*/
{ 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
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 },
/*!
* \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 },
* \li Notion: See also #LFUN_FINISHED_FORWARD.
* \endvar
*/
- { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
+ { LFUN_FINISHED_BACKWARD, "", ReadOnly | NoUpdate, Hidden },
/*!
* \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
back into the surrounding text.
* \endvar
*/
- { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
+ { LFUN_FINISHED_FORWARD, "", ReadOnly | NoUpdate, Hidden },
/*!
* \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
* \li Notion: See also #LFUN_FINISHED_FORWARD.
* \endvar
*/
- { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
+ { LFUN_FINISHED_LEFT, "", ReadOnly | NoUpdate, Hidden },
/*!
* \li Notion: See also #LFUN_FINISHED_FORWARD
* \endvar
*/
- { 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 },
+ { LFUN_FINISHED_RIGHT, "", ReadOnly | NoUpdate, Hidden },
/*!
* \var lyx::FuncCode lyx::LFUN_FLEX_INSERT
*/
{ 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
the inset is locked, and the temporary file is edited.
In this case, #LFUN_INSET_END_EDIT must be called to overtake
the changes and unlock the inset after editing is finished.
- * \li Syntax: inset-edit [<INSET_PARAMS>]
+ * \li Syntax: inset-edit [nogui] [<INSET_PARAMS>]
* \li Params: <INSET_PARAMS>: Parameters for the inset. \n
- Currently only the filename will be considered.
+ Currently only the filename will be considered.\n
+ nogui: does not launch external editor, only returns filename
+ to be processed.
* \li Origin: spitz, 27 Apr 2006
* \endvar
*/
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
+ 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
* \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
*/
- { LFUN_INSET_SPLIT, "inset-split", AtPoint, Edit },
+ { LFUN_INSET_SPLIT, "inset-split", Noop, Edit },
/*!
* \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
*/
{ 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
* \li Origin: Andre, 9 Aug 2002
* \endvar
*/
- { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
+ { LFUN_MOUSE_DOUBLE, "", ReadOnly | NoUpdate, Hidden },
/*!
* \var lyx::FuncCode lyx::LFUN_MOUSE_MOTION
* \li Origin: Andre, 9 Aug 2002
* \endvar
*/
- { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
+ { LFUN_MOUSE_MOTION, "", ReadOnly | NoUpdate, Hidden },
/*!
* \var lyx::FuncCode lyx::LFUN_MOUSE_PRESS
* \li Origin: Andre, 9 Aug 2002
* \endvar
*/
- { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
+ { LFUN_MOUSE_PRESS, "", ReadOnly | NoUpdate, Hidden },
/*!
* \var lyx::FuncCode lyx::LFUN_MOUSE_RELEASE
* \li Origin: Andre, 9 Aug 2002
* \endvar
*/
- { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
+ { LFUN_MOUSE_RELEASE, "", ReadOnly | NoUpdate, Hidden },
/*!
* \li Origin: Andre, 9 Aug 2002
* \endvar
*/
- { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
+ { LFUN_MOUSE_TRIPLE, "", ReadOnly | NoUpdate, Hidden },
/*!
* \var lyx::FuncCode lyx::LFUN_NEWLINE_INSERT
* \li Action: Moves the current group in the downward direction in the
hierarchy of the document structure.
* \li Notion: Part -> Chapter -> Section -> etc.
- * \li Syntax: outline-in
+ * \li Syntax: outline-in [local]
+ * \li Params: local: if given, only the current paragraph will be affected.
* \li Origin: Vermeer, 23 Mar 2006
* \endvar
*/
* \li Action: Moves the current group in the upward direction in the
hierarchy of the document structure.
* \li Notion: Part <- Chapter <- Section <- etc.
- * \li Syntax: outline-out
+ * \li Syntax: outline-out [local]
+ * \li Params: local: if given, only the current paragraph will be affected.
* \li Origin: Vermeer, 23 Mar 2006
* \endvar
*/
* \var lyx::FuncCode lyx::LFUN_QUOTE_INSERT
* \li Action: Inserts quotes according to the type and quote-language preference.
* \li Notion: Currently 15 different quote styles are distinguished (see params).
- * \li Syntax: quote-insert [<LEVEL>] [<SIDE>] [<STYLE>]
+ * \li Syntax: quote-insert [<LEVEL>] [<SIDE> <STYLE>]
* \li Params: <LEVEL>: 'inner' for (i.e., secondary, usually single) quotes, otherwise
* outer (i.e., primary, usually double) quotes will be used.\n
* <SIDE>: 'opening' for opening quotes, 'closing' for closing quotes,
- * otherwise the side will be guessed from the context.\n
+ * otherwise the side will be guessed from the context. Use 'auto'
+ * to force this default. (You will need to give this argument if
+ * you also want to give <STYLE>.)\n
* <STYLE>: 'british' for `British' quote style (with ``inner quotation'')\n
* 'cjk' for Chinese/Japanese/Korean corner bracket quotation marks\n
* 'cjk-angle' for Chinese/Japanese/Korean angle bracket quotation marks\n
* 'french' for <<french>> quote style (with ``inner quotation'')\n
* 'frenchin' for <<frenchin>> quote style (with <<inner quotation>>) ["in" = Imprimerie Nationale]\n
* 'german' for ,,German`` quote style (with ,inner quotation`)\n
+ * 'hebrew' for ''hebrew,, quote style (with 'inner quotation,)\n
* 'plain' for "Plain" quote style (with 'inner quotation')\n
* 'polish' for ,,Polish'' quote style (with ,inner quotation')\n
* 'swedish' for ''Swedish'' quote style (with 'inner quotation')\n
* 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
* 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
*/
* 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
*/
* 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
*/
* \endvar
*/
{ LFUN_STATISTICS, "statistics", ReadOnly, System },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_STATISTICS_REFERENCE_CLAMP
+ * \li Action: Count statistics relative to the current value.
+ In other words all future values will be subtracted by this value.
+ * \li Syntax: statistics-reference-clamp [reset]
+ * \li Params: reset: remove the clamp, i.e. count in the absolute numbers again
+ * \li Origin: sanda, Mar 28 2024
+ * \endvar
+ */
+ { LFUN_STATISTICS_REFERENCE_CLAMP, "statistics-reference-clamp", ReadOnly, System },
/*!
* \var lyx::FuncCode lyx::LFUN_TABULAR_FEATURE
*/
{ 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
* \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
*/
* \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
- zoomslider : Toggle visibility of the zoom slider in tabbar.\n
- zoomlevel : Toggle visibility of the zoom level display in tabbar.\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 },
projects / lyx.git / blobdiff