X-Git-Url: https://git.decadent.org.uk/gitweb/?a=blobdiff_plain;f=doc%2Fionconf%2Fnode7.html;h=9b8b3e3d8db7d7e16466be2f186f92927422364a;hb=20070318;hp=5a3e390e466263e9701eff33b458d3ec9d14b9f1;hpb=8366314611bf30a0f31d25bf5f5023186fa87692;p=ion3.git diff --git a/doc/ionconf/node7.html b/doc/ionconf/node7.html index 5a3e390..9b8b3e3 100644 --- a/doc/ionconf/node7.html +++ b/doc/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,18 +249,18 @@ The string guard maybe set to pose limits on _sub. Currently

-
- +
+
Synopsis:
-
ioncore.create_ws(scr, tmpl, no_default) +
ioncore.create_ws(scr, tmpl, layout)
Description:
Create new workspace on screen scr. The table tmpl - may be used to override parts of default_ws_params, - and no_default may be set to true to complete ignore it. + may be used to override parts of the layout named with layout. + If no layout is given, "default" is used.
@@ -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,27 @@ The string guard maybe set to pose limits on _sub. Currently

-
- +
+ + +
+
Synopsis:
+
ioncore.deflayout(name, tab) + +
+
Description:
+
Define a new workspace layout with name name, and + attach/creation parameters given in tab. The layout + "empty" may not be defined. + +
+
+ +

+ +

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

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

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

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

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

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

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

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

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

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

-
- +
+
Synopsis:
@@ -497,16 +523,17 @@ The string guard maybe set to pose limits on _sub. Currently

-
- - +
+ +
Synopsis:
-
ioncore.getmenu(name) +
ioncore.getlayout(name, all)
Description:
-
Returns a menu defined with ioncore.defmenu. +
Get named layout (or all of the latter parameter is set, + but this is for internal use only).
@@ -514,16 +541,16 @@ The string guard maybe set to pose limits on _sub. Currently

-
- - +
+ +
Synopsis:
-
ioncore.getwinprop(cwin) +
ioncore.getmenu(name)
Description:
-
Find winprop table for cwin. +
Returns a menu defined with ioncore.defmenu.
@@ -531,16 +558,16 @@ The string guard maybe set to pose limits on _sub. Currently

-
- - +
+ +
Synopsis:
-
string ioncore.aboutmsg() +
ioncore.getwinprop(cwin)
Description:
-
Returns an about message (version, author, copyright notice). +
Find winprop table for cwin.
@@ -548,16 +575,16 @@ The string guard maybe set to pose limits on _sub. Currently

-
- - +
+ +
Synopsis:
-
WRegion ioncore.activity_first() +
string ioncore.aboutmsg()
Description:
-
Return first regio non activity list. +
Returns an about message (version, author, copyright notice).
@@ -565,16 +592,16 @@ The string guard maybe set to pose limits on _sub. Currently

-
- - +
+ +
Synopsis:
-
table ioncore.activity_list() +
WRegion ioncore.activity_first()
Description:
-
Return list of regions with activity/urgency bit set. +
Return first regio non activity list.
@@ -582,16 +609,18 @@ The string guard maybe set to pose limits on _sub. Currently

-
- - +
+ +
Synopsis:
-
void ioncore.clear_tags() +
bool ioncore.activity_i(function iterfn)
Description:
-
Untag all regions. +
Iterate over activity list until iterfn returns false. + The function itself returns true if it reaches the end of list + without this happening.
@@ -599,16 +628,18 @@ The string guard maybe set to pose limits on _sub. Currently

-
- - +
+ +
Synopsis:
-
table ioncore.clientwin_list() +
bool ioncore.clientwin_i(function fn)
Description:
-
Return a list of all client windows. +
Iterate over client windows until iterfn returns false. + The function itself returns true if it reaches the end of list + without this happening.
@@ -616,8 +647,8 @@ The string guard maybe set to pose limits on _sub. Currently

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

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

-
- +
+ + +
+
Synopsis:
+
bool ioncore.detach(WRegion reg, string how) + +
+
Description:
+
Detach or reattach reg, depending on whether how + is 'set'/'unset'/'toggle'. (Detaching means making reg + managed by its nearest ancestor WGroup, framed if reg is + not itself WFrame. Reattaching means making it managed where + it used to be managed, if a return-placeholder exists.) + If reg is the 'bottom' of some group, the whole group is + detached. If reg is a WWindow, it is put into a + frame. + +
+
+ +

+ +

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

-
- +
+
Synopsis:
@@ -716,10 +771,26 @@ Similarly to sed's 's' command, rule may contain characters that are
Description:
-
Find the screen with numerical id id. If Xinerama is - not present, id corresponds to X screen numbers. Otherwise - the ids are some arbitrary ordering of Xinerama rootwins. - If id is , the screen with the highest id is returned. +
Find the screen with numerical id id. + +
+
+ +

+ +

+
+ + +
+
Synopsis:
+
bool ioncore.focushistory_i(function iterfn) + +
+
Description:
+
Iterate over focus history until iterfn returns false. + The function itself returns true if it reaches the end of list + without this happening.
@@ -727,8 +798,8 @@ Similarly to sed's 's' command, rule may contain characters that are

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

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

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

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

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

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

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

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

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

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

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

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

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

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

-
- +
+
Synopsis:
@@ -1002,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.
@@ -1015,8 +1086,8 @@ Note that this function is asynchronous; the region will not

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

-
- +
+
Synopsis:
@@ -1051,16 +1122,19 @@ Note that this function is asynchronous; the region will not

-
- - +
+ +
Synopsis:
-
table ioncore.region_list(string typenam) +
bool ioncore.region_i(function fn, string typenam)
Description:
-
Find all non-client window regions inheriting typenam. +
Iterate over all non-client window regions with (inherited) class + typenam until iterfn returns false. + The function itself returns true if it reaches the end of list + without this happening.
@@ -1068,8 +1142,8 @@ Note that this function is asynchronous; the region will not

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

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

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

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

-
- +
+
Synopsis:
@@ -1208,9 +1282,14 @@ 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''. -default_ws_params -(table) Default workspace layout; the - attach/creation parameters for a WGroup. +mousefocus +String: ''disable'' or ''sloppy''. + +unsqueeze +(boolean) Auto-unsqueeze transients/menus/queries/etc. + +autoraise +(boolean) Autoraise regions in groups on goto. @@ -1229,25 +1308,8 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- - -
-
Synopsis:
-
void ioncore.set_get_winprop_fn(function fn) - -
-
Description:
-
Set function used to look up winprops. - -
-
- -

- -

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

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

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

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

-
- - +
+ +
Synopsis:
-
table ioncore.tagged_list() +
void ioncore.tagged_clear()
Description:
-
Returns a list of tagged regions. +
Untag all regions. + +
+
+ +

+ +

+
+ + +
+
Synopsis:
+
WRegion ioncore.tagged_first(bool untag) + +
+
Description:
+
Returns first tagged object, untagging it as well if untagis set. + +
+
+ +

+ +

+
+ + +
+
Synopsis:
+
bool ioncore.tagged_i(function iterfn) + +
+
Description:
+
Iterate over tagged regions until iterfn returns false. + The function itself returns true if it reaches the end of list + without this happening.
@@ -1331,16 +1429,19 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- - +
+ +
Synopsis:
-
WRegion ioncore.tags_first() +
void ioncore.unsqueeze(WRegion reg, bool override)
Description:
-
Returns first tagged object. +
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.
@@ -1348,8 +1449,8 @@ When a keyboard resize function is called, and at most kbresize_t_max

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

-
- +
+
Synopsis:
@@ -1648,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.)
@@ -1668,8 +1773,8 @@ When a keyboard resize function is called, and at most kbresize_t_max

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

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

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

-
- +
+
Synopsis:
@@ -1743,45 +1848,48 @@ When a keyboard resize function is called, and at most kbresize_t_max
-

- -

-6.1.1 WClientWin functions -

-

-
- - +
+ +
Synopsis:
-
table WClientWin.get_ident(WClientWin cwin) +
ioncore.tagged_attach(reg, param)
Description:
-
Returns a table containing the properties WM_CLASS (table entries - instance and class) and WM_WINDOW_ROLE (role) - properties for cwin. If a property is not set, the corresponding - field(s) are unset in the table. +
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.
+

+ +

