# gen_lfuns.py generated this file. For more info see http://www.lyx.org/
-\lyxformat 474
+\lyxformat 501
\begin_document
\begin_header
+\origin /systemlyxdir/doc/
\textclass article
\begin_preamble
\renewcommand{\descriptionlabel}[1]{\hspace\labelsep\upshape\bfseries #1:}
\language_package default
\inputencoding auto
\fontencoding global
-\font_roman default
-\font_sans default
-\font_typewriter default
-\font_math auto
+\font_roman "default" "default"
+\font_sans "default" "default"
+\font_typewriter "default" "default"
+\font_math "auto" "auto"
\font_default_family default
\use_non_tex_fonts false
\font_sc false
\font_osf false
-\font_sf_scale 100
-\font_tt_scale 100
+\font_sf_scale 100 100
+\font_tt_scale 100 100
\graphics default
\default_output_format default
\output_sync 0
\begin_body
\begin_layout Title
-LyX Functions (LFUNs)
+\SpecialChar LyX
+ Functions (LFUNs)
\end_layout
\begin_layout Author
-The LyX Team
+The \SpecialChar LyX
+ Team
\end_layout
\begin_layout Date
-2014-10-23
+2015-11-11
\end_layout
\begin_layout Section*
\end_inset
(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
+ These are commands that are used to make \SpecialChar LyX
+ perform specific actions.
+ \SpecialChar 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{}
+ So if you want to change\SpecialChar breakableslash
customize the user interface, you need to deal
with LFUNs.
Furthermore, external programs can use LFUNs to communicate with and
\begin_inset Quotes erd
\end_inset
- LyX.
+ \SpecialChar LyX
+ .
Finally, you can also issue LFUNs directly via the so called mini-buffer
which can be opened via
\begin_inset Info
Syntax accent-ogonek
\end_layout
+\begin_layout Subsection*
+accent-perispomeni
+\end_layout
+\begin_layout Description
+Action Adds a perispomeni (Greek circumflex) over the next character typed.
+\end_layout
+\begin_layout Description
+Syntax accent-perispomeni
+\end_layout
+
\begin_layout Subsection*
accent-tie
\end_layout
\begin_inset Newline newline
\end_inset
- icon: icon of lfun used in toolbar
+ icon: icon of lfun used in toolbar or direct icon name
\begin_inset Newline newline
\end_inset
inset-select-all
\end_layout
\begin_layout Description
-Action Selects all contents of an inset.
+Action Select all contents of an inset.
+\end_layout
+\begin_layout Description
+Notion There are 3 successive levels: select current cell, select all cells of inset, select the inset from outside (in the enclosing inset).
\end_layout
\begin_layout Description
Syntax inset-select-all
\end_layout
\begin_layout Description
-Origin vfr, 22 Aug 2009
+Origin vfr, 22 Aug 2009; lasgouttes 1 Nov 2014
\end_layout
\begin_layout Subsection*
section-select
\end_layout
\begin_layout Description
-Action Selects the whole section.
+Action Select the whole section.
\end_layout
\begin_layout Description
Notion The cursor should be in a section heading before calling this lfun.
Syntax specialchar-insert <CHAR>
\end_layout
\begin_layout Description
-Params <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots, end-of-sentence, menu-separator.
+Params <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots, end-of-sentence, menu-separator, lyx, tex, latex, latex2e.
\end_layout
\begin_layout Description
Origin JSpitzm, 6 Dec 2007
spelling-add
\end_layout
\begin_layout Description
-Action Add the word under the cursor to the respective spell checker dictionary.
+Action Add the word under the cursor to the respective spell checker dictionary. The default for the language is retrieved from the cursor position.
\end_layout
\begin_layout Description
Syntax spelling-add [<STRING>] [<LANG>]
spelling-ignore
\end_layout
\begin_layout Description
-Action Let the spell checker ignore the word under the cursor in the current session for the given language.
+Action Let the spell checker ignore the word under the cursor in the current session for the given language. The default for the language is retrieved from the cursor position.
\end_layout
\begin_layout Description
Syntax spelling-ignore [<WORD>] [<LANG>]
spelling-remove
\end_layout
\begin_layout Description
-Action Remove the word under the cursor from the respective spell checker dictionary.
+Action Remove the word under the cursor from the respective spell checker dictionary. The default for the language is retrieved from the cursor position.
\end_layout
\begin_layout Description
Syntax spelling-remove [<STRING>] [<LANG>]
word-capitalize
\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 Capitalizes the words in the selection (i.e. the first letters) or the first letter of word at cursor position.
+\end_layout
+\begin_layout Description
+Syntax word-capitalize [<SEL_TYPE>]
\end_layout
\begin_layout Description
-Syntax word-capitalize
+Params <SEL_TYPE>: if this is equal to "partial", then the default word starts at cursor position (emacs-style). Otherwise, the whole word is considered.
\end_layout
\begin_layout Subsection*
word-lowcase
\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.
+Action Change the words in the selection or word at cursor position to lower case.
+\end_layout
+\begin_layout Description
+Syntax word-lowcase [<SEL_TYPE>]
\end_layout
\begin_layout Description
-Syntax word-lowcase
+Params <SEL_TYPE>: if this is equal to "partial", then the default word starts at cursor position (emacs-style). Otherwise, the whole word is considered.
\end_layout
\begin_layout Subsection*
word-upcase
\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 Change the words in the selection or word at cursor position to upper case.
+\end_layout
+\begin_layout Description
+Syntax word-upcase [<SEL_TYPE>]
\end_layout
\begin_layout Description
-Syntax word-upcase
+Params <SEL_TYPE>: if this is equal to "partial", then the default word starts at cursor position (emacs-style). Otherwise, the whole word is considered.
\end_layout
\begin_layout Subsection*
\end_layout
\begin_layout Description
-Origin scottkostyshak, 20 Jul 2012
+Origin skostysh, 20 Jul 2012
\end_layout
\begin_layout Subsection*
Origin leeming, 30 Mar 2004
\end_layout
+\begin_layout Subsection*
+buffer-move-next
+\end_layout
+\begin_layout Description
+Action Moves the current tab one spot to the right.
+\end_layout
+\begin_layout Description
+Syntax buffer-move-next
+\end_layout
+\begin_layout Description
+Origin skostysh, 7 Apr 2015
+\end_layout
+
+\begin_layout Subsection*
+buffer-move-previous
+\end_layout
+\begin_layout Description
+Action Moves the current tab one spot to the left.
+\end_layout
+\begin_layout Description
+Syntax buffer-move-previous
+\end_layout
+\begin_layout Description
+Origin skostysh, 7 Apr 2015
+\end_layout
+
\begin_layout Subsection*
buffer-new
\end_layout
Syntax buffer-previous
\end_layout
-\begin_layout Subsection*
-buffer-print
-\end_layout
-\begin_layout Description
-Action Prints the current document.
-\end_layout
-\begin_layout Description
-Notion Many settings can be given via the preferences dialog.
-\end_layout
-\begin_layout Description
-Syntax buffer-print <TARGET> <TARGET-NAME> <COMMAND>
-\end_layout
-\begin_layout Description
-Params <TARGET> is either "printer" or "file".
-\begin_inset Newline newline
-\end_inset
-
-<TARGER-NAME> is either "default" or file name or printer name.
-\begin_inset Newline newline
-\end_inset
-
-<COMMAND> command ensuring the printing job.
-\end_layout
-\begin_layout Description
-Sample buffer-print file "/trash/newfile1.ps" "dvips"
-\end_layout
-\begin_layout Description
-Origin leeming, 28 Mar 2004
-\end_layout
-
\begin_layout Subsection*
buffer-reload
\end_layout
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.
\end_layout
+\begin_layout Subsection*
+buffer-view-cache
+\end_layout
+\begin_layout Description
+Action Opens the file that was created from last preview of this buffer.
+\end_layout
+\begin_layout Description
+Notion This LFUN is called by the "Show Output Anyway" button in the LaTeX Errors dialog. It can also be called by the user, which is useful if the document takes a long time to compile, and you just want to see the last previewed version.
+\end_layout
+\begin_layout Description
+Syntax buffer-view-cache
+\end_layout
+
\begin_layout Subsection*
buffer-write
\end_layout
projects / lyx.git / blobdiff