X-Git-Url: https://git.decadent.org.uk/gitweb/?a=blobdiff_plain;f=ionconf%2Fnode7.html;h=3d636c618a5ee366f173a445ed41beb57488c879;hb=20080207;hp=4a3e772f4c3e2bc0295f167b21d99d11e472a62f;hpb=4926ec036ac81e3de8841228e8b48a8caa2e3d68;p=ion3-doc.git diff --git a/ionconf/node7.html b/ionconf/node7.html index 4a3e772..3d636c6 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

@@ -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,11 +1026,12 @@ 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 and stderr. +

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

@@ -1191,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. @@ -1202,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. @@ -1326,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.

@@ -2035,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').

@@ -2145,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.
Synopsis:: bool WRegion.is_active(WRegion reg) +; bool WRegion.is_active(WRegion reg, bool pseudoact_ok)
Description:
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.
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 @@ -4492,7 +4501,7 @@ Note that this function is asynchronous; the region will not
Description:: This query asks for a host to connect to with SSH. - Hosts to tab-complete are read from ~/.ssh/known_hosts. + Hosts to tab-complete are read from .

@@ -5849,7 +5858,7 @@ Any parameters not explicitly set in conftab will be left unchanged.

+
Hook name:

	Last.
	After `WMPlex.mx_current`.	(boolean) Turn some completions case-insensitive (default: false).
`substrcompl`	(boolean) Complete on sub-strings in some cases + (default: ftrue).