+6.1.1 WClientWin functions +

+

-
- - +
+ +
Synopsis:
-
bool WClientWin.is_fullscreen(WClientWin cwin) +
table WClientWin.get_ident(WClientWin cwin)
Description:
-
Is cwin in full screen mode? +
Returns a table containing the properties WM_CLASS (table entries + instance and class) and WM_WINDOW_ROLE (role) + properties for cwin. If a property is not set, the corresponding + field(s) are unset in the table.
@@ -1789,8 +1897,8 @@ When a keyboard resize function is called, and at most kbresize_t_max

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

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

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

-
- - -
-
Synopsis:
-
bool WClientWin.set_fullscreen(WClientWin cwin, string how) - -
-
Description:
-
Set client window cwin full screen state according to the - parameter how (set/unset/toggle). Resulting state is returned, - which may not be what was requested. - -
-
- -

- -

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

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

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

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

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

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

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

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

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

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

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

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

-
- +
+
Synopsis:
@@ -2133,27 +2222,84 @@ In addition parameters to the region to be created are passed in this

-
- - +
+ +
Synopsis:
-
table WGroup.managed_list(WGroup ws) +
bool WGroup.is_fullscreen(WGroup grp)
Description:
-
Returns a list of regions managed by the workspace (frames, mostly). +
Is reg in full screen mode?

-

-6.1.4 WGroupCW functions -

- -

+

+
+ + +
+
Synopsis:
+
bool WGroup.managed_i(WGroup ws, function iterfn) + +
+
Description:
+
Iterate over managed regions of ws until iterfn returns + false. + The function itself returns true if it reaches the end of list + without this happening. + +
+
+ +

+ +

+
+ + +
+
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:
+
bool WGroup.set_fullscreen(WGroup grp, string how) + +
+
Description:
+
Set client window reg full screen state according to the + parameter how (set/unset/toggle). Resulting state is returned, + which may not be what was requested. + +
+
+ +

+ +

+6.1.4 WGroupCW functions +

+ +

6.1.5 WGroupWS functions @@ -2162,8 +2308,8 @@ In addition parameters to the region to be created are passed in this

-
- +
+
Synopsis:
@@ -2201,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:
@@ -2224,8 +2370,8 @@ In addition parameters to the region to be created are passed in this

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

-
- +
+
Synopsis:
@@ -2289,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. @@ -2307,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:
@@ -2341,8 +2469,8 @@ In addition parameters to the region to be created are passed in this

-
- +
+
Synopsis:
@@ -2350,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.
@@ -2360,8 +2488,8 @@ In addition parameters to the region to be created are passed in this

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

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

-
- +
+
Synopsis:
@@ -2412,16 +2540,19 @@ In addition parameters to the region to be created are passed in this

-
- - +
+ +
Synopsis:
-
table WMPlex.managed_list(WMPlex mplex) +
bool WMPlex.managed_i(WMPlex mplex, function iterfn)
Description:
-
Returns a list of all regions managed by mplex. +
Iterate over managed regions of mplex until iterfn returns + false. + The function itself returns true if it reaches the end of list + without this happening.
@@ -2429,8 +2560,8 @@ In addition parameters to the region to be created are passed in this

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

-
- +
+
Synopsis:
@@ -2464,17 +2595,19 @@ In addition parameters to the region to be created are passed in this

-
- - +
+ +
Synopsis:
-
table WMPlex.mx_list(WMPlex mplex) +
bool WMPlex.mx_i(WMPlex mplex, function iterfn)
Description:
-
Returns a list of regions on the numbered/mutually exclusive list of - mplex. +
Iterate over numbered/mutually exclusive region list of mplex + until iterfn returns false. + The function itself returns true if it reaches the end of list + without this happening.
@@ -2482,8 +2615,8 @@ In addition parameters to the region to be created are passed in this

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

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

-
- +
+
Synopsis:
@@ -2528,14 +2661,14 @@ 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: - + - +
After WMPlex.mx_current.Last.
Last.After WMPlex.mx_current.
@@ -2545,8 +2678,8 @@ In addition parameters to the region to be created are passed in this

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

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

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

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

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

-
- +
+
Synopsis:
@@ -2680,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:
@@ -2713,8 +2863,8 @@ In addition parameters to the region to be created are passed in this

-
- +
+
Synopsis:
@@ -2730,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. + +
+
+

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

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

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

-
- +
+
Synopsis:
@@ -2797,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:
@@ -2819,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:
@@ -2836,8 +3040,8 @@ Note that this function is asynchronous; the region will not

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

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

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

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

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

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

-
- +
+
Synopsis:
@@ -2955,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:
@@ -2968,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.
@@ -2981,8 +3184,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -2993,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.
@@ -3002,8 +3205,8 @@ Note that this function is asynchronous; the region will not

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

-
- +
+
Synopsis:
@@ -3483,17 +3686,16 @@ Note that this function is asynchronous; the region will not

-
- - +
+ +
Synopsis:
-
bool mod_tiling.detach(WRegion reg) +
table mod_tiling.get()
Description:
-
Detach reg, i.e. make it managed by its nearest ancestor - WGroup, framed if reg is not itself WFrame. +
Get parameters. For details see mod_tiling.set.
@@ -3501,16 +3703,17 @@ Note that this function is asynchronous; the region will not

-
- - +
+ +
Synopsis:
-
table mod_tiling.get() +
bool mod_tiling.mkbottom(WRegion reg)
Description:
-
Get parameters. For details see mod_tiling.set. +
Create a new WTiling 'bottom' for the group of reg, + consisting of reg.
@@ -3518,17 +3721,17 @@ Note that this function is asynchronous; the region will not

-
- - +
+ +
Synopsis:
-
bool mod_tiling.mkbottom(WRegion reg) +
void mod_tiling.set(table tab)
Description:
-
Create a new WTiling 'bottom' for the group of reg, - consisting of reg. +
Set parameters. Currently only raise_delay (in milliseconds) + is supported.
@@ -3536,17 +3739,17 @@ Note that this function is asynchronous; the region will not

-
- - +
+ +
Synopsis:
-
void mod_tiling.set(table tab) +
bool mod_tiling.untile(WTiling tiling)
Description:
-
Set parameters. Currently only raise_delay (in milliseconds) - is supported. +
If tiling is managed by some group, float the frames in + the tiling in that group, and dispose of tiling.
@@ -3560,8 +3763,8 @@ Note that this function is asynchronous; the region will not

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

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

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

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

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

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

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

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

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

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

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

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

-
- +
+
Synopsis:
@@ -3813,16 +4016,19 @@ Note that this function is asynchronous; the region will not

-
- - +
+ +
Synopsis:
-
table WTiling.managed_list(WTiling ws) +
bool WTiling.managed_i(WTiling ws, function iterfn)
Description:
-
Returns a list of regions managed by the workspace (frames, mostly). +
Iterate over managed regions of ws until iterfn returns + false. + The function itself returns true if it reaches the end of list + without this happening.
@@ -3830,8 +4036,8 @@ Note that this function is asynchronous; the region will not

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

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

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

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

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

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

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

-
- +
+
Synopsis:
@@ -3982,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.
@@ -4006,8 +4212,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -4023,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:
@@ -4041,8 +4264,8 @@ Note that this function is asynchronous; the region will not

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

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

-
- +
+
Synopsis:
@@ -4092,19 +4315,20 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
-
integer mod_query.history_search(string s, integer from, bool bwd) +
integer mod_query.history_search(string s, integer from, bool bwd, bool exact)
Description:
Try to find matching history entry. Returns -1 if none was found. The parameter from specifies where to start searching from, and bwd causes backward search from - that point. + that point. If exact is not set, s only required + to be a prefix of the match.
@@ -4112,8 +4336,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -4129,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:
@@ -4170,6 +4377,10 @@ Note that this function is asynchronous; the region will not (integer) auto-show-completions delay in milliseconds (default: 250). +caseicompl +(boolean) Turn some completions case-insensitive + (default: false). + @@ -4178,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:
@@ -4219,8 +4413,8 @@ Note that this function is asynchronous; the region will not

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

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

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

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

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

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

-
- +
+
Synopsis:
@@ -4363,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:
@@ -4380,8 +4574,8 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
@@ -4398,17 +4592,18 @@ Note that this function is asynchronous; the region will not

-
- +
+
Synopsis:
-
mod_query.query_renameworkspace(mplex) +
mod_query.query_renameworkspace(mplex, ws)
Description:
-
This function asks for a name new for the workspace on which the - query resides. +
This function asks for a name new for the workspace ws, + or the one on which mplex resides, if it is not set. + If mplex is not set, one is looked for.
@@ -4416,8 +4611,8 @@ Note that this function is asynchronous; the region will not

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

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

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

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

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

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

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

-
- +
+
Synopsis:
@@ -4561,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. + +
+
+

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

-
- +
+
Synopsis:
@@ -5643,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:
@@ -5666,8 +6011,8 @@ Any parameters not explicitly set in conftab will be left unchanged.

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

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

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

-

+


-6.8 Hooks +6.9 Hooks

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

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

-
+
+ +
+
Hook name:
+
clientwin_property_change_hook + +
+
Parameters:
+
(WClientWin, integer) + +
+
Description:
+
Called when the property identified by the parameter atom id + (integer) has changed on a client window. + +
+
+ +

+ +

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

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

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

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

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

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

-
+
Hook name:
@@ -6018,85 +6384,11 @@ reg:attach(cwin)

-
- -
-
Hook name:
-
panews_make_placement_alt - -
-
Parameters:
-
table - -
-
Description:
-
Called to make a placement on panews. The parameter table has - the following fields: - -

- - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
wsWPaneWSThe workspace
frameWFrameA frame initially allocated for the - region to be placed
regWRegionThe region to be placed
specifierWRegionFor drag&drop on handling empty areas
- -

-The handler should set some of these fields on success: - -

- - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
res_nodeWSplitTarget split
res_configWFrameNew configuration for it, unless - WSplitRegion
res_wintegerNew width for target split (optional)
res_hintegerNew height for target split (optional)
- -

-
- -

- -

-
+
Hook name:
-
region_activated_hook +
region_do_warp_alt
Parameters:
@@ -6104,7 +6396,8 @@ The handler should set some of these fields on success:
Description:
-
Signalled when a region or one of its children has received the focus. +
This alt-hook exist to allow for alternative pointer warping + implementations.
@@ -6112,20 +6405,21 @@ The handler should set some of these fields on success:

-
+
Hook name:
-
region_activity_hook +
screen_managed_changed_hook
Parameters:
-
WRegion +
table
Description:
-
This hook is triggered when the activity flag of the parameter - region has been changed. +
Called when there are changes in the objects managed by a screen + or their order. The table parameter is similar to that of + frame_managed_changed_hook.
@@ -6133,98 +6427,104 @@ The handler should set some of these fields on success:

-
+
Hook name:
-
region_do_warp_alt +
region_notify_hook
Parameters:
-
WRegion +
(WRegion, string)
Description:
-
This alt-hook exist to allow for alternative pointer warping - implementations. - -
-
+
Signalled when something (minor) has changed in relation to + the first parameter region. The string argument gives the + change:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StringDescription
deinitThe region is about to be deinitialised.
activatedThe region has received focus.
inactivatedThe region has lost focus.
activityThere's been activity in the region itself.
sub_activityThere's been activity in some sub-region.
nameThe name of the region has changed.
unset_managerThe region no longer has a manager.
set_managerThe region now has a manager.
tagTagging state has changed.
pseudoactivatedThe region has become pseudoactive + (see below).
pseudoinactivatedThe region is no longer pseudoactive.
-

-
- -
-
Hook name:
-
region_inactivated_hook - -
-
Parameters:
-
WRegion - -
-
Description:
-
Signalled when the focus has moved from the parameter region or - one of its children to a non-child region of the parameter region. +

+A region is pseudoactive, when a) it is itself not active (does + not not have the focus, and may not even have a window that could + have it), but b) some region managed by it is active.

-

-
- -
-
Hook name:
-
screen_managed_changed_hook - -
-
Parameters:
-
table - -
-
Description:
-
Called when there are changes in the objects managed by a screen - or their order. The table parameter is similar to that of - frame_managed_changed_hook. - -
-
-

- next - up - previous - contents - index
- Next: Next: A. The GNU General - Up: Up: Configuring and extending Ion3 - Previous: Previous: 5. Scripting -   Contents -   Index