#include "support/debug.h"
#include "support/lstrings.h"
-#include <boost/assert.hpp>
+#include "support/lassert.h"
using namespace std;
using namespace lyx::support;
*/
/*!
- * \var lyx::kb_action lyx::LFUN_
+ * \var lyx::FuncCode lyx::LFUN_
* \li Action:
* \li Notion:
* \li Syntax:
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;
if (init) return;
struct ev_item {
- kb_action action;
+ FuncCode action;
char const * name;
unsigned int attrib;
func_type type;
ev_item const items[] = {
#endif
/*!
- * \var lyx::kb_action lyx::LFUN_ACCENT_ACUTE
+ * \var lyx::FuncCode lyx::LFUN_ACCENT_ACUTE
* \li Action: Adds an acute accent \htmlonly (á)\endhtmlonly
to the next character typed.
* \li Syntax: accent-acute
*/
{ LFUN_ACCENT_ACUTE, "accent-acute", Noop, Edit },
/*!
- * \var lyx::kb_action lyx::LFUN_ACCENT_BREVE
+ * \var lyx::FuncCode lyx::LFUN_ACCENT_BREVE
* \li Action: Adds a breve accent \htmlonly (ă)\endhtmlonly
to the next character typed.
* \li Syntax: accent-breve
*/
{ LFUN_ACCENT_BREVE, "accent-breve", Noop, Edit },
/*!
- * \var lyx::kb_action lyx::LFUN_ACCENT_CARON
+ * \var lyx::FuncCode lyx::LFUN_ACCENT_CARON
* \li Action: Adds a caron \htmlonly (ǎ)\endhtmlonly
to the next character typed.
* \li Syntax: accent-caron
*/
{ LFUN_ACCENT_CARON, "accent-caron", Noop, Edit },
/*!
- * \var lyx::kb_action lyx::LFUN_ACCENT_CEDILLA
+ * \var lyx::FuncCode lyx::LFUN_ACCENT_CEDILLA
* \li Action: Adds a cedilla \htmlonly (ç)\endhtmlonly
to the next character typed.
* \li Syntax: accent-cedilla
*/
{ LFUN_ACCENT_CEDILLA, "accent-cedilla", Noop, Edit },
/*!
- * \var lyx::kb_action lyx::LFUN_ACCENT_CIRCLE
+ * \var lyx::FuncCode lyx::LFUN_ACCENT_CIRCLE
* \li Action: Adds a circle accent \htmlonly (å)\endhtmlonly
to the next character typed.
* \li Syntax: accent-circle
*/
{ LFUN_ACCENT_CIRCLE, "accent-circle", Noop, Edit },
/*!
- * \var lyx::kb_action lyx::LFUN_ACCENT_CIRCUMFLEX
+ * \var lyx::FuncCode lyx::LFUN_ACCENT_CIRCUMFLEX
* \li Action: Adds a circumflex \htmlonly (ê)\endhtmlonly
to the next character typed.
* \li Syntax: accent-circumflex
*/
{ LFUN_ACCENT_CIRCUMFLEX, "accent-circumflex", Noop, Edit },
/*!
- * \var lyx::kb_action lyx::LFUN_ACCENT_DOT
+ * \var lyx::FuncCode lyx::LFUN_ACCENT_DOT
* \li Action: Adds a dot accent \htmlonly (ż)\endhtmlonly
to the next character typed.
* \li Syntax: accent-dot
*/
{ LFUN_ACCENT_DOT, "accent-dot", Noop, Edit },
/*!
- * \var lyx::kb_action lyx::LFUN_ACCENT_GRAVE
+ * \var lyx::FuncCode lyx::LFUN_ACCENT_GRAVE
* \li Action: Adds a grave accent \htmlonly (è)\endhtmlonly
to the next character typed.
* \li Syntax: accent-grave
*/
{ LFUN_ACCENT_GRAVE, "accent-grave", Noop, Edit },
/*!
- * \var lyx::kb_action lyx::LFUN_ACCENT_HUNGARIAN_UMLAUT
+ * \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
*/
{ LFUN_ACCENT_HUNGARIAN_UMLAUT, "accent-hungarian-umlaut", Noop, Edit },
/*!
- * \var lyx::kb_action lyx::LFUN_ACCENT_MACRON
+ * \var lyx::FuncCode lyx::LFUN_ACCENT_MACRON
* \li Action: Adds a macron \htmlonly (ā)\endhtmlonly
to the next character typed.
* \li Syntax: accent-macron
*/
{ LFUN_ACCENT_MACRON, "accent-macron", Noop, Edit },
/*!
- * \var lyx::kb_action lyx::LFUN_ACCENT_OGONEK
+ * \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::kb_action lyx::LFUN_ACCENT_TIE
+ * \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.
*/
{ LFUN_ACCENT_TIE, "accent-tie", Noop, Edit },
/*!
- * \var lyx::kb_action lyx::LFUN_ACCENT_TILDE
+ * \var lyx::FuncCode lyx::LFUN_ACCENT_TILDE
* \li Action: Adds a tilde \htmlonly (ã)\endhtmlonly
over the next character typed.
* \li Syntax: accent-tilde
*/
{ LFUN_ACCENT_TILDE, "accent-tilde", Noop, Edit },
/*!
- * \var lyx::kb_action lyx::LFUN_ACCENT_UMLAUT
+ * \var lyx::FuncCode lyx::LFUN_ACCENT_UMLAUT
* \li Action: Adds an umlaut \htmlonly (ä)\endhtmlonly
over the next character typed.
* \li Syntax: accent-umlaut
*/
{ LFUN_ACCENT_UMLAUT, "accent-umlaut", Noop, Edit },
/*!
- * \var lyx::kb_action lyx::LFUN_ACCENT_UNDERBAR
+ * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERBAR
* \li Action: Adds a bar \htmlonly (a̠)\endhtmlonly
under the next character typed.
* \li Syntax: accent-underbar
*/
{ LFUN_ACCENT_UNDERBAR, "accent-underbar", Noop, Edit },
/*!
- * \var lyx::kb_action lyx::LFUN_ACCENT_UNDERDOT
+ * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERDOT
* \li Action: Adds a dot \htmlonly (ạ)\endhtmlonly
under the next character typed.
* \li Syntax: accent-underdot
{ LFUN_ACCENT_UNDERDOT, "accent-underdot", Noop, Edit },
/*!
- * \var lyx::kb_action lyx::LFUN_BREAK_PARAGRAPH
- * \li Action: Breaks the current paragraph at the current location.
- * \li Syntax: break-paragraph
- * \endvar
- */
- { LFUN_BREAK_PARAGRAPH, "break-paragraph", Noop, Edit },
-/*!
- * \var lyx::kb_action lyx::LFUN_BREAK_PARAGRAPH_SKIP
- * \li Action: Breaks the current paragraph at the current location,
- unless used at the beginning of a line, where it sets
- the label width string to empty.
- * \li Syntax: break-paragraph-skip
- * \endvar
- */
- { LFUN_BREAK_PARAGRAPH_SKIP, "break-paragraph-skip", Noop, Edit },
-/*!
- * \var lyx::kb_action lyx::LFUN_CAPTION_INSERT
+ * \var lyx::FuncCode lyx::LFUN_CAPTION_INSERT
* \li Action: Inserts a caption inset.
* \li Syntax: caption-insert
* \li Origin: Lgb, 18 Jul 2000
*/
{ LFUN_CAPTION_INSERT, "caption-insert", Noop, Edit },
/*!
- * \var lyx::kb_action lyx::LFUN_DATE_INSERT
+ * \var lyx::FuncCode lyx::LFUN_DATE_INSERT
* \li Action: Inserts the current date.
* \li Syntax: date-insert [<ARG>]
* \li Params: <ARG>: Format of date. The default value (%x) can be set
*/
{ LFUN_DATE_INSERT, "date-insert", Noop, Edit },
/*!
- * \var lyx::kb_action lyx::LFUN_FOOTNOTE_INSERT
+ * \var lyx::FuncCode lyx::LFUN_FOOTNOTE_INSERT
* \li Action: Inserts a footnote inset.
* \li Syntax: footnote-insert
* \li Origin: Jug, 7 Mar 2000
*/
{ LFUN_FOOTNOTE_INSERT, "footnote-insert", Noop, Edit },
/*!
- * \var lyx::kb_action lyx::LFUN_ERT_INSERT
+ * \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 <TYPE>
+ * \li Params: <TYPE>: 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 <TYPE>
+ * \li Params: <TYPE>: 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 },
- { LFUN_WRAP_INSERT, "wrap-insert", Noop, Edit },
/*!
- * \var lyx::kb_action lyx::LFUN_HFILL_INSERT
- * \li Action: Inserts an hfill inset.
- * \li Syntax: hfill-insert
+ * \var lyx::FuncCode lyx::LFUN_FLOAT_LIST_INSERT
+ * \li Action: Inserts the list of floats in the document.
+ * \li Syntax: float-list-insert <TYPE>
+ * \li Params: <TYPE>: type of float depends on the used textclass. Usually
+ "algorithm", "table", "figure" parameters can be given.
+ * \li Origin: Lgb, 3 May 2001
* \endvar
*/
- { LFUN_HFILL_INSERT, "hfill-insert", Noop, Edit },
+ { LFUN_FLOAT_LIST_INSERT, "float-list-insert", Noop, Edit },
/*!
- * \var lyx::kb_action lyx::LFUN_OPTIONAL_INSERT
+ * \var lyx::FuncCode lyx::LFUN_WRAP_INSERT
+ * \li Action: Inserts floats wrapped by the text around.
+ * \li Syntax: wrap-insert <TYPE>
+ * \li Params: <TYPE>: table|figure
+ * \li Origin: Dekel, 7 Apr 2002
+ * \endvar
+ */
+ { LFUN_WRAP_INSERT, "wrap-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
*/
{ LFUN_OPTIONAL_INSERT, "optional-insert", Noop, Edit },
/*!
- * \var lyx::kb_action lyx::LFUN_LINE_INSERT
+ * \var lyx::FuncCode lyx::LFUN_LINE_INSERT
* \li Action: Inserts a horizontal line.
* \li Syntax: line-insert
* \li Origin: poenitz, Oct 27 2003
*/
{ LFUN_LINE_INSERT, "line-insert", Noop, Edit },
/*!
- * \var lyx::kb_action lyx::LFUN_NEWPAGE_INSERT
+ * \var lyx::FuncCode lyx::LFUN_NEWPAGE_INSERT
* \li Action: Inserts a new page.
- * \li Syntax: newpage-insert
+ * \li Syntax: newpage-insert<ARG>
+ * \li Params: <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
* \li Origin: uwestoehr, 24 Nov 2007
* \endvar
*/
{ LFUN_NEWPAGE_INSERT, "newpage-insert", Noop, Edit },
/*!
- * \var lyx::kb_action lyx::LFUN_PAGEBREAK_INSERT
- * \li Action: Inserts a pagebreak.
- * \li Syntax: pagebreak-insert
- * \li Origin: poenitz, Oct 27 2003
- * \endvar
- */
- { LFUN_PAGEBREAK_INSERT, "pagebreak-insert", Noop, Edit },
-/*!
- * \var lyx::kb_action lyx::LFUN_MARGINALNOTE_INSERT
+ * \var lyx::FuncCode lyx::LFUN_MARGINALNOTE_INSERT
* \li Action: Inserts a marginal note.
* \li Syntax: marginalnote-insert
* \li Origin: Lgb, 26 Jun 2000
*/
{ LFUN_MARGINALNOTE_INSERT, "marginalnote-insert", Noop, Edit },
/*!
- * \var lyx::kb_action lyx::LFUN_UNICODE_INSERT
+ * \var lyx::FuncCode lyx::LFUN_UNICODE_INSERT
* \li Action: Inserts a single unicode character.
* \li Syntax: unicode-insert <CHAR>
* \li Params: <CHAR>: The character to insert, given as its code
*/
{ LFUN_UNICODE_INSERT, "unicode-insert", Noop, Edit },
/*!
- * \var lyx::kb_action lyx::LFUN_LISTING_INSERT
+ * \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_QUOTE_INSERT
+ * \li Action: Inserts quotes according to the type and quote-language preference.
+ * \li Action: Currently English, Swedish, German, Polish, French, Danish quotes
+ are distinguished.
+ * \li Syntax: quote-insert [<TYPE>]
+ * \li Params: TYPE: '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.\n
+ * \li Syntax: info-insert <TYPE> <ARG>
+ * \li Params: <TYPE>: shortcut|lyxrc|package|textclass|menu|buffer \n
+ <ARG>: argument for a given type. Look into InsetInfo.h for detailed
+ description.
+ * \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 <BRANCH-NAME>
+ * \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 [<TYPE>]
+ * \li Params: <TYPE>: 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::kb_action lyx::LFUN_FLEX_INSERT
+ * \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
* \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 <STRING>
+ * \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 <NAME> [<LEN>]
+ * \li Params: <NAME>: normal, protected, thin, quad, qquad, enspace, enskip,
+ negthinspace, hfill, hfill*, dotfill, hrulefill, hspace,
+ hspace* \n
+ <LEN>: 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 [<TARGET>]
+ * \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 <CHAR>
+ * \li Params: <CHAR>: 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 },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_TOC_INSERT
+ * \li Action: Inserts table of contents.
+ * \li Syntax: toc-insert
+ * \li Origin: Lgb, 27 May 97
+ * \endvar
+ */
{ LFUN_TOC_INSERT, "toc-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 },
-#if 0
- { LFUN_LIST_INSERT, "list-insert", Noop, Edit },
-#endif
+/*!
+ * \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 Origin: Angus, 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 Origin: Lgb, 27 Feb 1997
+ * \endvar
+ */
+ { LFUN_INDEX_PRINT, "index-print", 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 [<SYMBOL>]
+ * \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 },
- { LFUN_DELETE_BACKWARD_SKIP, "delete-backward-skip", Noop, Edit },
- { LFUN_DELETE_FORWARD_SKIP, "delete-forward-skip", 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 [<TYPE>]
+ * \li Params: <TYPE>: <Note|Greyedout|Comment> 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_NEWLINE_INSERT
+ * \li Action: Inserts a line break or new line.
+ * \li Syntax: newline-insert [<ARG>]
+ * \li Params: <ARG>: <newline|linebreak> 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.
+ * \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 },
- { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, 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::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::kb_action lyx::LFUN_SCROLL
+ * \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 <TYPE> <QUANTITY>
*/
{ LFUN_SCROLL, "scroll", ReadOnly, Edit },
/*!
- * \var lyx::kb_action lyx::LFUN_SCREEN_RECENTER
+ * \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::kb_action lyx::LFUN_CHAR_BACKWARD
+ * \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
*/
{ LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit },
/*!
- * \var lyx::kb_action lyx::LFUN_CHAR_BACKWARD_SELECT
+ * \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.
* \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::kb_action lyx::LFUN_CHAR_FORWARD
+ * \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.
*/
{ LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit },
/*!
- * \var lyx::kb_action lyx::LFUN_CHAR_FORWARD_SELECT
+ * \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.
*/
{ LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit },
/*!
- * \var lyx::kb_action lyx::LFUN_CHAR_LEFT
+ * \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
*/
{ LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit },
/*!
- * \var lyx::kb_action lyx::LFUN_CHAR_LEFT_SELECT
+ * \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.
*/
{ LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit },
/*!
- * \var lyx::kb_action lyx::LFUN_CHAR_RIGHT
+ * \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
*/
{ LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit },
/*!
- * \var lyx::kb_action lyx::LFUN_CHAR_RIGHT_SELECT
+ * \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.
*/
{ 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 },
- { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, 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 },
- { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, 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 [<STRING>]
+ * \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 [<STRING>]
+ * \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 [<DATA>]
+ * \li Params: <DATA>: 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: poenitz, Jan 7 2004
+ * \endvar
+ */
+ { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_WORD_FIND
+ * \li Action: Replace a string in the document.
+ * \li Syntax: word-replace [<DATA>]
+ * \li Params: <DATA>: data is of the form
+ "<search> \n
+ <replace> \n
+ <casesensitive> <matchword> <all> <forward>"
+ * \li Origin: poenitz, Jan 7 2004
+ * \endvar
+ */
+ { LFUN_WORD_REPLACE, "word-replace", Noop, 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 },
- { LFUN_WORD_LOWCASE, "word-lowcase", Noop, 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 Author: 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 },
- { 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_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_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 },
+/*!
+ * \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_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 },
- { LFUN_LINE_BREAK, "line-break", Noop, Edit },
- { LFUN_LINE_DELETE, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
+/*!
+ * \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 },
- { 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
+ * \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_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
+ { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, 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
+ * \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_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
+ { LFUN_LINE_DELETE, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
/*!
- * \var lyx::kb_action lyx::LFUN_COPY
+ * \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
+ * \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
+ * \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
+ * \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
+ * \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
+ * \var lyx::FuncCode lyx::LFUN_REDO
* \li Action: Redoes the last thing undone.
* \li Syntax: redo
* \endvar
*/
{ LFUN_REDO, "redo", Noop, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_REPEAT
+ * \li Action: Repeat the given command.
+ * \li Syntax: repeat <COUNT> <LFUN-COMMAND>
+ * \li Author: poenitz, 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 Author: 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 },
{ LFUN_ENVIRONMENT_INSERT, "environment-insert", Noop, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_FONT_BOLD
+ * \li Action: Toggles the bold font (selection-wise).
+ * \li Syntax: font-bold
+ * \endvar
+ */
{ LFUN_FONT_BOLD, "font-bold", 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 },
- { LFUN_FONT_DEFAULT, "font-default", 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_EMPH
+ * \li Action: Toggles the emphasis font style (selection-wise).
+ * \li Syntax: font-emph
+ * \endvar
+ */
{ LFUN_FONT_EMPH, "font-emph", Noop, Layout },
- { LFUN_FONT_FREE_APPLY, "font-free-apply", Noop, Layout },
- { LFUN_FONT_FREE_UPDATE, "font-free-update", 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 },
+ { LFUN_FONT_FREE_APPLY, "font-free-apply", Noop, Layout },
+ { LFUN_FONT_FREE_UPDATE, "font-free-update", Noop, Layout },
+ { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
{ LFUN_FONT_SIZE, "font-size", Noop, 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 },
- { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
- { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
-
- { LFUN_INDEX_INSERT, "index-insert", Noop, Edit },
- { LFUN_INDEX_PRINT, "index-print", Noop, Edit },
-
- { LFUN_NOMENCL_INSERT, "nomencl-insert", Noop, Edit },
- { LFUN_NOMENCL_PRINT, "nomencl-print", Noop, Edit },
-
- { LFUN_NOTE_INSERT, "note-insert", Noop, Edit },
- { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
{ LFUN_BIBITEM_INSERT, "bibitem-insert", Noop, Edit },
{ LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
{ LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
/*!
- * \var lyx::kb_action lyx::LFUN_LAYOUT
+ * \var lyx::FuncCode lyx::LFUN_LAYOUT
* \li Action: Sets the layout (that is, environment) for the current paragraph.
* \li Syntax: layout <LAYOUT>
* \li Params: <LAYOUT>: the layout to use
*/
{ LFUN_LAYOUT, "layout", Noop, Layout },
/*!
- * \var lyx::kb_action lyx::LFUN_LAYOUT_PARAGRAPH
+ * \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::kb_action lyx::LFUN_DROP_LAYOUTS_CHOICE
+ * \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.
*/
{ LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
/*!
- * \var lyx::kb_action lyx::LFUN_LAYOUT_MODULES_CLEAR
+ * \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
*/
{ LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", Noop, Layout },
/*!
- * \var lyx::kb_action lyx::LFUN_LAYOUT_MODULE_ADD
+ * \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 <MODULE>
*/
{ LFUN_LAYOUT_MODULE_ADD, "layout-module-add", Noop, Layout },
/*!
- * \var lyx::kb_action lyx::LFUN_LAYOUT_RELOAD
+ * \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.
*/
{ LFUN_LAYOUT_RELOAD, "layout-reload", Noop, Layout },
/*!
- * \var lyx::kb_action lyx::LFUN_TEXTCLASS_APPLY
+ * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
* \li Action: Sets the text class for the current buffer.
* \li Syntax: textclass-apply <TEXTCLASS>
* \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
*/
{ LFUN_TEXTCLASS_APPLY, "textclass-apply", Noop, Layout },
/*!
- * \var lyx::kb_action lyx::LFUN_TEXTCLASS_LOAD
+ * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
* \li Action: Loads information for a textclass from disk.
* \li Syntax: textclass-load <TEXTCLASS>
* \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
{ LFUN_TEXTCLASS_LOAD, "textclass-load", Noop, Layout },
/*!
- * \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
*/
{ LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
/*!
- * \var lyx::kb_action lyx::LFUN_MARK_TOGGLE
+ * \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
{ 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
*/
{ LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
/*!
- * \var lyx::kb_action lyx::LFUN_MATH_NUMBER_TOGGLE
+ * \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
{ LFUN_MATH_EXTERN, "math-extern", Noop, Math },
{ LFUN_MATH_SIZE, "math-size", Noop, Math },
/*!
- * \var lyx::kb_action lyx::LFUN_MATH_MACRO_UNFOLD
+ * \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.
*/
{ LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
/*!
- * \var lyx::kb_action lyx::LFUN_MATH_MACRO_FOLD
+ * \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.
*/
{ LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
/*!
- * \var lyx::kb_action lyx::LFUN_MATH_MACRO_ADD_PARAM
+ * \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: <NUM>: The number of the parameter behind which the new one
*/
{ LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
/*!
- * \var lyx::kb_action lyx::LFUN_MATH_MACRO_REMOVE_PARAM
+ * \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
*/
{ LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
/*!
- * \var lyx::kb_action lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
+ * \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
*/
{ LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
/*!
- * \var lyx::kb_action lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
+ * \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
*/
{ LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
/*!
- * \var lyx::kb_action lyx::LFUN_MATH_MACRO_MAKE_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.
*/
{ LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
/*!
- * \var lyx::kb_action lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
+ * \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
*/
{ LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
/*!
- * \var lyx::kb_action lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
+ * \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.
*/
{ LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
/*!
- * \var lyx::kb_action lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
+ * \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.
*/
{ 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
+ * \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]
*/
{ LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
/*!
- * \var lyx::kb_action lyx::LFUN_IN_MATHMACROTEMPLATE
+ * \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
*/
{ 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 },
+
+/*!
+ * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP
+ * \li Action: Move the cursor to the next paragraph (or begining of the current one)
+ in upward direction.
+ * \li Syntax: paragraph-up
+ * \li Origin: Asger, 1 Oct 1996
+ * \endvar
+ */
+ { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP_SELECT
+ * \li Action: Move the cursor and select the text to the next paragraph (or
+ begining of the current one) in upward direction.
+ * \li Syntax: paragraph-up-select
+ * \li Origin: Asger, 1 Oct 1996
+ * \endvar
+ */
+ { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN
+ * \li Action: Move the cursor to the next paragraph (or begining of the current one)
+ in downward direction.
+ * \li Syntax: paragraph-down
+ * \li Origin: Asger, 1 Oct 1996
+ * \endvar
+ */
{ LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN_SELECT
+ * \li Action: Move the cursor and select the text to the next paragraph (or
+ begining of the current one) in downward direction.
+ * \li Syntax: paragraph-down-select
+ * \li Origin: Asger, 1 Oct 1996
+ * \endvar
+ */
{ LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
/*!
- * \var lyx::kb_action lyx::LFUN_PARAGRAPH_GOTO
- * \li Action: Jump to a paragraph given by its id number.
+ * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
+ * \li Action: Jump to a paragraph given by its id number and optionally the
+ desired position within the paragraph.
* \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 <PAR_ID_NUMBER>
+ * \li Syntax: paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
+ * \li Params: <PAR_ID_NUMBER>: paragraph id
+ <POSITION_IN_PAR>: desired position within the paragraph
* \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_PARAGRAPH_SPACING, "paragraph-spacing", Noop, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
+ * \li Action: Breaks the current paragraph at the current location.
+ * \li Notion: Removes the selection.
+ * \li Syntax: break-paragraph [<LAYOUT>]
+ * \li Params: <LAYOUT>: "inverse" - decreases depth by one (or change layout
+ to default layout) when the cursor is at the end of
+ the line.
+ * \endvar
+ */
+ { LFUN_BREAK_PARAGRAPH, "break-paragraph", 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 [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
+ * \li Params: <INDENT>: \\noindent|\\indent|\\indent-toggle|\\leftindent LENGTH\n
+ <SPACING>: \\paragraph_spacing default|single|onehalf|double|other\n
+ <ALIGN>: \\align block|left|right|center|default\n
+ <OTHERS>: \\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 <INDENT> <SPACING> <ALIGN> <OTHERS>
+ * \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
*/
{ 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
*/
{ 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.
*/
{ 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.
* \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 },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_INSET_EDIT
+ * \li Action: Edit the inset at cursor with an external application,
+ * if one is attributed.
+ * \li Syntax: inset-edit [<INSET_PARAMS>]
+ * \li Params: <INSET_PARAMS>: Parameters for the inset.
+ Currently only the filename will be considered.
+ * \li Origin: JSpitzm, 27 Apr 2006
+ * \endvar
+ */
+ { LFUN_INSET_EDIT, "inset-edit", Noop, Edit },
{ LFUN_CELL_BACKWARD, "cell-backward", Noop, Edit },
{ LFUN_CELL_FORWARD, "cell-forward", Noop, Edit },
{ LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
/*!
- * \var lyx::kb_action lyx::LFUN_INSET_APPLY
+ * \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
* \endvar
*/
{ LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE
+ * \li Action: Dissolve the current inset into text.
+ * \li Syntax: inset-dissolve [<INSET>]
+ * \li Params: <INSET>: this can be used to make sure the right kind of inset
+ is dissolved. For example "dissolve" entry in the charstyles
+ sub-menu should only dissolve the charstyle inset, even if the
+ cursor is inside several nested insets of different type.\n
+ For values see #lyx::InsetLayout::lyxtype_ .
+ * \li Author: JSpitz, 7 Aug 2006
+ * \endvar
+ */
{ LFUN_INSET_DISSOLVE, "inset-dissolve", Noop, Edit },
/*!
- * \var lyx::kb_action lyx::LFUN_INSET_INSERT
+ * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
* \li Action: Insert new inset (type given by the parameters).
* \li Syntax: inset-insert <INSET> <ARGS>
* \li Params: <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics|
*/
{ LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
/*!
- * \var lyx::kb_action lyx::LFUN_INSET_MODIFY
+ * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
* \li Action: Modify existing inset.
* \li Notion: Used for label, floats, listings, box, branch, external, wrap
- bibtex, ert, command, grahocs, note, vspace, tabular, bibitem,
- inlude, ref insets.
+ bibtex, ert, command, graphics, note, space, vspace, tabular,
+ bibitem, inlude, ref insets.
* \li Syntax: inset-modify <INSET> <ARGS>
* \li Params: See #LFUN_INSET_INSERT for further details.
* \endvar
*/
{ LFUN_INSET_MODIFY, "", Noop, Hidden },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_MODIFY
+ * \li Action: Modify the inset at cursor position, if there is one.
+ * \li Notion: Used for label, floats, listings, box, branch, external, wrap
+ bibtex, ert, command, graphics, note, space, vspace, tabular,
+ bibitem, inlude, ref insets.
+ * \li Syntax: next-inset-modify <INSET> <ARGS> or next-inset-modify changetype <TYPE>
+ * \li Params: See #LFUN_INSET_INSERT for further details.
+ * \li Origin: JSpitzm, 23 Mar 2008
+ * \endvar
+ */
+ { LFUN_NEXT_INSET_MODIFY, "next-inset-modify", ReadOnly, Edit },
{ LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
+ * \li Action: Open the inset's properties dialog.
+ * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
+ * \li Syntax: inset-settings <INSET>
+ * \li Params: <INSET>: <box|branch|ert|float|listings|note|tabular|wrap>
+ * \endvar
+ */
{ LFUN_INSET_SETTINGS, "inset-settings", ReadOnly, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_TOGGLE
+ * \li Action: Toggles the inset at cursor position. For collapsables, this means it will
+ be (un-)collapsed, in case of other insets, the editing widget (dialog) will
+ be entered. Also cf. #LFUN_INSET_SETTINGS.
+ * \li Notion: Used for label, floats, listings, box, branch, external, wrap
+ bibtex, ert, command, graphics, note, space, vspace, tabular,
+ bibitem, inlude, ref insets.
+ * \li Syntax: next-inset-toggle <ARG>
+ * \li Params: <ARG>: these are passed as arguments to #LFUN_INSET_TOGGLE .
+ * \li Origin: leeming, 30 Mar 2004
+ * \endvar
+ */
{ LFUN_NEXT_INSET_TOGGLE, "next-inset-toggle", ReadOnly, Edit },
- { LFUN_INSET_TOGGLE, "", ReadOnly, Hidden },
- { LFUN_ALL_INSETS_TOGGLE, "all-insets-toggle", ReadOnly, Edit },
-
/*!
- * \var lyx::kb_action lyx::LFUN_PARAGRAPH_PARAMS
- * \li Action: Change paragraph settings.
- * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
- This function only modifies, and does not override, existing settings.
- Note that the "leftindent" indent setting is deprecated.
- * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
- * \li Params: <INDENT>: \\noindent|\\indent|\\indent-toggle|\\leftindent LENGTH\n
- <SPACING>: \\paragraph_spacing default|single|onehalf|double|other\n
- <ALIGN>: \\align block|left|right|center|default\n
- <OTHERS>: \\labelwidthstring WIDTH|\\start_of_appendix\n
- * \li Origin: rgh, Aug 15 2007
+ * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
+ * \li Action: Toggles the collapsable inset we are currently in.
+ * \li Syntax: inset-toggle [<ARG>]
+ * \li Params: <ARG>: <open|close|toggle|assign>. \n
+ open/close/toggle are for collapsable insets. close can be currently used
+ by #LFUN_NEXT_INSET_TOGGLE. toggle is used when no argument is given.\n
+ assign is for branch inset.
+ * \li Origin: lasgouttes, 19 Jul 2001
* \endvar
*/
- { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
+ { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly, Hidden },
/*!
- * \var lyx::kb_action lyx::LFUN_PARAGRAPH_PARAMS_APPLY
- * \li Action: Change paragraph settings.
- * \li Notion: Overwrite all nonspecified settings to the default ones.
- Use paragraph-params lfun if you don't want to overwrite others settings.
- * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
- * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
+ * \var lyx::FuncCode lyx::LFUN_ALL_INSETS_TOGGLE
+ * \li Action: Toggles (open/closes) all collapsable insets (of a given type) in the document.
+ * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
+ * \li Syntax: all-insets-toggle <STATE> <INSET>
+ * \li Params: <STATE>: <toggle|open|close> default: toggle \n
+ <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all insets \n
* \li Origin: leeming, 30 Mar 2004
* \endvar
*/
- { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
- { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
+ { LFUN_ALL_INSETS_TOGGLE, "all-insets-toggle", ReadOnly, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_GRAPHICS_GROUPS_UNIFY
+ * \li Action: Unify all graphics insets with the one given as an parameter.
+ * \li Notion: This is internally used for synchronize certain group of graphics insets.
+ * \li Syntax: graphics-groups-unigfy <GRAPHICS_PARAMS>
+ * \li Params: <GRAPHICS_PARAMS>: Parameters for graphics inset
+ (syntax can be seen in .lyx files).
+ * \li Origin: sanda, 6 May 2008
+ * \endvar
+ */
+ { LFUN_GRAPHICS_GROUPS_UNIFY, "graphics-groups-unify", ReadOnly, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_SET_GRAPHICS_GROUP
+ * \li Action: Set the group for the graphics inset on the cursor position.
+ * \li Syntax: set-graphics-group [<GROUP>]
+ * \li Params: <GROUP>: Id for an existing group. In case tthe Id is an empty string,
+ the graphics inset is removed from the current group.
+ * \li Origin: sanda, 6 May 2008
+ * \endvar
+ */
+ { LFUN_SET_GRAPHICS_GROUP, "set-graphics-group", ReadOnly, Edit },
/*!
- * \var lyx::kb_action lyx::LFUN_FINISHED_FORWARD
+ * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
* \li Action: Moves the cursor out of the current slice, going forward.
* \li Notion: Cursor movement within an inset may be different than cursor
movement in the surrounding text. This action should be called
*/
{ LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
/*!
- * \var lyx::kb_action lyx::LFUN_FINISHED_BACKWARD
+ * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
* \li Action: Moves the cursor out of the current slice, going backwards.
* \li Notion: See also #LFUN_FINISHED_FORWARD.
* \endvar
*/
{ LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
/*!
- * \var lyx::kb_action lyx::LFUN_FINISHED_RIGHT
+ * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
* \li Action: Moves the cursor out of the current slice, going right.
* \li Notion: See also #LFUN_FINISHED_FORWARD
* \endvar
*/
{ LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
/*!
- * \var lyx::kb_action lyx::LFUN_FINISHED_LEFT
+ * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
* \li Action: Moves the cursor out of the current slice, going left.
* \li Notion: See also #LFUN_FINISHED_FORWARD.
* \endvar
{ LFUN_LANGUAGE, "language", Noop, Edit },
/*!
- * \var lyx::kb_action lyx::LFUN_LABEL_GOTO
+ * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
* \li Action: Goto a label.
* \li Syntax: label-goto [<LABEL>]
* \li Params: <LABEL>: Requested label. If no label is given and refernce
* \endvar
*/
{ LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT
+ * \li Action: Inserts label to text or displayed formula.
+ * \li Syntax: label-insert [<LABEL>]
+ * \li Params: <LABEL>: Requested label. If no label is given dialog requesting
+ name will be opened.
+ * \endvar
+ */
{ LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
/*!
- * \var lyx::kb_action lyx::LFUN_REFERENCE_NEXT
+ * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
* \li Action: Go to the next label or cross-reference.
* \li Syntax: reference-next
* \li Origin: Dekel, 14 Jan 2001
{ LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
/*!
- * \var lyx::kb_action lyx::LFUN_BOOKMARK_GOTO
+ * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
* \li Action: Goto a bookmark.
* \li Notion: Moves the cursor to the numbered bookmark, opening the file
if necessary. Note that bookmarsk are saved per-session, not
*/
{ LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
/*!
- * \var lyx::kb_action lyx::LFUN_BOOKMARK_SAVE
+ * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
* \li Action: Save a bookmark.
* \li Notion: Saves a numbered bookmark to the sessions file. The number
must be between 1 and 9, inclusive. Note that bookmarks are
*/
{ LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
/*!
- * \var lyx::kb_action lyx::LFUN_BOOKMARK_CLEAR
+ * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
* \li Action: Clears the list of saved bookmarks.
* \li Syntax: bookmark-clear
* \li Origin: bpeng, 31 October 2006
*/
{ LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
+ * \li Action: Open the given help file according to the language setting.
+ * \li Syntax: help-open <FILE>[.lyx]
+ * \li Params: <FILE>: any document from (/usr/share/)doc directory.
+ * \li Author: Jug, 27 Jun 1999
+ * \endvar
+ */
{ LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
/*!
- * \var lyx::kb_action lyx::LFUN_LYX_QUIT
+ * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
* \li Action: Terminates the current LyX instance.
* \li Notion: Terminates the current LyX instance, asking whether to save
modified documents, etc.
*/
{ LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
/*!
- * \var lyx::kb_action lyx::LFUN_TOOLBAR_TOGGLE
+ * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
* \li Action: Toggles visibility of a given toolbar between on/off/auto.
* \li Notion: Skiping "auto" when allowauto is false.
* \li Syntax: toolbar-toggle <NAME> [allowauto]
* \endvar
*/
{ LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_MENU_OPEN
+ * \li Action: Opens the menu given by its name.
+ * \li Syntax: menu-open <NAME>
+ * \li Params: <NAME>: menu name. See various .inc files in lib/ui for candidates.
+ * \endvar
+ */
{ LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
/*!
- * \var lyx::kb_action lyx::LFUN_UI_TOGGLE
+ * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
* \li Action: Various UI visibility-toggling actions.
* \li Syntax: ui-toggle <statusbar|menubar|frame|fullscreen>
* \li Params: statusbar : Toggle visibility of the statusbar.\n
*/
{ LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
+/*!
+ * \var lyx::FuncCode lyx::WINDOW_NEW
+ * \li Action: Creates new empty LyX window.
+ * \li Notion: Already opened documents from the previous window can be found under View menu.
+ * \li Syntax: window-new [<GEOMETRY>]
+ * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently
+ accepted only on Windows platform.
+ * \li Origin: Abdel, 21 Oct 2006
+ * \endvar
+ */
{ LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_WINDOW_CLOSE
+ * \li Action: Closes the current LyX window.
+ * \li Syntax: window-close
+ * \li Origin: Abdel, 23 Oct 2006
+ * \endvar
+ */
{ LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
/*!
- * \var lyx::kb_action lyx::LFUN_SPLIT_VIEW
+ * \var lyx::FuncCode lyx::LFUN_SPLIT_VIEW
* \li Action: Creates another split view of current buffer.
* \li Notion: All split views act in the same way indpendently.
* \li Syntax: split-view <vertical|horizontal>
{ LFUN_SPLIT_VIEW, "split-view", ReadOnly, Buffer },
/*!
- * \var lyx::kb_action lyx::LFUN_CLOSE_TAB_GROUP
+ * \var lyx::FuncCode lyx::LFUN_CLOSE_TAB_GROUP
* \li Action: Close the current tab group.
* \li Notion: This only closes the work areas, not the buffer themselves.
The still opened buffers can be visualized in another tab group.
{ LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
{ LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
- { LFUN_MESSAGE, "message", NoBuffer, System },
- { LFUN_FLOAT_LIST, "float-list", Noop, Edit },
- { LFUN_ESCAPE, "escape", ReadOnly, Edit },
-
{ LFUN_SERVER_CHAR_AFTER, "server-char-after", ReadOnly, System },
- { LFUN_SERVER_GET_FONT, "server-get-font", ReadOnly, System },
{ LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
{ LFUN_SERVER_GET_NAME, "server-get-name", ReadOnly, System },
- { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
/*!
- * \var lyx::kb_action lyx::LFUN_SERVER_GOTO_FILE_ROW
+ * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
* \li Action: Sets the cursor position based on the row number of generated TeX file.
* \li Syntax: server-goto-file-row <LYX_FILE_NAME> <ROW_NUMBER>
* \li Origin: Edmar, 23 Dec 1998
*/
{ LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly, System },
{ LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
+ * \li Action: Sets the cursor position based on the editing area coordinates
+ (similar as clicking on that point with left mouse button).
+ * \li Syntax: server-set-xy <X> <Y>
+ * \endvar
+ */
{ LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
+ * \li Action: Returns the coordinates of cursor position in the editing area.
+ * \li Syntax: server-get-xy
+ * \endvar
+ */
+ { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
+ * \li Action: Generates the code (literate programming).
+ * \li Notion: Latex file with extension \literate_extension is generated.
+ Then LyX invokes \build_command (with a default of``make'') to generate the code and
+ \build_error_filter to process the compilation error messages. \n
+ In case you want to process your literate file with a script, or some other program,
+ just insert in your lyxrc file an entry with:\n
+ \build_command "my_script my_arguments" \n
+ The \build_error_filter differs from the \literate_error_filter only in that the
+ former will identify error messages from your compiler.
+ * \li Syntax: build-program
+ * \endvar
+ */
{ LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
/*!
- * \var lyx::kb_action lyx::LFUN_BUFFER_AUTO_SAVE
+ * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
* \li Action: Saves the current buffer to a temporary file.
* \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
is called automatically by LyX, to "autosave" the current buffer.
- * \li Syntax: buffer-auto-save
+ * \li Syntax: buffer-auto-save
* \endvar
*/
{ LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_BUFFER_CHILD_OPEN
+ * \li Action: Loads the given child document.
+ * \li Notion: The current document is treated as a parent.
+ * \li Syntax: buffer-child-open <FILE>
+ * \li Params: <FILE>: Filename of the child. The directory of the parent is assumed by default.
+ * \li Origin: Ale, 28 May 1997
+ * \endvar
+ */
{ LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_BUFFER_CHKTEX
+ * \li Action: Runs chktex for the current document.
+ * \li Syntax: buffer-chktex
+ * \li Origin: Asger, 30 Oct 1997
+ * \endvar
+ */
{ LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
+ * \li Action: Toggles compression of the current document on/off.
+ * \li Syntax: buffer-toggle-compression
+ * \li Origin: bpeng, 27 Apr 2006
+ * \endvar
+ */
{ LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
- { LFUN_BUFFER_TOGGLE_EMBEDDING, "buffer-toggle-embedding", Noop, Buffer },
/*!
- * \var lyx::kb_action lyx::LFUN_BUFFER_CLOSE
+ * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
* \li Action: Closes the current buffer.
* \li Notion: Closes the current buffer, asking whether to save it, etc,
if the buffer has been modified.
*/
{ LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
/*!
- * \var lyx::kb_action lyx::LFUN_BUFFER_EXPORT
+ * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
* \li Action: Exports the current buffer (document) to the given format.
* \li Syntax: buffer-export <FORMAT>
* \li Params: <FORMAT> is either "custom" or one of the formats which you
*/
{ LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
/*!
- * \var lyx::kb_action lyx::LFUN_BUFFER_EXPORT_CUSTOM
+ * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
* \li Action: Exports the current buffer (document) from the given format using
the given command on it.
* \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
*/
{ LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
/*!
- * \var lyx::kb_action lyx::LFUN_BUFFER_PRINT
+ * \var lyx::FuncCode lyx::LFUN_BUFFER_PRINT
* \li Action: Prints the current document.
* \li Notion: Many settings can be given via the preferences dialog.
* \li Syntax: buffer-print <TARGET> <TARGET-NAME> <COMMAND>
*/
{ LFUN_BUFFER_PRINT, "buffer-print", ReadOnly, Buffer },
/*!
- * \var lyx::kb_action lyx::LFUN_BUFFER_IMPORT
+ * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
* \li Action: Import a given file as a lyx document.
* \li Notion: File can be imported iff lyx file format is (transitively) reachable via
defined convertors in preferences. Look into File->Import menu to get
*/
{ LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
/*!
- * \var lyx::kb_action lyx::LFUN_BUFFER_NEW
+ * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
* \li Action: Creates a new buffer (that is, document).
* \li Notion: Implicit path can be set in Preferences dialog.
* \li Syntax: buffer-new [<FILE>]
*/
{ LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
/*!
- * \var lyx::kb_action lyx::LFUN_BUFFER_NEW_TEMPLATE
+ * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
* \li Action: Creates a new buffer (that is, document) from a template.
* \li Notion: Path for new files and templates can be set in Preferences dialog.
Template will be asked for via Open-dialog.
* \endvar
*/
{ LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
+ * \li Action: Reverts opened document.
+ * \li Syntax: buffer-reload
+ * \li Origin: Asger, 2 Feb 1997
+ * \endvar
+ */
{ LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
/*!
- * \var lyx::kb_action lyx::LFUN_BUFFER_SWITCH
+ * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
* \li Action: Switch to the given buffer.
* \li Notion: This is useful also in case you need simultaneously more views of the edited
document in different LyX windows.
*/
{ LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
/*!
- * \var lyx::kb_action lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
+ * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
* \li Action: Toggle editing mode of the current document between read/write and read-only.
* \li Syntax: buffer-toggle-read-only
* \li Origin: Lgb, 27 May 1997
*/
{ LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
/*!
- * \var lyx::kb_action lyx::LFUN_BUFFER_VIEW
+ * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
* \li Action: Displays current buffer in chosen format.
* \li Notion: Displays the contents of the current buffer in the chosen
format, for example, PDF or DVI. This runs the necessary
*/
{ LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
/*!
- * \var lyx::kb_action lyx::LFUN_BUFFER_UPDATE
+ * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
* \li Action: Exports the current document and put the result into the
temporary directory.
* \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
{ LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
/*!
- * \var lyx::kb_action lyx::LFUN_BUFFER_WRITE
+ * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
* \li Action: Saves the current buffer.
* \li Notion: Saves the current buffer to disk, using the filename that
is already associated with the buffer, asking for one if
*/
{ LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
/*!
- * \var lyx::kb_action lyx::LFUN_BUFFER_WRITE_AS
+ * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
* \li Action: Rename and save current buffer.
* \li Syntax: buffer-write-as <FILENAME>
* \li Params: <FILENAME>: New name of the buffer/file. A relative path
* \endvar
*/
{ LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
+ * \li Action: Save all changed documents.
+ * \li Syntax: buffer-write-all
+ * \li Origin: rgh, gpothier 6 Aug 2007
+ * \endvar
+ */
{ LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_BUFFER_NEXT
+ * \li Action: Switch to the next opened document.
+ * \li Notion: Note that this does not necessarily mean next in tabbar
+ (for full list see View menu).
+ * \li Syntax: buffer-next
+ * \endvar
+ */
{ LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS
+ * \li Action: Switch to the previous opened document.
+ * \li Syntax: buffer-previous
+ * \endvar
+ */
{ LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
+ * \li Action: When run from a child document, this updates (exports) document built
+ from the master buffer. If a master is not found, it updates the
+ current buffer.
+ * \li Syntax: master-buffer-update
+ * \li Author: Tommaso, 20 Sep 2007
+ * \endvar
+ */
{ LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
+ * \li Action: When run from a child document, this command shows a preview built
+ from the master buffer. If a master is not found, it previews the
+ current buffer.
+ * \li Syntax: master-buffer-view
+ * \li Author: Tommaso, 20 Sep 2007
+ * \endvar
+ */
{ LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_BUFFER_LANGUAGE
+ * \li Action: Set language of the current document.
+ * \li Syntax: buffer-language <LANG>
+ * \li Params: <LANG>: language name. See lib/languages for list.
+ * \li Author: leeming, 30 Mar 2004
+ * \endvar
+ */
{ LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_BUFFER_SAVE_AS_DEFAULT
+ * \li Action: Save the current document settings as default.
+ * \li Notion: The file will will be saved into ~/.lyx/templates/defaults.lyx .
+ * \li Syntax: buffer-save-as-default [<ARGS>]
+ * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
+ you can find in document header of usual .lyx file.
+ * \li Author: leeming, 30 Mar 2004
+ * \endvar
+ */
{ LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_BUFFER_PARAMS_APPLY
+ * \li Action: Apply the given settings to the current document.
+ * \li Syntax: buffer-params-apply [<ARGS>]
+ * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
+ you can find in document header of usual .lyx file.
+ * \li Author: leeming, 30 Mar 2004
+ * \endvar
+ */
{ LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", Noop, Buffer },
/*!
- * \var lyx::kb_action lyx::LFUN_FILE_INSERT
+ * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
* \li Action: Inserts another LyX file.
* \li Syntax: file-insert [<FILE>]
* \li Params: <FILE>: Filename to be inserted.
*/
{ LFUN_FILE_INSERT, "file-insert", Noop, Edit },
/*!
- * \var lyx::kb_action lyx::LFUN_FILE_INSERT_PLAINTEXT
+ * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
* \li Action: Inserts plain text file.
* \li Syntax: file-insert-plaintext [<FILE>]
* \li Params: <FILE>: Filename to be inserted.
*/
{ LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
/*!
- * \var lyx::kb_action lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
+ * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
* \li Action: Inserts plain text file as paragraph (i.e. join lines).
* \li Syntax: file-insert-plaintext-para [<FILE>]
* \li Params: <FILE>: Filename to be inserted.
*/
{ LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
/*!
- * \var lyx::kb_action lyx::LFUN_FILE_OPEN
+ * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
* \li Action: Open LyX document.
* \li Syntax: file-open [<FILE>]
* \li Params: <FILE>: Filename to be opened.
*/
{ LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
-
/*!
- * \var lyx::kb_action lyx::LFUN_CALL
+ * \var lyx::FuncCode lyx::LFUN_CALL
* \li Action: Executes a command defined in a .def file.
* \li Notion: The definitions are by default read from lib/commands/default.def.\n
A .def file allows to define a command with \\define "<NAME>" "<LFUN>"
*/
{ LFUN_CALL, "call", NoBuffer, System },
/*!
- * \var lyx::kb_action lyx::LFUN_META_PREFIX
+ * \var lyx::FuncCode lyx::LFUN_META_PREFIX
* \li Action: Simulate halting Meta key (Alt key on PCs).
* \li Notion: Used for buffer editation not for GUI control.
* \li Syntax: meta-prefix
*/
{ LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
/*!
- * \var lyx::kb_action lyx::LFUN_CANCEL
+ * \var lyx::FuncCode lyx::LFUN_CANCEL
* \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
* \li Syntax: cancel
* \endvar
{ LFUN_CANCEL, "cancel", NoBuffer, System },
/*!
- * \var lyx::kb_action lyx::LFUN_COMMAND_EXECUTE
+ * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
* \li Action: Opens the minibuffer toolbar so that the user can type in there.
* \li Notion: Usually bound to M-x shortcut.
* \li Syntax: command-execute
{ LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
{ LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
/*!
- * \var lyx::kb_action lyx::LFUN_COMMAND_SEQUENCE
+ * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
* \li Action: Run more commands (LFUN and its parameters) in a sequence.
* \li Syntax: command-sequence <CMDS>
* \li Params: <CMDS>: Sequence of commands separated by semicolons.
* \endvar
*/
{ LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
-
/*!
- * \var lyx::kb_action lyx::LFUN_PREFERENCES_SAVE
+ * \var lyx::FuncCode lyx::LFUN_MESSAGE
+ * \li Action: Shows message in statusbar (for script purposes).
+ * \li Syntax: message <STRING>
+ * \li Origin: Lgb, 8 Apr 2001
+ * \endvar
+ */
+ { LFUN_MESSAGE, "message", NoBuffer, System },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
* \li Action: Save user preferences.
* \li Syntax: preferences-save
* \li Origin: Lgb, 27 Nov 1999
*/
{ LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
/*!
- * \var lyx::kb_action lyx::LFUN_RECONFIGURE
+ * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
* \li Action: Reconfigure the automatic settings.
* \li Syntax: reconfigure
* \li Origin: Asger, 14 Feb 1997
*/
{ LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
/*!
- * \var lyx::kb_action lyx::LFUN_LYXRC_APPLY
+ * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
* \li Action: Apply the given settings to user preferences.
* \li Syntax: lyxrc-apply <SETTINGS>
* \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
*/
{ LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
/*!
- * \var lyx::kb_action lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
+ * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
* \li Action: Determine whether keep cursor inside the editing window regardless
the scrollbar movement.
* \li Syntax: toggle-cursor-follows-scrollbar
*/
{ LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
/*!
- * \var lyx::kb_action lyx::LFUN_SET_COLOR
+ * \var lyx::FuncCode lyx::LFUN_SET_COLOR
* \li Action: Set the given LyX color to the color defined by the X11 name given.
* \li Notion: A new color entry is created if the color is unknown.
Color names can be stored as a part of user settings.
*/
{ LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
/*!
- * \var lyx::kb_action lyx::LFUN_STATISTICS
+ * \var lyx::FuncCode lyx::LFUN_STATISTICS
* \li Action: Count the statistics (number of words and characters)
in the document or in the given selection.
* \li Notion: Note that this function gives the number of words/chars written,
*/
{ LFUN_STATISTICS, "statistics", ReadOnly, System },
/*!
- * \var lyx::kb_action lyx::LFUN_COMPLETION_INLINE
+ * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
* \li Action: Show the inline completion at the cursor position.
* \li Syntax: completion-inline
* \li Origin: sts, Feb 19 2008
*/
{ LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
/*!
- * \var lyx::kb_action lyx::LFUN_COMPLETION_POPUP
+ * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
* \li Action: Show the completion popup at the cursor position.
* \li Syntax: completion-popup
* \li Origin: sts, Feb 19 2008
*/
{ LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
/*!
- * \var lyx::kb_action lyx::LFUN_COMPLETION_COMPLETE
+ * \var lyx::FuncCode lyx::LFUN_COMPLETION_COMPLETE
* \li Action: Try to complete the word or command at the cursor position.
- * \li Syntax: complete
+ * \li Syntax: completion-complete
* \li Origin: sts, Feb 19 2008
* \endvar
*/
{ LFUN_COMPLETION_COMPLETE, "complete", SingleParUpdate, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
+ * \li Action: Activate the branch
+ * \li Syntax: branch-activate <BRANCH>
+ * \li Params: <BRANCH>: The branch to activate
+ * \li Sample: lyx -e pdf2 -x "branch-activate answers" finalexam.lyx \n
+ could be used to export a pdf with the answers branch included
+ without one's having to open LyX and activate the branch manually.
+ * \li Origin: rgh, 27 May 2008
+ * \endvar
+ */
+ { LFUN_BRANCH_ACTIVATE, "branch-activate", Argument, Buffer },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
+ * \li Action: De-activate the branch
+ * \li Syntax: branch-deactivate <BRANCH>
+ * \li Params: <BRANCH>: The branch to deactivate
+ * \li Origin: rgh, 27 May 2008
+ * \endvar
+ */
+ { LFUN_BRANCH_DEACTIVATE, "branch-deactivate", Argument, Buffer },
{ LFUN_NOACTION, "", Noop, Hidden }
#ifndef DOXYGEN_SHOULD_SKIP_THIS
}
-string const LyXAction::getActionName(kb_action action) const
+string const LyXAction::getActionName(FuncCode action) const
{
info_map::const_iterator const it = lyx_info_map.find(action);
return it != lyx_info_map.end() ? it->second.name : string();
}
-LyXAction::func_type const LyXAction::getActionType(kb_action action) const
+LyXAction::func_type const LyXAction::getActionType(FuncCode action) const
{
info_map::const_iterator const it = lyx_info_map.find(action);
return it != lyx_info_map.end() ? it->second.type : Hidden;
}
-bool LyXAction::funcHasFlag(kb_action action,
+bool LyXAction::funcHasFlag(FuncCode action,
LyXAction::func_attrib flag) const
{
info_map::const_iterator ici = lyx_info_map.find(action);
if (ici == lyx_info_map.end()) {
LYXERR0("action: " << action << " is not known.");
- BOOST_ASSERT(false);
+ LASSERT(false, /**/);
}
return ici->second.attrib & flag;
projects / lyx.git / blobdiff