* \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 Syntax: index-insert [<TYPE:Name>]
+ * \li Params: <TYPE:Name>: name of the index, if multiple indices are defined.
+ with an empty argument, the default index is selected.
* \li Origin: leeming, 3 Aug 2000
* \endvar
*/
/*!
* \var lyx::FuncCode lyx::LFUN_INDEX_PRINT
* \li Action: Inserts list of Index entries on a new page.
- * \li Syntax: index-print
+ * \li Syntax: index-print [<TYPE:Name>]
+ * \li Params: <TYPE:Name>: name of the index, if multiple indices are defined.
+ with an empty argument, the default index is selected.
* \li Origin: Lgb, 27 Feb 1997
* \endvar
*/
* \var lyx::FuncCode lyx::LFUN_PASTE
* \li Action: Pastes material from the active clipboard.
* \li Syntax: paste [<TYPE>]
- * \li Params: <TYPE>: pdf|png|jpeg|linkback
+ * \li Params: <TYPE>: emf|pdf|png|jpeg|linkback|wmf
* \endvar
*/
{ LFUN_PASTE, "paste", Noop, Edit },
* \endvar
*/
{ LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_FONT_UULINE
+ * \li Action: Toggles double underline in the font (selection-wise).
+ * \li Syntax: font-underunderline
+ * \li Origin: sanda, 5 May 2009
+ * \endvar
+ */
+ { LFUN_FONT_UULINE, "font-underunderline", Noop, Layout },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_FONT_UWAVE
+ * \li Action: Toggles wavy underline in the font (selection-wise).
+ * \li Syntax: font-underwave
+ * \li Origin: sanda, 5 May 2009
+ * \endvar
+ */
+ { LFUN_FONT_UWAVE, "font-underwave", Noop, Layout },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_FONT_STRIKEOUT
+ * \li Action: Toggles strikeout (strike-through) in the font (selection-wise).
+ * \li Syntax: font-strikeout
+ * \li Origin: sanda, 3 May 2009
+ * \endvar
+ */
+ { LFUN_FONT_STRIKEOUT, "font-strikeout", Noop, Layout },
/*!
* \var lyx::FuncCode lyx::LFUN_FONT_EMPH
* \li Action: Toggles the emphasis font style (selection-wise).
* \endvar
*/
{ LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_CHANGE_PREVIOUS
+ * \li Action: Moves the cursor to the position of the previous change
+ of the change tracking records.
+ * \li Syntax: change-previous
+ * \li Origin: vfr, 4 Apr 2009
+ * \endvar
+ */
+ { LFUN_CHANGE_PREVIOUS, "change-previous", ReadOnly, Edit },
/*!
* \var lyx::FuncCode lyx::LFUN_CHANGES_MERGE
* \li Action: Open change tracking dialog for merging and moves the cursor
/*!
* \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 Notion: Used for bibitem, bibtex, box, branch, citation, ert, external,
+ * float, graphics, href, include, index, index_print, label, listings,
+ * note, phantom, ref, space, tabular, vspace, wrap insets.
* \li Syntax: inset-settings <INSET>
- * \li Params: <INSET>: <box|branch|ert|float|listings|note|phantom|tabular|wrap>
+ * \li Params: <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|
+ * graphics|href|include|index|index_print|label|listings|
+ * note|phantom|ref|space|tabular|vspace|wrap>.
* \endvar
*/
- { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly, Edit },
+ { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly | AtPoint, Edit },
/*!
* \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
- * \li Action: Toggles the collapsable inset we are currently in.
+ * \li Action: Toggles the collapsable inset at cursor position,
+ * or the inset we are currently in.
* \li Syntax: inset-toggle [<ARG>]
* \li Params: <ARG>: <open|close|toggle|assign>. \n
open/close/toggle are for collapsable insets. toggle is used when no argument is given.\n
* \li Origin: lasgouttes, 19 Jul 2001
* \endvar
*/
- { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly | AtPoint, Hidden },
+ { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly | AtPoint, Edit },
/*!
* \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
+ * \li Syntax: all-insets-toggle [<STATE>] [<INSET>]
+ * \li Params: <STATE>: <toggle|open|close|assign> default: toggle \n
<INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all insets
* \li Origin: leeming, 30 Mar 2004
* \endvar
{ LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
/*!
- * \var lyx::FuncCode lyx::WINDOW_NEW
+ * \var lyx::FuncCode lyx::LFUN_WINDOW_NEW
* \li Action: Creates new empty LyX window.
* \li Notion: Already opened documents from the previous window can be found under View menu.
* \li Syntax: window-new [<GEOMETRY>]
* \li Syntax: dialog-show <NAME> [<DATA>]
* \li Params: <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|\n
document|errorlist|ert|external|file|findreplace|float|graphics|\n
- include|index|info|nomenclature|label|listings|log|mathdelimiter|\n
+ href|include|index|info|nomenclature|label|listings|log|mathdelimiter|\n
mathmatrix|note|paragraph|phantom|prefs|print|ref|sendto|space|\n
- spellchecker|symbols|tabular|tabularcreate|thesaurus|texinfo|toc|href|\n
+ spellchecker|symbols|tabular|tabularcreate|thesaurus|texinfo|toc|\n
view-source|vspace|wrap|<SPECIAL> \n
<SPECIAL>: latexlog|vclog \n
<DATA>: data, usually settings for the given dialog. Use debug mode for the
/*!
* \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
* \li Action: Sets the cursor position based on the row number of generated TeX file.
- * \li Syntax: server-goto-file-row <LYX_FILE_NAME> <ROW_NUMBER>
+ * \li Notion: This can be useful for DVI inverse-search or detection of the problematic
+ line from LaTeX compilation. Note that before this function can be used
+ export to LaTeX output must occur (in order to map the row numbers).
+ * \li Syntax: server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
+ * \li Params: <FILE>: the filename. Environment variables are expaned in the path.
+ In case this LFUN does not work make sure you are giving correct
+ path to the file.\n
+ If the file is located inside LyX temporary directory it will be
+ mapped back into the appropriate opened buffer (e.g. for the case
+ of generated .tex file).
+ .ext: extensions will be automatically replaced by .lyx.
* \li Origin: Edmar, 23 Dec 1998
* \endvar
*/
* \li Notion: Displays the contents of the current buffer in the chosen
format, for example, PDF or DVI. This runs the necessary
converter, calls the defined viewer, and so forth.
- * \li Syntax: buffer-view <FORMAT>
+ * \li Syntax: buffer-view [<FORMAT>]
* \li Params: <FORMAT>: The format to display, where this is one of the
formats defined (in the current GUI) in the
Tools>Preferences>File Formats dialog.
+ If no format is given, the default format as
+ specified in the same dialog is used.
* \endvar
*/
{ LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
* \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
the output will be rewriten - updated. This is useful in case your viewer
is able to detect such changes (e.g. ghostview for postscript).
- * \li Syntax: buffer-update <FORMAT>
+ * \li Syntax: buffer-update [<FORMAT>]
* \li Params: <FORMAT>: The format to display, where this is one of the
formats defined (in the current GUI) in the
Tools>Preferences>File Formats dialog.
+ If no format is given, the default format as
+ specified in the same dialog is used.
* \li Origin: Dekel, 5 Aug 2000
* \endvar
*/
/*!
* \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
* \li Action: When run from a child document, this updates (exports) document built
- from the master buffer. If a master is not found, it updates the
- current buffer.
- * \li Syntax: master-buffer-update
+ from the master buffer, if available.
+ * \li Syntax: master-buffer-update [<FORMAT>]
+ * \li Params: <FORMAT>: The format to display, where this is one of the
+ formats defined (in the current GUI) in the
+ Tools>Preferences>File Formats dialog.
+ If no format is given, the default format as
+ specified in the same dialog is used.
* \li Origin: Tommaso, 20 Sep 2007
* \endvar
*/
/*!
* \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
* \li Action: When run from a child document, this command shows a preview built
- from the master buffer. If a master is not found, it previews the
- current buffer.
- * \li Syntax: master-buffer-view
+ from the master buffer, if available.
+ * \li Syntax: master-buffer-view [<FORMAT>]
+ * \li Params: <FORMAT>: The format to display, where this is one of the
+ formats defined (in the current GUI) in the
+ Tools>Preferences>File Formats dialog.
+ If no format is given, the default format as
+ specified in the same dialog is used.
* \li Origin: Tommaso, 20 Sep 2007
* \endvar
*/
* \li Origin: rgh, 27 May 2008
* \endvar
*/
- { LFUN_BRANCH_ACTIVATE, "branch-activate", Argument, Buffer },
+ { LFUN_BRANCH_ACTIVATE, "branch-activate", AtPoint, Buffer },
/*!
* \var lyx::FuncCode lyx::LFUN_BRANCH_DEACTIVATE
* \li Action: De-activate the branch
* \li Origin: rgh, 27 May 2008
* \endvar
*/
- { LFUN_BRANCH_DEACTIVATE, "branch-deactivate", Argument, Buffer },
+ { LFUN_BRANCH_DEACTIVATE, "branch-deactivate", AtPoint, Buffer },
/*!
* \var lyx::FuncCode lyx::LFUN_COPY_LABEL_AS_REF
*/
{ LFUN_COPY_LABEL_AS_REF, "copy-label-as-reference", ReadOnly | NoUpdate, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_INSERT_LABEL_AS_REF
+ * \li Action: Inserts the label as a cross-reference at the position of the cursor.
+ * \li Syntax: insert-label-as-reference
+ * \li Origin: vfr, 7 Apr 2009
+ * \endvar
+ */
+ { LFUN_INSERT_LABEL_AS_REF, "insert-label-as-reference", Noop, Edit},
+
+/*!
+ * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_IN
+ * \li Action: Increases the zoom of the screen fonts.
+ * \li Syntax: buffer-zoom-in [<ZOOM>]
+ * \li Params: <ZOOM>: The zoom in %, the default is 20.
+ * \li Origin: vfr, 30 Mar 2009
+ * \endvar
+ */
+ { LFUN_BUFFER_ZOOM_IN, "buffer-zoom-in", ReadOnly, Buffer },
+
+/*!
+ * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_OUT
+ * \li Action: Decreases the zoom of the screen fonts.
+ * \li Syntax: buffer-zoom-out [<ZOOM>]
+ * \li Params: <ZOOM>: The zoom in %, the default is 20.
+ * \li Origin: vfr, 30 Mar 2009
+ * \endvar
+ */
+ { LFUN_BUFFER_ZOOM_OUT, "buffer-zoom-out", ReadOnly, Buffer },
+
+/*!
+ * \var lyx::FuncCode lyx::LFUN_SECTION_SELECT
+ * \li Action: Selects the whole section.
+ * \li Notion: The cursor should be in a section heading
+ before calling this lfun.
+ * \li Syntax: section-select
+ * \li Origin: vfr, 05 May 2009
+ * \endvar
+ */
+ { LFUN_SECTION_SELECT, "section-select", ReadOnly, Edit },
+
{ LFUN_NOACTION, "", Noop, Hidden }
#ifndef DOXYGEN_SHOULD_SKIP_THIS
};