]> git.decadent.org.uk Git - ion3-doc.git/blobdiff - ionconf/node7.html
[svn-upgrade] Integrating new upstream version, ion3-doc (20080411)
[ion3-doc.git] / ionconf / node7.html
index 7b2bbb912d94bc3a9fd6a89e83cff5e493b82c94..f9cc8550e144a70be4d0c365dc0f43d6df795c01 100644 (file)
@@ -28,31 +28,31 @@ original version by:  Nikos Drakos, CBLU, University of Leeds
 <BODY >
 
 <DIV CLASS="navigation"><!--Navigation Panel-->
-<A NAME="tex2html383"
+<A NAME="tex2html382"
   HREF="node8.html">
 <IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A> 
-<A NAME="tex2html377"
+<A NAME="tex2html376"
   HREF="ionconf.html">
 <IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A> 
-<A NAME="tex2html371"
+<A NAME="tex2html370"
   HREF="node6.html">
 <IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A> 
-<A NAME="tex2html379"
+<A NAME="tex2html378"
   HREF="node1.html">
 <IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A> 
-<A NAME="tex2html381"
+<A NAME="tex2html380"
   HREF="node11.html">
 <IMG WIDTH="43" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="index" SRC="index.png"></A> 
 <BR>
-<B> Next:</B> <A NAME="tex2html384"
-  HREF="node8.html">A. The GNU General</A>
-<B> Up:</B> <A NAME="tex2html378"
+<B> Next:</B> <A NAME="tex2html383"
+  HREF="node8.html">A. GNU Free Documentation</A>
+<B> Up:</B> <A NAME="tex2html377"
   HREF="ionconf.html">Configuring and extending Ion3</A>
-<B> Previous:</B> <A NAME="tex2html372"
+<B> Previous:</B> <A NAME="tex2html371"
   HREF="node6.html">5. Scripting</A>
- &nbsp; <B>  <A NAME="tex2html380"
+ &nbsp; <B>  <A NAME="tex2html379"
   HREF="node1.html">Contents</A></B> 
- &nbsp; <B>  <A NAME="tex2html382"
+ &nbsp; <B>  <A NAME="tex2html381"
   HREF="node11.html">Index</A></B> 
 <BR>
 <BR></DIV>
@@ -61,104 +61,104 @@ original version by:  Nikos Drakos, CBLU, University of Leeds
 <A NAME="CHILD_LINKS"><STRONG>Subsections</STRONG></A>
 
 <UL CLASS="ChildLinks">
-<LI><A NAME="tex2html385"
+<LI><A NAME="tex2html384"
   HREF="node7.html#SECTION00710000000000000000"><SPAN CLASS="arabic">6</SPAN>.<SPAN CLASS="arabic">1</SPAN> Functions defined in <SPAN  CLASS="textit">ioncore</SPAN></A>
 <UL>
-<LI><A NAME="tex2html386"
+<LI><A NAME="tex2html385"
   HREF="node7.html#SECTION00711000000000000000"><SPAN CLASS="arabic">6</SPAN>.<SPAN CLASS="arabic">1</SPAN>.<SPAN CLASS="arabic">1</SPAN> WClientWin functions</A>
-<LI><A NAME="tex2html387"
+<LI><A NAME="tex2html386"
   HREF="node7.html#SECTION00712000000000000000"><SPAN CLASS="arabic">6</SPAN>.<SPAN CLASS="arabic">1</SPAN>.<SPAN CLASS="arabic">2</SPAN> WFrame functions</A>
-<LI><A NAME="tex2html388"
+<LI><A NAME="tex2html387"
   HREF="node7.html#SECTION00713000000000000000"><SPAN CLASS="arabic">6</SPAN>.<SPAN CLASS="arabic">1</SPAN>.<SPAN CLASS="arabic">3</SPAN> WGroup functions</A>
-<LI><A NAME="tex2html389"
+<LI><A NAME="tex2html388"
   HREF="node7.html#SECTION00714000000000000000"><SPAN CLASS="arabic">6</SPAN>.<SPAN CLASS="arabic">1</SPAN>.<SPAN CLASS="arabic">4</SPAN> WGroupCW functions</A>
-<LI><A NAME="tex2html390"
+<LI><A NAME="tex2html389"
   HREF="node7.html#SECTION00715000000000000000"><SPAN CLASS="arabic">6</SPAN>.<SPAN CLASS="arabic">1</SPAN>.<SPAN CLASS="arabic">5</SPAN> WGroupWS functions</A>
-<LI><A NAME="tex2html391"
+<LI><A NAME="tex2html390"
   HREF="node7.html#SECTION00716000000000000000"><SPAN CLASS="arabic">6</SPAN>.<SPAN CLASS="arabic">1</SPAN>.<SPAN CLASS="arabic">6</SPAN> WHook functions</A>
-<LI><A NAME="tex2html392"
+<LI><A NAME="tex2html391"
   HREF="node7.html#SECTION00717000000000000000"><SPAN CLASS="arabic">6</SPAN>.<SPAN CLASS="arabic">1</SPAN>.<SPAN CLASS="arabic">7</SPAN> WInfoWin functions</A>
-<LI><A NAME="tex2html393"
+<LI><A NAME="tex2html392"
   HREF="node7.html#SECTION00718000000000000000"><SPAN CLASS="arabic">6</SPAN>.<SPAN CLASS="arabic">1</SPAN>.<SPAN CLASS="arabic">8</SPAN> WMPlex functions</A>
-<LI><A NAME="tex2html394"
+<LI><A NAME="tex2html393"
   HREF="node7.html#SECTION00719000000000000000"><SPAN CLASS="arabic">6</SPAN>.<SPAN CLASS="arabic">1</SPAN>.<SPAN CLASS="arabic">9</SPAN> WMoveresMode functions</A>
-<LI><A NAME="tex2html395"
+<LI><A NAME="tex2html394"
   HREF="node7.html#SECTION007110000000000000000"><SPAN CLASS="arabic">6</SPAN>.<SPAN CLASS="arabic">1</SPAN>.<SPAN CLASS="arabic">10</SPAN> WRegion functions</A>
-<LI><A NAME="tex2html396"
+<LI><A NAME="tex2html395"
   HREF="node7.html#SECTION007111000000000000000"><SPAN CLASS="arabic">6</SPAN>.<SPAN CLASS="arabic">1</SPAN>.<SPAN CLASS="arabic">11</SPAN> WRootWin functions</A>
-<LI><A NAME="tex2html397"
+<LI><A NAME="tex2html396"
   HREF="node7.html#SECTION007112000000000000000"><SPAN CLASS="arabic">6</SPAN>.<SPAN CLASS="arabic">1</SPAN>.<SPAN CLASS="arabic">12</SPAN> WScreen functions</A>
-<LI><A NAME="tex2html398"
+<LI><A NAME="tex2html397"
   HREF="node7.html#SECTION007113000000000000000"><SPAN CLASS="arabic">6</SPAN>.<SPAN CLASS="arabic">1</SPAN>.<SPAN CLASS="arabic">13</SPAN> WTimer functions</A>
-<LI><A NAME="tex2html399"
+<LI><A NAME="tex2html398"
   HREF="node7.html#SECTION007114000000000000000"><SPAN CLASS="arabic">6</SPAN>.<SPAN CLASS="arabic">1</SPAN>.<SPAN CLASS="arabic">14</SPAN> WWindow functions</A>
-<LI><A NAME="tex2html400"
+<LI><A NAME="tex2html399"
   HREF="node7.html#SECTION007115000000000000000"><SPAN CLASS="arabic">6</SPAN>.<SPAN CLASS="arabic">1</SPAN>.<SPAN CLASS="arabic">15</SPAN> global functions</A>
-<LI><A NAME="tex2html401"
+<LI><A NAME="tex2html400"
   HREF="node7.html#SECTION007116000000000000000"><SPAN CLASS="arabic">6</SPAN>.<SPAN CLASS="arabic">1</SPAN>.<SPAN CLASS="arabic">16</SPAN> gr functions</A>
-<LI><A NAME="tex2html402"
+<LI><A NAME="tex2html401"
   HREF="node7.html#SECTION007117000000000000000"><SPAN CLASS="arabic">6</SPAN>.<SPAN CLASS="arabic">1</SPAN>.<SPAN CLASS="arabic">17</SPAN> string functions</A>
-<LI><A NAME="tex2html403"
+<LI><A NAME="tex2html402"
   HREF="node7.html#SECTION007118000000000000000"><SPAN CLASS="arabic">6</SPAN>.<SPAN CLASS="arabic">1</SPAN>.<SPAN CLASS="arabic">18</SPAN> table functions</A>
 </UL>
 <BR>
-<LI><A NAME="tex2html404"
+<LI><A NAME="tex2html403"
   HREF="node7.html#SECTION00720000000000000000"><SPAN CLASS="arabic">6</SPAN>.<SPAN CLASS="arabic">2</SPAN> Functions defined in <SPAN  CLASS="textit">mod_tiling</SPAN></A>
 <UL>
-<LI><A NAME="tex2html405"
+<LI><A NAME="tex2html404"
   HREF="node7.html#SECTION00721000000000000000"><SPAN CLASS="arabic">6</SPAN>.<SPAN CLASS="arabic">2</SPAN>.<SPAN CLASS="arabic">1</SPAN> WSplit functions</A>
-<LI><A NAME="tex2html406"
+<LI><A NAME="tex2html405"
   HREF="node7.html#SECTION00722000000000000000"><SPAN CLASS="arabic">6</SPAN>.<SPAN CLASS="arabic">2</SPAN>.<SPAN CLASS="arabic">2</SPAN> WSplitInner functions</A>
-<LI><A NAME="tex2html407"
+<LI><A NAME="tex2html406"
   HREF="node7.html#SECTION00723000000000000000"><SPAN CLASS="arabic">6</SPAN>.<SPAN CLASS="arabic">2</SPAN>.<SPAN CLASS="arabic">3</SPAN> WSplitRegion functions</A>
-<LI><A NAME="tex2html408"
+<LI><A NAME="tex2html407"
   HREF="node7.html#SECTION00724000000000000000"><SPAN CLASS="arabic">6</SPAN>.<SPAN CLASS="arabic">2</SPAN>.<SPAN CLASS="arabic">4</SPAN> WSplitSplit functions</A>
-<LI><A NAME="tex2html409"
+<LI><A NAME="tex2html408"
   HREF="node7.html#SECTION00725000000000000000"><SPAN CLASS="arabic">6</SPAN>.<SPAN CLASS="arabic">2</SPAN>.<SPAN CLASS="arabic">5</SPAN> WTiling functions</A>
 </UL>
 <BR>
-<LI><A NAME="tex2html410"
+<LI><A NAME="tex2html409"
   HREF="node7.html#SECTION00730000000000000000"><SPAN CLASS="arabic">6</SPAN>.<SPAN CLASS="arabic">3</SPAN> Functions defined in <SPAN  CLASS="textit">mod_query</SPAN></A>
 <UL>
-<LI><A NAME="tex2html411"
+<LI><A NAME="tex2html410"
   HREF="node7.html#SECTION00731000000000000000"><SPAN CLASS="arabic">6</SPAN>.<SPAN CLASS="arabic">3</SPAN>.<SPAN CLASS="arabic">1</SPAN> WComplProxy functions</A>
-<LI><A NAME="tex2html412"
+<LI><A NAME="tex2html411"
   HREF="node7.html#SECTION00732000000000000000"><SPAN CLASS="arabic">6</SPAN>.<SPAN CLASS="arabic">3</SPAN>.<SPAN CLASS="arabic">2</SPAN> WEdln functions</A>
-<LI><A NAME="tex2html413"
+<LI><A NAME="tex2html412"
   HREF="node7.html#SECTION00733000000000000000"><SPAN CLASS="arabic">6</SPAN>.<SPAN CLASS="arabic">3</SPAN>.<SPAN CLASS="arabic">3</SPAN> WInput functions</A>
 </UL>
 <BR>
-<LI><A NAME="tex2html414"
+<LI><A NAME="tex2html413"
   HREF="node7.html#SECTION00740000000000000000"><SPAN CLASS="arabic">6</SPAN>.<SPAN CLASS="arabic">4</SPAN> Functions defined in <SPAN  CLASS="textit">mod_menu</SPAN></A>
 <UL>
-<LI><A NAME="tex2html415"
+<LI><A NAME="tex2html414"
   HREF="node7.html#SECTION00741000000000000000"><SPAN CLASS="arabic">6</SPAN>.<SPAN CLASS="arabic">4</SPAN>.<SPAN CLASS="arabic">1</SPAN> WMenu functions</A>
 </UL>
 <BR>
-<LI><A NAME="tex2html416"
+<LI><A NAME="tex2html415"
   HREF="node7.html#SECTION00750000000000000000"><SPAN CLASS="arabic">6</SPAN>.<SPAN CLASS="arabic">5</SPAN> Functions defined in <SPAN  CLASS="textit">mod_dock</SPAN></A>
 <UL>
-<LI><A NAME="tex2html417"
+<LI><A NAME="tex2html416"
   HREF="node7.html#SECTION00751000000000000000"><SPAN CLASS="arabic">6</SPAN>.<SPAN CLASS="arabic">5</SPAN>.<SPAN CLASS="arabic">1</SPAN> WDock functions</A>
 </UL>
 <BR>
-<LI><A NAME="tex2html418"
+<LI><A NAME="tex2html417"
   HREF="node7.html#SECTION00760000000000000000"><SPAN CLASS="arabic">6</SPAN>.<SPAN CLASS="arabic">6</SPAN> Functions defined in <SPAN  CLASS="textit">mod_sp</SPAN></A>
-<LI><A NAME="tex2html419"
+<LI><A NAME="tex2html418"
   HREF="node7.html#SECTION00770000000000000000"><SPAN CLASS="arabic">6</SPAN>.<SPAN CLASS="arabic">7</SPAN> Functions defined in <SPAN  CLASS="textit">mod_statusbar</SPAN></A>
 <UL>
-<LI><A NAME="tex2html420"
+<LI><A NAME="tex2html419"
   HREF="node7.html#SECTION00771000000000000000"><SPAN CLASS="arabic">6</SPAN>.<SPAN CLASS="arabic">7</SPAN>.<SPAN CLASS="arabic">1</SPAN> WStatusBar functions</A>
 </UL>
 <BR>
-<LI><A NAME="tex2html421"
+<LI><A NAME="tex2html420"
   HREF="node7.html#SECTION00780000000000000000"><SPAN CLASS="arabic">6</SPAN>.<SPAN CLASS="arabic">8</SPAN> Functions defined in <SPAN  CLASS="textit">de</SPAN></A>
-<LI><A NAME="tex2html422"
+<LI><A NAME="tex2html421"
   HREF="node7.html#SECTION00790000000000000000"><SPAN CLASS="arabic">6</SPAN>.<SPAN CLASS="arabic">9</SPAN> Hooks</A>
-<LI><A NAME="tex2html423"
+<LI><A NAME="tex2html422"
   HREF="node7.html#SECTION007100000000000000000"><SPAN CLASS="arabic">6</SPAN>.<SPAN CLASS="arabic">10</SPAN> Miscellaneous</A>
 <UL>
-<LI><A NAME="tex2html424"
+<LI><A NAME="tex2html423"
   HREF="node7.html#SECTION007101000000000000000"><SPAN CLASS="arabic">6</SPAN>.<SPAN CLASS="arabic">10</SPAN>.<SPAN CLASS="arabic">1</SPAN> Size policies</A>
 </UL></UL>
 <!--End of Table of Child-Links-->
@@ -593,7 +593,8 @@ The string <TT>guard</TT>  maybe set to pose limits on <TT>_sub</TT>. Currently
 </DD>
 <DT><STRONG>Description:</STRONG></DT>
 <DD>Iterate over activity list until <TT>iterfn</TT> returns <TT>false</TT>.
- The function itself returns <TT>true</TT> if it reaches the end of list
+ The function is called in protected mode.
+ This routine returns <TT>true</TT> if it reaches the end of list
  without this happening.
   
 </DD>
@@ -610,7 +611,8 @@ The string <TT>guard</TT>  maybe set to pose limits on <TT>_sub</TT>. Currently
 </DD>
 <DT><STRONG>Description:</STRONG></DT>
 <DD>Iterate over client windows until <TT>iterfn</TT> returns <TT>false</TT>.
- The function itself returns <TT>true</TT> if it reaches the end of list
+ The function is called in protected mode.
+ This routine returns <TT>true</TT> if it reaches the end of list
  without this happening.
   
 </DD>
@@ -693,15 +695,19 @@ Similarly to sed's 's' command, <TT>rule</TT> may contain characters that are
 
 </DD>
 <DT><STRONG>Description:</STRONG></DT>
