X-Git-Url: https://git.decadent.org.uk/gitweb/?p=ion3-doc.git;a=blobdiff_plain;f=ionconf%2Fnode7.html;h=f9cc8550e144a70be4d0c365dc0f43d6df795c01;hp=5a3e390e466263e9701eff33b458d3ec9d14b9f1;hb=6c79ccf7ddf25af66675865badef0b8f6d0fee78;hpb=6e84dc8312f2fdb5b8b7467a0279afd5b2df107f diff --git a/ionconf/node7.html b/ionconf/node7.html index 5a3e390..f9cc855 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: A. The GNU General - Up: Next: A. GNU Free Documentation + Up: Configuring and extending Ion3 - Previous: Previous: 5. Scripting -   Contents -   Index

@@ -61,90 +61,106 @@ original version by: Nikos Drakos, CBLU, University of Leeds Subsections
@@ -163,9 +179,7 @@ original version by: Nikos Drakos, CBLU, University of Leeds
-
- - +
Synopsis:
ioncore.TR(s, ...) @@ -180,9 +194,7 @@ original version by: Nikos Drakos, CBLU, University of Leeds

-
- - +
Synopsis:
ioncore.bdoc(text) @@ -198,9 +210,7 @@ original version by: Nikos Drakos, CBLU, University of Leeds

-
- - +
Synopsis:
ioncore.chdir_for(reg, dir) @@ -215,9 +225,7 @@ original version by: Nikos Drakos, CBLU, University of Leeds

-
- - +
Synopsis:
ioncore.compile_cmd(cmd, guard) @@ -242,18 +250,31 @@ The string guard maybe set to pose limits on _sub. Currently

-
- - +
+
+
Synopsis:
+
WTimer ioncore.create_timer() + +
+
Description:
+
Create a new timer. + +
+
+ +

+ +

+
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,9 +282,7 @@ The string guard maybe set to pose limits on _sub. Currently

-
- - +
Synopsis:
ioncore.defbindings(context, bindings) @@ -272,7 +291,7 @@ The string guard maybe set to pose limits on _sub. Currently
Description:
Define bindings for context context. Here binding is a table composed of entries created with ioncore.kpress, - etc.; see section 3.3 for details. + etc.; see Section 3.3 for details.
@@ -280,9 +299,7 @@ The string guard maybe set to pose limits on _sub. Currently

-
- - +
Synopsis:
ioncore.defctxmenu(ctx, ...) @@ -298,9 +315,24 @@ 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:
ioncore.defmenu(name, tab) @@ -317,9 +349,7 @@ The string guard maybe set to pose limits on _sub. Currently

-
- - +
Synopsis:
ioncore.defwinprop(list) @@ -334,9 +364,7 @@ The string guard maybe set to pose limits on _sub. Currently

-
- - +
Synopsis:
ioncore.exec_on(reg, cmd, merr_internal) @@ -357,9 +385,7 @@ The string guard maybe set to pose limits on _sub. Currently

-
- - +
Synopsis:
table ioncore.read_savefile(string basename) @@ -374,9 +400,7 @@ The string guard maybe set to pose limits on _sub. Currently

-
- - +
Synopsis:
string ioncore.get_savefile(string basename) @@ -392,9 +416,7 @@ The string guard maybe set to pose limits on _sub. Currently

-
- - +
Synopsis:
string ioncore.lookup_script(string file, string sp) @@ -410,9 +432,7 @@ The string guard maybe set to pose limits on _sub. Currently

-
- - +
Synopsis:
bool ioncore.write_savefile(string basename, table tab) @@ -428,9 +448,7 @@ The string guard maybe set to pose limits on _sub. Currently

-
- - +
Synopsis:
ioncore.find_manager(obj, t) @@ -446,9 +464,7 @@ The string guard maybe set to pose limits on _sub. Currently

-
- - +
Synopsis:
ioncore.get_dir_for(reg) @@ -463,9 +479,7 @@ The string guard maybe set to pose limits on _sub. Currently

-
- - +
Synopsis:
ioncore.getbindings(maybe_context) @@ -480,9 +494,7 @@ The string guard maybe set to pose limits on _sub. Currently

-
- - +
Synopsis:
ioncore.getctxmenu(name) @@ -497,16 +509,15 @@ 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 +525,14 @@ 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 +540,14 @@ 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 +555,14 @@ 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 +570,14 @@ 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. +
Returns first region on activity list.
@@ -582,16 +585,17 @@ 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 is called in protected mode. + This routine returns true if it reaches the end of list + without this happening.
@@ -599,16 +603,17 @@ 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 is called in protected mode. + This routine returns true if it reaches the end of list + without this happening.
@@ -616,9 +621,7 @@ The string guard maybe set to pose limits on _sub. Currently

-
- - +
Synopsis:
WRegion ioncore.current() @@ -633,9 +636,7 @@ The string guard maybe set to pose limits on _sub. Currently

-
- - +
Synopsis:
bool ioncore.defshortening(string rx, string rule, bool always) @@ -687,9 +688,34 @@ 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 or any group it is the leader of + (see WRegion.groupleader_of), depending on whether how + is `set', `unset' or `toggle'. If this + region is not a window, it is put into a frame. + +

+Detaching a region means having it managed by its nearest ancestor + WGroup. Reattaching means having it managed where it used + to be managed, if a ``return placeholder'' exists. + +

+Additionally, setting how to `forget', can be used to + clear this return placeholder of the group leader of reg. + +

+
+ +

+ +

+
Synopsis:
integer ioncore.exec(string cmd) @@ -707,19 +733,32 @@ Similarly to sed's 's' command, rule may contain characters that are

-
- - +
Synopsis:
WScreen ioncore.find_screen_id(integer id)
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 is called in protected mode. + This routine returns true if it reaches the end of list + without this happening.
@@ -727,9 +766,7 @@ Similarly to sed's 's' command, rule may contain characters that are

-
- - +
Synopsis:
table ioncore.get() @@ -744,16 +781,15 @@ Similarly to sed's 's' command, rule may contain characters that are

-
- - +
Synopsis:
table ioncore.get_paths(table tab)
Description:
-
Get important directories (userdir, sessiondir, searchpath). +
Get important directories (the fields userdir, + sessiondir, searchpath in the returned table).
@@ -761,9 +797,7 @@ Similarly to sed's 's' command, rule may contain characters that are

-
- - +
Synopsis:
bool ioncore.goto_activity() @@ -778,20 +812,17 @@ Similarly to sed's 's' command, rule may contain characters that are

-
- - +
Synopsis:
WRegion ioncore.goto_first(WRegion reg, string dirstr, table param)
Description:
-
Go to first region within reg in direction dirstr - (up/down/left/right/beg/end/any). For information on param, - see ioncore.navi_next. Additionally this function supports - the boolean nofront field, for not bringing the object to - front. +
Go to first region within reg in direction dirstr. + For information on param, see ioncore.navi_next. + Additionally this function supports the boolean nofront field, + for not bringing the object to front.
@@ -799,20 +830,17 @@ Similarly to sed's 's' command, rule may contain characters that are

-
- - +
Synopsis:
WRegion ioncore.goto_next(WRegion reg, string dirstr, table param)
Description:
-
Go to region next from reg in direction dirstr - (up/down/left/right/next/prev/any). For information on param, - see ioncore.navi_next. Additionally this function supports - the boolean nofront field, for not bringing the object to - front. +
Go to region next from reg in direction dirstr. + For information on param, see ioncore.navi_next. + Additionally this function supports the boolean nofront + field, for not bringing the object to front.
@@ -820,9 +848,7 @@ Similarly to sed's 's' command, rule may contain characters that are

-
- - +
Synopsis:
WScreen ioncore.goto_next_screen() @@ -841,9 +867,7 @@ Note that this function is asynchronous; the screen will not

-
- - +
Synopsis:
WScreen ioncore.goto_nth_screen(integer id) @@ -862,9 +886,7 @@ Note that this function is asynchronous; the screen will not

-
- - +
Synopsis:
WScreen ioncore.goto_prev_screen() @@ -883,9 +905,7 @@ Note that this function is asynchronous; the screen will not

-
- - +
Synopsis:
WRegion ioncore.goto_previous() @@ -904,9 +924,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
bool ioncore.is_i18n() @@ -921,9 +939,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
bool ioncore.load_module(string modname) @@ -938,9 +954,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
WClientWin ioncore.lookup_clientwin(string name) @@ -955,9 +969,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
WRegion ioncore.lookup_region(string name, string typenam) @@ -973,18 +985,15 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
WRegion ioncore.navi_first(WRegion reg, string dirstr, table param)
Description:
-
Find first region within reg in direction dirstr - (up/down/left/right/beg/end/any). For information on param, - see ioncore.navi_next. +
Find first region within reg in direction dirstr. + For information on param, see ioncore.navi_next.
@@ -992,9 +1001,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
WRegion ioncore.navi_next(WRegion reg, string dirstr, table param) @@ -1002,12 +1009,13 @@ 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 - contain the boolean field nowrap, instructing not to wrap + (`up', `down', `left', `right', + `next', `prev', or `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,18 +1023,19 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
-
integer ioncore.popen_bgread(string cmd, function h, function errh) +
integer ioncore.popen_bgread(string cmd, function h, function errh, string wd)
Description:
-
Run cmd with a read pipe connected to its stdout. - When data is received through the pipe, handler is called - with that data. +
Run cmd in directory wd with a read pipe connected to its + stdout and stderr. + When data is received through one of these pipes, h or errh + is called with that data. When the pipe is closed, the handler is called + with nil argument. The PID of the new process is returned, or + -1 on error.
@@ -1034,9 +1043,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
string ioncore.progname() @@ -1051,16 +1058,18 @@ 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 is called in protected mode. + This routine returns true if it reaches the end of list + without this happening.
@@ -1068,9 +1077,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
void ioncore.request_selection(function fn) @@ -1086,9 +1093,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
void ioncore.resign() @@ -1104,9 +1109,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
void ioncore.restart() @@ -1121,9 +1124,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
void ioncore.restart_other(string cmd) @@ -1138,9 +1139,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
void ioncore.set(table tab) @@ -1176,7 +1175,8 @@ Note that this function is asynchronous; the region will not frame_default_index (string) Specifies where to add new regions on the mutually exclusive list of a frame. One of - ''last'', ''next'' (for after current), ''next-act'' + `last', `next', (for after current), + or `next-act' (for after current and anything with activity right after it). @@ -1200,17 +1200,27 @@ Note that this function is asynchronous; the region will not kbresize_maxacc (floating point) See below. +edge_resistance +(integer) Resize edge resistance in pixels. + framed_transients (boolean) Put transients in nested frames. float_placement_method (string) How to place floating frames. - One of ''udlr'' (up-down, then left-right), - ''lrud'' (left-right, then up-down) or ''random''. + One of `udlr' (up-down, then left-right), + `lrud' (left-right, then up-down), or + `random'. + +mousefocus +(string) Mouse focus mode: + `disabled' or `sloppy'. -default_ws_params -(table) Default workspace layout; the - attach/creation parameters for a WGroup. +unsqueeze +(boolean) Auto-unsqueeze transients/menus/queries/etc. + +autoraise +(boolean) Autoraise regions in groups on goto. @@ -1229,16 +1239,15 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- - +
Synopsis:
-
void ioncore.set_get_winprop_fn(function fn) +
bool ioncore.set_paths(table tab)
Description:
-
Set function used to look up winprops. +
Set important directories (the fields sessiondir, searchpath + of tab).
@@ -1246,16 +1255,14 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- - +
Synopsis:
-
bool ioncore.set_paths(table tab) +
void ioncore.set_selection(string p)
Description:
-
Set important directories (sessiondir, searchpath). +
Set primary selection and cutbuffer0 to p.
@@ -1263,16 +1270,14 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- - +
Synopsis:
-
void ioncore.set_selection(string p) +
void ioncore.shutdown()
Description:
-
Set primary selection and cutbuffer0 to p. +
End session saving it first.
@@ -1280,16 +1285,14 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- - +
Synopsis:
-
void ioncore.shutdown() +
void ioncore.snapshot()
Description:
-
End session saving it first. +
Save session.
@@ -1297,16 +1300,29 @@ When a keyboard resize function is called, and at most kbresize_t_max

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

+ +

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

-
- - +
Synopsis:
-
table ioncore.tagged_list() +
bool ioncore.tagged_i(function iterfn)
Description:
-
Returns a list of tagged regions. +
Iterate over tagged regions until iterfn returns false. + The function is called in protected mode. + This routine returns true if it reaches the end of list + without this happening.
@@ -1331,16 +1348,17 @@ 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,9 +1366,7 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- - +
Synopsis:
string ioncore.version() @@ -1365,9 +1381,7 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- - +
Synopsis:
void ioncore.warn(string str) @@ -1383,9 +1397,7 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- - +
Synopsis:
void ioncore.warn_traced(string str) @@ -1400,9 +1412,7 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- - +
Synopsis:
void ioncore.x_change_property(integer win, integer atom, integer atom_type, integer format, string mode, table tab) @@ -1410,7 +1420,7 @@ When a keyboard resize function is called, and at most kbresize_t_max
Description:
Modify a window property. The mode is one of - "replace", "prepend" or "append", and format + `replace', `prepend' or `append', and format is either 8, 16 or 32. Also see ioncore.x_get_window_property and the XChangeProperty(3) manual page. @@ -1420,9 +1430,7 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- - +
Synopsis:
void ioncore.x_delete_property(integer win, integer atom) @@ -1437,9 +1445,7 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- - +
Synopsis:
string ioncore.x_get_atom_name(integer atom) @@ -1455,17 +1461,14 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- - +
Synopsis:
table ioncore.x_get_text_property(integer win, integer atom)
Description:
-
Get a text property for a window (STRING, COMPOUND_TEXT, - or UTF8_STRING property converted). The fields in the returned +
Get a text property for a window. The fields in the returned table (starting from 1) are the null-separated parts of the property. See the XGetTextProperty(3) manual page for more information. @@ -1475,9 +1478,7 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- - +
Synopsis:
table ioncore.x_get_window_property(integer win, integer atom, integer atom_type, integer n32expected, bool more) @@ -1497,9 +1498,7 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- - +
Synopsis:
integer ioncore.x_intern_atom(string name, bool only_if_exists) @@ -1514,9 +1513,7 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- - +
Synopsis:
void ioncore.x_set_text_property(integer win, integer atom, table tab) @@ -1533,9 +1530,7 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- - +
Synopsis:
ioncore.kpress(keyspec, cmd, guard) @@ -1543,8 +1538,9 @@ When a keyboard resize function is called, and at most kbresize_t_max
Description:
Creates a binding description table for the action of pressing a key given - by keyspec (with possible modifiers) to the function func. - For more information on bindings, see section 3.3. + by keyspec (with possible modifiers) to the function cmd. + The guard controls when the binding can be called. + For more informationp see Section 3.3.
@@ -1552,19 +1548,32 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- - +
Synopsis:
ioncore.kpress_wait(keyspec, cmd, guard)
Description:
-
This is similar to kpress but after calling cmd, +
This is similar to ioncore.kpress but after calling cmd, Ioncore waits for all modifiers to be released before processing any further actions. - For more information on bindings, see section 3.3. + For more information on bindings, see Section 3.3. + +
+
+ +

+ +

+
+
+
Synopsis:
+
bool ioncore.defer(function fn) + +
+
Description:
+
Defer execution of fn until the main loop.
@@ -1572,12 +1581,25 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- - +
Synopsis:
-
ioncore.match_winprop_name(prop, cwin) +
WHook ioncore.get_hook(string name) + +
+
Description:
+
Find named hook name. + +
+
+ +

+ +

+
+
+
Synopsis:
+
ioncore.match_winprop_dflt(prop, cwin, id)
Description:
@@ -1589,9 +1611,7 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- - +
Synopsis:
ioncore.mclick(buttonspec, cmd, guard) @@ -1600,8 +1620,8 @@ When a keyboard resize function is called, and at most kbresize_t_max
Description:
Creates a binding description table for the action of clicking a mouse button while possible modifier keys are pressed, - both given by buttonspec, to the function func. - For more information, see section 3.3. + both given by buttonspec, to the function cmd. + For more information, see Section 3.3.
@@ -1609,17 +1629,15 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- - +
Synopsis:
ioncore.mdblclick(buttonspec, cmd, guard)
Description:
-
Similar to mclick but for double-click. - Also see section 3.3. +
Similar to ioncore.mclick but for double-click. + Also see Section 3.3.
@@ -1627,9 +1645,7 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- - +
Synopsis:
ioncore.mdrag(buttonspec, cmd, guard) @@ -1648,19 +1664,21 @@ 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,17 +1686,15 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- - +
Synopsis:
ioncore.mpress(buttonspec, cmd, guard)
Description:
-
Similar to mclick but for just pressing the mouse button. - Also see section 3.3. +
Similar to ioncore.mclick but for just pressing the mouse button. + Also see Section 3.3.
@@ -1686,9 +1702,7 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- - +
Synopsis:
ioncore.refresh_stylelist() @@ -1703,19 +1717,47 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- - +
Synopsis:
-
ioncore.submap(kcb_, list) +
ioncore.submap(keyspec, list)
Description:
Returns a function that creates a submap binding description table. When the key press action keyspec occurs, Ioncore will wait for a further key presse and act according to the submap. - For details, see section 3.3. + For details, see Section 3.3. + +
+
+ +

+ +

+
+
+
Synopsis:
+
ioncore.submap_enter(cmd, guard) + +
+
Description:
+
Submap enter event for bindings. + +
+
+ +

+ +

+
+
+
Synopsis:
+
ioncore.submap_wait(cmd, guard) + +
+
Description:
+
Submap modifier release event for bindings.
@@ -1723,9 +1765,7 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- - +
Synopsis:
ioncore.submenu(name, sub_or_name, options) @@ -1745,26 +1785,33 @@ When a keyboard resize function is called, and at most kbresize_t_max

-

-6.1.1 WClientWin functions -

+
+
+
+
Synopsis:
+
ioncore.tabnum.clear() + +
+
Description:
+
Clear all tab numbers set by ioncore.tabnum.show. + +
+

-
- - +
Synopsis:
-
table WClientWin.get_ident(WClientWin cwin) +
ioncore.tabnum.show(frame, delay)
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. +
Show tab numbers on frame, clearing them when submap + grab is released the next time. If delay is given, in + milliseconds, the numbers are not actually displayed until this + time has passed.
@@ -1772,34 +1819,43 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- - +
Synopsis:
-
bool WClientWin.is_fullscreen(WClientWin cwin) +
ioncore.tagged_attach(reg, param)
Description:
-
Is cwin in full screen mode? +
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. + The function returns true if all tagged regions were + succesfully attached, and false otherwisse.
+

+ +

+6.1.1 WClientWin functions +

+

-
- - +
Synopsis:
-
void WClientWin.kill(WClientWin cwin) +
table WClientWin.get_ident(WClientWin cwin)
Description:
-
Attempt to kill (with XKillWindow) the client that owns the X - window correspoding to cwin. +
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.
@@ -1807,17 +1863,15 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- - +
Synopsis:
-
void WClientWin.nudge(WClientWin cwin) +
void WClientWin.kill(WClientWin cwin)
Description:
-
Attempts to fix window size problems with non-ICCCM compliant - programs. +
Attempt to kill (with XKillWindow) the client that owns + the X window correspoding to cwin.
@@ -1825,16 +1879,15 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- - +
Synopsis:
-
void WClientWin.quote_next(WClientWin cwin) +
void WClientWin.nudge(WClientWin cwin)
Description:
-
Send next key press directly to cwin. +
Attempts to fix window size problems with non-ICCCM compliant + programs.
@@ -1842,18 +1895,14 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- - +
Synopsis:
-
bool WClientWin.set_fullscreen(WClientWin cwin, string how) +
void WClientWin.quote_next(WClientWin cwin)
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. +
Send next key press directly to cwin.
@@ -1861,9 +1910,7 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- - +
Synopsis:
double WClientWin.xid(WClientWin cwin) @@ -1884,9 +1931,7 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- - +
Synopsis:
bool WFrame.is_shaded(WFrame frame) @@ -1901,9 +1946,7 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- - +
Synopsis:
void WFrame.maximize_horiz(WFrame frame) @@ -1918,9 +1961,7 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- - +
Synopsis:
void WFrame.maximize_vert(WFrame frame) @@ -1935,9 +1976,7 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- - +
Synopsis:
string WFrame.mode(WFrame frame) @@ -1952,9 +1991,7 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- - +
Synopsis:
void WFrame.p_switch_tab(WFrame frame) @@ -1970,9 +2007,7 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- - +
Synopsis:
void WFrame.p_tabdrag(WFrame frame) @@ -1981,7 +2016,7 @@ When a keyboard resize function is called, and at most kbresize_t_max
Description:
Start dragging the tab that the user pressed on with the pointing device. This function should only be used by binding it to mpress or - mdrag action with area ''tab''. + mdrag action with area `tab'.
@@ -1989,16 +2024,16 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- - +
Synopsis:
-
bool WFrame.set_mode(WFrame frame, string modestr) +
bool WFrame.set_grattr(WFrame frame, string attr, string how)
Description:
-
Set frame mode. +
Set extra drawing engine attributes for the frame. + The parameter attr is the attribute, and how is + one of `set', `unset', or `toggle'.
@@ -2006,18 +2041,16 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- - +
Synopsis:
-
bool WFrame.set_numbers(WFrame frame, string how) +
bool WFrame.set_mode(WFrame frame, string modestr)
Description:
-
Control whether tabs show numbers (set/unset/toggle). - Resulting state is returned, which may not be what was - requested. +
Set frame mode (one of + `unknown', `tiled', `floating', `transient', + or any of these suffixed with `-alt').
@@ -2025,9 +2058,7 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- - +
Synopsis:
bool WFrame.set_shaded(WFrame frame, string how) @@ -2035,7 +2066,8 @@ When a keyboard resize function is called, and at most kbresize_t_max
Description:
Set shading state according to the parameter how - (set/unset/toggle). Resulting state is returned, which may not be + (`set', `unset', or `toggle'). + Resulting state is returned, which may not be what was requested.
@@ -2050,9 +2082,7 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- - +
Synopsis:
WRegion WGroup.attach(WGroup ws, WRegion reg, table param) @@ -2069,9 +2099,7 @@ When a keyboard resize function is called, and at most kbresize_t_max

-
- - +
Synopsis:
WRegion WGroup.attach_new(WGroup ws, table param) @@ -2087,22 +2115,26 @@ When a keyboard resize function is called, and at most kbresize_t_max Description type -Class name (a string) of the object to be created. Mandatory. +(string) Class of the object to be created. Mandatory. name -Name of the object to be created (a string). Optional. +(string) Name of the object to be created. switchto -Should the region be switched to (boolean)? Optional. +(boolean) Should the region be switched to? level -Stacking level; default is 1. +(integer) Stacking level; default is 1. modal -Make object modal; ignored if level is set. +(boolean) Make object modal; ignored if level is set. sizepolicy -Size policy. +(string) Size policy; see Section 6.10.1. + +bottom +(boolean) Mark the attached region as the + ``bottom'' of ws. @@ -2116,16 +2148,49 @@ In addition parameters to the region to be created are passed in this

-
- - +
Synopsis:
WRegion WGroup.bottom(WGroup ws)
Description:
-
Returns the 'bottom' of ws. +
Returns the `bottom' of ws. + +
+
+ +

+ +

+
+
+
Synopsis:
+
bool WGroup.managed_i(WGroup ws, function iterfn) + +
+
Description:
+
Iterate over managed regions of ws until iterfn returns + false. + The function is called in protected mode. + This routine 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.
@@ -2133,16 +2198,17 @@ In addition parameters to the region to be created are passed in this

-
- - +
Synopsis:
-
table WGroup.managed_list(WGroup ws) +
bool WGroup.set_fullscreen(WGroup grp, string how)
Description:
-
Returns a list of regions managed by the workspace (frames, mostly). +
Set client window reg full screen state according to the + parameter how (one of `set', `unset', or + `toggle'). Resulting state is returned, which may not be + what was requested.
@@ -2162,9 +2228,7 @@ In addition parameters to the region to be created are passed in this

-
- - +
Synopsis:
bool WGroupWS.attach_framed(WGroupWS ws, WRegion reg, table t) @@ -2195,76 +2259,123 @@ In addition parameters to the region to be created are passed in this

-6.1.6 WInfoWin functions +6.1.6 WHook functions

-
- - +
Synopsis:
-
void WInfoWin.set_text(WInfoWin p, string str) +
bool WHook.add(WHook hk, function efn)
Description:
-
Set contents of the info window. +
Add efn to the list of functions to be called when the + hook hk is triggered.

-

-6.1.7 WMPlex functions -

+
+
+
+
Synopsis:
+
bool WHook.listed(WHook hk, function efn) + +
+
Description:
+
Is fn hooked to hook hk? + +
+

-
- - +
Synopsis:
-
WRegion WMPlex.attach(WMPlex mplex, WRegion reg, table param) +
bool WHook.remove(WHook hk, function efn)
Description:
-
Attach and reparent existing region reg to mplex. - The table param may contain the fields index and - switchto that are interpreted as for WMPlex.attach_new. +
Remove efn from the list of functions to be called when the + hook hk is triggered.
+

+ +

+6.1.7 WInfoWin functions +

+

-
- - +
Synopsis:
-
WRegion WMPlex.attach_new(WMPlex mplex, table param) +
void WInfoWin.set_text(WInfoWin p, string str, integer maxw)
Description:
-
Create a new region to be managed by mplex. At least the following - fields in param are understood (all but type are optional). +
Set contents of the info window. + +
+

- - - - - - - - - + +

+6.1.8 WMPlex functions +

+ +

+ +

+
+
+
Synopsis:
+
WRegion WMPlex.attach(WMPlex mplex, WRegion reg, table param) + +
+
Description:
+
Attach and reparent existing region reg to mplex. + The table param may contain the fields index and + switchto that are interpreted as for WMPlex.attach_new. + +
+
+ +

+ +

+
+
+
Synopsis:
+
WRegion WMPlex.attach_new(WMPlex mplex, table param) + +
+
Description:
+
Create a new region to be managed by mplex. At least the following + fields in param are understood (all but type are optional). + +

+

FieldDescription
type(string) Class name (a string) of the object to be created.
name(string) Name of the object to be created (a string).
+ + + + + + + + @@ -2288,9 +2399,17 @@ In addition parameters to the region to be created are passed in this by e.g. the mutually exclusive list being empty. This option overrides switchto. + + + + + + - + @@ -2307,33 +2426,14 @@ 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:
void WMPlex.dec_index(WMPlex mplex, WRegion r)
Description:
-
Move r ''right'' within objects managed by mplex on list 1. +
Move r ``left'' within objects managed by mplex on list 1.
@@ -2341,18 +2441,16 @@ In addition parameters to the region to be created are passed in this

-
- - +
Synopsis:
integer WMPlex.get_index(WMPlex mplex, WRegion reg)
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,9 +2458,7 @@ In addition parameters to the region to be created are passed in this

-
- - +
Synopsis:
table WMPlex.get_stdisp(WMPlex mplex) @@ -2378,16 +2474,14 @@ In addition parameters to the region to be created are passed in this

-
- - +
Synopsis:
void WMPlex.inc_index(WMPlex mplex, WRegion r)
Description:
-
Move r ''right'' within objects managed by mplex on list 1. +
Move r ``right'' within objects managed by mplex on list 1.
@@ -2395,9 +2489,7 @@ In addition parameters to the region to be created are passed in this

-
- - +
Synopsis:
bool WMPlex.is_hidden(WMPlex mplex, WRegion reg) @@ -2412,16 +2504,18 @@ 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 is called in protected mode. + This routine returns true if it reaches the end of list + without this happening.
@@ -2429,9 +2523,7 @@ In addition parameters to the region to be created are passed in this

-
- - +
Synopsis:
integer WMPlex.mx_count(WMPlex mplex) @@ -2446,9 +2538,7 @@ In addition parameters to the region to be created are passed in this

-
- - +
Synopsis:
WRegion WMPlex.mx_current(WMPlex mplex) @@ -2464,17 +2554,18 @@ 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 is called in protected mode. + This routine returns true if it reaches the end of list + without this happening.
@@ -2482,17 +2573,15 @@ In addition parameters to the region to be created are passed in this

-
- - +
Synopsis:
WRegion WMPlex.mx_nth(WMPlex mplex, integer n)
Description:
-
Returns the n:th object managed by mplex on the - l:th layer. +
Returns the n:th object on the mutually exclusive + list of mplex.
@@ -2500,9 +2589,7 @@ In addition parameters to the region to be created are passed in this

-
- - +
Synopsis:
bool WMPlex.set_hidden(WMPlex mplex, WRegion reg, string how) @@ -2510,7 +2597,8 @@ In addition parameters to the region to be created are passed in this
Description:
Set the visibility of the region reg on mplex - as specified with the parameter how (set/unset/toggle). + as specified with the parameter how + (one of `set', `unset', or `toggle'). The resulting state is returned.
@@ -2519,24 +2607,28 @@ In addition parameters to the region to be created are passed in this

-
- - +
Synopsis:
void WMPlex.set_index(WMPlex mplex, WRegion reg, integer index)
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:
FieldDescription
type(string) Class name (a string) of the object to be created.
name(string) Name of the object to be created (a string).
switchto (boolean) Should the region be switched to (boolean)?
passive(boolean) Skip in certain focusing operations.
pseudomodal(boolean) The attached region is ``pseudomodal'' + if the stacking level dictates it to be modal. + This means that the region may be hidden to display + regions with lesser stacking levels.
sizepolicy(integer) Size policy. - (TODO: document them somewhere.)(string) Size policy; see Section 6.10.1.
geom (table) Geometry specification.
- - - - + + + +
After WMPlex.mx_current.
$-1$ Last.
$-2$After WMPlex.mx_current.

@@ -2545,9 +2637,7 @@ In addition parameters to the region to be created are passed in this

-
- - +
Synopsis:
WRegion WMPlex.set_stdisp(WMPlex mplex, table t) @@ -2565,15 +2655,19 @@ In addition parameters to the region to be created are passed in this Description pos -The corner of the screen to place the status display - in. One of tl, tr, bl or br. +(string) The corner of the screen to place the status + display in: one of `tl', `tr', `bl' + or `br'. + +fullsize +(boolean) Waste all available space. action -If this field is set to keep, corner - and orientation are changed for the existing - status display. If this field is set to remove, +(string) If this field is set to `keep', + pos and fullsize are changed for the existing + status display. If this field is set to `remove', the existing status display is removed. If this - field is not set or is set to replace, a + field is not set or is set to `replace', a new status display is created and the old, if any, removed. @@ -2585,9 +2679,7 @@ In addition parameters to the region to be created are passed in this

