X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FLyXAction.cpp;h=4c4666cc1eb0172afe9d40e68a1e4cfa42f1bfa4;hb=6b651f2ad9f698c01993dcc6e340682c279f1c55;hp=2a440d571222f9bc0783669f6851c428862294b0;hpb=33c95fc07b6eff0390f12b26378298fb843613e3;p=lyx.git diff --git a/src/LyXAction.cpp b/src/LyXAction.cpp index 2a440d5712..4c4666cc1e 100644 --- a/src/LyXAction.cpp +++ b/src/LyXAction.cpp @@ -1,4 +1,4 @@ -/** +/*! * \file LyXAction.cpp * This file is part of LyX, the document processor. * Licence details can be found in the file COPYING. @@ -44,6 +44,27 @@ namespace lyx { (May 19 1996, 12:04, RvdK) */ +/* LFUN documentation (a start at least, Chr 2007-08-12) + * + * The documentation below is primarily notes about restrictions and + * oddities relating to the different LFUNs. + * + * Try to find an appropriate (thematical) place when adding the new LFUN. + * + * Doxygen template below. Some notes: Parameters should be set in uppercase + * and put in , as so. + */ + +/*! + * \var lyx::kb_action lyx::LFUN_ + * \li Action: + * \li Notion: + * \li Syntax: + * \li Params: + * \li Sample: + * \li Origin: + */ + LyXAction lyxaction; @@ -63,7 +84,6 @@ void LyXAction::newFunc(kb_action action, string const & name, // \var inside functions. #ifndef DOXYGEN_SHOULD_SKIP_THIS void LyXAction::init() -#endif { // This function was changed to use the array below in initalization // instead of calling newFunc numerous times because of compilation @@ -82,43 +102,226 @@ void LyXAction::init() }; ev_item const items[] = { - { LFUN_ACCENT_ACUTE, "accent-acute", Noop, Layout }, - { LFUN_ACCENT_BREVE, "accent-breve", Noop, Layout }, - { LFUN_ACCENT_CARON, "accent-caron", Noop, Layout }, - { LFUN_ACCENT_CEDILLA, "accent-cedilla", Noop, Layout }, - { LFUN_ACCENT_CIRCLE, "accent-circle", Noop, Layout }, - { LFUN_ACCENT_CIRCUMFLEX, "accent-circumflex", Noop, Layout }, - { LFUN_ACCENT_DOT, "accent-dot", Noop, Layout }, - { LFUN_ACCENT_GRAVE, "accent-grave", Noop, Layout }, - { LFUN_ACCENT_HUNGARIAN_UMLAUT, "accent-hungarian-umlaut", Noop, Layout }, - { LFUN_ACCENT_MACRON, "accent-macron", Noop, Layout }, - { LFUN_ACCENT_OGONEK, "accent-ogonek", Noop, Layout }, - { LFUN_ACCENT_SPECIAL_CARON, "accent-special-caron", Noop, Layout }, - { LFUN_ACCENT_TIE, "accent-tie", Noop, Layout }, - { LFUN_ACCENT_TILDE, "accent-tilde", Noop, Layout }, - { LFUN_ACCENT_UMLAUT, "accent-umlaut", Noop, Layout }, - { LFUN_ACCENT_UNDERBAR, "accent-underbar", Noop, Layout }, - { LFUN_ACCENT_UNDERDOT, "accent-underdot", Noop, Layout }, - - { LFUN_APPENDIX, "appendix", Noop, Edit }, +#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 [] + * \li Param: : 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 + * \li Params: : 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 }, @@ -132,10 +335,10 @@ void LyXAction::init() { LFUN_CLEARPAGE_INSERT, "clearpage-insert", Noop, Edit }, { LFUN_CLEARDOUBLEPAGE_INSERT, "cleardoublepage-insert", Noop, Edit }, { LFUN_TOC_INSERT, "toc-insert", Noop, Edit }, + { LFUN_APPENDIX, "appendix", Noop, Edit }, + #if 0 { LFUN_LIST_INSERT, "list-insert", Noop, Edit }, -#endif -#if 0 { LFUN_THEOREM_INSERT, "theorem-insert", Noop, Edit }, #endif @@ -147,21 +350,105 @@ void LyXAction::init() { 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_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout }, +/*! + * \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 + * \li Params: : line|page\n + : up|down|\n + * \li Origin: Abdelrazak Younes, Dec 27 2007 + */ { LFUN_SCROLL, "scroll", ReadOnly, Edit }, +/*! + * \var lyx::kb_action lyx::LFUN_SCREEN_RECENTER + * \li Action: Recenters the screen on the current cursor position. + * \li Syntax: screen-recenter + */ { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit }, { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit }, { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit }, + { LFUN_ERROR_NEXT, "error-next", ReadOnly, Edit }, +/*! + * \var lyx::kb_action lyx::LFUN_CHAR_BACKWARD + * \li Action: Moves the cursor one position logically backwards. + * \li Notion: This is not the action which should be bound to the arrow keys, + because backwards may be left or right, depending on the + language. The arrow keys should be bound to #LFUN_CHAR_LEFT or + #LFUN_CHAR_RIGHT actions, which in turn may employ this one. + * \li Syntax: char-backward + */ { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit }, +/*! + * \var lyx::kb_action lyx::LFUN_CHAR_BACKWARD_SELECT + * \li Action: Moves the cursor one position logically backwards, adding + traversed position to the selection. + * \li Notion: See also #LFUN_CHAR_BACKWARD. + * \li Syntax: char-backward-select + */ { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit }, { LFUN_CHAR_DELETE_BACKWARD, "delete-backward", SingleParUpdate, Edit }, { LFUN_CHAR_DELETE_FORWARD, "delete-forward", SingleParUpdate, Edit }, +/*! + * \var lyx::kb_action lyx::LFUN_CHAR_FORWARD + * \li Action: Moves the cursor one position logically forward. + * \li Notion: This is not the action which should be bound to the arrow keys, + because forward may be left or right, depending on the language. + The arrow keys should be bound to #LFUN_CHAR_LEFT or + #LFUN_CHAR_RIGHT actions, which in turn may employ this one. + * \li Syntax: char-forward + */ { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit }, +/*! + * \var lyx::kb_action lyx::LFUN_CHAR_FORWARD_SELECT + * \li Action: Moves the cursor one position logically forward, adding + traversed position to the selection. + * \li Notion: See also #LFUN_CHAR_FORWARD. + * \li Syntax: char-forward-select + */ { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit }, +/*! + * \var lyx::kb_action lyx::LFUN_CHAR_LEFT + * \li Action: Moves the cursor one position "to the left". + * \li Notion: This is the action which should be taken when the "left" key + is pressed. Generally, it moves the cursor one position to 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 paragraphs, and + logically backwards in LTR paragraphs. + * \li Syntax: char-left + */ { LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit }, +/*! + * \var lyx::kb_action lyx::LFUN_CHAR_LEFT_SELECT + * \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_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit }, +/*! + * \var lyx::kb_action lyx::LFUN_CHAR_RIGHT + * \li Action: Moves the cursor one position "to the right". + * \li Notion: This is the action which should be taken when the "right" key + is pressed. Generally, it moves the cursor one position to 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 paragraphs. + * \li Syntax: char-right + */ { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit }, +/*! + * \var lyx::kb_action lyx::LFUN_CHAR_RIGHT_SELECT + * \li Action: Moves the cursor one position "to the right", adding + traversed position to the selection. + * \li Notion: See also #LFUN_CHAR_RIGHT for exact details of the movement. + * \li Syntax: char-right-select + */ { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit }, { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit }, @@ -182,6 +469,17 @@ void LyXAction::init() { 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_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit }, { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit }, { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit }, @@ -191,15 +489,56 @@ void LyXAction::init() { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit }, { LFUN_NEW_LINE, "new-line", Noop, Edit }, +/*! + * \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 }, +/*! + * \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 }, - +/*! + * \var lyx::kb_action lyx::LFUN_COPY + * \li Action: Copies to the clipboard the last edit. + * \li Syntax: copy + */ { LFUN_COPY, "copy", ReadOnly, Edit }, +/*! + * \var lyx::kb_action lyx::LFUN_CUT + * \li Action: Cuts to the clipboard. + * \li Syntax: cut + */ { LFUN_CUT, "cut", Noop, Edit }, +/*! + * \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 }, +/*! + * \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 }, +/*! + * \var lyx::kb_action lyx::LFUN_UNDO + * \li Action: Undoes the last edit. + * \li Syntax: undo + */ { LFUN_UNDO, "undo", Noop, Edit }, +/*! + * \var lyx::kb_action lyx::LFUN_REDO + * \li Action: Redoes the last thing undone. + * \li Syntax: redo + */ { LFUN_REDO, "redo", Noop, Edit }, { LFUN_REPEAT, "repeat", NoBuffer, Edit }, { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit }, @@ -222,6 +561,7 @@ void LyXAction::init() { LFUN_FONT_SIZE, "font-size", Noop, Layout }, { LFUN_FONT_STATE, "font-state", ReadOnly, Layout }, { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout }, + { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout }, { LFUN_INDEX_INSERT, "index-insert", Noop, Edit }, { LFUN_INDEX_PRINT, "index-print", Noop, Edit }, @@ -237,19 +577,94 @@ void LyXAction::init() { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit }, { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit }, + /*! + * \var lyx::kb_action lyx::LFUN_LAYOUT + * \li Action: Sets the layout (that is, environment) for the current paragraph. + * \li Syntax: layout + * \li Params: : the layout to use + */ { LFUN_LAYOUT, "layout", Noop, Layout }, +/*! + * \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 }, +/*! + * \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. + * \li Syntax: drop-layouts-choice + */ { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout }, +/*! + * \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 + * \li Origin: rgh, 25 August 2007 + */ { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", Noop, Layout }, +/*! + * \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 + * \li Params: : the module to be added + * \li Origin: rgh, 25 August 2007 + */ { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", Noop, Layout }, +/*! + * \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. + This is intended to be used only by layout developers and should not be + used when one is trying to do actual work. + * \li Syntax: layout-reload + * \li Origin: rgh, 3 September 2007 + */ { LFUN_LAYOUT_RELOAD, "layout-reload", Noop, Layout }, +/*! + * \var lyx::kb_action lyx::LFUN_TEXTCLASS_APPLY + * \li Action: Sets the text class for the current buffer. + * \li Syntax: textclass-apply + * \li Params: : the textclass to set. Note that this must be + the filename, minus the ".layout" extension. + */ { LFUN_TEXTCLASS_APPLY, "textclass-apply", Noop, Layout }, +/*! + * \var lyx::kb_action lyx::LFUN_TEXTCLASS_LOAD + * \li Action: Loads information for a textclass from disk. + * \li Syntax: textclass-load + * \li Params: : the textclass to load. Note that this must be + the filename, minus the ".layout" extension. + */ { LFUN_TEXTCLASS_LOAD, "textclass-load", Noop, Layout }, +/*! + * \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 }, +/*! + * \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 }, +/*! + * \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_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit }, + { LFUN_MATH_DELIM, "math-delim", Noop, Math }, { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math }, { LFUN_MATH_DISPLAY, "math-display", Noop, Math }, @@ -263,29 +678,184 @@ void LyXAction::init() { LFUN_MATH_IMPORT_SELECTION, "math-import-selection", Noop, Math }, { LFUN_MATH_MATRIX, "math-matrix", Noop, Math }, { LFUN_MATH_MODE, "math-mode", Noop, Math }, +/*! + * \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 + * \li Origin: Alejandro 18 Jun 1996 + */ { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math }, +/*! + * \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 + * \li Origin: Alejandro 4 Jun 1996 + */ { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math }, { LFUN_MATH_EXTERN, "math-extern", Noop, Math }, { LFUN_MATH_SIZE, "math-size", Noop, Math }, +/*! + * \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. + * \li Syntax: math-macro-unfold + * \li Origin: sts, 06 January 2008 + */ { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math }, +/*! + * \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. + * \li Syntax: math-macro-fold + * \li Origin: sts, 06 January 2008 + */ { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math }, +/*! + * \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: : The number of the parameter behind which the new one + will be added (1 for the first, i.e. use 0 for add a + parameter at the left), defaults to the last one. + * \li Syntax: math-macro-add-param + * \li Origin: sts, 06 January 2008 + */ { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math }, +/*! + * \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 + in the buffer. + * \li Params: : The number of the parameter to be deleted (1 for + the first), defaults to the last one. + * \li Syntax: math-macro-remove-param + * \li Origin: sts, 06 January 2008 + */ { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math }, +/*! + * \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 + the macro in the buffer. + * \li Syntax: math-macro-append-greedy-param + * \li Origin: sts, 06 January 2008 + */ { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math }, +/*! + * \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 + in the buffer. If it is an optional parameter the [valud] + format is used. + * \li Syntax: math-macro-remove-greedy-param + * \li Origin: sts, 06 January 2008 + */ { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math }, +/*! + * \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. + * \li Syntax: math-macro-make-optional + * \li Origin: sts, 06 January 2008 + */ { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math }, +/*! + * \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 + remembered to be reused later if the user changes his mind. + * \li Syntax: math-macro-make-nonoptional + * \li Origin: sts, 06 January 2008 + */ { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math }, +/*! + * \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. + * \li Syntax: math-macro-add-optional-param + * \li Origin: sts, 06 January 2008 + */ { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math }, +/*! + * \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. + * \li Syntax: math-macro-remove-optional-param + * \li Origin: sts, 06 January 2008 + */ { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math }, +/*! + * \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] + format. + * \li Syntax: math-macro-add-greedy-optional-param + * \li Origin: sts, 06 January 2008 + */ { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math }, +/*! + * \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 + into a Math Macro definition. + * \li Syntax: in-mathmacrotemplate + * \li Origin: sts, 06 January 2008 + */ { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math }, { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit }, { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit }, { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly, Edit }, +/*! + * \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 + the whole substructure of the group. + * \li Syntax: outline-up + * \li Origin: Vermeer, 23 Mar 2006 + */ { LFUN_OUTLINE_UP, "outline-up", Noop, Edit }, +/*! + * \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 + the whole substructure of the group. + * \li Syntax: outline-down + * \li Origin: Vermeer, 23 Mar 2006 + */ { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit }, +/*! + * \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. + * \li Syntax: outline-in + * \li Origin: Vermeer, 23 Mar 2006 + */ { LFUN_OUTLINE_IN, "outline-in", Noop, Edit }, +/*! + * \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. + * \li Syntax: outline-out + * \li Origin: Vermeer, 23 Mar 2006 + */ { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit }, { LFUN_PARAGRAPH_SPACING, "paragraph-spacing", Noop, Edit }, @@ -327,13 +897,64 @@ void LyXAction::init() { LFUN_INSET_TOGGLE, "", ReadOnly, Hidden }, { LFUN_ALL_INSETS_TOGGLE, "all-insets-toggle", ReadOnly, Edit }, +/*! + * \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. + Note that the "leftindent" indent setting is deprecated. + * \li Syntax: paragraph-params [] [] [] [] + * \li Params: : \\noindent|\\indent|\\indent-toggle|\\leftindent LENGTH\n + : \\paragraph_spacing default|single|onehalf|double|other\n + : \\align block|left|right|center|default\n + : \\labelwidthstring WIDTH|\\start_of_appendix\n + * \li Origin: rgh, Aug 15 2007 + */ { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit }, +/*! + * \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. + * \li Syntax: paragraph-params-apply + * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS + * \li Origin: leeming, 30 Mar 2004 + */ { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit }, { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden }, +/*! + * \var lyx::kb_action lyx::LFUN_FINISHED_FORWARD + * \li Action: Moves the cursor out of the current slice, going forward. + * \li Notion: Cursor movement within an inset may be different than cursor + movement in the surrounding text. This action should be called + automatically by the cursor movement within the inset, when + movement within the inset has ceased (reached the end of the + last paragraph, for example), in order to move correctly + back into the surrounding text. + * \li Syntax: finished-forward + */ { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden }, +/*! + * \var lyx::kb_action lyx::LFUN_FINISHED_BACKWARD + * \li Action: Moves the cursor out of the current slice, going backwards. + * \li Notion: See also #LFUN_FINISHED_FORWARD. + * \li Syntax: finished-backward + */ { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden }, +/*! + * \var lyx::kb_action lyx::LFUN_FINISHED_RIGHT + * \li Action: Moves the cursor out of the current slice, going right. + * \li Notion: See also #LFUN_FINISHED_FORWARD + * \li Syntax: finished-right + */ { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden }, +/*! + * \var lyx::kb_action lyx::LFUN_FINISHED_LEFT + * \li Action: Moves the cursor out of the current slice, going left. + * \li Notion: See also #LFUN_FINISHED_FORWARD. + * \li Syntax: finished-left + */ { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden }, { LFUN_LANGUAGE, "language", Noop, Edit }, @@ -342,14 +963,46 @@ void LyXAction::init() { LFUN_LABEL_INSERT, "label-insert", Noop, Edit }, { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit }, +/*! + * \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 + per file. + * \li Syntax: bookmark-goto + * \li Params: : the number of the bookmark to restore. + * \li Origin: Dekel, 27 January 2001 + */ { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit }, +/*! + * \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 + saved per-session, not per file. + * \li Syntax: bookmark-save + * \li Params: : the number of the bookmark to save. + * \li Origin: Dekel, 27 January 2001 + */ { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit }, +/*! + * \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_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit }, - { LFUN_ERROR_NEXT, "error-next", ReadOnly, Edit }, { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer }, +/*! + * \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. + * \li Syntax: lyx-quit + */ { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer }, - { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Edit }, + { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer }, { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer }, { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer }, @@ -388,63 +1041,221 @@ void LyXAction::init() { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer }, +/*! + * \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. + * \li Syntax: buffer-auto-save + */ { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer }, - { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit }, - { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit }, { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer }, { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer }, { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer }, { LFUN_BUFFER_TOGGLE_EMBEDDING, "buffer-toggle-embedding", Noop, Buffer }, +/*! + * \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. + * \li Syntax: buffer-close + */ { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer }, - { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit }, - { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit }, +/*! + * \var lyx::kb_action lyx::LFUN_BUFFER_EXPORT + * \li Action: Exports the current buffer (document) to the given format. + * \li Syntax: buffer-export + * \li Params: 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), + "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n + 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. + * \li Origin: Lgb, 29 Jul 1997 + */ { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer }, { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer }, +/*! + * \var lyx::kb_action 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 + * \li Params: is either "printer" or "file".\n + is either "default" or file name or printer name.\n + command ensuring the printing job. + * \li Sample: buffer-print file "/trash/newfile1.ps" "dvips" + * \li Origin: leeming, 28 Mar 2004 + */ { LFUN_BUFFER_PRINT, "buffer-print", ReadOnly, Buffer }, +/*! + * \var lyx::kb_action lyx::LFUN_BUFFER_IMPORT + * \li Action: Import a given file as a lyx document. + * \li Notion: File can be imported iff lyx file format is (transitively) reachable via + defined convertors in preferences. Look into File->Import menu to get + an idea of the currently active import formats. + * \li Syntax: buffer-import [] + * \li Origin: Asger, 24 Jul 1998 + */ { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer }, +/*! + * \var lyx::kb_action lyx::LFUN_BUFFER_NEW + * \li Action: Creates a new buffer (that is, document). + * \li Syntax: buffer-new + */ { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer }, { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer }, { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer }, - { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Edit }, + { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer }, { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer }, - { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Edit }, - { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Edit }, + { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer }, +/*! + * \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 + converter, calls the defined viewer, and so forth. + * \li Syntax: buffer-view + * \li Params: : The format to display, where this is one of the + formats defined (in the current GUI) in the + Tools>Preferences>File Formats dialog. + */ + { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer }, +/*! + * \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 + none is yet assigned. + * \li Syntax: buffer-write + */ { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer }, +/*! + * \var lyx::kb_action lyx::LFUN_BUFFER_WRITE_AS + * \li Action: Rename and save current buffer. + * \li Syntax: buffer-write-as + * \li Params: : New name of the buffer/file. A relative path + * is with respect to the original location of the buffer/file. + */ { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer }, { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer }, { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer }, { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer }, - { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Edit }, - { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Edit }, + { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer }, + { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer }, { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer }, { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer }, { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", Noop, Buffer }, - { LFUN_FILE_INSERT, "file-insert", Noop, Buffer }, + { LFUN_FILE_INSERT, "file-insert", Noop, Edit }, { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit }, { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit }, { LFUN_FILE_NEW, "file-new", NoBuffer, Buffer }, { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer }, - { 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.\n + A .def file allows to define a command with \\define "" "" + where is the name of the new command and 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/.png this is the way to assign an image + to a complex command-sequence. + * \li Syntax: call + * \li Params: : Name of the command that must be called. + * \li Origin: broider, 2 Oct 2007 + */ { LFUN_CALL, "call", NoBuffer, System }, +/*! + * \var lyx::kb_action 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 Syntax: meta-prefix + */ + { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System }, +/*! + * \var lyx::kb_action lyx::LFUN_CANCEL + * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX . + * \li Syntax: cancel + */ { LFUN_CANCEL, "cancel", NoBuffer, System }, +/*! + * \var lyx::kb_action lyx::LFUN_COMMAND_EXECUTE + * \li Action: Opens the minibuffer toolbar so that the user can type in there. + * \li Notion: Usually bound to M-x shortcut. + * \li Syntax: command-execute + */ { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit }, { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden }, +/*! + * \var lyx::kb_action lyx::LFUN_COMMAND_SEQUENCE + * \li Action: Run more commands (LFUN and its parameters) in a sequence. + * \li Syntax: command-sequence + * \li Params: : Sequence of commands separated by semicolons. + * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle; + * \li Origin: Andre', 11 Nov 1999 + */ { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System }, - { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, Edit }, +/*! + * \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 }, +/*! + * \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 }, +/*! + * \var lyx::kb_action lyx::LFUN_LYXRC_APPLY + * \li Action: Apply the given settings to user preferences. + * \li Syntax: lyxrc-apply + * \li Params: : settings which are to be set. Take a look into ~/.lyx/preferences + to get an idea which commands to use and their syntax. + #lyx::LyXRC::LyXRCTags has the list of possible commands. + */ { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System }, - { LFUN_TOGGLE_CURSOR_FOLLOWS_SCROLLBAR, "toggle-cursor-follows-scrollbar", ReadOnly, Edit }, - - { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, Edit }, - { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit }, +/*! + * \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 }, +/*! + * \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 + * \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, + not the number of characters which will be typeset. + * \li Syntax: statistics + * \li Origin: lasgouttes, Jan 27 2004; ps, Jan 8 2008 + */ { LFUN_STATISTICS, "statistics", ReadOnly, System }, { LFUN_NOACTION, "", Noop, Hidden } +#ifndef DOXYGEN_SHOULD_SKIP_THIS }; for (int i = 0; items[i].action != LFUN_NOACTION; ++i) { @@ -453,7 +1264,7 @@ void LyXAction::init() init = true; } - +#endif LyXAction::LyXAction() {