-<DD>Detach or reattach <TT>reg</TT>, depending on whether <TT>how</TT>
- is `<TT>set</TT>', `<TT>unset</TT>' or `<TT>toggle</TT>'. (Detaching 
- means making <TT>reg</TT> managed by its nearest ancestor WGroup,
- framed if <TT>reg</TT> is not itself WFrame. Reattaching means 
- making it managed where it used to be managed, if a return-placeholder
- exists.)
- If <TT>reg</TT> is the `bottom' of some group, the whole group is
- detached. If <TT>reg</TT> is a WWindow, it is put into a 
- frame.
+<DD>Detach or reattach <TT>reg</TT> or any group it is the leader of
+ (see <A HREF="#fn:WRegion.groupleader_of"><TT>WRegion.groupleader_of</TT></A>), depending on whether <TT>how</TT> 
+ is `<TT>set</TT>', `<TT>unset</TT>' or `<TT>toggle</TT>'. If this
+ region is not a window, it is put into a frame.
+
+<P>
+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.
+
+<P>
+Additionally, setting <TT>how</TT> to `<TT>forget</TT>', can be used to
+ clear this return placeholder of the group leader of <TT>reg</TT>.
   
 </DD>
 </DL>
@@ -750,7 +756,8 @@ Similarly to sed's 's' command, <TT>rule</TT> may contain characters that are
 </DD>
 <DT><STRONG>Description:</STRONG></DT>
 <DD>Iterate over focus history until <TT>iterfn</TT> returns <TT>false</TT>.
- The function itself returns <TT>true</TT> if it reaches the end of list
+ The function is called in protected mode.
+ This routine returns <TT>true</TT> if it reaches the end of list
  without this happening.
   
 </DD>
@@ -1019,11 +1026,12 @@ Note that this function is asynchronous; the region will not
 <DD><A NAME="fn:ioncore.popen_bgread"></A>  
 </DD>
 <DT><STRONG>Synopsis:</STRONG></DT>
-<DD><TT>integer ioncore.popen_bgread(string cmd, function h, function errh)</TT>
+<DD><TT>integer ioncore.popen_bgread(string cmd, function h, function errh, string wd)</TT>
 
 </DD>
 <DT><STRONG>Description:</STRONG></DT>
-<DD>Run <TT>cmd</TT> with a read pipe connected to its stdout and stderr.
+<DD>Run <TT>cmd</TT> in directory <TT>wd</TT> with a read pipe connected to its
+ stdout and stderr.
  When data is received through one of these pipes, <TT>h</TT> or <TT>errh</TT> 
  is called with that data. When the pipe is closed, the handler is called
  with <TT>nil</TT> argument. The PID of the new process is returned, or
@@ -1059,7 +1067,8 @@ Note that this function is asynchronous; the region will not
 <DT><STRONG>Description:</STRONG></DT>
 <DD>Iterate over all non-client window regions with (inherited) class
  <TT>typenam</TT> until <TT>iterfn</TT> returns <TT>false</TT>.
- The function itself returns <TT>true</TT> if it reaches the end of list
+ The function is called in protected mode.
+ This routine returns <TT>true</TT> if it reaches the end of list
  without this happening.
   
 </DD>
@@ -1191,6 +1200,9 @@ Note that this function is asynchronous; the region will not
 <TR><TD ALIGN="LEFT"><TT>kbresize_maxacc</TT></TD>
 <TD ALIGN="LEFT">(floating point) See below.</TD>
 </TR>
+<TR><TD ALIGN="LEFT"><TT>edge_resistance</TT></TD>
+<TD ALIGN="LEFT">(integer) Resize edge resistance in pixels.</TD>
+</TR>
 <TR><TD ALIGN="LEFT"><TT>framed_transients</TT></TD>
 <TD ALIGN="LEFT">(boolean) Put transients in nested frames.</TD>
 </TR>
@@ -1202,7 +1214,7 @@ Note that this function is asynchronous; the region will not
 </TR>
 <TR><TD ALIGN="LEFT"><TT>mousefocus</TT></TD>
 <TD ALIGN="LEFT">(string) Mouse focus mode: 
-                     `<TT>disable</TT>' or `<TT>sloppy</TT>'.</TD>
+                     `<TT>disabled</TT>' or `<TT>sloppy</TT>'.</TD>
 </TR>
 <TR><TD ALIGN="LEFT"><TT>unsqueeze</TT></TD>
 <TD ALIGN="LEFT">(boolean) Auto-unsqueeze transients/menus/queries/etc.</TD>
@@ -1326,7 +1338,8 @@ When a keyboard resize function is called, and at most <TT>kbresize_t_max</TT>
 </DD>
 <DT><STRONG>Description:</STRONG></DT>
 <DD>Iterate over tagged regions until <TT>iterfn</TT> returns <TT>false</TT>.
