* 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.)
/*!
* \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
* \li Action: Exports the current buffer (document) to the given format.
- * \li Syntax: buffer-export <FORMAT> [<DEST>]
+ * \li Syntax: buffer-export [<FORMAT>] [<DEST>]
* \li Params: <FORMAT> is either "custom" or one of the formats which you
can find in Tools->Preferences->File formats->Format.
Usual format you will enter is "pdf2" (pdflatex),
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. Internally the control is then passed
- to #LFUN_BUFFER_EXPORT_CUSTOM.
+ to #LFUN_BUFFER_EXPORT_CUSTOM.\n
+ If absent or "default", then the default output format of the
+ document is used.
<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.
*/
{ LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_BUFFER_EXTERNAL_MODIFICATION_CLEAR
+ * \li Action: Clear the external modification flag on the current buffer.
+ * \li Syntax: buffer-external-modification-clear
+ * \li Origin: gm, 2 March 2017
+ * \endvar
+ */
+ { 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
*/
/*!
* \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
+ * \li Syntax: char-delete-backward [force]
+ * \li Params: force: Delete big insets, do not only select 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
+ * \li Syntax: char-delete-forward [force]
+ * \li Params: force: Delete big insets, do not only select them.
* \endvar
*/
{ LFUN_CHAR_DELETE_FORWARD, "char-delete-forward", SingleParUpdate, Edit },
{ 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.
*/
{ LFUN_FONT_STRIKEOUT, "font-strikeout", Noop, Layout },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_FONT_CROSSOUT
+ * \li Action: Toggles xout (cross-through) in the font (selection-wise).
+ * \li Syntax: font-crossout
+ * \li Origin: uwestoehr, 4 April 2017
+ * \endvar
+ */
+ { LFUN_FONT_CROSSOUT, "font-crossout", Noop, Layout },
+
/*!
* \var lyx::FuncCode lyx::LFUN_FONT_TYPEWRITER
* \li Action: Toggles the typewriter family font (selection-wise).
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
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 \n
+ inset-forall Index char-delete-forward force \n
Close all Notes (also works for a particular branch, for example): \n
inset-forall Note inset-toggle close \n
Transform all yellow notes to comments \n
/*!
* \var lyx::FuncCode lyx::LFUN_REPEAT
* \li Action: Repeat the given command.
+ * \li Notion: fails when the repeat count is greater than 10000.
* \li Syntax: repeat <COUNT> <LFUN-COMMAND>
* \li Origin: Andre, 27 Oct 2003
* \endvar
* \var lyx::FuncCode lyx::LFUN_SPECIALCHAR_INSERT
* \li Action: Inserts various characters into the document.
* \li Syntax: specialchar-insert <CHAR>
- * \li Params: <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots,
- end-of-sentence, menu-separator, lyx, tex, latex, latex2e.
+ * \li Params: <CHAR>: hyphenation, allowbreak, ligature-break, slash,
+ 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_WORD_DELETE_BACKWARD
* \li Action: Deletes characters to the beginning of the word (usually the "C+BackSpace" key).
- * \li Syntax: word-delete-backward
+ * \li Syntax: word-delete-backward [force]
+ * \li Params: force: Delete big insets, do not only select 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
+ * \li Syntax: word-delete-forward [force]
+ * \li Params: force: Delete big insets, do not only select them.
* \endvar
*/
{ LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },