* The documentation below primarily describes the purpose and syntax
* of the various LFUNs.
*
- * The list is alphabetized. Try to keep it that way, and don't forget to add
+ * The list is alphabetized. Try to keep it that way, and don't forget to add
* doxygen commentary. This allows the file LFUNs.lyx to be auto-generated.
* (If you should want to do that, see the gen_lfuns.py script, which is in
* the development/tools/ directory.)
{ LFUN_BUFFER_EXTERNAL_MODIFICATION_CLEAR,
"buffer-external-modification-clear", ReadOnly, Buffer },
+/*!
+* \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM
+* \li Action: Sets the zoom of the screen fonts.
+* \li Syntax: buffer-zoom [<ZOOM>]
+* \li Params: <ZOOM>: The target zoom value in %;
+* the default is the default zoom as saved in preferences.
+* \li Origin: daniel, 28 Oct 2016
+* \endvar
+*/
+ { LFUN_BUFFER_ZOOM, "buffer-zoom", ReadOnly, Buffer },
+
/*!
* \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_IN
* \li Action: Increases the zoom of the screen fonts.
* \li Syntax: buffer-zoom-in [<ZOOM>]
- * \li Params: <ZOOM>: The zoom in % points (neg. or pos.), the default is 20.
+ * \li Params: <ZOOM>: The zoom value addition in % (neg. or pos.);
+ * the default is 10% of the default zoom as saved in preferences.
* \li Origin: vfr, 30 Mar 2009
* \endvar
*/
* \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_OUT
* \li Action: Decreases the zoom of the screen fonts.
* \li Syntax: buffer-zoom-out [<ZOOM>]
- * \li Params: <ZOOM>: The zoom in % points (neg. or pos.), the default is -20.
+ * \li Params: <ZOOM>: The zoom value abstraction in % (neg. or pos.);
+ * the default is 10% of the default zoom as saved in preferences.
* \li Origin: vfr, 30 Mar 2009
* \endvar
*/
{ LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_DEVEL_MODE_TOGGLE
+ * \li Action: toggle a mode where more information is given in UI
+ * \li Syntax: devel-mode-toggle
+ * \li Notion: in so called "devel" mode, the information given in the
+ * status bar is more precise, and the help documents are
+ * open in editing mode.
+ * \li Origin: lasgouttes, 23 Jul 2017
+ * \endvar
+ */
+ { LFUN_DEVEL_MODE_TOGGLE, "devel-mode-toggle", NoBuffer, System },
+
+
/*!
* \var lyx::FuncCode lyx::LFUN_DIALOG_DISCONNECT_INSET
* \li Action: Closes opened connection to opened inset.
/*!
* \var lyx::FuncCode lyx::LFUN_ENVIRONMENT_SPLIT
* \li Action: Splits the current environment with a Separator.
- * \li Syntax: environment-split [outer]
+ * \li Syntax: environment-split [before|outer|previous]
* \li Params: outer: If this is given, LyX will split the outermost environment in
- * the current nesting hierarchy.
+ the current nesting hierarchy.\n
+ previous: If this is given, LyX will split the environment in the previous
+ paragraph (if there is one).\n
+ before: If this is given, the new environment will be appended rather than
+ prepended.
* \li Origin: spitz, 23 Dec 2012
* \endvar
*/
the work area.\n
2. select the text and run info-insert lfun.
* \li Syntax: info-insert <TYPE> <ARG>
- * \li Params: <TYPE>: shortcut[s]|lyxrc|lyxinfo|package|textclass|menu|buffer \n
+ * \li Params: <TYPE>: shortcut[s]|lyxrc|lyxinfo|package|textclass|menu|icon|buffer \n
<ARG>: argument for a given type. Look into InsetInfo.h for detailed
description. \n
shortcut[s]: name of lfun (e.g math-insert \alpha) \n
/*!
* \var lyx::FuncCode lyx::LFUN_INSET_BEGIN
* \li Action: Move the cursor to the beginning of the current inset
- if it is not already there, or at the beginning of the
- enclosing inset otherwise
+ if it is not already there. If the cursor is already at
+ the beginning of the current inset, move it to the
+ beginning of the enclosing inset or the main work area,
+ respectively, if there is no enclosing inset.
* \li Syntax: inset-begin
* \li Origin: lasgouttes, 16 Mar 2009
* \endvar
/*!
* \var lyx::FuncCode lyx::LFUN_INSET_BEGIN_SELECT
* \li Action: Move the cursor to the beginning of the current inset
- if it is not already there, or at the beginning of the
- enclosing inset otherwise (adding the
+ if it is not already there. If the cursor is already at
+ the beginning of the current inset, move it to the
+ beginning of the enclosing inset or the main work area,
+ respectively, if there is no enclosing inset (adding the
traversed text to the selection).
* \li Syntax: inset-begin-select
* \li Origin: lasgouttes, 16 Mar 2009
* \var lyx::FuncCode lyx::LFUN_INSET_EDIT
* \li Action: Edit the inset at cursor with an external application,
if one is attributed.
+ If the inset is file based, the referenced file is edited.
+ Otherwise, the inset contents is written to a temporary file,
+ 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 Params: <INSET_PARAMS>: Parameters for the inset. \n
Currently only the filename will be considered.
{ LFUN_INSET_EDIT, "inset-edit", ReadOnly | AtPoint, Edit },
+ /*!
+ * \var lyx::FuncCode lyx::LFUN_INSET_END_EDIT
+ * \li Action: End editing the inset at cursor with an external application.
+ * This replaces the inset contents with the contents of the
+ * temporary file, deletes the file and unlocks the inset.
+ * \li Syntax: inset-end-edit
+ * \li Origin: gb, 11 Oct 2015
+ * \endvar
+ */
+ { LFUN_INSET_END_EDIT, "inset-end-edit", ReadOnly | AtPoint, Edit },
+
/*!
* \var lyx::FuncCode lyx::LFUN_INSET_END
- * \li Action: Move the cursor to the end of the current inset
- if it is not already there, or at the end of the
- enclosing inset otherwise
+ * \li Action: Move the cursor to the end of the current inset if it
+ is not already there. If the cursor is already at the
+ end of the current inset, move it to the end of the
+ enclosing inset or the main work area, respectively, if
+ there is no enclosing inset.
* \li Syntax: inset-end
* \li Origin: lasgouttes, 16 Mar 2009
* \endvar
/*!
* \var lyx::FuncCode lyx::LFUN_INSET_END_SELECT
- * \li Action: Move the cursor to the end of the current inset
- if it is not already there, or at the end of the
- enclosing inset otherwise (adding the
+ * \li Action: Move the cursor to the end of the current inset if it
+ is not already there. If the cursor is already at the
+ end of the current inset, move it to the end of the
+ enclosing inset or the main work area, respectively, if
+ there is no enclosing inset (adding the
traversed text to the selection).
* \li Syntax: inset-end-select
* \li Origin: lasgouttes, 16 Mar 2009
/*!
* \var lyx::FuncCode lyx::LFUN_LAYOUT
* \li Action: Sets the layout (that is, environment) for the current paragraph.
- * \li Syntax: layout <LAYOUT>
- * \li Params: <LAYOUT>: the layout to use
+ * \li Syntax: layout <LAYOUT> [ignorenests]
+ * \li Params: <LAYOUT>: the layout to use\n
+ ignorenests: If specified, nesting advices will be ignored.
* \endvar
*/
{ LFUN_LAYOUT, "layout", Noop, Layout },
{ LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_EXPORT
+ * \li Action: Exports the master buffer (document) to the given format.
+ * \li Syntax: master-buffer-export [<FORMAT>] [<DEST>]
+ * \li Params: <FORMAT> is one of the formats which you can find in
+ Tools->Preferences->File formats->Format.
+ Usual format you will enter is "pdf2" (pdflatex),
+ "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
+ Note that "custom" is not allowed in this case.\n
+ If absent or "default", then the default output format of the
+ document is used.\n
+ <DEST> If present, this argument provides the export destination
+ filename. Its containing folder will also be the destination
+ folder, where all the needed external files will be copied.
+ * \li Origin: rkh, 18 April 2018
+ * \endvar
+ */
+ { LFUN_MASTER_BUFFER_EXPORT, "master-buffer-export", ReadOnly, Buffer },
+
/*!
* \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
* \li Action: Update (export) the document built from the master buffer,
* \var lyx::FuncCode lyx::LFUN_PARAGRAPH_BREAK
* \li Action: Breaks the current paragraph at the current location.
* \li Notion: Removes the selection.
- * \li Syntax: paragraph-break [<LAYOUT>]
+ * \li Syntax: paragraph-break [<LAYOUT>] [ignoresep]
* \li Params: <LAYOUT>: "inverse" - decreases depth by one (or change layout
to default layout) when the cursor is at the end of
- the line.
+ the line.\n
+ ignoresep: Do not account for paragraph separators while breaking.
* \endvar
*/
{ LFUN_PARAGRAPH_BREAK, "paragraph-break", Noop, Edit },
*/
{ LFUN_SET_GRAPHICS_GROUP, "set-graphics-group", Noop, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_GRAPHICS_UNIFY
+ * \li Action: Set the same group for all graphics insets in the marked block.
+ * \li Syntax: graphics-unify [<GROUP>]
+ * \li Params: <GROUP>: Id for an existing group. In case the Id is an empty string,
+ the group Id from the first graphics inset will be used.
+ * \li Origin: sanda, 7 Feb 2018
+ * \endvar
+ */
+ { LFUN_GRAPHICS_UNIFY, "graphics-unify", Noop, Edit },
+
/*!
* \var lyx::FuncCode lyx::LFUN_SPACE_INSERT
* \li Action: Inserts various characters into the document.
* \li Syntax: specialchar-insert <CHAR>
* \li Params: <CHAR>: hyphenation, allowbreak, ligature-break, slash,
- nobreakdash, dots, end-of-sentence, menu-separator,
+ nobreakdash, dots, end-of-sentence, menu-separator,
lyx, tex, latex, latex2e.
* \li Origin: JSpitzm, 6 Dec 2007
* \endvar
*/
{ LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_TOOLBAR_MOVABLE
+ * \li Action: Toggles movability of a given toolbar between true/false.
+ * \li Syntax: toolbar-movable <NAME>
+ * \li Params: <NAME>: *|standard|extra|table|math|mathmacrotemplate|\n
+ minibuffer|review|view/update|math_panels|vcs|
+ view-others|update-others
+* \li Origin: daniel, 12 July 2016
+* \endvar
+*/
+ { LFUN_TOOLBAR_MOVABLE, "toolbar-movable", NoBuffer, Buffer },
+
/*!
* \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
* \li Action: Toggles visibility of a given toolbar between on/off/auto.
/*!
* \var lyx::FuncCode lyx::LFUN_UNICODE_INSERT
* \li Action: Inserts a single unicode character.
- * \li Syntax: unicode-insert <CHAR>
- * \li Params: <CHAR>: The character to insert, given as its code
+ * \li Syntax: unicode-insert <CHAR1> <CHAR2> ...
+ * \li Params: <CHARn>: The character to insert, given as its code
point, in hexadecimal.
- * \li Sample: unicode-insert 0x0100
+ * \li Sample: unicode-insert 0x0100 0x0259
* \li Origin: Lgb, 22 Oct 2006
* \endvar
*/
*/
{ LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_BUFFER_ANONYMIZE
+ * \li Action: For debug purposes only. Convert all [a-zA-Z0-1] characters to
+ single character. Useful when submitting docs to list or bugzilla.
+ * \li Syntax: buffer-anonymize
+ * \li Origin: sanda, Feb 1 2018
+ * \endvar
+ */
+ { LFUN_BUFFER_ANONYMIZE, "buffer-anonymize", Noop, Edit },
+
/*!
* \var lyx::FuncCode lyx::LFUN_WORD_RIGHT
* \li Action: Moves the cursor to the next beginning of a word "on the right".
projects / lyx.git / blobdiff