-
- - +
Synopsis:
void WMPlex.switch_next(WMPlex mplex) @@ -2603,9 +2695,7 @@ In addition parameters to the region to be created are passed in this

-
- - +
Synopsis:
void WMPlex.switch_nth(WMPlex mplex, integer n) @@ -2620,9 +2710,7 @@ In addition parameters to the region to be created are passed in this

-
- - +
Synopsis:
void WMPlex.switch_prev(WMPlex mplex) @@ -2637,16 +2725,14 @@ In addition parameters to the region to be created are passed in this

-

-6.1.8 WMoveresMode functions +

+6.1.9 WMoveresMode functions

-
- - +
Synopsis:
void WMoveresMode.cancel(WMoveresMode mode) @@ -2662,9 +2748,7 @@ In addition parameters to the region to be created are passed in this

-
- - +
Synopsis:
void WMoveresMode.finish(WMoveresMode mode) @@ -2680,9 +2764,22 @@ In addition parameters to the region to be created are passed in this

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

+ +

+
Synopsis:
void WMoveresMode.move(WMoveresMode mode, integer horizmul, integer vertmul) @@ -2713,9 +2810,7 @@ In addition parameters to the region to be created are passed in this

-
- - +
Synopsis:
void WMoveresMode.resize(WMoveresMode mode, integer left, integer right, integer top, integer bottom) @@ -2732,16 +2827,30 @@ In addition parameters to the region to be created are passed in this

-

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

+ +

+6.1.10 WRegion functions

-
- - +
Synopsis:
WMoveresMode WRegion.begin_kbresize(WRegion reg) @@ -2761,16 +2870,14 @@ In addition parameters to the region to be created are passed in this

-
- - +
Synopsis:
WRegion WRegion.current(WRegion mgr)
Description:
-
Return the object, if any, that is considered ''currently active'' +
Return the object, if any, that is considered ``currently active'' within the objects managed by mplex.
@@ -2779,9 +2886,7 @@ In addition parameters to the region to be created are passed in this

-
- - +
Synopsis:
table WRegion.geom(WRegion reg) @@ -2797,9 +2902,23 @@ 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:
bool WRegion.goto(WRegion reg) @@ -2819,12 +2938,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:
-
bool WRegion.is_active(WRegion reg) +
bool WRegion.is_active(WRegion reg, bool pseudoact_ok)
Description:
@@ -2836,9 +2969,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
bool WRegion.is_activity(WRegion reg) @@ -2853,9 +2984,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
bool WRegion.is_mapped(WRegion reg) @@ -2870,9 +2999,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
bool WRegion.is_tagged(WRegion reg) @@ -2887,9 +3014,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
WRegion WRegion.manager(WRegion reg) @@ -2904,9 +3029,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
string WRegion.name(WRegion reg) @@ -2921,9 +3044,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
WWindow WRegion.parent(WRegion reg) @@ -2938,9 +3059,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
WRootWin WRegion.rootwin_of(WRegion reg) @@ -2955,12 +3074,10 @@ 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 +3085,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,9 +3097,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
WRegion WRegion.rqclose_propagate(WRegion reg, WRegion maybe_sub) @@ -2993,8 +3107,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,9 +3116,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
table WRegion.rqgeom(WRegion reg, table g) @@ -3022,9 +3134,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
bool WRegion.rqorder(WRegion reg, string ord) @@ -3032,7 +3142,7 @@ Note that this function is asynchronous; the region will not
Description:
Request ordering. Currently supported values for ord - are 'front' and 'back'. + are `front' and `back'.
@@ -3040,9 +3150,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
WScreen WRegion.screen_of(WRegion reg) @@ -3057,17 +3165,15 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
bool WRegion.set_activity(WRegion reg, string how)
Description:
-
Set activity flag of reg. The how parameter most be - one of (set/unset/toggle). +
Set activity flag of reg. The how parameter must be + one of `set', `unset' or `toggle'.
@@ -3075,9 +3181,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
bool WRegion.set_name(WRegion reg, string p) @@ -3085,7 +3189,7 @@ Note that this function is asynchronous; the region will not
Description:
Set the name of reg to p. If the name is already in use, - an instance number suffix <n> will be attempted. If p has + an instance number suffix `<n>' will be attempted. If p has such a suffix, it will be modified, otherwise such a suffix will be added. Setting p to nil will cause current name to be removed. @@ -3095,9 +3199,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
bool WRegion.set_name_exact(WRegion reg, string p) @@ -3106,7 +3208,7 @@ Note that this function is asynchronous; the region will not
Description:
Similar to WRegion.set_name except if the name is already in use, other instance numbers will not be attempted. The string p should - not contain a <n> suffix or this function will fail. + not contain a `<n>' suffix or this function will fail.
@@ -3114,9 +3216,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
bool WRegion.set_tagged(WRegion reg, string how) @@ -3124,7 +3224,8 @@ Note that this function is asynchronous; the region will not
Description:
Change tagging state of reg as defined by how - (set/unset/toggle). Resulting state is returned. + (one of `set', `unset', or `toggle'). + The resulting state is returned.
@@ -3132,9 +3233,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
table WRegion.size_hints(WRegion reg) @@ -3150,16 +3249,14 @@ Note that this function is asynchronous; the region will not

-

-6.1.10 WRootWin functions +

+6.1.11 WRootWin functions

-
- - +
Synopsis:
WScreen WRootWin.current_scr(WRootWin rootwin) @@ -3173,16 +3270,14 @@ Note that this function is asynchronous; the region will not

-

-6.1.11 WScreen functions +

+6.1.12 WScreen functions

-
- - +
Synopsis:
integer WScreen.id(WScreen scr) @@ -3197,9 +3292,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
bool WScreen.set_managed_offset(WScreen scr, table offset) @@ -3216,16 +3309,65 @@ Note that this function is asynchronous; the region will not

-

-6.1.12 WWindow functions +

+6.1.13 WTimer functions +

+ +

+ +

+
+
+
Synopsis:
+
bool WTimer.is_set(WTimer timer) + +
+
Description:
+
Is timer set? + +
+
+ +

+ +

+
+
+
Synopsis:
+
void WTimer.reset(WTimer timer) + +
+
Description:
+
Reset timer. + +
+
+ +

+ +

+
+
+
Synopsis:
+
void WTimer.set(WTimer timer, integer msecs, function fn) + +
+
Description:
+
Set timer to call fn in msecs milliseconds. + +
+
+ +

+ +

+6.1.14 WWindow functions

-
- - +
Synopsis:
void WWindow.p_move(WWindow wwin) @@ -3242,9 +3384,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
void WWindow.p_resize(WWindow wwin) @@ -3261,9 +3401,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
double WWindow.xid(WWindow wwin) @@ -3277,15 +3415,14 @@ Note that this function is asynchronous; the region will not

-

-6.1.13 global functions +

+6.1.15 global functions

-
- +
Synopsis:
export(lib, ...) @@ -3299,23 +3436,21 @@ Note that this function is asynchronous; the region will not

-

-6.1.14 gr functions +

+6.1.16 gr functions

-
- - +
Synopsis:
void gr.read_config()
Description:
-
Read drawing engine configuration file draw.lua. +
Read drawing engine configuration file look.lua.
@@ -3323,9 +3458,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
void gr.refresh() @@ -3340,16 +3473,14 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
bool gr.select_engine(string engine)
Description:
-
Future requests for ''brushes'' are to be forwarded to the drawing engine +
Future requests for ``brushes'' are to be forwarded to the drawing engine engine. If no engine of such name is known, a module with that name is attempted to be loaded. This function is only intended to be called from colour scheme etc. configuration files and can not be used to change the @@ -3360,16 +3491,14 @@ Note that this function is asynchronous; the region will not

-

-6.1.15 string functions +

+6.1.17 string functions

-
- - +
Synopsis:
string.shell_safe(str) @@ -3383,16 +3512,14 @@ Note that this function is asynchronous; the region will not

-

-6.1.16 table functions +

