]> git.lyx.org Git - lyx.git/blobdiff - src/LyXAction.cpp
Update RELEASE-NOTES and LFUN documentation for the changes in LFUN_INSET_TOGGLE...
[lyx.git] / src / LyXAction.cpp
index 1b5ec7a00f92448f5b4c17b75ab91e278bbad901..36a79cc5c9751c37f72c9598b128b537838fdd77 100644 (file)
@@ -679,6 +679,15 @@ void LyXAction::init()
  */
                { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit },
 
+/*!
+ * \var lyx::FuncCode lyx::LFUN_SCREEN_SHOW_CURSOR
+ * \li Action: Repositions the screen such that the cursor is visible.
+ * \li Syntax: screen-show-cursor
+ * \li Origin: vfr, 25 Mar 2009
+ * \endvar
+ */
+               { LFUN_SCREEN_SHOW_CURSOR, "screen-show-cursor", ReadOnly, Edit },
+
 /*!
  * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD
  * \li Action: Moves the cursor one position logically backwards.
@@ -1009,6 +1018,49 @@ void LyXAction::init()
  */
                { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
 
+/*!
+ * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN
+ * \li Action: Move the cursor to the beginning of the current inset 
+               if it is not already there, or at the beginning of the 
+               enclosing inset otherwise
+ * \li Syntax: inset-begin
+ * \li Origin: JMarc, 2009/03/16
+ * \endvar
+ */
+               { LFUN_INSET_BEGIN, "inset-begin", ReadOnly, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN_SELECT
+ * \li Action: Move the cursor to the beginning of the current inset 
+               if it is not already there, or at the beginning of the 
+               enclosing inset otherwise (adding the
+               traversed text to the selection).
+ * \li Syntax: inset-begin-select
+ * \li Origin: JMarc, 2009/03/16
+ * \endvar
+ */
+               { LFUN_INSET_BEGIN_SELECT, "inset-begin-select", ReadOnly, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_INSET_END
+ * \li Action: Move the cursor to the end of the current inset 
+               if it is not already there, or at the end of the 
+               enclosing inset otherwise
+ * \li Syntax: inset-end
+ * \li Origin: JMarc, 2009/03/16
+ * \endvar
+ */
+               { LFUN_INSET_END, "inset-end", ReadOnly, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_INSET_END_SELECT
+ * \li Action: Move the cursor to the end of the current inset 
+               if it is not already there, or at the end of the 
+               enclosing inset otherwise (adding the
+               traversed text to the selection).
+ * \li Syntax: inset-end-select
+ * \li Origin: JMarc, 2009/03/16
+ * \endvar
+ */
+               { LFUN_INSET_END_SELECT, "inset-end-select", ReadOnly, Edit },
+
 /*!
  * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN
  * \li Action: Move the cursor to the begining of the (screen) line.
@@ -1112,7 +1164,7 @@ void LyXAction::init()
  * \var lyx::FuncCode lyx::LFUN_REPEAT
  * \li Action: Repeat the given command.
  * \li Syntax: repeat <COUNT> <LFUN-COMMAND>
- * \li Origin: Andre, 27 Oct 2003
+ * \li Origin: Andre, 27 Oct 2003
  * \endvar
  */
                { LFUN_REPEAT, "repeat", NoBuffer, Edit },
@@ -1921,7 +1973,7 @@ void LyXAction::init()
  * \var lyx::FuncCode lyx::LFUN_TABULAR_FEATURE
  * \li Action: Sets various features to the table/cell on the current cursor position.
  * \li Notion: Various math-environment features are handled here as well, e.g.
-               add-vline-left/right for Grid/Cases environment
+               add-vline-left/right for the Grid/Array environment
  * \li Syntax: tabular-feature <FEATURE> [<ARG>]
  * \li Params: <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|
@@ -2056,6 +2108,15 @@ void LyXAction::init()
  * \endvar
  */
                { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_CHANGE_PREVIOUS
+ * \li Action: Moves the cursor to the position of the previous change
+               of the change tracking records.
+ * \li Syntax: change-previous
+ * \li Origin: vfr, 4 Apr 2009
+ * \endvar
+ */
+               { LFUN_CHANGE_PREVIOUS, "change-previous", ReadOnly, Edit },
 /*!
  * \var lyx::FuncCode lyx::LFUN_CHANGES_MERGE
  * \li Action: Open change tracking dialog for merging and moves the cursor
@@ -2180,44 +2241,35 @@ void LyXAction::init()
 /*!
  * \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 Notion: Used for bibitem, bibtex, box, branch, citation, ert, external,
+ *             float, graphics, href, include, label, listings, note, phantom,
+ *             ref, space, tabular, vspace, wrap insets.
  * \li Syntax: inset-settings <INSET>
- * \li Params: <INSET>: <box|branch|ert|float|listings|note|phantom|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 bibitem, bibtex, box, branch, command, ert, external,
-                        floats, graphics, include, label, listings, note,
-                        phantom, ref, space, tabular, vspace, wrap 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
+ * \li Params: <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|
+ *                       graphics|href|include|label|listings|note|phantom|ref|
+ *                       space|tabular|vspace|wrap>.
  * \endvar
  */
-               { LFUN_NEXT_INSET_TOGGLE, "next-inset-toggle", ReadOnly, Edit },
+               { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly | AtPoint, Edit },
 /*!
  * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
- * \li Action: Toggles the collapsable inset we are currently in.
+ * \li Action: Toggles the collapsable inset at cursor position,
+ *             or the 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.
+               open/close/toggle are for collapsable insets. toggle is used when no argument is given.\n
+               assign synchronize the branch-inset with activation status of the branch.
+              Used for global toggling when changed activation.
  * \li Origin: lasgouttes, 19 Jul 2001
  * \endvar
  */
-               { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly, Hidden },
+               { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly | AtPoint, Edit },
 /*!
  * \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
+ * \li Syntax: all-insets-toggle [<STATE>] [<INSET>]
+ * \li Params: <STATE>: <toggle|open|close|assign> default: toggle \n
                <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all insets
  * \li Origin: leeming, 30 Mar 2004
  * \endvar
@@ -2400,7 +2452,7 @@ void LyXAction::init()
                { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
 
 /*!
- * \var lyx::FuncCode lyx::WINDOW_NEW
+ * \var lyx::FuncCode lyx::LFUN_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>]
@@ -2803,10 +2855,12 @@ void LyXAction::init()
  * \li Notion: Displays the contents of the current buffer in the chosen
                format, for example, PDF or DVI. This runs the necessary
                converter, calls the defined viewer, and so forth.
- * \li Syntax: buffer-view <FORMAT>
+ * \li Syntax: buffer-view [<FORMAT>]
  * \li Params: <FORMAT>: The format to display, where this is one of the
                          formats defined (in the current GUI) in the
                          Tools>Preferences>File Formats dialog.
+                         If no format is given, the default format as
+                         specified in the same dialog is used.
  * \endvar
  */
                { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
@@ -2817,10 +2871,12 @@ void LyXAction::init()
  * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
                the output will be rewriten - updated. This is useful in case your viewer
               is able to detect such changes (e.g. ghostview for postscript).
- * \li Syntax: buffer-update <FORMAT>
+ * \li Syntax: buffer-update [<FORMAT>]
  * \li Params: <FORMAT>: The format to display, where this is one of the
                          formats defined (in the current GUI) in the
                          Tools>Preferences>File Formats dialog.
+                         If no format is given, the default format as
+                         specified in the same dialog is used.
  * \li Origin: Dekel, 5 Aug 2000
  * \endvar
  */
@@ -2872,9 +2928,13 @@ void LyXAction::init()
 /*!
  * \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
+               from the master buffer, if available.
+ * \li Syntax: master-buffer-update [<FORMAT>]
+ * \li Params: <FORMAT>: The format to display, where this is one of the
+                         formats defined (in the current GUI) in the
+                         Tools>Preferences>File Formats dialog.
+                         If no format is given, the default format as
+                         specified in the same dialog is used.
  * \li Origin: Tommaso, 20 Sep 2007
  * \endvar
  */
@@ -2882,9 +2942,13 @@ void LyXAction::init()
 /*!
  * \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
+               from the master buffer, if available.
+ * \li Syntax: master-buffer-view [<FORMAT>]
+ * \li Params: <FORMAT>: The format to display, where this is one of the
+                         formats defined (in the current GUI) in the
+                         Tools>Preferences>File Formats dialog.
+                         If no format is given, the default format as
+                         specified in the same dialog is used.
  * \li Origin: Tommaso, 20 Sep 2007
  * \endvar
  */
@@ -3140,22 +3204,22 @@ void LyXAction::init()
  * \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
+ * \li Sample: lyx -x "branch-activate answers" -e pdf2 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 },
+               { LFUN_BRANCH_ACTIVATE, "branch-activate", AtPoint, Buffer },
 /*!
- * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
+ * \var lyx::FuncCode lyx::LFUN_BRANCH_DEACTIVATE
  * \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_BRANCH_DEACTIVATE, "branch-deactivate", AtPoint, Buffer },
 
 /*!
  * \var lyx::FuncCode lyx::LFUN_COPY_LABEL_AS_REF
@@ -3166,6 +3230,35 @@ void LyXAction::init()
  */
                { LFUN_COPY_LABEL_AS_REF, "copy-label-as-reference", ReadOnly | NoUpdate, Edit },
 
+/*!
+ * \var lyx::FuncCode lyx::LFUN_INSERT_LABEL_AS_REF
+ * \li Action: Inserts the label as a cross-reference at the position of the cursor.
+ * \li Syntax: insert-label-as-reference
+ * \li Origin: vfr, 7 Apr 2009
+ * \endvar
+ */
+               { LFUN_INSERT_LABEL_AS_REF, "insert-label-as-reference", Noop, Edit},
+
+/*!
+ * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_IN
+ * \li Action: Increases the zoom of the screen fonts.
+ * \li Syntax: buffer-zoom-in [<ZOOM>]
+ * \li Params: <ZOOM>: The zoom in %, the default is 20.
+ * \li Origin: vfr, 30 Mar 2009
+ * \endvar
+ */
+               { LFUN_BUFFER_ZOOM_IN, "buffer-zoom-in", ReadOnly, Buffer },
+
+/*!
+ * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_OUT
+ * \li Action: Decreases the zoom of the screen fonts.
+ * \li Syntax: buffer-zoom-out [<ZOOM>]
+ * \li Params: <ZOOM>: The zoom in %, the default is 20.
+ * \li Origin: vfr, 30 Mar 2009
+ * \endvar
+ */
+               { LFUN_BUFFER_ZOOM_OUT, "buffer-zoom-out", ReadOnly, Buffer },
+
                { LFUN_NOACTION, "", Noop, Hidden }
 #ifndef DOXYGEN_SHOULD_SKIP_THIS
        };