/*!
* \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 {
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
* \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
*/
* \endvar
*/
{ LFUN_NEWLINE_INSERT, "newline-insert", Noop, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_SEPARATOR_INSERT
+ * \li Action: Inserts an environment separator or paragraph break.
+ * \li Syntax: separator-insert [<ARG>]
+ * \li Params: <ARG>: <plain|parbreak> 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_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
*/
/*!
* \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
* \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 colums if tha paste happens
+ 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
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
- colums if the paste happens in a tabular inset.
+ 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
* \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
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 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
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 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
{ 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>
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
* \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
buffer-forall branch-activate Solutions \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: Update (export) the document built from the master buffer,
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.
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);
}
projects / lyx.git / blobdiff