]> git.lyx.org Git - lyx.git/blobdiff - src/LyXAction.cpp
Fix bug #12772
[lyx.git] / src / LyXAction.cpp
index ca8c5b751b0ade83d2fe21f74d15db0b57d7674c..f93ea9564df570a0345e73e370888a92f1de1744 100644 (file)
@@ -331,6 +331,16 @@ void LyXAction::init()
  */
                { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
 
+/*!
+ * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_LIST
+ * \li Action: Lists the available databases (separated by path separator common
+ *             on the used OS).
+ * \li Notion: Used by bibliographic managers
+ * \li Syntax: bibtex-database-list
+ * \li Origin: bpiwowar, 18 December 2022
+ * \endvar
+ */
+               { LFUN_BIBTEX_DATABASE_LIST, "bibtex-database-list", ReadOnly, System },
 
 /*!
  * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
@@ -452,6 +462,15 @@ void LyXAction::init()
  */
                { LFUN_BRANCH_INSERT, "branch-insert", Noop, Edit },
 
+/*!
+ * \var lyx::FuncCode lyx::LFUN_BRANCH_SYNC_ALL
+ * \li Action: Open/close all insets of selected branch (depending on its activation status).
+ * \li Syntax: branch-sync-all
+ * \li Origin: sanda, 15 April 2022
+ * \endvar
+ */
+               { LFUN_BRANCH_SYNC_ALL, "branch-sync-all", AtPoint, Buffer },
+
 /*!
  * \var lyx::FuncCode lyx::LFUN_BRANCH_INVERT
  * \li Action: Toggles inversion status of branch inset.
@@ -642,7 +661,7 @@ void LyXAction::init()
                visible in any window.
  * \li Syntax: buffer-forall <LFUN-COMMAND>
  * \li Params: <LFUN-COMMAND>: The command to be applied to the buffers.
- * \li Sample: Close all Notes in buffers: \n
+ * \li Sample: Close all Notes in all buffers: \n
                buffer-forall inset-forall Note inset-toggle close \n
                Toggle change tracking on buffers: \n
                buffer-forall changes-track \n
@@ -716,7 +735,7 @@ void LyXAction::init()
                Template will be asked for via Open-dialog.
  * \li Syntax: buffer-new-template [<FILE>] [<TEMPLATE FILE>]
  * \li Params: <FILE>: filename of created file with absolute path. If empty
- *                     or "newfile", a file with appropriate name is generated.
+ *                     or "newfile", a file with appropriate name is generated.\n
  *             <TEMPLATE FILE>: filename of template with absolute path. If empty,
  *                              a dialog is opened to select the new file.
  * \endvar
@@ -834,8 +853,8 @@ void LyXAction::init()
                is able to detect such changes (e.g. ghostview for postscript).
  * \li Syntax: buffer-update [<FORMAT>]
  * \li Params: <FORMAT>: The format to display, where this is one of the
-                         formats defined (in the current GUI) in the
-                         Tools>Preferences>File Formats dialog.
+                         formats defined in the Tools>Preferences>File Formats dialog,
+                         use the "Short name" field.
                          If no format is given, the default format as
                          specified in the same dialog is used.
  * \li Origin: Dekel, 5 Aug 2000
@@ -879,7 +898,7 @@ void LyXAction::init()
                is already associated with the buffer, asking for one if
                none is yet assigned.
  * \li Syntax: buffer-write [force]
- * \li Params: force: write even if buffer is clean.
+ * \li Params: force: write even if buffer is not marked as modified.
  * \endvar
  */
                { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
@@ -908,7 +927,7 @@ void LyXAction::init()
  * \li Action: Rename and save current buffer in the local templates directory.
  * \li Syntax: buffer-write-as-template <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_TEMPLATE, "buffer-write-as-template", ReadOnly, Buffer },
@@ -1141,8 +1160,8 @@ void LyXAction::init()
 /*!
  * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_BACKWARD
  * \li Action: Deletes one character in the backward direction (usually the "BackSpace" key).
- * \li Syntax: char-delete-backward [force]
- * \li Params: force: Delete big insets, do not only select them.
+ * \li Syntax: char-delete-backward [confirm]
+ * \li Params: confirm: Select big insets, do not directly delete them.
  * \endvar
  */
                { LFUN_CHAR_DELETE_BACKWARD, "char-delete-backward", SingleParUpdate, Edit },
@@ -1150,8 +1169,8 @@ void LyXAction::init()
 /*!
  * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_FORWARD
  * \li Action: Deletes one character in the backward direction (usually the "Delete" key).
- * \li Syntax: char-delete-forward [force]
- * \li Params: force: Delete big insets, do not only select them.
+ * \li Syntax: char-delete-forward [confirm]
+ * \li Params: confirm: Select big insets, do not directly delete them.
  * \endvar
  */
                { LFUN_CHAR_DELETE_FORWARD, "char-delete-forward", SingleParUpdate, Edit },
@@ -1668,22 +1687,6 @@ void LyXAction::init()
  */
                { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
 
-/*!
- * \var lyx::FuncCode lyx::LFUN_FINISHED_UP
- * \li Action: Moves the cursor out of the current slice, going up.
- * \li Notion: See also #LFUN_FINISHED_DOWN.
- * \endvar
- */
-               { LFUN_FINISHED_UP, "", ReadOnly, Hidden },
-
-/*!
- * \var lyx::FuncCode lyx::LFUN_FINISHED_DOWN
- * \li Action: Moves the cursor out of the current slice, going down.
- * \li Notion: See also #LFUN_FINISHED_DOWN.
- * \endvar
- */
-               { LFUN_FINISHED_DOWN, "", ReadOnly, Hidden },
-
 /*!
  * \var lyx::FuncCode lyx::LFUN_FLEX_INSERT
  * \li Action: Inserts CharStyle, Custom inset or XML short element.
@@ -1982,6 +1985,17 @@ void LyXAction::init()
  */
                { LFUN_INDEX_INSERT, "index-insert", Noop, Edit },
 
+/*!
+ * \var lyx::FuncCode lyx::LFUN_INDEX_TAG_ALL
+ * \li Action: Tags all occurrences of the word before the cursor with the
+ *             index inset at cursor.
+ * \li Notion: It automatically takes the word on the cursor position.
+ * \li Syntax: index-tag-all
+ * \li Origin: spitz, 5 Nov 2022
+ * \endvar
+ */
+               { LFUN_INDEX_TAG_ALL, "index-tag-all", AtPoint, Edit },
+
 /*!
  * \var lyx::FuncCode lyx::LFUN_INDEX_PRINT
  * \li Action: Inserts list of Index entries on a new page.
@@ -2077,6 +2091,14 @@ void LyXAction::init()
  */
                { LFUN_INSET_COPY_AS, "inset-copy-as", ReadOnly | NoUpdate | AtPoint, Edit },
 
+/*!
+ * \var lyx::FuncCode lyx::LFUN_INSET_INSERT_COPY
+ * \li Action: Inserts the inset's content (in ToC pane) at the position of the cursor.
+ * \li Syntax: inset-insert-copy
+ * \li Origin: spitz, 1 Nov 2022
+ * \endvar
+ */
+               { LFUN_INSET_INSERT_COPY, "inset-insert-copy", Noop, Edit},
 
 /*!
  * \var lyx::FuncCode lyx::LFUN_INSET_DIALOG_UPDATE
@@ -2178,9 +2200,11 @@ void LyXAction::init()
                matches all note insets, while "Note:Note" only matches LyX
                yellow note insets.
  * \li Sample: Remove all index insets: \n
-                   inset-forall Index char-delete-forward force \n
-               Close all Notes (also works for a particular branch, for example): \n
+                   inset-forall Index char-delete-forward \n
+               Close all Notes: \n
                    inset-forall Note inset-toggle close \n
+               Open all branch insets of branch "myBranch": \n
+                   inset-forall Branch:myBranch inset-toggle open \n
                Transform all yellow notes to comments \n
                    inset-forall Note:Note inset-modify note Note Comment \n
                Try to put LyX in an infinite loop if there is at least a Note: \n
@@ -2265,10 +2289,10 @@ void LyXAction::init()
  * \li Action: Splits the current inset into two at current position.
  * \li Syntax: inset-split [<INSET>]
  * \li Params: <INSET>: this can be used to make sure the right kind of inset
-                       is dissolved. For example "split" entry in the charstyles
-                       sub-menu should only dissolve the charstyle inset, even if the
-                       cursor is inside several nested insets of different type.\n
-                       For values see #lyx::InsetLayout::lyxtype_ .
+                        is dissolved. For example "split" entry in the charstyles
+                        sub-menu should only dissolve the charstyle inset, even if the
+                        cursor is inside several nested insets of different type.\n
+                        For values see #lyx::InsetLayout::lyxtype_ .
  * \li Origin: spitz, 22 Dec 2020
  * \endvar
  */
@@ -2312,6 +2336,16 @@ void LyXAction::init()
  */
                { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
 
+/*!
+ * \var lyx::FuncCode lyx::LFUN_INDEXMACRO_INSERT
+ * \li Action: Inserts special Index macros into the document.
+ * \li Syntax: indexmacro-insert <type>
+ * \li Params: <type>: see, seealso, subentry, sortkey.
+ * \li Origin: spitz, 20 Feb 2022
+ * \endvar
+ */
+               { LFUN_INDEXMACRO_INSERT, "indexmacro-insert", Noop, Edit },
+
 
 /*!
  * \var lyx::FuncCode lyx::LFUN_IPAMACRO_INSERT
@@ -3802,7 +3836,7 @@ void LyXAction::init()
  *             spell checker dictionary.
  *             The default for the language is retrieved from the cursor position.
  * \li Syntax: spelling-add [<STRING>] [<LANG>]
- * \li Params: <WORD>: word to add
+ * \li Params: <WORD>: word to add\n
                <LANG>: language name (see file languages)
  * \li Origin: spitz, 18 Jan 2010
  * \endvar
@@ -3815,8 +3849,8 @@ void LyXAction::init()
  *             spell checker dictionary.
  *             The default for the language is retrieved from the cursor position.
  * \li Syntax: spelling-add-local [<STRING>] [<LANG>]
- * \li Params: <WORD>: word to add
-              <LANG>: language name (see file languages)
+ * \li Params: <WORD>: word to add\n
+               <LANG>: language name (see file languages)
  * \li Origin: spitz, 6 Mar 2021
  * \endvar
  */
@@ -3828,8 +3862,8 @@ void LyXAction::init()
  *             spell checker dictionary.
  *             The default for the language is retrieved from the cursor position.
  * \li Syntax: spelling-remove-local [<STRING>] [<LANG>]
- * \li Params: <WORD>: word to remove
-              <LANG>: language name (see file languages)
+ * \li Params: <WORD>: word to remove\n
+               <LANG>: language name (see file languages)
  * \li Origin: spitz, 7 Mar 2021
  * \endvar
  */
@@ -3851,7 +3885,7 @@ void LyXAction::init()
  *             in the current session for the given language.
  *             The default for the language is retrieved from the cursor position.
  * \li Syntax: spelling-ignore [<WORD>] [<LANG>]
- * \li Params: <WORD>: word to ignore
+ * \li Params: <WORD>: word to ignore\n
                <LANG>: language name (see file languages)
  * \li Origin: spitz, 18 Jan 2010
  * \endvar
@@ -3864,8 +3898,8 @@ void LyXAction::init()
  *             spell checker dictionary.
  *             The default for the language is retrieved from the cursor position.
  * \li Syntax: spelling-remove [<STRING>] [<LANG>]
- * \li Params: <WORD>: word to remove
*             <LANG>: language name (see file languages)
+ * \li Params: <WORD>: word to remove\n
              <LANG>: language name (see file languages)
  * \li Origin: SWitt, 28 July 2010
  * \endvar
  */
@@ -3957,6 +3991,22 @@ void LyXAction::init()
  */
                { LFUN_TAB_DELETE, "tab-delete", SingleParUpdate, Edit },
 
+/*!
+ * \var lyx::FuncCode lyx::LFUN_TAB_GROUP_NEXT
+ * \li Action: Switch to the next tab group in split view.
+ * \li Syntax: tab-group-next
+ * \endvar
+ */
+               { LFUN_TAB_GROUP_NEXT, "tab-group-next", ReadOnly, Buffer },
+
+/*!
+ * \var lyx::FuncCode lyx::LFUN_TAB_GROUP_PREVIOUS
+ * \li Action: Switch to the previous tab group in split view.
+ * \li Syntax: tab-group-previous
+ * \endvar
+ */
+               { LFUN_TAB_GROUP_PREVIOUS, "tab-group-previous", ReadOnly, Buffer },
+
 /*!
  * \var lyx::FuncCode lyx::LFUN_TAB_GROUP_CLOSE
  * \li Action: Close the current tab group.
@@ -4031,7 +4081,7 @@ void LyXAction::init()
  * \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
  * \li Action: Look up thesaurus entries with respect to the word under the cursor.
  * \li Syntax: thesaurus-entry [<STRING>] [lang=<LANG>]
- * \li Params: <STRING>: word to look up
+ * \li Params: <STRING>: word to look up\n
                <LANG>: language (see file languages)
  * \li Origin: Levon, 20 Jul 2001
  * \endvar
@@ -4056,8 +4106,8 @@ void LyXAction::init()
  * \li Notion: Skipping "auto" when allowauto is false.
  * \li Syntax: toolbar-set <NAME> [on|off|auto]
  * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|\n
-                      minibuffer|review|view/update|math_panels|vcs|
-                      view-others|update-others
+                       minibuffer|review|view/update|math_panels|vcs|\n
+                       view-others|update-others
  * \li Origin: spitz, 17 Dec 2020
  * \endvar
  */
@@ -4069,7 +4119,7 @@ void LyXAction::init()
  * \li Notion: Skipping "auto" when allowauto is false.
  * \li Syntax: toolbar-toggle <NAME> [allowauto]
  * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|\n
-                       minibuffer|review|view/update|math_panels|vcs|
+                       minibuffer|review|view/update|math_panels|vcs|\n
                        view-others|update-others
  * \li Origin: Edwin, 21 May 2007
  * \endvar
@@ -4080,13 +4130,20 @@ void LyXAction::init()
  * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
  * \li Action: Various UI visibility-toggling actions.
  * \li Syntax: ui-toggle <statusbar|menubar|scrollbar|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 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
+               zoomslider    : Toggle visibility of the zoom slider in statusbar.\n
+               zoomlevel     : Toggle visibility of the zoom level display in statusbar.\n
+               statistics-w  : Toggle visibility of the document word count in statusbar.\n
+               statistics-cb : Toggle visibility of the document character count (incl. blanks)
+                               in statusbar.\n
+               statistics-c  : Toggle visibility of the document character count (excl. blanks)
+                               in statusbar.\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: sanda, 9 Feb 2007
  * \endvar
  */
@@ -4370,8 +4427,8 @@ void LyXAction::init()
 /*!
  * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_BACKWARD
  * \li Action: Deletes characters to the beginning of the word (usually the "C+BackSpace" key).
- * \li Syntax: word-delete-backward [force]
- * \li Params: force: Delete big insets, do not only select them.
+ * \li Syntax: word-delete-backward [confirm]
+ * \li Params: confirm: Select big insets, do not directly delete them.
  * \endvar
  */
                { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
@@ -4379,8 +4436,8 @@ void LyXAction::init()
 /*!
  * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_FORWARD
  * \li Action: Deletes characters to the end of the word (usually the "C+Delete" key).
- * \li Syntax: word-delete-forward [force]
- * \li Params: force: Delete big insets, do not only select them.
+ * \li Syntax: word-delete-forward [confirm]
+ * \li Params: confirm: Select big insets, do not directly delete them.
  * \endvar
  */
                { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },