]> git.lyx.org Git - lyx.git/blobdiff - src/LyXAction.cpp
Buffer: Rename function names:
[lyx.git] / src / LyXAction.cpp
index 0b7cb9296759a284b19455543deb3389e8895fa6..f70b36c7d93a17993d68639f06d7c0aaf54ee023 100644 (file)
@@ -317,21 +317,13 @@ void LyXAction::init()
  */
                { 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
+ * \var lyx::FuncCode lyx::LFUN_ARGUMENT_INSERT
+ * \li Action: Inserts an argument (short title) inset.
+ * \li Syntax: argument-insert
  * \li Origin: vermeer, 12 Aug 2002
  * \endvar
  */
-               { LFUN_OPTIONAL_INSERT, "optional-insert", Noop, Edit },
-/*!
- * \var lyx::FuncCode lyx::LFUN_LINE_INSERT
- * \li Action: Inserts a horizontal line.
- * \li Syntax: line-insert
- * \li Origin: Andre, Oct 27 2003
- * \endvar
- */
-               { LFUN_LINE_INSERT, "line-insert", Noop, Edit },
+               { LFUN_ARGUMENT_INSERT, "argument-insert", Noop, Edit },
 /*!
  * \var lyx::FuncCode lyx::LFUN_NEWPAGE_INSERT
  * \li Action: Inserts a new page.
@@ -416,11 +408,12 @@ void LyXAction::init()
                the work area.\n
                2. select the text and run info-insert lfun.
  * \li Syntax: info-insert <TYPE> <ARG>
- * \li Params: <TYPE>: shortcut[s]|lyxrc|package|textclass|menu|buffer \n
+ * \li Params: <TYPE>: shortcut[s]|lyxrc|lyxinfo|package|textclass|menu|buffer \n
                <ARG>: argument for a given type. Look into InsetInfo.h for detailed
                       description. \n
                      shortcut[s]: name of lfun (e.g math-insert \alpha) \n
                      lyxrc: name of rc_entry (e.g. bind_file) \n
+                     lyxinfo: "version" - used version of LyX \n
                      package: name of latex package (e.g. listings) \n
                      textclass: name of textclass (e.g. article) \n
                      menu: name of lfun used in menu  \n
@@ -460,16 +453,12 @@ void LyXAction::init()
                a few contained in the Logical Markup module. You can also of
                course create some yourself. \n
                For dissolving the element see #LFUN_INSET_DISSOLVE.
- * \li Syntax: flex-insert <TYPE:Name>
- * \li Params: TYPE: CharStyle|Custom|Element|Standard \n
-                     Identifies whether this is a Character Style, a
-                     Custom Inset or an XML Element, and which dynamical 
-                     sub-menu this flex inset is in on the LyX menu tree. 
-                     If Standard (currently unused): none of these.\n
-               Name: This name must be defined either in your layout file
+ * \li Syntax: flex-insert Name
+ * \li Params: Name: This name must be defined either in your layout file
                      or imported by some module. The definition is 
-                     InsetLayout <TYPE:Name>
- * \li Sample: flex-insert CharStyle:Code
+                     InsetLayout Name or InsetLayout <Flex:Name>. The Flex:
+                     prefix is optional.
+ * \li Sample: flex-insert Code
  * \endvar
  */
                { LFUN_FLEX_INSERT, "flex-insert", Noop, Edit },
@@ -513,14 +502,6 @@ void LyXAction::init()
  * \endvar
  */
                { LFUN_SPECIALCHAR_INSERT, "specialchar-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.
@@ -1014,6 +995,17 @@ void LyXAction::init()
  * \endvar
  */
                { LFUN_SPELLING_IGNORE, "spelling-ignore", ReadOnly, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_SPELLING_REMOVE
+ * \li Action: Remove the word under the cursor from the respective
+ *             spell checker dictionary.
+ * \li Syntax: spelling-remove [<STRING>] [<LANG>]
+ * \li Params: <WORD>: word to remove
+               <LANG>: language name (see file languages)
+ * \li Origin: SWitt, 28 July 2010
+ * \endvar
+ */
+               { LFUN_SPELLING_REMOVE, "spelling-remove", ReadOnly, Edit },
 /*!
  * \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
  * \li Action: Look up thesaurus entries with respect to the word under the cursor.
@@ -1210,14 +1202,14 @@ void LyXAction::init()
  * \li Syntax: undo
  * \endvar
  */
-               { LFUN_UNDO, "undo", Noop, Edit },
+               { LFUN_UNDO, "undo", ReadOnly, Edit },
 /*!
  * \var lyx::FuncCode lyx::LFUN_REDO
  * \li Action: Redoes the last thing undone.
  * \li Syntax: redo
  * \endvar
  */
-               { LFUN_REDO, "redo", Noop, Edit },
+               { LFUN_REDO, "redo", ReadOnly, Edit },
 /*!
  * \var lyx::FuncCode lyx::LFUN_REPEAT
  * \li Action: Repeat the given command.
@@ -2074,14 +2066,14 @@ void LyXAction::init()
  * \li Origin: Jug, 22 May 2000
  * \endvar
  */
-               { LFUN_CELL_BACKWARD, "cell-backward", Noop, Edit },
+               { LFUN_CELL_BACKWARD, "cell-backward", ReadOnly | NoUpdate, Edit },
 /*!
  * \var lyx::FuncCode lyx::LFUN_CELL_FORWARD
  * \li Action: Moves the cursor to the next cell inside the table.
  * \li Syntax: cell-forward
  * \endvar
  */
-               { LFUN_CELL_FORWARD, "cell-forward", Noop, Edit },
+               { LFUN_CELL_FORWARD, "cell-forward", ReadOnly | NoUpdate, Edit },
 /*!
  * \var lyx::FuncCode lyx::LFUN_CELL_SPLIT
  * \li Action: Splits cell and shifts right part to the next cell (inside the math grid).
@@ -2180,13 +2172,14 @@ void LyXAction::init()
  * \var lyx::FuncCode lyx::LFUN_VC_COMPARE
  * \li Action: Compares two revisions of the same file under version control.
  * \li Notion: This is currently implemented only for SVN and RCS.
- * \li Syntax: vc-compare <REV1> [<REV2>]
+ * \li Syntax: vc-compare [<REV1>] [<REV2>]
  * \li Params: Revision number either points directly to commit in history
-               or if negative number -x it points to last commit - x.\n
+               or if negative number -x it points to (last commit - x).\n
               In RCS we subtract only in the last number of revision specification.
                Special case "0" is reserved for the last committed revision.\n
                <REV1>: Older file.\n
-              <REV2>: Newer file. Used only if REV1 > 0.
+              <REV2>: Newer file. Used only if REV1 > 0.\n
+               If no parameter is given, interactive dialog will be shown.
  * \li Sample: Compare current document against last commit\n
                vc-compare 0
  * \li Sample: Compare current document against current revision - 5 commits\n
@@ -2304,7 +2297,7 @@ void LyXAction::init()
  * \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|tabular
-                         hyperlink|include|index|label|nomencl|vspace|ref|toc>\n
+                         hyperlink|include|index|label|line|nomencl|vspace|ref|toc>\n
                <ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
  * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
                where <label name> is the name of the referenced label and
@@ -2314,7 +2307,7 @@ void LyXAction::init()
                pageref -- <page> \n
                vpageref -- on <page> \n
                vref -- <reference> on <page> \n
-               prettyref -- Formatted reference
+               formatted -- Formatted reference
  * \endvar
  */
                { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
@@ -2333,12 +2326,12 @@ void LyXAction::init()
                are handled as well, e.g. add-vline-left/right for the Grid/Array environment.\n
                <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|copy-column|
                        toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
-                       align-left|align-right|align-center|align-block|valign-top|valign-bottom|
-                       valign-middle|longtabular-align-left|longtabular-align-center|
-                       longtabular-align-right|m-align-left|m-align-right|m-align-center|
-                       m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|set-all-lines|
-                       unset-all-lines|set-longtabular|unset-longtabular|set-pwidth|set-mpwidth|
-                       set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|
+                       align-left|align-right|align-center|align-block|align-decimal|set-decimal-point|
+                       valign-top|valign-bottom|valign-middle|longtabular-align-left|
+                       longtabular-align-center|longtabular-align-right|m-align-left|m-align-right|
+                       m-align-center|m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|
+                       set-all-lines|unset-all-lines|set-longtabular|unset-longtabular|set-pwidth|
+                       set-mpwidth|set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|
                        set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|
                        unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|
                        set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
@@ -2366,12 +2359,12 @@ void LyXAction::init()
  * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
  * \li Action: Open the inset's properties dialog.
  * \li Notion: Used for bibitem, bibtex, box, branch, citation, ert, external,
-               float, graphics, href, include, index, index_print, label, listings,
-               note, phantom, ref, space, tabular, vspace, wrap insets.
+               float, graphics, href, include, index, index_print, label, line,
+               listings, note, phantom, ref, space, tabular, vspace, wrap insets.
  * \li Syntax: inset-settings <INSET>
  * \li Params: <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|
-                         graphics|href|include|index|index_print|label|listings|
-                         note|phantom|ref|space|tabular|vspace|wrap>.
+                         graphics|href|include|index|index_print|label|line|
+                         listings|note|phantom|ref|space|tabular|vspace|wrap>.
  * \endvar
  */
                { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly | AtPoint, Edit },
@@ -2573,7 +2566,8 @@ void LyXAction::init()
  * \li Notion: Skipping "auto" when allowauto is false.
  * \li Syntax: toolbar-toggle <NAME> [allowauto]
  * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|
-                       minibuffer|review|view/update|math_panels|vcs
+                       minibuffer|review|view/update|math_panels|vcs|
+                       view-others|update-others
  * \li Origin: Edwin, 21 May 2007
  * \endvar
  */
@@ -2650,7 +2644,7 @@ void LyXAction::init()
  * \li Syntax: dialog-show <NAME> [<DATA>]
  * \li Params: <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|\n
                compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|\n
-               graphics|href|include|index|index_print|info|label|listings|log|mathdelimiter|\n
+               graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimiter|\n
                mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|\n
                print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|\n
                thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL> \n
@@ -2829,19 +2823,18 @@ void LyXAction::init()
  * \li Action: Sets the cursor position in the previewed (e.g. dvi) file based on the row
                number in LyX window.
  * \li Notion: The external program used for forward search call can be specified in
-               \\forward_search_dvi and \\forward_search_pdf RC settings.
-              By default, the value for pdf is empty, while for dvi it is\n
-              "xdvi -sourceposition $$n:$$t $$o"\n
-              The values replaced in the call: $$n for row number, $$t for
-              exported temporary .tex file, $$o exported output file, either
-              dvi or pdf, depending on which one exists in the temp dir
-              (preferred is dvi).
+               \forward_search_dvi and \forward_search_pdf RC settings.
+               By default, the value for pdf is empty, while for dvi it is\n
+               "xdvi -sourceposition $$n:$$t $$o"\n
+               The values replaced in the call: $$n for row number, $$t for
+               exported temporary .tex file, $$o exported output file, either
+               dvi or pdf, depending on which one exists in the temp dir
+               (preferred is dvi).
  * \li Syntax: forward-search
  * \li Origin: sanda, 14 Apr 2010
  * \endvar
  */
                { LFUN_FORWARD_SEARCH, "forward-search", ReadOnly, System },
-
 /*!
  * \var lyx::FuncCode lyx::LFUN_SERVER_NOTIFY
  * \li Action: Sends notify message about the last key-sequence to client.
@@ -2918,6 +2911,16 @@ void LyXAction::init()
  * \endvar
  */
                { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_OUTPUT_SYNC
+ * \li Action: Toggles including of resources for forward/reverse search of the given document.
+ * \li Notion: When toggled on, SyncTeX is invoked for PDF, while srcltx package
+               is used for DVI. Custom LaTeX macro can be defined in preferences.
+ * \li Syntax: buffer-toggle-output-sync
+ * \li Origin: sanda, 25 May 2010
+ * \endvar
+ */
+               { LFUN_BUFFER_TOGGLE_OUTPUT_SYNC, "buffer-toggle-output-sync", Noop, System },
 /*!
  * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
  * \li Action: Closes the current buffer.