*/
/**
- *
+ * \var lyx::kb_action lyx::LFUN_
* \li Action:
* \li Notion:
* \li Syntax:
ev_item const items[] = {
#endif
+/**
+ * \var lyx::kb_action lyx::LFUN_ACCENT_ACUTE
+ * \li Action: adds an acute accent \htmlonly (á)\endhtmlonly
+ to the next character typed
+ * \li Syntax: accent-acute
+ */
{ LFUN_ACCENT_ACUTE, "accent-acute", Noop, Edit },
+/**
+ * \var lyx::kb_action lyx::LFUN_ACCENT_BREVE
+ * \li Action: adds a breve accent \htmlonly (ă)\endhtmlonly
+ to the next character typed
+ * \li Syntax: accent-breve
+ */
{ LFUN_ACCENT_BREVE, "accent-breve", Noop, Edit },
+/**
+ * \var lyx::kb_action lyx::LFUN_ACCENT_CARON
+ * \li Action: adds a caron \htmlonly (ǎ)\endhtmlonly
+ to the next character typed
+ * \li Syntax: accent-caron
+ */
{ LFUN_ACCENT_CARON, "accent-caron", Noop, Edit },
+/**
+ * \var lyx::kb_action lyx::LFUN_ACCENT_CEDILLA
+ * \li Action: adds a cedilla \htmlonly (ç)\endhtmlonly
+ to the next character typed
+ * \li Syntax: accent-cedilla
+ */
{ LFUN_ACCENT_CEDILLA, "accent-cedilla", Noop, Edit },
+/**
+ * \var lyx::kb_action lyx::LFUN_ACCENT_CIRCLE
+ * \li Action: adds a circle accent \htmlonly (å)\endhtmlonly
+ to the next character typed
+ * \li Syntax: accent-circle
+ */
{ LFUN_ACCENT_CIRCLE, "accent-circle", Noop, Edit },
+/**
+ * \var lyx::kb_action lyx::LFUN_ACCENT_CIRCUMFLEX
+ * \li Action: adds a circumflex \htmlonly (ê)\endhtmlonly
+ to the next character typed
+ * \li Syntax: accent-circumflex
+ */
{ LFUN_ACCENT_CIRCUMFLEX, "accent-circumflex", Noop, Edit },
+/**
+ * \var lyx::kb_action lyx::LFUN_ACCENT_DOT
+ * \li Action: adds a dot accent \htmlonly (ż)\endhtmlonly
+ to the next character typed
+ * \li Syntax: accent-dot
+ */
{ LFUN_ACCENT_DOT, "accent-dot", Noop, Edit },
+/**
+ * \var lyx::kb_action lyx::LFUN_ACCENT_GRAVE
+ * \li Action: adds a grave accent \htmlonly (è)\endhtmlonly
+ to the next character typed
+ * \li Syntax: accent-grave
+ */
{ LFUN_ACCENT_GRAVE, "accent-grave", Noop, Edit },
+/**
+ * \var lyx::kb_action lyx::LFUN_ACCENT_HUNGARIAN_UMLAUT
+ * \li Action: adds a Hungarian umlaut \htmlonly (ő)\endhtmlonly
+ to the next character typed
+ * \li Syntax: accent-grave
+ */
{ LFUN_ACCENT_HUNGARIAN_UMLAUT, "accent-hungarian-umlaut", Noop, Edit },
+/**
+ * \var lyx::kb_action lyx::LFUN_ACCENT_MACRON
+ * \li Action: adds a macron \htmlonly (ā)\endhtmlonly
+ to the next character typed
+ * \li Syntax: accent-macron
+ */
{ LFUN_ACCENT_MACRON, "accent-macron", Noop, Edit },
+/**
+ * \var lyx::kb_action lyx::LFUN_ACCENT_OGONEK
+ * \li Action: adds an ogonek accent \htmlonly (ą)\endhtmlonly
+ to the next character typed
+ * \li Syntax: accent-ogonek
+ */
{ LFUN_ACCENT_OGONEK, "accent-ogonek", Noop, Edit },
{ LFUN_ACCENT_SPECIAL_CARON, "accent-special-caron", Noop, Edit },
+/**
+ * \var lyx::kb_action lyx::LFUN_ACCENT_TIE
+ * \li Action: adds a tie \htmlonly (a͡)\endhtmlonly
+ over the next two character typed
+ * \li Notion: the following char will finish the tie.
+ * \li Syntax: accent-tie
+ */
{ LFUN_ACCENT_TIE, "accent-tie", Noop, Edit },
+/**
+ * \var lyx::kb_action lyx::LFUN_ACCENT_TILDE
+ * \li Action: adds a tilde \htmlonly (ã)\endhtmlonly
+ over the next character typed
+ * \li Syntax: accent-tilde
+ */
{ LFUN_ACCENT_TILDE, "accent-tilde", Noop, Edit },
+/**
+ * \var lyx::kb_action lyx::LFUN_ACCENT_UMLAUT
+ * \li Action: adds an umlaut \htmlonly (ä)\endhtmlonly
+ over the next character typed
+ * \li Syntax: accent-umlaut
+ */
{ LFUN_ACCENT_UMLAUT, "accent-umlaut", Noop, Edit },
+/**
+ * \var lyx::kb_action lyx::LFUN_ACCENT_UNDERBAR
+ * \li Action: adds a bar \htmlonly (a̠)\endhtmlonly
+ under the next character typed
+ * \li Syntax: accent-underbar
+ */
{ LFUN_ACCENT_UNDERBAR, "accent-underbar", Noop, Edit },
+/**
+ * \var lyx::kb_action lyx::LFUN_ACCENT_UNDERDOT
+ * \li Action: adds a dot \htmlonly (ạ)\endhtmlonly
+ under the next character typed
+ * \li Syntax: accent-underdot
+ */
{ LFUN_ACCENT_UNDERDOT, "accent-underdot", Noop, Edit },
+/**
+ * \var lyx::kb_action lyx::LFUN_BREAK_PARAGRAPH
+ * \li Action: Breaks the current paragraph at the current location
+ * \li Syntax: break-paragraph
+ */
{ LFUN_BREAK_PARAGRAPH, "break-paragraph", Noop, Edit },
+/**
+ * \var lyx::kb_action lyx::LFUN_BREAK_PARAGRAPH_SKIP
+ * \li Action: Breaks the current paragraph at the current location,
+ unless used at the beginning of a line, where it sets
+ the label width string to empty.
+ * \li Syntax: break-paragraph-skip
+ */
{ LFUN_BREAK_PARAGRAPH_SKIP, "break-paragraph-skip", Noop, Edit },
-
+/**
+ * \var lyx::kb_action lyx::LFUN_CAPTION_INSERT
+ * \li Action: Inserts a caption inset.
+ * \li Syntax: caption-insert
+ * \li Origin: Lgb, 18 Jul 2000
+ */
{ LFUN_CAPTION_INSERT, "caption-insert", Noop, Edit },
+/**
+ * \var lyx::kb_action lyx::LFUN_DATE_INSERT
+ * \li Action: Inserts the current date
+ * \li Syntax: date-insert [<ARG>]
+ * \li Param: <ARG>: Format of date. The default value (%x) can be set
+ in Preferences->Date format. For possible formats
+ see manual page of strftime function.
+ * \li Origin: jdblair, 31 Jan 2000
+ */
{ LFUN_DATE_INSERT, "date-insert", Noop, Edit },
+/**
+ * \var lyx::kb_action lyx::LFUN_FOOTNOTE_INSERT
+ * \li Action: Inserts a footnote inset.
+ * \li Syntax: footnote-insert
+ * \li Origin: Jug, 7 Mar 2000
+ */
{ LFUN_FOOTNOTE_INSERT, "footnote-insert", Noop, Edit },
+/**
+ * \var lyx::kb_action lyx::LFUN_ERT_INSERT
+ * \li Action: Inserts an ERT inset.
+ * \li Syntax: ert-insert
+ * \li Origin: Jug, 18 Feb 2000
+ */
{ LFUN_ERT_INSERT, "ert-insert", Noop, Edit },
{ LFUN_FLOAT_INSERT, "float-insert", Noop, Edit },
{ LFUN_FLOAT_WIDE_INSERT, "float-wide-insert", Noop, Edit },
{ LFUN_WRAP_INSERT, "wrap-insert", Noop, Edit },
+/**
+ * \var lyx::kb_action lyx::LFUN_HFILL_INSERT
+ * \li Action: Inserts an hfill inset.
+ * \li Syntax: hfill-insert
+ */
{ LFUN_HFILL_INSERT, "hfill-insert", Noop, Edit },
+/**
+ * \var lyx::kb_action lyx::LFUN_OPTIONAL_INSERT
+ * \li Action: Inserts an optional-argument (short title) inset.
+ * \li Syntax: optional-insert
+ * \li Origin: Martin, 12 Aug 2002
+ */
{ LFUN_OPTIONAL_INSERT, "optional-insert", Noop, Edit },
+/**
+ * \var lyx::kb_action lyx::LFUN_LINE_INSERT
+ * \li Action: Inserts a horizontal line.
+ * \li Syntax: line-insert
+ * \li Origin: poenitz, Oct 27 2003
+ */
{ LFUN_LINE_INSERT, "line-insert", Noop, Edit },
+/**
+ * \var lyx::kb_action lyx::LFUN_NEWPAGE_INSERT
+ * \li Action: Inserts a new page.
+ * \li Syntax: newpage-insert
+ * \li Origin: uwestoehr, 24 Nov 2007
+ */
{ LFUN_NEWPAGE_INSERT, "newpage-insert", Noop, Edit },
+/**
+ * \var lyx::kb_action lyx::LFUN_PAGEBREAK_INSERT
+ * \li Action: Inserts a pagebreak.
+ * \li Syntax: pagebreak-insert
+ * \li Origin: poenitz, Oct 27 2003
+ */
{ LFUN_PAGEBREAK_INSERT, "pagebreak-insert", Noop, Edit },
+/**
+ * \var lyx::kb_action lyx::LFUN_MARGINALNOTE_INSERT
+ * \li Action: Inserts a marginal note.
+ * \li Syntax: marginalnote-insert
+ * \li Origin: Lgb, 26 Jun 2000
+ */
{ LFUN_MARGINALNOTE_INSERT, "marginalnote-insert", Noop, Edit },
+/**
+ * \var lyx::kb_action 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
+ point, in hexadecimal, e.g.: unicode-insert 0x0100.
+ * \li Origin: Lgb, 22 Oct 2006
+ */
{ LFUN_UNICODE_INSERT, "unicode-insert", Noop, Edit },
+/**
+ * \var lyx::kb_action lyx::LFUN_LISTING_INSERT
+ * \li Action: Inserts a new listings inset.
+ * \li Syntax: listing-insert
+ * \li Origin: Herbert, 10 Nov 2001; bpeng, 2 May 2007
+ */
{ LFUN_LISTING_INSERT, "listing-insert", Noop, Edit },
{ LFUN_QUOTE_INSERT, "quote-insert", Noop, Edit },
{ LFUN_INFO_INSERT, "info-insert", Noop, Edit },
{ LFUN_UP_SELECT, "up-select", ReadOnly | SingleParUpdate, Edit },
{ LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit },
{ LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit },
-/** LFUN_SCROLL
+/**
+ * \var lyx::kb_action lyx::LFUN_SCROLL
* \li Action: scroll the buffer view
* \li Notion: Only scrolls the screen up or down; does not move the cursor.
* \li Syntax: scroll <TYPE> <QUANTITY>
*/
{ LFUN_SCROLL, "scroll", ReadOnly, Edit },
/**
- * LFUN_SCREEN_RECENTER
+ * \var lyx::kb_action lyx::LFUN_SCREEN_RECENTER
* \li Action: Recenters the screen on the current cursor position
* \li Syntax: screen-recenter
*/
{ LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
{ LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
{ LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
+/**
+ * \var lyx::kb_action lyx::LFUN_THESAURUS_ENTRY
+ * \li Action: Look up thesaurus entries with respect to the word under the cursor.
+ * \li Syntax: thesaurus-entry
+ * \li Origin: Levon, 20 Jul 2001
+ */
+ { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
{ LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
{ LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
{ LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
{ LFUN_NEW_LINE, "new-line", Noop, Edit },
/**
- * LFUN_PARAGRAPH_MOVE_DOWN
+ * \var lyx::kb_action lyx::LFUN_PARAGRAPH_MOVE_DOWN
* \li Action: Moves the current paragraph downwards in the document.
* \li Syntax: paragraph-move-down
* \li Origin: Edwin, 8 Apr 2006
*/
{ LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
/**
- * LFUN_PARAGRAPH_MOVE_UP
+ * \var lyx::kb_action lyx::LFUN_PARAGRAPH_MOVE_UP
* \li Action: Moves the current paragraph upwards in the document.
* \li Syntax: paragraph-move-up
* \li Origin: Edwin, 8 Apr 2006
*/
{ LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
/**
- * LFUN_COPY
+ * \var lyx::kb_action lyx::LFUN_COPY
* \li Action: Copies to the clipboard the last edit
* \li Syntax: copy
*/
{ LFUN_COPY, "copy", ReadOnly, Edit },
/**
- * LFUN_CUT
+ * \var lyx::kb_action lyx::LFUN_CUT
* \li Action: Cuts to the clipboard
* \li Syntax: cut
*/
{ LFUN_CUT, "cut", Noop, Edit },
/**
- * LFUN_PASTE
+ * \var lyx::kb_action lyx::LFUN_PASTE
* \li Action: Pastes from the active clipboard
* \li Syntax: paste
*/
{ LFUN_PASTE, "paste", Noop, Edit },
{ LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
/**
- * LFUN_PRIMARY_SELECTION_PASTE
+ * \var lyx::kb_action lyx::LFUN_PRIMARY_SELECTION_PASTE
* \li Action: Pastes the material currently selected
* \li Syntax: primary-selection-paste
*/
{ LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
/**
- * LFUN_UNDO
+ * \var lyx::kb_action lyx::LFUN_UNDO
* \li Action: Undoes the last edit
* \li Syntax: undo
*/
{ LFUN_UNDO, "undo", Noop, Edit },
/**
- * LFUN_REDO
+ * \var lyx::kb_action lyx::LFUN_REDO
* \li Action: Redoes the last thing undone
* \li Syntax: redo
*/
{ LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
/**
- * LFUN_LAYOUT
+ * \var lyx::kb_action 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
*/
{ LFUN_LAYOUT, "layout", Noop, Layout },
/**
- * LFUN_LAYOUT_PARAGRAPH
+ * \var lyx::kb_action lyx::LFUN_LAYOUT_PARAGRAPH
* \li Action: Launches the paragraph settings dialog
* \li Syntax: layout-paragraph
*/
{ LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
{ LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
/**
- * LFUN_DROP_LAYOUTS_CHOICE
+ * \var lyx::kb_action lyx::LFUN_DROP_LAYOUTS_CHOICE
* \li Action: Displays list of layout choices
* \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
dropbox allowing for choice of layout
*/
{ LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
/**
- * LFUN_LAYOUT_MODULES_CLEAR
+ * \var lyx::kb_action lyx::LFUN_LAYOUT_MODULES_CLEAR
* \li Action: Clears the module list
* \li Notion: Clears the list of included modules for the current buffer.
* \li Syntax: layout-modules-clear
*/
{ LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", Noop, Layout },
/**
- * LFUN_LAYOUT_MODULE_ADD
+ * \var lyx::kb_action lyx::LFUN_LAYOUT_MODULE_ADD
* \li Action: Adds a module
* \li Notion: Adds a module to the list of included modules for the current buffer.
* \li Syntax: layout-module-add <MODULE>
*/
{ LFUN_LAYOUT_MODULE_ADD, "layout-module-add", Noop, Layout },
/**
- * LFUN_LAYOUT_RELOAD
+ * \var lyx::kb_action lyx::LFUN_LAYOUT_RELOAD
* \li Action: Reloads layout information
* \li Notion: Reloads all layout information for the current buffer from disk, thus
recognizing any changes that have been made to layout files on the fly.
*/
{ LFUN_LAYOUT_RELOAD, "layout-reload", Noop, Layout },
/**
- * LFUN_TEXTCLASS_APPLY
+ * \var lyx::kb_action lyx::LFUN_TEXTCLASS_APPLY
* \li Action: Sets the text class for the current buffer
* \li Syntax: textclass-apply <TEXTCLASS>
* \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
*/
{ LFUN_TEXTCLASS_APPLY, "textclass-apply", Noop, Layout },
/**
- * LFUN_TEXTCLASS_LOAD
+ * \var lyx::kb_action lyx::LFUN_TEXTCLASS_LOAD
* \li Action: Loads information for a textclass from disk
* \li Syntax: textclass-load <TEXTCLASS>
* \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
{ LFUN_TEXTCLASS_LOAD, "textclass-load", Noop, Layout },
/**
- * LFUN_MARK_OFF
+ * \var lyx::kb_action lyx::LFUN_MARK_OFF
* \li Action: Disable selecting of text-region.
* \li Syntax: mark-off
*/
{ LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
/**
- * LFUN_MARK_ON
+ * \var lyx::kb_action lyx::LFUN_MARK_ON
* \li Action: Enable selecting of text-region.
* \li Notion: After enabling you can simply move arrow keys to get selected region.
* \li Syntax: mark-on
*/
{ LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
/**
- * LFUN_MARK_TOGGLE
- * \li Action: Toggle between MARK_ON and MARK_OFF
+ * \var lyx::kb_action lyx::LFUN_MARK_TOGGLE
+ * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
* \li Syntax: mark-toggle
* \li Origin: poenitz, May 5 2006
*/
{ LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
{ LFUN_MATH_MODE, "math-mode", Noop, Math },
/**
- * LFUN_MATH_NUMBER_LINE_TOGGLE
+ * \var lyx::kb_action lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
* \li Action: Toggles numbering of the current formula line.
* \li Notion: Must be in display formula mode.
* \li Syntax: math-number-line-toggle
*/
{ LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
/**
- * LFUN_MATH_NUMBER_TOGGLE
+ * \var lyx::kb_action lyx::LFUN_MATH_NUMBER_TOGGLE
* \li Action: Toggles numbering of the current formula.
* \li Notion: Must be in display formula mode.
* \li Syntax: math-number-toggle
{ LFUN_MATH_EXTERN, "math-extern", Noop, Math },
{ LFUN_MATH_SIZE, "math-size", Noop, Math },
/**
- * LFUN_MATH_MACRO_UNFOLD
+ * \var lyx::kb_action lyx::LFUN_MATH_MACRO_UNFOLD
* \li Action: Unfold a Math Macro
* \li Notion: Unfold the Math Macro the cursor is in, i.e.
display it as \foo.
*/
{ LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
/**
- * LFUN_MATH_MACRO_FOLD
+ * \var lyx::kb_action lyx::LFUN_MATH_MACRO_FOLD
* \li Action: Fold a Math Macro
* \li Notion: Fold the Math Macro the cursor is in if it was
unfolded, i.e. displayed as \foo before.
*/
{ LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
/**
- * LFUN_MATH_MACRO_ADD_PARAM
+ * \var lyx::kb_action lyx::LFUN_MATH_MACRO_ADD_PARAM
* \li Action: Add a parameter
* \li Notion: Add a parameter to a Math Macro
* \li Params: <NUM>: The number of the parameter behind which the new one
*/
{ LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
/**
- * LFUN_MATH_MACRO_REMOVE_PARAM
+ * \var lyx::kb_action lyx::LFUN_MATH_MACRO_REMOVE_PARAM
* \li Action: Remove the last parameter
* \li Notion: Remove the last parameter of a Math Macro and
remove its value in all instances of the macro
*/
{ LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
/**
- * LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
+ * \var lyx::kb_action lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
* \li Action: Append a greedy parameter
* \li Notion: Append a greedy parameter to a Math Macro which
eats the following mathed cell in every instance of
*/
{ LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
/**
- * LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
+ * \var lyx::kb_action lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
* \li Action: Remove a greedy parameter
* \li Notion: Remove a greedy parameter of a Math Macro and spit
out the values of it in every instance of the macro
*/
{ LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
/**
- * LFUN_MATH_MACRO_MAKE_OPTIONAL
+ * \var lyx::kb_action lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
* \li Action: Make a parameter optional
* \li Notion: Turn the first non-optional parameter of a Math Macro
into an optional parameter with a default value.
*/
{ LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
/**
- * LFUN_MATH_MACRO_MAKE_NONOPTIONAL
+ * \var lyx::kb_action lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
* \li Action: Make a parameter non-optional
* \li Notion: Turn the last optional parameter of a Math Macro
into a non-optional parameter. The default value is
*/
{ LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
/**
- * LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
+ * \var lyx::kb_action lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
* \li Action: Add an optional parameter
* \li Notion: Insert an optional parameter just behind the
already existing optional parameters.
*/
{ LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
/**
- * LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
+ * \var lyx::kb_action lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
* \li Action: Remove the last optional parameter
* \li Notion: Remove the last optional parameter of a Math Macro and
remove it in all the instances of the macro in the buffer.
*/
{ LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
/**
- * LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
+ * \var lyx::kb_action lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
* \li Action: Add a greedy optional parameter
* \li Notion: Add a greedy optional parameter which eats the value
from the following cells in mathed which are in the [value]
*/
{ LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
/**
- * LFUN_IN_MATHMACROTEMPLATE
+ * \var lyx::kb_action lyx::LFUN_IN_MATHMACROTEMPLATE
* \li Action: Only active in Math Macro definition
* \li Notion: Dummy function which is only active in a Math Macro definition.
It's used to toggle the Math Macro toolbar if the cursor moves
{ LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
{ LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly, Edit },
/**
- * LFUN_OUTLINE_UP
+ * \var lyx::kb_action lyx::LFUN_OUTLINE_UP
* \li Action: Move the current group in the upward direction in the
structure of the document.
* \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
*/
{ LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
/**
- * LFUN_OUTLINE_DOWN
+ * \var lyx::kb_action lyx::LFUN_OUTLINE_DOWN
* \li Action: Move the current group in the downward direction in the
structure of the document.
* \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
*/
{ LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
/**
- * LFUN_OUTLINE_IN
+ * \var lyx::kb_action lyx::LFUN_OUTLINE_IN
* \li Action: Moves the current group in the downward direction in the
hierarchy of the document structure.
* \li Notion: Part -> Chapter -> Section -> etc.
*/
{ LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
/**
- * LFUN_OUTLINE_OUT
+ * \var lyx::kb_action lyx::LFUN_OUTLINE_OUT
* \li Action: Moves the current group in the upward direction in the
hierarchy of the document structure.
* \li Notion: Part <- Chapter <- Section <- etc.
{ LFUN_ALL_INSETS_TOGGLE, "all-insets-toggle", ReadOnly, Edit },
/**
- * LFUN_PARAGRAPH_PARAMS
+ * \var lyx::kb_action lyx::LFUN_PARAGRAPH_PARAMS
* \li Action: Change paragraph settings
* \li Notion: Modifies the current paragraph, or currently selected paragraphs.
This function only modifies, and does not override, existing settings.
*/
{ LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
/**
- * LFUN_PARAGRAPH_PARAMS_APPLY
+ * \var lyx::kb_action lyx::LFUN_PARAGRAPH_PARAMS_APPLY
* \li Action: Change paragraph settings.
* \li Notion: Overwrite all nonspecified settings to the default ones.
Use paragraph-params lfun if you don't want to overwrite others settings.
{ LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
/**
- * LFUN_BOOKMARK_GOTO
+ * \var lyx::kb_action lyx::LFUN_BOOKMARK_GOTO
* \li Action: Goto a bookmark
* \li Notion: Moves the cursor to the numbered bookmark, opening the file
if necessary. Note that bookmarsk are saved per-session, not
*/
{ LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
/**
- * LFUN_BOOKMARK_SAVE
+ * \var lyx::kb_action lyx::LFUN_BOOKMARK_SAVE
* \li Action: Save a bookmark
* \li Notion: Saves a numbered bookmark to the sessions file. The number
must be between 1 and 9, inclusive. Note that bookmarks are
*/
{ LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
/**
- * LFUN_BOOKMARK_CLEAR
+ * \var lyx::kb_action lyx::LFUN_BOOKMARK_CLEAR
* \li Action: Clears the list of saved bookmarks
* \li Syntax: bookmark-clear
* \li Origin: bpeng, 31 October 2006
{ LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
/**
- * LFUN_LYX_QUIT
+ * \var lyx::kb_action lyx::LFUN_LYX_QUIT
* \li Action: Terminates the current LyX instance
* \li Notion: Terminates the current LyX instance, asking whether to save
modified documents, etc.
{ LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
/**
- * LFUN_BUFFER_AUTO_SAVE
+ * \var lyx::kb_action lyx::LFUN_BUFFER_AUTO_SAVE
* \li Action: Saves the current buffer to a temporary file
* \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
is called automatically by LyX, to "autosave" the current buffer.
{ LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
{ LFUN_BUFFER_TOGGLE_EMBEDDING, "buffer-toggle-embedding", Noop, Buffer },
/**
- * LFUN_BUFFER_CLOSE
+ * \var lyx::kb_action lyx::LFUN_BUFFER_CLOSE
* \li Action: Closes the current buffer
* \li Notion: Closes the current buffer, asking whether to save it, etc,
if the buffer has been modified.
{ LFUN_BUFFER_PRINT, "buffer-print", ReadOnly, Buffer },
{ LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
/**
- * LFUN_BUFFER_NEW
+ * \var lyx::kb_action lyx::LFUN_BUFFER_NEW
* \li Action: Creates a new buffer (that is, document)
* \li Syntax: buffer-new
*/
{ LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
{ LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
/**
- * LFUN_BUFFER_VIEW
+ * \var lyx::kb_action lyx::LFUN_BUFFER_VIEW
* \li Action: Displays current buffer in chosen format
* \li Notion: Displays the contents of the current buffer in the chosen
format, for example, PDF or DVI. This runs the necessary
*/
{ LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
/**
- * LFUN_BUFFER_WRITE
+ * \var lyx::kb_action lyx::LFUN_BUFFER_WRITE
* \li Action: Saves the current buffer
* \li Notion: Saves the current buffer to disk, using the filename that
is already associated with the buffer, asking for one if
*/
{ LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
/**
- * LFUN_BUFFER_WRITE_AS
+ * \var lyx::kb_action lyx::LFUN_BUFFER_WRITE_AS
* \li Action: Rename and save current buffer.
* \li Syntax: buffer-write-as <FILENAME>
* \li Params: <FILENAME>: New name of the buffer/file. A relative path
{ LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
+/**
+ * \var lyx::kb_action lyx::LFUN_CALL
+ * \li Action: Executes a command defined in a .def file.
+ * \li Notion: The definitions are by default read from lib/commands/default.def .
+ A .def file allows to define a command with \\define "<NAME>" "<LFUN>"
+ where <NAME> is the name of the new command and <LFUN> is the lfun code
+ 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
+ lib/images/commands/<NAME>.png this is the way to assign an image
+ to a complex command-sequence.
+ * \li Syntax: call <NAME>
+ * \li Params: <NAME>: Name of the command that must be called.
+ * \li Origin: broider, 2 Oct 2007
+ */
{ LFUN_CALL, "call", NoBuffer, System },
{ LFUN_CANCEL, "cancel", NoBuffer, System },
{ LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
/**
- * LFUN_PREFERENCES_SAVE
+ * \var lyx::kb_action lyx::LFUN_PREFERENCES_SAVE
* \li Action: Save user preferences.
* \li Syntax: preferences-save
* \li Origin: Lgb, 27 Nov 1999
*/
{ LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
/**
- * LFUN_RECONFIGURE
+ * \var lyx::kb_action lyx::LFUN_RECONFIGURE
* \li Action: Reconfigure the automatic settings.
* \li Syntax: reconfigure
* \li Origin: Asger, 14 Feb 1997
*/
{ LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
{ LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
+/**
+ * \var lyx::kb_action lyx::LFUN_TOGGLE_CURSOR_FOLLOWS_SCROLLBAR
+ * \li Action: Determine whether keep cursor inside the editing window regardless
+ the scrollbar movement.
+ * \li Syntax: toggle-cursor-follows-scrollbar
+ * \li Origin: ARRae, 2 Dec 1997
+ */
{ LFUN_TOGGLE_CURSOR_FOLLOWS_SCROLLBAR, "toggle-cursor-follows-scrollbar", ReadOnly, System },
-
- { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, Edit },
- { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
/**
- * LFUN_STATISTICS
+ * \var lyx::kb_action lyx::LFUN_SET_COLOR
+ * \li Action: Set the given LyX color to the color defined by the X11 name given.
+ * \li Notion: A new color entry is created if the color is unknown.
+ Color names can be stored as a part of user settings.
+ * \li Syntax: set-color <LYX_NAME> <X11_NAME>
+ * \li Origin: SLior, 11 Jun 2000
+ */
+ { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
+/**
+ * \var lyx::kb_action lyx::LFUN_STATISTICS
* \li Action: Count 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,