]> git.lyx.org Git - lyx.git/blobdiff - src/LyXAction.cpp
markDirty is automatic.
[lyx.git] / src / LyXAction.cpp
index 83534a6c3eea59fbb3645e7a3e521813d745a6a2..5925351b826f78b0de273901d77f10c8e8e31db8 100644 (file)
@@ -532,6 +532,16 @@ void LyXAction::init()
  * \endvar
  */
                { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_NOTES_MUTATE
+ * \li Action: Changes all Note insets of a particular type (source)
+               to a different type (target) fot the current document.
+ * \li Syntax: notes-mutate <SOURCE> <TARGET>
+ * \li Params: <SOURCE/TARGET>: Note|Comment|Greyedout
+ * \li Origin: ps, 18 Jun 2008
+ * \endvar
+ */
+               { LFUN_NOTES_MUTATE, "notes-mutate", Argument, Edit },
 /*!
  * \var lyx::FuncCode lyx::LFUN_NEWLINE_INSERT
  * \li Action: Inserts a line break or new line.
@@ -1136,16 +1146,45 @@ void LyXAction::init()
  */
                { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
 /*!
- * \var lyx::FuncCode lyx::LFUN_FONT_DEFAULT
+ * \var lyx::FuncCode lyx::LFUN_FONT_SIZE
  * \li Action: Sets font size according to lyx format string.
- * \li Syntax: font-default <SIZE>
+ * \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 },
-               { LFUN_FONT_FREE_APPLY, "font-free-apply", Noop, Layout },
-               { LFUN_FONT_FREE_UPDATE, "font-free-update", 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
@@ -1266,25 +1305,136 @@ 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 },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_MATH_BIGDELIM
+ * \li Action: Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
+ * \li Syntax: math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
+ * \li Params: <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r \n
+               <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
+ * \li Sample: math-bigdelim "Bigl" "\Downarrow" "Bigr" "\}"
+ * \li Origin: Enrico & Georg, 7 May 2006
+ * \endvar
+ */
                { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_MATH_DISPLAY
+ * \li Action: Creates a new displayed equation in text mode.
+               Toggles inlined/display formula in math mode.
+ * \li Syntax: math-display [<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 },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_MATH_INSERT
+ * \li Action: Inserts math objects and symbols.
+ * \li Syntax: math-insert <ARG>
+ * \li Params: <ARG>: Symbol or LaTeX code to be inserted.
+ * \endvar
+ */
                { LFUN_MATH_INSERT, "math-insert", Noop, Math },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_MATH_SUBSCRIPT
+ * \li Action: Enters subscript expression in math expression.
+ * \li Syntax: math-subscript
+ * \li Origin: vermeer, 12 Dec 2001
+ * \endvar
+ */
                { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_MATH_SUPERSCRIPT
+ * \li Action: Enters subscript expression in math expression.
+ * \li Syntax: math-superscript
+ * \li Origin: vermeer, 12 Dec 2001
+ * \endvar
+ */
                { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_MATH_LIMITS
+ * \li Action: Toggles the position of the limits from above/below to the right
+               side an vice versa in integral symbol, a limit, a summation, etc.
+ * \li Notion: Put the cursor before the symbol with the limits and then invoke
+               math-limits.
+ * \li Syntax: math-limits [<STATE>]
+ * \li Params: <STATE>: limits|nolimits
+ * \endvar
+ */
                { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_MATH_MACRO
+ * \li Action: Inserts a math macro definition at the cursor position in the text.
+ * \li Syntax: math-macro <NAME> [<NARGS>] [def]
+ * \li Params: <NAME>: The name of the macro, e.g. "mymacro".
+               <NARGS>: The number of parameters of the macro. Default is 0.
+               "def": Has no effect anymore, just for compatibility with former LyX versions.
+ * \li Origin: ale, 10 May 1997;  sts, 21 Dec 2007
+ * \endvar
+ */
                { LFUN_MATH_MACRO, "math-macro", Noop, Math },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_MATH_MUTATE
+ * \li Action: Mutates the type of math inset to the newly selected one.
+ * \li Syntax: math-mutate <TYPE>
+ * \li Params: <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
+                       multline|gather|flalign
+ * \li Origin: Andre', 23 May 2001
+ * \endvar
+ */
                { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_MATH_SPACE
+ * \li Action: Inserts space into math expression.
+ * \li Notion: Use spacebar after entering this space to change type of space.
+ * \li Syntax: math-space [<TYPE>]
+ * \li Params: <TYPE>: negative spaces: !|negmedspace|negthickspace \n
+                       positive spaces: ,|:|;|quad|qquad \n
+                       "," used by default.
+ * \li Origin: Andre', 25 Jul 2001; ps, 16 Jun 2008
+ * \endvar
+ */
                { LFUN_MATH_SPACE, "math-space", Noop, Math },
-               { LFUN_MATH_IMPORT_SELECTION, "math-import-selection", Noop, Math },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_MATH_MATRIX
+ * \li Action: Inserts a matrix.
+ * \li Syntax: math-matrix <COLS> <ROWS> [<ALIGN>]
+ * \li Params: <ALIGN>: Alignment is a word composed of the vertical alignment
+                        (b, c or t) (i.e. 1 char) and the horizontal alignments 
+                       (l, c or r) (i.e. <COL> chars).
+ * \li Sample: math-matrix 3 3 bccc
+ * \endvar
+ */
                { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_MATH_MODE
+ * \li Action: In text mode enters math mode (i.e. puts math insets on the current
+               cursor position), in math mode enters text mode inside math expression.
+ * \li Notion: If there is some selected text, it puts the text inside created math box.
+ * \li Syntax: math-mode [<ARG>]
+ * \li Params: <ARG>: eventual argument (LaTeX code) is passed to #LFUN_MATH_INSERT .
+ * \li Origin: Alejandro, 4 Jun 1996
+ * \endvar
+ */
                { LFUN_MATH_MODE, "math-mode", Noop, Math },
 /*!
  * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
  * \li Action: Toggles numbering of the current formula line.
  * \li Notion: Must be in display formula mode.
  * \li Syntax: math-number-line-toggle
- * \li Origin: Alejandro 18 Jun 1996
+ * \li Origin: Alejandro, 18 Jun 1996
  * \endvar
  */
                { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
@@ -1293,11 +1443,34 @@ void LyXAction::init()
  * \li Action: Toggles numbering/labeling of the current formula.
  * \li Notion: Must be in display formula mode.
  * \li Syntax: math-number-toggle
- * \li Origin: Alejandro 4 Jun 1996
+ * \li Origin: Alejandro, 4 Jun 1996
  * \endvar
  */
                { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_MATH_EXTERN
+ * \li Action: Calls external program and passes the current expression/equation
+               as an argument for the calculation in the format appropriate to the
+               given language.
+ * \li Notion: Selection can be used to determine the input for the external program.
+ * \li Syntax: math-extern <LANG> [<COMMAND>]
+ * \li Params: <LANG>: octave|maxima|maple|mathematica|script \n
+                       where "script" stands fot the external script (normalized
+                       expression will be passed)
+ * \li Origin: Andre', 24 Apr 2001
+ * \li Sample: math-extern maple simplify
+ * \endvar
+ */
                { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_MATH_SIZE
+ * \li Action: Changes arbitrarily the size used by math fonts inside a context.
+ * \li Notion: Provides an interface to the LaTeX math mode font size commands.
+ * \li Syntax: math-size <STYLE>
+ *\ li Params: <STYLE>: \displaystyle|\textstyle|\scriptstyle|\scriptscriptstyle
+ * \li Origin: Alejandro, 15 Aug 1996; ps, 14 Jun 2008
+ * \endvar
+ */
                { LFUN_MATH_SIZE, "math-size", Noop, Math },
 /*!
  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
@@ -1742,7 +1915,7 @@ void LyXAction::init()
  * \li Origin: sanda, 6 May 2008
  * \endvar
  */
-               { LFUN_GRAPHICS_GROUPS_UNIFY, "graphics-groups-unify", ReadOnly, Edit },
+               { LFUN_GRAPHICS_GROUPS_UNIFY, "graphics-groups-unify", Argument, Edit },
 /*!
  * \var lyx::FuncCode lyx::LFUN_SET_GRAPHICS_GROUP
  * \li Action: Set the group for the graphics inset on the cursor position.
@@ -1752,7 +1925,7 @@ void LyXAction::init()
  * \li Origin: sanda, 6 May 2008
  * \endvar
  */
-               { LFUN_SET_GRAPHICS_GROUP, "set-graphics-group", ReadOnly, Edit },
+               { LFUN_SET_GRAPHICS_GROUP, "set-graphics-group", Noop, Edit },
 
 /*!
  * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
@@ -1788,6 +1961,15 @@ void LyXAction::init()
  */
                { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
 
+/*!
+ * \var lyx::FuncCode lyx::LFUN_LANGUAGE
+ * \li Action: Set language from the current cursor position.
+ * \li Syntax: language <LANG>
+ * \li Params: <LANG>: Requested language. Look in lib/languages for
+                       the list.
+ * \li Origin: Dekel, 2 Mar 2000
+ * \endvar
+ */
                { LFUN_LANGUAGE, "language", Noop, Edit },
 
 /*!