X-Git-Url: https://git.decadent.org.uk/gitweb/?p=ion3-doc.git;a=blobdiff_plain;f=ionconf%2Fnode7.html;h=9b8b3e3d8db7d7e16466be2f186f92927422364a;hp=628a67028af7057943ef75d7a974892bc334e55d;hb=refs%2Ftags%2Fion3-20070318;hpb=16a5f824c31d29598763c5f49918ef67a47ad7e0 diff --git a/ionconf/node7.html b/ionconf/node7.html index 628a670..9b8b3e3 100644 --- a/ionconf/node7.html +++ b/ionconf/node7.html @@ -28,31 +28,31 @@ original version by: Nikos Drakos, CBLU, University of Leeds
- next - up - previous - contents - index
- Next: Next: A. The GNU General - Up: Up: Configuring and extending Ion3 - Previous: Previous: 5. Scripting -   Contents -   Index

@@ -61,89 +61,96 @@ original version by: Nikos Drakos, CBLU, University of Leeds Subsections
@@ -163,8 +170,8 @@ original version by: Nikos Drakos, CBLU, University of Leeds
-
- +
+
Synopsis:
@@ -180,8 +187,8 @@ original version by: Nikos Drakos, CBLU, University of Leeds

-
- +
+
Synopsis:
@@ -198,8 +205,8 @@ original version by: Nikos Drakos, CBLU, University of Leeds

-
- +
+
Synopsis:
@@ -215,8 +222,8 @@ original version by: Nikos Drakos, CBLU, University of Leeds

-
- +
+
Synopsis:
@@ -242,8 +249,8 @@ The string guard maybe set to pose limits on _sub. Currently

-
- +
+
Synopsis:
@@ -261,8 +268,8 @@ The string guard maybe set to pose limits on _sub. Currently

-
- +
+
Synopsis:
@@ -280,8 +287,8 @@ The string guard maybe set to pose limits on _sub. Currently

-
- +
+
Synopsis:
@@ -298,8 +305,8 @@ The string guard maybe set to pose limits on _sub. Currently

-
- +
+
Synopsis:
@@ -317,8 +324,8 @@ The string guard maybe set to pose limits on _sub. Currently

-
- +
+
Synopsis:
@@ -336,8 +343,8 @@ The string guard maybe set to pose limits on _sub. Currently

-
- +
+
Synopsis:
@@ -353,8 +360,8 @@ The string guard maybe set to pose limits on _sub. Currently

-
- +
+
Synopsis:
@@ -376,8 +383,8 @@ The string guard maybe set to pose limits on _sub. Currently

-
- +
+
Synopsis:
@@ -393,8 +400,8 @@ The string guard maybe set to pose limits on _sub. Currently

-
- +
+
Synopsis:
@@ -411,8 +418,8 @@ The string guard maybe set to pose limits on _sub. Currently

-
- +
+
Synopsis:
@@ -429,8 +436,8 @@ The string guard maybe set to pose limits on _sub. Currently

-
- +
+
Synopsis:
@@ -447,8 +454,8 @@ The string guard maybe set to pose limits on _sub. Currently

-
- +
+
Synopsis:
@@ -465,8 +472,8 @@ The string guard maybe set to pose limits on _sub. Currently

-
- +
+
Synopsis:
@@ -482,8 +489,8 @@ The string guard maybe set to pose limits on _sub. Currently

-
- +
+
Synopsis:
@@ -499,8 +506,8 @@ The string guard maybe set to pose limits on _sub. Currently

-
- +
+
Synopsis:
@@ -516,8 +523,8 @@ The string guard maybe set to pose limits on _sub. Currently

-
- +
+
Synopsis:
@@ -534,8 +541,8 @@ The string guard maybe set to pose limits on _sub. Currently

-
- +
+
Synopsis:
@@ -551,8 +558,8 @@ The string guard maybe set to pose limits on _sub. Currently

-
- +
+
Synopsis:
@@ -568,8 +575,8 @@ The string guard maybe set to pose limits on _sub. Currently

-
- +
+
Synopsis:
@@ -585,8 +592,8 @@ The string guard maybe set to pose limits on _sub. Currently

-
- +
+
Synopsis:
@@ -602,8 +609,8 @@ The string guard maybe set to pose limits on _sub. Currently

-
- +
+
Synopsis:
@@ -621,25 +628,8 @@ The string guard maybe set to pose limits on _sub. Currently

-
- - -
-
Synopsis:
-
void ioncore.clear_tags() - -
-
Description:
-
Untag all regions. - -
-
- -

- -

-
- +
+
Synopsis:
@@ -657,8 +647,8 @@ The string guard maybe set to pose limits on _sub. Currently

-
- +
+
Synopsis:
@@ -674,8 +664,8 @@ The string guard maybe set to pose limits on _sub. Currently

-
- +
+
Synopsis:
@@ -728,8 +718,8 @@ Similarly to sed's 's' command, rule may contain characters that are

-
- +
+
Synopsis:
@@ -752,8 +742,8 @@ Similarly to sed's 's' command, rule may contain characters that are

-
- +
+
Synopsis:
@@ -772,8 +762,8 @@ Similarly to sed's 's' command, rule may contain characters that are

-
- +
+
Synopsis:
@@ -789,8 +779,8 @@ Similarly to sed's 's' command, rule may contain characters that are

-
- +
+
Synopsis:
@@ -808,8 +798,8 @@ Similarly to sed's 's' command, rule may contain characters that are

-
- +
+
Synopsis:
@@ -825,8 +815,8 @@ Similarly to sed's 's' command, rule may contain characters that are

-
- +
+
Synopsis:
@@ -842,8 +832,8 @@ Similarly to sed's 's' command, rule may contain characters that are

-
- +
+
Synopsis:
@@ -859,8 +849,8 @@ Similarly to sed's 's' command, rule may contain characters that are

-
- +
+
Synopsis:
@@ -880,8 +870,8 @@ Similarly to sed's 's' command, rule may contain characters that are

-
- +
+
Synopsis:
@@ -901,8 +891,8 @@ Similarly to sed's 's' command, rule may contain characters that are

-
- +
+
Synopsis:
@@ -922,8 +912,8 @@ Note that this function is asynchronous; the screen will not

-
- +
+
Synopsis:
@@ -943,8 +933,8 @@ Note that this function is asynchronous; the screen will not

-
- +
+
Synopsis:
@@ -964,8 +954,8 @@ Note that this function is asynchronous; the screen will not

-
- +
+
Synopsis:
@@ -985,8 +975,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -1002,8 +992,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -1019,8 +1009,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -1036,8 +1026,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -1054,8 +1044,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -1073,8 +1063,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -1083,12 +1073,12 @@ Note that this function is asynchronous; the region will not
Description:
Find region next from reg in direction dirstr - (up/down/left/right/next/prev/any). The table param may + (up/down/left/right/next/prev/any). The table param may contain the boolean field nowrap, instructing not to wrap around, and the WRegions no_ascend and no_descend, - and functions ascend_filter and descend_filter from - WRegions (to, from), used to decide when to descend - or ascend into another region. (TODO: more detailed explanation.) + and boolean functions ascend_filter and descend_filter + on WRegion pairs (to, from), are used to decide when + to descend or ascend into another region.
@@ -1096,8 +1086,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -1115,8 +1105,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -1132,8 +1122,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -1152,8 +1142,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -1170,8 +1160,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -1188,8 +1178,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -1205,8 +1195,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -1222,8 +1212,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -1292,6 +1282,15 @@ Note that this function is asynchronous; the region will not One of ''udlr'' (up-down, then left-right), ''lrud'' (left-right, then up-down) or ''random''. +mousefocus +String: ''disable'' or ''sloppy''. + +unsqueeze +(boolean) Auto-unsqueeze transients/menus/queries/etc. + +autoraise +(boolean) Autoraise regions in groups on goto. +

@@ -1309,8 +1308,8 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- +
+
Synopsis:
@@ -1326,8 +1325,8 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- +
+
Synopsis:
@@ -1343,8 +1342,8 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- +
+
Synopsis:
@@ -1360,8 +1359,8 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- +
+
Synopsis:
@@ -1377,16 +1376,33 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- +
+ + +
+
Synopsis:
+
void ioncore.tagged_clear() + +
+
Description:
+
Untag all regions. + +
+
+ +

