X-Git-Url: https://git.decadent.org.uk/gitweb/?a=blobdiff_plain;f=ionconf%2Fnode7.html;h=628a67028af7057943ef75d7a974892bc334e55d;hb=16a5f824c31d29598763c5f49918ef67a47ad7e0;hp=5a3e390e466263e9701eff33b458d3ec9d14b9f1;hpb=6e84dc8312f2fdb5b8b7467a0279afd5b2df107f;p=ion3-doc.git diff --git a/ionconf/node7.html b/ionconf/node7.html index 5a3e390..628a670 100644 --- a/ionconf/node7.html +++ b/ionconf/node7.html @@ -163,8 +163,8 @@ original version by: Nikos Drakos, CBLU, University of Leeds
-
- +
+
Synopsis:
@@ -180,8 +180,8 @@ original version by: Nikos Drakos, CBLU, University of Leeds

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

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

-
- +
+
Synopsis:
@@ -242,18 +242,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 +261,8 @@ The string guard maybe set to pose limits on _sub. Currently

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

-
- +
+
Synopsis:
@@ -298,8 +298,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 +336,8 @@ The string guard maybe set to pose limits on _sub. Currently

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

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

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

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

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

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

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

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

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

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

-
- +
+ + +
+
Synopsis:
+
ioncore.getlayout(name, all) + +
+
Description:
+
Get named layout (or all of the latter parameter is set, + but this is for internal use only). + +
+
+ +

+ +

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

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

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

-
- +
+
Synopsis:
@@ -565,16 +602,18 @@ The string guard maybe set to pose limits on _sub. Currently

-
- - +
+ +
Synopsis:
-
table ioncore.activity_list() +
bool ioncore.activity_i(function iterfn)
Description:
-
Return list of regions with activity/urgency bit set. +
Iterate over activity list until iterfn returns false. + The function itself returns true if it reaches the end of list + without this happening.
@@ -582,8 +621,8 @@ The string guard maybe set to pose limits on _sub. Currently

-
- +
+
Synopsis:
@@ -599,16 +638,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 +657,8 @@ The string guard maybe set to pose limits on _sub. Currently

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

-
- +
+
Synopsis:
@@ -687,8 +728,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 +772,8 @@ Similarly to sed's 's' command, rule may contain characters that are

-
- +
+
Synopsis:
@@ -716,10 +781,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 +808,8 @@ Similarly to sed's 's' command, rule may contain characters that are

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

-
- +
+
Synopsis:
@@ -1051,16 +1132,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 +1152,8 @@ Note that this function is asynchronous; the region will not

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

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

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

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

-
- +
+
Synopsis:
@@ -1208,10 +1292,6 @@ 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. -

@@ -1229,25 +1309,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 +1326,8 @@ When a keyboard resize function is called, and at most kbresize_t_max

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

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

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

-
- - +
+ +
Synopsis:
-
table ioncore.tagged_list() +
WRegion ioncore.tagged_first()
Description:
-
Returns a list of tagged regions. +
Returns first tagged object.
@@ -1331,16 +1394,18 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- - +
+ +
Synopsis:
-
WRegion ioncore.tags_first() +
bool ioncore.tagged_i(function iterfn)
Description:
-
Returns first tagged object. +
Iterate over tagged regions until iterfn returns false. + The function itself returns true if it reaches the end of list + without this happening.
@@ -1348,8 +1413,8 @@ When a keyboard resize function is called, and at most kbresize_t_max

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

-
- - -
-
Synopsis:
-
bool WClientWin.is_fullscreen(WClientWin cwin) - -
-
Description:
-
Is cwin in full screen mode? - -
-
- -

- -

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

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

-
- +
+
Synopsis:
@@ -1842,27 +1890,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 +1913,8 @@ When a keyboard resize function is called, and at most kbresize_t_max

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

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

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

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

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

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

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

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

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

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

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

-
- +
+
Synopsis:
@@ -2133,16 +2162,55 @@ 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? + +
+
+ +

+ +

+
+ + +
+
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_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.
@@ -2162,8 +2230,8 @@ In addition parameters to the region to be created are passed in this

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

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

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

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

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

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

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

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

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

-
- +
+
Synopsis:
@@ -2412,16 +2480,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 +2500,8 @@ In addition parameters to the region to be created are passed in this

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

-
- +
+
Synopsis:
@@ -2464,17 +2535,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 +2555,8 @@ In addition parameters to the region to be created are passed in this

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

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

-
- +
+
Synopsis:
@@ -2532,10 +2605,10 @@ In addition parameters to the region to be created are passed in this the mutually exclusive list. Special values for index are: - + - +
After WMPlex.mx_current.Last.
Last.After WMPlex.mx_current.
@@ -2545,8 +2618,8 @@ In addition parameters to the region to be created are passed in this

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

-
- +
+
Synopsis:
@@ -3483,26 +3556,8 @@ Note that this function is asynchronous; the region will not
-
- - -
-
Synopsis:
-
bool mod_tiling.detach(WRegion reg) - -
-
Description:
-
Detach reg, i.e. make it managed by its nearest ancestor - WGroup, framed if reg is not itself WFrame. - -
-
- -

- -

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

-
- +
+
Synopsis:
@@ -3813,16 +3868,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 +3888,8 @@ Note that this function is asynchronous; the region will not

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

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

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

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

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

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

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

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

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

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

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

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

-
- +
+
Synopsis:
@@ -4092,19 +4150,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 +4171,8 @@ Note that this function is asynchronous; the region will not

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

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

-
- +
+
Synopsis:
@@ -4170,6 +4229,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,8 +4241,8 @@ Note that this function is asynchronous; the region will not

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

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

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

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

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

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

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

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

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

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

-
- +
+
Synopsis:
@@ -4398,17 +4461,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 +4480,8 @@ Note that this function is asynchronous; the region will not

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

-
- +
+
Synopsis:
@@ -5725,7 +5789,7 @@ Any parameters not explicitly set in conftab will be left unchanged.

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

-
+
Hook name:
@@ -5817,7 +5881,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 +5923,7 @@ reg:attach(cwin)

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

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

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

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

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

-
+
Hook name:
@@ -6018,85 +6103,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 +6115,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 +6124,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,67 +6146,73 @@ 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. - -
-
-