* \endvar
*/
{ LFUN_ERT_INSERT, "ert-insert", Noop, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_FLOAT_INSERT
+ * \li Action: Inserts a float inset.
+ * \li Syntax: float-insert <TYPE>
+ * \li Params: <TYPE>: type of float depends on the used textclass. Usually
+ "algorithm", "table", "figure" parameters can be given.
+ * \li Origin: Lgb, 27 Jun 2000
+ * \endvar
+ */
{ LFUN_FLOAT_INSERT, "float-insert", Noop, Edit },
+/*!
+ * \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 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
*/
{ 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
*/
{ 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.
* \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.
* \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.
* \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.
* \endvar
*/
{ LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
- { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, 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
* \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
* \endvar
*/
{ LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit },
- { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
/*!
* \var lyx::FuncCode lyx::LFUN_WORD_RIGHT
* \li Action: Moves the cursor to the next beginning of a word "on the right".
* \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
+ * \li Action: Capitalizes the words in the selection (i.e. the first letters)
+ or the letter on the cursor position.
+ * \li Syntax: word-capitalize
+ * \endvar
+ */
+ { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_WORD_UPCASE
+ * \li Action: Change the words in the selection or from the cursor position
+ to the end of word to the upper case.
+ * \li Syntax: word-upcase
+ * \endvar
+ */
{ LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_WORD_LOWCASE
+ * \li Action: Change the words in the selection or from the cursor position
+ to the end of word to the lower case.
+ * \li Syntax: word-lowcase
+ * \endvar
+ */
+ { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
/*!
* \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
* \li Action: Look up thesaurus entries with respect to the word under the cursor.
* \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.
*/
{ 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 },
* \endvar
*/
{ LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_LAYOUT_TABULAR
+ * \li Action: Launches the tabular settings dialog.
+ * \li Syntax: layout-tabular
+ * \li Origin: Jug, 31 Jul 2000
+ * \endvar
+ */
{ LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
/*!
* \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE
* \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.
{ 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 },
projects / lyx.git / blobdiff