]> git.lyx.org Git - lyx.git/blobdiff - src/LyXAction.cpp
The mode changing math insets already provide the needed info, so
[lyx.git] / src / LyXAction.cpp
index 51fbaceed7786227f8367552fb73e7c88b221f6e..e1c957ddf40bad7c119fe9a17779b49051dc0b28 100644 (file)
@@ -1307,6 +1307,16 @@ void LyXAction::init()
  * \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
@@ -1319,22 +1329,102 @@ void LyXAction::init()
  * \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
+ * \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 },
@@ -1343,11 +1433,20 @@ 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 },
                { 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