]> git.lyx.org Git - lyx.git/blobdiff - src/LyXAction.cpp
cosmetics; compile fix
[lyx.git] / src / LyXAction.cpp
index 9cf78feadf759b74cf0ddd6a001a7583889c5b96..1a6b8f6b3b4b9109ccb703c6555b0574096a8d4e 100644 (file)
@@ -480,18 +480,62 @@ void LyXAction::init()
  */
                { 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 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 },
 
+/*!
+ * \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 Syntax: newline-insert [<ARG>]
  * \li Params: <ARG>: <newline|linebreak> default: newline
  * \li Origin: JSpitzm, 25 Mar 2008
  * \endvar
@@ -836,6 +880,7 @@ void LyXAction::init()
  * \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 },
@@ -871,16 +916,75 @@ void LyXAction::init()
  * \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_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 },
+/*!
+ * \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.
@@ -941,7 +1045,21 @@ void LyXAction::init()
  */
                { 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 },
 
@@ -1017,10 +1135,47 @@ void LyXAction::init()
  * \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 },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_FONT_SIZE
+ * \li Action: Sets font size according to lyx format string.
+ * \li Syntax: font-size <SIZE>
+ * \li Params: <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|
+                       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 <FONT_INFO>
+ * \li Params: <FONT_INFO>: 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.
@@ -1140,11 +1295,46 @@ void LyXAction::init()
  */
                { 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 [<LEFT>] [<RIGHT>]
+ * \li Params: <LEFT/RIGHT>: 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 },
                { 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 [<ARG>]
+ * \li Params: <ARG>: 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 },
                { 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 subscript expression in math expression.
+ * \li Syntax: math-superscript
+ * \li Origin: vermeer, 12 Dec 2001
+ * \endvar
+ */
                { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
                { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
                { LFUN_MATH_MACRO, "math-macro", Noop, Math },