+6.1.18 table functions

-
- - +
Synopsis:
table.append(t1, t2) @@ -3407,9 +3534,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
table.copy(t, deep) @@ -3425,9 +3550,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
table.icat(t1, t2) @@ -3442,9 +3565,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
table.join(t1, t2) @@ -3460,9 +3581,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
table.map(f, t) @@ -3483,17 +3602,14 @@ 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 +3617,15 @@ 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 +3633,15 @@ 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 +3649,15 @@ 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,9 +3671,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
table WSplit.geom(WSplit split) @@ -3577,9 +3686,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
WSplitInner WSplit.parent(WSplit split) @@ -3594,9 +3701,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
table WSplit.rqgeom(WSplit node, table g) @@ -3613,9 +3718,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
void WSplit.transpose(WSplit node) @@ -3636,9 +3739,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
WSplit WSplitInner.current(WSplitInner node) @@ -3659,9 +3760,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
WRegion WSplitRegion.reg(WSplitRegion node) @@ -3682,9 +3781,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
WSplit WSplitSplit.br(WSplitSplit split) @@ -3700,17 +3797,15 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
string WSplitSplit.dir(WSplitSplit split)
Description:
-
Returns the direction of split; either ''vertical'' or - ''horizontal''. +
Returns the direction of split; either `vertical' or + `horizontal'.
@@ -3718,16 +3813,14 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
void WSplitSplit.flip(WSplitSplit split)
Description:
-
Flip contents of node. +
Flip contents of split.
@@ -3735,9 +3828,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
WSplit WSplitSplit.tl(WSplitSplit split) @@ -3759,9 +3850,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
bool WTiling.flip_at(WTiling ws, WRegion reg) @@ -3776,9 +3865,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
bool WTiling.transpose_at(WTiling ws, WRegion reg) @@ -3793,9 +3880,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
WRegion WTiling.farthest(WTiling ws, string dirstr, bool any) @@ -3804,8 +3889,8 @@ Note that this function is asynchronous; the region will not
Description:
Return the most previously active region on ws with no other regions next to it in direction dirstr - (left/right/up/down). If any is not set, the status - display is not considered. + (`left', `right', `up', or `down'). + If any is not set, the status display is not considered.
@@ -3813,16 +3898,18 @@ 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 is called in protected mode. + This routine returns true if it reaches the end of list + without this happening.
@@ -3830,9 +3917,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
WRegion WTiling.nextto(WTiling ws, WRegion reg, string dirstr, bool any) @@ -3840,7 +3925,8 @@ Note that this function is asynchronous; the region will not
Description:
Return the most previously active region next to reg in - direction dirstr (left/right/up/down). The region reg + direction dirstr (`left', `right', `up', + or `down'). The region reg must be managed by ws. If any is not set, the status display is not considered. @@ -3850,9 +3936,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
WSplitRegion WTiling.node_of(WTiling ws, WRegion reg) @@ -3868,9 +3952,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
bool WTiling.set_floating_at(WTiling ws, WRegion reg, string how, string dirstr) @@ -3878,9 +3960,10 @@ Note that this function is asynchronous; the region will not
Description:
Toggle floating of the sides of a split containin reg as indicated - by the parameters how (set/unset/toggle) and dirstr - (left/right/up/down/any). The new status is returned (and false - also on error). + by the parameters how (`set', `unset', or + `toggle') and dirstr (`left', `right', + `up', or `down'). The new status is returned + (and false also on error).
@@ -3888,9 +3971,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
WSplitSplit WTiling.set_floating(WTiling ws, WSplitSplit split, string how) @@ -3898,8 +3979,8 @@ Note that this function is asynchronous; the region will not
Description:
Toggle floating of a split's sides at split as indicated by the - parameter how (set/unset/toggle). A split of the appropriate is - returned, if there was a change. + parameter how (`set', `unset', or `toggle'). + A split of the appropriate is returned, if there was a change.
@@ -3907,18 +3988,17 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
WFrame WTiling.split(WTiling ws, WSplit node, string dirstr)
Description:
-
Create a new frame on ws above/below/left of/right of - node as indicated by dirstr. If dirstr is - prefixed with ''floating:'' a floating split is created. +
Create a new frame on ws `above', `below' + `left' of, or `right' of node as indicated + by dirstr. If dirstr is prefixed with + `floating:' a floating split is created.
@@ -3926,9 +4006,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
WFrame WTiling.split_at(WTiling ws, WFrame frame, string dirstr, bool attach_current) @@ -3936,11 +4014,12 @@ Note that this function is asynchronous; the region will not
Description:
Split frame creating a new frame to direction dirstr - (one of ''left'', ''right'', ''top'' or ''bottom'') of frame. + (one of `left', `right', `top' or + `bottom') of frame. If attach_current is set, the region currently displayed in frame, if any, is moved to thenew frame. - If dirstr is prefixed with ''floating:'' a floating split is - created. + If dirstr is prefixed with `floating:', a floating + split is created.
@@ -3948,9 +4027,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
WFrame WTiling.split_top(WTiling ws, string dirstr) @@ -3965,9 +4042,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
WSplit WTiling.split_tree(WTiling ws) @@ -3982,17 +4057,15 @@ 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,9 +4079,7 @@ Note that this function is asynchronous; the region will not
-
- - +
Synopsis:
mod_query.defcmd(cmd, fn) @@ -4023,9 +4094,22 @@ Note that this function is asynchronous; the region will not

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

+ +

+
Synopsis:
table mod_query.get() @@ -4041,9 +4125,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
void mod_query.history_clear() @@ -4058,9 +4140,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
string mod_query.history_get(integer n) @@ -4075,9 +4155,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
bool mod_query.history_push(string str) @@ -4092,19 +4170,18 @@ 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,9 +4189,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
table mod_query.history_table() @@ -4129,26 +4204,7 @@ 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:
void mod_query.set(table tab) @@ -4170,6 +4226,14 @@ 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). + +substrcompl +(boolean) Complete on sub-strings in some cases + (default: ftrue). +
@@ -4178,36 +4242,18 @@ 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:
-
mod_query.popen_completions(cp, cmd, fn, reshnd) +
mod_query.popen_completions(cp, cmd, fn, reshnd, wd)
Description:
This function can be used to read completions from an external source. The parameter cp is the completion proxy to be used, - and the string cmd the shell command to be executed. To its stdout, - the command should on the first line write the common_beg + and the string cmd the shell command to be executed, in the directory + wd. + To its stdout, the command should on the first line write the common_beg parameter of WComplProxy.set_completions (which fn maybe used to override) and a single actual completion on each of the successive lines. The function reshnd may be used to override a result table @@ -4219,9 +4265,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
mod_query.query(mplex, prompt, initvalue, handler, completor, @@ -4246,18 +4290,16 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
mod_query.query_attachclient(mplex)
Description:
-
This query asks for the name of a client window and switches - focus to the one entered. It uses the completion function - ioncore.complete_clientwin. +
This query asks for the name of a client window and attaches + it to the frame the query was opened in. It uses the completion + function ioncore.complete_clientwin.
@@ -4265,9 +4307,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
mod_query.query_editfile(mplex, script, prompt) @@ -4284,9 +4324,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
mod_query.query_exec(mplex) @@ -4305,18 +4343,16 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
mod_query.query_gotoclient(mplex)
Description:
-
This query asks for the name of a client window and attaches - it to the frame the query was opened in. It uses the completion - function ioncore.complete_clientwin. +
This query asks for the name of a client window and switches + focus to the one entered. It uses the completion function + ioncore.complete_clientwin.
@@ -4324,9 +4360,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
mod_query.query_lua(mplex) @@ -4344,9 +4378,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
mod_query.query_man(mplex, prog) @@ -4363,12 +4395,10 @@ 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,9 +4410,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
mod_query.query_renameframe(frame) @@ -4398,17 +4426,16 @@ 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,9 +4443,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
mod_query.query_restart(mplex) @@ -4434,9 +4459,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
mod_query.query_runfile(mplex, script, prompt) @@ -4453,9 +4476,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
mod_query.query_shutdown(mplex) @@ -4472,9 +4493,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
mod_query.query_ssh(mplex, ssh) @@ -4490,9 +4509,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
mod_query.query_workspace(mplex) @@ -4511,9 +4528,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
mod_query.query_yesno(mplex, prompt, handler) @@ -4530,9 +4545,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
mod_query.show_about_ion(mplex) @@ -4547,9 +4560,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
mod_query.show_tree(mplex, reg, max_depth) @@ -4561,6 +4572,21 @@ 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,9 +4596,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
bool WComplProxy.set_completions(WComplProxy proxy, table compls) @@ -4597,9 +4621,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
void WEdln.back(WEdln wedln) @@ -4614,9 +4636,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
void WEdln.backspace(WEdln wedln) @@ -4631,9 +4651,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
void WEdln.bkill_word(WEdln wedln) @@ -4649,9 +4667,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
void WEdln.bol(WEdln wedln) @@ -4666,9 +4682,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
void WEdln.bskip_word(WEdln wedln) @@ -4684,9 +4698,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
void WEdln.clear_mark(WEdln wedln) @@ -4701,9 +4713,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
void WEdln.complete(WEdln wedln, string cycle, string mode) @@ -4712,11 +4722,12 @@ Note that this function is asynchronous; the region will not
Description:
Call completion handler with the text between the beginning of line and current cursor position, or select next/previous completion from list if in - auto-show-completions mode and cycle is set to ``next'' or ``prev'', - respectively. The mode may be ``history'' or ``normal''. If it is + auto-show-completions mode and cycle is set to `next' or + `prev', respectively. + The mode may be `history' or `normal'. If it is not set, the previous mode is used. Normally next entry is not cycled to despite the setting of cycle if mode switch occurs. To override - this, use ``next-always'' and ``prev-always'' for cycle. + this, use `next-always' and `prev-always' for cycle.
@@ -4724,9 +4735,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
string WEdln.contents(WEdln wedln) @@ -4741,9 +4750,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
string WEdln.context(WEdln wedln) @@ -4758,9 +4765,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
void WEdln.copy(WEdln wedln) @@ -4775,9 +4780,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
void WEdln.cut(WEdln wedln) @@ -4793,9 +4796,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
void WEdln.delete(WEdln wedln) @@ -4810,9 +4811,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
void WEdln.eol(WEdln wedln) @@ -4827,9 +4826,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
void WEdln.finish(WEdln wedln) @@ -4844,9 +4841,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
void WEdln.forward(WEdln wedln) @@ -4861,9 +4856,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
void WEdln.history_next(WEdln wedln, bool match) @@ -4880,9 +4873,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
void WEdln.history_prev(WEdln wedln, bool match) @@ -4899,9 +4890,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
void WEdln.insstr(WEdln wedln, string str) @@ -4916,9 +4905,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
bool WEdln.is_histcompl(WEdln wedln) @@ -4933,9 +4920,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
void WEdln.kill_line(WEdln wedln) @@ -4950,9 +4935,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
void WEdln.kill_to_bol(WEdln wedln) @@ -4967,9 +4950,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
void WEdln.kill_to_eol(WEdln wedln) @@ -4984,9 +4965,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
void WEdln.kill_word(WEdln wedln) @@ -5002,9 +4981,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
integer WEdln.mark(WEdln wedln) @@ -5021,9 +4998,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
bool WEdln.next_completion(WEdln wedln) @@ -5038,9 +5013,7 @@ Note that this function is asynchronous; the region will not

-
- - +
Synopsis:
void WEdln.paste(WEdln wedln) @@ -5060,9 +5033,7 @@ Note that this function is asynchronous; the selection will not

-
- - +
Synopsis:
integer WEdln.point(WEdln wedln) @@ -5078,9 +5049,7 @@ Note that this function is asynchronous; the selection will not

-
- - +
Synopsis:
bool WEdln.prev_completion(WEdln wedln) @@ -5095,9 +5064,7 @@ Note that this function is asynchronous; the selection will not

-
- - +
Synopsis:
void WEdln.set_context(WEdln wedln, string context) @@ -5112,9 +5079,7 @@ Note that this function is asynchronous; the selection will not

-
- - +
Synopsis:
void WEdln.set_mark(WEdln wedln) @@ -5129,9 +5094,7 @@ Note that this function is asynchronous; the selection will not

-
- - +
Synopsis:
void WEdln.skip_word(WEdln wedln) @@ -5147,9 +5110,7 @@ Note that this function is asynchronous; the selection will not

-
- - +
Synopsis:
void WEdln.transpose_chars(WEdln wedln) @@ -5164,9 +5125,7 @@ Note that this function is asynchronous; the selection will not

-
- - +
Synopsis:
void WEdln.transpose_words(WEdln wedln) @@ -5187,9 +5146,7 @@ Note that this function is asynchronous; the selection will not

-
- - +
Synopsis:
void WInput.cancel(WInput input) @@ -5204,9 +5161,7 @@ Note that this function is asynchronous; the selection will not

-
- - +
Synopsis:
void WInput.scrolldown(WInput input) @@ -5221,9 +5176,7 @@ Note that this function is asynchronous; the selection will not

-
- - +
Synopsis:
void WInput.scrollup(WInput input) @@ -5244,9 +5197,7 @@ Note that this function is asynchronous; the selection will not

-
- - +
Synopsis:
mod_menu.grabmenu(mplex, sub, menu_or_name, param) @@ -5263,9 +5214,7 @@ Note that this function is asynchronous; the selection will not

-
- - +
Synopsis:
mod_menu.menu(mplex, sub, menu_or_name, param) @@ -5290,9 +5239,7 @@ Note that this function is asynchronous; the selection will not

-
- - +
Synopsis:
table mod_menu.get() @@ -5307,9 +5254,7 @@ Note that this function is asynchronous; the selection will not

-
- - +
Synopsis:
void mod_menu.set(table tab) @@ -5325,7 +5270,7 @@ Note that this function is asynchronous; the selection will not Description scroll_amount -Number of pixels to scroll at a time +Number of pixels to scroll at a time in pointer-controlled menus when one extends beyond a border of the screen and the pointer touches that border. @@ -5342,9 +5287,7 @@ Note that this function is asynchronous; the selection will not

-
- - +
Synopsis:
mod_menu.pmenu(win, sub, menu_or_name) @@ -5367,9 +5310,7 @@ Note that this function is asynchronous; the selection will not

-
- - +
Synopsis:
void WMenu.cancel(WMenu menu) @@ -5384,9 +5325,7 @@ Note that this function is asynchronous; the selection will not

-
- - +
Synopsis:
void WMenu.finish(WMenu menu) @@ -5402,9 +5341,7 @@ Note that this function is asynchronous; the selection will not

-
- - +
Synopsis:
void WMenu.select_next(WMenu menu) @@ -5419,9 +5356,7 @@ Note that this function is asynchronous; the selection will not

-
- - +
Synopsis:
void WMenu.select_nth(WMenu menu, integer n) @@ -5436,9 +5371,7 @@ Note that this function is asynchronous; the selection will not

-
- - +
Synopsis:
void WMenu.select_prev(WMenu menu) @@ -5453,9 +5386,7 @@ Note that this function is asynchronous; the selection will not

-
- - +
Synopsis:
void WMenu.typeahead_clear(WMenu menu) @@ -5476,9 +5407,7 @@ Note that this function is asynchronous; the selection will not
-
- - +
Synopsis:
void mod_dock.set_floating_shown_on(WMPlex mplex, string how) @@ -5499,9 +5428,7 @@ Note that this function is asynchronous; the selection will not

-
- - +
Synopsis:
bool WDock.attach(WDock dock, WRegion reg) @@ -5516,9 +5443,7 @@ Note that this function is asynchronous; the selection will not

-
- - +
Synopsis:
table WDock.get(WDock dock) @@ -5534,9 +5459,7 @@ Note that this function is asynchronous; the selection will not

-
- - +
Synopsis:
void WDock.resize(WDock dock) @@ -5551,9 +5474,7 @@ Note that this function is asynchronous; the selection will not

-
- - +
Synopsis:
void WDock.set(WDock dock, table conftab) @@ -5576,7 +5497,10 @@ Note that this function is asynchronous; the selection will not string in - +$\{t,m,b\}\times\{t,c,b\}$ Dock position. Can only be used in floating mode. @@ -5607,9 +5531,7 @@ Any parameters not explicitly set in conftab will be left unchanged.
-
- - +
Synopsis:
bool mod_sp.set_shown(WFrame sp, string how) @@ -5617,7 +5539,9 @@ Any parameters not explicitly set in conftab will be left unchanged.
Description:
Toggle displayed status of sp. - The parameter how is one of (set/unset/toggle). + The parameter how is one of + `set', `unset', or `toggle'. + The resulting status is returned.
@@ -5625,9 +5549,7 @@ Any parameters not explicitly set in conftab will be left unchanged.

-
- - +
Synopsis:
bool mod_sp.set_shown_on(WMPlex mplex, string how) @@ -5635,7 +5557,9 @@ Any parameters not explicitly set in conftab will be left unchanged.
Description:
Change displayed status of some scratchpad on mplex if one is - found. The parameter how is one of (set/unset/toggle). + found. The parameter how is one of + `set', `unset', or `toggle'. + The resulting status is returned.
@@ -5643,32 +5567,245 @@ Any parameters not explicitly set in conftab will be left unchanged.

- +
-6.7 Functions defined in de +6.7 Functions defined in mod_statusbar

-
- - +
Synopsis:
-
bool de.defstyle(string name, table tab) +
mod_statusbar.create(param)
Description:
-
Define a style. - -
-
+
Create a statusbar. The possible parameters in the + table param are:

- -

-
- - + + + + + + + + + + + + + + + + + + + + + + + + + +
VariableTypeDescription
templatestringThe template; see + Section 3.6.
posstringPosition: `tl', `tr', + `bl' or `br' + (for the obvious combinations of + top/left/bottom/right).
screenintegerScreen number to create the statusbar on.
fullsizebooleanIf set, the statusbar will waste + space instead of adapting to layout.
systrayboolaenSwallow (KDE protocol) systray icons.
+ +
+
+ +

+ +

+
+
+
Synopsis:
+
mod_statusbar.inform(name, value) + +
+
Description:
+
Inform of a value. + +
+
+ +

+ +

+
+
+
Synopsis:
+
mod_statusbar.launch_statusd(cfg) + +
+
Description:
+
Load modules and launch ion-statusd with configuration + table cfg. The options for each ion-statusd monitor + script should be contained in the corresponding sub-table of cfg. + +
+
+ +

+ +

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

+ +

+
+
+
Synopsis:
+
mod_statusbar.update(update_templates) + +
+
Description:
+
Update statusbar contents. To be called after series + of mod_statusbar.inform calls. + +
+
+ +

+ +

+6.7.1 WStatusBar functions +

+ +

+ +

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

+ +

+
+
+
Synopsis:
+
bool WStatusBar.is_systray(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', or `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.8 Functions defined in de +

+ +
+
+
+
Synopsis:
+
bool de.defstyle(string name, table tab) + +
+
Description:
+
Define a style. + +
+
+ +

+ +

+
Synopsis:
bool de.defstyle_rootwin(WRootWin rootwin, string name, table tab) @@ -5683,9 +5820,7 @@ Any parameters not explicitly set in conftab will be left unchanged.

-
- - +
Synopsis:
void de.reset() @@ -5700,9 +5835,7 @@ Any parameters not explicitly set in conftab will be left unchanged.

-
- - +
Synopsis:
table de.substyle(string pattern, table tab) @@ -5716,16 +5849,16 @@ Any parameters not explicitly set in conftab will be left unchanged.

-

+


-6.8 Hooks +6.9 Hooks

-
+
Hook name:
@@ -5760,7 +5893,7 @@ Any parameters not explicitly set in conftab will be left unchanged. dockapp bool -Client window is a dockapp. +Client window is a dock-app. maprq bool @@ -5797,7 +5930,7 @@ reg:attach(cwin)

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

-
+
Hook name:
@@ -5865,12 +6019,12 @@ reg:attach(cwin) mode string -"switchonly", "reorder", - "add" or "remove" +`switchonly', `reorder', + `add' or `remove' sw bool -Switch occured +Switch occurred sub WRegion @@ -5884,7 +6038,7 @@ reg:attach(cwin)

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

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

-
+
Hook name:
@@ -5938,7 +6092,7 @@ reg:attach(cwin)
Description:
Called when Ion has done all initialisation and is almost ready to - enter the mainloop, except no windows are yet being managed. + enter the main-loop, except no windows are yet being managed.
@@ -5946,7 +6100,7 @@ reg:attach(cwin)

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

-
+
+ +
+
Hook name:
+
ioncore_submap_ungrab_hook + +
+
Parameters:
+
() + +
+
Description:
+
This hook is used to signal whenever Ion leaves the submap grab mode. + +
+
+ +

+ +

+
Hook name:
@@ -6002,7 +6176,7 @@ reg:attach(cwin) res_frame WFrame -A succesfull handler should +A successful handler should return the target frame here. @@ -6018,73 +6192,20 @@ reg:attach(cwin)

-
+
Hook name:
-
panews_make_placement_alt +
region_do_warp_alt
Parameters:
-
table +
WRegion
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)
+

This alt-hook exist to allow for alternative pointer warping + implementations.
@@ -6092,19 +6213,21 @@ The handler should set some of these fields on success:

-
+
Hook name:
-
region_activated_hook +
screen_managed_changed_hook
Parameters:
-
WRegion +
table
Description:
-
Signalled when a region or one of its children has received the focus. +
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.
@@ -6112,87 +6235,133 @@ The handler should set some of these fields on success:

-
+
Hook name:
-
region_activity_hook +
region_notify_hook
Parameters:
-
WRegion +
(WRegion, string)
Description:
-
This hook is triggered when the activity flag of the parameter - region has been changed. - -
-
+
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 pseudo-active + (see below).
pseudoinactivatedThe region is no longer pseudo-active.
-

-
- -
-
Hook name:
-
region_do_warp_alt - -
-
Parameters:
-
WRegion - -
-
Description:
-
This alt-hook exist to allow for alternative pointer warping - implementations. +

+A region is pseudo-active, 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:
-
region_inactivated_hook +

+ +
+6.10 Miscellaneous +

-
-
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. - -
-
+

+ +
+6.10.1 Size policies +

+Some functions accept a sizepolicy parameter. The possible +values are: -

-
- -
-
Hook name:
-
screen_managed_changed_hook +

+

+`default', +`full', +`full_bounds', +`free', +`free_glue', +`northwest', +`north', +`northeast', +`west', +`center', +`east', +`southwest', +`south', +`southeast', +`stretch_top', +`stretch_bottom', +`stretch_left', +`stretch_right', +`free_glue_northwest', +`free_glue_north', +`free_glue_northeast', +`free_glue_west', +`free_glue_center', +`free_glue_east', +`free_glue_southwest', +`free_glue_south', and +`free_glue_southeast'. -
-
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. - -
-
+

+The ``free'' policies allow the managed +object to be moved around, whereas the other versions do not. +The ``glue'' policies glue the object to some border, while allowing +it to be moved away from it by user action, but not automatically. +The ``stretch'' policies stretch the object along the given border, +while the coordinate-based policies simply place the object along +that border.

@@ -6200,31 +6369,31 @@ The handler should set some of these fields on success:

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