]> git.lyx.org Git - lyx.git/blobdiff - src/LyXAction.cpp
* Doxy.
[lyx.git] / src / LyXAction.cpp
index 424aa86796fcc656ae3f9012c9047b29a2df659c..5fe8245ed618e53eaf0bcb70011fd7dc084a74e7 100644 (file)
@@ -480,18 +480,62 @@ void LyXAction::init()
  */
                { LFUN_APPENDIX, "appendix", Noop, Edit },
 
+/*!
+ * \var lyx::FuncCode lyx::LFUN_INDEX_INSERT
+ * \li Action: Inserts Index entry.
+ * \li Notion: It automatically takes the word on the cursor position.
+ * \li Syntax: index-insert
+ * \li Origin: Angus, 3 Aug 2000
+ * \endvar
+ */
                { LFUN_INDEX_INSERT, "index-insert", Noop, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_INDEX_PRINT
+ * \li Action: Inserts list of Index entries on a new page.
+ * \li Syntax: index-print
+ * \li Origin: Lgb, 27 Feb 1997
+ * \endvar
+ */
                { LFUN_INDEX_PRINT, "index-print", Noop, Edit },
 
+/*!
+ * \var lyx::FuncCode lyx::LFUN_NOMENCL_INSERT
+ * \li Action: Inserts Nomenclature entry.
+ * \li Notion: It automatically takes the word on the cursor position if no symbol is given.
+ * \li Syntax: nomencl-insert [<SYMBOL>]
+ * \li Origin: Ugras, 4 Nov 2006
+ * \endvar
+ */
                { LFUN_NOMENCL_INSERT, "nomencl-insert", Noop, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_NOMENCLATURE_PRINT
+ * \li Action: Inserts list of Nomenclature entries.
+ * \li Syntax: nomenclature-print
+ * \li Origin: Ugras, 4 Nov 2006
+ * \endvar
+ */
                { LFUN_NOMENCL_PRINT, "nomencl-print", Noop, Edit },
 
+/*!
+ * \var lyx::FuncCode lyx::LFUN_NOTE_INSERT
+ * \li Action: Inserts Note on the current cursor postion,
+               move selection inside the inset.
+ * \li Syntax: note-insert [<TYPE>]
+ * \li Params: <TYPE>: <Note|Greyedout|Comment> default: Note
+ * \endvar
+ */
                { LFUN_NOTE_INSERT, "note-insert", Noop, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_NOTE_NEXT
+ * \li Action: Moves the cursor to the begining of next Note inset.
+ * \li Syntax: note-next
+ * \endvar
+ */
                { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
 /*!
  * \var lyx::FuncCode lyx::LFUN_NEWLINE_INSERT
  * \li Action: Inserts a line break or new line.
- * \li Syntax: newline-insert <ARG>
+ * \li Syntax: newline-insert [<ARG>]
  * \li Params: <ARG>: <newline|linebreak> default: newline
  * \li Origin: JSpitzm, 25 Mar 2008
  * \endvar
@@ -506,8 +550,6 @@ 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.
@@ -538,9 +580,35 @@ void LyXAction::init()
  * \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
@@ -561,7 +629,6 @@ void LyXAction::init()
  */
                { LFUN_SCREEN_RECENTER, "screen-recenter", 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.
@@ -726,6 +793,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
@@ -798,6 +876,13 @@ 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
+ * \li Author: Andre, 11 Sep 2002
+ * \endvar
+ */
                { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
 /*!
  * \var lyx::FuncCode lyx::LFUN_WORD_CAPITALIZE
@@ -831,16 +916,75 @@ void LyXAction::init()
  * \endvar
  */
                { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN
+ * \li Action: Move the cursor to the beginning of the document.
+ * \li Syntax: buffer-begin
+ * \endvar
+ */
                { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN_SELECT
+ * \li Action: Move the cursor to the beginning of the document adding the
+               traversed text to the selection.
+ * \li Syntax: buffer-begin-select
+ * \endvar
+ */
                { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_BUFFER_END
+ * \li Action: Move the cursor to the end of the document.
+ * \li Syntax: buffer-end
+ * \endvar
+ */
                { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_BUFFER_END_SELECT
+ * \li Action: Move the cursor to the end of the document adding the
+               traversed text to the selection.
+ * \li Syntax: buffer-end-select
+ * \endvar
+ */
                { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
 
+/*!
+ * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN
+ * \li Action: Move the cursor to the begining of the (screen) line.
+ * \li Syntax: line-begin
+ * \endvar
+ */
                { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN_SELECT
+ * \li Action: Move the cursor to the beginning of the (screen) line adding the
+               traversed text to the selection.
+ * \li Syntax: line-begin-select
+ * \endvar
+ */
                { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
-               { LFUN_LINE_DELETE, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
+/*!
+ * \var lyx::FuncCode lyx::LFUN_LINE_END
+ * \li Action: Move the cursor to the end of the (screen) line.
+ * \li Syntax: line-end
+ * \endvar
+ */
                { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_LINE_END_SELECT
+ * \li Action: Move the cursor to the end of the (screen) line adding the
+               traversed text to the selection.
+ * \li Syntax: line-end-select
+ * \endvar
+ */
                { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_LINE_DELETE
+ * \li Action: Deletes the letters to the end of the (screen) line or
+               deletes the selection.
+ * \li Syntax: line-delete-forward
+ * \endvar
+ */
+               { LFUN_LINE_DELETE, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
 /*!
  * \var lyx::FuncCode lyx::LFUN_COPY
  * \li Action: Copies to the clipboard the last edit.
@@ -901,7 +1045,21 @@ void LyXAction::init()
  */
                { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
 
+/*!
+ * \var lyx::FuncCode lyx::LFUN_DEPTH_DECREMENT
+ * \li Action: Decrease the nesting depth of the (selected) paragraph(s)
+               inside lists.
+ * \li Syntax: depth-decrement
+ * \endvar
+ */
                { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_DEPTH_INCREMENT
+ * \li Action: Increase the nesting depth of the (selected) paragraph(s)
+               inside lists.
+ * \li Syntax: depth-increment
+ * \endvar
+ */
                { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
                { LFUN_ENVIRONMENT_INSERT, "environment-insert", Noop, Edit },
 
@@ -1349,15 +1507,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.