diff --git a/docs/lcdproc-dev/language.docbook b/docs/lcdproc-dev/language.docbook index 7467b87..3efa74b 100644 --- a/docs/lcdproc-dev/language.docbook +++ b/docs/lcdproc-dev/language.docbook @@ -413,10 +413,14 @@ - menu_add_item <menu_id> <new_item_id> <type> + menu_add_item <menu_id> <new_item_id> <type> [options] - Adds a new menuitem to a menu. The main menu of a client, will be created automatically as soon as the client adds an item. This main menu has an empty id ("") and the name is identical to the name of the client. + Adds a new menuitem to a menu. The main menu of a client, + will be created automatically as soon as the client adds + an item. This main menu has an empty id ("") and the name + is identical to the name of the client. The options are + described under menu_set_item below. menu item types action @@ -501,6 +505,31 @@ + + + + -is_hidden false|true (false) + + If the item currently should not appear in a menu. + + + + + + + + -parent <parentid> () + (Re)sets the parent of this + menu. Parentid has to be of type menu. This + function does not change any menu (neither the + old nor the new parent) since this option is + normally used with hidden menus. Otherwise use + menu_add/del_item. Applying this option is + equivalent to second argument of the menu_goto + command. + + + action @@ -688,13 +717,55 @@ - menuscreen_goto <menu_id> + menu_goto <menu_id> [<parent_id>] Changes current menu to <menu_id>. Depending on the - configure option --enable-permissive-menuscreen-goto the + configure option --enable-permissive-menu-goto the client may switch to any (if enabled) or his menus only (if not enabled). + + + <menu_id> + + The menuitem to go to (any menu type e.g. an + action or a menu). + + + + <parent_id> + + Resets the parent of <menu_id>. This + optional parameter can be used to reuse a menu + from different places (for wizzards etc.). Use it + with caution: This may lead to a messy menu + structure in particular due to the fact that the + menus are not changed ! + + + + + + + + + menu_set_main <menu_id> + + + Sets the entry point into the menu system. Use this to + make the server menu invisible. Note that you may only set + the menu to your own clients menus unless the configure + option --permissive-menu-goto is used. (See menuscreens.c + for the menu ids of the server menus.) + + + <menu_id> + + The new main menu, restricted to the client's own + menus. + + + diff --git a/docs/menustuff.txt b/docs/menustuff.txt index 264ae72..fdfbdcd 100644 --- a/docs/menustuff.txt +++ b/docs/menustuff.txt @@ -127,7 +127,7 @@ When it is set at 40%. -fixme: missing description of menuscreen_goto for session control (Volker) +fixme: missing description of menu_goto for session control (Volker) --