X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=lib%2Fdoc%2FLFUNs.lyx;h=0d9bb938ddab95e58e015c884fe3573c96ef1758;hb=b2b71d97b503e3ee4444d31220748906bdefcbef;hp=cde8662abe983d27f806932bcf38f541620d93b3;hpb=0cb8c55e11d88639ac986d6e6580657d54329d36;p=lyx.git diff --git a/lib/doc/LFUNs.lyx b/lib/doc/LFUNs.lyx index cde8662abe..0d9bb938dd 100644 --- a/lib/doc/LFUNs.lyx +++ b/lib/doc/LFUNs.lyx @@ -1,995 +1,1067 @@ # gen_lfuns.py generated this file. For more info see http://www.lyx.org/ -\lyxformat 345 +\lyxformat 474 \begin_document \begin_header -\textclass amsart +\textclass article +\begin_preamble +\renewcommand{\descriptionlabel}[1]{\hspace\labelsep\upshape\bfseries #1:} +\renewenvironment{description}{\list{}{% + \setlength{\itemsep}{-2pt} + \advance\leftmargini6\p@ \itemindent-12\p@ + \labelwidth\z@ \let\makelabel\descriptionlabel}% +}{ + \endlist +} +\end_preamble \use_default_options false -\begin_modules -theorems-ams -\end_modules +\maintain_unincluded_children false +\begin_local_layout +Style Description +LabelIndent MM +LeftMargin MMMMMxx +End +\end_local_layout \language english +\language_package default \inputencoding auto +\fontencoding global \font_roman default \font_sans default \font_typewriter default +\font_math auto \font_default_family default +\use_non_tex_fonts false \font_sc false \font_osf false \font_sf_scale 100 \font_tt_scale 100 - \graphics default +\default_output_format default +\output_sync 0 +\bibtex_command default +\index_command default \paperfontsize default +\spacing single \use_hyperref false \papersize default \use_geometry true -\use_amsmath 1 -\use_esint 1 +\use_package amsmath 1 +\use_package amssymb 1 +\use_package cancel 0 +\use_package esint 1 +\use_package mathdots 0 +\use_package mathtools 0 +\use_package mhchem 1 +\use_package stackrel 0 +\use_package stmaryrd 0 +\use_package undertilde 0 \cite_engine basic +\cite_engine_type default +\biblio_style plain \use_bibtopic false +\use_indices false \paperorientation portrait +\suppress_date false +\justification true +\use_refstyle 0 +\index Index +\shortcut idx +\color #008000 +\end_index \leftmargin 2.5cm \topmargin 2cm \rightmargin 3cm -\bottommargin 1cm +\bottommargin 2.5cm \secnumdepth 3 \tocdepth 3 \paragraph_separation indent -\defskip medskip +\paragraph_indentation default \quotes_language english \papercolumns 1 \papersides 1 \paperpagestyle default \tracking_changes false \output_changes false -\author "" -\author "" +\html_math_output 0 +\html_css_as_file 0 +\html_be_strict false \end_header \begin_body +\begin_layout Title +LyX Functions (LFUNs) +\end_layout + +\begin_layout Author +The LyX Team +\end_layout + +\begin_layout Date +2014-10-23 +\end_layout + \begin_layout Section* -LFUNs documentation automatically generated 2009-07-11 +About this manual \end_layout \begin_layout Standard -\begin_inset ERT -status collapsed - -\begin_layout Plain Layout +This manual documents the +\begin_inset Quotes eld +\end_inset +LyX Functions +\begin_inset Quotes erd +\end_inset -\backslash -thispagestyle{empty} + (abbreviated LFUNs). + These are commands that are used to make LyX perform specific actions. + LyX itself uses these functions internally, and every internal action is + bound to an LFUN. \end_layout +\begin_layout Standard +LFUNs are also used in the files that define keyboard shortcuts, menu or + toolbar items. + So if you want to change\SpecialChar \slash{} +customize the user interface, you need to deal + with LFUNs. + Furthermore, external programs can use LFUNs to communicate with and +\begin_inset Quotes eld \end_inset +remote-control +\begin_inset Quotes erd +\end_inset -\begin_inset VSpace 1cm + LyX. + Finally, you can also issue LFUNs directly via the so called mini-buffer + which can be opened via +\begin_inset Info +type "shortcuts" +arg "command-execute" \end_inset +. +\end_layout + +\begin_layout Standard +In the following, all LFUNs are listed, categorized by function. +\end_layout +\begin_layout Section +Layout Functions (Font, Layout and Textclass related) \end_layout \begin_layout Subsection* -LFUN_ACCENT_ACUTE +drop-layouts-choice \end_layout \begin_layout Description -Action Adds an acute accent to the next character typed. +Action Displays list of layout choices. \end_layout \begin_layout Description -Syntax accent-acute +Notion In the current (as of 2007) Qt4 frontend, this LFUN opens the dropbox allowing for choice of layout. +\end_layout +\begin_layout Description +Syntax drop-layouts-choice \end_layout \begin_layout Subsection* -LFUN_ACCENT_BREVE +environment-split \end_layout \begin_layout Description -Action Adds a breve accent to the next character typed. +Action Splits the current environment with a Separator. \end_layout \begin_layout Description -Syntax accent-breve +Syntax environment-split [outer] +\end_layout +\begin_layout Description +Params outer: If this is given, LyX will split the outermost environment in the current nesting hierarchy. +\end_layout +\begin_layout Description +Origin spitz, 23 Dec 2012 \end_layout \begin_layout Subsection* -LFUN_ACCENT_CARON +font-bold \end_layout \begin_layout Description -Action Adds a caron to the next character typed. +Action Toggles the bold font (selection-wise) using mathbf in math. \end_layout \begin_layout Description -Syntax accent-caron +Syntax font-bold \end_layout \begin_layout Subsection* -LFUN_ACCENT_CEDILLA +font-boldsymbol \end_layout \begin_layout Description -Action Adds a cedilla to the next character typed. +Action Toggles the bold font (selection-wise) using boldsymbol in math. \end_layout \begin_layout Description -Syntax accent-cedilla +Syntax font-boldsymbol \end_layout \begin_layout Subsection* -LFUN_ACCENT_CIRCLE +font-default \end_layout \begin_layout Description -Action Adds a circle accent to the next character typed. +Action Reverts the settings of the font to the default values (selection-wise). \end_layout \begin_layout Description -Syntax accent-circle +Syntax font-default \end_layout \begin_layout Subsection* -LFUN_ACCENT_CIRCUMFLEX +font-emph \end_layout \begin_layout Description -Action Adds a circumflex to the next character typed. +Action Toggles the emphasis font style (selection-wise). \end_layout \begin_layout Description -Syntax accent-circumflex +Syntax font-emph \end_layout \begin_layout Subsection* -LFUN_ACCENT_DOT +font-frak \end_layout \begin_layout Description -Action Adds a dot accent to the next character typed. +Action Toggles Fraktur family font (math-mode, selection-wise). \end_layout \begin_layout Description -Syntax accent-dot +Syntax font-frak +\end_layout +\begin_layout Description +Origin vermeer, 10 Jan 2002 \end_layout \begin_layout Subsection* -LFUN_ACCENT_GRAVE +font-ital \end_layout \begin_layout Description -Action Adds a grave accent to the next character typed. +Action Toggles Italics font shape (math-mode, selection-wise). \end_layout \begin_layout Description -Syntax accent-grave +Syntax font-ital +\end_layout +\begin_layout Description +Origin vermeer, 10 Jan 2002 \end_layout \begin_layout Subsection* -LFUN_ACCENT_HUNGARIAN_UMLAUT +font-noun \end_layout \begin_layout Description -Action Adds a Hungarian umlaut to the next character typed. +Action Toggles Noun text style font (selection-wise). \end_layout \begin_layout Description -Syntax accent-grave +Syntax font-noun \end_layout \begin_layout Subsection* -LFUN_ACCENT_MACRON +font-roman \end_layout \begin_layout Description -Action Adds a macron to the next character typed. +Action Toggles Roman family font (selection-wise). \end_layout \begin_layout Description -Syntax accent-macron +Syntax font-roman \end_layout \begin_layout Subsection* -LFUN_ACCENT_OGONEK +font-sans \end_layout \begin_layout Description -Action Adds an ogonek accent to the next character typed. +Action Toggles Sans Serif family font (selection-wise). \end_layout \begin_layout Description -Syntax accent-ogonek +Syntax font-sans \end_layout \begin_layout Subsection* -LFUN_ACCENT_TIE +font-size \end_layout \begin_layout Description -Action Adds a tie over the next two character typed. +Action Sets font size according to lyx format string. \end_layout \begin_layout Description -Notion The following char will finish the tie. +Syntax font-size \end_layout \begin_layout Description -Syntax accent-tie +Params : tiny|scriptsize|footnotesize|small|normal|large|larger| +\begin_inset Newline newline +\end_inset + +largest|huge|giant|increase|decrease|default \end_layout \begin_layout Subsection* -LFUN_ACCENT_TILDE +font-state \end_layout \begin_layout Description -Action Adds a tilde over the next character typed. +Action Returns the info about the current font. \end_layout \begin_layout Description -Syntax accent-tilde +Syntax font-state \end_layout \begin_layout Subsection* -LFUN_ACCENT_UMLAUT +font-strikeout \end_layout \begin_layout Description -Action Adds an umlaut over the next character typed. +Action Toggles strikeout (strike-through) in the font (selection-wise). \end_layout \begin_layout Description -Syntax accent-umlaut +Syntax font-strikeout +\end_layout +\begin_layout Description +Origin sanda, 3 May 2009 \end_layout \begin_layout Subsection* -LFUN_ACCENT_UNDERBAR +font-typewriter \end_layout \begin_layout Description -Action Adds a bar under the next character typed. +Action Toggles the typewriter family font (selection-wise). \end_layout \begin_layout Description -Syntax accent-underbar +Syntax font-typewriter \end_layout \begin_layout Subsection* -LFUN_ACCENT_UNDERDOT +font-underline \end_layout \begin_layout Description -Action Adds a dot under the next character typed. +Action Toggles underline in the font (selection-wise). \end_layout \begin_layout Description -Syntax accent-underdot +Syntax font-underline \end_layout \begin_layout Subsection* -LFUN_CAPTION_INSERT +font-underunderline \end_layout \begin_layout Description -Action Inserts a caption inset. +Action Toggles double underline in the font (selection-wise). \end_layout \begin_layout Description -Syntax caption-insert +Syntax font-underunderline \end_layout \begin_layout Description -Origin Lgb, 18 Jul 2000 +Origin sanda, 5 May 2009 \end_layout \begin_layout Subsection* -LFUN_DATE_INSERT -\end_layout -\begin_layout Description -Action Inserts the current date. +font-underwave \end_layout \begin_layout Description -Syntax date-insert [] +Action Toggles wavy underline in the font (selection-wise). \end_layout \begin_layout Description -Params : Format of date. The default value (%x) can be set in Preferences->Date format. For possible formats see manual page of strftime function. +Syntax font-underwave \end_layout \begin_layout Description -Origin jdblair, 31 Jan 2000 +Origin sanda, 5 May 2009 \end_layout \begin_layout Subsection* -LFUN_FOOTNOTE_INSERT +layout \end_layout \begin_layout Description -Action Inserts a footnote inset. +Action Sets the layout (that is, environment) for the current paragraph. \end_layout \begin_layout Description -Syntax footnote-insert +Syntax layout \end_layout \begin_layout Description -Origin Jug, 7 Mar 2000 +Params : the layout to use \end_layout \begin_layout Subsection* -LFUN_ERT_INSERT +layout-module-add \end_layout \begin_layout Description -Action Inserts an ERT inset. +Action Adds a module. \end_layout \begin_layout Description -Syntax ert-insert +Notion Adds a module to the list of included modules for the current buffer. \end_layout \begin_layout Description -Origin Jug, 18 Feb 2000 +Syntax layout-module-add +\end_layout +\begin_layout Description +Params : the module to be added +\end_layout +\begin_layout Description +Origin rgh, 25 August 2007 \end_layout \begin_layout Subsection* -LFUN_FLOAT_INSERT +layout-modules-clear \end_layout \begin_layout Description -Action Inserts a float inset. +Action Clears the module list. \end_layout \begin_layout Description -Syntax float-insert +Notion Clears the list of included modules for the current buffer. \end_layout \begin_layout Description -Params : type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given. +Syntax layout-modules-clear \end_layout \begin_layout Description -Origin Lgb, 27 Jun 2000 +Origin rgh, 25 August 2007 \end_layout \begin_layout Subsection* -LFUN_FLOAT_WIDE_INSERT +layout-paragraph \end_layout \begin_layout Description -Action Inserts float insets as in LFUN_FLOAT_INSERT but span multiple columns. +Action Launches the paragraph settings dialog. \end_layout \begin_layout Description -Notion Corresponds to the starred floats (figure*, table*, etc.) in LaTeX. +Syntax layout-paragraph +\end_layout + +\begin_layout Subsection* +layout-reload \end_layout \begin_layout Description -Syntax float-wide-insert +Action Reloads layout information. \end_layout \begin_layout Description -Params : type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given. +Notion Reloads all layout information for the current buffer from disk, thus recognizing any changes that have been made to layout files on the fly. This is intended to be used only by layout developers and should not be used when one is trying to do actual work. \end_layout \begin_layout Description -Origin Lgb, 31 Oct 2001 +Syntax layout-reload +\end_layout +\begin_layout Description +Origin rgh, 3 September 2007 \end_layout \begin_layout Subsection* -LFUN_FLOAT_LIST_INSERT -\end_layout -\begin_layout Description -Action Inserts the list of floats in the document. +layout-tabular \end_layout \begin_layout Description -Syntax float-list-insert +Action Launches the tabular settings dialog. \end_layout \begin_layout Description -Params : type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given. +Syntax layout-tabular \end_layout \begin_layout Description -Origin Lgb, 3 May 2001 +Origin Jug, 31 Jul 2000 \end_layout \begin_layout Subsection* -LFUN_WRAP_INSERT +screen-font-update \end_layout \begin_layout Description -Action Inserts floats wrapped by the text around. +Action Update fonts and its metrics. \end_layout \begin_layout Description -Syntax wrap-insert +Notion Automatically called after zoom, dpi, font names, or norm change. \end_layout \begin_layout Description -Params : table|figure +Syntax screen-font-update \end_layout \begin_layout Description -Origin Dekel, 7 Apr 2002 +Origin ARRae, 13 Aug 2000 \end_layout \begin_layout Subsection* -LFUN_OPTIONAL_INSERT +textclass-apply \end_layout \begin_layout Description -Action Inserts an optional-argument (short title) inset. +Action Sets the text class for the current buffer. \end_layout \begin_layout Description -Syntax optional-insert +Syntax textclass-apply \end_layout \begin_layout Description -Origin vermeer, 12 Aug 2002 +Params : the textclass to set. Note that this must be the filename, minus the ".layout" extension. \end_layout \begin_layout Subsection* -LFUN_LINE_INSERT +textclass-load \end_layout \begin_layout Description -Action Inserts a horizontal line. +Action Loads information for a textclass from disk. \end_layout \begin_layout Description -Syntax line-insert +Syntax textclass-load \end_layout \begin_layout Description -Origin Andre, Oct 27 2003 +Params : the textclass to load. Note that this must be the filename, minus the ".layout" extension. \end_layout \begin_layout Subsection* -LFUN_NEWPAGE_INSERT +textstyle-apply \end_layout \begin_layout Description -Action Inserts a new page. +Action Toggle user-defined (=last-time used) text style. \end_layout \begin_layout Description -Syntax newpage-insert +Notion This style is set via LFUN_TEXTSTYLE_UPDATE, which is automatically triggered when using Text Style dialog. \end_layout \begin_layout Description -Params : default: newpage +Syntax textstyle-apply \end_layout \begin_layout Description -Origin uwestoehr, 24 Nov 2007 +Origin leeming, 12 Mar 2003 \end_layout \begin_layout Subsection* -LFUN_MARGINALNOTE_INSERT +textstyle-update \end_layout \begin_layout Description -Action Inserts a marginal note. +Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APPLY. \end_layout \begin_layout Description -Syntax marginalnote-insert +Syntax textstyle-update \end_layout \begin_layout Description -Origin Lgb, 26 Jun 2000 +Params : specifies font atributes, e.g. family, series, shape, size, emph, noun, underbar, number, color, language, toggleall. +\begin_inset Newline newline +\end_inset + +Use lyx -dbg action for exact syntax of text-style dialog parameters. +\end_layout +\begin_layout Description +Origin leeming, 12 Mar 2003 \end_layout +\begin_layout Section +Editing Functions (Cursor and Mouse Movement, Copy/Paste etc.) +\end_layout \begin_layout Subsection* -LFUN_UNICODE_INSERT +accent-acute \end_layout \begin_layout Description -Action Inserts a single unicode character. +Action Adds an acute accent to the next character typed. \end_layout \begin_layout Description -Syntax unicode-insert +Syntax accent-acute \end_layout -\begin_layout Description -Params : The character to insert, given as its code point, in hexadecimal. + +\begin_layout Subsection* +accent-breve \end_layout \begin_layout Description -Sample unicode-insert 0x0100 +Action Adds a breve accent to the next character typed. \end_layout \begin_layout Description -Origin Lgb, 22 Oct 2006 +Syntax accent-breve \end_layout \begin_layout Subsection* -LFUN_LISTING_INSERT -\end_layout -\begin_layout Description -Action Inserts a new listings inset. +accent-caron \end_layout \begin_layout Description -Syntax listing-insert +Action Adds a caron to the next character typed. \end_layout \begin_layout Description -Origin Herbert, 10 Nov 2001; bpeng, 2 May 2007 +Syntax accent-caron \end_layout \begin_layout Subsection* -LFUN_TAB_INSERT +accent-cedilla \end_layout \begin_layout Description -Action Insert a tab into a listings inset. +Action Adds a cedilla to the next character typed. \end_layout \begin_layout Description -Notion It also works on a selection. +Syntax accent-cedilla +\end_layout + +\begin_layout Subsection* +accent-circle \end_layout \begin_layout Description -Syntax tab-insert +Action Adds a circle accent to the next character typed. \end_layout \begin_layout Description -Origin vfr, Sep 30 2008 +Syntax accent-circle \end_layout \begin_layout Subsection* -LFUN_TAB_DELETE +accent-circumflex \end_layout \begin_layout Description -Action Delete a tab or up to an equivalent amount of spaces from a listings inset. +Action Adds a circumflex to the next character typed. \end_layout \begin_layout Description -Notion It also works on a selection - it removes a tab or spaces from the beginning of each line spanned by the selection. This is useful if you want to indent/unindent multiple lines in one action. +Syntax accent-circumflex +\end_layout + +\begin_layout Subsection* +accent-dot \end_layout \begin_layout Description -Syntax tab-delete +Action Adds a dot accent to the next character typed. \end_layout \begin_layout Description -Origin vfr, Sep 30 2008 +Syntax accent-dot \end_layout \begin_layout Subsection* -LFUN_QUOTE_INSERT +accent-grave \end_layout \begin_layout Description -Action Inserts quotes according to the type and quote-language preference. +Action Adds a grave accent to the next character typed. \end_layout \begin_layout Description -Notion Currently English, Swedish, German, Polish, French, Danish quotes are distinguished. +Syntax accent-grave +\end_layout + +\begin_layout Subsection* +accent-hungarian-umlaut \end_layout \begin_layout Description -Syntax quote-insert [] +Action Adds a Hungarian umlaut to the next character typed. \end_layout \begin_layout Description -Params : 'single' for single quotes, otherwise double quotes will be used. +Syntax accent-grave \end_layout \begin_layout Subsection* -LFUN_INFO_INSERT +accent-macron \end_layout \begin_layout Description -Action Displays shortcuts, lyxrc, package and textclass availability and menu information in a non-editable boxed InsetText. +Action Adds a macron to the next character typed. \end_layout \begin_layout Description -Notion Apart from lfun arguments you can use the following method: -\begin_inset Newline newline -\end_inset - -1. input the type and argument of this inset, e.g. "menu paste", in the work area. -\begin_inset Newline newline -\end_inset +Syntax accent-macron +\end_layout -2. select the text and run info-insert lfun. +\begin_layout Subsection* +accent-ogonek \end_layout \begin_layout Description -Syntax info-insert +Action Adds an ogonek accent to the next character typed. \end_layout \begin_layout Description -Params : shortcut[s]|lyxrc|package|textclass|menu|buffer -\begin_inset Newline newline -\end_inset - -: argument for a given type. Look into InsetInfo.h for detailed description. -\begin_inset Newline newline -\end_inset - - shortcut[s]: name of lfun (e.g math-insert -\backslash -alpha) -\begin_inset Newline newline -\end_inset - - lyxrc: name of rc_entry (e.g. bind_file) -\begin_inset Newline newline -\end_inset - - package: name of latex package (e.g. listings) -\begin_inset Newline newline -\end_inset - - textclass: name of textclass (e.g. article) -\begin_inset Newline newline -\end_inset - - menu: name of lfun used in menu -\begin_inset Newline newline -\end_inset - - icon: name of lfun used in toolbar -\begin_inset Newline newline -\end_inset +Syntax accent-ogonek +\end_layout - buffer: "name"|"path"|"class" +\begin_layout Subsection* +accent-tie \end_layout \begin_layout Description -Sample command-sequence info-insert buffer path; info-insert buffer name +Action Adds a tie over the next two character typed. \end_layout \begin_layout Description -Origin bpeng, 7 Oct 2007 +Notion The following char will finish the tie. +\end_layout +\begin_layout Description +Syntax accent-tie \end_layout \begin_layout Subsection* -LFUN_BRANCH_INSERT -\end_layout -\begin_layout Description -Action Inserts branch inset. +accent-tilde \end_layout \begin_layout Description -Syntax branch-insert +Action Adds a tilde over the next character typed. \end_layout \begin_layout Description -Origin vermeer, 17 Aug 2003 +Syntax accent-tilde \end_layout \begin_layout Subsection* -LFUN_BOX_INSERT +accent-umlaut \end_layout \begin_layout Description -Action Inserts Box inset. +Action Adds an umlaut over the next character typed. \end_layout \begin_layout Description -Syntax box-insert [] +Syntax accent-umlaut \end_layout -\begin_layout Description -Params : Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox -\begin_inset Newline newline -\end_inset -Framed is the default one. +\begin_layout Subsection* +accent-underbar \end_layout \begin_layout Description -Origin vermeer, 7 Oct 2003 +Action Adds a bar under the next character typed. +\end_layout +\begin_layout Description +Syntax accent-underbar \end_layout \begin_layout Subsection* -LFUN_FLEX_INSERT +accent-underdot \end_layout \begin_layout Description -Action Inserts CharStyle, Custom inset or XML short element. +Action Adds a dot under the next character typed. \end_layout \begin_layout Description -Notion Look into the Customization manual for more information about these elements. -\begin_inset Newline newline -\end_inset - -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. -\begin_inset Newline newline -\end_inset +Syntax accent-underdot +\end_layout -For dissolving the element see LFUN_INSET_DISSOLVE. +\begin_layout Subsection* +all-changes-accept \end_layout \begin_layout Description -Syntax flex-insert +Action Accepts all tracked changes in the document. \end_layout \begin_layout Description -Params TYPE: CharStyle|Custom|Element|Standard -\begin_inset Newline newline -\end_inset - -Identifies whether this is a Character Style, a Custom Inset or an XML Element, and which dynamical sub-menu this flex inset is in on the LyX menu tree. If Standard (currently unused): none of these. -\begin_inset Newline newline -\end_inset - -Name: This name must be defined either in your layout file or imported by some module. The definition is InsetLayout +Syntax all-changes-accept \end_layout \begin_layout Description -Sample flex-insert CharStyle:Code +Origin Levon, 16 Oct 2002 \end_layout \begin_layout Subsection* -LFUN_SELF_INSERT +all-changes-reject \end_layout \begin_layout Description -Action Inserts the given string (accordingly to the correct keymap). +Action Rejects all tracked changes in the document. \end_layout \begin_layout Description -Notion Automatically replace the currently selected text. Depends on lyxrc settings "auto_region_delete". +Notion Reject does not work recursively; the user may have to repeat the operation. \end_layout \begin_layout Description -Syntax self-insert +Syntax all-changes-reject +\end_layout +\begin_layout Description +Origin Levon, 16 Oct 2002 \end_layout \begin_layout Subsection* -LFUN_SPACE_INSERT +appendix \end_layout \begin_layout Description -Action Inserts one of horizontal space insets. -\end_layout -\begin_layout Description -Syntax space-insert [] +Action Start (or remove) Appendix on the given cursor position. \end_layout \begin_layout Description -Params : normal, protected, thin, quad, qquad, enspace, enskip, negthinspace, hfill, hfill*, dotfill, hrulefill, hspace, hspace* -\begin_inset Newline newline -\end_inset - -: length for custom spaces (hspace, hspace* for protected) +Syntax appendix \end_layout \begin_layout Description -Origin JSpitzm, 20 May 2003, Mar 17 2008 +Origin ettrich, 5 May 1998 \end_layout \begin_layout Subsection* -LFUN_HYPERLINK_INSERT +argument-insert \end_layout \begin_layout Description -Action Inserts hyperlinks into the document (clickable in pdf output). +Action Inserts an argument (short title) inset. \end_layout \begin_layout Description -Notion Hyperlink target can be set via selection + hyperlink-insert function. +Syntax argument-insert \end_layout \begin_layout Description -Syntax href-insert [] +Params : see layout declarations \end_layout \begin_layout Description -Origin CFO-G, 21 Nov 1997 +Origin vermeer, 12 Aug 2002 \end_layout \begin_layout Subsection* -LFUN_SPECIALCHAR_INSERT +bibtex-database-add \end_layout \begin_layout Description -Action Inserts various characters into the document. +Action Adds database, which will be used for bibtex citations. \end_layout \begin_layout Description -Syntax specialchar-insert +Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor position. \end_layout \begin_layout Description -Params : hyphenation, ligature-break, slash, nobreakdash, dots, end-of-sentence, menu-separator. +Syntax bibtex-database-add \end_layout \begin_layout Description -Origin JSpitzm, 6 Dec 2007 +Origin Ale, 30 May 1997 \end_layout \begin_layout Subsection* -LFUN_TOC_INSERT +bibtex-database-del \end_layout \begin_layout Description -Action Inserts table of contents. +Action Adds database, which will be used for bibtex citations. +\end_layout +\begin_layout Description +Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor position. \end_layout \begin_layout Description -Syntax toc-insert +Syntax bibtex-database-del \end_layout \begin_layout Description -Origin Lgb, 27 May 97 +Origin Ale, 30 May 1997 \end_layout \begin_layout Subsection* -LFUN_APPENDIX +bookmark-clear \end_layout \begin_layout Description -Action Start (or remove) Appendix on the given cursor position. +Action Clears the list of saved bookmarks. \end_layout \begin_layout Description -Syntax appendix +Syntax bookmark-clear \end_layout \begin_layout Description -Origin ettrich, 5 May 1998 +Origin bpeng, 31 October 2006 \end_layout \begin_layout Subsection* -LFUN_INDEX_INSERT +bookmark-goto \end_layout \begin_layout Description -Action Inserts Index entry. +Action Moves the cursor to the numbered bookmark, opening the file if necessary. Note that bookmarks are saved per-session, not per file. \end_layout \begin_layout Description -Notion It automatically takes the word on the cursor position. +Notion Bookmark 0 has a special purpose. It is automatically set +\begin_inset Newline newline +\end_inset + +1. to the paragraph you are currently editing +\begin_inset Newline newline +\end_inset + +2. to the paragraph from where you are jumping to the last-edited position (jump-back feature) +\begin_inset Newline newline +\end_inset + +3. when jumping from crossreference to the requested label by LFUN_LABEL_GOTO. \end_layout \begin_layout Description -Syntax index-insert [] +Syntax bookmark-goto \end_layout \begin_layout Description -Params : name of the index, if multiple indices are defined. with an empty argument, the default index is selected. +Params : the number of the bookmark to restore. \end_layout \begin_layout Description -Origin leeming, 3 Aug 2000 +Origin Dekel, 27 January 2001 \end_layout \begin_layout Subsection* -LFUN_INDEX_PRINT +bookmark-save \end_layout \begin_layout Description -Action Inserts list of Index entries on a new page. +Action Save a bookmark. \end_layout \begin_layout Description -Syntax index-print [] +Notion Saves a numbered bookmark to the sessions file. The number must be between 1 and 9, inclusive. Note that bookmarks are saved per-session, not per file. +\end_layout +\begin_layout Description +Syntax bookmark-save \end_layout \begin_layout Description -Params : name of the index, if multiple indices are defined. with an empty argument, the default index is selected. +Params : the number of the bookmark to save. \end_layout \begin_layout Description -Origin Lgb, 27 Feb 1997 +Origin Dekel, 27 January 2001 \end_layout \begin_layout Subsection* -LFUN_NOMENCL_INSERT +box-insert \end_layout \begin_layout Description -Action Inserts Nomenclature entry. +Action Inserts Box inset. \end_layout \begin_layout Description -Notion It automatically takes the word on the cursor position if no symbol is given. +Syntax box-insert [] \end_layout \begin_layout Description -Syntax nomencl-insert [] +Params : Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox +\begin_inset Newline newline +\end_inset + +Framed is the default one. \end_layout \begin_layout Description -Origin Ugras, 4 Nov 2006 +Origin vermeer, 7 Oct 2003 \end_layout \begin_layout Subsection* -LFUN_NOMENCLATURE_PRINT +branch-insert \end_layout \begin_layout Description -Action Inserts list of Nomenclature entries. +Action Inserts branch inset. \end_layout \begin_layout Description -Syntax nomenclature-print +Syntax branch-insert \end_layout \begin_layout Description -Origin Ugras, 4 Nov 2006 +Origin vermeer, 17 Aug 2003 \end_layout \begin_layout Subsection* -LFUN_NOTE_INSERT -\end_layout -\begin_layout Description -Action Inserts Note on the current cursor postion, move selection inside the inset. +buffer-begin \end_layout \begin_layout Description -Syntax note-insert [] +Action Move the cursor to the beginning of the document. \end_layout \begin_layout Description -Params : default: Note +Syntax buffer-begin \end_layout \begin_layout Subsection* -LFUN_NOTE_NEXT +buffer-begin-select \end_layout \begin_layout Description -Action Moves the cursor to the begining of next Note inset. +Action Move the cursor to the beginning of the document adding the traversed text to the selection. \end_layout \begin_layout Description -Syntax note-next +Syntax buffer-begin-select \end_layout \begin_layout Subsection* -LFUN_NOTES_MUTATE +buffer-end \end_layout \begin_layout Description -Action Changes all Note insets of a particular type (source) to a different type (target) fot the current document. -\end_layout -\begin_layout Description -Syntax notes-mutate -\end_layout -\begin_layout Description -Params : Note|Comment|Greyedout +Action Move the cursor to the end of the document. \end_layout \begin_layout Description -Origin sanda, 18 Jun 2008 +Syntax buffer-end \end_layout \begin_layout Subsection* -LFUN_PHANTOM_INSERT -\end_layout -\begin_layout Description -Action Inserts phantom on the current cursor postion, move selection inside the inset. +buffer-end-select \end_layout \begin_layout Description -Syntax phantom-insert [] -\end_layout -\begin_layout Description -Params : default: Phantom +Action Move the cursor to the end of the document adding the traversed text to the selection. \end_layout \begin_layout Description -Origin uwestoehr, 30 Jan 2009 +Syntax buffer-end-select \end_layout \begin_layout Subsection* -LFUN_NEWLINE_INSERT -\end_layout -\begin_layout Description -Action Inserts a line break or new line. +caption-insert \end_layout \begin_layout Description -Syntax newline-insert [] +Action Inserts a caption inset. \end_layout \begin_layout Description -Params : default: newline +Syntax caption-insert \end_layout \begin_layout Description -Origin JSpitzm, 25 Mar 2008 +Origin Lgb, 18 Jul 2000 \end_layout \begin_layout Subsection* -LFUN_ESCAPE +cell-backward \end_layout \begin_layout Description -Action Clears the selection. If no text is selected call LFUN_FINISHED_FORWARD. +Action Moves the cursor to the previous cell inside the table. \end_layout \begin_layout Description -Syntax escape +Syntax cell-backward \end_layout \begin_layout Description -Origin Lgb, 17 May 2001 +Origin Jug, 22 May 2000 \end_layout \begin_layout Subsection* -LFUN_DOWN +cell-forward \end_layout \begin_layout Description -Action Moves the cursor one line in downward direction. +Action Moves the cursor to the next cell inside the table. \end_layout \begin_layout Description -Syntax down +Syntax cell-forward \end_layout \begin_layout Subsection* -LFUN_UP +cell-split \end_layout \begin_layout Description -Action Moves the cursor one line in upward direction. +Action Splits cell and shifts right part to the next cell (inside the math grid). \end_layout \begin_layout Description -Syntax up +Syntax cell-split +\end_layout +\begin_layout Description +Origin Ale, 15 May 1997 \end_layout \begin_layout Subsection* -LFUN_DOWN_SELECT +change-accept \end_layout \begin_layout Description -Action Moves the cursor one line in downward direction adding the current position to the selection. +Action Accepts tracked change inside the selection. \end_layout \begin_layout Description -Syntax down-select +Syntax change-accept +\end_layout +\begin_layout Description +Origin Levon, 16 Oct 2002 \end_layout \begin_layout Subsection* -LFUN_UP_SELECT +change-next \end_layout \begin_layout Description -Action Moves the cursor one line in upward direction adding the current position to the selection. +Action Moves the cursor to the position of the next change of the change tracking records. \end_layout \begin_layout Description -Syntax up-select +Syntax change-next +\end_layout +\begin_layout Description +Origin schmitt, 4 Oct 2006 \end_layout \begin_layout Subsection* -LFUN_SCREEN_DOWN +change-previous \end_layout \begin_layout Description -Action Moves the cursor one page in downward direction. +Action Moves the cursor to the position of the previous change of the change tracking records. \end_layout \begin_layout Description -Syntax screen-down -\end_layout - -\begin_layout Subsection* -LFUN_SCREEN_UP -\end_layout -\begin_layout Description -Action Moves the cursor one page in upward direction. +Syntax change-previous \end_layout \begin_layout Description -Syntax screen-up +Origin vfr, 4 Apr 2009 \end_layout \begin_layout Subsection* -LFUN_SCREEN_DOWN_SELECT -\end_layout -\begin_layout Description -Action Moves the cursor one screen in downward direction adding the current position to the selection. +change-reject \end_layout \begin_layout Description -Syntax screen-down-select -\end_layout - -\begin_layout Subsection* -LFUN_SCREEN_UP_SELECT +Action Rejects tracked change inside the selection. \end_layout \begin_layout Description -Action Moves the cursor one page in upward direction adding the current position to the selection. +Syntax change-reject \end_layout \begin_layout Description -Syntax screen-up-select +Origin Levon, 16 Oct 2002 \end_layout \begin_layout Subsection* -LFUN_SCROLL +changes-merge \end_layout \begin_layout Description -Action Scroll the buffer view. +Action Open change tracking dialog for merging and moves the cursor to the position of the next change. \end_layout \begin_layout Description -Notion Only scrolls the screen up or down; does not move the cursor. +Syntax changes-merge \end_layout \begin_layout Description -Syntax scroll +Origin Levon, 16 Oct 2002 \end_layout -\begin_layout Description -Params : line|page -\begin_inset Newline newline -\end_inset -: up|down| +\begin_layout Subsection* +changes-output \end_layout \begin_layout Description -Origin Abdel, Dec 27 2007 -\end_layout - -\begin_layout Subsection* -LFUN_SCREEN_RECENTER +Action Toggles showing of change tracking in typeset output. \end_layout \begin_layout Description -Action Recenters the screen on the current cursor position. +Syntax changes-output \end_layout \begin_layout Description -Syntax screen-recenter +Origin jspitzm, 21 Jan 2005 \end_layout \begin_layout Subsection* -LFUN_SCREEN_SHOW_CURSOR +changes-track \end_layout \begin_layout Description -Action Repositions the screen such that the cursor is visible. +Action Toggles change tracking to on/off. \end_layout \begin_layout Description -Syntax screen-show-cursor +Syntax changes-track \end_layout \begin_layout Description -Origin vfr, 25 Mar 2009 +Origin levon, 1 Oct 2002 \end_layout \begin_layout Subsection* -LFUN_CHAR_BACKWARD +char-backward \end_layout \begin_layout Description Action Moves the cursor one position logically backwards. @@ -1002,7 +1074,7 @@ Syntax char-backward \end_layout \begin_layout Subsection* -LFUN_CHAR_BACKWARD_SELECT +char-backward-select \end_layout \begin_layout Description Action Moves the cursor one position logically backwards, adding traversed position to the selection. @@ -1015,7 +1087,7 @@ Syntax char-backward-select \end_layout \begin_layout Subsection* -LFUN_CHAR_DELETE_BACKWARD +char-delete-backward \end_layout \begin_layout Description Action Deletes one character in the backward direction (usually the "BackSpace" key). @@ -1025,7 +1097,7 @@ Syntax char-delete-backward \end_layout \begin_layout Subsection* -LFUN_CHAR_DELETE_FORWARD +char-delete-forward \end_layout \begin_layout Description Action Deletes one character in the backward direction (usually the "Delete" key). @@ -1035,7 +1107,7 @@ Syntax char-delete-forward \end_layout \begin_layout Subsection* -LFUN_CHAR_FORWARD +char-forward \end_layout \begin_layout Description Action Moves the cursor one position logically forward. @@ -1048,7 +1120,7 @@ Syntax char-forward \end_layout \begin_layout Subsection* -LFUN_CHAR_FORWARD_SELECT +char-forward-select \end_layout \begin_layout Description Action Moves the cursor one position logically forward, adding traversed position to the selection. @@ -1061,7 +1133,7 @@ Syntax char-forward-select \end_layout \begin_layout Subsection* -LFUN_CHAR_LEFT +char-left \end_layout \begin_layout Description Action Moves the cursor one position "to the left". @@ -1074,7 +1146,7 @@ Syntax char-left \end_layout \begin_layout Subsection* -LFUN_CHAR_LEFT_SELECT +char-left-select \end_layout \begin_layout Description Action Moves the cursor one position "to the left", adding traversed position to the selection. @@ -1087,7 +1159,7 @@ Syntax char-left-select \end_layout \begin_layout Subsection* -LFUN_CHAR_RIGHT +char-right \end_layout \begin_layout Description Action Moves the cursor one position "to the right". @@ -1100,7 +1172,7 @@ Syntax char-right \end_layout \begin_layout Subsection* -LFUN_CHAR_RIGHT_SELECT +char-right-select \end_layout \begin_layout Description Action Moves the cursor one position "to the right", adding traversed position to the selection. @@ -1113,3813 +1185,4261 @@ Syntax char-right-select \end_layout \begin_layout Subsection* -LFUN_WORD_BACKWARD +chars-transpose \end_layout \begin_layout Description -Action Moves the cursor to the logically previous beginning of a word. +Action Transposes the character at the cursor with the one before it. \end_layout \begin_layout Description -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. +Syntax chars-transpose \end_layout \begin_layout Description -Syntax word-backward +Origin Lgb, 25 Apr 2001 \end_layout \begin_layout Subsection* -LFUN_WORD_BACKWARD_SELECT +citation-insert \end_layout \begin_layout Description -Action Moves the cursor to the logically previous beginning of a word, adding the logically traversed text to the selection. +Action Inserts citation from loaded citation database. \end_layout \begin_layout Description -Notion See also LFUN_WORD_BACKWARD. +Syntax citation-insert [[|]] \end_layout \begin_layout Description -Syntax word-backward-select +Params : Citation (shortcut listed in available citations). +\begin_inset Newline newline +\end_inset + +: text which should appear before citation. +\end_layout +\begin_layout Description +Origin AAS, 97-02-23 \end_layout \begin_layout Subsection* -LFUN_WORD_DELETE_BACKWARD +clipboard-paste \end_layout \begin_layout Description -Action Deletes characters to the begining of the word (usually the "C+BackSpace" key). +Action Pastes text from the active clipboard (retains formatting if the clipboard contains formatted text). Pastes plain text if plain text is on the clipboard, but tries to interpret it in special ways for certain insets, e.g. converting csv data to rows and columns if the paste happens in a tabular inset. \end_layout \begin_layout Description -Syntax word-delete-backward +Notion Historically, LFUN_CLIPBOARD_PASTE was introduced as a counterpart of LFUN_PRIMARY_SELECTION_PASTE: It behaved exactly the same, but the source is the clipboard, not the selection. \end_layout - -\begin_layout Subsection* -LFUN_WORD_DELETE_FORWARD +\begin_layout Description +Syntax clipboard-paste [] \end_layout \begin_layout Description -Action Deletes characters to the end of the word (usually the "C+Delete" key). +Params : "paragraph" will cause pasting as one paragraph, i.e. "Join lines". \end_layout \begin_layout Description -Syntax word-delete-forward +Origin Georg, 10 Jul 2006 \end_layout \begin_layout Subsection* -LFUN_WORD_FIND_FORWARD -\end_layout -\begin_layout Description -Action Search for a given string in forward direction. +clipboard-paste-simple \end_layout \begin_layout Description -Notion Case sensitive, match words. If no argument given, last search repeated. +Action Pastes plain text from the active clipboard even if formatted LyX content is in the clipboard. Pastes plain text if plain text is on the clipboard, without trying to interpret it in special ways for certain insets, e.g. converting csv data to rows and columns if the paste happens in a tabular inset. \end_layout \begin_layout Description -Syntax word-find-forward [] +Syntax clipboard-paste-simple [] \end_layout \begin_layout Description -Origin Etienne, 16 Feb 1998 +Params : "paragraph" will cause pasting as one paragraph, i.e. "Join lines". \end_layout \begin_layout Subsection* -LFUN_WORD_FIND_BACKWARD -\end_layout -\begin_layout Description -Action Search for a given string in backward direction. +command-execute \end_layout \begin_layout Description -Notion Case sensitive, match words. If no argument given, last search repeated. +Action Switches the focus to the minibuffer so that the user can type in there. If necessary, it opens the minibuffer toolbar. \end_layout \begin_layout Description -Syntax word-find-backward [] +Notion Usually bound to M-x shortcut. \end_layout \begin_layout Description -Origin Etienne, 20 Feb 1998 +Syntax command-execute \end_layout \begin_layout Subsection* -LFUN_WORD_FIND -\end_layout -\begin_layout Description -Action Search for next occurence of a string. +complete \end_layout \begin_layout Description -Syntax word-find [] +Action Try to complete the word or command at the cursor position. \end_layout \begin_layout Description -Params : 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). +Syntax complete \end_layout \begin_layout Description -Origin Andre, Jan 7 2004 +Origin sts, Feb 19 2008 \end_layout \begin_layout Subsection* -LFUN_WORD_REPLACE -\end_layout -\begin_layout Description -Action Replace a string in the document. +completion-accept \end_layout \begin_layout Description -Syntax word-replace [] +Action Accept suggested completion. \end_layout \begin_layout Description -Params : data is of the form " -\begin_inset Newline newline -\end_inset - - -\begin_inset Newline newline -\end_inset - - " +Syntax completion-accept \end_layout \begin_layout Description -Origin Andre, Jan 7 2004 +Origin sanda, Sep 08 2008 \end_layout \begin_layout Subsection* -LFUN_WORD_FINDADV -\end_layout -\begin_layout Description -Action Search for next occurence of a pattern. +completion-cancel \end_layout \begin_layout Description -Syntax word-findadv [] +Action Try to cancel completion, either the popup or the inline completion. \end_layout \begin_layout Description -Params : data encoded from FindAdv dialog (see lyx::findadv2string()). If no parameter is given, search with last find-dialog data is used for search (i.e. find-next). +Syntax completion-cancel \end_layout \begin_layout Description -Origin Tommaso, Nov 15 2007 +Origin sts, Sep 07 2008 \end_layout \begin_layout Subsection* -LFUN_WORD_FORWARD +completion-inline \end_layout \begin_layout Description -Action Moves the cursor to the logically next beginning of a word. +Action Show the inline completion at the cursor position. \end_layout \begin_layout Description -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. +Syntax completion-inline \end_layout \begin_layout Description -Syntax word-forward +Origin sts, Feb 19 2008 \end_layout \begin_layout Subsection* -LFUN_WORD_FORWARD_SELECT +completion-popup \end_layout \begin_layout Description -Action Moves the cursor to the logically next beginning of a word, adding the logically traversed text to the selection. +Action Show the completion popup at the cursor position. \end_layout \begin_layout Description -Notion See also LFUN_WORD_FORWARD. +Syntax completion-popup \end_layout \begin_layout Description -Syntax word-forward-select +Origin sts, Feb 19 2008 \end_layout \begin_layout Subsection* -LFUN_WORD_LEFT +copy \end_layout \begin_layout Description -Action Moves the cursor to the next beginning of a word "on the left". +Action Copies the current selection to the clipboard. \end_layout \begin_layout Description -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. +Syntax copy +\end_layout + +\begin_layout Subsection* +cut \end_layout \begin_layout Description -Syntax word-left +Action Cuts to the clipboard. \end_layout \begin_layout Description -Origin dov, 28 Oct 2007 +Syntax cut \end_layout \begin_layout Subsection* -LFUN_WORD_LEFT_SELECT +date-insert \end_layout \begin_layout Description -Action Moves the cursor to the next beginning of a word "on the left", adding *logically* traversed text to the selection. +Action Inserts the current date. \end_layout \begin_layout Description -Notion See also LFUN_WORD_LEFT for exact details of the movement. +Syntax date-insert [] \end_layout \begin_layout Description -Syntax word-left-select +Params : Format of date. The default value (%x) can be set in Preferences->Date format. For possible formats see manual page of strftime function. \end_layout \begin_layout Description -Origin dov, 28 Oct 2007 +Origin jdblair, 31 Jan 2000 \end_layout \begin_layout Subsection* -LFUN_WORD_RIGHT +depth-decrement \end_layout \begin_layout Description -Action Moves the cursor to the next beginning of a word "on the right". +Action Decrease the nesting depth of the (selected) paragraph(s) inside lists. \end_layout \begin_layout Description -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. +Syntax depth-decrement +\end_layout + +\begin_layout Subsection* +depth-increment \end_layout \begin_layout Description -Syntax word-right +Action Increase the nesting depth of the (selected) paragraph(s) inside lists. \end_layout \begin_layout Description -Origin dov, 28 Oct 2007 +Syntax depth-increment \end_layout \begin_layout Subsection* -LFUN_WORD_RIGHT_SELECT +dialog-disconnect-inset \end_layout \begin_layout Description -Action Moves the cursor to the next beginning of a word "on the right", adding *logically* traversed text to the selection. +Action Closes opened connection to opened inset. \end_layout \begin_layout Description -Notion See also LFUN_WORD_RIGHT for exact details of the movement. +Notion Connection is used for apply functions. \end_layout \begin_layout Description -Syntax word-right-select +Syntax dialog-disconnect-inset \end_layout \begin_layout Description -Origin dov, 28 Oct 2007 +Origin leeming, 25 Feb 2003 \end_layout \begin_layout Subsection* -LFUN_WORD_SELECT +dialog-hide \end_layout \begin_layout Description -Action Puts the word where the cursor stands into the selection. +Action Hides showed dialog. Counterpart to LFUN_DIALOG_SHOW . \end_layout \begin_layout Description -Syntax word-select +Syntax dialog-hide \end_layout \begin_layout Description -Origin Andre, 11 Sep 2002 +Params See LFUN_DIALOG_SHOW . +\end_layout +\begin_layout Description +Origin leeming, 25 Feb 2003 \end_layout \begin_layout Subsection* -LFUN_WORD_CAPITALIZE +dialog-show \end_layout \begin_layout Description -Action Capitalizes the words in the selection (i.e. the first letters) or the letter on the cursor position. +Action Shows hidden dialog or creates new one for a given function/inset settings etc. \end_layout \begin_layout Description -Syntax word-capitalize +Syntax dialog-show [] +\end_layout +\begin_layout Description +Params : aboutlyx|bibitem|bibtex|box|branch|changes|character|citation| +\begin_inset Newline newline +\end_inset + +compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float| +\begin_inset Newline newline +\end_inset + +graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimiter| +\begin_inset Newline newline +\end_inset + +mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs| +\begin_inset Newline newline +\end_inset + +print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate| +\begin_inset Newline newline +\end_inset + +thesaurus|texinfo|toc|view-source|vspace|wrap| +\begin_inset Newline newline +\end_inset + +: latexlog|vclog +\begin_inset Newline newline +\end_inset + +: data, usually settings for the given dialog. Use debug mode for the details. +\end_layout +\begin_layout Description +Origin leeming, 17 Jun 2003 \end_layout \begin_layout Subsection* -LFUN_WORD_UPCASE +dialog-show-new-inset \end_layout \begin_layout Description -Action Change the words in the selection or from the cursor position to the end of word to the upper case. +Action Shows hidden dialog or create new one for a given inset settings etc. \end_layout \begin_layout Description -Syntax word-upcase +Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given inset. \end_layout - -\begin_layout Subsection* -LFUN_WORD_LOWCASE +\begin_layout Description +Syntax dialog-show-new-inset [] \end_layout \begin_layout Description -Action Change the words in the selection or from the cursor position to the end of word to the lower case. +Params See LFUN_DIALOG_SHOW . \end_layout \begin_layout Description -Syntax word-lowcase +Origin leeming, 25 Feb 2003 \end_layout \begin_layout Subsection* -LFUN_THESAURUS_ENTRY +dialog-toggle \end_layout \begin_layout Description -Action Look up thesaurus entries with respect to the word under the cursor. +Action Toggles dialog between showed/hidden state. \end_layout \begin_layout Description -Syntax thesaurus-entry [] [lang=] +Notion Internally uses LFUN_DIALOG_SHOW , LFUN_DIALOG_HIDE . \end_layout \begin_layout Description -Params : word to look up : language (see file languages) +Syntax dialog-toggle [] \end_layout \begin_layout Description -Origin Levon, 20 Jul 2001 +Params See LFUN_DIALOG_SHOW . +\end_layout +\begin_layout Description +Origin JSpitzm, 30 Apr 2007 \end_layout \begin_layout Subsection* -LFUN_BUFFER_BEGIN +dialog-update \end_layout \begin_layout Description -Action Move the cursor to the beginning of the document. +Action Updates the dialog values from the inset/paragraph/document. \end_layout \begin_layout Description -Syntax buffer-begin -\end_layout - -\begin_layout Subsection* -LFUN_BUFFER_BEGIN_SELECT +Syntax dialog-update \end_layout \begin_layout Description -Action Move the cursor to the beginning of the document adding the traversed text to the selection. +Params : paragraph|prefs| +\begin_inset Newline newline +\end_inset + +: inset name \end_layout \begin_layout Description -Syntax buffer-begin-select +Origin leeming, 25 Feb 2003 \end_layout \begin_layout Subsection* -LFUN_BUFFER_END +down \end_layout \begin_layout Description -Action Move the cursor to the end of the document. +Action Moves the cursor one line in downward direction. \end_layout \begin_layout Description -Syntax buffer-end +Syntax down \end_layout \begin_layout Subsection* -LFUN_BUFFER_END_SELECT +down-select \end_layout \begin_layout Description -Action Move the cursor to the end of the document adding the traversed text to the selection. +Action Moves the cursor one line in downward direction adding the current position to the selection. \end_layout \begin_layout Description -Syntax buffer-end-select +Syntax down-select \end_layout \begin_layout Subsection* -LFUN_INSET_BEGIN +ert-insert \end_layout \begin_layout Description -Action Move the cursor to the beginning of the current inset if it is not already there, or at the beginning of the enclosing inset otherwise +Action Inserts an ERT inset. \end_layout \begin_layout Description -Syntax inset-begin +Syntax ert-insert \end_layout \begin_layout Description -Origin lasgouttes, 16 Mar 2009 +Origin Jug, 18 Feb 2000 \end_layout \begin_layout Subsection* -LFUN_INSET_BEGIN_SELECT +escape \end_layout \begin_layout Description -Action Move the cursor to the beginning of the current inset if it is not already there, or at the beginning of the enclosing inset otherwise (adding the traversed text to the selection). +Action Clears the selection. If no text is selected call LFUN_FINISHED_FORWARD. Inside math mode jumps out of the math inset. \end_layout \begin_layout Description -Syntax inset-begin-select +Syntax escape \end_layout \begin_layout Description -Origin lasgouttes, 16 Mar 2009 +Origin Lgb, 17 May 2001 \end_layout \begin_layout Subsection* -LFUN_INSET_END +file-insert \end_layout \begin_layout Description -Action Move the cursor to the end of the current inset if it is not already there, or at the end of the enclosing inset otherwise +Action Inserts another LyX file. \end_layout \begin_layout Description -Syntax inset-end +Syntax file-insert [] \end_layout \begin_layout Description -Origin lasgouttes, 16 Mar 2009 +Params : Filename to be inserted. \end_layout \begin_layout Subsection* -LFUN_INSET_END_SELECT -\end_layout -\begin_layout Description -Action Move the cursor to the end of the current inset if it is not already there, or at the end of the enclosing inset otherwise (adding the traversed text to the selection). +file-insert-plaintext \end_layout \begin_layout Description -Syntax inset-end-select +Action Inserts plain text file. \end_layout \begin_layout Description -Origin lasgouttes, 16 Mar 2009 -\end_layout - -\begin_layout Subsection* -LFUN_LINE_BEGIN +Syntax file-insert-plaintext [] \end_layout \begin_layout Description -Action Move the cursor to the begining of the (screen) line. +Params : Filename to be inserted. \end_layout \begin_layout Description -Syntax line-begin +Origin CFO-G, 19 Nov 1997 \end_layout \begin_layout Subsection* -LFUN_LINE_BEGIN_SELECT +file-insert-plaintext-para \end_layout \begin_layout Description -Action Move the cursor to the beginning of the (screen) line adding the traversed text to the selection. +Action Inserts plain text file as paragraph (i.e. join lines). \end_layout \begin_layout Description -Syntax line-begin-select -\end_layout - -\begin_layout Subsection* -LFUN_LINE_END +Syntax file-insert-plaintext-para [] \end_layout \begin_layout Description -Action Move the cursor to the end of the (screen) line. +Params : Filename to be inserted. \end_layout \begin_layout Description -Syntax line-end +Origin Levon, 14 Feb 2001 \end_layout \begin_layout Subsection* -LFUN_LINE_END_SELECT +flex-insert \end_layout \begin_layout Description -Action Move the cursor to the end of the (screen) line adding the traversed text to the selection. +Action Inserts CharStyle, Custom inset or XML short element. \end_layout \begin_layout Description -Syntax line-end-select -\end_layout +Notion Look into the Customization manual for more information about these elements. +\begin_inset Newline newline +\end_inset -\begin_layout Subsection* -LFUN_LINE_DELETE +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. +\begin_inset Newline newline +\end_inset + +For dissolving the element see LFUN_INSET_DISSOLVE. \end_layout \begin_layout Description -Action Deletes the letters to the end of the (screen) line or deletes the selection. +Syntax flex-insert Name \end_layout \begin_layout Description -Syntax line-delete-forward +Params Name: This name must be defined either in your layout file or imported by some module. The definition is InsetLayout Name or InsetLayout . The Flex: prefix is optional. +\end_layout +\begin_layout Description +Sample flex-insert Code \end_layout \begin_layout Subsection* -LFUN_COPY +float-insert \end_layout \begin_layout Description -Action Copies to the clipboard the last edit. +Action Inserts a float inset. \end_layout \begin_layout Description -Syntax copy -\end_layout - -\begin_layout Subsection* -LFUN_CUT +Syntax float-insert \end_layout \begin_layout Description -Action Cuts to the clipboard. +Params : type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given. \end_layout \begin_layout Description -Syntax cut +Origin Lgb, 27 Jun 2000 \end_layout \begin_layout Subsection* -LFUN_PASTE +float-list-insert \end_layout \begin_layout Description -Action Pastes material (text or picture) from the active clipboard. +Action Inserts the list of floats in the document. \end_layout \begin_layout Description -Syntax paste [|] +Syntax float-list-insert \end_layout \begin_layout Description -Params : emf|pdf|png|jpeg|linkback|wmf -\begin_inset Newline newline -\end_inset - -: number of the selection in the internal clipboard stack to be pasted. +Params : type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given. +\end_layout +\begin_layout Description +Origin Lgb, 3 May 2001 \end_layout \begin_layout Subsection* -LFUN_CLIPBOARD_PASTE +float-wide-insert \end_layout \begin_layout Description -Action Pastes text from the active clipboard. +Action Inserts float insets as in LFUN_FLOAT_INSERT but span multiple columns. \end_layout \begin_layout Description -Syntax clipboard-paste [] +Notion Corresponds to the starred floats (figure*, table*, etc.) in LaTeX. \end_layout \begin_layout Description -Params : "paragraph" will cause pasting as one paragraph, i.e. "Join lines". +Syntax float-wide-insert +\end_layout +\begin_layout Description +Params : type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given. \end_layout \begin_layout Description -Origin baum, 10 Jul 2006 +Origin Lgb, 31 Oct 2001 \end_layout \begin_layout Subsection* -LFUN_PRIMARY_SELECTION_PASTE -\end_layout -\begin_layout Description -Action Pastes the currently text selected text. +footnote-insert \end_layout \begin_layout Description -Notion Primary selection mechanism is linux-only thing. +Action Inserts a footnote inset. \end_layout \begin_layout Description -Syntax primary-selection-paste [] +Syntax footnote-insert \end_layout \begin_layout Description -Params : "paragraph" will cause pasting as one paragraph, i.e. "Join lines". +Origin Jug, 7 Mar 2000 \end_layout \begin_layout Subsection* -LFUN_SELECTION_PASTE +graphics-reload \end_layout \begin_layout Description -Action Pastes the text in permanent selection. +Action Reloads the image if necessary. \end_layout \begin_layout Description -Syntax selection-paste +Syntax graphics-reload +\end_layout +\begin_layout Description +Origin vfr, 10 Aug 2009 \end_layout \begin_layout Subsection* -LFUN_UNDO +href-insert \end_layout \begin_layout Description -Action Undoes the last edit. +Action Inserts hyperlinks into the document (clickable in pdf output). \end_layout \begin_layout Description -Syntax undo -\end_layout - -\begin_layout Subsection* -LFUN_REDO +Notion Hyperlink target can be set via selection + hyperlink-insert function. \end_layout \begin_layout Description -Action Redoes the last thing undone. +Syntax href-insert [] \end_layout \begin_layout Description -Syntax redo +Origin CFO-G, 21 Nov 1997 \end_layout \begin_layout Subsection* -LFUN_REPEAT +in-ipa \end_layout \begin_layout Description -Action Repeat the given command. +Action Only active in IPA inset. \end_layout \begin_layout Description -Syntax repeat +Notion Dummy function which is only active in a IPA inset. It's used to toggle the IPA toolbar if the cursor moves into an IPA inset. \end_layout \begin_layout Description -Origin Andre, 27 Oct 2003 +Syntax in-ipa +\end_layout +\begin_layout Description +Origin spitz, 20 May 2012 \end_layout \begin_layout Subsection* -LFUN_CHARS_TRANSPOSE +index-insert \end_layout \begin_layout Description -Action Transposes the character at the cursor with the one before it. +Action Inserts Index entry. \end_layout \begin_layout Description -Syntax chars-transpose +Notion It automatically takes the word on the cursor position. \end_layout \begin_layout Description -Origin Lgb, 25 Apr 2001 -\end_layout - -\begin_layout Subsection* -LFUN_DEPTH_DECREMENT +Syntax index-insert [] \end_layout \begin_layout Description -Action Decrease the nesting depth of the (selected) paragraph(s) inside lists. +Params : name of the index, if multiple indices are defined. With an empty argument, the default index is selected. \end_layout \begin_layout Description -Syntax depth-decrement +Origin leeming, 3 Aug 2000 \end_layout \begin_layout Subsection* -LFUN_DEPTH_INCREMENT +index-print \end_layout \begin_layout Description -Action Increase the nesting depth of the (selected) paragraph(s) inside lists. +Action Inserts list of Index entries on a new page. \end_layout \begin_layout Description -Syntax depth-increment -\end_layout - -\begin_layout Subsection* -LFUN_FONT_BOLD +Syntax index-print [] \end_layout \begin_layout Description -Action Toggles the bold font (selection-wise) using mathbf in math. +Params : name of the index, if multiple indices are defined. With an empty argument, the default index is selected. \end_layout \begin_layout Description -Syntax font-bold +Origin Lgb, 27 Feb 1997 \end_layout \begin_layout Subsection* -LFUN_FONT_BOLDSYMBOL +info-insert \end_layout \begin_layout Description -Action Toggles the bold font (selection-wise) using boldsymbol in math. +Action Displays shortcuts, lyxrc, package and textclass availability and menu information in a non-editable boxed InsetText. \end_layout \begin_layout Description -Syntax font-boldsymbol -\end_layout +Notion Apart from lfun arguments you can use the following method: +\begin_inset Newline newline +\end_inset -\begin_layout Subsection* -LFUN_FONT_TYPEWRITER +1. input the type and argument of this inset, e.g. "menu paste", in the work area. +\begin_inset Newline newline +\end_inset + +2. select the text and run info-insert lfun. \end_layout \begin_layout Description -Action Toggles the typewriter family font (selection-wise). +Syntax info-insert \end_layout \begin_layout Description -Syntax font-typewriter -\end_layout +Params : shortcut[s]|lyxrc|lyxinfo|package|textclass|menu|buffer +\begin_inset Newline newline +\end_inset -\begin_layout Subsection* -LFUN_FONT_UNDERLINE +: argument for a given type. Look into InsetInfo.h for detailed description. +\begin_inset Newline newline +\end_inset + + shortcut[s]: name of lfun (e.g math-insert +\backslash +alpha) +\begin_inset Newline newline +\end_inset + + lyxrc: name of rc_entry (e.g. bind_file) +\begin_inset Newline newline +\end_inset + + lyxinfo: "version" - used version of LyX +\begin_inset Newline newline +\end_inset + + package: name of latex package (e.g. listings) +\begin_inset Newline newline +\end_inset + + textclass: name of textclass (e.g. article) +\begin_inset Newline newline +\end_inset + + menu: name of lfun used in menu +\begin_inset Newline newline +\end_inset + + icon: icon of lfun used in toolbar +\begin_inset Newline newline +\end_inset + + buffer: "name"|"path"|"class"|"vcs-tree-revision"| "vcs-revision"|"vcs-author"|"vcs-date"|"vcs-time" \end_layout \begin_layout Description -Action Toggles underline in the font (selection-wise). +Sample command-sequence info-insert buffer path; info-insert buffer name \end_layout \begin_layout Description -Syntax font-underline +Origin bpeng, 7 Oct 2007 \end_layout \begin_layout Subsection* -LFUN_FONT_UULINE +inset-apply \end_layout \begin_layout Description -Action Toggles double underline in the font (selection-wise). +Action Apply data for an inset. \end_layout \begin_layout Description -Syntax font-underunderline +Notion LFUN_INSET_APPLY is sent from the dialogs when the data should be applied. This is either changed to LFUN_INSET_MODIFY or LFUN_INSET_INSERT depending on the context where it is called. \end_layout \begin_layout Description -Origin sanda, 5 May 2009 +Syntax inset-apply +\end_layout +\begin_layout Description +Params See LFUN_INSET_INSERT . \end_layout \begin_layout Subsection* -LFUN_FONT_UWAVE +inset-begin \end_layout \begin_layout Description -Action Toggles wavy underline in the font (selection-wise). +Action Move the cursor to the beginning of the current inset if it is not already there, or at the beginning of the enclosing inset otherwise \end_layout \begin_layout Description -Syntax font-underwave +Syntax inset-begin \end_layout \begin_layout Description -Origin sanda, 5 May 2009 +Origin lasgouttes, 16 Mar 2009 \end_layout \begin_layout Subsection* -LFUN_FONT_STRIKEOUT +inset-begin-select \end_layout \begin_layout Description -Action Toggles strikeout (strike-through) in the font (selection-wise). +Action Move the cursor to the beginning of the current inset if it is not already there, or at the beginning of the enclosing inset otherwise (adding the traversed text to the selection). \end_layout \begin_layout Description -Syntax font-strikeout +Syntax inset-begin-select \end_layout \begin_layout Description -Origin sanda, 3 May 2009 +Origin lasgouttes, 16 Mar 2009 \end_layout \begin_layout Subsection* -LFUN_FONT_EMPH +inset-copy-as \end_layout \begin_layout Description -Action Toggles the emphasis font style (selection-wise). +Action Copies the inset to the clipboard as a certain type. \end_layout \begin_layout Description -Syntax font-emph -\end_layout - -\begin_layout Subsection* -LFUN_FONT_NOUN +Notion Currently used only for InsetInfo where its content is copied as a text. \end_layout \begin_layout Description -Action Toggles Noun text style font (selection-wise). +Syntax inset-copy-as \end_layout \begin_layout Description -Syntax font-noun +Origin vfr, 18 Apr 2010 \end_layout \begin_layout Subsection* -LFUN_FONT_ROMAN +inset-dissolve \end_layout \begin_layout Description -Action Toggles Roman family font (selection-wise). +Action Dissolve the current inset into text. \end_layout \begin_layout Description -Syntax font-roman -\end_layout - -\begin_layout Subsection* -LFUN_FONT_SANS +Syntax inset-dissolve [] \end_layout \begin_layout Description -Action Toggles Sans Serif family font (selection-wise). +Params : this can be used to make sure the right kind of inset is dissolved. For example "dissolve" entry in the charstyles sub-menu should only dissolve the charstyle inset, even if the cursor is inside several nested insets of different type. +\begin_inset Newline newline +\end_inset + +For values see lyx::InsetLayout::lyxtype_ . \end_layout \begin_layout Description -Syntax font-sans +Origin JSpitz, 7 Aug 2006 \end_layout \begin_layout Subsection* -LFUN_FONT_FRAK +inset-edit \end_layout \begin_layout Description -Action Toggles Fraktur family font (math-mode, selection-wise). +Action Edit the inset at cursor with an external application, if one is attributed. \end_layout \begin_layout Description -Syntax font-frak +Syntax inset-edit [] \end_layout \begin_layout Description -Origin vermeer, 10 Jan 2002 +Params : Parameters for the inset. +\begin_inset Newline newline +\end_inset + +Currently only the filename will be considered. +\end_layout +\begin_layout Description +Origin JSpitzm, 27 Apr 2006 \end_layout \begin_layout Subsection* -LFUN_FONT_ITAL +inset-end \end_layout \begin_layout Description -Action Toggles Italics font shape (math-mode, selection-wise). +Action Move the cursor to the end of the current inset if it is not already there, or at the end of the enclosing inset otherwise \end_layout \begin_layout Description -Syntax font-ital +Syntax inset-end \end_layout \begin_layout Description -Origin vermeer, 10 Jan 2002 +Origin lasgouttes, 16 Mar 2009 \end_layout \begin_layout Subsection* -LFUN_FONT_DEFAULT +inset-end-select \end_layout \begin_layout Description -Action Reverts the settings of the font to the default values (selection-wise). +Action Move the cursor to the end of the current inset if it is not already there, or at the end of the enclosing inset otherwise (adding the traversed text to the selection). \end_layout \begin_layout Description -Syntax font-default +Syntax inset-end-select +\end_layout +\begin_layout Description +Origin lasgouttes, 16 Mar 2009 \end_layout \begin_layout Subsection* -LFUN_FONT_SIZE +inset-forall \end_layout \begin_layout Description -Action Sets font size according to lyx format string. +Action Apply the given commands on insets of a given name. \end_layout \begin_layout Description -Syntax font-size +Notion WARNING: use at your own risks; this function gives you too many ways of shooting yourself in the foot. A typical example is inset-forall Note note-insert which starts an infinite loop. This is mitigated by the fact that the number of actions is arbitrarily limited to 100000. Note also that inset-forall does not update metrics between iterations, which can lead to bugs. This has to be eventually fixed. \end_layout \begin_layout Description -Params : tiny|scriptsize|footnotesize|small|normal|large|larger| +Syntax inset-forall \begin_inset Newline newline \end_inset -largest|huge|giant|increase|decrease|default +: Type of Inset. If is *, all insets are matched. The name is used like for InsetLayout in layout files: "Note" matches all note insets, while "Note:Note" only matches LyX yellow note insets. +\end_layout +\begin_layout Description +Sample Remove all index insets: +\begin_inset Newline newline +\end_inset + + inset-forall Index char-delete-forward +\begin_inset Newline newline +\end_inset + +Close all Notes (also works for a particular branch, for example): +\begin_inset Newline newline +\end_inset + + inset-forall Note inset-toggle close +\begin_inset Newline newline +\end_inset + +Transform all yellow notes to comments +\begin_inset Newline newline +\end_inset + + inset-forall Note:Note inset-modify note Note Comment +\begin_inset Newline newline +\end_inset + +Try to put LyX in an infinite loop if there is at least a Note: +\begin_inset Newline newline +\end_inset + + inset-forall Note char-backward +\end_layout +\begin_layout Description +Origin lasgouttes, 27 Nov 2009 +\end_layout + +\begin_layout Subsection* +inset-insert +\end_layout +\begin_layout Description +Action Insert new inset (type given by the parameters). +\end_layout +\begin_layout Description +Syntax inset-insert +\end_layout +\begin_layout Description +Params : +\begin_inset Newline newline +\end_inset + +: depends on the given inset. Use "lyx -dbg action" to explore. +\end_layout +\begin_layout Description +Sample inset-insert ref LatexCommand reference "