/*! * \file LyXAction.cpp * This file is part of LyX, the document processor. * Licence details can be found in the file COPYING. * * \author Lars Gullik Bjønnes * \author Jean-Marc Lasgouttes * \author John Levon * \author André Pönitz * \author Pavel Sanda * * Full author contact details are available in file CREDITS. */ #include #include "LyXAction.h" #include "FuncRequest.h" #include "support/debug.h" #include "support/lstrings.h" #include "support/lassert.h" #include using namespace std; using namespace lyx::support; namespace lyx { /* NAMING RULES FOR USER-COMMANDS Here's the set of rules to apply when a new command name is introduced: 1) Use the object.event order. That is, use `word-forward' instead of `forward-word'. 2) Don't introduce an alias for an already named object. Same for events. 3) Forward movement or focus is called `forward' (not `right'). 4) Backward movement or focus is called `backward' (not `left'). 5) Upward movement of focus is called `up'. 6) Downward movement is called `down'. 7) The begin of an object is called `begin' (not `start'). 8) The end of an object is called `end'. (May 19 1996, 12:04, RvdK) */ /* LFUN documentation * * The documentation below is primarily description of purpose and syntax * relating to the different LFUNs. * * Try to find an appropriate (thematical) place when adding the new LFUN * and don't forget to add doxygen commentary. * * Doxygen template below. Some notes: Parameters should be set in uppercase * and put in , [] means optional one. * * Use spaces for indentation (doxy -> .lyx generator is tab-sensitive). */ /*! * \var lyx::FuncCode lyx::LFUN_ * \li Action: * \li Notion: * \li Syntax: * \li Params: * \li Sample: * \li Origin: * \endvar */ LyXAction lyxaction; void LyXAction::newFunc(FuncCode action, string const & name, unsigned int attrib, LyXAction::FuncType type) { lyx_func_map[name] = action; FuncInfo tmpinfo; tmpinfo.name = name; tmpinfo.attrib = attrib; tmpinfo.type = type; lyx_info_map[action] = tmpinfo; } // Needed for LFUNs documentation to be accepted, since doxygen won't take // \var inside functions. #ifndef DOXYGEN_SHOULD_SKIP_THIS void LyXAction::init() { // This function was changed to use the array below in initalization // instead of calling newFunc numerous times because of compilation // times. Since the array is not static we get back the memory it // occupies after the init is completed. It compiles several // magnitudes faster. static bool init; if (init) return; struct ev_item { FuncCode action; char const * name; unsigned int attrib; FuncType type; }; 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 }, /*! * \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 }, /*! * \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 }, /*! * \var lyx::FuncCode lyx::LFUN_FLOAT_INSERT * \li Action: Inserts a float inset. * \li Syntax: float-insert * \li Params: : type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given. * \li Origin: Lgb, 27 Jun 2000 * \endvar */ { LFUN_FLOAT_INSERT, "float-insert", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_FLOAT_WIDE_INSERT * \li Action: Inserts float insets as in #LFUN_FLOAT_INSERT but span multiple columns. * \li Notion: Corresponds to the starred floats (figure*, table*, etc.) in LaTeX. * \li Syntax: float-wide-insert * \li Params: : type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given. * \li Origin: Lgb, 31 Oct 2001 * \endvar */ { LFUN_FLOAT_WIDE_INSERT, "float-wide-insert", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_FLOAT_LIST_INSERT * \li Action: Inserts the list of floats in the document. * \li Syntax: float-list-insert * \li Params: : type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given. * \li Origin: Lgb, 3 May 2001 * \endvar */ { LFUN_FLOAT_LIST_INSERT, "float-list-insert", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_WRAP_INSERT * \li Action: Inserts floats wrapped by the text around. * \li Syntax: wrap-insert * \li Params: : table|figure * \li Origin: Dekel, 7 Apr 2002 * \endvar */ { LFUN_WRAP_INSERT, "wrap-insert", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_ARGUMENT_INSERT * \li Action: Inserts an argument (short title) inset. * \li Syntax: argument-insert * \li Origin: vermeer, 12 Aug 2002 * \endvar */ { LFUN_ARGUMENT_INSERT, "argument-insert", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_NEWPAGE_INSERT * \li Action: Inserts a new page. * \li Syntax: newpage-insert * \li Params: : default: newpage * \li Origin: uwestoehr, 24 Nov 2007 * \endvar */ { LFUN_NEWPAGE_INSERT, "newpage-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. * \li Sample: 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 }, /*! * \var lyx::FuncCode lyx::LFUN_PREVIEW_INSERT * \li Action: Inserts a new preview inset. * \li Syntax: preview-insert * \li Origin: vfr, 28 Mar 2010 * \endvar */ { LFUN_PREVIEW_INSERT, "preview-insert", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_TAB_INSERT * \li Action: Insert a tab into a listings inset. * \li Notion: It also works on a selection. * \li Syntax: tab-insert * \li Origin: vfr, Sep 30 2008 * \endvar */ { LFUN_TAB_INSERT, "tab-insert", SingleParUpdate, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_TAB_DELETE * \li Action: Delete a tab or up to an equivalent amount of spaces from a listings inset. * \li Notion: It also works on a selection - it removes a tab or spaces from the beginning of each line spanned by the selection. This is useful if you want to indent/unindent multiple lines in one action. * \li Syntax: tab-delete * \li Origin: vfr, Sep 30 2008 * \endvar */ { LFUN_TAB_DELETE, "tab-delete", SingleParUpdate, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_QUOTE_INSERT * \li Action: Inserts quotes according to the type and quote-language preference. * \li Notion: Currently English, Swedish, German, Polish, French, Danish quotes are distinguished. * \li Syntax: quote-insert [] * \li Params: : 'single' for single quotes, otherwise double quotes will be used. * \endvar */ { LFUN_QUOTE_INSERT, "quote-insert", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_INFO_INSERT * \li Action: Displays shortcuts, lyxrc, package and textclass availability and menu information in a non-editable boxed InsetText. * \li Notion: Apart from lfun arguments you can use the following method: \n 1. input the type and argument of this inset, e.g. "menu paste", in the work area.\n 2. select the text and run info-insert lfun. * \li Syntax: info-insert * \li Params: : shortcut[s]|lyxrc|lyxinfo|package|textclass|menu|buffer \n : argument for a given type. Look into InsetInfo.h for detailed description. \n shortcut[s]: name of lfun (e.g math-insert \alpha) \n lyxrc: name of rc_entry (e.g. bind_file) \n lyxinfo: "version" - used version of LyX \n package: name of latex package (e.g. listings) \n textclass: name of textclass (e.g. article) \n menu: name of lfun used in menu \n icon: icon of lfun used in toolbar \n buffer: "name"|"path"|"class"|"vcs-tree-revision"| "vcs-revision"|"vcs-author"|"vcs-date"|"vcs-time" * \li Sample: command-sequence info-insert buffer path; info-insert buffer name * \li Origin: bpeng, 7 Oct 2007 * \endvar */ { LFUN_INFO_INSERT, "info-insert", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_BRANCH_INSERT * \li Action: Inserts branch inset. * \li Syntax: branch-insert * \li Origin: vermeer, 17 Aug 2003 * \endvar */ { LFUN_BRANCH_INSERT, "branch-insert", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_BOX_INSERT * \li Action: Inserts Box inset. * \li Syntax: box-insert [] * \li Params: : Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox \n Framed is the default one. * \li Origin: vermeer, 7 Oct 2003 * \endvar */ { 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 To make this command enabled the layout file for the document class you're using has to load the character styles. There are a few contained in the Logical Markup module. You can also of course create some yourself. \n For dissolving the element see #LFUN_INSET_DISSOLVE. * \li Syntax: flex-insert Name * \li Params: Name: This name must be defined either in your layout file or imported by some module. The definition is InsetLayout Name or InsetLayout . The Flex: prefix is optional. * \li Sample: flex-insert Code * \endvar */ { LFUN_FLEX_INSERT, "flex-insert", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_SELF_INSERT * \li Action: Inserts the given string (accordingly to the correct keymap). * \li Notion: Automatically replace the currently selected text. Depends on lyxrc settings "auto_region_delete". * \li Syntax: self-insert * \endvar */ { 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, visible, thin, quad, qquad, enspace, enskip, negthinspace, negmedspace, negthickspace, hfill, hfill*, dotfill, hrulefill, hspace, hspace* \n Only in math mode: med and thick.\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 }, /*! * \var lyx::FuncCode lyx::LFUN_HYPERLINK_INSERT * \li Action: Inserts hyperlinks into the document (clickable in pdf output). * \li Notion: Hyperlink target can be set via selection + hyperlink-insert function. * \li Syntax: href-insert [] * \li Origin: CFO-G, 21 Nov 1997 * \endvar */ { 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 }, /*! * \var lyx::FuncCode lyx::LFUN_SCRIPT_INSERT * \li Action: Inserts a subscript or superscript inset. * \li Syntax: script-insert * \li Params: : subscript|superscript * \li Origin: Georg, 23 Nov 2010 * \endvar */ { LFUN_SCRIPT_INSERT, "script-insert", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_APPENDIX * \li Action: Start (or remove) Appendix on the given cursor position. * \li Syntax: appendix * \li Origin: ettrich, 5 May 1998 * \endvar */ { LFUN_APPENDIX, "appendix", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_INDEX_INSERT * \li Action: Inserts Index entry. * \li Notion: It automatically takes the word on the cursor position. * \li Syntax: index-insert [] * \li Params: : name of the index, if multiple indices are defined. with an empty argument, the default index is selected. * \li Origin: leeming, 3 Aug 2000 * \endvar */ { LFUN_INDEX_INSERT, "index-insert", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_INDEX_PRINT * \li Action: Inserts list of Index entries on a new page. * \li Syntax: index-print [] * \li Params: : name of the index, if multiple indices are defined. with an empty argument, the default index is selected. * \li Origin: Lgb, 27 Feb 1997 * \endvar */ { LFUN_INDEX_PRINT, "index-print", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_IPA_INSERT * \li Action: Inserts an IPA inset. * \li Syntax: ipa-insert * \li Origin: spitz, 05 Mar 2012 * \endvar */ { LFUN_IPA_INSERT, "ipa-insert", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_NOMENCL_INSERT * \li Action: Inserts Nomenclature entry. * \li Notion: It automatically takes the word on the cursor position if no symbol is given. * \li Syntax: nomencl-insert [] * \li Origin: Ugras, 4 Nov 2006 * \endvar */ { LFUN_NOMENCL_INSERT, "nomencl-insert", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_NOMENCLATURE_PRINT * \li Action: Inserts list of Nomenclature entries. * \li Syntax: nomenclature-print * \li Origin: Ugras, 4 Nov 2006 * \endvar */ { LFUN_NOMENCL_PRINT, "nomencl-print", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_NOTE_INSERT * \li Action: Inserts Note on the current cursor postion, move selection inside the inset. * \li Syntax: note-insert [] * \li Params: : default: Note * \endvar */ { LFUN_NOTE_INSERT, "note-insert", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_NOTE_NEXT * \li Action: Moves the cursor to the begining of next Note inset. * \li Syntax: note-next * \endvar */ { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_PHANTOM_INSERT * \li Action: Inserts phantom on the current cursor postion, move selection inside the inset. * \li Syntax: phantom-insert [] * \li Params: : default: Phantom * \li Origin: uwestoehr, 30 Jan 2009 * \endvar */ { LFUN_PHANTOM_INSERT, "phantom-insert", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_NEWLINE_INSERT * \li Action: Inserts a line break or new line. * \li Syntax: newline-insert [] * \li Params: : default: newline * \li Origin: JSpitzm, 25 Mar 2008 * \endvar */ { LFUN_NEWLINE_INSERT, "newline-insert", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_ESCAPE * \li Action: Clears the selection. If no text is selected call #LFUN_FINISHED_FORWARD. Inside math mode jumps out of the math inset. * \li Syntax: escape * \li Origin: Lgb, 17 May 2001 * \endvar */ { LFUN_ESCAPE, "escape", ReadOnly, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_DOWN * \li Action: Moves the cursor one line in downward direction. * \li Syntax: down * \endvar */ { LFUN_DOWN, "down", ReadOnly | NoUpdate, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_UP * \li Action: Moves the cursor one line in upward direction. * \li Syntax: up * \endvar */ { LFUN_UP, "up", ReadOnly | NoUpdate, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_DOWN_SELECT * \li Action: Moves the cursor one line in downward direction adding the current position to the selection. * \li Syntax: down-select * \endvar */ { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_UP_SELECT * \li Action: Moves the cursor one line in upward direction adding the current position to the selection. * \li Syntax: up-select * \endvar */ { LFUN_UP_SELECT, "up-select", ReadOnly | SingleParUpdate, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN * \li Action: Moves the cursor one page in downward direction. * \li Syntax: screen-down * \endvar */ { LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_SCREEN_UP * \li Action: Moves the cursor one page in upward direction. * \li Syntax: screen-up * \endvar */ { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN_SELECT * \li Action: Moves the cursor one screen in downward direction adding the current position to the selection. * \li Syntax: screen-down-select * \endvar */ { LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_SCREEN_UP_SELECT * \li Action: Moves the cursor one page in upward direction adding the current position to the selection. * \li Syntax: screen-up-select * \endvar */ { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit }, /*! * \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| * \li Origin: Abdel, Dec 27 2007 * \endvar */ { LFUN_SCROLL, "scroll", ReadOnly, Edit }, /*! * \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 }, /*! * \var lyx::FuncCode lyx::LFUN_SCREEN_SHOW_CURSOR * \li Action: Repositions the screen such that the cursor is visible. * \li Syntax: screen-show-cursor * \li Origin: vfr, 25 Mar 2009 * \endvar */ { LFUN_SCREEN_SHOW_CURSOR, "screen-show-cursor", 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 }, /*! * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_BACKWARD * \li Action: Deletes one character in the backward direction (usually the "BackSpace" key). * \li Syntax: char-delete-backward * \endvar */ { LFUN_CHAR_DELETE_BACKWARD, "char-delete-backward", SingleParUpdate, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_FORWARD * \li Action: Deletes one character in the backward direction (usually the "Delete" key). * \li Syntax: char-delete-forward * \endvar */ { LFUN_CHAR_DELETE_FORWARD, "char-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 }, /*! * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD * \li Action: Moves the cursor to the logically previous beginning of a word. * \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_WORD_LEFT or #LFUN_WORD_RIGHT actions, which in turn may employ this one. * \li Syntax: word-backward * \endvar */ { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD_SELECT * \li Action: Moves the cursor to the logically previous beginning of a word, adding the logically traversed text to the selection. * \li Notion: See also #LFUN_WORD_BACKWARD. * \li Syntax: word-backward-select * \endvar */ { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_BACKWARD * \li Action: Deletes characters to the begining of the word (usually the "C+BackSpace" key). * \li Syntax: word-delete-backward * \endvar */ { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_FORWARD * \li Action: Deletes characters to the end of the word (usually the "C+Delete" key). * \li Syntax: word-delete-forward * \endvar */ { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_WORD_FIND_FORWARD * \li Action: Search for a given string in forward direction. * \li Notion: Case sensitive, match words. If no argument given, last search repeated. * \li Syntax: word-find-forward [] * \li Origin: Etienne, 16 Feb 1998 * \endvar */ { LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_WORD_FIND_BACKWARD * \li Action: Search for a given string in backward direction. * \li Notion: Case sensitive, match words. If no argument given, last search repeated. * \li Syntax: word-find-backward [] * \li Origin: Etienne, 20 Feb 1998 * \endvar */ { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_WORD_FIND * \li Action: Search for next occurence of a string. * \li Syntax: word-find [] * \li Params: : data encoded from Find dialog (see #lyx::find2string()). If no parameter is given, search with last find-dialog data is used for search (i.e. find-next). * \li Origin: Andre, Jan 7 2004 * \endvar */ { LFUN_WORD_FIND, "word-find", ReadOnly, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_WORD_REPLACE * \li Action: Replace a string in the document. * \li Syntax: word-replace [] * \li Params: : data is of the form " \n \n " * \li Origin: Andre, Jan 7 2004 * \endvar */ { LFUN_WORD_REPLACE, "word-replace", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_WORD_FINDADV * \li Action: Search for next occurence of a pattern. * \li Syntax: word-findadv [] * \li Params: : data encoded from FindAdv dialog (see #lyx::findadv2string()). If no parameter is given, search with last find-dialog data is used for search (i.e. find-next). * \li Origin: Tommaso, Nov 15 2007 * \endvar */ { LFUN_WORD_FINDADV, "word-findadv", ReadOnly | NoBuffer, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD * \li Action: Moves the cursor to the logically next beginning of a word. * \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_WORD_LEFT or #LFUN_WORD_RIGHT actions, which in turn may employ this one. * \li Syntax: word-forward * \endvar */ { LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD_SELECT * \li Action: Moves the cursor to the logically next beginning of a word, adding the logically traversed text to the selection. * \li Notion: See also #LFUN_WORD_FORWARD. * \li Syntax: word-forward-select * \endvar */ { LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_WORD_LEFT * \li Action: Moves the cursor to the next beginning of a word "on the left". * \li Notion: This is the action which should be taken when the (e.g., ctrl-) "left" key is pressed. Generally, it moves the cursor to the next beginning of a word on the left. However, in Bidi text this 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: word-left * \li Origin: dov, 28 Oct 2007 * \endvar */ { LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_WORD_LEFT_SELECT * \li Action: Moves the cursor to the next beginning of a word "on the left", adding *logically* traversed text to the selection. * \li Notion: See also #LFUN_WORD_LEFT for exact details of the movement. * \li Syntax: word-left-select * \li Origin: dov, 28 Oct 2007 * \endvar */ { LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT * \li Action: Moves the cursor to the next beginning of a word "on the right". * \li Notion: This is the action which should be taken when the (e.g., ctrl-) "right" key is pressed. Generally, it moves the cursor to the next beginning of a word on the right. However, in Bidi text 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: word-right * \li Origin: dov, 28 Oct 2007 * \endvar */ { LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT_SELECT * \li Action: Moves the cursor to the next beginning of a word "on the right", adding *logically* traversed text to the selection. * \li Notion: See also #LFUN_WORD_RIGHT for exact details of the movement. * \li Syntax: word-right-select * \li Origin: dov, 28 Oct 2007 * \endvar */ { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_WORD_SELECT * \li Action: Puts the word where the cursor stands into the selection. * \li Syntax: word-select * \li Origin: Andre, 11 Sep 2002 * \endvar */ { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_WORD_CAPITALIZE * \li Action: Capitalizes the words in the selection (i.e. the first letters) or the letter on the cursor position. * \li Syntax: word-capitalize * \endvar */ { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_WORD_UPCASE * \li Action: Change the words in the selection or from the cursor position to the end of word to the upper case. * \li Syntax: word-upcase * \endvar */ { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_WORD_LOWCASE * \li Action: Change the words in the selection or from the cursor position to the end of word to the lower case. * \li Syntax: word-lowcase * \endvar */ { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_SPELLING_ADD * \li Action: Add the word under the cursor to the respective * spell checker dictionary. * \li Syntax: spelling-add [] [] * \li Params: : word to add : language name (see file languages) * \li Origin: JSpitzm, 18 Jan 2010 * \endvar */ { LFUN_SPELLING_ADD, "spelling-add", ReadOnly, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_SPELLING_IGNORE * \li Action: Let the spell checker ignore the word under the cursor * in the current session for the given language. * \li Syntax: spelling-ignore [] [] * \li Params: : word to ignore : language name (see file languages) * \li Origin: JSpitzm, 18 Jan 2010 * \endvar */ { LFUN_SPELLING_IGNORE, "spelling-ignore", ReadOnly, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_SPELLING_REMOVE * \li Action: Remove the word under the cursor from the respective * spell checker dictionary. * \li Syntax: spelling-remove [] [] * \li Params: : word to remove : language name (see file languages) * \li Origin: SWitt, 28 July 2010 * \endvar */ { LFUN_SPELLING_REMOVE, "spelling-remove", ReadOnly, Edit }, /*! * \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 [] [lang=] * \li Params: : word to look up : language (see file languages) * \li Origin: Levon, 20 Jul 2001 * \endvar */ { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN * \li Action: Move the cursor to the beginning of the document. * \li Syntax: buffer-begin * \endvar */ { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN_SELECT * \li Action: Move the cursor to the beginning of the document adding the traversed text to the selection. * \li Syntax: buffer-begin-select * \endvar */ { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_BUFFER_END * \li Action: Move the cursor to the end of the document. * \li Syntax: buffer-end * \endvar */ { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_BUFFER_END_SELECT * \li Action: Move the cursor to the end of the document adding the traversed text to the selection. * \li Syntax: buffer-end-select * \endvar */ { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN * \li Action: Move the cursor to the beginning of the current inset if it is not already there, or at the beginning of the enclosing inset otherwise * \li Syntax: inset-begin * \li Origin: lasgouttes, 16 Mar 2009 * \endvar */ { LFUN_INSET_BEGIN, "inset-begin", ReadOnly, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN_SELECT * \li Action: Move the cursor to the beginning of the current inset if it is not already there, or at the beginning of the enclosing inset otherwise (adding the traversed text to the selection). * \li Syntax: inset-begin-select * \li Origin: lasgouttes, 16 Mar 2009 * \endvar */ { LFUN_INSET_BEGIN_SELECT, "inset-begin-select", ReadOnly, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_INSET_END * \li Action: Move the cursor to the end of the current inset if it is not already there, or at the end of the enclosing inset otherwise * \li Syntax: inset-end * \li Origin: lasgouttes, 16 Mar 2009 * \endvar */ { LFUN_INSET_END, "inset-end", ReadOnly, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_INSET_END_SELECT * \li Action: Move the cursor to the end of the current inset if it is not already there, or at the end of the enclosing inset otherwise (adding the traversed text to the selection). * \li Syntax: inset-end-select * \li Origin: lasgouttes, 16 Mar 2009 * \endvar */ { LFUN_INSET_END_SELECT, "inset-end-select", ReadOnly, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_INSET_SELECT_ALL * \li Action: Selects all contents of an inset. * \li Syntax: inset-select-all * \li Origin: vfr, 22 Aug 2009 * \endvar */ { LFUN_INSET_SELECT_ALL, "inset-select-all", ReadOnly, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_SECTION_SELECT * \li Action: Selects the whole section. * \li Notion: The cursor should be in a section heading before calling this lfun. * \li Syntax: section-select * \li Origin: vfr, 05 May 2009 * \endvar */ { LFUN_SECTION_SELECT, "section-select", ReadOnly, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN * \li Action: Move the cursor to the begining of the (screen) line. * \li Syntax: line-begin * \endvar */ { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN_SELECT * \li Action: Move the cursor to the beginning of the (screen) line adding the traversed text to the selection. * \li Syntax: line-begin-select * \endvar */ { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_LINE_END * \li Action: Move the cursor to the end of the (screen) line. * \li Syntax: line-end * \endvar */ { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_LINE_END_SELECT * \li Action: Move the cursor to the end of the (screen) line adding the traversed text to the selection. * \li Syntax: line-end-select * \endvar */ { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_LINE_DELETE * \li Action: Deletes the letters to the end of the (screen) line or deletes the selection. * \li Syntax: line-delete-forward * \endvar */ { LFUN_LINE_DELETE, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward /*! * \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::FuncCode lyx::LFUN_CUT * \li Action: Cuts to the clipboard. * \li Syntax: cut * \endvar */ { LFUN_CUT, "cut", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_PASTE * \li Action: Pastes material (text or picture) from the active clipboard. * \li Syntax: paste [|] * \li Params: : emf|pdf|png|jpeg|linkback|wmf \n : number of the selection in the internal clipboard stack to be pasted. * \endvar */ { LFUN_PASTE, "paste", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE * \li Action: Pastes text from the active clipboard. * \li Syntax: clipboard-paste [] * \li Params: : "paragraph" will cause pasting as one paragraph, i.e. "Join lines". * \li Origin: Georg, 10 Jul 2006 * \endvar */ { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE * \li Action: Pastes the currently selected text. * \li Notion: Primary selection mechanism is linux-only thing. * \li Syntax: primary-selection-paste [] * \li Params: : "paragraph" will cause pasting as one paragraph, i.e. "Join lines". * \endvar */ { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_SELECTION_PASTE * \li Action: Pastes the internal selection text in permanent selection. * \li Notion: Created in order to have middle mouse button pasting correct (bound to command-alternatives selection-paste ; primary-selection-paste paragraph). * \li Syntax: selection-paste * \li Origin: lasgouttes, 14 Jan 2009 * \endvar */ { LFUN_SELECTION_PASTE, "selection-paste", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE_SIMPLE * \li Action: Pastes simple unformatted text from the active clipboard. * \li Syntax: clipboard-paste-simple [] * \li Params: : "paragraph" will cause pasting as one paragraph, i.e. "Join lines". * \endvar */ { LFUN_CLIPBOARD_PASTE_SIMPLE, "clipboard-paste-simple", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_UNDO * \li Action: Undoes the last edit. * \li Syntax: undo * \endvar */ { LFUN_UNDO, "undo", ReadOnly, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_REDO * \li Action: Redoes the last thing undone. * \li Syntax: redo * \endvar */ { LFUN_REDO, "redo", ReadOnly, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_REPEAT * \li Action: Repeat the given command. * \li Syntax: repeat * \li Origin: Andre, 27 Oct 2003 * \endvar */ { LFUN_REPEAT, "repeat", NoBuffer, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_CHARS_TRANSPOSE * \li Action: Transposes the character at the cursor with the one before it. * \li Syntax: chars-transpose * \li Origin: Lgb, 25 Apr 2001 * \endvar */ { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_DEPTH_DECREMENT * \li Action: Decrease the nesting depth of the (selected) paragraph(s) inside lists. * \li Syntax: depth-decrement * \endvar */ { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_DEPTH_INCREMENT * \li Action: Increase the nesting depth of the (selected) paragraph(s) inside lists. * \li Syntax: depth-increment * \endvar */ { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_FONT_BOLD * \li Action: Toggles the bold font (selection-wise) using mathbf in math. * \li Syntax: font-bold * \endvar */ { LFUN_FONT_BOLD, "font-bold", Noop, Layout }, /*! * \var lyx::FuncCode lyx::LFUN_FONT_BOLDSYMBOL * \li Action: Toggles the bold font (selection-wise) using boldsymbol in math. * \li Syntax: font-boldsymbol * \endvar */ { LFUN_FONT_BOLDSYMBOL, "font-boldsymbol", Noop, Layout }, /*! * \var lyx::FuncCode lyx::LFUN_FONT_TYPEWRITER * \li Action: Toggles the typewriter family font (selection-wise). * \li Syntax: font-typewriter * \endvar */ { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout }, /*! * \var lyx::FuncCode lyx::LFUN_FONT_UNDERLINE * \li Action: Toggles underline in the font (selection-wise). * \li Syntax: font-underline * \endvar */ { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout }, /*! * \var lyx::FuncCode lyx::LFUN_FONT_UULINE * \li Action: Toggles double underline in the font (selection-wise). * \li Syntax: font-underunderline * \li Origin: sanda, 5 May 2009 * \endvar */ { LFUN_FONT_UULINE, "font-underunderline", Noop, Layout }, /*! * \var lyx::FuncCode lyx::LFUN_FONT_UWAVE * \li Action: Toggles wavy underline in the font (selection-wise). * \li Syntax: font-underwave * \li Origin: sanda, 5 May 2009 * \endvar */ { LFUN_FONT_UWAVE, "font-underwave", Noop, Layout }, /*! * \var lyx::FuncCode lyx::LFUN_FONT_STRIKEOUT * \li Action: Toggles strikeout (strike-through) in the font (selection-wise). * \li Syntax: font-strikeout * \li Origin: sanda, 3 May 2009 * \endvar */ { LFUN_FONT_STRIKEOUT, "font-strikeout", Noop, Layout }, /*! * \var lyx::FuncCode lyx::LFUN_FONT_EMPH * \li Action: Toggles the emphasis font style (selection-wise). * \li Syntax: font-emph * \endvar */ { LFUN_FONT_EMPH, "font-emph", Noop, Layout }, /*! * \var lyx::FuncCode lyx::LFUN_FONT_NOUN * \li Action: Toggles Noun text style font (selection-wise). * \li Syntax: font-noun * \endvar */ { LFUN_FONT_NOUN, "font-noun", Noop, Layout }, /*! * \var lyx::FuncCode lyx::LFUN_FONT_ROMAN * \li Action: Toggles Roman family font (selection-wise). * \li Syntax: font-roman * \endvar */ { LFUN_FONT_ROMAN, "font-roman", Noop, Layout }, /*! * \var lyx::FuncCode lyx::LFUN_FONT_SANS * \li Action: Toggles Sans Serif family font (selection-wise). * \li Syntax: font-sans * \endvar */ { LFUN_FONT_SANS, "font-sans", Noop, Layout }, /*! * \var lyx::FuncCode lyx::LFUN_FONT_FRAK * \li Action: Toggles Fraktur family font (math-mode, selection-wise). * \li Syntax: font-frak * \li Origin: vermeer, 10 Jan 2002 * \endvar */ { LFUN_FONT_FRAK, "font-frak", Noop, Layout }, /*! * \var lyx::FuncCode lyx::LFUN_FONT_ITAL * \li Action: Toggles Italics font shape (math-mode, selection-wise). * \li Syntax: font-ital * \li Origin: vermeer, 10 Jan 2002 * \endvar */ { LFUN_FONT_ITAL, "font-ital", Noop, Layout }, /*! * \var lyx::FuncCode lyx::LFUN_FONT_DEFAULT * \li Action: Reverts the settings of the font to the default values (selection-wise). * \li Syntax: font-default * \endvar */ { LFUN_FONT_DEFAULT, "font-default", Noop, Layout }, /*! * \var lyx::FuncCode lyx::LFUN_FONT_SIZE * \li Action: Sets font size according to lyx format string. * \li Syntax: font-size * \li Params: : tiny|scriptsize|footnotesize|small|normal|large|larger|\n largest|huge|giant|increase|decrease|default * \endvar */ { LFUN_FONT_SIZE, "font-size", Noop, Layout }, /*! * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_APPLY * \li Action: Toggle user-defined (=last-time used) text style. * \li Notion: This style is set via #LFUN_TEXTSTYLE_UPDATE, which is automatically trigerred when using Text Style dialog. * \li Syntax: textstyle-apply * \li Origin: leeming, 12 Mar 2003 * \endvar */ { LFUN_TEXTSTYLE_APPLY, "textstyle-apply", Noop, Layout }, /*! * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_UPDATE * \li Action: Apply text style and update the settings to be used by #LFUN_TEXTSTYLE_APPLY. * \li Syntax: textstyle-update * \li Params: : specifies font atributes, e.g. family, series, shape, size, emph, noun, underbar, number, color, language, toggleall.\n Use lyx -dbg action for exact syntax of text-style dialog parameters. * \li Origin: leeming, 12 Mar 2003 * \endvar */ { LFUN_TEXTSTYLE_UPDATE, "textstyle-update", Noop, Layout }, /*! * \var lyx::FuncCode lyx::LFUN_SCREEN_FONT_UPDATE * \li Action: Update fonts and its metrics. * \li Notion: Automatically called after zoom, dpi, font names, or norm change. * \li Syntax: screen-font-update * \li Origin: ARRae, 13 Aug 2000 * \endvar */ { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout }, /*! * \var lyx::FuncCode lyx::LFUN_FONT_STATE * \li Action: Returns the info about the current font. * \li Syntax: font-state * \endvar */ { LFUN_FONT_STATE, "font-state", ReadOnly, Layout }, /*! * \var lyx::FuncCode lyx::LFUN_CITATION_INSERT * \li Action: Inserts citation from loaded citation database. * \li Syntax: citation-insert [[|]] * \li Params: : Citation (shortcut listed in available citations). \n : text which should appear before citation. * \li Origin: AAS, 97-02-23 * \endvar */ { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_ADD * \li Action: Adds database, which will be used for bibtex citations. * \li Notion: Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor postion. * \li Syntax: bibtex-database-add * \li Origin: Ale, 30 May 1997 * \endvar */ { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_DEL * \li Action: Adds database, which will be used for bibtex citations. * \li Notion: Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor postion. * \li Syntax: bibtex-database-del * \li Origin: Ale, 30 May 1997 * \endvar */ { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit }, /*! * \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::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH * \li Action: Launches the paragraph settings dialog. * \li Syntax: layout-paragraph * \endvar */ { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout }, /*! * \var lyx::FuncCode lyx::LFUN_LAYOUT_TABULAR * \li Action: Launches the tabular settings dialog. * \li Syntax: layout-tabular * \li Origin: Jug, 31 Jul 2000 * \endvar */ { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout }, /*! * \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. * \li Syntax: drop-layouts-choice * \endvar */ { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout }, /*! * \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", NoInternal, Layout }, /*! * \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", NoInternal, Layout }, /*! * \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", NoInternal, Layout }, /*! * \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", NoInternal, Layout }, /*! * \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", NoInternal, Layout }, /*! * \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::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::FuncCode lyx::LFUN_MARK_TOGGLE * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF . * \li Syntax: mark-toggle * \li Origin: Andre, May 5 2006 * \endvar */ { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_MATH_DELIM * \li Action: Inserts math delimiters (e.g. parentheses, brackets) enclosing expression. * \li Syntax: math-delim [] [] * \li Params: : Delimiters to be used. Each delimiter can be specified by either a LaTeX name or a valid character. ( is the default letter. * \li Sample: math-delim { rangle * \li Origin: Alejandro, 18 Jun 1996 * \endvar */ { LFUN_MATH_DELIM, "math-delim", Noop, Math }, /*! * \var lyx::FuncCode lyx::LFUN_MATH_BIGDELIM * \li Action: Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression. * \li Syntax: math-bigdelim * \li Params: : bigl/r|Bigl/r|biggl/r|Biggl/r \n : TeX code for delimiter. See Delimiter dialog for delimiters to be used. * \li Sample: math-bigdelim "Bigl" "\Downarrow" "Bigr" "\}" * \li Origin: Enrico & Georg, 7 May 2006 * \endvar */ { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math }, /*! * \var lyx::FuncCode lyx::LFUN_MATH_DISPLAY * \li Action: Creates a new displayed equation in text mode. Toggles inlined/display formula in math mode. * \li Syntax: math-display [] * \li Params: : this argument will be passed to #LFUN_MATH_INSERT when creating new equation from the text mode. * \li Origin: Alejandro, 18 Jun 1996 * \endvar */ { LFUN_MATH_DISPLAY, "math-display", Noop, Math }, /*! * \var lyx::FuncCode lyx::LFUN_MATH_INSERT * \li Action: Inserts math objects and symbols. * \li Syntax: math-insert * \li Params: : Symbol or LaTeX code to be inserted. * \li Notion: When is a _single_ math inset with more than one cell (such as "x_y^z" or "\frac{x}{y}"), the content of cell(0) is replaced by the current selection (only works if the selection is in mathed). As an example, if "abc" is selected in mathed, "math-insert \frac{x}{y}" replaces "abc" with "\frac{abc}{y}", and "math-insert x_y^z" replaces "abc" with "abc_y^z". If nothing is selected (or the selection is not in mathed), math-insert works as expected. * \endvar */ { LFUN_MATH_INSERT, "math-insert", Noop, Math }, /*! * \var lyx::FuncCode lyx::LFUN_MATH_SUBSCRIPT * \li Action: Enters subscript expression in math expression. * \li Syntax: math-subscript * \li Origin: vermeer, 12 Dec 2001 * \endvar */ { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math }, /*! * \var lyx::FuncCode lyx::LFUN_MATH_SUPERSCRIPT * \li Action: Enters superscript expression in math expression. * \li Syntax: math-superscript * \li Origin: vermeer, 12 Dec 2001 * \endvar */ { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math }, /*! * \var lyx::FuncCode lyx::LFUN_MATH_LIMITS * \li Action: Toggles the position of the limits from above/below to the right side an vice versa in integral symbol, a limit, a summation, etc. * \li Notion: Put the cursor before the symbol with the limits and then invoke math-limits. * \li Syntax: math-limits [] * \li Params: : limits|nolimits * \endvar */ { LFUN_MATH_LIMITS, "math-limits", Noop, Math }, /*! * \var lyx::FuncCode lyx::LFUN_MATH_MACRO * \li Action: Inserts a math macro definition at the cursor position in the text. * \li Syntax: math-macro [] [def] * \li Params: : The name of the macro, e.g. "mymacro".\n : The number of parameters of the macro. Default is 0. "def": Has no effect anymore, just for compatibility with former LyX versions. * \li Origin: ale, 10 May 1997; sts, 21 Dec 2007 * \endvar */ { LFUN_MATH_MACRO, "math-macro", Noop, Math }, /*! * \var lyx::FuncCode lyx::LFUN_MATH_MUTATE * \li Action: Mutates the type of math inset to the newly selected one. * \li Syntax: math-mutate * \li Params: : none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat| multline|gather|flalign * \li Origin: Andre, 23 May 2001 * \endvar */ { LFUN_MATH_MUTATE, "math-mutate", Noop, Math }, /*! * \var lyx::FuncCode lyx::LFUN_MATH_SPACE * \li Action: Inserts space into math expression. * \li Notion: Use spacebar after entering this space to change type of space. * \li Syntax: math-space [] [] * \li Params: : negative spaces: !|negthinspace|negmedspace|negthickspace \n positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad \n custom space: hspace \n "," used by default.\n Note that ! is equivalent to negthinspace, , = thinspace, : = medspace, and ; = thickspace.\n : length for custom spaces (hspace) * \li Origin: Andre, 25 Jul 2001; sanda, 16 Jun 2008 * \endvar */ { LFUN_MATH_SPACE, "math-space", Noop, Math }, /*! * \var lyx::FuncCode lyx::LFUN_MATH_MATRIX * \li Action: Inserts a matrix. * \li Syntax: math-matrix [] * \li Params: : Alignment is a word composed of the vertical alignment (b, c or t) (i.e. 1 char) and the horizontal alignments (l, c or r) (i.e. chars). * \li Sample: math-matrix 3 3 bccc * \endvar */ { LFUN_MATH_MATRIX, "math-matrix", Noop, Math }, /*! * \var lyx::FuncCode lyx::LFUN_MATH_AMS_MATRIX * \li Action: Inserts a matrix. * \li Syntax: math-matrix [] * \li Params: : Decoration determines the LaTeX name of the matrix that should be created. * \li Sample: math-ams-matrix 3 3 bmatrix * \endvar */ { LFUN_MATH_AMS_MATRIX, "math-ams-matrix", Noop, Math }, /*! * \var lyx::FuncCode lyx::LFUN_MATH_MODE * \li Action: In text mode enters math mode (i.e. puts math insets on the current cursor position), in math mode enters text mode inside math expression. * \li Notion: If there is some selected text, it puts the text inside created math box. * \li Syntax: math-mode [on|] * \li Params: : eventual argument (LaTeX code) is passed to #LFUN_MATH_INSERT .\n "on": allow only entering of math mode from text mode. * \li Origin: Alejandro, 4 Jun 1996 * \endvar */ { LFUN_MATH_MODE, "math-mode", Noop, Math }, /*! * \var lyx::FuncCode lyx::LFUN_REGEXP_MODE * \li Action: Enters regexp mode (i.e., puts regexp insets on the current cursor position). Used by the advanced search dialog. * \li Notion: If there is any selected text, then it is moved inside the created regexp inset. * \li Syntax: regexp-mode [] * \li Params: : eventual argument (regular expression). * \li Origin: Tommaso, 4 Oct 2008 * \endvar */ { LFUN_REGEXP_MODE, "regexp-mode", Noop, Math }, /*! * \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::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 }, /*! * \var lyx::FuncCode lyx::LFUN_MATH_EXTERN * \li Action: Calls external program and passes the current expression/equation as an argument for the calculation in the format appropriate to the given language. * \li Notion: Selection can be used to determine the input for the external program. * \li Syntax: math-extern [] * \li Params: : octave|maxima|maple|mathematica|script \n where "script" stands fot the external script (normalized expression will be passed) * \li Origin: Andre, 24 Apr 2001 * \li Sample: math-extern maple simplify * \endvar */ { LFUN_MATH_EXTERN, "math-extern", Noop, Math }, /*! * \var lyx::FuncCode lyx::LFUN_MATH_SIZE * \li Action: Changes arbitrarily the size used by math fonts inside a context. * \li Notion: Provides an interface to the LaTeX math mode font size commands. * \li Syntax: math-size