Tooltips for collapsables and branches

[lyx.git] / src / LyXAction.cpp

diff --git a/src/LyXAction.cpp b/src/LyXAction.cpp
index 980af677f84dfd3ab7cff45d2fdf7d5c6ae4f095..321d38f50fa74e7d1874dca405056a5e940a4a02 100644 (file)
--- a/src/LyXAction.cpp
+++ b/src/LyXAction.cpp
@@ -263,7 +263,7 @@ void LyXAction::init()
  * \var lyx::kb_action lyx::LFUN_DATE_INSERT
  * \li Action: Inserts the current date.
  * \li Syntax: date-insert [<ARG>]
- * \li Param: <ARG>: Format of date. The default value (%x) can be set
+ * \li Params: <ARG>: Format of date. The default value (%x) can be set
                      in Preferences->Date format. For possible formats
                      see manual page of strftime function.
  * \li Origin: jdblair, 31 Jan 2000
@@ -387,7 +387,7 @@ void LyXAction::init()
  * \li Notion: Only scrolls the screen up or down; does not move the cursor.
  * \li Syntax: scroll <TYPE> <QUANTITY>
  * \li Params: <TYPE>:  line|page\n
-               <QUANTITY>: up|down|<number>\n
+               <QUANTITY>: up|down|<number>
  * \li Origin: Abdelrazak Younes, Dec 27 2007
  * \endvar
  */
@@ -627,7 +627,7 @@ void LyXAction::init()
                { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit },
                { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
 
- /*!
+/*!
  * \var lyx::kb_action lyx::LFUN_LAYOUT
  * \li Action: Sets the layout (that is, environment) for the current paragraph.
  * \li Syntax: layout <LAYOUT>
@@ -1091,8 +1091,33 @@ void LyXAction::init()
  * \endvar
  */
                { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
+/*!
+ * \var lyx::kb_action lyx::LFUN_TOOLBAR_TOGGLE
+ * \li Action: Toggles visibility of a given toolbar between on/off/auto.
+ * \li Notion: Skiping "auto" when allowauto is false.
+ * \li Syntax: toolbar-toggle <NAME> [allowauto]
+ * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|
+                       minibuffer|review|view/update|math_panels
+ * \li Origin: Edwin, 21 May 2007
+ * \endvar
+ */
                { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
                { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
+/*!
+ * \var lyx::kb_action lyx::LFUN_UI_TOGGLE
+ * \li Action: Various UI visibility-toggling actions.
+ * \li Syntax: ui-toggle <statusbar|menubar|frame|fullscreen>
+ * \li Params: statusbar  : Toggle visibility of the statusbar.\n
+               menubar    : Toggle visibility of the menubar.\n
+              scrollbar  : Toggle visibility of the scrollbar.\n
+              frame      : Toggle visibility of the frames around editing window.\n
+              fullscreen : Toggle fullscreen mode. This also covers calling the
+                           previous functions. However #LFUN_TOOLBAR_TOGGLE for the
+                           custom tweaks of the toolbars should be used.
+ * \li Origin: ps, 9 Feb 2007
+ * \endvar
+ */
+               { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
 
                { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
                { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
@@ -1162,11 +1187,25 @@ void LyXAction::init()
                        "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
                        In case of "custom" you will be asked for a format you
                        want to start from and for the command that you want to
-                       apply to this format.
+                       apply to this format. Internally the control is then passed
+                       to #LFUN_BUFFER_EXPORT_CUSTOM.
  * \li Origin: Lgb, 29 Jul 1997
  * \endvar
  */
                { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
+/*!
+ * \var lyx::kb_action lyx::LFUN_BUFFER_EXPORT_CUSTOM
+ * \li Action: Exports the current buffer (document) from the given format using
+               the given command on it.
+ * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
+ * \li Params: <FORMAT> format to start from (LyX will care to produce such
+                        intermediate file).\n
+               <COMMAND> this command will be launched on the file. Note that you can
+              use "$$FName" string to qualify the intermediate file.
+ * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
+ * \li Origin: leeming, 27 Mar 2004
+ * \endvar
+ */
                { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
 /*!
  * \var lyx::kb_action lyx::LFUN_BUFFER_PRINT
@@ -1195,10 +1234,21 @@ void LyXAction::init()
 /*!
  * \var lyx::kb_action lyx::LFUN_BUFFER_NEW
  * \li Action: Creates a new buffer (that is, document).
- * \li Syntax: buffer-new
+ * \li Notion: Implicit path can be set in Preferences dialog.
+ * \li Syntax: buffer-new [<FILE>]
+ * \li Params: <FILE>: filename of created file with absolute path.
  * \endvar
  */
                { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
+/*!
+ * \var lyx::kb_action lyx::LFUN_BUFFER_NEW_TEMPLATE
+ * \li Action: Creates a new buffer (that is, document) from a template.
+ * \li Action: Path for new files and templates can be set in Preferences dialog.
+               Template will be asked for via Open-dialog.
+ * \li Syntax: buffer-new-template [<FILE>]
+ * \li Params: <FILE>: filename of created file with absolute path.
+ * \endvar
+ */
                { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
                { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
                { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
@@ -1232,7 +1282,7 @@ void LyXAction::init()
  * \li Action: Rename and save current buffer.
  * \li Syntax: buffer-write-as <FILENAME>
  * \li Params: <FILENAME>: New name of the buffer/file. A relative path
- *             is with respect to the original location of the buffer/file.
+               is with respect to the original location of the buffer/file.
  * \endvar
  */
                { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },