*/
{ 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
*/
{ 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.
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
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
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
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 },
* \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 },
* \li Origin: Levon, 16 Oct 2002
* \endvar
*/
- { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
+ { LFUN_CHANGES_MERGE, "changes-merge", ReadOnly, Edit },
/*!
* \var lyx::FuncCode lyx::LFUN_CHANGES_OUTPUT
/*!
* \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 },
/*!
* \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 },
*/
{ LFUN_FONT_CROSSOUT, "font-crossout", Noop, Layout },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_FONT_NO_SPELLCHECK
+ * \li Action: Toggles nospellcheck status in the font (selection-wise).
+ * \li Syntax: font-nospellcheck
+ * \li Origin: spitz, 5 March 2021
+ * \endvar
+ */
+ { LFUN_FONT_NO_SPELLCHECK, "font-nospellcheck", Noop, Layout },
+
/*!
* \var lyx::FuncCode lyx::LFUN_FONT_TYPEWRITER
* \li Action: Toggles the typewriter family font (selection-wise).
*/
{ LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_LYXFILES_OPEN
+ * \li Action: Open lyxfiles (templates/examples). Create a view if he have none.
+ * \li Syntax: lyxfiles-open [<TYPE>]
+ * \li Params: <TYPE>: templates or examples. Default is templates.
+ * \li Origin: spitz, 10 Feb 2021
+ * \endvar
+ */
+ { LFUN_LYXFILES_OPEN, "lyxfiles-open", NoBuffer | Argument, Buffer },
+
/*!
* \var lyx::FuncCode lyx::LFUN_HREF_INSERT
* \li Action: Inserts hyperlinks into the document (clickable in pdf output).
*/
{ 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.
*/
{ 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
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
*/
{ LFUN_INSET_SETTINGS, "inset-settings", ReadOnly | AtPoint, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_INSET_SPLIT
+ * \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_ .
+ * \li Origin: spitz, 22 Dec 2020
+ * \endvar
+ */
+ { LFUN_INSET_SPLIT, "inset-split", AtPoint, Edit },
+
/*!
* \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
* \li Action: Toggles the collapsible inset at cursor position,
*/
{ 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
/*!
* \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
* \li Action: Pastes the currently selected text.
- * \li Notion: Primary selection mechanism is linux-only thing.
+ * \li Notion: Primary selection mechanism is X11/Wayland-only thing.
* \li Syntax: primary-selection-paste [<ARG>]
* \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
* \endvar
* \var lyx::FuncCode lyx::LFUN_SEARCH_IGNORE
* \li Action: Enables/disables searching for features in findadv
* \li Syntax: search-ignore <type> <value>
- * \li Params: <type>: language|color|sectioning|font|series|shape|family|markup|underline|strike
+ * \li Params: <type>: language|color|sectioning|font|series|shape|family|markup|underline|strike|deleted|non-output-content\n
* \li Params: <value>: true|false
* \endvar
*/
/*!
* \var lyx::FuncCode lyx::LFUN_SET_COLOR
- * \li Action: Set the given LyX color to the color defined by the X11 name given.
+ * \li Action: Set the given LyX color to the color defined by the X11 name given,
+ * and optionally a specific color for dark mode.
* \li Notion: A new color entry is created if the color is unknown.
Color names can be stored as a part of user settings.
- * \li Syntax: set-color <LYX_NAME> <X11_NAME>
+ * \li Syntax: set-color <LYX_NAME> <X11_NAME> [<X11_DARKNAME>]
* \li Origin: SLior, 11 Jun 2000
* \endvar
*/
* 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
*/
{ LFUN_SPELLING_ADD, "spelling-add", ReadOnly, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_SPELLING_ADD_LOCAL
+ * \li Action: Add the word under the cursor to the document's local
+ * 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\n
+ <LANG>: language name (see file languages)
+ * \li Origin: spitz, 6 Mar 2021
+ * \endvar
+ */
+ { LFUN_SPELLING_ADD_LOCAL, "spelling-add-local", Noop, Edit },
+
+/*!
+ * \var lyx::FuncCode lyx::LFUN_SPELLING_REMOVE_LOCAL
+ * \li Action: Remove the word under the cursor from the document's local
+ * 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\n
+ <LANG>: language name (see file languages)
+ * \li Origin: spitz, 7 Mar 2021
+ * \endvar
+ */
+ { LFUN_SPELLING_REMOVE_LOCAL, "spelling-remove-local", Noop, Edit },
+
/*!
* \var lyx::FuncCode lyx::LFUN_SPELLING_CONTINUOUSLY
* \li Action: Toggle continuous spell checking.
* 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
* 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
*/
valign-top|valign-bottom|valign-middle|longtabular-align-left|\n
longtabular-align-center|longtabular-align-right|m-align-left|m-align-right|\n
m-align-center|m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|\n
- reset-formal-default|set-all-lines|unset-all-lines|toggle-longtabular|\n
- set-longtabular|unset-longtabular|set-pwidth|\n
+ reset-formal-default|set-all-lines|toggle-all-lines|unset-all-lines|\n
+ toggle-longtabular|set-longtabular|unset-longtabular|set-pwidth|\n
set-mpwidth|set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|\n
set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|\n
unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|\n
set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|\n
set-special-column|set-special-multicolumn|set-special-multirow|\n
toggle-booktabs|set-booktabs|unset-booktabs|set-top-space|set-bottom-space|\n
- set-interline-space|set-border-lines|tabular-valign-top|\n
- tabular-valign-middle|tabular-valign-bottom|set-tabular-width|\n
- toggle-varwidth-column
+ set-interline-space|tabular-valign-top|tabular-valign-middle|\n
+ tabular-valign-bottom|set-tabular-width|toggle-varwidth-column|\n
+ set-border-lines|toggle-border-lines|set-inner-lines|toggle-inner-lines
Various math-environment features are handled as well, e.g. add-vline-left/right for\n
the Grid/Array environment.\n
<ARG>: additional argument for some commands, use debug mode to explore its values.
*/
{ 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.
* \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
*/
{ LFUN_TOOLBAR_MOVABLE, "toolbar-movable", NoBuffer, Buffer },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_TOOLBAR_SET
+ * \li Action: Sets visibility of a given toolbar to on, off, or auto.
+ * \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|\n
+ view-others|update-others
+ * \li Origin: spitz, 17 Dec 2020
+ * \endvar
+ */
+ { LFUN_TOOLBAR_SET, "toolbar-set", NoBuffer, Buffer },
+
/*!
* \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
* \li Action: Toggles visibility of a given toolbar between on/off/auto.
* \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
* \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
*/
/*!
* \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 },
/*!
* \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 },
*/
{ LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_SEARCH_STRING_SET
+ * \li Action: Set search string buffer.
+ * \li Syntax: search-string-set [<DATA>]
+ * \li Params: <DATA>: string to search for. If no parameter is given,
+ * use (word under) selection.
+ * \li Origin: stwitt, spitz, Feb 12 2021
+ * \endvar
+ */
+ { LFUN_SEARCH_STRING_SET, "search-string-set", ReadOnly, Edit },
+
/*!
* \var lyx::FuncCode lyx::LFUN_WORD_FINDADV
* \li Action: Search for next occurrence of a pattern.
projects / lyx.git / blobdiff