+ +

+
+
Synopsis:
-
WRegion ioncore.tagged_first() +
WRegion ioncore.tagged_first(bool untag)
Description:
-
Returns first tagged object. +
Returns first tagged object, untagging it as well if untagis set.
@@ -1394,8 +1410,8 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- +
+
Synopsis:
@@ -1413,8 +1429,28 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- +
+ + +
+
Synopsis:
+
void ioncore.unsqueeze(WRegion reg, bool override) + +
+
Description:
+
Try to detach reg if it fits poorly in its + current location. This function does not do anything, + unless override is set or the unsqueeze option + of ioncore.set is set. + +
+
+ +

+ +

+
+
Synopsis:
@@ -1430,8 +1466,8 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- +
+
Synopsis:
@@ -1448,8 +1484,8 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- +
+
Synopsis:
@@ -1465,8 +1501,8 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- +
+
Synopsis:
@@ -1485,8 +1521,8 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- +
+
Synopsis:
@@ -1502,8 +1538,8 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- +
+
Synopsis:
@@ -1520,8 +1556,8 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- +
+
Synopsis:
@@ -1540,8 +1576,8 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- +
+
Synopsis:
@@ -1562,8 +1598,8 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- +
+
Synopsis:
@@ -1579,8 +1615,8 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- +
+
Synopsis:
@@ -1598,8 +1634,8 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- +
+
Synopsis:
@@ -1617,8 +1653,8 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- +
+
Synopsis:
@@ -1637,8 +1673,8 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- +
+
Synopsis:
@@ -1654,8 +1690,8 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- +
+
Synopsis:
@@ -1674,8 +1710,8 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- +
+
Synopsis:
@@ -1692,8 +1728,8 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- +
+
Synopsis:
@@ -1713,19 +1749,23 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- +
+
Synopsis:
-
ioncore.menuentry(name, cmd, guard) +
ioncore.menuentry(name, cmd, guard_or_opts)
Description:
Use this function to define normal menu entries. The string name - is the string shown in the visual representation of menu, and the - parameter cmd and guard are similar to those of - ioncore.defbindings. + is the string shown in the visual representation of menu. The + parameter cmd and guard_or_opts (when string) are similar + to those of ioncore.defbindings. If guard_or_opts is + a table, it may contains the guard field, and the priority + field, for controlling positioning of entries in context menus. + (The default priority is 1 for most entries, and -1 for auto-generated + submenus.)
@@ -1733,8 +1773,8 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- +
+
Synopsis:
@@ -1751,8 +1791,8 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- +
+
Synopsis:
@@ -1768,8 +1808,8 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- +
+
Synopsis:
@@ -1788,8 +1828,8 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- +
+
Synopsis:
@@ -1808,6 +1848,26 @@ When a keyboard resize function is called, and at most kbresize_t_max
+

+ +

+
+ + +
+
Synopsis:
+
ioncore.tagged_attach(reg, param) + +
+
Description:
+
Attach tagged regions to reg. The method of attach + depends on the types of attached regions and whether reg + implements attach_framed and attach. If param + is not set, the default of {switchto=true} is used. + +
+
+

@@ -1817,8 +1877,8 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- +
+
Synopsis:
@@ -1837,8 +1897,8 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- +
+
Synopsis:
@@ -1855,8 +1915,8 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- +
+
Synopsis:
@@ -1873,8 +1933,8 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- +
+
Synopsis:
@@ -1890,8 +1950,8 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- +
+
Synopsis:
@@ -1913,8 +1973,8 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- +
+
Synopsis:
@@ -1930,8 +1990,8 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- +
+
Synopsis:
@@ -1947,8 +2007,8 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- +
+
Synopsis:
@@ -1964,8 +2024,8 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- +
+
Synopsis:
@@ -1981,8 +2041,8 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- +
+
Synopsis:
@@ -1999,8 +2059,8 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- +
+
Synopsis:
@@ -2018,8 +2078,8 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- +
+
Synopsis:
@@ -2035,8 +2095,8 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- +
+
Synopsis:
@@ -2054,8 +2114,8 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- +
+
Synopsis:
@@ -2079,8 +2139,8 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- +
+
Synopsis:
@@ -2098,8 +2158,8 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- +
+
Synopsis:
@@ -2145,8 +2205,8 @@ In addition parameters to the region to be created are passed in this

-
- +
+
Synopsis:
@@ -2162,8 +2222,8 @@ In addition parameters to the region to be created are passed in this

-
- +
+
Synopsis:
@@ -2179,8 +2239,8 @@ In addition parameters to the region to be created are passed in this

-
- +
+
Synopsis:
@@ -2199,8 +2259,26 @@ In addition parameters to the region to be created are passed in this

-
- +
+ + +
+
Synopsis:
+
bool WGroup.set_bottom(WGroup ws, WRegion reg) + +
+
Description:
+
Sets the 'bottom' of ws. The region reg must already + be managed by ws, unless nil. + +
+
+ +

+ +

+
+
Synopsis:
@@ -2230,8 +2308,8 @@ In addition parameters to the region to be created are passed in this

-
- +
+
Synopsis:
@@ -2269,12 +2347,12 @@ In addition parameters to the region to be created are passed in this

-
- +
+
Synopsis:
-
void WInfoWin.set_text(WInfoWin p, string str) +
void WInfoWin.set_text(WInfoWin p, string str, integer maxw)
Description:
@@ -2292,8 +2370,8 @@ In addition parameters to the region to be created are passed in this

-
- +
+
Synopsis:
@@ -2311,8 +2389,8 @@ In addition parameters to the region to be created are passed in this

-
- +
+
Synopsis:
@@ -2357,8 +2435,7 @@ In addition parameters to the region to be created are passed in this This option overrides switchto. sizepolicy -(integer) Size policy. - (TODO: document them somewhere.) +(integer) Size policy. geom (table) Geometry specification. @@ -2375,25 +2452,8 @@ In addition parameters to the region to be created are passed in this

-
- - -
-
Synopsis:
-
void WMPlex.attach_tagged(WMPlex mplex) - -
-
Description:
-
Attach all tagged regions to mplex. - -
-
- -

- -

-
- +
+
Synopsis:
@@ -2409,8 +2469,8 @@ In addition parameters to the region to be created are passed in this

-
- +
+
Synopsis:
@@ -2418,9 +2478,9 @@ In addition parameters to the region to be created are passed in this
Description:
-
Get index of reg within the multiplexer on list 1. The first region - managed by mplex has index zero. If reg is not managed by - mplex, -1 is returned. +
Get index of reg on the mutually exclusive list of mplex. + The indices begin from zero.. If reg is not on the list, + -1 is returned.
@@ -2428,8 +2488,8 @@ In addition parameters to the region to be created are passed in this

-
- +
+
Synopsis:
@@ -2446,8 +2506,8 @@ In addition parameters to the region to be created are passed in this

-
- +
+
Synopsis:
@@ -2463,8 +2523,8 @@ In addition parameters to the region to be created are passed in this

-
- +
+
Synopsis:
@@ -2480,8 +2540,8 @@ In addition parameters to the region to be created are passed in this

-
- +
+
Synopsis:
@@ -2500,8 +2560,8 @@ In addition parameters to the region to be created are passed in this

-
- +
+
Synopsis:
@@ -2517,8 +2577,8 @@ In addition parameters to the region to be created are passed in this

-
- +
+
Synopsis:
@@ -2535,8 +2595,8 @@ In addition parameters to the region to be created are passed in this

-
- +
+
Synopsis:
@@ -2555,8 +2615,8 @@ In addition parameters to the region to be created are passed in this

-
- +
+
Synopsis:
@@ -2573,8 +2633,8 @@ In addition parameters to the region to be created are passed in this

-
- +
+
Synopsis:
@@ -2591,9 +2651,9 @@ In addition parameters to the region to be created are passed in this

-

-
- +
+
+
Synopsis:
@@ -2601,8 +2661,8 @@ In addition parameters to the region to be created are passed in this
Description:
-
Set index of reg within the multiplexer to index within - the mutually exclusive list. Special values for index are: +
Set index of reg to index within the mutually exclusive + list of mplex. Special values for index are: @@ -2618,8 +2678,8 @@ In addition parameters to the region to be created are passed in this

-
- +
+
Synopsis:
@@ -2658,8 +2718,8 @@ In addition parameters to the region to be created are passed in this

-
- +
+
Synopsis:
@@ -2676,8 +2736,8 @@ In addition parameters to the region to be created are passed in this

-
- +
+
Synopsis:
@@ -2693,8 +2753,8 @@ In addition parameters to the region to be created are passed in this

-
- +
+
Synopsis:
@@ -2717,8 +2777,8 @@ In addition parameters to the region to be created are passed in this

-
- +
+
Synopsis:
@@ -2735,8 +2795,8 @@ In addition parameters to the region to be created are passed in this

-
- +
+
Synopsis:
@@ -2753,8 +2813,25 @@ In addition parameters to the region to be created are passed in this

-
- +
+ + +
+
Synopsis:
+
table WMoveresMode.geom(WMoveresMode mode) + +
+
Description:
+
Returns current geometry. + +
+
+ +

+ +

+
+
Synopsis:
@@ -2786,8 +2863,8 @@ In addition parameters to the region to be created are passed in this

-
- +
+
Synopsis:
@@ -2803,6 +2880,24 @@ In addition parameters to the region to be created are passed in this
+

+ +

+
+ + +
+
Synopsis:
+
table WMoveresMode.rqgeom(WMoveresMode mode, table g) + +
+
Description:
+
Request exact geometry in move/resize mode. For details on parameters, + see WRegion.rqgeom. + +
+
+

@@ -2812,8 +2907,8 @@ In addition parameters to the region to be created are passed in this

-
- +
+
Synopsis:
@@ -2834,8 +2929,8 @@ In addition parameters to the region to be created are passed in this

-
- +
+
Synopsis:
@@ -2852,8 +2947,8 @@ In addition parameters to the region to be created are passed in this

-
- +
+
Synopsis:
@@ -2870,8 +2965,26 @@ In addition parameters to the region to be created are passed in this

-
- +
+ + +
+
Synopsis:
+
table WRegion.get_configuration(WRegion reg, bool clientwins) + +
+
Description:
+
Get configuration tree. If clientwins is unset, client windows + are filtered out. + +
+
+ +

+ +

+
+
Synopsis:
@@ -2892,8 +3005,26 @@ Note that this function is asynchronous; the region will not

-
- +
+ + +
+
Synopsis:
+
WRegion WRegion.groupleader_of(WRegion reg) + +
+
Description:
+
Returns the group of reg, if reg is its bottom, + and reg itself otherwise. + +
+
+ +

+ +

+
+
Synopsis:
@@ -2909,8 +3040,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -2926,8 +3057,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -2943,8 +3074,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -2960,8 +3091,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -2977,8 +3108,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -2994,8 +3125,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -3011,8 +3142,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -3028,12 +3159,12 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
-
bool WRegion.rqclose(WRegion reg, bool relocate) +
void WRegion.rqclose(WRegion reg, bool relocate)
Description:
@@ -3041,12 +3172,11 @@ Note that this function is asynchronous; the region will not depends on whether the particular type of region in question has implemented the feature and, in case of client windows, whether the client supports the WM_DELETE protocol (see also - WClientWin.kill). If the operation is likely to succeed, - true is returned, otherwise false. In most cases the - region will not have been actually destroyed when this function returns. - If relocate is not set, and reg manages other regions, it - will not be closed. Otherwise the managed regions will be attempted - to be relocated. + WClientWin.kill). The region will not be destroyed when + this function returns. To find out if and when it is destroyed, + use the "deinit" notification. If relocate is not set, and + reg manages other regions, it will not be closed. Otherwise + the managed regions will be attempted to be relocated.
@@ -3054,8 +3184,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -3066,8 +3196,8 @@ Note that this function is asynchronous; the region will not
Recursively attempt to close a region or one of the regions managed by it. If sub is set, it will be used as the managed region, otherwise WRegion.current(reg). The object to be closed is - returned or NULL if nothing can be closed. Also see notes for - WRegion.rqclose. + returned, or NULL if nothing can be closed. For further details, see + notes for WRegion.rqclose.
@@ -3075,8 +3205,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -3095,8 +3225,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -3113,8 +3243,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -3130,8 +3260,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -3148,8 +3278,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -3168,8 +3298,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -3187,8 +3317,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -3205,8 +3335,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -3230,8 +3360,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -3253,8 +3383,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -3270,8 +3400,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -3296,8 +3426,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -3315,8 +3445,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -3334,8 +3464,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -3357,7 +3487,7 @@ Note that this function is asynchronous; the region will not

-
+
Synopsis:
@@ -3379,8 +3509,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -3396,8 +3526,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -3413,8 +3543,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -3440,8 +3570,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -3463,8 +3593,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -3480,8 +3610,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -3498,8 +3628,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -3515,8 +3645,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -3533,8 +3663,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -3556,8 +3686,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -3573,8 +3703,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -3591,8 +3721,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -3606,6 +3736,24 @@ Note that this function is asynchronous; the region will not
+

+ +

+
+ + +
+
Synopsis:
+
bool mod_tiling.untile(WTiling tiling) + +
+
Description:
+
If tiling is managed by some group, float the frames in + the tiling in that group, and dispose of tiling. + +
+
+

@@ -3615,8 +3763,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -3632,8 +3780,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -3649,8 +3797,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -3668,8 +3816,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -3691,8 +3839,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -3714,8 +3862,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -3737,8 +3885,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -3755,8 +3903,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -3773,8 +3921,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -3790,8 +3938,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -3814,8 +3962,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -3831,8 +3979,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -3848,8 +3996,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -3868,8 +4016,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -3888,8 +4036,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -3908,8 +4056,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -3926,8 +4074,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -3946,8 +4094,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -3965,8 +4113,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -3984,8 +4132,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -4006,8 +4154,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -4023,8 +4171,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -4040,17 +4188,17 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
-
bool WTiling.unsplit_at(WTiling ws, WFrame frame) +
void WTiling.unsplit_at(WTiling ws, WRegion reg)
Description:
-
Try to relocate regions managed by frame to another frame - and, if possible, destroy the frame. +
Try to relocate regions managed by reg to another frame + and, if possible, destroy it.
@@ -4064,8 +4212,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -4081,8 +4229,25 @@ Note that this function is asynchronous; the region will not

-
- +
+ + +
+
Synopsis:
+
mod_query.message(mplex, str) + +
+
Description:
+
Display a message in mplex. + +
+
+ +

+ +

+
+
Synopsis:
@@ -4099,8 +4264,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -4116,8 +4281,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -4133,8 +4298,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -4150,8 +4315,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -4171,8 +4336,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -4188,25 +4353,8 @@ Note that this function is asynchronous; the region will not

-
- - -
-
Synopsis:
-
WMessage mod_query.message(WMPlex mplex, string p) - -
-
Description:
-
Display a message in the mplex. - -
-
- -

- -

-
- +
+
Synopsis:
@@ -4241,25 +4389,8 @@ Note that this function is asynchronous; the region will not

-
- - -
-
Synopsis:
-
WMessage mod_query.warn(WMPlex mplex, string p) - -
-
Description:
-
Display an error message box in the multiplexer mplex. - -
-
- -

- -

-
- +
+
Synopsis:
@@ -4282,8 +4413,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -4309,8 +4440,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -4328,8 +4459,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -4347,8 +4478,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -4368,8 +4499,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -4387,8 +4518,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -4407,8 +4538,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -4426,12 +4557,12 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
-
mod_query.query_menu(mplex, themenu, prompt) +
mod_query.query_menu(mplex, sub, themenu, prompt)
Description:
@@ -4443,8 +4574,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -4461,8 +4592,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -4480,8 +4611,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -4498,8 +4629,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -4517,8 +4648,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -4536,8 +4667,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -4554,8 +4685,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -4575,8 +4706,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -4594,8 +4725,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -4611,8 +4742,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -4625,6 +4756,23 @@ Note that this function is asynchronous; the region will not
+

+ +

+
+ + +
+
Synopsis:
+
mod_query.warn(mplex, str) + +
+
Description:
+
Display an error message box in the multiplexer mplex. + +
+
+

@@ -4634,8 +4782,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -4661,8 +4809,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -4678,8 +4826,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -4695,8 +4843,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -4713,8 +4861,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -4730,8 +4878,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -4748,8 +4896,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -4765,8 +4913,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -4788,8 +4936,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -4805,8 +4953,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -4822,8 +4970,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -4839,8 +4987,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -4857,8 +5005,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -4874,8 +5022,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -4891,8 +5039,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -4908,8 +5056,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -4925,8 +5073,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -4944,8 +5092,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -4963,8 +5111,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -4980,8 +5128,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -4997,8 +5145,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -5014,8 +5162,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -5031,8 +5179,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -5048,8 +5196,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -5066,8 +5214,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -5085,8 +5233,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -5102,8 +5250,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -5124,8 +5272,8 @@ Note that this function is asynchronous; the selection will not

-
- +
+
Synopsis:
@@ -5142,8 +5290,8 @@ Note that this function is asynchronous; the selection will not

-
- +
+
Synopsis:
@@ -5159,8 +5307,8 @@ Note that this function is asynchronous; the selection will not

-
- +
+
Synopsis:
@@ -5176,8 +5324,8 @@ Note that this function is asynchronous; the selection will not

-
- +
+
Synopsis:
@@ -5193,8 +5341,8 @@ Note that this function is asynchronous; the selection will not

-
- +
+
Synopsis:
@@ -5211,8 +5359,8 @@ Note that this function is asynchronous; the selection will not

-
- +
+
Synopsis:
@@ -5228,8 +5376,8 @@ Note that this function is asynchronous; the selection will not

-
- +
+
Synopsis:
@@ -5251,8 +5399,8 @@ Note that this function is asynchronous; the selection will not

-
- +
+
Synopsis:
@@ -5268,8 +5416,8 @@ Note that this function is asynchronous; the selection will not

-
- +
+
Synopsis:
@@ -5285,8 +5433,8 @@ Note that this function is asynchronous; the selection will not

-
- +
+
Synopsis:
@@ -5308,8 +5456,8 @@ Note that this function is asynchronous; the selection will not

-
- +
+
Synopsis:
@@ -5327,8 +5475,8 @@ Note that this function is asynchronous; the selection will not

-
- +
+
Synopsis:
@@ -5354,8 +5502,8 @@ Note that this function is asynchronous; the selection will not

-
- +
+
Synopsis:
@@ -5371,8 +5519,8 @@ Note that this function is asynchronous; the selection will not

-
- +
+
Synopsis:
@@ -5406,8 +5554,8 @@ Note that this function is asynchronous; the selection will not

-
- +
+
Synopsis:
@@ -5431,8 +5579,8 @@ Note that this function is asynchronous; the selection will not

-
- +
+
Synopsis:
@@ -5448,8 +5596,8 @@ Note that this function is asynchronous; the selection will not

-
- +
+
Synopsis:
@@ -5466,8 +5614,8 @@ Note that this function is asynchronous; the selection will not

-
- +
+
Synopsis:
@@ -5483,8 +5631,8 @@ Note that this function is asynchronous; the selection will not

-
- +
+
Synopsis:
@@ -5500,8 +5648,8 @@ Note that this function is asynchronous; the selection will not

-
- +
+
Synopsis:
@@ -5517,8 +5665,8 @@ Note that this function is asynchronous; the selection will not

-
- +
+
Synopsis:
@@ -5540,8 +5688,8 @@ Note that this function is asynchronous; the selection will not
-
- +
+
Synopsis:
@@ -5563,8 +5711,8 @@ Note that this function is asynchronous; the selection will not

-
- +
+
Synopsis:
@@ -5580,8 +5728,8 @@ Note that this function is asynchronous; the selection will not

-
- +
+
Synopsis:
@@ -5598,8 +5746,8 @@ Note that this function is asynchronous; the selection will not

-
- +
+
Synopsis:
@@ -5615,8 +5763,8 @@ Note that this function is asynchronous; the selection will not

-
- +
+
Synopsis:
@@ -5671,8 +5819,8 @@ Any parameters not explicitly set in conftab will be left unchanged.
-
- +
+
Synopsis:
@@ -5689,8 +5837,8 @@ Any parameters not explicitly set in conftab will be left unchanged.

-
- +
+
Synopsis:
@@ -5707,14 +5855,147 @@ Any parameters not explicitly set in conftab will be left unchanged.

+ +
+6.7 Functions defined in mod_statusbar +

+ +
+
+ + +
+
Synopsis:
+
table mod_statusbar.statusbars() + +
+
Description:
+
Returns a list of all statusbars. + +
+
+ +

+ +

+6.7.1 WStatusBar functions +

+ +

+ +

+
+ + +
+
Synopsis:
+
table WStatusBar.get_template_table(WStatusBar sb) + +
+
Description:
+
Get statusbar template as table. + +
+
+ +

+ +

+
+ + +
+
Synopsis:
+
bool WStatusBar.is_systray_extl(WStatusBar sb) + +
+
Description:
+
Is sb used as a systray? + +
+
+ +

+ +

+
+ + +
+
Synopsis:
+
bool WStatusBar.set_systray(WStatusBar sb, string how) + +
+
Description:
+
Enable or disable use of sb as systray. + The parameter how can be one of (set/unset/toggle). + Resulting state is returned. + +
+
+ +

+ +

+
+ + +
+
Synopsis:
+
void WStatusBar.set_template(WStatusBar sb, string tmpl) + +
+
Description:
+
Set statusbar template. + +
+
+ +

+ +

+
+ + +
+
Synopsis:
+
void WStatusBar.set_template_table(WStatusBar sb, table t) + +
+
Description:
+
Set statusbar template as table. + +
+
+ +

+ +

+
+ + +
+
Synopsis:
+
void WStatusBar.update(WStatusBar sb, table t) + +
+
Description:
+
Set statusbar template. + +
+
+ +

+ +


-6.7 Functions defined in de +6.8 Functions defined in de

-
- +
+
Synopsis:
@@ -5730,8 +6011,8 @@ Any parameters not explicitly set in conftab will be left unchanged.

-
- +
+
Synopsis:
@@ -5747,8 +6028,8 @@ Any parameters not explicitly set in conftab will be left unchanged.

-
- +
+
Synopsis:
@@ -5764,8 +6045,8 @@ Any parameters not explicitly set in conftab will be left unchanged.

-
- +
+
Synopsis:
@@ -5780,16 +6061,16 @@ Any parameters not explicitly set in conftab will be left unchanged.

-

+


-6.8 Hooks +6.9 Hooks

-
+
Hook name:
@@ -5861,7 +6142,7 @@ reg:attach(cwin)

-
+
Hook name:
@@ -5881,7 +6162,7 @@ reg:attach(cwin)

-
+
Hook name:
@@ -5902,7 +6183,7 @@ reg:attach(cwin)

-
+
Hook name:
@@ -5923,7 +6204,7 @@ reg:attach(cwin)

-
+
Hook name:
@@ -5969,7 +6250,7 @@ reg:attach(cwin)

-
+
Hook name:
@@ -5990,7 +6271,7 @@ reg:attach(cwin)

-
+
Hook name:
@@ -6010,7 +6291,7 @@ reg:attach(cwin)

-
+
Hook name:
@@ -6031,7 +6312,7 @@ reg:attach(cwin)

-
+
Hook name:
@@ -6051,7 +6332,7 @@ reg:attach(cwin)

-
+
Hook name:
@@ -6103,7 +6384,7 @@ reg:attach(cwin)

-
+
Hook name:
@@ -6124,7 +6405,7 @@ reg:attach(cwin)

-
+
Hook name:
@@ -6146,7 +6427,7 @@ reg:attach(cwin)

-
+
Hook name:
@@ -6219,31 +6500,31 @@ A region is pseudoactive, when a) it is itself not active (does
- next - up - previous - contents - index
- Next: Next: A. The GNU General - Up: Up: Configuring and extending Ion3 - Previous: Previous: 5. Scripting -   Contents -   Index
Last.