- The function itself returns <TT>true</TT> if it reaches the end of list
+ The function is called in protected mode.
+ This routine returns <TT>true</TT> if it reaches the end of list
  without this happening.
   
 </DD>
@@ -2035,7 +2048,9 @@ When a keyboard resize function is called, and at most <TT>kbresize_t_max</TT>
 
 </DD>
 <DT><STRONG>Description:</STRONG></DT>
-<DD>Set frame mode.
+<DD>Set frame mode (one of
+ `<TT>unknown</TT>', `<TT>tiled</TT>', `<TT>floating</TT>', `<TT>transient</TT>',
+ or any of these suffixed with `<TT>-alt</TT>').
   
 </DD>
 </DL>
@@ -2145,21 +2160,6 @@ In addition parameters to the region to be created are passed in this
 </DD>
 </DL>
 
-<P>
-
-  <DL>
-<DD><A NAME="fn:WGroup.is_fullscreen"></A>  
-</DD>
-<DT><STRONG>Synopsis:</STRONG></DT>
-<DD><TT>bool WGroup.is_fullscreen(WGroup grp)</TT>
-
-</DD>
-<DT><STRONG>Description:</STRONG></DT>
-<DD>Is <TT>reg</TT> in full screen mode?
-  
-</DD>
-</DL>
-
 <P>
 
   <DL>
@@ -2172,7 +2172,8 @@ In addition parameters to the region to be created are passed in this
 <DT><STRONG>Description:</STRONG></DT>
 <DD>Iterate over managed regions of <TT>ws</TT> until <TT>iterfn</TT> returns
  <TT>false</TT>.
- The function itself returns <TT>true</TT> if it reaches the end of list
+ The function is called in protected mode.
+ This routine returns <TT>true</TT> if it reaches the end of list
  without this happening.
   
 </DD>
@@ -2398,6 +2399,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 <TT>switchto</TT>.</TD>
 </TR>
+<TR><TD ALIGN="LEFT"><TT>passive</TT></TD>
+<TD ALIGN="LEFT">(boolean) Skip in certain focusing operations.</TD>
+</TR>
 <TR><TD ALIGN="LEFT"><TT>pseudomodal</TT></TD>
 <TD ALIGN="LEFT">(boolean) The attached region is ``pseudomodal''
                       if the stacking level dictates it to be modal.
@@ -2509,7 +2513,8 @@ In addition parameters to the region to be created are passed in this
 <DT><STRONG>Description:</STRONG></DT>
 <DD>Iterate over managed regions of <TT>mplex</TT> until <TT>iterfn</TT> returns
  <TT>false</TT>.
- The function itself returns <TT>true</TT> if it reaches the end of list
+ The function is called in protected mode.
+ This routine returns <TT>true</TT> if it reaches the end of list
  without this happening.
   
 </DD>
@@ -2558,7 +2563,8 @@ In addition parameters to the region to be created are passed in this
 <DT><STRONG>Description:</STRONG></DT>
 <DD>Iterate over numbered/mutually exclusive region list of <TT>mplex</TT> 
  until <TT>iterfn</TT> returns <TT>false</TT>.
- The function itself returns <TT>true</TT> if it reaches the end of list
+ The function is called in protected mode.
+ This routine returns <TT>true</TT> if it reaches the end of list
  without this happening.
   
 </DD>
@@ -2612,13 +2618,13 @@ In addition parameters to the region to be created are passed in this
  list of <TT>mplex</TT>. Special values for <TT>index</TT> are:
  <TABLE CELLPADDING=3 WIDTH="100%">
 <TR><TD ALIGN="LEFT"><SPAN CLASS="MATH"><IMG
- WIDTH="27" HEIGHT="31" ALIGN="MIDDLE" BORDER="0"
+ WIDTH="26" HEIGHT="33" ALIGN="MIDDLE" BORDER="0"
  SRC="img4.png"
  ALT="$-1$"></SPAN></TD>
 <TD ALIGN="LEFT">Last.</TD>
 </TR>
 <TR><TD ALIGN="LEFT"><SPAN CLASS="MATH"><IMG
- WIDTH="27" HEIGHT="31" ALIGN="MIDDLE" BORDER="0"
+ WIDTH="26" HEIGHT="33" ALIGN="MIDDLE" BORDER="0"
  SRC="img5.png"
  ALT="$-2$"></SPAN></TD>
 <TD ALIGN="LEFT">After <A HREF="#fn:WMPlex.mx_current"><TT>WMPlex.mx_current</TT></A>.</TD>
@@ -2951,7 +2957,7 @@ Note that this function is asynchronous; the region will not
 <DD><A NAME="fn:WRegion.is_active"></A>  
 </DD>
 <DT><STRONG>Synopsis:</STRONG></DT>
-<DD><TT>bool WRegion.is_active(WRegion reg)</TT>
+<DD><TT>bool WRegion.is_active(WRegion reg, bool pseudoact_ok)</TT>
 
 </DD>
 <DT><STRONG>Description:</STRONG></DT>
@@ -3901,7 +3907,8 @@ Note that this function is asynchronous; the region will not
 <DT><STRONG>Description:</STRONG></DT>
 <DD>Iterate over managed regions of <TT>ws</TT> until <TT>iterfn</TT> returns
  <TT>false</TT>.
- The function itself returns <TT>true</TT> if it reaches the end of list
+ The function is called in protected mode.
+ This routine returns <TT>true</TT> if it reaches the end of list
  without this happening.
   
 </DD>
@@ -4223,6 +4230,10 @@ Note that this function is asynchronous; the region will not
 <TD ALIGN="LEFT">(boolean) Turn some completions case-insensitive
       (default: false).</TD>
 </TR>
+<TR><TD ALIGN="LEFT"><TT>substrcompl</TT></TD>
+<TD ALIGN="LEFT">(boolean) Complete on sub-strings in some cases
+      (default: ftrue).</TD>
+</TR>
 </TABLE>
   
 </DD>
@@ -4234,14 +4245,15 @@ Note that this function is asynchronous; the region will not
 <DD><A NAME="fn:mod_query.popen_completions"></A>  
 </DD>
 <DT><STRONG>Synopsis:</STRONG></DT>
-<DD><TT>mod_query.popen_completions(cp, cmd, fn, reshnd)</TT>
+<DD><TT>mod_query.popen_completions(cp, cmd, fn, reshnd, wd)</TT>
 
 </DD>
 <DT><STRONG>Description:</STRONG></DT>
 <DD>This function can be used to read completions from an external source.
  The parameter <TT>cp</TT> is the completion proxy to be used,
- and the string <TT>cmd</TT> the shell command to be executed. To its stdout, 
- the command should on the first line write the <TT>common_beg</TT> 
+ and the string <TT>cmd</TT> the shell command to be executed, in the directory
+ <TT>wd</TT>. 
+ To its stdout, the command should on the first line write the <TT>common_beg</TT>
  parameter of <A HREF="#fn:WComplProxy.set_completions"><TT>WComplProxy.set_completions</TT></A> (which <TT>fn</TT> maybe used
  to override) and a single actual completion on each of the successive lines.
  The function <TT>reshnd</TT> may be used to override a result table
@@ -5258,7 +5270,7 @@ Note that this function is asynchronous; the selection will not
 <TD ALIGN="LEFT">Description</TD>
 </TR>
 <TR><TD ALIGN="LEFT"><TT>scroll_amount</TT></TD>
-<TD ALIGN="LEFT">Number of pixels to scroll at a time 
+<TD ALIGN="LEFT">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.</TD>
@@ -5846,7 +5858,7 @@ Any parameters not explicitly set in <TT>conftab</TT> will be left unchanged.
 <P>
 
   <DL>
-<DD><A NAME="8264"></A>
+<DD><A NAME="8285"></A>
 
 </DD>
 <DT><STRONG>Hook name:</STRONG></DT>
@@ -5918,7 +5930,7 @@ reg:attach(cwin)
 <P>
 
   <DL>
-<DD><A NAME="8265"></A>
+<DD><A NAME="8286"></A>
 
 </DD>
 <DT><STRONG>Hook name:</STRONG></DT>
@@ -5938,7 +5950,7 @@ reg:attach(cwin)
 <P>
 
   <DL>
-<DD><A NAME="8266"></A>
+<DD><A NAME="8287"></A>
 
 </DD>
 <DT><STRONG>Hook name:</STRONG></DT>
@@ -5959,7 +5971,7 @@ reg:attach(cwin)
 <P>
 
   <DL>
-<DD><A NAME="8267"></A>
+<DD><A NAME="8288"></A>
 
 </DD>
 <DT><STRONG>Hook name:</STRONG></DT>
@@ -5980,7 +5992,7 @@ reg:attach(cwin)
 <P>
 
   <DL>
-<DD><A NAME="8268"></A>
+<DD><A NAME="8289"></A>
 
 </DD>
 <DT><STRONG>Hook name:</STRONG></DT>
@@ -6026,7 +6038,7 @@ reg:attach(cwin)
 <P>
 
   <DL>
-<DD><A NAME="8269"></A>
+<DD><A NAME="8290"></A>
 
 </DD>
 <DT><STRONG>Hook name:</STRONG></DT>
@@ -6047,7 +6059,7 @@ reg:attach(cwin)
 <P>
 
   <DL>
-<DD><A NAME="8270"></A>
+<DD><A NAME="8291"></A>
 
 </DD>
 <DT><STRONG>Hook name:</STRONG></DT>
@@ -6067,7 +6079,7 @@ reg:attach(cwin)
 <P>
 
   <DL>
-<DD><A NAME="8271"></A>
+<DD><A NAME="8292"></A>
 
 </DD>
 <DT><STRONG>Hook name:</STRONG></DT>
@@ -6088,7 +6100,7 @@ reg:attach(cwin)
 <P>
 
   <DL>
-<DD><A NAME="8272"></A>
+<DD><A NAME="8293"></A>
 
 </DD>
 <DT><STRONG>Hook name:</STRONG></DT>
@@ -6108,7 +6120,7 @@ reg:attach(cwin)
 <P>
 
   <DL>
-<DD><A NAME="8273"></A>
+<DD><A NAME="8294"></A>
 
 </DD>
 <DT><STRONG>Hook name:</STRONG></DT>
@@ -6128,7 +6140,7 @@ reg:attach(cwin)
 <P>
 
   <DL>
-<DD><A NAME="8274"></A>
+<DD><A NAME="8295"></A>
 
 </DD>
 <DT><STRONG>Hook name:</STRONG></DT>
@@ -6180,7 +6192,7 @@ reg:attach(cwin)
 <P>
 
   <DL>
-<DD><A NAME="8275"></A>
+<DD><A NAME="8296"></A>
 
 </DD>
 <DT><STRONG>Hook name:</STRONG></DT>
@@ -6201,7 +6213,7 @@ reg:attach(cwin)
 <P>
 
   <DL>
-<DD><A NAME="8276"></A>
+<DD><A NAME="8297"></A>
 
 </DD>
 <DT><STRONG>Hook name:</STRONG></DT>
@@ -6223,7 +6235,7 @@ reg:attach(cwin)
 <P>
 
   <DL>
-<DD><A NAME="8277"></A>
+<DD><A NAME="8298"></A>
 
 </DD>
 <DT><STRONG>Hook name:</STRONG></DT>
@@ -6357,31 +6369,31 @@ that border.
 
 <DIV CLASS="navigation"><HR>
 <!--Navigation Panel-->
-<A NAME="tex2html383"
+<A NAME="tex2html382"
   HREF="node8.html">
 <IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A> 
-<A NAME="tex2html377"
+<A NAME="tex2html376"
   HREF="ionconf.html">
 <IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A> 
-<A NAME="tex2html371"
+<A NAME="tex2html370"
   HREF="node6.html">
 <IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A> 
-<A NAME="tex2html379"
+<A NAME="tex2html378"
   HREF="node1.html">
 <IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A> 
-<A NAME="tex2html381"
+<A NAME="tex2html380"
   HREF="node11.html">
 <IMG WIDTH="43" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="index" SRC="index.png"></A> 
 <BR>
-<B> Next:</B> <A NAME="tex2html384"
-  HREF="node8.html">A. The GNU General</A>
-<B> Up:</B> <A NAME="tex2html378"
+<B> Next:</B> <A NAME="tex2html383"
+  HREF="node8.html">A. GNU Free Documentation</A>
+<B> Up:</B> <A NAME="tex2html377"
   HREF="ionconf.html">Configuring and extending Ion3</A>
-<B> Previous:</B> <A NAME="tex2html372"
+<B> Previous:</B> <A NAME="tex2html371"
   HREF="node6.html">5. Scripting</A>
- &nbsp; <B>  <A NAME="tex2html380"
+ &nbsp; <B>  <A NAME="tex2html379"
   HREF="node1.html">Contents</A></B> 
- &nbsp; <B>  <A NAME="tex2html382"
+ &nbsp; <B>  <A NAME="tex2html381"
   HREF="node11.html">Index</A></B> </DIV>
 <!--End of Navigation Panel-->