File: Maximize.xml

package info (click to toggle)
fvwm 1%3A2.7.0-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 15,968 kB
  • sloc: ansic: 145,836; xml: 17,096; perl: 7,237; sh: 5,100; makefile: 1,101; yacc: 688; lex: 187; sed: 11
file content (137 lines) | stat: -rw-r--r-- 5,147 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE part PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
  "../docbook-xml/docbookx.dtd"
[
<!ENTITY % myents SYSTEM "../fvwm.ent" >
%myents;
]>

<!-- $Id$ -->

<section id='Maximize'>
<title>Maximize</title>

<cmdsynopsis>
	<command>Maximize</command
	><arg choice='opt'
		><replaceable>flags</replaceable
	></arg>
	<arg choice='opt'
		><replaceable>bool | forget</replaceable
	></arg
	><arg choice='opt'
		><replaceable>horizontal</replaceable
		><optional>p</optional
	></arg
	><arg choice='opt'
		><replaceable>vertical</replaceable
		><optional>p</optional
	></arg>
</cmdsynopsis>


<para>Without its optional arguments (or if the
<replaceable>bool</replaceable>
bit has the value "<fvwmopt cmd="Maximize" opt="toggle"/>")
<emphasis remap='B'>Maximize</emphasis>
causes the window to alternately switch from a full-screen size to
its normal size.  To force a window into maximized (normal) state
you can use a "<fvwmopt cmd="Maximize" opt="True"/>" or "<fvwmopt cmd="Maximize" opt="False"/>" value for the
<replaceable>bool</replaceable>
argument.</para>

<para>With just the parameter "forget" a maximized window reverts
back into normal state but keeps its current maximized size.  This
can be useful in conjunction with the commands
<fvwmref cmd="ResizeMaximize"/> and <fvwmref cmd="ResizeMoveMaximize"/>.  If
the window is not maximized, nothing happens.</para>

<para>With the optional arguments
<replaceable>horizontal</replaceable> and <replaceable>vertical</replaceable>,
which are expressed as percentage of a full screen, the user can
control the new size of the window.  An optional suffix
'<fvwmopt cmd="Maximize" opt="p"/>'
can be used to indicate pixels instead of percents of the screen
size.  If horizontal is greater than 0 then the horizontal
dimension of the window is set to
<replaceable>horizontal</replaceable>*screen_width/100.
If the value is smaller than 0 the size is subtracted from the
screen width, i.e. -25 is the same as 75.  If
<replaceable>horizontal</replaceable>
is "<fvwmopt cmd="Maximize" opt="grow"/>", it is maximized to current
available space until
finding any obstacle.  The vertical resizing is similar.  If both
horizontal and vertical values are "grow", it expands vertically
first, then horizontally to find space.  Instead of the horizontal
"grow" argument, "<fvwmopt cmd="Maximize" opt="growleft"/>" or "<fvwmopt cmd="Maximize" opt="growright"/>" can be used
respectively "<fvwmopt cmd="Maximize" opt="growup"/>" and "<fvwmopt cmd="Maximize" opt="growdown"/>".
The optional
<replaceable>flags</replaceable>
argument is a space separated list containing the following
key words:
<emphasis remap='I'>fullscreen</emphasis>, <emphasis remap='I'>ewmhiwa</emphasis>, <emphasis remap='I'>growonwindowlayer</emphasis>, <emphasis remap='I'>growonlayers</emphasis> and <emphasis remap='I'>screen</emphasis>.
<fvwmopt cmd="Maximize" opt="fullscreen"/>
causes the window to become fullscreened if the appropriate EWMH hint is set.
<fvwmopt cmd="Maximize" opt="ewmhiwa"/>
causes fvwm to ignore the <acronym>EWMH</acronym> working area.
<fvwmopt cmd="Maximize" opt="growonwindowlayer"/>
causes the various grow methods to ignore windows with a layer
other than the current layer of the window which is maximized.
The
<fvwmopt cmd="Maximize" opt="growonlayers"/>
option must have two integer arguments.  The first one is the
minimum layer and the second one the maximum layer to use.
Windows that are outside of this range of layers are ignored by
the grow methods.  A negative value as the first or second
argument means to assume no minimum or maximum layer.
<fvwmopt cmd="Maximize" opt="screen"/>
must have an argument which specifies the Xinerama screen on which
to operate.
It can be 'p' for the primary screen, 'c' for the current
screen (containing the mouse pointer), 'g' for the global screen
or the screen number itself (counting from zero).  This option is
only useful with multiple Xinerama screens.</para>

<para>Here are some examples.  The following adds a title-bar button to
switch a window to the full vertical size of the screen:</para>

<programlisting>
<fvwmref cmd="Mouse"/> 0 4 A Maximize 0 100
</programlisting>

<para>The following causes windows to be stretched to the full width:</para>

<programlisting>
<fvwmref cmd="Mouse"/> 0 4 A Maximize 100 0
</programlisting>

<para>This makes a window that is half the screen size in each
direction:</para>

<programlisting>
<fvwmref cmd="Mouse"/> 0 4 A Maximize 50 50
</programlisting>

<para>To expand a window horizontally until any other window is found:</para>

<programlisting>
<fvwmref cmd="Mouse"/> 0 4 A Maximize 0 grow
</programlisting>

<para>To expand a window until any other window on the same or a higher
layer is hit.</para>

<programlisting>
<fvwmref cmd="Mouse"/> 0 4 A Maximize growonlayers $[w.layer] -1 grow grow
</programlisting>

<para>To expand a window but leave the lower 60 pixels of the screen
unoccupied:</para>

<programlisting>
<fvwmref cmd="Mouse"/> 0 4 A Maximize 100 -60p
</programlisting>

<para>Values larger than 100 can be used with caution.</para>

</section>