X-Git-Url: https://git.decadent.org.uk/gitweb/?p=ion3-doc.git;a=blobdiff_plain;f=ionconf%2Fnode7.html;h=f9cc8550e144a70be4d0c365dc0f43d6df795c01;hp=11dd84ac7f6beabb8c1ac86c3a22afa950aa48a0;hb=6c79ccf7ddf25af66675865badef0b8f6d0fee78;hpb=da1e04def26932e7f91a2106c885142e7fafe59b diff --git a/ionconf/node7.html b/ionconf/node7.html index 11dd84a..f9cc855 100644 --- a/ionconf/node7.html +++ b/ionconf/node7.html @@ -28,31 +28,31 @@ original version by: Nikos Drakos, CBLU, University of Leeds @@ -61,104 +61,104 @@ original version by: Nikos Drakos, CBLU, University of Leeds Subsections

@@ -291,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.

@@ -593,7 +593,8 @@ The string guard maybe set to pose limits on _sub. Currently

Description:

Iterate over activity list until iterfn returns false. - The function itself returns true if it reaches the end of list + The function is called in protected mode. + This routine returns true if it reaches the end of list without this happening.

@@ -610,7 +611,8 @@ The string guard maybe set to pose limits on _sub. Currently

Description:

Iterate over client windows until iterfn returns false. - The function itself returns true if it reaches the end of list + The function is called in protected mode. + This routine returns true if it reaches the end of list without this happening.

@@ -693,15 +695,19 @@ Similarly to sed's 's' command, rule may contain characters that are

Description:

Detach or reattach reg, depending on whether how - is `set', `unset' or `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. +

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.

@@ -750,7 +756,8 @@ Similarly to sed's 's' command, rule may contain characters that are

Description:

Iterate over focus history until iterfn returns false. - The function itself returns true if it reaches the end of list + The function is called in protected mode. + This routine returns true if it reaches the end of list without this happening.

@@ -1019,13 +1026,16 @@ 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.

@@ -1057,7 +1067,8 @@ Note that this function is asynchronous; the region will not

Description:

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 + The function is called in protected mode. + This routine returns true if it reaches the end of list without this happening.

@@ -1189,6 +1200,9 @@ 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. @@ -1200,7 +1214,7 @@ Note that this function is asynchronous; the region will not mousefocus (string) Mouse focus mode: - `disable' or `sloppy'. + `disabled' or `sloppy'. unsqueeze (boolean) Auto-unsqueeze transients/menus/queries/etc. @@ -1324,7 +1338,8 @@ When a keyboard resize function is called, and at most kbresize_t_max

Description:

Iterate over tagged regions until iterfn returns false. - The function itself returns true if it reaches the end of list + The function is called in protected mode. + This routine returns true if it reaches the end of list without this happening.

@@ -1523,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.

@@ -1539,10 +1555,10 @@ When a keyboard resize function is called, and at most kbresize_t_max

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.

@@ -1604,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.

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

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.

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

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.

@@ -1704,14 +1720,14 @@ 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.

@@ -1814,6 +1830,8 @@ When a keyboard resize function is called, and at most kbresize_t_max 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. @@ -2030,7 +2048,9 @@ When a keyboard resize function is called, and at most kbresize_t_max

Description:

Set frame mode. +

Set frame mode (one of + `unknown', `tiled', `floating', `transient', + or any of these suffixed with `-alt').

@@ -2112,6 +2132,10 @@ When a keyboard resize function is called, and at most kbresize_t_max sizepolicy (string) Size policy; see Section 6.10.1. +bottom +(boolean) Mark the attached region as the + ``bottom'' of ws. +

@@ -2136,21 +2160,6 @@ In addition parameters to the region to be created are passed in this -

- -

-
Synopsis:: bool WGroup.is_fullscreen(WGroup grp) - -
Description:: Is reg in full screen mode? - -

Description:: Iterate over managed regions of ws until iterfn returns false. - The function itself returns true if it reaches the end of list + The function is called in protected mode. + This routine returns true if it reaches the end of list without this happening.
Description:: Iterate over managed regions of mplex until iterfn returns false. - The function itself returns true if it reaches the end of list + The function is called in protected mode. + This routine returns true if it reaches the end of list without this happening.
Description:: 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 + The function is called in protected mode. + This routine returns true if it reaches the end of list without this happening.
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.

@@ -2603,13 +2618,13 @@ In addition parameters to the region to be created are passed in this list of mplex. Special values for index are: @@ -2640,13 +2655,16 @@ In addition parameters to the region to be created are passed in this - + + + - + + +

	Last.
	After `WMPlex.mx_current`.	Description
`pos`	The corner of the screen to place the status display - in: one of ``tl`', ``tr`', ``bl`' +	(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 +	(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 @@ -2939,7 +2957,7 @@ Note that this function is asynchronous; the region will not Synopsis: - `bool WRegion.is_active(WRegion reg)` + `bool WRegion.is_active(WRegion reg, bool pseudoact_ok)` Description: @@ -3802,7 +3820,7 @@ Note that this function is asynchronous; the region will not Description: - Flip contents of `node`. + Flip contents of `split`. @@ -3889,7 +3907,8 @@ Note that this function is asynchronous; the region will not Description: Iterate over managed regions of `ws` until `iterfn` returns `false`. - The function itself returns `true` if it reaches the end of list + The function is called in protected mode. + This routine returns `true` if it reaches the end of list without this happening. @@ -4211,6 +4230,10 @@ Note that this function is asynchronous; the region will not	(boolean) Turn some completions case-insensitive (default: false).
`substrcompl`	(boolean) Complete on sub-strings in some cases + (default: ftrue).

@@ -4222,14 +4245,15 @@ Note that this function is asynchronous; the region will not

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 @@ -5246,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. @@ -5572,8 +5596,8 @@ Any parameters not explicitly set in conftab will be left unchanged. pos string -Position: "tl", "tr", - "bl" or "br" +Position: `tl', `tr', + `bl' or `br' (for the obvious combinations of top/left/bottom/right). @@ -5834,7 +5858,7 @@ Any parameters not explicitly set in conftab will be left unchanged.

+
Hook name: