X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FLyXAction.cpp;h=99f9ab28f6718356f1b41cf35c317ce45abf0e73;hb=027563eec2d2a1b81391b221f9ca40d823713235;hp=62c47b317a747fd9c2f9f472a619fe5be48d7d0b;hpb=25c7910e875bf6be80c0e48a4ef7674158b67667;p=lyx.git diff --git a/src/LyXAction.cpp b/src/LyXAction.cpp index 62c47b317a..99f9ab28f6 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. @@ -15,9 +15,9 @@ #include "LyXAction.h" -#include "support/debug.h" #include "FuncRequest.h" +#include "support/debug.h" #include "support/lstrings.h" #include @@ -55,23 +55,25 @@ namespace lyx { * and put in , as so. */ -/** - * +/*! + * \var lyx::FuncCode lyx::LFUN_ * \li Action: * \li Notion: * \li Syntax: * \li Params: + * \li Sample: * \li Origin: + * \endvar */ LyXAction lyxaction; -void LyXAction::newFunc(kb_action action, string const & name, +void LyXAction::newFunc(FuncCode action, string const & name, unsigned int attrib, LyXAction::func_type type) { lyx_func_map[name] = action; - func_info tmpinfo; + FuncInfo tmpinfo; tmpinfo.name = name; tmpinfo.attrib = attrib; tmpinfo.type = type; @@ -94,7 +96,7 @@ void LyXAction::init() if (init) return; struct ev_item { - kb_action action; + FuncCode action; char const * name; unsigned int attrib; func_type type; @@ -102,50 +104,279 @@ void LyXAction::init() ev_item const items[] = { #endif +/*! + * \var lyx::FuncCode lyx::LFUN_ACCENT_ACUTE + * \li Action: Adds an acute accent \htmlonly (á)\endhtmlonly + to the next character typed. + * \li Syntax: accent-acute + * \endvar + */ { LFUN_ACCENT_ACUTE, "accent-acute", Noop, Edit }, +/*! + * \var lyx::FuncCode lyx::LFUN_ACCENT_BREVE + * \li Action: Adds a breve accent \htmlonly (ă)\endhtmlonly + to the next character typed. + * \li Syntax: accent-breve + * \endvar + */ { LFUN_ACCENT_BREVE, "accent-breve", Noop, Edit }, +/*! + * \var lyx::FuncCode lyx::LFUN_ACCENT_CARON + * \li Action: Adds a caron \htmlonly (ǎ)\endhtmlonly + to the next character typed. + * \li Syntax: accent-caron + * \endvar + */ { LFUN_ACCENT_CARON, "accent-caron", Noop, Edit }, +/*! + * \var lyx::FuncCode lyx::LFUN_ACCENT_CEDILLA + * \li Action: Adds a cedilla \htmlonly (ç)\endhtmlonly + to the next character typed. + * \li Syntax: accent-cedilla + * \endvar + */ { LFUN_ACCENT_CEDILLA, "accent-cedilla", Noop, Edit }, +/*! + * \var lyx::FuncCode lyx::LFUN_ACCENT_CIRCLE + * \li Action: Adds a circle accent \htmlonly (å)\endhtmlonly + to the next character typed. + * \li Syntax: accent-circle + * \endvar + */ { LFUN_ACCENT_CIRCLE, "accent-circle", Noop, Edit }, +/*! + * \var lyx::FuncCode lyx::LFUN_ACCENT_CIRCUMFLEX + * \li Action: Adds a circumflex \htmlonly (ê)\endhtmlonly + to the next character typed. + * \li Syntax: accent-circumflex + * \endvar + */ { LFUN_ACCENT_CIRCUMFLEX, "accent-circumflex", Noop, Edit }, +/*! + * \var lyx::FuncCode lyx::LFUN_ACCENT_DOT + * \li Action: Adds a dot accent \htmlonly (ż)\endhtmlonly + to the next character typed. + * \li Syntax: accent-dot + * \endvar + */ { LFUN_ACCENT_DOT, "accent-dot", Noop, Edit }, +/*! + * \var lyx::FuncCode lyx::LFUN_ACCENT_GRAVE + * \li Action: Adds a grave accent \htmlonly (è)\endhtmlonly + to the next character typed. + * \li Syntax: accent-grave + * \endvar + */ { LFUN_ACCENT_GRAVE, "accent-grave", Noop, Edit }, +/*! + * \var lyx::FuncCode lyx::LFUN_ACCENT_HUNGARIAN_UMLAUT + * \li Action: Adds a Hungarian umlaut \htmlonly (ő)\endhtmlonly + to the next character typed. + * \li Syntax: accent-grave + * \endvar + */ { LFUN_ACCENT_HUNGARIAN_UMLAUT, "accent-hungarian-umlaut", Noop, Edit }, +/*! + * \var lyx::FuncCode lyx::LFUN_ACCENT_MACRON + * \li Action: Adds a macron \htmlonly (ā)\endhtmlonly + to the next character typed. + * \li Syntax: accent-macron + * \endvar + */ { LFUN_ACCENT_MACRON, "accent-macron", Noop, Edit }, +/*! + * \var lyx::FuncCode lyx::LFUN_ACCENT_OGONEK + * \li Action: Adds an ogonek accent \htmlonly (ą)\endhtmlonly + to the next character typed. + * \li Syntax: accent-ogonek + * \endvar + */ { LFUN_ACCENT_OGONEK, "accent-ogonek", Noop, Edit }, { LFUN_ACCENT_SPECIAL_CARON, "accent-special-caron", Noop, Edit }, +/*! + * \var lyx::FuncCode 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 + * \endvar + */ { LFUN_ACCENT_TIE, "accent-tie", Noop, Edit }, +/*! + * \var lyx::FuncCode lyx::LFUN_ACCENT_TILDE + * \li Action: Adds a tilde \htmlonly (ã)\endhtmlonly + over the next character typed. + * \li Syntax: accent-tilde + * \endvar + */ { LFUN_ACCENT_TILDE, "accent-tilde", Noop, Edit }, +/*! + * \var lyx::FuncCode lyx::LFUN_ACCENT_UMLAUT + * \li Action: Adds an umlaut \htmlonly (ä)\endhtmlonly + over the next character typed. + * \li Syntax: accent-umlaut + * \endvar + */ { LFUN_ACCENT_UMLAUT, "accent-umlaut", Noop, Edit }, +/*! + * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERBAR + * \li Action: Adds a bar \htmlonly (a̠)\endhtmlonly + under the next character typed. + * \li Syntax: accent-underbar + * \endvar + */ { LFUN_ACCENT_UNDERBAR, "accent-underbar", Noop, Edit }, +/*! + * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERDOT + * \li Action: Adds a dot \htmlonly (ạ)\endhtmlonly + under the next character typed. + * \li Syntax: accent-underdot + * \endvar + */ { LFUN_ACCENT_UNDERDOT, "accent-underdot", Noop, Edit }, - { LFUN_BREAK_PARAGRAPH, "break-paragraph", Noop, Edit }, - { LFUN_BREAK_PARAGRAPH_SKIP, "break-paragraph-skip", Noop, Edit }, - +/*! + * \var lyx::FuncCode lyx::LFUN_CAPTION_INSERT + * \li Action: Inserts a caption inset. + * \li Syntax: caption-insert + * \li Origin: Lgb, 18 Jul 2000 + * \endvar + */ { LFUN_CAPTION_INSERT, "caption-insert", Noop, Edit }, +/*! + * \var lyx::FuncCode lyx::LFUN_DATE_INSERT + * \li Action: Inserts the current date. + * \li Syntax: date-insert [] + * \li Params: : 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 + * \endvar + */ { LFUN_DATE_INSERT, "date-insert", Noop, Edit }, +/*! + * \var lyx::FuncCode lyx::LFUN_FOOTNOTE_INSERT + * \li Action: Inserts a footnote inset. + * \li Syntax: footnote-insert + * \li Origin: Jug, 7 Mar 2000 + * \endvar + */ { LFUN_FOOTNOTE_INSERT, "footnote-insert", Noop, Edit }, +/*! + * \var lyx::FuncCode lyx::LFUN_ERT_INSERT + * \li Action: Inserts an ERT inset. + * \li Syntax: ert-insert + * \li Origin: Jug, 18 Feb 2000 + * \endvar + */ { 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 }, - { LFUN_HFILL_INSERT, "hfill-insert", Noop, Edit }, +/*! + * \var lyx::FuncCode lyx::LFUN_OPTIONAL_INSERT + * \li Action: Inserts an optional-argument (short title) inset. + * \li Syntax: optional-insert + * \li Origin: Martin, 12 Aug 2002 + * \endvar + */ { LFUN_OPTIONAL_INSERT, "optional-insert", Noop, Edit }, +/*! + * \var lyx::FuncCode lyx::LFUN_LINE_INSERT + * \li Action: Inserts a horizontal line. + * \li Syntax: line-insert + * \li Origin: poenitz, Oct 27 2003 + * \endvar + */ { LFUN_LINE_INSERT, "line-insert", Noop, Edit }, +/*! + * \var lyx::FuncCode lyx::LFUN_NEWPAGE_INSERT + * \li Action: Inserts a new page. + * \li Syntax: newpage-insert + * \li Origin: uwestoehr, 24 Nov 2007 + * \endvar + */ { LFUN_NEWPAGE_INSERT, "newpage-insert", Noop, Edit }, +/*! + * \var lyx::FuncCode lyx::LFUN_PAGEBREAK_INSERT + * \li Action: Inserts a pagebreak. + * \li Syntax: pagebreak-insert + * \li Origin: poenitz, Oct 27 2003 + * \endvar + */ { LFUN_PAGEBREAK_INSERT, "pagebreak-insert", Noop, Edit }, +/*! + * \var lyx::FuncCode lyx::LFUN_MARGINALNOTE_INSERT + * \li Action: Inserts a marginal note. + * \li Syntax: marginalnote-insert + * \li Origin: Lgb, 26 Jun 2000 + * \endvar + */ { LFUN_MARGINALNOTE_INSERT, "marginalnote-insert", Noop, Edit }, +/*! + * \var lyx::FuncCode 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 + * \endvar + */ { LFUN_UNICODE_INSERT, "unicode-insert", Noop, Edit }, +/*! + * \var lyx::FuncCode 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 + * \endvar + */ { LFUN_LISTING_INSERT, "listing-insert", Noop, Edit }, { LFUN_QUOTE_INSERT, "quote-insert", Noop, Edit }, { LFUN_INFO_INSERT, "info-insert", Noop, Edit }, { LFUN_BRANCH_INSERT, "branch-insert", Noop, Edit }, { LFUN_BOX_INSERT, "box-insert", Noop, Edit }, +/*! + * \var lyx::FuncCode lyx::LFUN_FLEX_INSERT + * \li Action: Inserts CharStyle, Custom inset or XML short element. + * \li Notion: Look into the Customization manual for more information about + these elements.\n + For dissolving the element see #LFUN_INSET_DISSOLVE. + * \li Syntax: flex-insert + * \li Params: TYPE: CharStyle|Custom|Element|Standard + Identifies whether this is a Character Style, a + Custom Inset or an XML Element, and which dynamical + sub-menu this flex inset is in on the LyX menu tree. + If Standard (currently unused): none of these. + Name: This name must be defined either in your layout file + or imported by some module. The definition is\n + InsetLayout + * \li Sample: flex-insert CharStyle:Code + * \endvar + */ { LFUN_FLEX_INSERT, "flex-insert", Noop, Edit }, { LFUN_SELF_INSERT, "self-insert", SingleParUpdate, Hidden }, +/*! + * \var lyx::FuncCode lyx::LFUN_SPACE_INSERT + * \li Action: Inserts one of horizontal space insets. + * \li Syntax: space-insert [] + * \li Params: : normal, protected, thin, quad, qquad, enspace, enskip, + negthinspace, hfill, hfill*, dotfill, hrulefill, hspace, + hspace* \n + : length for custom spaces (hspace, hspace* for protected) + * \li Origin: JSpitzm, 20 May 2003, Mar 17 2008 + * \endvar + */ { LFUN_SPACE_INSERT, "space-insert", Noop, Edit }, { LFUN_HYPERLINK_INSERT, "href-insert", Noop, Edit }, +/*! + * \var lyx::FuncCode lyx::LFUN_SPECIALCHAR_INSERT + * \li Action: Inserts various characters into the document. + * \li Syntax: specialchar-insert + * \li Params: : hyphenation, ligature-break, slash, nobreakdash, dots, + end-of-sentence, menu-separator. + * \li Origin: JSpitzm, 6 Dec 2007 + * \endvar + */ { LFUN_SPECIALCHAR_INSERT, "specialchar-insert", Noop, Edit }, { LFUN_CLEARPAGE_INSERT, "clearpage-insert", Noop, Edit }, { LFUN_CLEARDOUBLEPAGE_INSERT, "cleardoublepage-insert", Noop, Edit }, @@ -154,7 +385,6 @@ void LyXAction::init() #if 0 { LFUN_LIST_INSERT, "list-insert", Noop, Edit }, - { LFUN_THEOREM_INSERT, "theorem-insert", Noop, Edit }, #endif { LFUN_DELETE_BACKWARD_SKIP, "delete-backward-skip", Noop, Edit }, @@ -165,35 +395,115 @@ 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 }, -/** - * \var lyx::kb_action lyx::LFUN_SCROLL - * \li Action: scroll the buffer view +/*! + * \var lyx::FuncCode 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 + : up|down| * \li Origin: Abdelrazak Younes, Dec 27 2007 + * \endvar */ { LFUN_SCROLL, "scroll", ReadOnly, Edit }, -/** - * \var lyx::kb_action lyx::LFUN_SCREEN_RECENTER - * \li Action: Recenters the screen on the current cursor position +/*! + * \var lyx::FuncCode lyx::LFUN_SCREEN_RECENTER + * \li Action: Recenters the screen on the current cursor position. * \li Syntax: screen-recenter + * \endvar */ { 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::FuncCode 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 + * \endvar + */ { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit }, +/*! + * \var lyx::FuncCode 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 + * \endvar + */ { 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::FuncCode 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 + * \endvar + */ { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit }, +/*! + * \var lyx::FuncCode 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 + * \endvar + */ { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit }, +/*! + * \var lyx::FuncCode 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 + * \endvar + */ { 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 + traversed position to the selection. + * \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement. + * \li Syntax: char-left-select + * \endvar + */ { LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit }, +/*! + * \var lyx::FuncCode 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 + * \endvar + */ { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit }, +/*! + * \var lyx::FuncCode 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 + * \endvar + */ { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit }, { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit }, @@ -214,11 +524,12 @@ 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 +/*! + * \var lyx::FuncCode 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 + * \endvar */ { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit }, { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit }, @@ -234,55 +545,47 @@ 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 +/*! + * \var lyx::FuncCode lyx::LFUN_COPY + * \li Action: Copies to the clipboard the last edit. * \li Syntax: copy + * \endvar */ { LFUN_COPY, "copy", ReadOnly, Edit }, -/** - * \var lyx::kb_action lyx::LFUN_CUT - * \li Action: Cuts to the clipboard +/*! + * \var lyx::FuncCode lyx::LFUN_CUT + * \li Action: Cuts to the clipboard. * \li Syntax: cut + * \endvar */ { LFUN_CUT, "cut", Noop, Edit }, -/** - * \var lyx::kb_action lyx::LFUN_PASTE - * \li Action: Pastes from the active clipboard +/*! + * \var lyx::FuncCode lyx::LFUN_PASTE + * \li Action: Pastes from the active clipboard. * \li Syntax: paste + * \endvar */ { 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 +/*! + * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE + * \li Action: Pastes the material currently selected. * \li Syntax: primary-selection-paste + * \endvar */ { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit }, -/** - * \var lyx::kb_action lyx::LFUN_UNDO - * \li Action: Undoes the last edit +/*! + * \var lyx::FuncCode lyx::LFUN_UNDO + * \li Action: Undoes the last edit. * \li Syntax: undo + * \endvar */ { LFUN_UNDO, "undo", Noop, Edit }, -/** - * \var lyx::kb_action lyx::LFUN_REDO - * \li Action: Redoes the last thing undone +/*! + * \var lyx::FuncCode lyx::LFUN_REDO + * \li Action: Redoes the last thing undone. * \li Syntax: redo + * \endvar */ { LFUN_REDO, "redo", Noop, Edit }, { LFUN_REPEAT, "repeat", NoBuffer, Edit }, @@ -322,91 +625,102 @@ 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 +/*! + * \var lyx::FuncCode lyx::LFUN_LAYOUT + * \li Action: Sets the layout (that is, environment) for the current paragraph. * \li Syntax: layout * \li Params: : the layout to use + * \endvar */ { LFUN_LAYOUT, "layout", Noop, Layout }, -/** - * \var lyx::kb_action lyx::LFUN_LAYOUT_PARAGRAPH - * \li Action: Launches the paragraph settings dialog +/*! + * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH + * \li Action: Launches the paragraph settings dialog. * \li Syntax: layout-paragraph + * \endvar */ { 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 +/*! + * \var lyx::FuncCode 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 + dropbox allowing for choice of layout. * \li Syntax: drop-layouts-choice + * \endvar */ { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout }, -/** - * \var lyx::kb_action lyx::LFUN_LAYOUT_MODULES_CLEAR - * \li Action: Clears the module list +/*! + * \var lyx::FuncCode 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 + * \endvar */ { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", Noop, Layout }, -/** - * \var lyx::kb_action lyx::LFUN_LAYOUT_MODULE_ADD - * \li Action: Adds a module +/*! + * \var lyx::FuncCode 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 + * \endvar */ { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", Noop, Layout }, -/** - * \var lyx::kb_action lyx::LFUN_LAYOUT_RELOAD - * \li Action: Reloads layout information +/*! + * \var lyx::FuncCode 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 + * \endvar */ { 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 +/*! + * \var lyx::FuncCode 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. + * \endvar */ { LFUN_TEXTCLASS_APPLY, "textclass-apply", Noop, Layout }, -/** - * \var lyx::kb_action lyx::LFUN_TEXTCLASS_LOAD - * \li Action: Loads information for a textclass from disk +/*! + * \var lyx::FuncCode 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. + * \endvar */ { LFUN_TEXTCLASS_LOAD, "textclass-load", Noop, Layout }, -/** - * \var lyx::kb_action lyx::LFUN_MARK_OFF +/*! + * \var lyx::FuncCode lyx::LFUN_MARK_OFF * \li Action: Disable selecting of text-region. * \li Syntax: mark-off + * \endvar */ { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit }, -/** - * \var lyx::kb_action lyx::LFUN_MARK_ON +/*! + * \var lyx::FuncCode 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 + * \endvar */ { LFUN_MARK_ON, "mark-on", ReadOnly, Edit }, -/** - * \var lyx::kb_action lyx::LFUN_MARK_TOGGLE - * \li Action: Toggle between MARK_ON and MARK_OFF +/*! + * \var lyx::FuncCode 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 + * \endvar */ { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit }, @@ -423,56 +737,61 @@ 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 +/*! + * \var lyx::FuncCode 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 + * \endvar */ { 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. +/*! + * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE + * \li Action: Toggles numbering/labeling of the current formula. * \li Notion: Must be in display formula mode. * \li Syntax: math-number-toggle * \li Origin: Alejandro 4 Jun 1996 + * \endvar */ { 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 +/*! + * \var lyx::FuncCode 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 + * \endvar */ { 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 +/*! + * \var lyx::FuncCode 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 + * \endvar */ { 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 +/*! + * \var lyx::FuncCode 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 + * \endvar */ { 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 +/*! + * \var lyx::FuncCode 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. @@ -480,133 +799,215 @@ void LyXAction::init() the first), defaults to the last one. * \li Syntax: math-macro-remove-param * \li Origin: sts, 06 January 2008 + * \endvar */ { 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 +/*! + * \var lyx::FuncCode 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 + * \endvar */ { 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 +/*! + * \var lyx::FuncCode 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 + * \endvar */ { 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 +/*! + * \var lyx::FuncCode 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 + * \endvar */ { 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 +/*! + * \var lyx::FuncCode 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 + * \endvar */ { 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 +/*! + * \var lyx::FuncCode 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 + * \endvar */ { 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 +/*! + * \var lyx::FuncCode 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 + * \endvar */ { 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 +/*! + * \var lyx::FuncCode 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 + * \endvar */ { 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 +/*! + * \var lyx::FuncCode 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 + * \endvar */ { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math }, +/*! + * \var lyx::FuncCode 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 + * \endvar + */ + { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit }, +/*! + * \var lyx::FuncCode 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 + * \endvar + */ + { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit }, + + { LFUN_PARAGRAPH_SPACING, "paragraph-spacing", Noop, Edit }, + { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit }, + { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit }, { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit }, { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit }, +/*! + * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO + * \li Action: Jump to a paragraph given by its id number. + * \li Notion: Note that id number of paragraph is not the sequential number of paragraph + seen on the screen. Moreover the id is unique for all opened buffers (documents). + * \li Syntax: paragraph-goto + * \li Origin: Dekel, 26 Aug 2000 + * \endvar + */ { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly, Edit }, -/** - * \var lyx::kb_action lyx::LFUN_OUTLINE_UP +/*! + * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH + * \li Action: Breaks the current paragraph at the current location. + * \li Syntax: break-paragraph + * \endvar + */ + { LFUN_BREAK_PARAGRAPH, "break-paragraph", Noop, Edit }, +/*! + * \var lyx::FuncCode 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 + * \endvar + */ + { LFUN_BREAK_PARAGRAPH_SKIP, "break-paragraph-skip", Noop, Edit }, +/*! + * \var lyx::FuncCode 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 + * \endvar + */ + { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit }, +/*! + * \var lyx::FuncCode 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 + * \endvar + */ + { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit }, + { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden }, + +/*! + * \var lyx::FuncCode 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 + * \endvar */ { LFUN_OUTLINE_UP, "outline-up", Noop, Edit }, -/** - * \var lyx::kb_action lyx::LFUN_OUTLINE_DOWN +/*! + * \var lyx::FuncCode 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 + * \endvar */ { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit }, -/** - * \var lyx::kb_action lyx::LFUN_OUTLINE_IN +/*! + * \var lyx::FuncCode 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 + * \endvar */ { LFUN_OUTLINE_IN, "outline-in", Noop, Edit }, -/** - * \var lyx::kb_action lyx::LFUN_OUTLINE_OUT +/*! + * \var lyx::FuncCode 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 + * \endvar */ { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit }, - { LFUN_PARAGRAPH_SPACING, "paragraph-spacing", Noop, Edit }, - { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit }, - { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit }, - { LFUN_EXTERNAL_EDIT, "external-edit", Noop, Edit }, { LFUN_GRAPHICS_EDIT, "graphics-edit", Noop, Edit }, @@ -631,99 +1032,208 @@ void LyXAction::init() { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit }, { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit }, +/*! + * \var lyx::FuncCode lyx::LFUN_INSET_APPLY + * \li Action: Apply data for an inset. + * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should + be applied. This is either changed to #LFUN_INSET_MODIFY or + #LFUN_INSET_INSERT depending on the context where it is called. + * \li Syntax: inset-apply + * \li Params: See #LFUN_INSET_INSERT . + * \endvar + */ { LFUN_INSET_APPLY, "inset-apply", Noop, Edit }, { LFUN_INSET_DISSOLVE, "inset-dissolve", Noop, Edit }, +/*! + * \var lyx::FuncCode lyx::LFUN_INSET_INSERT + * \li Action: Insert new inset (type given by the parameters). + * \li Syntax: inset-insert + * \li Params: : \n + : depends on the given inset. Use "lyx -dbg action" to + explore. + * \li Sample: inset-insert ref LatexCommand reference "