{ LFUN_FLOAT_INSERT, "float-insert", Noop, Edit },
{ LFUN_FLOAT_WIDE_INSERT, "float-wide-insert", Noop, Edit },
{ LFUN_WRAP_INSERT, "wrap-insert", Noop, Edit },
-/*!
- * \var lyx::FuncCode lyx::LFUN_HFILL_INSERT
- * \li Action: Inserts an hfill inset.
- * \li Syntax: hfill-insert
- * \endvar
- */
- { LFUN_HFILL_INSERT, "hfill-insert", Noop, Edit },
/*!
* \var lyx::FuncCode lyx::LFUN_OPTIONAL_INSERT
* \li Action: Inserts an optional-argument (short title) inset.
/*!
* \var lyx::FuncCode lyx::LFUN_NEWPAGE_INSERT
* \li Action: Inserts a new page.
- * \li Syntax: newpage-insert
+ * \li Syntax: newpage-insert<ARG>
+ * \li Params: <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
* \li Origin: uwestoehr, 24 Nov 2007
* \endvar
*/
{ LFUN_NEWPAGE_INSERT, "newpage-insert", Noop, Edit },
-/*!
- * \var lyx::FuncCode lyx::LFUN_PAGEBREAK_INSERT
- * \li Action: Inserts a pagebreak.
- * \li Syntax: pagebreak-insert
- * \li Origin: poenitz, Oct 27 2003
- * \endvar
- */
- { LFUN_PAGEBREAK_INSERT, "pagebreak-insert", Noop, Edit },
/*!
* \var lyx::FuncCode lyx::LFUN_MARGINALNOTE_INSERT
* \li Action: Inserts a marginal note.
*/
{ LFUN_FLEX_INSERT, "flex-insert", Noop, Edit },
{ LFUN_SELF_INSERT, "self-insert", SingleParUpdate, Hidden },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_SPACE_INSERT
+ * \li Action: Inserts one of horizontal space insets.
+ * \li Syntax: space-insert <NAME> [<LEN>]
+ * \li Params: <NAME>: normal, protected, thin, quad, qquad, enspace, enskip,
+ negthinspace, hfill, hfill*, dotfill, hrulefill, hspace,
+ hspace* \n
+ <LEN>: length for custom spaces (hspace, hspace* for protected)
+ * \li Origin: JSpitzm, 20 May 2003, Mar 17 2008
+ * \endvar
+ */
{ LFUN_SPACE_INSERT, "space-insert", Noop, Edit },
{ LFUN_HYPERLINK_INSERT, "href-insert", Noop, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_SPECIALCHAR_INSERT
+ * \li Action: Inserts various characters into the document.
+ * \li Syntax: specialchar-insert <CHAR>
+ * \li Params: <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots,
+ end-of-sentence, menu-separator.
+ * \li Origin: JSpitzm, 6 Dec 2007
+ * \endvar
+ */
{ LFUN_SPECIALCHAR_INSERT, "specialchar-insert", Noop, Edit },
- { LFUN_CLEARPAGE_INSERT, "clearpage-insert", Noop, Edit },
- { LFUN_CLEARDOUBLEPAGE_INSERT, "cleardoublepage-insert", Noop, Edit },
{ LFUN_TOC_INSERT, "toc-insert", Noop, Edit },
{ LFUN_APPENDIX, "appendix", Noop, Edit },
{ LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
{ LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
{ LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
- { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_WORD_FIND_FORWARD
+ * \li Action: Search for a given string in forward direction.
+ * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
+ * \li Syntax: word-find-forward [<STRING>]
+ * \li Origin: Etienne, 16 Feb 1998
+ * \endvar
+ */
{ LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_WORD_FIND_BACKWARD
+ * \li Action: Search for a given string in backward direction.
+ * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
+ * \li Syntax: word-find-backward [<STRING>]
+ * \li Origin: Etienne, 20 Feb 1998
+ * \endvar
+ */
+ { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_WORD_FIND
+ * \li Action: Search for next occurence of a string.
+ * \li Syntax: word-find [<DATA>]
+ * \li Params: <DATA>: data encoded from Find dialog (see #lyx::find2string()).
+ If no parameter is given, search with last find-dialog
+ data is used for search (i.e. find-next).
+ * \li Origin: poenitz, Jan 7 2004
+ * \endvar
+ */
+ { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
+ { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
{ LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
{ LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
{ LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
{ 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_WORD_FIND, "word-find", ReadOnly, Edit },
- { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
/*!
* \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
* \li Action: Look up thesaurus entries with respect to the word under the cursor.
{ LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
{ LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
- { LFUN_LINE_BREAK, "line-break", Noop, Edit },
{ LFUN_LINE_DELETE, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
{ LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
{ LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
- { LFUN_NEW_LINE, "new-line", Noop, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_NEWLINE_INSERT
+ * \li Action: Inserts a line break or new line.
+ * \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 },
/*!
* \var lyx::FuncCode lyx::LFUN_COPY
* \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
* \li Action: Modify existing inset.
* \li Notion: Used for label, floats, listings, box, branch, external, wrap
- bibtex, ert, command, grahocs, note, vspace, tabular, bibitem,
- inlude, ref insets.
+ bibtex, ert, command, graphics, note, space, vspace, tabular,
+ bibitem, inlude, ref insets.
* \li Syntax: inset-modify <INSET> <ARGS>
* \li Params: See #LFUN_INSET_INSERT for further details.
* \endvar
*/
{ LFUN_INSET_MODIFY, "", Noop, Hidden },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_MODIFY
+ * \li Action: Modify the inset at cursor position, if there is one.
+ * \li Notion: Used for label, floats, listings, box, branch, external, wrap
+ bibtex, ert, command, graphics, note, space, vspace, tabular,
+ bibitem, inlude, ref insets.
+ * \li Syntax: next-inset-modify <INSET> <ARGS> or next-inset-modify changetype <TYPE>
+ * \li Params: See #LFUN_INSET_INSERT for further details.
+ * \li Origin: JSpitzm, 23 Mar 2008
+ * \endvar
+ */
+ { LFUN_NEXT_INSET_MODIFY, "next-inset-modify", ReadOnly, Edit },
{ LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
+ * \li Action: Open the inset's properties dialog.
+ * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
+ * \li Syntax: inset-settings <INSET>
+ * \li Params: <INSET>: <box|branch|ert|float|listings|note|tabular|wrap>
+ * \endvar
+ */
{ LFUN_INSET_SETTINGS, "inset-settings", ReadOnly, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_TOGGLE
+ * \li Action: Toggles the inset at cursor position. For collapsables, this means it will
+ be (un-)collapsed, in case of other insets, the editing widget (dialog) will
+ be entered. Also cf. #LFUN_INSET_SETTINGS.
+ * \li Notion: Used for label, floats, listings, box, branch, external, wrap
+ bibtex, ert, command, graphics, note, space, vspace, tabular,
+ bibitem, inlude, ref insets.
+ * \li Syntax: next-inset-toggle
+ * \endvar
+ */
{ LFUN_NEXT_INSET_TOGGLE, "next-inset-toggle", ReadOnly, Edit },
- { LFUN_INSET_TOGGLE, "", ReadOnly, Hidden },
+ { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly, Hidden },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_ALL_INSETS_TOGGLE
+ * \li Action: Toggles (open/closes) all collapsable insets (of a given type) in the document.
+ * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
+ * \li Syntax: all-insets-toggle <STATE> <INSET>
+ * \li Params: <STATE>: <toggle|open|close> default: toggle \n
+ * <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all insets \n
+ * \endvar
+ */
{ LFUN_ALL_INSETS_TOGGLE, "all-insets-toggle", ReadOnly, Edit },
/*!
*/
{ LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
+ * \li Action: Open the given help file according to the language setting.
+ * \li Syntax: help-open <FILE>[.lyx]
+ * \li Params: <FILE>: any document from (/usr/share/)doc directory.
+ * \li Author: Jug, 27 Jun 1999
+ * \endvar
+ */
{ LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
/*!
* \var lyx::FuncCode lyx::LFUN_LYX_QUIT
* \li Action: Saves the current buffer to a temporary file.
* \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
is called automatically by LyX, to "autosave" the current buffer.
- * \li Syntax: buffer-auto-save
+ * \li Syntax: buffer-auto-save
* \endvar
*/
{ LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
{ LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
{ LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
+ * \li Action: Toggles compression of the current document on/off.
+ * \li Syntax: buffer-toggle-compression
+ * \li Origin: bpeng, 27 Apr 2006
+ * \endvar
+ */
{ LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_EMBEDDING
+ * \li Action: Toggles the embeddding feature on/off.
+ * \li Syntax: buffer-toggle-embedding
+ * \li Origin: bpeng, 21 Oct 2007
+ * \endvar
+ */
{ LFUN_BUFFER_TOGGLE_EMBEDDING, "buffer-toggle-embedding", Noop, Buffer },
/*!
* \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
* \endvar
*/
{ LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
+ * \li Action: Save all changed documents.
+ * \li Syntax: buffer-write-all
+ * \li Origin: rgh, gpothier 6 Aug 2007
+ * \endvar
+ */
{ LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_BUFFER_NEXT
+ * \li Action: Switch to the next opened document.
+ * \li Notion: Note that this does not necessarily mean next in tabbar
+ (for full list see View menu).
+ * \li Syntax: buffer-next
+ * \endvar
+ */
{ LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS
+ * \li Action: Switch to the previous opened document.
+ * \li Syntax: buffer-previous
+ * \endvar
+ */
{ LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
{ LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
{ LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
/*!
* \var lyx::FuncCode lyx::LFUN_COMPLETION_COMPLETE
* \li Action: Try to complete the word or command at the cursor position.
- * \li Syntax: complete
+ * \li Syntax: completion-complete
* \li Origin: sts, Feb 19 2008
* \endvar
*/
projects / lyx.git / blobdiff