]> git.lyx.org Git - lyx.git/blobdiff - src/LyXAction.cpp
RenderGraphic::metrics(): return early.
[lyx.git] / src / LyXAction.cpp
index 2663b7a4d7737bd730322e4f3b0b379bf38ed449..9cf78feadf759b74cf0ddd6a001a7583889c5b96 100644 (file)
@@ -282,12 +282,32 @@ void LyXAction::init()
 /*!
  * \var lyx::FuncCode lyx::LFUN_FLOAT_WIDE_INSERT
  * \li Action: Inserts float insets as in #LFUN_FLOAT_INSERT but span multiple columns.
- * \li Notion: Corresponds to the "figure*" in LaTeX.
+ * \li Notion: Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
  * \li Syntax: float-wide-insert <TYPE>
+ * \li Params: <TYPE>: type of float depends on the used textclass. Usually
+                       "algorithm", "table", "figure" parameters can be given.
  * \li Origin: Lgb, 31 Oct 2001
  * \endvar
  */
                { LFUN_FLOAT_WIDE_INSERT, "float-wide-insert", Noop, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_FLOAT_LIST_INSERT
+ * \li Action: Inserts the list of floats in the document.
+ * \li Syntax: float-list-insert <TYPE>
+ * \li Params: <TYPE>: type of float depends on the used textclass. Usually
+                       "algorithm", "table", "figure" parameters can be given.
+ * \li Origin: Lgb, 3 May 2001
+ * \endvar
+ */
+               { LFUN_FLOAT_LIST_INSERT, "float-list-insert", Noop, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_WRAP_INSERT
+ * \li Action: Inserts floats wrapped by the text around.
+ * \li Syntax: wrap-insert <TYPE>
+ * \li Params: <TYPE>: table|figure
+ * \li Origin: Dekel, 7 Apr 2002
+ * \endvar
+ */
                { LFUN_WRAP_INSERT, "wrap-insert", Noop, Edit },
 /*!
  * \var lyx::FuncCode lyx::LFUN_OPTIONAL_INSERT
@@ -478,11 +498,6 @@ void LyXAction::init()
  */
                { LFUN_NEWLINE_INSERT, "newline-insert", Noop, Edit },
 
-
-#if 0
-               { LFUN_LIST_INSERT, "list-insert", Noop, Edit },
-#endif
-
 /*!
  * \var lyx::FuncCode lyx::LFUN_ESCAPE
  * \li Action: Clears the selection. If no text is selected call #LFUN_FINISHED_FORWARD.
@@ -491,14 +506,66 @@ void LyXAction::init()
  * \endvar
  */
                { LFUN_ESCAPE, "escape", ReadOnly, Edit },
-               { LFUN_DELETE_BACKWARD_SKIP, "delete-backward-skip", Noop, Edit },
-               { LFUN_DELETE_FORWARD_SKIP, "delete-forward-skip", Noop, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_DOWN
+ * \li Action: Moves the cursor one line in downward direction.
+ * \li Syntax: down
+ * \endvar
+ */
                { LFUN_DOWN, "down", ReadOnly | NoUpdate, Edit },
-               { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_UP
+ * \li Action: Moves the cursor one line in upward direction.
+ * \li Syntax: up
+ * \endvar
+ */
                { LFUN_UP, "up", ReadOnly | NoUpdate, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_DOWN_SELECT
+ * \li Action: Moves the cursor one line in downward direction adding the current
+               position to the selection.
+ * \li Syntax: down-select
+ * \endvar
+ */
+               { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_UP_SELECT
+ * \li Action: Moves the cursor one line in upward direction adding the current
+               position to the selection.
+ * \li Syntax: up-select
+ * \endvar
+ */
                { LFUN_UP_SELECT, "up-select", ReadOnly | SingleParUpdate, Edit },
+/*!
+ * \var lyx::FuncCode lyx::SCREEN_DOWN
+ * \li Action: Moves the cursor one page in downward direction.
+ * \li Syntax: screen-down
+ * \endvar
+ */
                { LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_SCREEN_UP
+ * \li Action: Moves the cursor one page in upward direction.
+ * \li Syntax: screen-up
+ * \endvar
+ */
+               { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN_SELECT
+ * \li Action: Moves the cursor one screen in downward direction adding the current
+               position to the selection.
+ * \li Syntax: screen-down-select
+ * \endvar
+ */
                { LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_SCREEN_UP_SELECT
+ * \li Action: Moves the cursor one page in upward direction adding the current
+               position to the selection.
+ * \li Syntax: screen-up-select
+ * \endvar
+ */
+               { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit },
 /*!
  * \var lyx::FuncCode lyx::LFUN_SCROLL
  * \li Action: Scroll the buffer view.
@@ -517,10 +584,7 @@ void LyXAction::init()
  * \endvar
  */
                { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit },
-               { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit },
-               { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit },
 
-               { LFUN_ERROR_NEXT, "error-next", ReadOnly, Edit },
 /*!
  * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD
  * \li Action: Moves the cursor one position logically backwards.
@@ -541,8 +605,20 @@ void LyXAction::init()
  * \endvar
  */
                { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit },
-               { LFUN_CHAR_DELETE_BACKWARD, "delete-backward", SingleParUpdate, Edit },
-               { LFUN_CHAR_DELETE_FORWARD, "delete-forward", SingleParUpdate, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_BACKWARD
+ * \li Action: Deletes one character in the backward direction (usually the "BackSpace" key).
+ * \li Syntax: char-delete-backward
+ * \endvar
+ */
+               { LFUN_CHAR_DELETE_BACKWARD, "char-delete-backward", SingleParUpdate, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_FORWARD
+ * \li Action: Deletes one character in the backward direction (usually the "Delete" key).
+ * \li Syntax: char-delete-forward
+ * \endvar
+ */
+               { LFUN_CHAR_DELETE_FORWARD, "char-delete-forward", SingleParUpdate, Edit },
 /*!
  * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD
  * \li Action: Moves the cursor one position logically forward.
@@ -630,7 +706,19 @@ void LyXAction::init()
  * \endvar
  */
                { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_BACKWARD
+ * \li Action: Deletes characters to the begining of the word (usually the "C+BackSpace" key).
+ * \li Syntax: word-delete-backward
+ * \endvar
+ */
                { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_FORWARD
+ * \li Action: Deletes characters to the end of the word (usually the "C+Delete" key).
+ * \li Syntax: word-delete-forward
+ * \endvar
+ */
                { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
 /*!
  * \var lyx::FuncCode lyx::LFUN_WORD_FIND_FORWARD
@@ -661,6 +749,17 @@ void LyXAction::init()
  * \endvar
  */
                { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_WORD_FIND
+ * \li Action: Replace a string in the document.
+ * \li Syntax: word-replace [<DATA>]
+ * \li Params: <DATA>: data is of the form
+                       "<search> \n
+                        <replace> \n
+                        <casesensitive> <matchword> <all> <forward>"
+ * \li Origin: poenitz, Jan 7 2004
+ * \endvar
+ */
                { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
 /*!
  * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD
@@ -733,6 +832,12 @@ void LyXAction::init()
  * \endvar
  */
                { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_WORD_SELECT
+ * \li Action: Puts the word where the cursor stands into the selection.
+ * \li Syntax: word-select
+ * \endvar
+ */
                { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
 /*!
  * \var lyx::FuncCode lyx::LFUN_WORD_CAPITALIZE
@@ -1284,15 +1389,6 @@ void LyXAction::init()
  * \endvar
  */
                { LFUN_BREAK_PARAGRAPH, "break-paragraph", Noop, Edit },
-/*!
- * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH_SKIP
- * \li Action: Breaks the current paragraph at the current location,
-               unless used at the beginning of a line, where it sets
-               the label width string to empty.
- * \li Syntax: break-paragraph-skip
- * \endvar
- */
-               { LFUN_BREAK_PARAGRAPH_SKIP, "break-paragraph-skip", Noop, Edit },
 /*!
  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
  * \li Action: Change paragraph settings.
@@ -1743,8 +1839,6 @@ void LyXAction::init()
                { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
                { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
 
-               { LFUN_FLOAT_LIST, "float-list", Noop, Edit },
-
                { LFUN_SERVER_CHAR_AFTER, "server-char-after", ReadOnly, System },
                { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
                { LFUN_SERVER_GET_NAME, "server-get-name", ReadOnly, System },