#include "support/debug.h"
#include "support/lstrings.h"
-#include "support/assert.h"
+#include "support/lassert.h"
using namespace std;
using namespace lyx::support;
* \endvar
*/
{ LFUN_ACCENT_OGONEK, "accent-ogonek", Noop, Edit },
- { LFUN_ACCENT_SPECIAL_CARON, "accent-special-caron", Noop, Edit },
/*!
* \var lyx::FuncCode lyx::LFUN_ACCENT_TIE
* \li Action: Adds a tie \htmlonly (a͡)\endhtmlonly
* \endvar
*/
{ LFUN_LISTING_INSERT, "listing-insert", Noop, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_QUOTE_INSERT
+ * \li Action: Inserts quotes according to the type and quote-language preference.
+ * \li Action: Currently English, Swedish, German, Polish, French, Danish quotes
+ are distinguished.
+ * \li Syntax: quote-insert [<TYPE>]
+ * \li Params: TYPE: 'single' for single quotes, otherwise double quotes will be used.
+ * \endvar
+ */
{ LFUN_QUOTE_INSERT, "quote-insert", Noop, Edit },
/*!
* \var lyx::FuncCode lyx::LFUN_INFO_INSERT
* \endvar
*/
{ LFUN_INFO_INSERT, "info-insert", Noop, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_BRANCH_INSERT
+ * \li Action: Inserts branch inset.
+ * \li Syntax: branch-insert <BRANCH-NAME>
+ * \li Origin: vermeer, 17 Aug 2003
+ * \endvar
+ */
{ LFUN_BRANCH_INSERT, "branch-insert", Noop, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_BOX_INSERT
+ * \li Action: Inserts Box inset.
+ * \li Syntax: box-insert [<TYPE>]
+ * \li Params: <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox \n
+ Framed is the default one.
+ * \li Origin: vermeer, 7 Oct 2003
+ * \endvar
+ */
{ LFUN_BOX_INSERT, "box-insert", Noop, Edit },
/*!
* \var lyx::FuncCode lyx::LFUN_FLEX_INSERT
* \endvar
*/
{ LFUN_SPACE_INSERT, "space-insert", Noop, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_HYPERLINK_INSERT
+ * \li Action: Inserts hyperlinks into the document (clickable in pdf output).
+ * \li Notion: Hyperlink target can be set via selection + hyperlink-insert function.
+ * \li Syntax: href-insert [<TARGET>]
+ * \li Origin: CFO-G, 21 Nov 1997
+ * \endvar
+ */
{ LFUN_HYPERLINK_INSERT, "href-insert", Noop, Edit },
/*!
* \var lyx::FuncCode lyx::LFUN_SPECIALCHAR_INSERT
*/
{ LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD
+ * \li Action: Moves the cursor to the logically previous beginning of a word.
+ * \li Notion: This is not the action which should be bound to the arrow keys,
+ because backwards may be left or right, depending on the
+ language. The arrow keys should be bound to #LFUN_WORD_LEFT or
+ #LFUN_WORD_RIGHT actions, which in turn may employ this one.
+ * \li Syntax: word-backward
+ * \endvar
+ */
{ LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD_SELECT
+ * \li Action: Moves the cursor to the logically previous beginning of a word,
+ adding the logically traversed text to the selection.
+ * \li Notion: See also #LFUN_WORD_BACKWARD.
+ * \li Syntax: word-backward-select
+ * \endvar
+ */
{ LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
{ LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
{ LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
*/
{ LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
{ LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD
+ * \li Action: Moves the cursor to the logically next beginning of a word.
+ * \li Notion: This is not the action which should be bound to the arrow keys,
+ because forward may be left or right, depending on the language.
+ The arrow keys should be bound to #LFUN_WORD_LEFT or
+ #LFUN_WORD_RIGHT actions, which in turn may employ this one.
+ * \li Syntax: word-forward
+ * \endvar
+ */
{ LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD_SELECT
+ * \li Action: Moves the cursor to the logically next beginning of a word,
+ adding the logically traversed text to the selection.
+ * \li Notion: See also #LFUN_WORD_FORWARD.
+ * \li Syntax: word-forward-select
+ * \endvar
+ */
{ LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_WORD_LEFT
+ * \li Action: Moves the cursor to the next beginning of a word "on the left".
+ * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
+ "left" key is pressed. Generally, it moves the cursor to the
+ next beginning of a word on the left. However, in Bidi text this
+ become slightly more complicated, and there are different modes
+ of cursor movement. In "visual mode", this moves left, plain and
+ simple. In "logical mode", movement is logically forward in RTL
+ paragraphs, and logically backwards in LTR paragraphs.
+ * \li Syntax: word-left
+ * \li Origin: dov, 28 Oct 2007
+ * \endvar
+ */
{ LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_WORD_LEFT_SELECT
+ * \li Action: Moves the cursor to the next beginning of a word "on the left",
+ adding *logically* traversed text to the selection.
+ * \li Notion: See also #LFUN_WORD_LEFT for exact details of the movement.
+ * \li Syntax: word-left-select
+ * \li Origin: dov, 28 Oct 2007
+ * \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".
+ * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
+ "right" key is pressed. Generally, it moves the cursor to the
+ next beginning of a word on the right. However, in Bidi text
+ this become slightly more complicated, and there are different
+ modes of cursor movement. In "visual mode", this moves right,
+ plain and simple. In "logical mode", movement is logically
+ forward in LTR paragraphs, and logically backwards in RTL
+ paragraphs.
+ * \li Syntax: word-right
+ * \li Origin: dov, 28 Oct 2007
+ * \endvar
+ */
{ LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT_SELECT
+ * \li Action: Moves the cursor to the next beginning of a word "on the right",
+ adding *logically* traversed text to the selection.
+ * \li Notion: See also #LFUN_WORD_RIGHT for exact details of the movement.
+ * \li Syntax: word-right-select
+ * \li Origin: dov, 28 Oct 2007
+ * \endvar
+ */
{ LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
{ LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
{ LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
{ LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
/*!
* \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
- * \li Action: Jump to a paragraph given by its id number.
+ * \li Action: Jump to a paragraph given by its id number and optionally the
+ desired position within the paragraph.
* \li Notion: Note that id number of paragraph is not the sequential number of paragraph
seen on the screen. Moreover the id is unique for all opened buffers (documents).
- * \li Syntax: paragraph-goto <PAR_ID_NUMBER>
+ * \li Syntax: paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
+ * \li Params: <PAR_ID_NUMBER>: paragraph id
+ <POSITION_IN_PAR>: desired position within the paragraph
* \li Origin: Dekel, 26 Aug 2000
* \endvar
*/
* \endvar
*/
{ LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
-
- { LFUN_EXTERNAL_EDIT, "external-edit", Noop, Edit },
- { LFUN_GRAPHICS_EDIT, "graphics-edit", Noop, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_INSET_EDIT
+ * \li Action: Edit the inset at cursor with an external application,
+ * if one is attributed.
+ * \li Syntax: inset-edit [<INSET_PARAMS>]
+ * \li Params: <INSET_PARAMS>: Parameters for the inset.
+ Currently only the filename will be considered.
+ * \li Origin: JSpitzm, 27 Apr 2006
+ * \endvar
+ */
+ { LFUN_INSET_EDIT, "inset-edit", Noop, Edit },
{ LFUN_CELL_BACKWARD, "cell-backward", Noop, Edit },
{ LFUN_CELL_FORWARD, "cell-forward", Noop, Edit },
* \endvar
*/
{ LFUN_ALL_INSETS_TOGGLE, "all-insets-toggle", ReadOnly, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_GRAPHICS_GROUPS_UNIFY
+ * \li Action: Unify all graphics insets with the one given as an parameter.
+ * \li Notion: This is internally used for synchronize certain group of graphics insets.
+ * \li Syntax: graphics-groups-unigfy <GRAPHICS_PARAMS>
+ * \li Params: <GRAPHICS_PARAMS>: Parameters for graphics inset
+ (syntax can be seen in .lyx files).
+ * \li Origin: sanda, 6 May 2008
+ * \endvar
+ */
+ { LFUN_GRAPHICS_GROUPS_UNIFY, "graphics-groups-unify", ReadOnly, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_SET_GRAPHICS_GROUP
+ * \li Action: Set the group for the graphics inset on the cursor position.
+ * \li Syntax: set-graphics-group [<GROUP>]
+ * \li Params: <GROUP>: Id for an existing group. In case tthe Id is an empty string,
+ the graphics inset is removed from the current group.
+ * \li Origin: sanda, 6 May 2008
+ * \endvar
+ */
+ { LFUN_SET_GRAPHICS_GROUP, "set-graphics-group", ReadOnly, Edit },
/*!
* \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
* \endvar
*/
{ LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT
+ * \li Action: Inserts label to text or displayed formula.
+ * \li Syntax: label-insert [<LABEL>]
+ * \li Params: <LABEL>: Requested label. If no label is given dialog requesting
+ name will be opened.
+ * \endvar
+ */
{ LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
/*!
* \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
{ LFUN_ESCAPE, "escape", ReadOnly, Edit },
{ LFUN_SERVER_CHAR_AFTER, "server-char-after", ReadOnly, System },
- { LFUN_SERVER_GET_FONT, "server-get-font", ReadOnly, System },
{ LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
{ LFUN_SERVER_GET_NAME, "server-get-name", ReadOnly, System },
- { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
/*!
* \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
* \li Action: Sets the cursor position based on the row number of generated TeX file.
*/
{ LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly, System },
{ LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
+ * \li Action: Sets the cursor position based on the editing area coordinates
+ (similar as clicking on that point with left mouse button).
+ * \li Syntax: server-set-xy <X> <Y>
+ * \endvar
+ */
{ LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
+ * \li Action: Returns the coordinates of cursor position in the editing area.
+ * \li Syntax: server-get-xy
+ * \endvar
+ */
+ { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
+ * \li Action: Generates the code (literate programming).
+ * \li Notion: Latex file with extension \literate_extension is generated.
+ Then LyX invokes \build_command (with a default of``make'') to generate the code and
+ \build_error_filter to process the compilation error messages. \n
+ In case you want to process your literate file with a script, or some other program,
+ just insert in your lyxrc file an entry with:\n
+ \build_command "my_script my_arguments" \n
+ The \build_error_filter differs from the \literate_error_filter only in that the
+ former will identify error messages from your compiler.
+ * \li Syntax: build-program
+ * \endvar
+ */
{ LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
/*!
projects / lyx.git / blobdiff