The following subsections list out the functions exported to Lua scripts by Ioncore and the ionws, floatws and query modules.
Similarly to sed's 's' command, rule may contain characters that are inserted in the resulting string and specials as follows:
Special | Description |
$0 | Place the original string here. |
$1 to $9 | Insert n:th capture here (as usual,captures are surrounded by parentheses in the regex). |
$| | Alternative shortening separator. The shortening described before the first this kind of separator is tried first and if it fails to make the string short enough, the next is tried, and so on. |
$< | Remove characters on the left of this marker to shorten the string. |
$> | Remove characters on the right of this marker to shorten the string. Only the first $< or $> within an alternative shortening is used. |
Note that this function is asynchronous; the screen will not actually have received the focus when this function returns.
Note that this function is asynchronous; the screen will not actually have received the focus when this function returns.
Note that this function is asynchronous; the screen will not actually have received the focus when this function returns.
Note that this function is asynchronous; the region will not actually have received the focus when this function returns.
Notice the interplay with X keyboard acceleration parameters. (Maybe insteed of t_min we should use a minimum number of calls to the function/key presses between updated? Or maybe the resize should be completely time-based with key presses triggering the changes?)
Field | Description |
type | Class name (a string) of the object to be created. Mandatory. |
name | Name of the object to be created (a string). Optional. |
switchto | Should the region be switched to (boolean)? Optional. |
index | Index of the new region in mplex's list of managed objects (integer, 0 = first). Optional. |
In addition parameters to the region to be created are passed in this same table.
Note that this function is asynchronous; the region will not actually have received the focus when this function returns.
Note that this function is asynchronous; the region will not actually have received the focus when this function returns.
horizmul/vertmul | effect |
-1 | Move left/up |
0 | No effect |
1 | Move right/down |
Field | Description |
switchto | Should the region be switched to (boolean)? Optional. |
geom | Geometry; x and y, if set, indicates top-left of the frame to be created while width and height, if set, indicate the size of the client window within that frame. Optional. |
Note that this function is asynchronous; the selection will not actually be inserted before Ion receives it. This will be no earlier than Ion return to its main loop.
Key | Values | Description |
name | string | Name of dock |
hpos | left/center/right | Horizontal position |
vpos | top/middle/bottom | Vertical position |
grow | up/down/left/right | Growth direction where new dockapps are added) |
is_auto | bool | Should dock automatically manage new dockapps? |
is_mapped | bool | Is dock mapped? |
Any parameters not explicitly set in conftab will be left unchanged.
Calling this function is equivalent to make_mplex_sub_or_self_fn(fn, true, true, true).
Calling this function is equivalent to make_mplex_sub_or_self_fn(fn, true, true, false).
Parameter | Description |
prompt | The prompt |
prog | Program name or a function that returns it when called. |
Parameter | Description |
prompt | The prompt |
dflt | Default value to call prog with |
prog | Program name or a function that returns it when called. |
completor | A completor function. |
Parameter | Description |
prompt | The prompt. |
initfn | A function that returns initial input when called. |
handler | The function to be called with the mplex/frame/screen and user input as parameters when the query is finished. |
completor | A completor function. |
Parameter | Description |
prompt | The prompt. |
initfn | A function that returns initial input when called. |
handler | The function to be called with the user input as parameter when the query is finished. |
completor | A completor function. |
query_man_path = { "/usr/local/man","/usr/man", "/usr/share/man", "/usr/X11R6/man", }
See also: menu_menu, make_bigmenu_fn and make_pmenu_fn.
See also: menu_pmenu, make_menu_fn.