* \li Action: Inserts CharStyle, Custom inset or XML short element.
* \li Notion: Look into the Customization manual for more information about
these elements.\n
+ To make this command enabled the layout file for the document
+ class you're using has to load the character styles. There are
+ a few contained in the Logical Markup module. You can also of
+ course create some yourself. \n
For dissolving the element see #LFUN_INSET_DISSOLVE.
* \li Syntax: flex-insert <TYPE:Name>
* \li Params: TYPE: CharStyle|Custom|Element|Standard
sub-menu this flex inset is in on the LyX menu tree.
If Standard (currently unused): none of these.
Name: This name must be defined either in your layout file
- or imported by some module. The definition is\n
+ or imported by some module. The definition is \n
InsetLayout <TYPE:Name>
* \li Sample: flex-insert CharStyle:Code
* \endvar
* \endvar
*/
{ LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_NOTES_MUTATE
+ * \li Action: Changes all Note insets of a particular type (source)
+ to a different type (target) fot the current document.
+ * \li Syntax: notes-mutate <SOURCE> <TARGET>
+ * \li Params: <SOURCE/TARGET>: Note|Comment|Greyedout
+ * \li Origin: ps, 18 Jun 2008
+ * \endvar
+ */
+ { LFUN_NOTES_MUTATE, "notes-mutate", Argument, Edit },
/*!
* \var lyx::FuncCode lyx::LFUN_NEWLINE_INSERT
* \li Action: Inserts a line break or new line.
{ LFUN_CUT, "cut", Noop, Edit },
/*!
* \var lyx::FuncCode lyx::LFUN_PASTE
- * \li Action: Pastes from the active clipboard.
- * \li Syntax: paste
+ * \li Action: Pastes material from the active clipboard.
+ * \li Syntax: paste [<TYPE>]
+ * \li Params: <TYPE>: pdf|png|jpeg|linkback
* \endvar
*/
{ LFUN_PASTE, "paste", Noop, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE
+ * \li Action: Pastes text from the active clipboard.
+ * \li Syntax: clipboard-paste [<ARG>]
+ * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
+ * \li Origin: baum, 10 Jul 2006
+ * \endvar
+ */
{ LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
/*!
* \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
- * \li Action: Pastes the material currently selected.
- * \li Syntax: primary-selection-paste
+ * \li Action: Pastes the currently text selected text.
+ * \li Notion: Primary selection mechanism is linux-only thing.
+ * \li Syntax: primary-selection-paste [<ARG>]
+ * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
* \endvar
*/
{ LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
* \endvar
*/
{ LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
- { LFUN_ENVIRONMENT_INSERT, "environment-insert", Noop, Edit },
/*!
* \var lyx::FuncCode lyx::LFUN_FONT_BOLD
*/
{ LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
- { LFUN_BIBITEM_INSERT, "bibitem-insert", Noop, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_CITATION_INSERT
+ * \li Action: Inserts citation from loaded citation database.
+ * \li Syntax: citation-insert [<KEY>[|<TEXT_BEFORE>]]
+ * \li Params: <KEY>: Citation (shortcut listed in available citations). \n
+ <TEXT_BEFORE>: text which should appear before citation.
+ * \li Origin: AAS, 97-02-23
+ * \endvar
+ */
{ LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_ADD
+ * \li Action: Adds database, which will be used for bibtex citations.
+ * \li Notion: Databases are added to the first BibTeX inset
+ (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
+ * \li Syntax: bibtex-database-add <DATABASE-NAME>
+ * \li Origin: Ale, 30 May 1997
+ * \endvar
+ */
{ LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_DEL
+ * \li Action: Adds database, which will be used for bibtex citations.
+ * \li Notion: Databases are deleted from the first BibTeX inset
+ (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
+ * \li Syntax: bibtex-database-del <DATABASE-NAME>
+ * \li Origin: Ale, 30 May 1997
+ * \endvar
+ */
{ LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
/*!
* \endvar
*/
{ LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UPDATE
+ * \li Action: Updates the values inside the paragraph dialog from the paragraph.
+ * \li Notion: This is internal LFUN, not to be used by users. Called internally
+ by #LFUN_DIALOG_UPDATE.
+ * \li Origin: leeming, 13 Mar 2003
+ * \endvar
+ */
{ LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
/*!
*/
{ LFUN_INSET_EDIT, "inset-edit", Noop, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_TABULAR_INSERT
+ * \li Action: Inserts table into the document.
+ * \li Syntax: tabular-insert [<ROWS> <COLUMNS>]
+ * \li Params: In case no arguments are given show insert dialog.
+ * \li Origin: Jug, 12 Apr 2000
+ * \endvar
+ */
+ { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
+/*!
+ * \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
+ * \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|
+ align-left|align-right|align-center|align-block|valign-top|valign-bottom|
+ valign-middle|m-align-left|m-align-right|m-align-center|m-valign-top|
+ m-valign-bottom|m-valign-middle|multicolumn|set-all-lines|unset-all-lines|
+ set-longtabular|unset-longtabular|set-pwidth|set-mpwidth|
+ set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|
+ set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|
+ unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|
+ set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
+ set-special-column|set-special-multi|set-booktabs|unset-booktabs|
+ set-top-space|set-bottom-space|set-interline-space|set-border-lines \n
+ <ARG>: additional argument for some commands, use debug mode to explore its values.
+ * \li Origin: Jug, 28 Jul 2000
+ * \endvar
+ */
+ { LFUN_TABULAR_FEATURE, "tabular-feature", Noop, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_CELL_BACKWARD
+ * \li Action: Moves the cursor to the previous cell inside the table.
+ * \li Syntax: cell-backward
+ * \li Origin: Jug, 22 May 2000
+ * \endvar
+ */
{ LFUN_CELL_BACKWARD, "cell-backward", Noop, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_CELL_FORWARD
+ * \li Action: Moves the cursor to the next cell inside the table.
+ * \li Syntax: cell-forward
+ * \endvar
+ */
{ LFUN_CELL_FORWARD, "cell-forward", Noop, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_CELL_SPLIT
+ * \li Action: Splits cell and shifts right part to the next cell (inside the math grid).
+ * \li Syntax: cell-split
+ * \li Origin: Ale, 15 May 1997
+ * \endvar
+ */
{ LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
- { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
- { LFUN_TABULAR_FEATURE, "tabular-feature", Noop, Edit },
{ LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
{ LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
{ LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
{ LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_CHANGES_TRACK
+ * \li Action: Toggles change tracking to on/off.
+ * \li Syntax: changes-track
+ * \li Origin: levon, 1 Oct 2002
+ * \endvar
+ */
{ LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_CHANGES_OUTPUT
+ * \li Action: Toggles showing of change tracking in typesetted output.
+ * \li Syntax: changes-output
+ * \li Origin: jspitzm, 21 Jan 2005
+ * \endvar
+ */
{ LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_CHANGE_NEXT
+ * \li Action: Moves the cursor to the position of the next change
+ of the change tracking records.
+ * \li Syntax: change-next
+ * \li Origin: schmitt, 4 Oct 2006
+ * \endvar
+ */
{ LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_CHANGES_MERGE
+ * \li Action: Open change tracking dialog for merging and moves the cursor
+ to the position of the next change.
+ * \li Syntax: changes-merge
+ * \li Origin: Levon, 16 Oct 2002
+ * \endvar
+ */
{ LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_CHANGE_ACCEPT
+ * \li Action: Accepts tracked change inside the selection.
+ * \li Syntax: change-accept
+ * \li Origin: Levon, 16 Oct 2002
+ * \endvar
+ */
{ LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_CHANGE_REJECT
+ * \li Action: Rejects tracked change inside the selection.
+ * \li Syntax: change-accept
+ * \li Origin: Levon, 16 Oct 2002
+ * \endvar
+ */
{ LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_ACCEPT
+ * \li Action: Accepts all tracked changes in the document.
+ * \li Syntax: all-changes-accept
+ * \li Origin: Levon, 16 Oct 2002
+ * \endvar
+ */
{ LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_REJECT
+ * \li Action: Rejects all tracked changes in the document.
+ * \li Notion: Reject does not work recursively; the user may have to repeat the operation.
+ * \li Syntax: all-changes-reject
+ * \li Origin: Levon, 16 Oct 2002
+ * \endvar
+ */
{ LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
/*!
* \endvar
*/
{ LFUN_NEXT_INSET_MODIFY, "next-inset-modify", ReadOnly, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_INSET_DIALOG_UPDATE
+ * \li Action: Updates the values inside the dialog from the inset.
+ * \li Notion: This is internal LFUN, not to be used by users. Called internally
+ by #LFUN_DIALOG_UPDATE
+ * \li Params: <DIALOG-NAME>
+ * \li Origin: leeming, 25 Feb 2003
+ * \endvar
+ */
{ LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
/*!
* \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
* \li Origin: sanda, 6 May 2008
* \endvar
*/
- { LFUN_GRAPHICS_GROUPS_UNIFY, "graphics-groups-unify", ReadOnly, Edit },
+ { LFUN_GRAPHICS_GROUPS_UNIFY, "graphics-groups-unify", Argument, Edit },
/*!
* \var lyx::FuncCode lyx::LFUN_SET_GRAPHICS_GROUP
* \li Action: Set the group for the graphics inset on the cursor position.
* \li Origin: sanda, 6 May 2008
* \endvar
*/
- { LFUN_SET_GRAPHICS_GROUP, "set-graphics-group", ReadOnly, Edit },
+ { LFUN_SET_GRAPHICS_GROUP, "set-graphics-group", Noop, Edit },
/*!
* \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
*/
{ LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_LANGUAGE
+ * \li Action: Set language from the current cursor position.
+ * \li Syntax: language <LANG>
+ * \li Params: <LANG>: Requested language. Look in lib/languages for
+ the list.
+ * \li Origin: Dekel, 2 Mar 2000
+ * \endvar
+ */
{ LFUN_LANGUAGE, "language", Noop, Edit },
/*!
* \endvar
*/
{ LFUN_CLOSE_TAB_GROUP, "close-tab-group", ReadOnly, Buffer },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW
+ * \li Action: Shows hidden dialog or create new one for a given function/inset settings etc.
+ * \li Syntax: dialog-show <NAME> [<DATA>]
+ * \li Params: <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
+ document|errorlist|ert|external|file|findreplace|float|graphics|
+ include|index|info|nomenclature|label|log|mathdelimiter|mathmatrix|
+ note|paragraph|prefs|print|ref|sendto|space|spellchecker|symbols|
+ tabular|tabularcreate|thesaurus|texinfo|toc|href|view-source|vspace|
+ wrap|listings|<SPECIAL> \n
+ <SPECIAL>: latexlog|vclog \n
+ <DATA>: data, usually settings for the given dialog. Use debug mode for the
+ details.
+ * \li Origin: leeming, 17 Jun 2003
+ * \endvar
+ */
{ LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW_NEW_INSET
+ * \li Action: Shows hidden dialog or create new one for a given inset settings etc.
+ * \li Notion: Internally uses #LFUN_DIALOG_SHOW with processed data for a given inset.
+ * \li Syntax: dialog-show-new-inset <NAME> [<DATA>]
+ * \li Params: See #LFUN_DIALOG_SHOW .
+ * \li Origin: leeming, 25 Feb 2003
+ * \endvar
+ */
{ LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_DIALOG_UPDATE
+ * \li Action: Updates the dialog values from the inset/paragraph/document.
+ * \li Syntax: dialog-update <NAME>
+ * \li Params: <NAME>: paragraph|prefs|<INSET> \n
+ <INSET>: inset name
+ * \li Origin: leeming, 25 Feb 2003
+ * \endvar
+ */
{ LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_DIALOG_HIDE
+ * \li Action: Hides showed dialog. Counterpart to #LFUN_DIALOG_SHOW .
+ * \li Syntax: dialog-hide <NAME>
+ * \li Params: See #LFUN_DIALOG_SHOW .
+ * \li Origin: leeming, 25 Feb 2003
+ * \endvar
+ */
{ LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_DIALOG_TOGGLE
+ * \li Action: Toggles dialog between showed/hidden state.
+ * \li Notion: Internally uses #LFUN_DIALOG_SHOW , #LFUN_DIALOG_HIDE .
+ * \li Syntax: dialog-toggle <NAME> [<DATA>]
+ * \li Params: See #LFUN_DIALOG_SHOW .
+ * \li Origin: JSpitzm, 30 Apr 2007
+ * \endvar
+ */
{ LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_DIALOG_DISCONNECT_INSET
+ * \li Action: Closes opened connection to opened inset.
+ * \li Notion: Connection is used for apply functions.
+ * \li Syntax: dialog-disconnect-inset <INSET-NAME>
+ * \li Origin: leeming, 25 Feb 2003
+ * \endvar
+ */
{ LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_MOUSE_PRESS
+ * \li Action: This function is called when mouse button is pressed (inside workarea).
+ Action depends on the context.
+ * \li Notion: This is internal LFUN, not to be used by users.
+ * \li Origin: André, 9 Aug 2002
+ * \endvar
+ */
{ LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
- { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
- { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_MOUSE_DOUBLE
+ * \li Action: This function is called when double click on mouse button is
+ pressed (inside workarea). Action depends on the context.
+ * \li Notion: This is internal LFUN, not to be used by users.
+ * \li Origin: André, 9 Aug 2002
+ * \endvar
+ */
{ LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_MOUSE_TRIPLE
+ * \li Action: This function is called when triple click on mouse button is
+ pressed (inside workarea). Action depends on the context.
+ * \li Notion: This is internal LFUN, not to be used by users.
+ * \li Origin: André, 9 Aug 2002
+ * \endvar
+ */
{ LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_MOUSE_MOTION
+ * \li Action: This function is called when mouse cursor is moving over the text.
+ Action depends on the context.
+ * \li Notion: This is internal LFUN, not to be used by users.
+ * \li Origin: André, 9 Aug 2002
+ * \endvar
+ */
+ { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_MOUSE_RELEASE
+ * \li Action: This function is called when mouse button is released (inside workarea).
+ Action depends on the context.
+ * \li Notion: This is internal LFUN, not to be used by users.
+ * \li Origin: André, 9 Aug 2002
+ * \endvar
+ */
+ { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
{ LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
{ LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
{ LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
{ LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
- { LFUN_SERVER_CHAR_AFTER, "server-char-after", ReadOnly, System },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_SERVER_GET_LAYOUT
+ * \li Action: Returns the current layout (that is environment) name
+ on the cursor position.
+ * \li Syntax: server-get-layout
+ * \endvar
+ */
{ LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
- { LFUN_SERVER_GET_NAME, "server-get-name", ReadOnly, System },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_SERVER_GET_FILENAME
+ * \li Action: Returns path and file name of the currently edited document.
+ * \li Syntax: server-get-filename
+ * \endvar
+ */
+ { LFUN_SERVER_GET_FILENAME, "server-get-filename", 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.
* \endvar
*/
{ LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly, System },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_SERVER_NOTIFY
+ * \li Action: Sends notify message about the last key-sequence to client.
+ * \li Notion: This can be used to grab last key-sequence used inside the LyX window.
+ * \li Syntax: server-notify
+ * \endvar
+ */
{ LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
/*!
* \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
* \endvar
*/
{ LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_COMMAND_PREFIX
+ * \li Action: Return the current key sequence and available options as a string.
+ * \li Notion: No options are added if no curmap kb map exists. \n
+ This is probably usable only with connection to lyxserver.
+ * \li Syntax: command-prefix
+ * \endvar
+ */
{ LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
/*!
* \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
projects / lyx.git / blobdiff