File: Move.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 (177 lines) | stat: -rw-r--r-- 5,519 bytes parent folder | download | duplicates (4)
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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
<?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='Move'>
<title>Move</title>

<cmdsynopsis>
	<command>Move</command
	><group choice='plain'
		><arg choice='opt'
			><arg choice='opt'
				>screen <replaceable>screen</replaceable
			></arg
			><arg choice='plain' rep="repeat"
				><optional
					><group choice='plain'
						><arg choice='plain'>w</arg
						><arg choice='plain'>m</arg
					></group
				></optional
				><replaceable>x</replaceable
				><optional
					><group choice='plain'
						><arg choice='plain'>p</arg
						><arg choice='plain'>w</arg
					></group
				></optional
			></arg
			><arg choice='plain' rep="repeat"
				><optional
					><group choice='plain'
						><arg choice='plain'>w</arg
						><arg choice='plain'>m</arg
					></group
				></optional
				><replaceable>y</replaceable
				><optional
					><group choice='plain'
						><arg choice='plain'>p</arg
						><arg choice='plain'>w</arg
					></group
				></optional
			></arg
			><arg choice='opt'>Warp</arg
		></arg
		><arg choice='opt'>pointer</arg
        ><arg choice='opt'>ewmhiwa</arg>
    </group>
</cmdsynopsis>

<para>Allows the user to move a window.  If called from somewhere in a
window or its border, then that window is moved.  If called from
the root window then the user is allowed to select the target
window.  By default, the EWMH working area is honoured.</para>

<para>If the literal option <fvwmopt cmd="Move" opt="screen"/> followed by a
<replaceable>screen</replaceable>
argument is specified, the coordinates are interpreted as relative
to the given screen.  The width and height of the screen are used
for the calculations instead of the display dimensions.  The
<replaceable>screen</replaceable>
as interpreted as in the
<fvwmref cmd="MoveToScreen"/>
command.
If the optional argument
<fvwmopt cmd="Move" opt="Warp"/>
is specified the pointer is warped with the window.  If the single
argument
<fvwmopt cmd="Move" opt="pointer"/>
is given, the top left corner of the window is moved to the
pointer position before starting the operation; this is mainly
intended for internal use by modules like
<fvwmref mod="FvwmPager"/>.
If the optional argument
<fvwmopt cmd="Move" opt="ewmhiwa"/>
is given, then the window position will ignore the working area
(such as ignoring any values set via <fvwmref cmd="EwmhBaseStruts"/>).</para>

<para>The operation can be aborted with <keysym>Escape</keysym> or any mouse
button not set to place the window. By default mouse button 2 is set to cancel
the move operation. To change this you may use the
<fvwmref cmd="Mouse"/>
command with special context 'P' for Placement.</para>

<para>The window condition
<fvwmref cmd="Style" opt="PlacedByButton"/>
can be used to check if a specific button was pressed to place the
window (see
<fvwmref cmd="Current"/>
command).</para>

<para>If the optional arguments
<fvwmopt cmd="Move" opt="x"/> and
<fvwmopt cmd="Move" opt="y"/>
are provided, then the window is moved immediately without user
interaction.  Each argument can specify an absolute or relative
position from either the left/top or right/bottom of the screen.
By default, the numeric value given is interpreted as a percentage
of the screen width/height, but a trailing
'<emphasis remap='I'>p</emphasis>'
changes the interpretation to mean pixels, while a trailing
'<emphasis>w</emphasis>'
means precent of the window width/height.
To move the window
relative to its current position, add the
'<fvwmopt cmd="Move" opt="w"/>'
(for "window") prefix before the
<replaceable>x</replaceable> and/or <replaceable>y</replaceable>
value.  To move the window to a position relative to the current
location of the pointer, add the
'<fvwmopt cmd="Move" opt="m"/>'
(for "mouse") prefix.  To leave either coordinate unchanged,
"<fvwmopt cmd="Move" opt="keep"/>" can be specified in place of
<replaceable>x</replaceable> or <replaceable>y</replaceable>.</para>

For advanced uses, the arguments
<replaceable>x</replaceable> and <replaceable>y</replaceable>
can be used multiple times, but without the prefix
'<replaceable>m</replaceable>' or '<replaceable>w</replaceable>'.
(See complex examples below).

<para>Simple Examples:</para>

<programlisting>
# Interactive move
<fvwmref cmd="Mouse"/> 1 T A Move
# Move window to top left is at (10%,10%)
<fvwmref cmd="Mouse"/> 2 T A Move 10 10
# Move top left to (10pixels,10pixels)
<fvwmref cmd="Mouse"/> 3 T A Move 10p 10p
</programlisting>

<para>More complex examples (these can be bound as actions to
keystrokes, etc.; only the command is shown, though):</para>

<programlisting>
# Move window so bottom right is at bottom
# right of screen
Move -0 -0

# Move window so top left corner is 10 pixels
# off the top left screen edge
Move +-10 +-10

# Move window 5% to the right, and to the
# middle vertically
Move w+5 50

# Move window up 10 pixels, and so left edge
# is at x=40 pixels
Move 40p w-10p

# Move window to the mouse pointer location
Move m+0 m+0

# Move window to center of screen (50% of screen
# poition minus 50% of widow size).
Move 50-50w 50-50w
</programlisting>

<para>Note:  In order to obtain moving windows which do not snap
to screen, with interactive move, hold down <emphasis>Alt</emphasis>
whilst moving the window to disable snap attraction if it's defined.
</para>

<para>See also the
<fvwmref cmd="AnimatedMove"/>
command.</para>

</section>