X-Git-Url: https://git.decadent.org.uk/gitweb/?a=blobdiff_plain;f=ionconf%2Fnode7.html;h=109737ea44c2a63e5ddd0797e24331afe1780cab;hb=refs%2Ftags%2F20071109;hp=11dd84ac7f6beabb8c1ac86c3a22afa950aa48a0;hpb=da1e04def26932e7f91a2106c885142e7fafe59b;p=ion3-doc.git diff --git a/ionconf/node7.html b/ionconf/node7.html index 11dd84a..109737e 100644 --- a/ionconf/node7.html +++ b/ionconf/node7.html @@ -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.
@@ -693,15 +693,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.

@@ -1019,13 +1023,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.
@@ -1523,8 +1530,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 +1547,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 +1612,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 +1628,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 +1685,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 +1712,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 +1822,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. @@ -2112,6 +2122,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 +2150,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? - -
-
-

@@ -2389,6 +2388,9 @@ 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. +passive +(boolean) Skip in certain focusing operations. + pseudomodal (boolean) The attached region is ``pseudomodal'' if the stacking level dictates it to be modal. @@ -2565,8 +2567,8 @@ In addition parameters to the region to be created are passed in this
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.
@@ -2640,13 +2642,16 @@ 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' +(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 @@ -3802,7 +3807,7 @@ Note that this function is asynchronous; the region will not
Description:
-
Flip contents of node. +
Flip contents of split.
@@ -4222,14 +4227,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 @@ -5572,8 +5578,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 +5840,7 @@ Any parameters not explicitly set in conftab will be left unchanged.

-
+
Hook name:
@@ -5906,7 +5912,7 @@ reg:attach(cwin)

-
+
Hook name:
@@ -5926,7 +5932,7 @@ reg:attach(cwin)

-
+
Hook name:
@@ -5947,7 +5953,7 @@ reg:attach(cwin)

-
+
Hook name:
@@ -5968,7 +5974,7 @@ reg:attach(cwin)

-
+
Hook name:
@@ -6014,7 +6020,7 @@ reg:attach(cwin)

-
+
Hook name:
@@ -6035,7 +6041,7 @@ reg:attach(cwin)

-
+
Hook name:
@@ -6055,7 +6061,7 @@ reg:attach(cwin)

-
+
Hook name:
@@ -6076,7 +6082,7 @@ reg:attach(cwin)

-
+
Hook name:
@@ -6096,7 +6102,7 @@ reg:attach(cwin)

-
+
Hook name:
@@ -6116,7 +6122,7 @@ reg:attach(cwin)

-
+
Hook name:
@@ -6168,7 +6174,7 @@ reg:attach(cwin)

-
+
Hook name:
@@ -6189,7 +6195,7 @@ reg:attach(cwin)

-
+
Hook name:
@@ -6211,7 +6217,7 @@ reg:attach(cwin)

-
+
Hook name: