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
|
<?xml version="1.0" encoding="UTF-8" ?>
<!-- $Id: ScanForWindow.xml,v 1.3 2007/06/16 12:38:46 griph Exp $ -->
<!DOCTYPE part PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"../docbook-xml/docbookx.dtd"
[
<!ENTITY % myents SYSTEM "../fvwm.ent" >
%myents;
]>
<section id='ScanForWindow'>
<title>ScanForWindow</title>
<cmdsynopsis>
<command>ScanForWindow</command
><arg choice='opt'>FromPointer</arg
><arg choice='plain'
><replaceable>dir1</replaceable
></arg
><arg choice='plain'
><replaceable>dir2</replaceable
></arg
><arg choice='opt'
>(<replaceable>conditions</replaceable
>)</arg
><arg choice='plain'
><replaceable>command</replaceable
></arg>
</cmdsynopsis>
<para>Performs <replaceable>command</replaceable>
(typically <fvwmref cmd="Focus"/>)
on a window in the given direction which satisfies all
<replaceable>conditions</replaceable>.
Normally, the center of the currently focused window or the
context window in which the command was invoked is taken as the
starting point. Lacking such a window, or when the
<fvwmopt cmd="ScanForWindow" opt="FromPointer"/>
option is given, the current position of the pointer is taken as
the starting point. The direction
<replaceable>dir1</replaceable>
may be one of "North", "NorthEast", "East", "SouthEast", "South",
"SouthWest", "West", and "NorthWest". Which window
<emphasis remap='B'>ScanForWindow</emphasis>
selects depends first on the position along the primary axis given
by
<replaceable>dir1</replaceable>.
If any windows have the exact same coordinate along the primary
axis, the secondary direction is used to order the windows. The
direction <replaceable>dir2</replaceable>
may be one of the same set of values as
<replaceable>dir1</replaceable>.
If <replaceable>dir2</replaceable>
is not perfectly perpendicular to
<replaceable>dir1</replaceable>,
ScanForWindow returns a failure. When using ScanForWindow
repeatedly with the same arguments, it is guaranteed that all
windows matching the conditions will eventually be found. If the
focus reaches a limit along the primary axis, it will wrap around
to the opposite side. Returns -1 if an invalid direction was
given.
See <fvwmref sect="conditionals" opt="conditions" name="Conditions"/> section for a list of conditions.</para>
</section>
|
