@@ -2288,9 +2398,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.
+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. |
@@ -2307,33 +2425,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 +2440,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 +2457,7 @@ In addition parameters to the region to be created are passed in this
--
-
-
+
-
- Synopsis:
- table WMPlex.get_stdisp(WMPlex mplex)
@@ -2378,16 +2473,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 +2488,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 +2503,17 @@ 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 itself returns true if it reaches the end of list
+ without this happening.
@@ -2429,9 +2521,7 @@ In addition parameters to the region to be created are passed in this
--
-
-
+
-
- Synopsis:
- integer WMPlex.mx_count(WMPlex mplex)
@@ -2446,9 +2536,7 @@ In addition parameters to the region to be created are passed in this
--
-
-
+
-
- Synopsis:
- WRegion WMPlex.mx_current(WMPlex mplex)
@@ -2464,17 +2552,17 @@ 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 itself returns true if it reaches the end of list
+ without this happening.
@@ -2482,17 +2570,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 +2586,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 +2594,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 +2604,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:
@@ -2545,9 +2634,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 +2652,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 +2676,7 @@ In addition parameters to the region to be created are passed in this
--
-
-
+
-
- Synopsis:
- void WMPlex.switch_next(WMPlex mplex)
@@ -2603,9 +2692,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 +2707,7 @@ In addition parameters to the region to be created are passed in this
--
-
-
+
-
- Synopsis:
- void WMPlex.switch_prev(WMPlex mplex)
@@ -2637,16 +2722,14 @@ In addition parameters to the region to be created are passed in this
-
--
-
-
+
-
- Synopsis:
- void WMoveresMode.cancel(WMoveresMode mode)
@@ -2662,9 +2745,7 @@ In addition parameters to the region to be created are passed in this
--
-
-
+
-
- Synopsis:
- void WMoveresMode.finish(WMoveresMode mode)
@@ -2680,9 +2761,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 +2807,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 +2824,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 +2867,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 +2883,7 @@ In addition parameters to the region to be created are passed in this
--
-
-
+
-
- Synopsis:
- table WRegion.geom(WRegion reg)
@@ -2797,9 +2899,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,9 +2935,23 @@ 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)
@@ -2836,9 +2966,7 @@ Note that this function is asynchronous; the region will not
--
-
-
+
-
- Synopsis:
- bool WRegion.is_activity(WRegion reg)
@@ -2853,9 +2981,7 @@ Note that this function is asynchronous; the region will not
--
-
-
+
-
- Synopsis:
- bool WRegion.is_mapped(WRegion reg)
@@ -2870,9 +2996,7 @@ Note that this function is asynchronous; the region will not
--
-
-
+
-
- Synopsis:
- bool WRegion.is_tagged(WRegion reg)
@@ -2887,9 +3011,7 @@ Note that this function is asynchronous; the region will not
--
-
-
+
-
- Synopsis:
- WRegion WRegion.manager(WRegion reg)
@@ -2904,9 +3026,7 @@ Note that this function is asynchronous; the region will not
--
-
-
+
-
- Synopsis:
- string WRegion.name(WRegion reg)
@@ -2921,9 +3041,7 @@ Note that this function is asynchronous; the region will not
--
-
-
+
-
- Synopsis:
- WWindow WRegion.parent(WRegion reg)
@@ -2938,9 +3056,7 @@ Note that this function is asynchronous; the region will not
--
-
-
+
-
- Synopsis:
- WRootWin WRegion.rootwin_of(WRegion reg)
@@ -2955,12 +3071,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 +3082,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 +3094,7 @@ Note that this function is asynchronous; the region will not
--
-
-
+
-
- Synopsis:
- WRegion WRegion.rqclose_propagate(WRegion reg, WRegion maybe_sub)
@@ -2993,8 +3104,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 +3113,7 @@ Note that this function is asynchronous; the region will not
--
-
-
+
-
- Synopsis:
- table WRegion.rqgeom(WRegion reg, table g)
@@ -3022,9 +3131,7 @@ Note that this function is asynchronous; the region will not
--
-
-
+
-
- Synopsis:
- bool WRegion.rqorder(WRegion reg, string ord)
@@ -3032,7 +3139,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 +3147,7 @@ Note that this function is asynchronous; the region will not
--
-
-
+
-
- Synopsis:
- WScreen WRegion.screen_of(WRegion reg)
@@ -3057,17 +3162,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 +3178,7 @@ Note that this function is asynchronous; the region will not
--
-
-
+
-
- Synopsis:
- bool WRegion.set_name(WRegion reg, string p)
@@ -3085,7 +3186,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 +3196,7 @@ Note that this function is asynchronous; the region will not
--
-
-
+
-
- Synopsis:
- bool WRegion.set_name_exact(WRegion reg, string p)
@@ -3106,7 +3205,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 +3213,7 @@ Note that this function is asynchronous; the region will not
--
-
-
+
-
- Synopsis:
- bool WRegion.set_tagged(WRegion reg, string how)
@@ -3124,7 +3221,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 +3230,7 @@ Note that this function is asynchronous; the region will not
--
-
-
+
-
- Synopsis:
- table WRegion.size_hints(WRegion reg)
@@ -3150,16 +3246,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 +3267,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 +3289,7 @@ Note that this function is asynchronous; the region will not
--
-
-
+
-
- Synopsis:
- bool WScreen.set_managed_offset(WScreen scr, table offset)
@@ -3216,16 +3306,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 +3381,7 @@ Note that this function is asynchronous; the region will not
--
-
-
+
-
- Synopsis:
- void WWindow.p_resize(WWindow wwin)
@@ -3261,9 +3398,7 @@ Note that this function is asynchronous; the region will not
--
-
-
+
-
- Synopsis:
- double WWindow.xid(WWindow wwin)
@@ -3277,15 +3412,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 +3433,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 +3455,7 @@ Note that this function is asynchronous; the region will not
--
-
-
+
-
- Synopsis:
- void gr.refresh()
@@ -3340,16 +3470,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 +3488,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 +3509,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 +3531,7 @@ Note that this function is asynchronous; the region will not
--
-
-
+
-
- Synopsis:
- table.copy(t, deep)
@@ -3425,9 +3547,7 @@ Note that this function is asynchronous; the region will not
--
-
-
+
-
- Synopsis:
- table.icat(t1, t2)
@@ -3442,9 +3562,7 @@ Note that this function is asynchronous; the region will not
--
-
-
+
-
- Synopsis:
- table.join(t1, t2)
@@ -3460,9 +3578,7 @@ Note that this function is asynchronous; the region will not
--
-
-
+
-
- Synopsis:
- table.map(f, t)
@@ -3483,17 +3599,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 +3614,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 +3630,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 +3646,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 +3668,7 @@ Note that this function is asynchronous; the region will not
--
-
-
+
-
- Synopsis:
- table WSplit.geom(WSplit split)
@@ -3577,9 +3683,7 @@ Note that this function is asynchronous; the region will not
--
-
-
+
-
- Synopsis:
- WSplitInner WSplit.parent(WSplit split)
@@ -3594,9 +3698,7 @@ Note that this function is asynchronous; the region will not
--
-
-
+
-
- Synopsis:
- table WSplit.rqgeom(WSplit node, table g)
@@ -3613,9 +3715,7 @@ Note that this function is asynchronous; the region will not
--
-
-
+
-
- Synopsis:
- void WSplit.transpose(WSplit node)
@@ -3636,9 +3736,7 @@ Note that this function is asynchronous; the region will not
--
-
-
+
-
- Synopsis:
- WSplit WSplitInner.current(WSplitInner node)
@@ -3659,9 +3757,7 @@ Note that this function is asynchronous; the region will not
--
-
-
+
-
- Synopsis:
- WRegion WSplitRegion.reg(WSplitRegion node)
@@ -3682,9 +3778,7 @@ Note that this function is asynchronous; the region will not
--
-
-
+
-
- Synopsis:
- WSplit WSplitSplit.br(WSplitSplit split)
@@ -3700,17 +3794,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 +3810,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 +3825,7 @@ Note that this function is asynchronous; the region will not
--
-
-
+
-
- Synopsis:
- WSplit WSplitSplit.tl(WSplitSplit split)
@@ -3759,9 +3847,7 @@ Note that this function is asynchronous; the region will not
--
-
-
+
-
- Synopsis:
- bool WTiling.flip_at(WTiling ws, WRegion reg)
@@ -3776,9 +3862,7 @@ Note that this function is asynchronous; the region will not
--
-
-
+
-
- Synopsis:
- bool WTiling.transpose_at(WTiling ws, WRegion reg)
@@ -3793,9 +3877,7 @@ Note that this function is asynchronous; the region will not
--
-
-
+
-
- Synopsis:
- WRegion WTiling.farthest(WTiling ws, string dirstr, bool any)
@@ -3804,8 +3886,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 +3895,17 @@ 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 itself returns true if it reaches the end of list
+ without this happening.
@@ -3830,9 +3913,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 +3921,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 +3932,7 @@ Note that this function is asynchronous; the region will not
--
-
-
+
-
- Synopsis:
- WSplitRegion WTiling.node_of(WTiling ws, WRegion reg)
@@ -3868,9 +3948,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 +3956,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 +3967,7 @@ Note that this function is asynchronous; the region will not
--
-
-
+
-
- Synopsis:
- WSplitSplit WTiling.set_floating(WTiling ws, WSplitSplit split, string how)
@@ -3898,8 +3975,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 +3984,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 +4002,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 +4010,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 +4023,7 @@ Note that this function is asynchronous; the region will not
--
-
-
+
-
- Synopsis:
- WFrame WTiling.split_top(WTiling ws, string dirstr)
@@ -3965,9 +4038,7 @@ Note that this function is asynchronous; the region will not
--
-
-
+
-
- Synopsis:
- WSplit WTiling.split_tree(WTiling ws)
@@ -3982,17 +4053,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 +4075,7 @@ Note that this function is asynchronous; the region will not
--
-
-
+
-
- Synopsis:
- mod_query.defcmd(cmd, fn)
@@ -4023,9 +4090,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 +4121,7 @@ Note that this function is asynchronous; the region will not
--
-
-
+
-
- Synopsis:
- void mod_query.history_clear()
@@ -4058,9 +4136,7 @@ Note that this function is asynchronous; the region will not
--
-
-
+
-
- Synopsis:
- string mod_query.history_get(integer n)
@@ -4075,9 +4151,7 @@ Note that this function is asynchronous; the region will not
--
-
-
+
-
- Synopsis:
- bool mod_query.history_push(string str)
@@ -4092,19 +4166,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 +4185,7 @@ Note that this function is asynchronous; the region will not
--
-
-
+
-
- Synopsis:
- table mod_query.history_table()
@@ -4129,26 +4200,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 +4222,10 @@ 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). |
+