/*!
* \var lyx::FuncCode lyx::LFUN_
- * \li Action:
- * \li Notion:
- * \li Syntax:
- * \li Params:
+ * \li Action:
+ * \li Notion:
+ * \li Syntax:
+ * \li Params:
* \li Sample:
- * \li Origin:
+ * \li Origin:
* \endvar
*/
// magnitudes faster.
static bool init;
- if (init)
+ if (init)
return;
struct ev_item {
* \endvar
*/
{ LFUN_ACCENT_OGONEK, "accent-ogonek", Noop, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_ACCENT_PERISPOMENI
+ * \li Action: Adds a perispomeni (Greek circumflex)
+ over the next character typed.
+ * \li Syntax: accent-perispomeni
+ * \endvar
+ */
+ { LFUN_ACCENT_PERISPOMENI, "accent-perispomeni", Noop, Edit },
/*!
* \var lyx::FuncCode lyx::LFUN_ACCENT_TIE
* \li Action: Adds a tie \htmlonly (a͡)\endhtmlonly
/*!
* \var lyx::FuncCode lyx::LFUN_ARGUMENT_INSERT
* \li Action: Inserts an argument (short title) inset.
- * \li Syntax: argument-insert
+ * \li Syntax: argument-insert <argument nr>
+ * \li Params: <argument nr>: see layout declarations
* \li Origin: vermeer, 12 Aug 2002
* \endvar
*/
package: name of latex package (e.g. listings) \n
textclass: name of textclass (e.g. article) \n
menu: name of lfun used in menu \n
- icon: icon of lfun used in toolbar \n
+ icon: icon of lfun used in toolbar or direct icon name\n
buffer: "name"|"path"|"class"|"vcs-tree-revision"|
"vcs-revision"|"vcs-author"|"vcs-date"|"vcs-time"
* \li Sample: command-sequence info-insert buffer path; info-insert buffer name
For dissolving the element see #LFUN_INSET_DISSOLVE.
* \li Syntax: flex-insert Name
* \li Params: Name: This name must be defined either in your layout file
- or imported by some module. The definition is
+ or imported by some module. The definition is
InsetLayout Name or InsetLayout <Flex:Name>. The Flex:
prefix is optional.
* \li Sample: flex-insert Code
*/
{ LFUN_SPACE_INSERT, "space-insert", Noop, Edit },
/*!
- * \var lyx::FuncCode lyx::LFUN_HYPERLINK_INSERT
+ * \var lyx::FuncCode lyx::LFUN_HREF_INSERT
* \li Action: Inserts hyperlinks into the document (clickable in pdf output).
* \li Notion: Hyperlink target can be set via selection + hyperlink-insert function.
* \li Syntax: href-insert [<TARGET>]
* \li Origin: CFO-G, 21 Nov 1997
* \endvar
*/
- { LFUN_HYPERLINK_INSERT, "href-insert", Noop, Edit },
+ { LFUN_HREF_INSERT, "href-insert", Noop, Edit },
/*!
* \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.
+ end-of-sentence, menu-separator, lyx, tex, latex, latex2e.
* \li Origin: JSpitzm, 6 Dec 2007
* \endvar
*/
* \li Origin: spitz, 05 Mar 2012
* \endvar
*/
- { LFUN_IPA_INSERT, "ipa-insert", Noop, Edit },
+ { LFUN_IPA_INSERT, "ipa-insert", Noop, Edit },
/*!
* \var lyx::FuncCode lyx::LFUN_IN_IPA
* \li Action: Only active in IPA inset.
* \endvar
*/
{ LFUN_NEWLINE_INSERT, "newline-insert", Noop, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_SEPARATOR_INSERT
+ * \li Action: Inserts an environment separator or latex paragraph break.
+ * \li Syntax: separator-insert [<ARG>]
+ * \li Params: <ARG>: <plain|parbreak|latexpar> default: plain
+ * \li Origin: ef, 2 May 2014
+ * \endvar
+ */
+ { LFUN_SEPARATOR_INSERT, "separator-insert", Noop, Edit },
/*!
* \var lyx::FuncCode lyx::LFUN_ESCAPE
* \li Action: Clears the selection. If no text is selected call #LFUN_FINISHED_FORWARD.
{ LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit },
/*!
* \var lyx::FuncCode lyx::LFUN_CHAR_LEFT_SELECT
- * \li Action: Moves the cursor one position "to the left", adding
+ * \li Action: Moves the cursor one position "to the left", adding
traversed position to the selection.
* \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement.
* \li Syntax: char-left-select
{ LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
/*!
* \var lyx::FuncCode lyx::LFUN_WORD_FORWARD_SELECT
- * \li Action: Moves the cursor to the logically next beginning of a word,
+ * \li Action: Moves the cursor to the logically next beginning of a word,
adding the logically traversed text to the selection.
* \li Notion: See also #LFUN_WORD_FORWARD.
* \li Syntax: word-forward-select
* \var lyx::FuncCode lyx::LFUN_WORD_LEFT
* \li Action: Moves the cursor to the next beginning of a word "on the left".
* \li Notion: This is the action which should be taken when the (e.g., ctrl-)
- "left" key is pressed. Generally, it moves the cursor to the
- next beginning of a word on the left. However, in Bidi text this
+ "left" key is pressed. Generally, it moves the cursor to the
+ next beginning of a word on the left. However, in Bidi text this
become slightly more complicated, and there are different modes
of cursor movement. In "visual mode", this moves left, plain and
simple. In "logical mode", movement is logically forward in RTL
* \var lyx::FuncCode lyx::LFUN_WORD_RIGHT
* \li Action: Moves the cursor to the next beginning of a word "on the right".
* \li Notion: This is the action which should be taken when the (e.g., ctrl-)
- "right" key is pressed. Generally, it moves the cursor to the
- next beginning of a word on the right. However, in Bidi text
+ "right" key is pressed. Generally, it moves the cursor to the
+ next beginning of a word on the right. However, in Bidi text
this become slightly more complicated, and there are different
modes of cursor movement. In "visual mode", this moves right,
- plain and simple. In "logical mode", movement is logically
- forward in LTR paragraphs, and logically backwards in RTL
+ plain and simple. In "logical mode", movement is logically
+ forward in LTR paragraphs, and logically backwards in RTL
paragraphs.
* \li Syntax: word-right
* \li Origin: dov, 28 Oct 2007
/*!
* \var lyx::FuncCode lyx::LFUN_WORD_CAPITALIZE
* \li Action: Capitalizes the words in the selection (i.e. the first letters)
- or the letter on the cursor position.
- * \li Syntax: word-capitalize
+ or the first letter of word at cursor position.
+ * \li Syntax: word-capitalize [<SEL_TYPE>]
+ * \li Params: <SEL_TYPE>: if this is equal to "partial", then the
+ * default word starts at cursor position (emacs-style).
+ * Otherwise, the whole word is considered.
* \endvar
*/
{ LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
/*!
* \var lyx::FuncCode lyx::LFUN_WORD_UPCASE
- * \li Action: Change the words in the selection or from the cursor position
- to the end of word to the upper case.
- * \li Syntax: word-upcase
+ * \li Action: Change the words in the selection or word at cursor position
+ to upper case.
+ * \li Syntax: word-upcase [<SEL_TYPE>]
+ * \li Params: <SEL_TYPE>: if this is equal to "partial", then the
+ * default word starts at cursor position (emacs-style).
+ * Otherwise, the whole word is considered.
* \endvar
*/
{ LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
/*!
* \var lyx::FuncCode lyx::LFUN_WORD_LOWCASE
- * \li Action: Change the words in the selection or from the cursor position
- to the end of word to the lower case.
- * \li Syntax: word-lowcase
+ * \li Action: Change the words in the selection or word at cursor position
+ to lower case.
+ * \li Syntax: word-lowcase [<SEL_TYPE>]
+ * \li Params: <SEL_TYPE>: if this is equal to "partial", then the
+ * default word starts at cursor position (emacs-style).
+ * Otherwise, the whole word is considered.
* \endvar
*/
{ LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
* \var lyx::FuncCode lyx::LFUN_SPELLING_ADD
* \li Action: Add the word under the cursor to the respective
* 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
<LANG>: language name (see file languages)
* \var lyx::FuncCode lyx::LFUN_SPELLING_IGNORE
* \li Action: Let the spell checker ignore the word under the cursor
* 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
<LANG>: language name (see file languages)
* \var lyx::FuncCode lyx::LFUN_SPELLING_REMOVE
* \li Action: Remove the word under the cursor from the respective
* 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)
+ * <LANG>: language name (see file languages)
* \li Origin: SWitt, 28 July 2010
* \endvar
*/
{ LFUN_SPELLING_REMOVE, "spelling-remove", ReadOnly, Edit },
+
+/*!
+ * \var lyx::FuncCode lyx::LFUN_SPELLING_CONTINUOUSLY
+ * \li Action: Toggle continuous spell checking.
+ * \li Syntax: spelling-continuously
+ * \li Origin: vfr, 24 March 2013
+ * \endvar
+ */
+ { LFUN_SPELLING_CONTINUOUSLY, "spelling-continuously", ReadOnly, Edit },
+
/*!
* \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
* \li Action: Look up thesaurus entries with respect to the word under the cursor.
/*!
* \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
+ * \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
* \li Syntax: inset-begin
* \li Origin: lasgouttes, 16 Mar 2009
{ LFUN_INSET_BEGIN, "inset-begin", ReadOnly, Edit },
/*!
* \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
+ * \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
traversed text to the selection).
* \li Syntax: inset-begin-select
{ LFUN_INSET_BEGIN_SELECT, "inset-begin-select", ReadOnly, 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
+ * \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 Syntax: inset-end
* \li Origin: lasgouttes, 16 Mar 2009
{ LFUN_INSET_END, "inset-end", ReadOnly, Edit },
/*!
* \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
+ * \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
traversed text to the selection).
* \li Syntax: inset-end-select
/*!
* \var lyx::FuncCode lyx::LFUN_INSET_SELECT_ALL
- * \li Action: Selects all contents of an inset.
+ * \li Action: Select all contents of an inset.
+ * \li Notion: There are 3 successive levels: select current cell,
+ * select all cells of inset, select the inset from outside
+ * (in the enclosing inset).
* \li Syntax: inset-select-all
- * \li Origin: vfr, 22 Aug 2009
+ * \li Origin: vfr, 22 Aug 2009; lasgouttes 1 Nov 2014
* \endvar
*/
{ LFUN_INSET_SELECT_ALL, "inset-select-all", ReadOnly, Edit },
/*!
* \var lyx::FuncCode lyx::LFUN_SECTION_SELECT
- * \li Action: Selects the whole section.
+ * \li Action: Select the whole section.
* \li Notion: The cursor should be in a section heading
before calling this lfun.
* \li Syntax: section-select
*/
{ LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
/*!
- * \var lyx::FuncCode lyx::LFUN_LINE_DELETE
+ * \var lyx::FuncCode lyx::LFUN_LINE_DELETE_FORWARD
* \li Action: Deletes the letters to the end of the (screen) line or
deletes the selection.
* \li Syntax: line-delete-forward
* \endvar
*/
- { LFUN_LINE_DELETE, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
+ { LFUN_LINE_DELETE_FORWARD, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
/*!
* \var lyx::FuncCode lyx::LFUN_COPY
* \li Action: Copies the current selection to the clipboard.
* \var lyx::FuncCode lyx::LFUN_PASTE
* \li Action: Pastes material (text or picture) from the active clipboard.
* \li Syntax: paste [<TYPE>|<NUM>]
- * \li Params: <TYPE>: emf|pdf|png|jpeg|linkback|wmf \n
+ * \li Params: <TYPE>: emf|pdf|png|jpeg|linkback|wmf|latex|html \n
<NUM>: number of the selection in the internal clipboard stack to be pasted.
* \endvar
*/
{ LFUN_PASTE, "paste", Noop, Edit },
/*!
* \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE
- * \li Action: Pastes text from the active clipboard.
+ * \li Action: Pastes text from the active clipboard (retains formatting if the
+ clipboard contains formatted text). Pastes plain text if plain text is
+ on the clipboard, but tries to interpret it in special ways for certain
+ insets, e.g. converting csv data to rows and columns if the paste happens
+ in a tabular inset.
+ * \li Notion: Historically, LFUN_CLIPBOARD_PASTE was introduced as a counterpart of
+ LFUN_PRIMARY_SELECTION_PASTE: It behaved exactly the same, but the source
+ is the clipboard, not the selection.
* \li Syntax: clipboard-paste [<ARG>]
* \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
* \li Origin: Georg, 10 Jul 2006
{ LFUN_SELECTION_PASTE, "selection-paste", Noop, Edit },
/*!
* \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE_SIMPLE
- * \li Action: Pastes simple unformatted text from the active clipboard.
+ * \li Action: Pastes plain text from the active clipboard even if formatted
+ LyX content is in the clipboard. Pastes plain text if plain text
+ is on the clipboard, without trying to interpret it in special
+ ways for certain insets, e.g. converting csv data to rows and
+ columns if the paste happens in a tabular inset.
* \li Syntax: clipboard-paste-simple [<ARG>]
* \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
* \endvar
*/
{ LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
/*!
- * \var lyx::FuncCode lyx::LFUN_FONT_UULINE
+ * \var lyx::FuncCode lyx::LFUN_FONT_UNDERUNDERLINE
* \li Action: Toggles double underline in the font (selection-wise).
* \li Syntax: font-underunderline
* \li Origin: sanda, 5 May 2009
* \endvar
*/
- { LFUN_FONT_UULINE, "font-underunderline", Noop, Layout },
+ { LFUN_FONT_UNDERUNDERLINE, "font-underunderline", Noop, Layout },
/*!
- * \var lyx::FuncCode lyx::LFUN_FONT_UWAVE
+ * \var lyx::FuncCode lyx::LFUN_FONT_UNDERWAVE
* \li Action: Toggles wavy underline in the font (selection-wise).
* \li Syntax: font-underwave
* \li Origin: sanda, 5 May 2009
* \endvar
*/
- { LFUN_FONT_UWAVE, "font-underwave", Noop, Layout },
+ { LFUN_FONT_UNDERWAVE, "font-underwave", Noop, Layout },
/*!
* \var lyx::FuncCode lyx::LFUN_FONT_STRIKEOUT
* \li Action: Toggles strikeout (strike-through) in the font (selection-wise).
* \endvar
*/
{ LFUN_LAYOUT_RELOAD, "layout-reload", NoInternal, Layout },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW_CACHE
+ * \li Action: Opens the file that was created from last preview of this buffer.
+ * \li Notion: This LFUN is called by the "Show Output Anyway" button in the LaTeX
+ * Errors dialog. It can also be called by the user, which is useful
+ * if the document takes a long time to compile, and you just
+ * want to see the last previewed version.
+ * \li Syntax: buffer-view-cache
+ * \endvar
+ */
+ { LFUN_BUFFER_VIEW_CACHE, "buffer-view-cache", ReadOnly, Buffer },
/*!
* \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
* \li Action: Sets the text class for the current buffer.
* \li Action: Inserts a matrix.
* \li Syntax: math-matrix <COLS> <ROWS> [<ALIGN>]
* \li Params: <ALIGN>: Alignment is a word composed of the vertical alignment
- (b, c or t) (i.e. 1 char) and the horizontal alignments
+ (b, c or t) (i.e. 1 char) and the horizontal alignments
(l, c or r) (i.e. <COL> chars).
* \li Sample: math-matrix 3 3 bccc
* \endvar
{ LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
/*!
* \var lyx::FuncCode lyx::LFUN_MATH_AMS_MATRIX
- * \li Action: Inserts a matrix.
+ * \li Action: Inserts an extended matrix as provided by the amsmath package.
* \li Syntax: math-matrix <COLS> <ROWS> [<DECORATION>]
* \li Params: <DECORATION>: Decoration determines the LaTeX name of the matrix
- that should be created.
+ that should be created. Possible values include
+ pmatrix, bmatrix, Bmatrix, vmatrix, Vmatrix and
+ matrix. The default is 'matrix'.
* \li Sample: math-ams-matrix 3 3 bmatrix
* \endvar
*/
/*!
* \var lyx::FuncCode lyx::LFUN_TABULAR_INSERT
* \li Action: Inserts table into the document.
- * \li Notion: See #LFUN_INSET_MODIFY for some more details
+ * \li Notion: See #LFUN_TABULAR_FEATURE for some more details
about tabular modifications.
* \li Syntax: tabular-insert [<ROWS> <COLUMNS>]
* \li Params: In case no arguments are given show insert dialog.
* \endvar
*/
{ LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_VC_RENAME
+ * \li Action: Renames the document to another name.
+ * \li Notion: Renaming with revision history is only supported by SVN.
+ For CVS it is simulated by adding the document under a new
+ name and deleting the old one. For RCS it is not supported.
+ Disabled if uncommitted changes exist.
+ * \li Syntax: vc-rename <FILENAME>
+ * \li Params: <FILENAME>: New name of the document.\n
+ * A file dialog is opened if no filename is given.
+ * \li Origin: gb, 05 Feb 2013
+ * \endvar
+ */
+ { LFUN_VC_RENAME, "vc-rename", ReadOnly, System },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_VC_COPY
+ * \li Action: Copies the document to another name.
+ * \li Notion: Copying with revision history is only supported by SVN.
+ For RCS and CVS it is simulated by adding the document
+ under a new name.
+ Disabled if uncommitted changes exist.
+ * \li Syntax: vc-copy <FILENAME>
+ * \li Params: <FILENAME>: New name of the document.\n
+ * A file dialog is opened if no filename is given.
+ * \li Origin: gb, 05 Feb 2013
+ * \endvar
+ */
+ { LFUN_VC_COPY, "vc-copy", ReadOnly, System },
/*!
* \var lyx::FuncCode lyx::LFUN_VC_CHECK_IN
* \li Action: Checks-in/commits the changes of the registered file to the repository.
{ LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
/*!
* \var lyx::FuncCode lyx::LFUN_CHANGES_OUTPUT
- * \li Action: Toggles showing of change tracking in typesetted output.
+ * \li Action: Toggles showing of change tracking in typeset output.
* \li Syntax: changes-output
* \li Origin: jspitzm, 21 Jan 2005
* \endvar
* \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
* \li Action: Modify some properties of an inset.
* \li Notion: Used for bibitem, bibtex, box, branch, command, ert, external,
- floats, graphics, include, index, info, label,
- listings, newline, newpage, nomencl, note, phantom,
+ floats, graphics, include, index, info, label,
+ listings, newline, newpage, nomencl, note, phantom,
ref, space, tabular, vspace, wrap insets.
- * \li Syntax: inset-modify <INSET> <ARGS>
- * \li Syntax: inset-modify changetype <TYPE>
- * \li Syntax: inset-modify tabular <FEATURE> [<ARG>]
- * \li Params: Generally see #LFUN_INSET_INSERT for further details.\n
- In case that <INSET> is "tabular" various math-environment features
- are handled as well, e.g. add-vline-left/right for the Grid/Array environment.\n
- <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|copy-column|
- toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
- align-left|align-right|align-center|align-block|align-decimal|set-decimal-point|
- valign-top|valign-bottom|valign-middle|longtabular-align-left|
- longtabular-align-center|longtabular-align-right|m-align-left|m-align-right|
- m-align-center|m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|
- set-all-lines|unset-all-lines|set-longtabular|unset-longtabular|set-pwidth|
- set-mpwidth|set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|
- set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|
- unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|
- set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
- set-special-column|set-special-multicolumn|set-special-multirow|
- set-booktabs|unset-booktabs|set-top-space|set-bottom-space|
- set-interline-space|set-border-lines|tabular-valign-top|
- tabular-valign-middle|tabular-valign-bottom|set-tabular-width \n
- <ARG>: additional argument for some commands, use debug mode to explore its values.
+ * \li Syntax: inset-modify <INSET> <ARGS> \n
+ inset-modify changetype <TYPE>
* \li Sample: inset-modify note Note Comment \n
inset-modify changetype Ovalbox
* \endvar
*/
{ LFUN_INSET_MODIFY, "inset-modify", AtPoint, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_TABULAR_FEATURE
+ * \li Action: Modify properties of tabulars and table-like math environments.
+ * \li Syntax: tabular-feature <FEATURE> [<ARG>]
+ * \li Params: Generally see #LFUN_INSET_INSERT for further details.\n
+ * <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|\n
+ copy-column|move-column-right|move-column-left|move-row-down|move-row-up|\n
+ toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|\n
+ align-left|align-right|align-center|align-block|align-decimal|set-decimal-point|\n
+ 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
+ set-all-lines|unset-all-lines|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
+ 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.
+ * \li Origin: gm, 10 Dec 2015
+ * \endvar
+ */
+ { LFUN_TABULAR_FEATURE, "tabular-feature", Noop, Edit },
/*!
* \var lyx::FuncCode lyx::LFUN_INSET_DIALOG_UPDATE
* \li Action: Updates the values inside the dialog from the inset.
inset-forall Note note-insert
which starts an infinite loop. This is mitigated by the fact
that the number of actions is arbitrarily limited to 100000.
- Note also that inset-forall does not update metrics between
+ Note also that inset-forall does not update metrics between
iterations, which can lead to bugs. This has to be eventually
fixed.
* \li Syntax: inset-forall <NAME> <LFUN-COMMAND> \n
matches all note insets, while "Note:Note" only matches LyX
yellow note insets.
* \li Sample: Remove all index insets: \n
- inset-forall Index delete-char-forward \n
+ inset-forall Index char-delete-forward \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_LANGUAGE
* \li Action: Set language from the current cursor position.
- * \li Syntax: language <LANG>
+ * \li Syntax: language <LANG> [set]
* \li Params: <LANG>: Requested language. Look in lib/languages for
- the list.
+ the list. "language reset" or "language" (without param)
+ reset to the document language.
+ set: If used, the language will be set to the specified
+ language. Otherwise, the language will be toggled (i.e., if
+ the current language is LANG, switch to the document language
+ or the default language, if LANG is the document language).
* \li Origin: Dekel, 2 Mar 2000
* \endvar
*/
* \li Action: Creates new empty LyX window.
* \li Notion: Already opened documents from the previous window can be found under View menu.
* \li Syntax: window-new [<GEOMETRY>]
- * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently
+ * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently
accepted only on Windows platform.
* \li Origin: Abdel, 21 Oct 2006
* \endvar
{ LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
/*!
* \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_AS
- * \li Action: Pops up a dialog for exporting the current buffer.
- * \li Syntax: buffer-export-as
+ * \li Action: Opens a dialog for exporting the current buffer.
+ * \li Syntax: buffer-export-as [<FORMAT>]
+ * \li Params: <FORMAT> is the export format initially selected in the dialog.
+ * You can pass any of the formats which you can find in
+ * Tools->Preferences->File formats->Format, provided it
+ * has the "document" flag set. If no format is specified
+ * the dialog will start with the default output format of
+ * the current document.
+ * \li Sample: buffer-export-as pdf2
* \li Origin: tommaso, 6 Oct 2011
* \endvar
*/
{ LFUN_BUFFER_EXPORT_AS, "buffer-export-as", ReadOnly, Buffer },
-/*!
- * \var lyx::FuncCode lyx::LFUN_BUFFER_PRINT
- * \li Action: Prints the current document.
- * \li Notion: Many settings can be given via the preferences dialog.
- * \li Syntax: buffer-print <TARGET> <TARGET-NAME> <COMMAND>
- * \li Params: <TARGET> is either "printer" or "file".\n
- <TARGER-NAME> is either "default" or file name or printer name.\n
- <COMMAND> command ensuring the printing job.
- * \li Sample: buffer-print file "/trash/newfile1.ps" "dvips"
- * \li Origin: leeming, 28 Mar 2004
- * \endvar
- */
- { LFUN_BUFFER_PRINT, "buffer-print", ReadOnly, Buffer },
/*!
* \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
* \li Action: Import a given file as a lyx document.
{ LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
/*!
* \var lyx::FuncCode lyx::LFUN_BUFFER_FORALL
- * \li Action: Applies a command to all visible, hidden, or both types of buffers in the active window.
- * \li Syntax: buffer-forall [<BUFFER-TYPE>] <LFUN-COMMAND>
- * \li Params: <BUFFER-TYPE>: <visible|hidden|both default:> default: visible
- <LFUN-COMMAND>: The command that is to be applied to the buffers.
- * \li Sample: Close all Notes in all visible documents: \n
+ * \li Action: Applies a command to all non-hidden buffers.
+ * \li Notion: a buffer is `hidden' if it is internally open in LyX, but not
+ 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
buffer-forall inset-forall Note inset-toggle close \n
- Toggle change tracking on all documents: \n
- buffer-forall both changes-track \n
- Toggle read-only for all visible documents: \n
+ Toggle change tracking on buffers: \n
+ buffer-forall changes-track \n
+ Toggle read-only for buffers: \n
buffer-forall buffer-toggle-read-only \n
- Show statistics for each document: \n
- buffer-forall both statistics \n
- Activate the branch named "Solutions" in all visible documents: \n
+ Show statistics for individual buffers: \n
+ buffer-forall statistics \n
+ Activate the branch named "Solutions" in buffers: \n
buffer-forall branch-activate Solutions \n
- Export all visible documents to PDF (pdflatex): \n
+ Export buffers to PDF (pdflatex): \n
buffer-forall buffer-export pdf2 \n
- * \li Origin: scottkostyshak, 20 Jul 2012
+ * \li Origin: skostysh, 20 Jul 2012
* \endvar
*/
{ LFUN_BUFFER_FORALL, "buffer-forall", ReadOnly | Argument, Buffer },
* \endvar
*/
{ LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_BUFFER_MOVE_NEXT
+ * \li Action: Moves the current tab one spot to the right.
+ * \li Syntax: buffer-move-next
+ * \li Origin: skostysh, 7 Apr 2015
+ * \endvar
+ */
+ { LFUN_BUFFER_MOVE_NEXT, "buffer-move-next", ReadOnly, Buffer },
/*!
* \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS
* \li Action: Switch to the previous opened document.
* \endvar
*/
{ LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_BUFFER_MOVE_PREVIOUS
+ * \li Action: Moves the current tab one spot to the left.
+ * \li Syntax: buffer-move-previous
+ * \li Origin: skostysh, 7 Apr 2015
+ * \endvar
+ */
+ { LFUN_BUFFER_MOVE_PREVIOUS, "buffer-move-previous", ReadOnly, Buffer },
/*!
* \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
- * \li Action: When run from a child document, this updates (exports) document built
- from the master buffer, if available.
+ * \li Action: Update (export) the document built from the master buffer,
+ if the current buffer is part of a master/child document.
* \li Syntax: master-buffer-update [<FORMAT>]
* \li Params: <FORMAT>: The format to display, where this is one of the
formats defined (in the current GUI) in the
{ LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
/*!
* \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
- * \li Action: When run from a child document, this command shows a preview built
- from the master buffer, if available.
+ * \li Action: Show a preview built from the master buffer, if available.
+ if the current buffer is part of a master/child document.
* \li Syntax: master-buffer-view [<FORMAT>]
* \li Params: <FORMAT>: The format to display, where this is one of the
formats defined (in the current GUI) in the
to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
\def_file "FileName" allows to include another .def file. \n
This is particularly useful in connection with toolbar buttons:
- Since the name of the button image for this lfun is
+ Since the name of the button image for this lfun is
lib/images/commands/<NAME>.png this is the way to assign an image
to a complex command-sequence.
* \li Syntax: call <NAME>
/*!
* \var lyx::FuncCode lyx::LFUN_META_PREFIX
* \li Action: Simulate halting Meta key (Alt key on PCs).
- * \li Notion: Used for buffer editation not for GUI control.
+ * \li Notion: Used for buffer edition not for GUI control.
* \li Syntax: meta-prefix
* \endvar
*/
/*!
* \var lyx::FuncCode lyx::LFUN_STATISTICS
* \li Action: Count the statistics (number of words and characters)
- in the document or in the given selection.
+ in the document or in the given selection and display it
+ in a dialog box.
* \li Notion: Note that this function gives the number of words/chars written,
not the number of characters which will be typeset.
* \li Syntax: statistics
* \endvar
*/
{ LFUN_STATISTICS, "statistics", ReadOnly, System },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_SERVER_GET_STATISTICS
+ * \li Action: Returns the statistics (number of words and characters)
+ in the document or in the given selection.
+ * \li Notion: Note that this function gives the number of words/chars written,
+ not the number of characters which will be typeset.
+ * \li Syntax: server-get-statistics [<TYPE>]
+ * \li Params: <TYPE>: <words|chars|chars-space> The requested count; if not
+ specified, the three values are returned, separated
+ by a space.\n
+ words: count words.\n
+ chars: count characters.\n
+ chars-space: count characters and spaces.
+ * \li Origin: brokenclock, Oct 10 2014
+ * \endvar
+ */
+ { LFUN_SERVER_GET_STATISTICS, "server-get-statistics", ReadOnly, System },
/*!
* \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
* \li Action: Show the inline completion at the cursor position.
*/
{ LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
/*!
- * \var lyx::FuncCode lyx::LFUN_COMPLETION_COMPLETE
+ * \var lyx::FuncCode lyx::LFUN_COMPLETE
* \li Action: Try to complete the word or command at the cursor position.
* \li Syntax: complete
* \li Origin: sts, Feb 19 2008
* \endvar
*/
- { LFUN_COMPLETION_COMPLETE, "complete", SingleParUpdate, Edit },
+ { LFUN_COMPLETE, "complete", SingleParUpdate, Edit },
/*!
* \var lyx::FuncCode lyx::LFUN_COMPLETION_CANCEL
* \li Origin: sts, 16 Nov 2008
* \endvar
*/
- { LFUN_LABEL_COPY_AS_REF, "copy-label-as-reference",
+ { LFUN_LABEL_COPY_AS_REFERENCE, "label-copy-as-reference",
ReadOnly | NoUpdate | AtPoint, Edit },
/*!
- * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT_AS_REF
- * \li Action: Inserts the label as a cross-reference at the position of the cursor.
+ * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT_AS_REFERENCE
+ * \li Action: Inserts the label (in ToC pane) as a cross-reference at the position of the cursor.
* \li Syntax: label-insert-as-reference
* \li Origin: vfr, 7 Apr 2009
* \endvar
*/
- { LFUN_LABEL_INSERT_AS_REF, "label-insert-as-reference", Noop, Edit},
+ { LFUN_LABEL_INSERT_AS_REFERENCE, "label-insert-as-reference", Noop, Edit},
/*!
* \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_IN
*/
{ LFUN_INSET_COPY_AS, "inset-copy-as", ReadOnly | NoUpdate | AtPoint, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_ENVIRONMENT_SPLIT
+ * \li Action: Splits the current environment with a Separator.
+ * \li Syntax: environment-split [outer]
+ * \li Params: outer: If this is given, LyX will split the outermost environment in
+ * the current nesting hierarchy.
+ * \li Origin: spitz, 23 Dec 2012
+ * \endvar
+ */
+ { LFUN_ENVIRONMENT_SPLIT, "environment-split", Noop, Layout },
+
{ LFUN_NOACTION, "", Noop, Hidden }
#ifndef DOXYGEN_SHOULD_SKIP_THIS
};
FuncMap::const_iterator const fit = lyx_func_map.find(cmd);
- return fit != lyx_func_map.end()
- ? FuncRequest(fit->second, arg)
+ return fit != lyx_func_map.end()
+ ? FuncRequest(fit->second, arg)
: FuncRequest(LFUN_UNKNOWN_ACTION);
}
if (ici == lyx_info_map.end()) {
LYXERR0("action: " << action << " is not known.");
- LASSERT(false, /**/);
+ LASSERT(false, return false);
}
return ici->second.attrib & flag;
projects / lyx.git / blobdiff