3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Lars Gullik Bjønnes
7 * \author Jean-Marc Lasgouttes
12 * Full author contact details are available in file CREDITS.
17 #include "LyXAction.h"
19 #include "FuncRequest.h"
21 #include "support/debug.h"
22 #include "support/lstrings.h"
24 #include "support/lassert.h"
29 using namespace lyx::support;
34 NAMING RULES FOR USER-COMMANDS
35 Here's the set of rules to apply when a new command name is introduced:
37 1) Use the object.event order. That is, use `word-forward'
38 instead of `forward-word'.
39 2) Don't introduce an alias for an already named object. Same for events.
40 3) Forward movement or focus is called `forward' (not `right').
41 4) Backward movement or focus is called `backward' (not `left').
42 5) Upward movement of focus is called `up'.
43 6) Downward movement is called `down'.
44 7) The begin of an object is called `begin' (not `start').
45 8) The end of an object is called `end'.
47 (May 19 1996, 12:04, RvdK)
52 * The documentation below is primarily description of purpose and syntax
53 * relating to the different LFUNs.
55 * Try to find an appropriate (thematical) place when adding the new LFUN
56 * and don't forget to add doxygen commentary.
58 * Doxygen template below. Some notes: Parameters should be set in uppercase
59 * and put in <BRACKETS>, [<PARAM>] means optional one.
61 * Use spaces for indentation (doxy -> .lyx generator is tab-sensitive).
65 * \var lyx::FuncCode lyx::LFUN_
78 void LyXAction::newFunc(FuncCode action, string const & name,
79 unsigned int attrib, LyXAction::FuncType type)
81 lyx_func_map[name] = action;
84 tmpinfo.attrib = attrib;
86 lyx_info_map[action] = tmpinfo;
90 // Needed for LFUNs documentation to be accepted, since doxygen won't take
91 // \var inside functions.
92 #ifndef DOXYGEN_SHOULD_SKIP_THIS
93 void LyXAction::init()
95 // This function was changed to use the array below in initalization
96 // instead of calling newFunc numerous times because of compilation
97 // times. Since the array is not static we get back the memory it
98 // occupies after the init is completed. It compiles several
112 ev_item const items[] = {
115 * \var lyx::FuncCode lyx::LFUN_ACCENT_ACUTE
116 * \li Action: Adds an acute accent \htmlonly (á)\endhtmlonly
117 to the next character typed.
118 * \li Syntax: accent-acute
121 { LFUN_ACCENT_ACUTE, "accent-acute", Noop, Edit },
123 * \var lyx::FuncCode lyx::LFUN_ACCENT_BREVE
124 * \li Action: Adds a breve accent \htmlonly (ă)\endhtmlonly
125 to the next character typed.
126 * \li Syntax: accent-breve
129 { LFUN_ACCENT_BREVE, "accent-breve", Noop, Edit },
131 * \var lyx::FuncCode lyx::LFUN_ACCENT_CARON
132 * \li Action: Adds a caron \htmlonly (ǎ)\endhtmlonly
133 to the next character typed.
134 * \li Syntax: accent-caron
137 { LFUN_ACCENT_CARON, "accent-caron", Noop, Edit },
139 * \var lyx::FuncCode lyx::LFUN_ACCENT_CEDILLA
140 * \li Action: Adds a cedilla \htmlonly (ç)\endhtmlonly
141 to the next character typed.
142 * \li Syntax: accent-cedilla
145 { LFUN_ACCENT_CEDILLA, "accent-cedilla", Noop, Edit },
147 * \var lyx::FuncCode lyx::LFUN_ACCENT_CIRCLE
148 * \li Action: Adds a circle accent \htmlonly (å)\endhtmlonly
149 to the next character typed.
150 * \li Syntax: accent-circle
153 { LFUN_ACCENT_CIRCLE, "accent-circle", Noop, Edit },
155 * \var lyx::FuncCode lyx::LFUN_ACCENT_CIRCUMFLEX
156 * \li Action: Adds a circumflex \htmlonly (ê)\endhtmlonly
157 to the next character typed.
158 * \li Syntax: accent-circumflex
161 { LFUN_ACCENT_CIRCUMFLEX, "accent-circumflex", Noop, Edit },
163 * \var lyx::FuncCode lyx::LFUN_ACCENT_DOT
164 * \li Action: Adds a dot accent \htmlonly (ż)\endhtmlonly
165 to the next character typed.
166 * \li Syntax: accent-dot
169 { LFUN_ACCENT_DOT, "accent-dot", Noop, Edit },
171 * \var lyx::FuncCode lyx::LFUN_ACCENT_GRAVE
172 * \li Action: Adds a grave accent \htmlonly (è)\endhtmlonly
173 to the next character typed.
174 * \li Syntax: accent-grave
177 { LFUN_ACCENT_GRAVE, "accent-grave", Noop, Edit },
179 * \var lyx::FuncCode lyx::LFUN_ACCENT_HUNGARIAN_UMLAUT
180 * \li Action: Adds a Hungarian umlaut \htmlonly (ő)\endhtmlonly
181 to the next character typed.
182 * \li Syntax: accent-grave
185 { LFUN_ACCENT_HUNGARIAN_UMLAUT, "accent-hungarian-umlaut", Noop, Edit },
187 * \var lyx::FuncCode lyx::LFUN_ACCENT_MACRON
188 * \li Action: Adds a macron \htmlonly (ā)\endhtmlonly
189 to the next character typed.
190 * \li Syntax: accent-macron
193 { LFUN_ACCENT_MACRON, "accent-macron", Noop, Edit },
195 * \var lyx::FuncCode lyx::LFUN_ACCENT_OGONEK
196 * \li Action: Adds an ogonek accent \htmlonly (ą)\endhtmlonly
197 to the next character typed.
198 * \li Syntax: accent-ogonek
201 { LFUN_ACCENT_OGONEK, "accent-ogonek", Noop, Edit },
203 * \var lyx::FuncCode lyx::LFUN_ACCENT_PERISPOMENI
204 * \li Action: Adds a perispomeni (Greek circumflex)
205 over the next character typed.
206 * \li Syntax: accent-perispomeni
209 { LFUN_ACCENT_PERISPOMENI, "accent-perispomeni", Noop, Edit },
211 * \var lyx::FuncCode lyx::LFUN_ACCENT_TIE
212 * \li Action: Adds a tie \htmlonly (a͡)\endhtmlonly
213 over the next two character typed.
214 * \li Notion: The following char will finish the tie.
215 * \li Syntax: accent-tie
218 { LFUN_ACCENT_TIE, "accent-tie", Noop, Edit },
220 * \var lyx::FuncCode lyx::LFUN_ACCENT_TILDE
221 * \li Action: Adds a tilde \htmlonly (ã)\endhtmlonly
222 over the next character typed.
223 * \li Syntax: accent-tilde
226 { LFUN_ACCENT_TILDE, "accent-tilde", Noop, Edit },
228 * \var lyx::FuncCode lyx::LFUN_ACCENT_UMLAUT
229 * \li Action: Adds an umlaut \htmlonly (ä)\endhtmlonly
230 over the next character typed.
231 * \li Syntax: accent-umlaut
234 { LFUN_ACCENT_UMLAUT, "accent-umlaut", Noop, Edit },
236 * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERBAR
237 * \li Action: Adds a bar \htmlonly (a̠)\endhtmlonly
238 under the next character typed.
239 * \li Syntax: accent-underbar
242 { LFUN_ACCENT_UNDERBAR, "accent-underbar", Noop, Edit },
244 * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERDOT
245 * \li Action: Adds a dot \htmlonly (ạ)\endhtmlonly
246 under the next character typed.
247 * \li Syntax: accent-underdot
250 { LFUN_ACCENT_UNDERDOT, "accent-underdot", Noop, Edit },
253 * \var lyx::FuncCode lyx::LFUN_CAPTION_INSERT
254 * \li Action: Inserts a caption inset.
255 * \li Syntax: caption-insert
256 * \li Origin: Lgb, 18 Jul 2000
259 { LFUN_CAPTION_INSERT, "caption-insert", Noop, Edit },
261 * \var lyx::FuncCode lyx::LFUN_DATE_INSERT
262 * \li Action: Inserts the current date.
263 * \li Syntax: date-insert [<ARG>]
264 * \li Params: <ARG>: Format of date. The default value (%x) can be set
265 in Preferences->Date format. For possible formats
266 see manual page of strftime function.
267 * \li Origin: jdblair, 31 Jan 2000
270 { LFUN_DATE_INSERT, "date-insert", Noop, Edit },
272 * \var lyx::FuncCode lyx::LFUN_FOOTNOTE_INSERT
273 * \li Action: Inserts a footnote inset.
274 * \li Syntax: footnote-insert
275 * \li Origin: Jug, 7 Mar 2000
278 { LFUN_FOOTNOTE_INSERT, "footnote-insert", Noop, Edit },
280 * \var lyx::FuncCode lyx::LFUN_ERT_INSERT
281 * \li Action: Inserts an ERT inset.
282 * \li Syntax: ert-insert
283 * \li Origin: Jug, 18 Feb 2000
286 { LFUN_ERT_INSERT, "ert-insert", Noop, Edit },
288 * \var lyx::FuncCode lyx::LFUN_FLOAT_INSERT
289 * \li Action: Inserts a float inset.
290 * \li Syntax: float-insert <TYPE>
291 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
292 "algorithm", "table", "figure" parameters can be given.
293 * \li Origin: Lgb, 27 Jun 2000
296 { LFUN_FLOAT_INSERT, "float-insert", Noop, Edit },
298 * \var lyx::FuncCode lyx::LFUN_FLOAT_WIDE_INSERT
299 * \li Action: Inserts float insets as in #LFUN_FLOAT_INSERT but span multiple columns.
300 * \li Notion: Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
301 * \li Syntax: float-wide-insert <TYPE>
302 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
303 "algorithm", "table", "figure" parameters can be given.
304 * \li Origin: Lgb, 31 Oct 2001
307 { LFUN_FLOAT_WIDE_INSERT, "float-wide-insert", Noop, Edit },
309 * \var lyx::FuncCode lyx::LFUN_FLOAT_LIST_INSERT
310 * \li Action: Inserts the list of floats in the document.
311 * \li Syntax: float-list-insert <TYPE>
312 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
313 "algorithm", "table", "figure" parameters can be given.
314 * \li Origin: Lgb, 3 May 2001
317 { LFUN_FLOAT_LIST_INSERT, "float-list-insert", Noop, Edit },
319 * \var lyx::FuncCode lyx::LFUN_WRAP_INSERT
320 * \li Action: Inserts floats wrapped by the text around.
321 * \li Syntax: wrap-insert <TYPE>
322 * \li Params: <TYPE>: table|figure
323 * \li Origin: Dekel, 7 Apr 2002
326 { LFUN_WRAP_INSERT, "wrap-insert", Noop, Edit },
328 * \var lyx::FuncCode lyx::LFUN_ARGUMENT_INSERT
329 * \li Action: Inserts an argument (short title) inset.
330 * \li Syntax: argument-insert <argument nr>
331 * \li Params: <argument nr>: see layout declarations
332 * \li Origin: vermeer, 12 Aug 2002
335 { LFUN_ARGUMENT_INSERT, "argument-insert", Noop, Edit },
337 * \var lyx::FuncCode lyx::LFUN_NEWPAGE_INSERT
338 * \li Action: Inserts a new page.
339 * \li Syntax: newpage-insert <ARG>
340 * \li Params: <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
341 * \li Origin: uwestoehr, 24 Nov 2007
344 { LFUN_NEWPAGE_INSERT, "newpage-insert", Noop, Edit },
346 * \var lyx::FuncCode lyx::LFUN_MARGINALNOTE_INSERT
347 * \li Action: Inserts a marginal note.
348 * \li Syntax: marginalnote-insert
349 * \li Origin: Lgb, 26 Jun 2000
352 { LFUN_MARGINALNOTE_INSERT, "marginalnote-insert", Noop, Edit },
354 * \var lyx::FuncCode lyx::LFUN_UNICODE_INSERT
355 * \li Action: Inserts a single unicode character.
356 * \li Syntax: unicode-insert <CHAR>
357 * \li Params: <CHAR>: The character to insert, given as its code
358 point, in hexadecimal.
359 * \li Sample: unicode-insert 0x0100
360 * \li Origin: Lgb, 22 Oct 2006
363 { LFUN_UNICODE_INSERT, "unicode-insert", Noop, Edit },
365 * \var lyx::FuncCode lyx::LFUN_LISTING_INSERT
366 * \li Action: Inserts a new listings inset.
367 * \li Syntax: listing-insert
368 * \li Origin: Herbert, 10 Nov 2001; bpeng, 2 May 2007
371 { LFUN_LISTING_INSERT, "listing-insert", Noop, Edit },
373 * \var lyx::FuncCode lyx::LFUN_PREVIEW_INSERT
374 * \li Action: Inserts a new preview inset.
375 * \li Syntax: preview-insert
376 * \li Origin: vfr, 28 Mar 2010
379 { LFUN_PREVIEW_INSERT, "preview-insert", Noop, Edit },
381 * \var lyx::FuncCode lyx::LFUN_TAB_INSERT
382 * \li Action: Insert a tab into a listings inset.
383 * \li Notion: It also works on a selection.
384 * \li Syntax: tab-insert
385 * \li Origin: vfr, Sep 30 2008
388 { LFUN_TAB_INSERT, "tab-insert", SingleParUpdate, Edit },
390 * \var lyx::FuncCode lyx::LFUN_TAB_DELETE
391 * \li Action: Delete a tab or up to an equivalent amount of spaces from
393 * \li Notion: It also works on a selection - it removes a tab or spaces from the
394 beginning of each line spanned by the selection. This is useful if
395 you want to indent/unindent multiple lines in one action.
396 * \li Syntax: tab-delete
397 * \li Origin: vfr, Sep 30 2008
400 { LFUN_TAB_DELETE, "tab-delete", SingleParUpdate, Edit },
402 * \var lyx::FuncCode lyx::LFUN_QUOTE_INSERT
403 * \li Action: Inserts quotes according to the type and quote-language preference.
404 * \li Notion: Currently English, Swedish, German, Polish, French, Danish quotes
406 * \li Syntax: quote-insert [<LEVEL>] [<SIDE>] [<STYLE>]
407 * \li Params: <LEVEL>: 'single' for single (i.e., inner or secondary) quotes, otherwise
408 * double quotes will be used.
409 * <SIDE>: 'left' for opening quotes, 'right' for closing quotes, otherwise
410 * the side will be guessed from the context.
411 * <STYLE>: 'english' for ``English'' quote style
412 * 'swedish' for ''Swedish'' quote style
413 * 'german' for ,,German`` quote style
414 * 'polish' for ,,Polish'' quote style
415 * 'french' for <<French>> quote style
416 * 'danish' for >>Danish<< quote style
417 * 'plain' for "Plain" quote style
418 * If no quote style is specified, the document-wide will be used.
421 { LFUN_QUOTE_INSERT, "quote-insert", Noop, Edit },
423 * \var lyx::FuncCode lyx::LFUN_INFO_INSERT
424 * \li Action: Displays shortcuts, lyxrc, package and textclass availability and menu
425 information in a non-editable boxed InsetText.
426 * \li Notion: Apart from lfun arguments you can use the following method: \n
427 1. input the type and argument of this inset, e.g. "menu paste", in
429 2. select the text and run info-insert lfun.
430 * \li Syntax: info-insert <TYPE> <ARG>
431 * \li Params: <TYPE>: shortcut[s]|lyxrc|lyxinfo|package|textclass|menu|buffer \n
432 <ARG>: argument for a given type. Look into InsetInfo.h for detailed
434 shortcut[s]: name of lfun (e.g math-insert \alpha) \n
435 lyxrc: name of rc_entry (e.g. bind_file) \n
436 lyxinfo: "version" - used version of LyX \n
437 package: name of latex package (e.g. listings) \n
438 textclass: name of textclass (e.g. article) \n
439 menu: name of lfun used in menu \n
440 icon: icon of lfun used in toolbar or direct icon name\n
441 buffer: "name"|"path"|"class"|"vcs-tree-revision"|
442 "vcs-revision"|"vcs-author"|"vcs-date"|"vcs-time"
443 * \li Sample: command-sequence info-insert buffer path; info-insert buffer name
444 * \li Origin: bpeng, 7 Oct 2007
447 { LFUN_INFO_INSERT, "info-insert", Noop, Edit },
449 * \var lyx::FuncCode lyx::LFUN_BRANCH_INSERT
450 * \li Action: Inserts branch inset.
451 * \li Syntax: branch-insert <BRANCH-NAME>
452 * \li Origin: vermeer, 17 Aug 2003
455 { LFUN_BRANCH_INSERT, "branch-insert", Noop, Edit },
457 * \var lyx::FuncCode lyx::LFUN_BOX_INSERT
458 * \li Action: Inserts Box inset.
459 * \li Syntax: box-insert [<TYPE>]
460 * \li Params: <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox \n
461 Framed is the default one.
462 * \li Origin: vermeer, 7 Oct 2003
465 { LFUN_BOX_INSERT, "box-insert", Noop, Edit },
467 * \var lyx::FuncCode lyx::LFUN_FLEX_INSERT
468 * \li Action: Inserts CharStyle, Custom inset or XML short element.
469 * \li Notion: Look into the Customization manual for more information about
471 To make this command enabled the layout file for the document
472 class you're using has to load the character styles. There are
473 a few contained in the Logical Markup module. You can also of
474 course create some yourself. \n
475 For dissolving the element see #LFUN_INSET_DISSOLVE.
476 * \li Syntax: flex-insert Name
477 * \li Params: Name: This name must be defined either in your layout file
478 or imported by some module. The definition is
479 InsetLayout Name or InsetLayout <Flex:Name>. The Flex:
481 * \li Sample: flex-insert Code
484 { LFUN_FLEX_INSERT, "flex-insert", Noop, Edit },
486 * \var lyx::FuncCode lyx::LFUN_SELF_INSERT
487 * \li Action: Inserts the given string (accordingly to the correct keymap).
488 * \li Notion: Automatically replace the currently selected text. Depends on lyxrc
489 settings "auto_region_delete".
490 * \li Syntax: self-insert <STRING>
493 { LFUN_SELF_INSERT, "self-insert", SingleParUpdate, Hidden },
495 * \var lyx::FuncCode lyx::LFUN_SPACE_INSERT
496 * \li Action: Inserts one of horizontal space insets.
497 * \li Syntax: space-insert <NAME> [<LEN>]
498 * \li Params: <NAME>: normal, protected, visible, thin, quad, qquad, enspace,
499 enskip, negthinspace, negmedspace, negthickspace, hfill,
500 hfill*, dotfill, hrulefill, hspace, hspace* \n
501 Only in math mode: med and thick.\n
502 <LEN>: length for custom spaces (hspace, hspace* for protected)
503 * \li Origin: JSpitzm, 20 May 2003, Mar 17 2008
506 { LFUN_SPACE_INSERT, "space-insert", Noop, Edit },
508 * \var lyx::FuncCode lyx::LFUN_HREF_INSERT
509 * \li Action: Inserts hyperlinks into the document (clickable in pdf output).
510 * \li Notion: Hyperlink target can be set via selection + hyperlink-insert function.
511 * \li Syntax: href-insert [<TARGET>]
512 * \li Origin: CFO-G, 21 Nov 1997
515 { LFUN_HREF_INSERT, "href-insert", Noop, Edit },
517 * \var lyx::FuncCode lyx::LFUN_SPECIALCHAR_INSERT
518 * \li Action: Inserts various characters into the document.
519 * \li Syntax: specialchar-insert <CHAR>
520 * \li Params: <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots,
521 end-of-sentence, menu-separator, lyx, tex, latex, latex2e.
522 * \li Origin: JSpitzm, 6 Dec 2007
525 { LFUN_SPECIALCHAR_INSERT, "specialchar-insert", Noop, Edit },
527 * \var lyx::FuncCode lyx::LFUN_SCRIPT_INSERT
528 * \li Action: Inserts a subscript or superscript inset.
529 * \li Syntax: script-insert <TYPE>
530 * \li Params: <TYPE>: subscript|superscript
531 * \li Origin: Georg, 23 Nov 2010
534 { LFUN_SCRIPT_INSERT, "script-insert", Noop, Edit },
536 * \var lyx::FuncCode lyx::LFUN_APPENDIX
537 * \li Action: Start (or remove) Appendix on the given cursor position.
538 * \li Syntax: appendix
539 * \li Origin: ettrich, 5 May 1998
542 { LFUN_APPENDIX, "appendix", Noop, Edit },
545 * \var lyx::FuncCode lyx::LFUN_INDEX_INSERT
546 * \li Action: Inserts Index entry.
547 * \li Notion: It automatically takes the word on the cursor position.
548 * \li Syntax: index-insert [<TYPE:Name>]
549 * \li Params: <TYPE:Name>: name of the index, if multiple indices are defined.
550 With an empty argument, the default index is selected.
551 * \li Origin: leeming, 3 Aug 2000
554 { LFUN_INDEX_INSERT, "index-insert", Noop, Edit },
556 * \var lyx::FuncCode lyx::LFUN_INDEX_PRINT
557 * \li Action: Inserts list of Index entries on a new page.
558 * \li Syntax: index-print [<TYPE:Name>]
559 * \li Params: <TYPE:Name>: name of the index, if multiple indices are defined.
560 With an empty argument, the default index is selected.
561 * \li Origin: Lgb, 27 Feb 1997
564 { LFUN_INDEX_PRINT, "index-print", Noop, Edit },
566 * \var lyx::FuncCode lyx::LFUN_IPA_INSERT
567 * \li Action: Inserts an IPA inset.
568 * \li Syntax: ipa-insert
569 * \li Origin: spitz, 05 Mar 2012
572 { LFUN_IPA_INSERT, "ipa-insert", Noop, Edit },
574 * \var lyx::FuncCode lyx::LFUN_IN_IPA
575 * \li Action: Only active in IPA inset.
576 * \li Notion: Dummy function which is only active in a IPA inset.
577 It's used to toggle the IPA toolbar if the cursor moves
580 * \li Origin: spitz, 20 May 2012
583 { LFUN_IN_IPA, "in-ipa", Noop, Edit },
585 * \var lyx::FuncCode lyx::LFUN_IPAMACRO_INSERT
586 * \li Action: Inserts special IPA macros into the document.
587 * \li Syntax: ipamacro-insert <CHAR>
588 * \li Params: <CHAR>: tone-falling, tone-rising, tone-high-rising, tone-low-rising,
589 * tone-high-rising-falling, deco bottomtiebar, deco toptiebar.
590 * \li Origin: JSpitzm, 22 Aug 2012
593 { LFUN_IPAMACRO_INSERT, "ipamacro-insert", Noop, Edit },
595 * \var lyx::FuncCode lyx::LFUN_NOMENCL_INSERT
596 * \li Action: Inserts Nomenclature entry.
597 * \li Notion: It automatically takes the word on the cursor position if no symbol is given.
598 * \li Syntax: nomencl-insert [<SYMBOL>]
599 * \li Origin: Ugras, 4 Nov 2006
602 { LFUN_NOMENCL_INSERT, "nomencl-insert", Noop, Edit },
604 * \var lyx::FuncCode lyx::LFUN_NOMENCLATURE_PRINT
605 * \li Action: Inserts list of Nomenclature entries.
606 * \li Syntax: nomenclature-print
607 * \li Origin: Ugras, 4 Nov 2006
610 { LFUN_NOMENCL_PRINT, "nomencl-print", Noop, Edit },
613 * \var lyx::FuncCode lyx::LFUN_NOTE_INSERT
614 * \li Action: Inserts Note on the current cursor position,
615 move selection inside the inset.
616 * \li Syntax: note-insert [<TYPE>]
617 * \li Params: <TYPE>: <Note|Greyedout|Comment> default: Note
620 { LFUN_NOTE_INSERT, "note-insert", Noop, Edit },
622 * \var lyx::FuncCode lyx::LFUN_NOTE_NEXT
623 * \li Action: Moves the cursor to the beginning of next Note inset.
624 * \li Syntax: note-next
627 { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
629 * \var lyx::FuncCode lyx::LFUN_PHANTOM_INSERT
630 * \li Action: Inserts phantom on the current cursor position,
631 move selection inside the inset.
632 * \li Syntax: phantom-insert [<TYPE>]
633 * \li Params: <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
634 * \li Origin: uwestoehr, 30 Jan 2009
637 { LFUN_PHANTOM_INSERT, "phantom-insert", Noop, Edit },
639 * \var lyx::FuncCode lyx::LFUN_NEWLINE_INSERT
640 * \li Action: Inserts a line break or new line.
641 * \li Syntax: newline-insert [<ARG>]
642 * \li Params: <ARG>: <newline|linebreak> default: newline
643 * \li Origin: JSpitzm, 25 Mar 2008
646 { LFUN_NEWLINE_INSERT, "newline-insert", Noop, Edit },
648 * \var lyx::FuncCode lyx::LFUN_SEPARATOR_INSERT
649 * \li Action: Inserts an environment separator or latex paragraph break.
650 * \li Syntax: separator-insert [<ARG>]
651 * \li Params: <ARG>: <plain|parbreak|latexpar> default: plain
652 * \li Origin: ef, 2 May 2014
655 { LFUN_SEPARATOR_INSERT, "separator-insert", Noop, Edit },
657 * \var lyx::FuncCode lyx::LFUN_ESCAPE
658 * \li Action: Clears the selection. If no text is selected call #LFUN_FINISHED_FORWARD.
659 Inside math mode jumps out of the math inset.
661 * \li Origin: Lgb, 17 May 2001
664 { LFUN_ESCAPE, "escape", ReadOnly, Edit },
666 * \var lyx::FuncCode lyx::LFUN_DOWN
667 * \li Action: Moves the cursor one line in downward direction.
671 { LFUN_DOWN, "down", ReadOnly | NoUpdate, Edit },
673 * \var lyx::FuncCode lyx::LFUN_UP
674 * \li Action: Moves the cursor one line in upward direction.
678 { LFUN_UP, "up", ReadOnly | NoUpdate, Edit },
680 * \var lyx::FuncCode lyx::LFUN_DOWN_SELECT
681 * \li Action: Moves the cursor one line in downward direction adding the current
682 position to the selection.
683 * \li Syntax: down-select
686 { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, Edit },
688 * \var lyx::FuncCode lyx::LFUN_UP_SELECT
689 * \li Action: Moves the cursor one line in upward direction adding the current
690 position to the selection.
691 * \li Syntax: up-select
694 { LFUN_UP_SELECT, "up-select", ReadOnly | SingleParUpdate, Edit },
696 * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN
697 * \li Action: Moves the cursor one page in downward direction.
698 * \li Syntax: screen-down
701 { LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit },
703 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP
704 * \li Action: Moves the cursor one page in upward direction.
705 * \li Syntax: screen-up
708 { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit },
710 * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN_SELECT
711 * \li Action: Moves the cursor one screen in downward direction adding the current
712 position to the selection.
713 * \li Syntax: screen-down-select
716 { LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit },
718 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP_SELECT
719 * \li Action: Moves the cursor one page in upward direction adding the current
720 position to the selection.
721 * \li Syntax: screen-up-select
724 { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit },
726 * \var lyx::FuncCode lyx::LFUN_SCROLL
727 * \li Action: Scroll the buffer view.
728 * \li Notion: Only scrolls the screen up or down; does not move the cursor.
729 * \li Syntax: scroll <TYPE> <QUANTITY>
730 * \li Params: <TYPE>: line|page\n
731 <QUANTITY>: up|down|<number>
732 * \li Origin: Abdel, Dec 27 2007
735 { LFUN_SCROLL, "scroll", ReadOnly, Edit },
737 * \var lyx::FuncCode lyx::LFUN_SCREEN_RECENTER
738 * \li Action: Recenters the screen on the current cursor position.
739 * \li Syntax: screen-recenter
742 { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit },
745 * \var lyx::FuncCode lyx::LFUN_SCREEN_SHOW_CURSOR
746 * \li Action: Repositions the screen such that the cursor is visible.
747 * \li Syntax: screen-show-cursor
748 * \li Origin: vfr, 25 Mar 2009
751 { LFUN_SCREEN_SHOW_CURSOR, "screen-show-cursor", ReadOnly, Edit },
754 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD
755 * \li Action: Moves the cursor one position logically backwards.
756 * \li Notion: This is not the action which should be bound to the arrow keys,
757 because backwards may be left or right, depending on the
758 language. The arrow keys should be bound to #LFUN_CHAR_LEFT or
759 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
760 * \li Syntax: char-backward
763 { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit },
765 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD_SELECT
766 * \li Action: Moves the cursor one position logically backwards, adding
767 traversed position to the selection.
768 * \li Notion: See also #LFUN_CHAR_BACKWARD.
769 * \li Syntax: char-backward-select
772 { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit },
774 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_BACKWARD
775 * \li Action: Deletes one character in the backward direction (usually the "BackSpace" key).
776 * \li Syntax: char-delete-backward
779 { LFUN_CHAR_DELETE_BACKWARD, "char-delete-backward", SingleParUpdate, Edit },
781 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_FORWARD
782 * \li Action: Deletes one character in the backward direction (usually the "Delete" key).
783 * \li Syntax: char-delete-forward
786 { LFUN_CHAR_DELETE_FORWARD, "char-delete-forward", SingleParUpdate, Edit },
788 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD
789 * \li Action: Moves the cursor one position logically forward.
790 * \li Notion: This is not the action which should be bound to the arrow keys,
791 because forward may be left or right, depending on the language.
792 The arrow keys should be bound to #LFUN_CHAR_LEFT or
793 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
794 * \li Syntax: char-forward
797 { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit },
799 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD_SELECT
800 * \li Action: Moves the cursor one position logically forward, adding
801 traversed position to the selection.
802 * \li Notion: See also #LFUN_CHAR_FORWARD.
803 * \li Syntax: char-forward-select
806 { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit },
808 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT
809 * \li Action: Moves the cursor one position "to the left".
810 * \li Notion: This is the action which should be taken when the "left" key
811 is pressed. Generally, it moves the cursor one position to the
812 left. However, in Bidi text this become slightly more
813 complicated, and there are different modes of cursor movement.
814 In "visual mode", this moves left, plain and simple. In "logical
815 mode", movement is logically forward in RTL paragraphs, and
816 logically backwards in LTR paragraphs.
817 * \li Syntax: char-left
820 { LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit },
822 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT_SELECT
823 * \li Action: Moves the cursor one position "to the left", adding
824 traversed position to the selection.
825 * \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement.
826 * \li Syntax: char-left-select
829 { LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit },
831 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT
832 * \li Action: Moves the cursor one position "to the right".
833 * \li Notion: This is the action which should be taken when the "right" key
834 is pressed. Generally, it moves the cursor one position to the
835 right. However, in Bidi text this become slightly more
836 complicated, and there are different modes of cursor movement.
837 In "visual mode", this moves right, plain and simple. In "logical
838 mode", movement is logically forward in LTR paragraphs, and
839 logically backwards in RTL paragraphs.
840 * \li Syntax: char-right
843 { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit },
845 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT_SELECT
846 * \li Action: Moves the cursor one position "to the right", adding
847 traversed position to the selection.
848 * \li Notion: See also #LFUN_CHAR_RIGHT for exact details of the movement.
849 * \li Syntax: char-right-select
852 { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit },
855 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD
856 * \li Action: Moves the cursor to the logically previous beginning of a word.
857 * \li Notion: This is not the action which should be bound to the arrow keys,
858 because backwards may be left or right, depending on the
859 language. The arrow keys should be bound to #LFUN_WORD_LEFT or
860 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
861 * \li Syntax: word-backward
864 { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit },
866 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD_SELECT
867 * \li Action: Moves the cursor to the logically previous beginning of a word,
868 adding the logically traversed text to the selection.
869 * \li Notion: See also #LFUN_WORD_BACKWARD.
870 * \li Syntax: word-backward-select
873 { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
875 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_BACKWARD
876 * \li Action: Deletes characters to the beginning of the word (usually the "C+BackSpace" key).
877 * \li Syntax: word-delete-backward
880 { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
882 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_FORWARD
883 * \li Action: Deletes characters to the end of the word (usually the "C+Delete" key).
884 * \li Syntax: word-delete-forward
887 { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
889 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_FORWARD
890 * \li Action: Search for a given string in forward direction.
891 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
892 * \li Syntax: word-find-forward [<STRING>]
893 * \li Origin: Etienne, 16 Feb 1998
896 { LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit },
898 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_BACKWARD
899 * \li Action: Search for a given string in backward direction.
900 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
901 * \li Syntax: word-find-backward [<STRING>]
902 * \li Origin: Etienne, 20 Feb 1998
905 { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
907 * \var lyx::FuncCode lyx::LFUN_WORD_FIND
908 * \li Action: Search for next occurrence of a string.
909 * \li Syntax: word-find [<DATA>]
910 * \li Params: <DATA>: data encoded from Find dialog (see #lyx::find2string()).
911 If no parameter is given, search with last find-dialog
912 data is used for search (i.e. find-next).
913 * \li Origin: Andre, Jan 7 2004
916 { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
918 * \var lyx::FuncCode lyx::LFUN_WORD_REPLACE
919 * \li Action: Replace a string in the document.
920 * \li Syntax: word-replace [<DATA>]
921 * \li Params: <DATA>: data is of the form
924 <casesensitive> <matchword> <all> <forward> <findnext>"
925 * \li Origin: Andre, Jan 7 2004
928 { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
930 * \var lyx::FuncCode lyx::LFUN_WORD_FINDADV
931 * \li Action: Search for next occurrence of a pattern.
932 * \li Syntax: word-findadv [<DATA>]
933 * \li Params: <DATA>: data encoded from FindAdv dialog (see #lyx::findadv2string()).
934 If no parameter is given, search with last find-dialog
935 data is used for search (i.e. find-next).
936 * \li Origin: Tommaso, Nov 15 2007
939 { LFUN_WORD_FINDADV, "word-findadv", ReadOnly | NoBuffer, Edit },
941 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD
942 * \li Action: Moves the cursor to the logically next beginning of a word.
943 * \li Notion: This is not the action which should be bound to the arrow keys,
944 because forward may be left or right, depending on the language.
945 The arrow keys should be bound to #LFUN_WORD_LEFT or
946 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
947 * \li Syntax: word-forward
950 { LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
952 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD_SELECT
953 * \li Action: Moves the cursor to the logically next beginning of a word,
954 adding the logically traversed text to the selection.
955 * \li Notion: See also #LFUN_WORD_FORWARD.
956 * \li Syntax: word-forward-select
959 { LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
961 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT
962 * \li Action: Moves the cursor to the next beginning of a word "on the left".
963 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
964 "left" key is pressed. Generally, it moves the cursor to the
965 next beginning of a word on the left. However, in Bidi text this
966 become slightly more complicated, and there are different modes
967 of cursor movement. In "visual mode", this moves left, plain and
968 simple. In "logical mode", movement is logically forward in RTL
969 paragraphs, and logically backwards in LTR paragraphs.
970 * \li Syntax: word-left
971 * \li Origin: dov, 28 Oct 2007
974 { LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
976 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT_SELECT
977 * \li Action: Moves the cursor to the next beginning of a word "on the left",
978 adding *logically* traversed text to the selection.
979 * \li Notion: See also #LFUN_WORD_LEFT for exact details of the movement.
980 * \li Syntax: word-left-select
981 * \li Origin: dov, 28 Oct 2007
984 { LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit },
986 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT
987 * \li Action: Moves the cursor to the next beginning of a word "on the right".
988 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
989 "right" key is pressed. Generally, it moves the cursor to the
990 next beginning of a word on the right. However, in Bidi text
991 this become slightly more complicated, and there are different
992 modes of cursor movement. In "visual mode", this moves right,
993 plain and simple. In "logical mode", movement is logically
994 forward in LTR paragraphs, and logically backwards in RTL
996 * \li Syntax: word-right
997 * \li Origin: dov, 28 Oct 2007
1000 { LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit },
1002 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT_SELECT
1003 * \li Action: Moves the cursor to the next beginning of a word "on the right",
1004 adding *logically* traversed text to the selection.
1005 * \li Notion: See also #LFUN_WORD_RIGHT for exact details of the movement.
1006 * \li Syntax: word-right-select
1007 * \li Origin: dov, 28 Oct 2007
1010 { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
1012 * \var lyx::FuncCode lyx::LFUN_WORD_SELECT
1013 * \li Action: Puts the word where the cursor stands into the selection.
1014 * \li Syntax: word-select
1015 * \li Origin: Andre, 11 Sep 2002
1018 { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
1020 * \var lyx::FuncCode lyx::LFUN_WORD_CAPITALIZE
1021 * \li Action: Capitalizes the words in the selection (i.e. the first letters)
1022 or the first letter of word at cursor position.
1023 * \li Syntax: word-capitalize [<SEL_TYPE>]
1024 * \li Params: <SEL_TYPE>: if this is equal to "partial", then the
1025 * default word starts at cursor position (emacs-style).
1026 * Otherwise, the whole word is considered.
1029 { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
1031 * \var lyx::FuncCode lyx::LFUN_WORD_UPCASE
1032 * \li Action: Change the words in the selection or word at cursor position
1034 * \li Syntax: word-upcase [<SEL_TYPE>]
1035 * \li Params: <SEL_TYPE>: if this is equal to "partial", then the
1036 * default word starts at cursor position (emacs-style).
1037 * Otherwise, the whole word is considered.
1040 { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
1042 * \var lyx::FuncCode lyx::LFUN_WORD_LOWCASE
1043 * \li Action: Change the words in the selection or word at cursor position
1045 * \li Syntax: word-lowcase [<SEL_TYPE>]
1046 * \li Params: <SEL_TYPE>: if this is equal to "partial", then the
1047 * default word starts at cursor position (emacs-style).
1048 * Otherwise, the whole word is considered.
1051 { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
1053 * \var lyx::FuncCode lyx::LFUN_SPELLING_ADD
1054 * \li Action: Add the word under the cursor to the respective
1055 * spell checker dictionary.
1056 * The default for the language is retrieved from the cursor position.
1057 * \li Syntax: spelling-add [<STRING>] [<LANG>]
1058 * \li Params: <WORD>: word to add
1059 <LANG>: language name (see file languages)
1060 * \li Origin: JSpitzm, 18 Jan 2010
1063 { LFUN_SPELLING_ADD, "spelling-add", ReadOnly, Edit },
1065 * \var lyx::FuncCode lyx::LFUN_SPELLING_IGNORE
1066 * \li Action: Let the spell checker ignore the word under the cursor
1067 * in the current session for the given language.
1068 * The default for the language is retrieved from the cursor position.
1069 * \li Syntax: spelling-ignore [<WORD>] [<LANG>]
1070 * \li Params: <WORD>: word to ignore
1071 <LANG>: language name (see file languages)
1072 * \li Origin: JSpitzm, 18 Jan 2010
1075 { LFUN_SPELLING_IGNORE, "spelling-ignore", ReadOnly, Edit },
1077 * \var lyx::FuncCode lyx::LFUN_SPELLING_REMOVE
1078 * \li Action: Remove the word under the cursor from the respective
1079 * spell checker dictionary.
1080 * The default for the language is retrieved from the cursor position.
1081 * \li Syntax: spelling-remove [<STRING>] [<LANG>]
1082 * \li Params: <WORD>: word to remove
1083 * <LANG>: language name (see file languages)
1084 * \li Origin: SWitt, 28 July 2010
1087 { LFUN_SPELLING_REMOVE, "spelling-remove", ReadOnly, Edit },
1090 * \var lyx::FuncCode lyx::LFUN_SPELLING_CONTINUOUSLY
1091 * \li Action: Toggle continuous spell checking.
1092 * \li Syntax: spelling-continuously
1093 * \li Origin: vfr, 24 March 2013
1096 { LFUN_SPELLING_CONTINUOUSLY, "spelling-continuously", ReadOnly, Edit },
1099 * \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
1100 * \li Action: Look up thesaurus entries with respect to the word under the cursor.
1101 * \li Syntax: thesaurus-entry [<STRING>] [lang=<LANG>]
1102 * \li Params: <STRING>: word to look up
1103 <LANG>: language (see file languages)
1104 * \li Origin: Levon, 20 Jul 2001
1107 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
1109 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN
1110 * \li Action: Move the cursor to the beginning of the document.
1111 * \li Syntax: buffer-begin
1114 { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
1116 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN_SELECT
1117 * \li Action: Move the cursor to the beginning of the document adding the
1118 traversed text to the selection.
1119 * \li Syntax: buffer-begin-select
1122 { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
1124 * \var lyx::FuncCode lyx::LFUN_BUFFER_END
1125 * \li Action: Move the cursor to the end of the document.
1126 * \li Syntax: buffer-end
1129 { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
1131 * \var lyx::FuncCode lyx::LFUN_BUFFER_END_SELECT
1132 * \li Action: Move the cursor to the end of the document adding the
1133 traversed text to the selection.
1134 * \li Syntax: buffer-end-select
1137 { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
1140 * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN
1141 * \li Action: Move the cursor to the beginning of the current inset
1142 if it is not already there, or at the beginning of the
1143 enclosing inset otherwise
1144 * \li Syntax: inset-begin
1145 * \li Origin: lasgouttes, 16 Mar 2009
1148 { LFUN_INSET_BEGIN, "inset-begin", ReadOnly, Edit },
1150 * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN_SELECT
1151 * \li Action: Move the cursor to the beginning of the current inset
1152 if it is not already there, or at the beginning of the
1153 enclosing inset otherwise (adding the
1154 traversed text to the selection).
1155 * \li Syntax: inset-begin-select
1156 * \li Origin: lasgouttes, 16 Mar 2009
1159 { LFUN_INSET_BEGIN_SELECT, "inset-begin-select", ReadOnly, Edit },
1161 * \var lyx::FuncCode lyx::LFUN_INSET_END
1162 * \li Action: Move the cursor to the end of the current inset
1163 if it is not already there, or at the end of the
1164 enclosing inset otherwise
1165 * \li Syntax: inset-end
1166 * \li Origin: lasgouttes, 16 Mar 2009
1169 { LFUN_INSET_END, "inset-end", ReadOnly, Edit },
1171 * \var lyx::FuncCode lyx::LFUN_INSET_END_SELECT
1172 * \li Action: Move the cursor to the end of the current inset
1173 if it is not already there, or at the end of the
1174 enclosing inset otherwise (adding the
1175 traversed text to the selection).
1176 * \li Syntax: inset-end-select
1177 * \li Origin: lasgouttes, 16 Mar 2009
1180 { LFUN_INSET_END_SELECT, "inset-end-select", ReadOnly, Edit },
1183 * \var lyx::FuncCode lyx::LFUN_INSET_SELECT_ALL
1184 * \li Action: Select all contents of an inset.
1185 * \li Notion: There are 3 successive levels: select current cell,
1186 * select all cells of inset, select the inset from outside
1187 * (in the enclosing inset).
1188 * \li Syntax: inset-select-all
1189 * \li Origin: vfr, 22 Aug 2009; lasgouttes 1 Nov 2014
1192 { LFUN_INSET_SELECT_ALL, "inset-select-all", ReadOnly, Edit },
1195 * \var lyx::FuncCode lyx::LFUN_SECTION_SELECT
1196 * \li Action: Select the whole section.
1197 * \li Notion: The cursor should be in a section heading
1198 before calling this lfun.
1199 * \li Syntax: section-select
1200 * \li Origin: vfr, 05 May 2009
1203 { LFUN_SECTION_SELECT, "section-select", ReadOnly, Edit },
1206 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN
1207 * \li Action: Move the cursor to the beginning of the (screen) line.
1208 * \li Syntax: line-begin
1211 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
1213 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN_SELECT
1214 * \li Action: Move the cursor to the beginning of the (screen) line adding the
1215 traversed text to the selection.
1216 * \li Syntax: line-begin-select
1219 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
1221 * \var lyx::FuncCode lyx::LFUN_LINE_END
1222 * \li Action: Move the cursor to the end of the (screen) line.
1223 * \li Syntax: line-end
1226 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
1228 * \var lyx::FuncCode lyx::LFUN_LINE_END_SELECT
1229 * \li Action: Move the cursor to the end of the (screen) line adding the
1230 traversed text to the selection.
1231 * \li Syntax: line-end-select
1234 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
1236 * \var lyx::FuncCode lyx::LFUN_LINE_DELETE_FORWARD
1237 * \li Action: Deletes the letters to the end of the (screen) line or
1238 deletes the selection.
1239 * \li Syntax: line-delete-forward
1242 { LFUN_LINE_DELETE_FORWARD, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
1244 * \var lyx::FuncCode lyx::LFUN_COPY
1245 * \li Action: Copies the current selection to the clipboard.
1249 { LFUN_COPY, "copy", ReadOnly, Edit },
1251 * \var lyx::FuncCode lyx::LFUN_CUT
1252 * \li Action: Cuts to the clipboard.
1256 { LFUN_CUT, "cut", Noop, Edit },
1258 * \var lyx::FuncCode lyx::LFUN_PASTE
1259 * \li Action: Pastes material (text or picture) from the active clipboard.
1260 * \li Syntax: paste [<TYPE>|<NUM>]
1261 * \li Params: <TYPE>: emf|pdf|png|jpeg|linkback|wmf|latex|html \n
1262 <NUM>: number of the selection in the internal clipboard stack to be pasted.
1265 { LFUN_PASTE, "paste", Noop, Edit },
1267 * \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE
1268 * \li Action: Pastes text from the active clipboard (retains formatting if the
1269 clipboard contains formatted text). Pastes plain text if plain text is
1270 on the clipboard, but tries to interpret it in special ways for certain
1271 insets, e.g. converting csv data to rows and columns if the paste happens
1273 * \li Notion: Historically, LFUN_CLIPBOARD_PASTE was introduced as a counterpart of
1274 LFUN_PRIMARY_SELECTION_PASTE: It behaved exactly the same, but the source
1275 is the clipboard, not the selection.
1276 * \li Syntax: clipboard-paste [<ARG>]
1277 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1278 * \li Origin: Georg, 10 Jul 2006
1281 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
1283 * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
1284 * \li Action: Pastes the currently selected text.
1285 * \li Notion: Primary selection mechanism is linux-only thing.
1286 * \li Syntax: primary-selection-paste [<ARG>]
1287 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1290 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
1292 * \var lyx::FuncCode lyx::LFUN_SELECTION_PASTE
1293 * \li Action: Pastes the internal selection text in permanent selection.
1294 * \li Notion: Created in order to have middle mouse button pasting correct (bound to
1295 command-alternatives selection-paste ; primary-selection-paste paragraph).
1296 * \li Syntax: selection-paste
1297 * \li Origin: lasgouttes, 14 Jan 2009
1300 { LFUN_SELECTION_PASTE, "selection-paste", Noop, Edit },
1302 * \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE_SIMPLE
1303 * \li Action: Pastes plain text from the active clipboard even if formatted
1304 LyX content is in the clipboard. Pastes plain text if plain text
1305 is on the clipboard, without trying to interpret it in special
1306 ways for certain insets, e.g. converting csv data to rows and
1307 columns if the paste happens in a tabular inset.
1308 * \li Syntax: clipboard-paste-simple [<ARG>]
1309 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1312 { LFUN_CLIPBOARD_PASTE_SIMPLE, "clipboard-paste-simple", Noop, Edit },
1314 * \var lyx::FuncCode lyx::LFUN_UNDO
1315 * \li Action: Undoes the last edit.
1319 { LFUN_UNDO, "undo", ReadOnly, Edit },
1321 * \var lyx::FuncCode lyx::LFUN_REDO
1322 * \li Action: Redoes the last thing undone.
1326 { LFUN_REDO, "redo", ReadOnly, Edit },
1328 * \var lyx::FuncCode lyx::LFUN_REPEAT
1329 * \li Action: Repeat the given command.
1330 * \li Syntax: repeat <COUNT> <LFUN-COMMAND>
1331 * \li Origin: Andre, 27 Oct 2003
1334 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
1336 * \var lyx::FuncCode lyx::LFUN_CHARS_TRANSPOSE
1337 * \li Action: Transposes the character at the cursor with the one before it.
1338 * \li Syntax: chars-transpose
1339 * \li Origin: Lgb, 25 Apr 2001
1342 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
1345 * \var lyx::FuncCode lyx::LFUN_DEPTH_DECREMENT
1346 * \li Action: Decrease the nesting depth of the (selected) paragraph(s)
1348 * \li Syntax: depth-decrement
1351 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
1353 * \var lyx::FuncCode lyx::LFUN_DEPTH_INCREMENT
1354 * \li Action: Increase the nesting depth of the (selected) paragraph(s)
1356 * \li Syntax: depth-increment
1359 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
1362 * \var lyx::FuncCode lyx::LFUN_FONT_BOLD
1363 * \li Action: Toggles the bold font (selection-wise) using mathbf in math.
1364 * \li Syntax: font-bold
1367 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
1370 * \var lyx::FuncCode lyx::LFUN_FONT_BOLDSYMBOL
1371 * \li Action: Toggles the bold font (selection-wise) using boldsymbol in math.
1372 * \li Syntax: font-boldsymbol
1375 { LFUN_FONT_BOLDSYMBOL, "font-boldsymbol", Noop, Layout },
1377 * \var lyx::FuncCode lyx::LFUN_FONT_TYPEWRITER
1378 * \li Action: Toggles the typewriter family font (selection-wise).
1379 * \li Syntax: font-typewriter
1382 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
1384 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERLINE
1385 * \li Action: Toggles underline in the font (selection-wise).
1386 * \li Syntax: font-underline
1389 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
1391 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERUNDERLINE
1392 * \li Action: Toggles double underline in the font (selection-wise).
1393 * \li Syntax: font-underunderline
1394 * \li Origin: sanda, 5 May 2009
1397 { LFUN_FONT_UNDERUNDERLINE, "font-underunderline", Noop, Layout },
1399 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERWAVE
1400 * \li Action: Toggles wavy underline in the font (selection-wise).
1401 * \li Syntax: font-underwave
1402 * \li Origin: sanda, 5 May 2009
1405 { LFUN_FONT_UNDERWAVE, "font-underwave", Noop, Layout },
1407 * \var lyx::FuncCode lyx::LFUN_FONT_STRIKEOUT
1408 * \li Action: Toggles strikeout (strike-through) in the font (selection-wise).
1409 * \li Syntax: font-strikeout
1410 * \li Origin: sanda, 3 May 2009
1413 { LFUN_FONT_STRIKEOUT, "font-strikeout", Noop, Layout },
1415 * \var lyx::FuncCode lyx::LFUN_FONT_EMPH
1416 * \li Action: Toggles the emphasis font style (selection-wise).
1417 * \li Syntax: font-emph
1420 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
1422 * \var lyx::FuncCode lyx::LFUN_FONT_NOUN
1423 * \li Action: Toggles Noun text style font (selection-wise).
1424 * \li Syntax: font-noun
1427 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
1429 * \var lyx::FuncCode lyx::LFUN_FONT_ROMAN
1430 * \li Action: Toggles Roman family font (selection-wise).
1431 * \li Syntax: font-roman
1434 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
1436 * \var lyx::FuncCode lyx::LFUN_FONT_SANS
1437 * \li Action: Toggles Sans Serif family font (selection-wise).
1438 * \li Syntax: font-sans
1441 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
1443 * \var lyx::FuncCode lyx::LFUN_FONT_FRAK
1444 * \li Action: Toggles Fraktur family font (math-mode, selection-wise).
1445 * \li Syntax: font-frak
1446 * \li Origin: vermeer, 10 Jan 2002
1449 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
1451 * \var lyx::FuncCode lyx::LFUN_FONT_ITAL
1452 * \li Action: Toggles Italics font shape (math-mode, selection-wise).
1453 * \li Syntax: font-ital
1454 * \li Origin: vermeer, 10 Jan 2002
1457 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
1459 * \var lyx::FuncCode lyx::LFUN_FONT_DEFAULT
1460 * \li Action: Reverts the settings of the font to the default values (selection-wise).
1461 * \li Syntax: font-default
1464 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
1466 * \var lyx::FuncCode lyx::LFUN_FONT_SIZE
1467 * \li Action: Sets font size according to lyx format string.
1468 * \li Syntax: font-size <SIZE>
1469 * \li Params: <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|\n
1470 largest|huge|giant|increase|decrease|default
1473 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
1475 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_APPLY
1476 * \li Action: Toggle user-defined (=last-time used) text style.
1477 * \li Notion: This style is set via #LFUN_TEXTSTYLE_UPDATE, which is
1478 automatically triggered when using Text Style dialog.
1479 * \li Syntax: textstyle-apply
1480 * \li Origin: leeming, 12 Mar 2003
1483 { LFUN_TEXTSTYLE_APPLY, "textstyle-apply", Noop, Layout },
1485 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_UPDATE
1486 * \li Action: Apply text style and update the settings to be used by #LFUN_TEXTSTYLE_APPLY.
1487 * \li Syntax: textstyle-update <FONT_INFO>
1488 * \li Params: <FONT_INFO>: specifies font atributes, e.g. family, series, shape,
1489 size, emph, noun, underbar, number, color, language,
1491 Use lyx -dbg action for exact syntax of text-style
1493 * \li Origin: leeming, 12 Mar 2003
1496 { LFUN_TEXTSTYLE_UPDATE, "textstyle-update", Noop, Layout },
1498 * \var lyx::FuncCode lyx::LFUN_SCREEN_FONT_UPDATE
1499 * \li Action: Update fonts and its metrics.
1500 * \li Notion: Automatically called after zoom, dpi, font names, or norm change.
1501 * \li Syntax: screen-font-update
1502 * \li Origin: ARRae, 13 Aug 2000
1505 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
1507 * \var lyx::FuncCode lyx::LFUN_FONT_STATE
1508 * \li Action: Returns the info about the current font.
1509 * \li Syntax: font-state
1512 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
1515 * \var lyx::FuncCode lyx::LFUN_CITATION_INSERT
1516 * \li Action: Inserts citation from loaded citation database.
1517 * \li Syntax: citation-insert [<KEY>[|<TEXT_BEFORE>]]
1518 * \li Params: <KEY>: Citation (shortcut listed in available citations). \n
1519 <TEXT_BEFORE>: text which should appear before citation.
1520 * \li Origin: AAS, 97-02-23
1523 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
1525 * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_ADD
1526 * \li Action: Adds database, which will be used for bibtex citations.
1527 * \li Notion: Databases are added to the first BibTeX inset
1528 (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
1529 * \li Syntax: bibtex-database-add <DATABASE-NAME>
1530 * \li Origin: Ale, 30 May 1997
1533 { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit },
1535 * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_DEL
1536 * \li Action: Adds database, which will be used for bibtex citations.
1537 * \li Notion: Databases are deleted from the first BibTeX inset
1538 (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
1539 * \li Syntax: bibtex-database-del <DATABASE-NAME>
1540 * \li Origin: Ale, 30 May 1997
1543 { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
1546 * \var lyx::FuncCode lyx::LFUN_LAYOUT
1547 * \li Action: Sets the layout (that is, environment) for the current paragraph.
1548 * \li Syntax: layout <LAYOUT>
1549 * \li Params: <LAYOUT>: the layout to use
1552 { LFUN_LAYOUT, "layout", Noop, Layout },
1554 * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH
1555 * \li Action: Launches the paragraph settings dialog.
1556 * \li Syntax: layout-paragraph
1559 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
1561 * \var lyx::FuncCode lyx::LFUN_LAYOUT_TABULAR
1562 * \li Action: Launches the tabular settings dialog.
1563 * \li Syntax: layout-tabular
1564 * \li Origin: Jug, 31 Jul 2000
1567 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
1569 * \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE
1570 * \li Action: Displays list of layout choices.
1571 * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
1572 dropbox allowing for choice of layout.
1573 * \li Syntax: drop-layouts-choice
1576 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
1578 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
1579 * \li Action: Clears the module list.
1580 * \li Notion: Clears the list of included modules for the current buffer.
1581 * \li Syntax: layout-modules-clear
1582 * \li Origin: rgh, 25 August 2007
1585 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", NoInternal, Layout },
1587 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULE_ADD
1588 * \li Action: Adds a module.
1589 * \li Notion: Adds a module to the list of included modules for the current buffer.
1590 * \li Syntax: layout-module-add <MODULE>
1591 * \li Params: <MODULE>: the module to be added
1592 * \li Origin: rgh, 25 August 2007
1595 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", NoInternal, Layout },
1597 * \var lyx::FuncCode lyx::LFUN_LAYOUT_RELOAD
1598 * \li Action: Reloads layout information.
1599 * \li Notion: Reloads all layout information for the current buffer from disk, thus
1600 recognizing any changes that have been made to layout files on the fly.
1601 This is intended to be used only by layout developers and should not be
1602 used when one is trying to do actual work.
1603 * \li Syntax: layout-reload
1604 * \li Origin: rgh, 3 September 2007
1607 { LFUN_LAYOUT_RELOAD, "layout-reload", NoInternal, Layout },
1609 * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW_CACHE
1610 * \li Action: Opens the file that was created from last preview of this buffer.
1611 * \li Notion: This LFUN is called by the "Show Output Anyway" button in the LaTeX
1612 * Errors dialog. It can also be called by the user, which is useful
1613 * if the document takes a long time to compile, and you just
1614 * want to see the last previewed version.
1615 * \li Syntax: buffer-view-cache
1618 { LFUN_BUFFER_VIEW_CACHE, "buffer-view-cache", ReadOnly, Buffer },
1620 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
1621 * \li Action: Sets the text class for the current buffer.
1622 * \li Syntax: textclass-apply <TEXTCLASS>
1623 * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
1624 the filename, minus the ".layout" extension.
1627 { LFUN_TEXTCLASS_APPLY, "textclass-apply", NoInternal, Layout },
1629 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
1630 * \li Action: Loads information for a textclass from disk.
1631 * \li Syntax: textclass-load <TEXTCLASS>
1632 * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
1633 the filename, minus the ".layout" extension.
1636 { LFUN_TEXTCLASS_LOAD, "textclass-load", NoInternal, Layout },
1639 * \var lyx::FuncCode lyx::LFUN_MARK_OFF
1640 * \li Action: Disable selecting of text-region.
1641 * \li Syntax: mark-off
1644 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
1646 * \var lyx::FuncCode lyx::LFUN_MARK_ON
1647 * \li Action: Enable selecting of text-region.
1648 * \li Notion: After enabling you can simply move arrow keys to get selected region.
1649 * \li Syntax: mark-on
1652 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
1654 * \var lyx::FuncCode lyx::LFUN_MARK_TOGGLE
1655 * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
1656 * \li Syntax: mark-toggle
1657 * \li Origin: Andre, May 5 2006
1660 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
1663 * \var lyx::FuncCode lyx::LFUN_MATH_DELIM
1664 * \li Action: Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
1665 * \li Syntax: math-delim [<LEFT>] [<RIGHT>]
1666 * \li Params: <LEFT/RIGHT>: Delimiters to be used. Each delimiter can be specified by
1667 either a LaTeX name or a valid character.
1668 ( is the default letter.
1669 * \li Sample: math-delim { rangle
1670 * \li Origin: Alejandro, 18 Jun 1996
1673 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
1675 * \var lyx::FuncCode lyx::LFUN_MATH_BIGDELIM
1676 * \li Action: Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
1677 * \li Syntax: math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
1678 * \li Params: <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r \n
1679 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
1680 * \li Sample: math-bigdelim "Bigl" "\Downarrow" "Bigr" "\}"
1681 * \li Origin: Enrico & Georg, 7 May 2006
1684 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
1686 * \var lyx::FuncCode lyx::LFUN_MATH_DISPLAY
1687 * \li Action: Creates a new displayed equation in text mode.
1688 Toggles inlined/display formula in math mode.
1689 * \li Syntax: math-display [<ARG>]
1690 * \li Params: <ARG>: this argument will be passed to #LFUN_MATH_INSERT when creating
1691 new equation from the text mode.
1692 * \li Origin: Alejandro, 18 Jun 1996
1695 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
1697 * \var lyx::FuncCode lyx::LFUN_MATH_INSERT
1698 * \li Action: Inserts math objects and symbols.
1699 * \li Syntax: math-insert <ARG>
1700 * \li Params: <ARG>: Symbol or LaTeX code to be inserted.
1701 * \li Notion: When <ARG> is a _single_ math inset with more than one cell
1702 (such as "x_y^z" or "\frac{x}{y}"), the content of cell(0) is
1703 replaced by the current selection (only works if the selection
1704 is in mathed). As an example, if "abc" is selected in mathed,
1705 "math-insert \frac{x}{y}" replaces "abc" with "\frac{abc}{y}",
1706 and "math-insert x_y^z" replaces "abc" with "abc_y^z".
1707 If nothing is selected (or the selection is not in mathed),
1708 math-insert works as expected.
1711 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
1713 * \var lyx::FuncCode lyx::LFUN_MATH_SUBSCRIPT
1714 * \li Action: Enters subscript expression in math expression.
1715 * \li Syntax: math-subscript
1716 * \li Origin: vermeer, 12 Dec 2001
1719 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
1721 * \var lyx::FuncCode lyx::LFUN_MATH_SUPERSCRIPT
1722 * \li Action: Enters superscript expression in math expression.
1723 * \li Syntax: math-superscript
1724 * \li Origin: vermeer, 12 Dec 2001
1727 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
1729 * \var lyx::FuncCode lyx::LFUN_MATH_LIMITS
1730 * \li Action: Toggles the position of the limits from above/below to the right
1731 side an vice versa in integral symbol, a limit, a summation, etc.
1732 * \li Notion: Put the cursor before the symbol with the limits and then invoke
1734 * \li Syntax: math-limits [<STATE>]
1735 * \li Params: <STATE>: limits|nolimits
1738 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
1740 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO
1741 * \li Action: Inserts a math macro definition at the cursor position in the text.
1742 * \li Syntax: math-macro <NAME> [<NARGS>] [def]
1743 * \li Params: <NAME>: The name of the macro, e.g. "mymacro".\n
1744 <NARGS>: The number of parameters of the macro. Default is 0.
1745 "def": Has no effect anymore, just for compatibility with former LyX versions.
1746 * \li Origin: ale, 10 May 1997; sts, 21 Dec 2007
1749 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
1751 * \var lyx::FuncCode lyx::LFUN_MATH_MUTATE
1752 * \li Action: Mutates the type of math inset to the newly selected one.
1753 * \li Syntax: math-mutate <TYPE>
1754 * \li Params: <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
1755 multline|gather|flalign
1756 * \li Origin: Andre, 23 May 2001
1759 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
1761 * \var lyx::FuncCode lyx::LFUN_MATH_SPACE
1762 * \li Action: Inserts space into math expression.
1763 * \li Notion: Use spacebar after entering this space to change type of space.
1764 * \li Syntax: math-space [<TYPE>] [<LEN>]
1765 * \li Params: <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace \n
1766 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad \n
1767 custom space: hspace \n
1768 "," used by default.\n
1769 Note that ! is equivalent to negthinspace, , = thinspace,
1770 : = medspace, and ; = thickspace.\n
1771 <LEN>: length for custom spaces (hspace)
1772 * \li Origin: Andre, 25 Jul 2001; sanda, 16 Jun 2008
1775 { LFUN_MATH_SPACE, "math-space", Noop, Math },
1777 * \var lyx::FuncCode lyx::LFUN_MATH_MATRIX
1778 * \li Action: Inserts a matrix.
1779 * \li Syntax: math-matrix <COLS> <ROWS> [<ALIGN>]
1780 * \li Params: <ALIGN>: Alignment is a word composed of the vertical alignment
1781 (b, c or t) (i.e. 1 char) and the horizontal alignments
1782 (l, c or r) (i.e. <COL> chars).
1783 * \li Sample: math-matrix 3 3 bccc
1786 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
1788 * \var lyx::FuncCode lyx::LFUN_MATH_AMS_MATRIX
1789 * \li Action: Inserts an extended matrix as provided by the amsmath package.
1790 * \li Syntax: math-matrix <COLS> <ROWS> [<DECORATION>]
1791 * \li Params: <DECORATION>: Decoration determines the LaTeX name of the matrix
1792 that should be created. Possible values include
1793 pmatrix, bmatrix, Bmatrix, vmatrix, Vmatrix and
1794 matrix. The default is 'matrix'.
1795 * \li Sample: math-ams-matrix 3 3 bmatrix
1798 { LFUN_MATH_AMS_MATRIX, "math-ams-matrix", Noop, Math },
1800 * \var lyx::FuncCode lyx::LFUN_MATH_MODE
1801 * \li Action: In text mode enters math mode (i.e. puts math insets on the current
1802 cursor position), in math mode enters text mode inside math expression.
1803 * \li Notion: If there is some selected text, it puts the text inside created math box.
1804 * \li Syntax: math-mode [on|<ARG>]
1805 * \li Params: <ARG>: eventual argument (LaTeX code) is passed to #LFUN_MATH_INSERT .\n
1806 "on": allow only entering of math mode from text mode.
1807 * \li Origin: Alejandro, 4 Jun 1996
1810 { LFUN_MATH_MODE, "math-mode", Noop, Math },
1812 * \var lyx::FuncCode lyx::LFUN_REGEXP_MODE
1813 * \li Action: Enters regexp mode (i.e., puts regexp insets on the current
1814 cursor position). Used by the advanced search dialog.
1815 * \li Notion: If there is any selected text, then it is moved inside the created
1817 * \li Syntax: regexp-mode [<ARG>]
1818 * \li Params: <ARG>: eventual argument (regular expression).
1819 * \li Origin: Tommaso, 4 Oct 2008
1822 { LFUN_REGEXP_MODE, "regexp-mode", Noop, Math },
1824 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
1825 * \li Action: Toggles numbering of the current formula line.
1826 * \li Notion: Must be in display formula mode.
1827 * \li Syntax: math-number-line-toggle
1828 * \li Origin: Alejandro, 18 Jun 1996
1831 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
1833 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
1834 * \li Action: Toggles numbering/labeling of the current formula.
1835 * \li Notion: Must be in display formula mode.
1836 * \li Syntax: math-number-toggle
1837 * \li Origin: Alejandro, 4 Jun 1996
1840 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
1842 * \var lyx::FuncCode lyx::LFUN_MATH_EXTERN
1843 * \li Action: Calls external program and passes the current expression/equation
1844 as an argument for the calculation in the format appropriate to the
1846 * \li Notion: Selection can be used to determine the input for the external program.
1847 * \li Syntax: math-extern <LANG> [<COMMAND>]
1848 * \li Params: <LANG>: octave|maxima|maple|mathematica|script \n
1849 where "script" stands for the external script (normalized
1850 expression will be passed)
1851 * \li Origin: Andre, 24 Apr 2001
1852 * \li Sample: math-extern maple simplify
1855 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
1857 * \var lyx::FuncCode lyx::LFUN_MATH_SIZE
1858 * \li Action: Changes arbitrarily the size used by math fonts inside a context.
1859 * \li Notion: Provides an interface to the LaTeX math mode font size commands.
1860 * \li Syntax: math-size <STYLE>
1861 * \li Params: <STYLE>: \displaystyle|\textstyle|\scriptstyle|\scriptscriptstyle
1862 * \li Origin: Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
1865 { LFUN_MATH_SIZE, "math-size", Noop, Math },
1867 * \var lyx::FuncCode lyx::LFUN_MATH_FONT_STYLE
1868 * \li Action: Changes the text style used in math.
1869 * \li Syntax: math-font-style <STYLE>
1870 * \li Params: <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf|textnormal\n
1871 |textrm|textsf|texttt|textbf|textmd|textit|textsc|textsl|textup
1872 * \li Origin: vfr, 9 jan 2009
1875 { LFUN_MATH_FONT_STYLE, "math-font-style", Noop, Math },
1877 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
1878 * \li Action: Unfold a Math Macro.
1879 * \li Notion: Unfold the Math Macro the cursor is in, i.e.
1881 * \li Syntax: math-macro-unfold
1882 * \li Origin: sts, 06 January 2008
1885 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
1887 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
1888 * \li Action: Fold a Math Macro.
1889 * \li Notion: Fold the Math Macro the cursor is in if it was
1890 unfolded, i.e. displayed as \foo before.
1891 * \li Syntax: math-macro-fold
1892 * \li Origin: sts, 06 January 2008
1895 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
1897 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
1898 * \li Action: Add a parameter.
1899 * \li Notion: Add a parameter to a Math Macro.
1900 * \li Params: <NUM>: The number of the parameter behind which the new one
1901 will be added (1 for the first, i.e. use 0 for add a
1902 parameter at the left), defaults to the last one.
1903 * \li Syntax: math-macro-add-param <NUM>
1904 * \li Origin: sts, 06 January 2008
1907 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
1909 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
1910 * \li Action: Remove the last parameter.
1911 * \li Notion: Remove the last parameter of a Math Macro and
1912 remove its value in all instances of the macro
1914 * \li Params: <NUM>: The number of the parameter to be deleted (1 for
1915 the first), defaults to the last one.
1916 * \li Syntax: math-macro-remove-param <NUM>
1917 * \li Origin: sts, 06 January 2008
1920 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
1922 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
1923 * \li Action: Append a greedy parameter.
1924 * \li Notion: Append a greedy parameter to a Math Macro which
1925 eats the following mathed cell in every instance of
1926 the macro in the buffer.
1927 * \li Syntax: math-macro-append-greedy-param
1928 * \li Origin: sts, 06 January 2008
1931 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
1933 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
1934 * \li Action: Remove a greedy parameter.
1935 * \li Notion: Remove a greedy parameter of a Math Macro and spit
1936 out the values of it in every instance of the macro
1937 in the buffer. If it is an optional parameter the [valud]
1939 * \li Syntax: math-macro-remove-greedy-param
1940 * \li Origin: sts, 06 January 2008
1943 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
1945 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
1946 * \li Action: Make a parameter optional.
1947 * \li Notion: Turn the first non-optional parameter of a Math Macro
1948 into an optional parameter with a default value.
1949 * \li Syntax: math-macro-make-optional
1950 * \li Origin: sts, 06 January 2008
1953 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
1955 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
1956 * \li Action: Make a parameter non-optional.
1957 * \li Notion: Turn the last optional parameter of a Math Macro
1958 into a non-optional parameter. The default value is
1959 remembered to be reused later if the user changes his mind.
1960 * \li Syntax: math-macro-make-nonoptional
1961 * \li Origin: sts, 06 January 2008
1964 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
1966 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
1967 * \li Action: Add an optional parameter.
1968 * \li Notion: Insert an optional parameter just behind the
1969 already existing optional parameters.
1970 * \li Syntax: math-macro-add-optional-param
1971 * \li Origin: sts, 06 January 2008
1974 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
1976 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
1977 * \li Action: Remove the last optional parameter.
1978 * \li Notion: Remove the last optional parameter of a Math Macro and
1979 remove it in all the instances of the macro in the buffer.
1980 * \li Syntax: math-macro-remove-optional-param
1981 * \li Origin: sts, 06 January 2008
1984 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
1986 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
1987 * \li Action: Add a greedy optional parameter.
1988 * \li Notion: Add a greedy optional parameter which eats the value
1989 from the following cells in mathed which are in the [value]
1991 * \li Syntax: math-macro-add-greedy-optional-param
1992 * \li Origin: sts, 06 January 2008
1995 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
1997 * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
1998 * \li Action: Only active in Math Macro definition.
1999 * \li Notion: Dummy function which is only active in a Math Macro definition.
2000 It's used to toggle the Math Macro toolbar if the cursor moves
2001 into a Math Macro definition.
2002 * \li Syntax: in-mathmacrotemplate
2003 * \li Origin: sts, 06 January 2008
2006 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
2009 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
2010 * \li Action: Moves the current paragraph downwards in the document.
2011 * \li Syntax: paragraph-move-down
2012 * \li Origin: Edwin, 8 Apr 2006
2015 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
2017 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
2018 * \li Action: Moves the current paragraph upwards in the document.
2019 * \li Notion: Movement through the document will possibly break the paragraph-depth
2020 (e.g. itemize structure).
2021 * \li Syntax: paragraph-move-up
2022 * \li Origin: Edwin, 8 Apr 2006
2025 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
2028 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP
2029 * \li Action: Move the cursor to the next paragraph (or beginning of the current one)
2030 in upward direction.
2031 * \li Syntax: paragraph-up
2032 * \li Origin: Asger, 1 Oct 1996
2035 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
2037 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP_SELECT
2038 * \li Action: Move the cursor and select the text to the next paragraph (or
2039 beginning of the current one) in upward direction.
2040 * \li Syntax: paragraph-up-select
2041 * \li Origin: Asger, 1 Oct 1996
2044 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
2046 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN
2047 * \li Action: Move the cursor to the next paragraph (or beginning of the current one)
2048 in downward direction.
2049 * \li Syntax: paragraph-down
2050 * \li Origin: Asger, 1 Oct 1996
2053 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
2055 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN_SELECT
2056 * \li Action: Move the cursor and select the text to the next paragraph (or
2057 beginning of the current one) in downward direction.
2058 * \li Syntax: paragraph-down-select
2059 * \li Origin: Asger, 1 Oct 1996
2062 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
2064 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
2065 * \li Action: Jump to a paragraph given by its id number and optionally the
2066 desired position within the paragraph.
2067 If given four arguments id_start, pos_start, id_end, pos_end,
2068 perform a selection from start to end.
2069 * \li Notion: Note that id number of paragraph is not the sequential number of
2070 paragraph seen on the screen. Moreover the id is unique for all
2071 opened buffers (documents). Both ids must belong to the same
2073 * \li Syntax: paragraph-goto <PAR_ID> <POS_IN_PAR> [<PAR_ID> <POS_IN_PAR>]
2074 * \li Params: <PAR_ID>: paragraph id \n
2075 <POS_IN_PAR>: desired position within the paragraph
2076 * \li Origin: Dekel, 26 Aug 2000
2080 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly | NoInternal, Edit },
2082 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_BREAK
2083 * \li Action: Breaks the current paragraph at the current location.
2084 * \li Notion: Removes the selection.
2085 * \li Syntax: paragraph-break [<LAYOUT>]
2086 * \li Params: <LAYOUT>: "inverse" - decreases depth by one (or change layout
2087 to default layout) when the cursor is at the end of
2091 { LFUN_PARAGRAPH_BREAK, "paragraph-break", Noop, Edit },
2093 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
2094 * \li Action: Change paragraph settings.
2095 * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
2096 This function only modifies, and does not override, existing settings.
2097 Note that the "leftindent" indent setting is deprecated.
2098 * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
2099 * \li Params: <INDENT>: \noindent|\indent|\indent-toggle|\leftindent LENGTH\n
2100 <SPACING>: \paragraph_spacing default|single|onehalf|double|other SIZE \n
2101 <ALIGN>: \align block|left|right|center|default\n
2102 <OTHERS>: \labelwidthstring WIDTH|\start_of_appendix
2103 * \li Origin: rgh, Aug 15 2007
2106 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
2108 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
2109 * \li Action: Change paragraph settings.
2110 * \li Notion: Overwrite all nonspecified settings to the default ones.
2111 Use paragraph-params lfun if you don't want to overwrite others settings.
2112 * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
2113 * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
2114 * \li Origin: leeming, 30 Mar 2004
2117 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
2119 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UPDATE
2120 * \li Action: Updates the values inside the paragraph dialog from the paragraph.
2121 * \li Notion: This is an internal LFUN, not to be used by users. Called internally
2122 by #LFUN_DIALOG_UPDATE.
2123 * \li Origin: leeming, 13 Mar 2003
2126 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
2129 * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
2130 * \li Action: Move the current group in the upward direction in the
2131 structure of the document.
2132 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
2133 the whole substructure of the group.
2134 * \li Syntax: outline-up
2135 * \li Origin: Vermeer, 23 Mar 2006
2138 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
2140 * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
2141 * \li Action: Move the current group in the downward direction in the
2142 structure of the document.
2143 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
2144 the whole substructure of the group.
2145 * \li Syntax: outline-down
2146 * \li Origin: Vermeer, 23 Mar 2006
2149 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
2151 * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
2152 * \li Action: Moves the current group in the downward direction in the
2153 hierarchy of the document structure.
2154 * \li Notion: Part -> Chapter -> Section -> etc.
2155 * \li Syntax: outline-in
2156 * \li Origin: Vermeer, 23 Mar 2006
2159 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
2161 * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
2162 * \li Action: Moves the current group in the upward direction in the
2163 hierarchy of the document structure.
2164 * \li Notion: Part <- Chapter <- Section <- etc.
2165 * \li Syntax: outline-out
2166 * \li Origin: Vermeer, 23 Mar 2006
2169 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
2172 * \var lyx::FuncCode lyx::LFUN_INSET_EDIT
2173 * \li Action: Edit the inset at cursor with an external application,
2174 if one is attributed.
2175 * \li Syntax: inset-edit [<INSET_PARAMS>]
2176 * \li Params: <INSET_PARAMS>: Parameters for the inset. \n
2177 Currently only the filename will be considered.
2178 * \li Origin: JSpitzm, 27 Apr 2006
2181 { LFUN_INSET_EDIT, "inset-edit", ReadOnly | AtPoint, Edit },
2184 * \var lyx::FuncCode lyx::LFUN_TABULAR_INSERT
2185 * \li Action: Inserts table into the document.
2186 * \li Notion: See #LFUN_TABULAR_FEATURE for some more details
2187 about tabular modifications.
2188 * \li Syntax: tabular-insert [<ROWS> <COLUMNS>]
2189 * \li Params: In case no arguments are given show insert dialog.
2190 * \li Origin: Jug, 12 Apr 2000
2193 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
2196 * \var lyx::FuncCode lyx::LFUN_CELL_BACKWARD
2197 * \li Action: Moves the cursor to the previous cell inside the table.
2198 * \li Syntax: cell-backward
2199 * \li Origin: Jug, 22 May 2000
2202 { LFUN_CELL_BACKWARD, "cell-backward", ReadOnly | NoUpdate, Edit },
2204 * \var lyx::FuncCode lyx::LFUN_CELL_FORWARD
2205 * \li Action: Moves the cursor to the next cell inside the table.
2206 * \li Syntax: cell-forward
2209 { LFUN_CELL_FORWARD, "cell-forward", ReadOnly | NoUpdate, Edit },
2211 * \var lyx::FuncCode lyx::LFUN_CELL_SPLIT
2212 * \li Action: Splits cell and shifts right part to the next cell (inside the math grid).
2213 * \li Syntax: cell-split
2214 * \li Origin: Ale, 15 May 1997
2217 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
2220 * \var lyx::FuncCode lyx::LFUN_VC_REGISTER
2221 * \li Action: Register the document as an file inside version control system.
2222 * \li Notion: File is registered inside cvs, svn or rcs repository acording to the existence
2223 of cvs/svn/rcs entries in the document's directory. \n
2224 See LyX Additional Features Manual (Version Control Chapter) for additional
2226 * \li Syntax: vc-register
2227 * \li Origin: Lgb, 1 Jul 1997
2230 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
2232 * \var lyx::FuncCode lyx::LFUN_VC_RENAME
2233 * \li Action: Renames the document to another name.
2234 * \li Notion: Renaming with revision history is only supported by SVN.
2235 For CVS it is simulated by adding the document under a new
2236 name and deleting the old one. For RCS it is not supported.
2237 Disabled if uncommitted changes exist.
2238 * \li Syntax: vc-rename <FILENAME>
2239 * \li Params: <FILENAME>: New name of the document.\n
2240 * A file dialog is opened if no filename is given.
2241 * \li Origin: gb, 05 Feb 2013
2244 { LFUN_VC_RENAME, "vc-rename", ReadOnly, System },
2246 * \var lyx::FuncCode lyx::LFUN_VC_COPY
2247 * \li Action: Copies the document to another name.
2248 * \li Notion: Copying with revision history is only supported by SVN.
2249 For RCS and CVS it is simulated by adding the document
2251 Disabled if uncommitted changes exist.
2252 * \li Syntax: vc-copy <FILENAME>
2253 * \li Params: <FILENAME>: New name of the document.\n
2254 * A file dialog is opened if no filename is given.
2255 * \li Origin: gb, 05 Feb 2013
2258 { LFUN_VC_COPY, "vc-copy", ReadOnly, System },
2260 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_IN
2261 * \li Action: Checks-in/commits the changes of the registered file to the repository.
2262 * \li Notion: In RCS case this also unlocks the file.
2263 * \li Syntax: vc-check-in
2264 * \li Origin: Lgb, 1 Jul 1997
2267 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
2269 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_OUT
2270 * \li Action: Checks-out the document for edit (and locks it in some cases).
2271 * \li Syntax: vc-check-out
2272 * \li Origin: Lgb, 1 Jul 1997
2275 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
2277 * \var lyx::FuncCode lyx::LFUN_VC_REVERT
2278 * \li Action: Reverts the document to the last check-in/commit in VCS.
2279 * \li Syntax: vc-revert
2280 * \li Origin: Lgb, 1 Jul 1997
2283 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
2285 * \var lyx::FuncCode lyx::LFUN_VC_UNDO_LAST
2286 * \li Action: Undo last check-in.
2287 * \li Notion: This is currently implemented only for RCS.
2288 * \li Syntax: vc-check-out
2289 * \li Origin: Lgb, 1 Jul 1997
2292 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
2294 * \var lyx::FuncCode lyx::LFUN_VC_COMMAND
2295 * \li Action: Executes external command. This command is intended to support
2296 additional VCS commands.
2297 * \li Syntax: vc-command <FLAG> <PATH> <COMMAND>
2298 * \li Params: <FLAG>: Flags for the command can be combined together.\n
2299 U - dUmmy - no flags \n
2300 D - Doc - need document loaded to proceed \n
2301 I - dIrty - mark document dirty \n
2302 R - Reload - ensure that the document is saved and reload it after command execution \n
2303 M - Message - ask for input string (commit message)\n
2304 <PATH>: path where to start. $$p will be replaced by the current document path.\n
2305 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current
2306 document(with absolute path)/path/message.
2307 * \li Sample: vc-command DR $$p "svn up"
2308 * \li Origin: sanda, 13 Jan 2009
2311 { LFUN_VC_COMMAND, "vc-command", NoBuffer | ReadOnly, System },
2313 * \var lyx::FuncCode lyx::LFUN_VC_LOCKING_TOGGLE
2314 * \li Action: Toggles the locking property of the edited file.
2315 * \li Notion: This is currently implemented only for SVN.
2316 * \li Syntax: vc-locking-toggle
2317 * \li Origin: sanda, 25 Jun 2009
2320 { LFUN_VC_LOCKING_TOGGLE, "vc-locking-toggle", ReadOnly, System },
2322 * \var lyx::FuncCode lyx::LFUN_VC_REPO_UPDATE
2323 * \li Action: Update the local archive directory in which resides
2324 the current document with the remote repository.
2325 * \li Syntax: vc-repo-update
2326 * \li Origin: sanda, 16 Oct 2009
2329 { LFUN_VC_REPO_UPDATE, "vc-repo-update", ReadOnly, System },
2331 * \var lyx::FuncCode lyx::LFUN_VC_COMPARE
2332 * \li Action: Compares two revisions of the same file under version control.
2333 * \li Syntax: vc-compare [<REV1>] [<REV2>]
2334 * \li Params: Revision number either points directly to commit in history
2335 or if negative number -x it points to (last commit - x).\n
2336 In RCS we subtract only in the last number of revision specification.
2337 Special case "0" is reserved for the last committed revision.\n
2338 <REV1>: Older file.\n
2339 <REV2>: Newer file. Used only if REV1 > 0.\n
2340 If no parameter is given, interactive dialog will be shown.
2341 * \li Sample: Compare current document against last commit\n
2343 Compare current document against current revision - 5 commits\n
2345 Compare revisions 120 and 155\n
2347 * \li Origin: sanda, 12 Feb 2010
2350 { LFUN_VC_COMPARE, "vc-compare", ReadOnly, System },
2353 * \var lyx::FuncCode lyx::LFUN_CHANGES_TRACK
2354 * \li Action: Toggles change tracking to on/off.
2355 * \li Syntax: changes-track
2356 * \li Origin: levon, 1 Oct 2002
2359 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
2361 * \var lyx::FuncCode lyx::LFUN_CHANGES_OUTPUT
2362 * \li Action: Toggles showing of change tracking in typeset output.
2363 * \li Syntax: changes-output
2364 * \li Origin: jspitzm, 21 Jan 2005
2367 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
2369 * \var lyx::FuncCode lyx::LFUN_CHANGE_NEXT
2370 * \li Action: Moves the cursor to the position of the next change
2371 of the change tracking records.
2372 * \li Syntax: change-next
2373 * \li Origin: schmitt, 4 Oct 2006
2376 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
2378 * \var lyx::FuncCode lyx::LFUN_CHANGE_PREVIOUS
2379 * \li Action: Moves the cursor to the position of the previous change
2380 of the change tracking records.
2381 * \li Syntax: change-previous
2382 * \li Origin: vfr, 4 Apr 2009
2385 { LFUN_CHANGE_PREVIOUS, "change-previous", ReadOnly, Edit },
2387 * \var lyx::FuncCode lyx::LFUN_CHANGES_MERGE
2388 * \li Action: Open change tracking dialog for merging and moves the cursor
2389 to the position of the next change.
2390 * \li Syntax: changes-merge
2391 * \li Origin: Levon, 16 Oct 2002
2394 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
2396 * \var lyx::FuncCode lyx::LFUN_CHANGE_ACCEPT
2397 * \li Action: Accepts tracked change inside the selection.
2398 * \li Syntax: change-accept
2399 * \li Origin: Levon, 16 Oct 2002
2402 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
2404 * \var lyx::FuncCode lyx::LFUN_CHANGE_REJECT
2405 * \li Action: Rejects tracked change inside the selection.
2406 * \li Syntax: change-reject
2407 * \li Origin: Levon, 16 Oct 2002
2410 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
2412 * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_ACCEPT
2413 * \li Action: Accepts all tracked changes in the document.
2414 * \li Syntax: all-changes-accept
2415 * \li Origin: Levon, 16 Oct 2002
2418 { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
2420 * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_REJECT
2421 * \li Action: Rejects all tracked changes in the document.
2422 * \li Notion: Reject does not work recursively; the user may have to repeat the operation.
2423 * \li Syntax: all-changes-reject
2424 * \li Origin: Levon, 16 Oct 2002
2427 { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
2430 * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
2431 * \li Action: Apply data for an inset.
2432 * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
2433 be applied. This is either changed to #LFUN_INSET_MODIFY or
2434 #LFUN_INSET_INSERT depending on the context where it is called.
2435 * \li Syntax: inset-apply <ARGS>
2436 * \li Params: See #LFUN_INSET_INSERT .
2439 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
2441 * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE
2442 * \li Action: Dissolve the current inset into text.
2443 * \li Syntax: inset-dissolve [<INSET>]
2444 * \li Params: <INSET>: this can be used to make sure the right kind of inset
2445 is dissolved. For example "dissolve" entry in the charstyles
2446 sub-menu should only dissolve the charstyle inset, even if the
2447 cursor is inside several nested insets of different type.\n
2448 For values see #lyx::InsetLayout::lyxtype_ .
2449 * \li Origin: JSpitz, 7 Aug 2006
2452 { LFUN_INSET_DISSOLVE, "inset-dissolve", AtPoint, Edit },
2454 * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
2455 * \li Action: Insert new inset (type given by the parameters).
2456 * \li Syntax: inset-insert <INSET> <ARGS>
2457 * \li Params: <INSET>: <bibitem|bibtex|citation|ert|listings|external|graphics|tabular|\n
2458 hyperlink|include|index|label|line|nomencl|vspace|ref|toc|script>\n
2459 <ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
2460 * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
2461 where <label name> is the name of the referenced label and
2462 <Format> is one of the following: \n
2463 ref -- <reference> \n
2464 eqref -- (<reference>) \n
2465 pageref -- <page> \n
2466 vpageref -- on <page> \n
2467 vref -- <reference> on <page> \n
2468 formatted -- Formatted reference
2471 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
2473 * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
2474 * \li Action: Modify some properties of an inset.
2475 * \li Notion: Used for argument, bibitem, bibtex, box, branch, caption, citation,
2476 command, ert, external, float, graphics, include, index,
2477 info, label, line, listings, newline, newpage, nomencl,
2478 note, phantom, quotes, ref, script, separator, space,
2479 tabular, vspace and wrap insets.
2480 * \li Syntax: inset-modify <INSET> <ARGS> \n
2481 inset-modify changetype <TYPE>
2482 * \li Sample: Change a Note inset into a Comment inset: \n
2483 inset-modify note Note Comment \n
2484 Change a Box into an Ovalbox: \n
2485 inset-modify changetype Ovalbox \n
2486 Change a quotation mark to e[nglish style], l[eft side], s[ingle] \n
2487 inset-modify changetype els \n
2488 Change only the style of a quotation mark, maintaining the other aspects (. = wildcard) \n
2489 inset-modify changetype e.. \n
2492 { LFUN_INSET_MODIFY, "inset-modify", AtPoint, Edit },
2494 * \var lyx::FuncCode lyx::LFUN_TABULAR_FEATURE
2495 * \li Action: Modify properties of tabulars and table-like math environments.
2496 * \li Syntax: tabular-feature <FEATURE> [<ARG>]
2497 * \li Params: Generally see #LFUN_INSET_INSERT for further details.\n
2498 * <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|\n
2499 copy-column|move-column-right|move-column-left|move-row-down|move-row-up|\n
2500 toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|\n
2501 align-left|align-right|align-center|align-block|align-decimal|set-decimal-point|\n
2502 valign-top|valign-bottom|valign-middle|longtabular-align-left|\n
2503 longtabular-align-center|longtabular-align-right|m-align-left|m-align-right|\n
2504 m-align-center|m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|\n
2505 set-all-lines|unset-all-lines|toggle-longtabular|set-longtabular|unset-longtabular|set-pwidth|\n
2506 set-mpwidth|set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|\n
2507 set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|\n
2508 unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|\n
2509 set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|\n
2510 set-special-column|set-special-multicolumn|set-special-multirow|\n
2511 toggle-booktabs|set-booktabs|unset-booktabs|set-top-space|set-bottom-space|\n
2512 set-interline-space|set-border-lines|tabular-valign-top|\n
2513 tabular-valign-middle|tabular-valign-bottom|set-tabular-width\n
2514 Various math-environment features are handled as well, e.g. add-vline-left/right for\n
2515 the Grid/Array environment.\n
2516 <ARG>: additional argument for some commands, use debug mode to explore its values.
2517 * \li Origin: gm, 10 Dec 2015
2520 { LFUN_TABULAR_FEATURE, "tabular-feature", Noop, Edit },
2522 * \var lyx::FuncCode lyx::LFUN_INSET_DIALOG_UPDATE
2523 * \li Action: Updates the values inside the dialog from the inset.
2524 * \li Notion: This is an internal LFUN, not to be used by users. Called internally
2525 by #LFUN_DIALOG_UPDATE
2526 * \li Params: <DIALOG-NAME>
2527 * \li Origin: leeming, 25 Feb 2003
2530 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
2532 * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
2533 * \li Action: Open the inset's properties dialog.
2534 * \li Notion: Used for bibitem, bibtex, box, branch, citation, ert, external,
2535 float, graphics, href, include, index, index_print, label, line,
2536 listings, note, phantom, ref, space, tabular, vspace, wrap insets.
2537 * \li Syntax: inset-settings <INSET>
2538 * \li Params: <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|\n
2539 graphics|href|include|index|index_print|label|line|\n
2540 listings|note|phantom|ref|space|tabular|vspace|wrap>.
2543 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly | AtPoint, Edit },
2545 * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
2546 * \li Action: Toggles the collapsible inset at cursor position,
2547 or the inset we are currently in.
2548 * \li Syntax: inset-toggle [<ARG>]
2549 * \li Params: <ARG>: <open|close|toggle|assign>. \n
2550 open/close/toggle are for collapsible insets. toggle is used when no argument is given.\n
2551 assign synchronize the branch-inset with activation status of the branch.
2552 Used for global toggling when changed activation.
2553 * \li Origin: lasgouttes, 19 Jul 2001
2556 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly | AtPoint, Edit },
2558 * \var lyx::FuncCode lyx::LFUN_INSET_FORALL
2559 * \li Action: Apply the given commands on insets of a given name.
2560 * \li Notion: WARNING: use at your own risks; this function gives
2561 you too many ways of shooting yourself in the foot.
2562 A typical example is
2563 inset-forall Note note-insert
2564 which starts an infinite loop. This is mitigated by the fact
2565 that the number of actions is arbitrarily limited to 100000.
2566 Note also that inset-forall does not update metrics between
2567 iterations, which can lead to bugs. This has to be eventually
2569 * \li Syntax: inset-forall <NAME> <LFUN-COMMAND> \n
2570 <NAME>: Type of Inset. If <NAME> is *, all insets are matched.
2571 The name is used like for InsetLayout in layout files: "Note"
2572 matches all note insets, while "Note:Note" only matches LyX
2574 * \li Sample: Remove all index insets: \n
2575 inset-forall Index char-delete-forward \n
2576 Close all Notes (also works for a particular branch, for example): \n
2577 inset-forall Note inset-toggle close \n
2578 Transform all yellow notes to comments \n
2579 inset-forall Note:Note inset-modify note Note Comment \n
2580 Try to put LyX in an infinite loop if there is at least a Note: \n
2581 inset-forall Note char-backward
2582 * \li Origin: lasgouttes, 27 Nov 2009
2585 { LFUN_INSET_FORALL, "inset-forall", ReadOnly, Edit },
2588 * \var lyx::FuncCode lyx::LFUN_GRAPHICS_RELOAD
2589 * \li Action: Reloads the image if necessary.
2590 * \li Syntax: graphics-reload
2591 * \li Origin: vfr, 10 Aug 2009
2594 { LFUN_GRAPHICS_RELOAD, "graphics-reload", ReadOnly | AtPoint, Edit },
2596 * \var lyx::FuncCode lyx::LFUN_SET_GRAPHICS_GROUP
2597 * \li Action: Set the group for the graphics inset on the cursor position.
2598 * \li Syntax: set-graphics-group [<GROUP>]
2599 * \li Params: <GROUP>: Id for an existing group. In case the Id is an empty string,
2600 the graphics inset is removed from the current group.
2601 * \li Origin: sanda, 6 May 2008
2604 { LFUN_SET_GRAPHICS_GROUP, "set-graphics-group", Noop, Edit },
2607 * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
2608 * \li Action: Moves the cursor out of the current slice, going forward.
2609 * \li Notion: Cursor movement within an inset may be different than cursor
2610 movement in the surrounding text. This action should be called
2611 automatically by the cursor movement within the inset, when
2612 movement within the inset has ceased (reached the end of the
2613 last paragraph, for example), in order to move correctly
2614 back into the surrounding text.
2617 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
2619 * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
2620 * \li Action: Moves the cursor out of the current slice, going backwards.
2621 * \li Notion: See also #LFUN_FINISHED_FORWARD.
2624 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
2626 * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
2627 * \li Action: Moves the cursor out of the current slice, going right.
2628 * \li Notion: See also #LFUN_FINISHED_FORWARD
2631 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
2633 * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
2634 * \li Action: Moves the cursor out of the current slice, going left.
2635 * \li Notion: See also #LFUN_FINISHED_FORWARD.
2638 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
2641 * \var lyx::FuncCode lyx::LFUN_LANGUAGE
2642 * \li Action: Set language from the current cursor position.
2643 * \li Syntax: language <LANG> [set]
2644 * \li Params: <LANG>: Requested language. Look in lib/languages for
2645 the list. "language reset" or "language" (without param)
2646 reset to the document language.
2647 set: If used, the language will be set to the specified
2648 language. Otherwise, the language will be toggled (i.e., if
2649 the current language is LANG, switch to the document language
2650 or the default language, if LANG is the document language).
2651 * \li Origin: Dekel, 2 Mar 2000
2654 { LFUN_LANGUAGE, "language", Noop, Edit },
2657 * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
2658 * \li Action: Goto a label.
2659 * \li Syntax: label-goto [<LABEL>]
2660 * \li Params: <LABEL>: Requested label. If no label is given and reference
2661 is on cursor position, Bookmark 0 is saved and
2662 cursor moves to the position of referenced label.
2663 * \li Origin: Ale, 6 Aug 1997
2666 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
2668 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT
2669 * \li Action: Inserts label to text or displayed formula.
2670 * \li Syntax: label-insert [<LABEL>]
2671 * \li Params: <LABEL>: Requested label. If no label is given dialog requesting
2672 name will be opened.
2675 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
2677 * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
2678 * \li Action: Go to the next label or cross-reference.
2679 * \li Syntax: reference-next
2680 * \li Origin: Dekel, 14 Jan 2001
2683 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
2686 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
2687 * \li Action: Moves the cursor to the numbered bookmark, opening the file
2688 if necessary. Note that bookmarks are saved per-session, not
2690 * \li Notion: Bookmark 0 has a special purpose. It is automatically set \n
2691 1. to the paragraph you are currently editing \n
2692 2. to the paragraph from where you are jumping to the last-edited
2693 position (jump-back feature) \n
2694 3. when jumping from crossreference to the requested label by
2696 * \li Syntax: bookmark-goto <NUMBER>
2697 * \li Params: <NUMBER>: the number of the bookmark to restore.
2698 * \li Origin: Dekel, 27 January 2001
2701 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
2703 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
2704 * \li Action: Save a bookmark.
2705 * \li Notion: Saves a numbered bookmark to the sessions file. The number
2706 must be between 1 and 9, inclusive. Note that bookmarks are
2707 saved per-session, not per file.
2708 * \li Syntax: bookmark-save <NUMBER>
2709 * \li Params: <NUMBER>: the number of the bookmark to save.
2710 * \li Origin: Dekel, 27 January 2001
2713 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
2715 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
2716 * \li Action: Clears the list of saved bookmarks.
2717 * \li Syntax: bookmark-clear
2718 * \li Origin: bpeng, 31 October 2006
2721 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
2724 * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
2725 * \li Action: Open the given help file according to the language setting.
2726 * \li Syntax: help-open <FILE>[.lyx]
2727 * \li Params: <FILE>: any document from (/usr/share/)doc directory.
2728 * \li Origin: Jug, 27 Jun 1999
2731 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
2733 * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
2734 * \li Action: Terminates the current LyX instance.
2735 * \li Notion: Terminates the current LyX instance, asking whether to save
2736 modified documents, etc.
2737 * \li Syntax: lyx-quit
2740 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
2742 * \var lyx::FuncCode lyx::LFUN_LYX_ACTIVATE
2743 * \li Action: Activates the LyX window.
2744 * \li Notion: On Linux and Mac OS, this action brings the LyX window
2745 into focus. Such behavior is not allowed by Windows OS
2746 so instead the color of the taskbar entry is changed to
2747 indicate that the window has changed in some way.
2748 This action is useful in combination with reverse search.
2749 * \li Syntax: lyx-activate
2750 * \li Origin: skostysh, 4 Aug 2016
2753 { LFUN_LYX_ACTIVATE, "lyx-activate", ReadOnly | NoBuffer, Hidden },
2755 * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
2756 * \li Action: Toggles visibility of a given toolbar between on/off/auto.
2757 * \li Notion: Skipping "auto" when allowauto is false.
2758 * \li Syntax: toolbar-toggle <NAME> [allowauto]
2759 * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|\n
2760 minibuffer|review|view/update|math_panels|vcs|
2761 view-others|update-others
2762 * \li Origin: Edwin, 21 May 2007
2765 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
2767 * \var lyx::FuncCode lyx::LFUN_ICON_SIZE
2768 * \li Action: Sets icon size of toolbars.
2769 * \li Syntax: icon-size [<SIZE>]
2770 * \li Params: <SIZE> : the icon size in px or one of the logical settings
2771 small|normal|big|huge|giant, the default is normal
2772 (whose size in px is icon set dependent).
2773 * \li Origin: 11 July 2016
2776 { LFUN_ICON_SIZE, "icon-size", NoBuffer, Buffer },
2778 * \var lyx::FuncCode lyx::LFUN_MENU_OPEN
2779 * \li Action: Opens the menu given by its name.
2780 * \li Syntax: menu-open <NAME>
2781 * \li Params: <NAME>: menu name. See various .inc files in lib/ui for candidates.
2784 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
2786 * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
2787 * \li Action: Various UI visibility-toggling actions.
2788 * \li Syntax: ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
2789 * \li Params: statusbar : Toggle visibility of the statusbar.\n
2790 menubar : Toggle visibility of the menubar.\n
2791 scrollbar : Toggle visibility of the scrollbar.\n
2792 frame : Toggle visibility of the frames around editing window.\n
2793 fullscreen : Toggle fullscreen mode. This also covers calling the
2794 previous functions. However #LFUN_TOOLBAR_TOGGLE for the
2795 custom tweaks of the toolbars should be used.
2796 * \li Origin: sanda, 9 Feb 2007
2799 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
2802 * \var lyx::FuncCode lyx::LFUN_WINDOW_NEW
2803 * \li Action: Creates new empty LyX window.
2804 * \li Notion: Already opened documents from the previous window can be found under View menu.
2805 * \li Syntax: window-new [<GEOMETRY>]
2806 * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently
2807 accepted only on Windows platform.
2808 * \li Origin: Abdel, 21 Oct 2006
2811 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
2813 * \var lyx::FuncCode lyx::LFUN_WINDOW_CLOSE
2814 * \li Action: Closes the current LyX window.
2815 * \li Syntax: window-close
2816 * \li Origin: Abdel, 23 Oct 2006
2819 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
2822 * \var lyx::FuncCode lyx::LFUN_VIEW_SPLIT
2823 * \li Action: Creates another split view of current buffer.
2824 * \li Notion: All split views act in the same way independently.
2825 * \li Syntax: view-split <vertical|horizontal>
2826 * \li Params: horizontal : The work areas are laid out side by side.\n
2827 vertical : The work areas laid out vertically.
2828 * \li Origin: Abdel, 20 Feb 2008
2831 { LFUN_VIEW_SPLIT, "view-split", ReadOnly, Buffer },
2834 * \var lyx::FuncCode lyx::LFUN_VIEW_CLOSE
2835 * \li Action: Close the current document work area.
2836 * \li Notion: Close the current work area. If no other work areas are showing the buffer,
2837 then close the associated buffer as well.
2838 * \li Syntax: view-close
2839 * \li Origin: Tommaso, 15 Sep 2012
2842 { LFUN_VIEW_CLOSE, "view-close", ReadOnly, Buffer },
2845 * \var lyx::FuncCode lyx::LFUN_TAB_GROUP_CLOSE
2846 * \li Action: Close the current tab group.
2847 * \li Notion: This only closes the work areas, not the buffers themselves.
2848 The still opened buffers can be visualized in another tab group.
2849 * \li Syntax: tab-group-close
2850 * \li Origin: Abdel, 21 Feb 2008
2853 { LFUN_TAB_GROUP_CLOSE, "tab-group-close", ReadOnly, Buffer },
2856 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW
2857 * \li Action: Shows hidden dialog or creates new one for a given function/inset settings etc.
2858 * \li Syntax: dialog-show <NAME> [<DATA>]
2859 * \li Params: <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|\n
2860 compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|\n
2861 graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimiter|\n
2862 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|\n
2863 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|\n
2864 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL> \n
2865 <SPECIAL>: latexlog|vclog \n
2866 <DATA>: data, usually settings for the given dialog. Use debug mode for the
2868 * \li Origin: leeming, 17 Jun 2003
2871 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
2873 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW_NEW_INSET
2874 * \li Action: Shows hidden dialog or create new one for a given inset settings etc.
2875 * \li Notion: Internally uses #LFUN_DIALOG_SHOW with processed data for a given inset.
2876 * \li Syntax: dialog-show-new-inset <NAME> [<DATA>]
2877 * \li Params: See #LFUN_DIALOG_SHOW .
2878 * \li Origin: leeming, 25 Feb 2003
2881 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
2883 * \var lyx::FuncCode lyx::LFUN_DIALOG_UPDATE
2884 * \li Action: Updates the dialog values from the inset/paragraph/document.
2885 * \li Syntax: dialog-update <NAME>
2886 * \li Params: <NAME>: paragraph|prefs|<INSET> \n
2888 * \li Origin: leeming, 25 Feb 2003
2891 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
2893 * \var lyx::FuncCode lyx::LFUN_DIALOG_HIDE
2894 * \li Action: Hides showed dialog. Counterpart to #LFUN_DIALOG_SHOW .
2895 * \li Syntax: dialog-hide <NAME>
2896 * \li Params: See #LFUN_DIALOG_SHOW .
2897 * \li Origin: leeming, 25 Feb 2003
2900 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
2902 * \var lyx::FuncCode lyx::LFUN_DIALOG_TOGGLE
2903 * \li Action: Toggles dialog between showed/hidden state.
2904 * \li Notion: Internally uses #LFUN_DIALOG_SHOW , #LFUN_DIALOG_HIDE .
2905 * \li Syntax: dialog-toggle <NAME> [<DATA>]
2906 * \li Params: See #LFUN_DIALOG_SHOW .
2907 * \li Origin: JSpitzm, 30 Apr 2007
2910 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
2912 * \var lyx::FuncCode lyx::LFUN_DIALOG_DISCONNECT_INSET
2913 * \li Action: Closes opened connection to opened inset.
2914 * \li Notion: Connection is used for apply functions.
2915 * \li Syntax: dialog-disconnect-inset <INSET-NAME>
2916 * \li Origin: leeming, 25 Feb 2003
2919 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
2922 * \var lyx::FuncCode lyx::LFUN_MOUSE_PRESS
2923 * \li Action: This function is called when mouse button is pressed (inside workarea).
2924 Action depends on the context.
2925 * \li Notion: This is an internal LFUN, not to be used by users.
2926 * \li Origin: Andre, 9 Aug 2002
2929 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
2931 * \var lyx::FuncCode lyx::LFUN_MOUSE_DOUBLE
2932 * \li Action: This function is called when double click on mouse button is
2933 pressed (inside workarea). Action depends on the context.
2934 * \li Notion: This is an internal LFUN, not to be used by users.
2935 * \li Origin: Andre, 9 Aug 2002
2938 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
2940 * \var lyx::FuncCode lyx::LFUN_MOUSE_TRIPLE
2941 * \li Action: This function is called when triple click on mouse button is
2942 pressed (inside workarea). Action depends on the context.
2943 * \li Notion: This is an internal LFUN, not to be used by users.
2944 * \li Origin: Andre, 9 Aug 2002
2947 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
2949 * \var lyx::FuncCode lyx::LFUN_MOUSE_MOTION
2950 * \li Action: This function is called when mouse cursor is moving over the text.
2951 Action depends on the context.
2952 * \li Notion: This is an internal LFUN, not to be used by users.
2953 * \li Origin: Andre, 9 Aug 2002
2956 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
2958 * \var lyx::FuncCode lyx::LFUN_MOUSE_RELEASE
2959 * \li Action: This function is called when mouse button is released (inside workarea).
2960 Action depends on the context.
2961 * \li Notion: This is an internal LFUN, not to be used by users.
2962 * \li Origin: Andre, 9 Aug 2002
2965 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
2968 * \var lyx::FuncCode lyx::LFUN_KEYMAP_OFF
2969 * \li Action: Turn off the loaded keyboard map.
2970 * \li Syntax: keymap-off
2973 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
2975 * \var lyx::FuncCode lyx::LFUN_KEYMAP_PRIMARY
2976 * \li Action: Turn on the primary keyboard map.
2977 * \li Notion: Maps were widely used in past, when X-windows didn't have nowadays
2978 keyboard support. They can be still used to maintain uniform keyboard
2979 layout across the various platforms.\n
2980 The language is to be set in the Preferences dialog.
2981 * \li Syntax: keymap-primary
2984 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
2986 * \var lyx::FuncCode lyx::LFUN_KEYMAP_SECONDARY
2987 * \li Action: Turn on the secondary keyboard map.
2988 * \li Syntax: keymap-secondary
2991 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
2993 * \var lyx::FuncCode lyx::LFUN_KEYMAP_TOGGLE
2994 * \li Action: Toggles keyboard maps (first/second/off).
2995 * \li Syntax: keymap-toggle
2996 * \li Origin: leeming, 30 Mar 2004
2999 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
3002 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_LAYOUT
3003 * \li Action: Returns the current layout (that is environment) name
3004 on the cursor position.
3005 * \li Syntax: server-get-layout
3008 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
3010 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_FILENAME
3011 * \li Action: Returns path and file name of the currently edited document.
3012 * \li Syntax: server-get-filename
3015 { LFUN_SERVER_GET_FILENAME, "server-get-filename", ReadOnly, System },
3017 * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
3018 * \li Action: Sets the cursor position in LyX based on the row number of generated TeX file.
3019 * \li Notion: This can be useful for DVI inverse-search or detection of the problematic
3020 line from LaTeX compilation. Note that before this function can be used
3021 export to LaTeX output must occur (in order to map the row numbers).
3022 * \li Syntax: server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
3023 * \li Params: <FILE>: the path and filename. Environment variables are expanded in the path.
3024 In case this LFUN does not work make sure you are giving correct
3026 If the file is located inside LyX temporary directory it will be
3027 mapped back into the appropriate opened buffer (e.g. for the case
3028 of generated .tex file).\n
3029 .ext: extensions will be automatically replaced by .lyx.\n
3030 <ROW_NUMBER> The row number of the LaTeX file to which to go.
3031 * \li Sample: server-goto-file-row /home/user/example.lyx 41\n
3032 server-goto-file-row /tmp/lyx_tmpdir.XM3088/lyx_tmpbuf0/example.tex 41
3033 * \li Origin: Edmar, 23 Dec 1998
3036 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly | NoBuffer, System },
3038 * \var lyx::FuncCode lyx::LFUN_FORWARD_SEARCH
3039 * \li Action: Sets the cursor position in the previewed (dvi/pdf) file based on the row
3040 number in LyX window.
3041 * \li Notion: The external program used for forward search call can be specified in
3042 LyX Output preferences. See Additional manual for details of these
3044 * \li Syntax: forward-search
3045 * \li Origin: sanda, 14 Apr 2010
3048 { LFUN_FORWARD_SEARCH, "forward-search", ReadOnly, System },
3050 * \var lyx::FuncCode lyx::LFUN_SERVER_NOTIFY
3051 * \li Action: Sends notify message about the last key-sequence to client.
3052 * \li Notion: This can be used to grab last key-sequence used inside the LyX window.
3053 See also Debug extensions section in Additional features manual.
3054 * \li Syntax: server-notify
3057 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
3059 * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
3060 * \li Action: Sets the cursor position based on the editing area coordinates
3061 (similar to clicking on that point with left mouse button).
3062 * \li Syntax: server-set-xy <X> <Y>
3065 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
3067 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
3068 * \li Action: Returns the coordinates of cursor position in the editing area.
3069 * \li Syntax: server-get-xy
3072 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
3075 * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
3076 * \li Action: Generates the code (literate programming).
3077 * \li Notion: Latex file with extension \literate_extension is generated.
3078 Then LyX invokes \build_command (with a default of ``make'') to generate the code and
3079 \build_error_filter to process the compilation error messages. \n
3080 In case you want to process your literate file with a script, or some other program,
3081 just insert in your lyxrc file an entry with:\n
3082 \build_command "my_script my_arguments" \n
3083 The \build_error_filter differs from the \literate_error_filter only in that the
3084 former will identify error messages from your compiler.
3085 * \li Syntax: build-program
3088 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
3091 * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
3092 * \li Action: Saves the current buffer to a temporary file.
3093 * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
3094 is called automatically by LyX, to "autosave" the current buffer.
3095 * \li Syntax: buffer-auto-save
3098 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
3100 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHILD_OPEN
3101 * \li Action: Loads the given child document.
3102 * \li Notion: The current document is treated as a parent.
3103 * \li Syntax: buffer-child-open <FILE>
3104 * \li Params: <FILE>: Filename of the child. The directory of the parent is assumed by default.
3105 * \li Origin: Ale, 28 May 1997
3108 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
3110 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHKTEX
3111 * \li Action: Runs chktex for the current document.
3112 * \li Syntax: buffer-chktex
3113 * \li Origin: Asger, 30 Oct 1997
3116 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
3118 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
3119 * \li Action: Toggles compression of the current document on/off.
3120 * \li Syntax: buffer-toggle-compression
3121 * \li Origin: bpeng, 27 Apr 2006
3124 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
3126 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_OUTPUT_SYNC
3127 * \li Action: Toggles including of resources for forward/reverse search of the given document.
3128 * \li Notion: When toggled on, SyncTeX is invoked for PDF, while srcltx package
3129 is used for DVI. Custom LaTeX macro can be defined in preferences.
3130 * \li Syntax: buffer-toggle-output-sync
3131 * \li Origin: sanda, 25 May 2010
3134 { LFUN_BUFFER_TOGGLE_OUTPUT_SYNC, "buffer-toggle-output-sync", Noop, System },
3136 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
3137 * \li Action: Closes the current buffer.
3138 * \li Notion: Closes the current buffer, asking whether to save it, etc,
3139 if the buffer has been modified.
3140 * \li Syntax: buffer-close
3143 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
3145 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE_ALL
3146 * \li Action: Closes all buffers.
3147 * \li Notion: Closes all buffers, asking whether to save it, etc,
3148 if a buffer has been modified.
3149 * \li Syntax: buffer-close-all
3152 { LFUN_BUFFER_CLOSE_ALL, "buffer-close-all", ReadOnly, Buffer },
3154 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
3155 * \li Action: Exports the current buffer (document) to the given format.
3156 * \li Syntax: buffer-export <FORMAT> [<DEST>]
3157 * \li Params: <FORMAT> is either "custom" or one of the formats which you
3158 can find in Tools->Preferences->File formats->Format.
3159 Usual format you will enter is "pdf2" (pdflatex),
3160 "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
3161 In case of "custom" you will be asked for a format you
3162 want to start from and for the command that you want to
3163 apply to this format. Internally the control is then passed
3164 to #LFUN_BUFFER_EXPORT_CUSTOM.
3165 <DEST> If present, this argument provides the export destination
3166 filename. Its containing folder will also be the destination
3167 folder, where all the needed external files will be copied.
3168 * \li Origin: Lgb, 29 Jul 1997
3171 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
3173 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
3174 * \li Action: Exports the current buffer (document) from the given format using
3175 the given command on it.
3176 * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
3177 * \li Params: <FORMAT> format to start from (LyX will care to produce such
3178 intermediate file).\n
3179 <COMMAND> this command will be launched on the file. Note that you can
3180 use "$$FName" string to qualify the intermediate file.
3181 * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
3182 * \li Origin: leeming, 27 Mar 2004
3185 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
3187 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_AS
3188 * \li Action: Opens a dialog for exporting the current buffer.
3189 * \li Syntax: buffer-export-as [<FORMAT>]
3190 * \li Params: <FORMAT> is the export format initially selected in the dialog.
3191 * You can pass any of the formats which you can find in
3192 * Tools->Preferences->File formats->Format, provided it
3193 * has the "document" flag set. If no format is specified
3194 * the dialog will start with the default output format of
3195 * the current document.
3196 * \li Sample: buffer-export-as pdf2
3197 * \li Origin: tommaso, 6 Oct 2011
3200 { LFUN_BUFFER_EXPORT_AS, "buffer-export-as", ReadOnly, Buffer },
3202 * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
3203 * \li Action: Import a given file as a lyx document.
3204 * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
3205 defined converters in preferences. Look in the File->Import menu to get
3206 an idea of the currently active import formats.
3207 * \li Syntax: buffer-import <FORMAT> [<FILE>]
3208 * \li Origin: Asger, 24 Jul 1998
3211 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
3213 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
3214 * \li Action: Creates a new buffer (that is, document) and switches to it.
3215 * \li Notion: Implicit path can be set in Preferences dialog.
3216 * \li Syntax: buffer-new [<FILE>]
3217 * \li Params: <FILE>: filename of created file with absolute path.
3220 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
3222 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
3223 * \li Action: Creates a new buffer (that is, document) from a template.
3224 * \li Notion: Path for new files and templates can be set in Preferences dialog.
3225 Template will be asked for via Open-dialog.
3226 * \li Syntax: buffer-new-template [<FILE>]
3227 * \li Params: <FILE>: filename of created file with absolute path.
3230 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
3232 * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
3233 * \li Action: Reverts opened document.
3234 * \li Syntax: buffer-reload
3235 * \li Origin: Asger, 2 Feb 1997
3238 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
3240 * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
3241 * \li Action: Display and switch to the given buffer.
3242 * \li Syntax: buffer-switch <BUFFER>
3243 * \li Params: <BUFFER>: path and filename of already opened (but possibly hidden)
3244 document which is to be shown.
3247 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
3249 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
3250 * \li Action: Toggle editing mode of the current document between read/write and read-only.
3251 * \li Notion: This function is not allowed if the file is under version control, since
3252 read-only flag is often used in version control file locking.
3253 * \li Syntax: buffer-toggle-read-only
3254 * \li Origin: Lgb, 27 May 1997
3257 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
3259 * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
3260 * \li Action: Displays current buffer in chosen format.
3261 * \li Notion: Displays the contents of the current buffer in the chosen
3262 format, for example, PDF or DVI. This runs the necessary
3263 converter, calls the defined viewer, and so forth.
3264 * \li Syntax: buffer-view [<FORMAT>]
3265 * \li Params: <FORMAT>: The format to display, where this is one of the
3266 formats defined (in the current GUI) in the
3267 Tools>Preferences>File Formats dialog.
3268 If no format is given, the default format as
3269 specified in the same dialog is used.
3272 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
3274 * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
3275 * \li Action: Exports the current document and put the result into the
3276 temporary directory.
3277 * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
3278 the output will be rewritten - updated. This is useful in case your viewer
3279 is able to detect such changes (e.g. ghostview for postscript).
3280 * \li Syntax: buffer-update [<FORMAT>]
3281 * \li Params: <FORMAT>: The format to display, where this is one of the
3282 formats defined (in the current GUI) in the
3283 Tools>Preferences>File Formats dialog.
3284 If no format is given, the default format as
3285 specified in the same dialog is used.
3286 * \li Origin: Dekel, 5 Aug 2000
3289 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
3292 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
3293 * \li Action: Saves the current buffer.
3294 * \li Notion: Saves the current buffer to disk, using the filename that
3295 is already associated with the buffer, asking for one if
3296 none is yet assigned.
3297 * \li Syntax: buffer-write
3300 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
3302 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
3303 * \li Action: Rename and save current buffer.
3304 * \li Syntax: buffer-write-as <FILENAME>
3305 * \li Params: <FILENAME>: New name of the buffer/file. A relative path
3306 is with respect to the original location of the buffer/file.
3309 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
3311 * \var lyx::FuncCode lyx::LFUN_BUFFER_FORALL
3312 * \li Action: Applies a command to all non-hidden buffers.
3313 * \li Notion: a buffer is `hidden' if it is internally open in LyX, but not
3314 visible in any window.
3315 * \li Syntax: buffer-forall <LFUN-COMMAND>
3316 * \li Params: <LFUN-COMMAND>: The command to be applied to the buffers.
3317 * \li Sample: Close all Notes in buffers: \n
3318 buffer-forall inset-forall Note inset-toggle close \n
3319 Toggle change tracking on buffers: \n
3320 buffer-forall changes-track \n
3321 Toggle read-only for buffers: \n
3322 buffer-forall buffer-toggle-read-only \n
3323 Show statistics for individual buffers: \n
3324 buffer-forall statistics \n
3325 Activate the branch named "Solutions" in buffers: \n
3326 buffer-forall branch-activate Solutions \n
3327 Export buffers to PDF (pdflatex): \n
3328 buffer-forall buffer-export pdf2 \n
3329 * \li Origin: skostysh, 20 Jul 2012
3332 { LFUN_BUFFER_FORALL, "buffer-forall", ReadOnly | Argument, Buffer },
3334 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
3335 * \li Action: Save all changed documents.
3336 * \li Syntax: buffer-write-all
3337 * \li Origin: rgh, gpothier 6 Aug 2007
3340 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
3342 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEXT
3343 * \li Action: Switch to the next opened document.
3344 * \li Notion: Note that this does not necessarily mean next in tabbar
3345 (for full list see View menu).
3346 * \li Syntax: buffer-next
3349 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
3351 * \var lyx::FuncCode lyx::LFUN_BUFFER_MOVE_NEXT
3352 * \li Action: Moves the current tab one spot to the right.
3353 * \li Syntax: buffer-move-next
3354 * \li Origin: skostysh, 7 Apr 2015
3357 { LFUN_BUFFER_MOVE_NEXT, "buffer-move-next", ReadOnly, Buffer },
3359 * \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS
3360 * \li Action: Switch to the previous opened document.
3361 * \li Syntax: buffer-previous
3364 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
3366 * \var lyx::FuncCode lyx::LFUN_BUFFER_MOVE_PREVIOUS
3367 * \li Action: Moves the current tab one spot to the left.
3368 * \li Syntax: buffer-move-previous
3369 * \li Origin: skostysh, 7 Apr 2015
3372 { LFUN_BUFFER_MOVE_PREVIOUS, "buffer-move-previous", ReadOnly, Buffer },
3374 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
3375 * \li Action: Update (export) the document built from the master buffer,
3376 if the current buffer is part of a master/child document.
3377 * \li Syntax: master-buffer-update [<FORMAT>]
3378 * \li Params: <FORMAT>: The format to display, where this is one of the
3379 formats defined (in the current GUI) in the
3380 Tools>Preferences>File Formats dialog.
3381 If no format is given, the default format as
3382 specified in the same dialog is used.
3383 * \li Origin: Tommaso, 20 Sep 2007
3386 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
3388 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
3389 * \li Action: Show a preview built from the master buffer, if available.
3390 if the current buffer is part of a master/child document.
3391 * \li Syntax: master-buffer-view [<FORMAT>]
3392 * \li Params: <FORMAT>: The format to display, where this is one of the
3393 formats defined (in the current GUI) in the
3394 Tools>Preferences>File Formats dialog.
3395 If no format is given, the default format as
3396 specified in the same dialog is used.
3397 * \li Origin: Tommaso, 20 Sep 2007
3400 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
3402 * \var lyx::FuncCode lyx::LFUN_BUFFER_LANGUAGE
3403 * \li Action: Set language of the current document.
3404 * \li Syntax: buffer-language <LANG>
3405 * \li Params: <LANG>: language name. See lib/languages for list.
3406 * \li Origin: leeming, 30 Mar 2004
3409 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
3411 * \var lyx::FuncCode lyx::LFUN_BUFFER_SAVE_AS_DEFAULT
3412 * \li Action: Save the current document settings as default.
3413 * \li Notion: The file will will be saved into ~/.lyx/templates/defaults.lyx .
3414 * \li Syntax: buffer-save-as-default [<ARGS>]
3415 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
3416 you can find in document header of usual .lyx file.
3417 * \li Origin: leeming, 30 Mar 2004
3420 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
3422 * \var lyx::FuncCode lyx::LFUN_BUFFER_PARAMS_APPLY
3423 * \li Action: Apply the given settings to the current document.
3424 * \li Syntax: buffer-params-apply [<ARGS>]
3425 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
3426 you can find in document header of usual .lyx file.
3427 * \li Origin: leeming, 30 Mar 2004
3430 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", NoInternal, Buffer },
3433 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
3434 * \li Action: Inserts another LyX file.
3435 * \li Syntax: file-insert [<FILE>]
3436 * \li Params: <FILE>: Filename to be inserted.
3439 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
3441 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
3442 * \li Action: Inserts plain text file.
3443 * \li Syntax: file-insert-plaintext [<FILE>]
3444 * \li Params: <FILE>: Filename to be inserted.
3445 * \li Origin: CFO-G, 19 Nov 1997
3448 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
3450 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
3451 * \li Action: Inserts plain text file as paragraph (i.e. join lines).
3452 * \li Syntax: file-insert-plaintext-para [<FILE>]
3453 * \li Params: <FILE>: Filename to be inserted.
3454 * \li Origin: Levon, 14 Feb 2001
3457 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
3459 * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
3460 * \li Action: Open LyX document.
3461 * \li Syntax: file-open [<FILE>]
3462 * \li Params: <FILE>: Filename to be opened.
3465 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
3468 * \var lyx::FuncCode lyx::LFUN_CALL
3469 * \li Action: Executes a command defined in a .def file.
3470 * \li Notion: The definitions are by default read from lib/commands/default.def.\n
3471 A .def file allows to define a command with \define "<NAME>" "<LFUN>"
3472 where <NAME> is the name of the new command and <LFUN> is the lfun code
3473 to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
3474 \def_file "FileName" allows to include another .def file. \n
3475 This is particularly useful in connection with toolbar buttons:
3476 Since the name of the button image for this lfun is
3477 lib/images/commands/<NAME>.png this is the way to assign an image
3478 to a complex command-sequence.
3479 * \li Syntax: call <NAME>
3480 * \li Params: <NAME>: Name of the command that must be called.
3481 * \li Origin: broider, 2 Oct 2007
3484 { LFUN_CALL, "call", NoBuffer, System },
3486 * \var lyx::FuncCode lyx::LFUN_META_PREFIX
3487 * \li Action: Simulate halting Meta key (Alt key on PCs).
3488 * \li Notion: Used for buffer edition not for GUI control.
3489 * \li Syntax: meta-prefix
3492 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
3494 * \var lyx::FuncCode lyx::LFUN_CANCEL
3495 * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
3496 * \li Syntax: cancel
3499 { LFUN_CANCEL, "cancel", NoBuffer, System },
3502 * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
3503 * \li Action: Switches the focus to the minibuffer so that the user can type
3504 in there. If necessary, it opens the minibuffer toolbar.
3505 * \li Notion: Usually bound to M-x shortcut.
3506 * \li Syntax: command-execute
3509 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
3512 * \var lyx::FuncCode lyx::LFUN_COMMAND_PREFIX
3513 * \li Action: Return the current key sequence and available options as a string.
3514 * \li Notion: No options are added if no current map exists. \n
3515 This is probably usable only with connection to lyxserver.
3516 * \li Syntax: command-prefix
3519 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
3521 * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
3522 * \li Action: Run more commands (LFUN and its parameters) in a sequence.
3523 * \li Syntax: command-sequence <CMDS>
3524 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
3525 * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
3526 * \li Origin: Andre, 11 Nov 1999
3529 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
3531 * \var lyx::FuncCode lyx::LFUN_COMMAND_ALTERNATIVES
3532 * \li Action: Runs the first listed command that is enabled.
3533 * \li Notion: This can be used to bind multiple functions to a single key,
3534 and then which one is used will depend upon the context.
3535 * \li Syntax: command-alternatives <CMDS>
3536 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
3537 * \li Sample: command-alternatives completion-accept;cell-forward
3538 * \li Origin: rgh, 24 September 2008
3541 { LFUN_COMMAND_ALTERNATIVES, "command-alternatives", NoBuffer, System },
3543 * \var lyx::FuncCode lyx::LFUN_MESSAGE
3544 * \li Action: Shows message in statusbar (for script purposes).
3545 * \li Syntax: message <STRING>
3546 * \li Origin: Lgb, 8 Apr 2001
3549 { LFUN_MESSAGE, "message", NoBuffer, System },
3551 * \var lyx::FuncCode lyx::LFUN_DEBUG_LEVEL_SET
3552 * \li Action: Set debug output level.
3553 * \li Syntax: debug-level-set <LEVEL>
3554 * \li Params: <LEVEL>: comma separated list of levels or the correspondent number
3555 of their combination. 0 is equivalent to disabling all debug
3556 events. See lyx -dbg for the current list of debug levels
3558 * \li Origin: sanda, 28 Dec 2009
3561 { LFUN_DEBUG_LEVEL_SET, "debug-level-set", NoBuffer, System },
3564 * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
3565 * \li Action: Save user preferences.
3566 * \li Syntax: preferences-save
3567 * \li Origin: Lgb, 27 Nov 1999
3570 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
3572 * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
3573 * \li Action: Reconfigure the automatic settings.
3574 * \li Syntax: reconfigure
3575 * \li Origin: Asger, 14 Feb 1997
3578 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
3580 * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
3581 * \li Action: Apply the given settings to user preferences.
3582 * \li Syntax: lyxrc-apply <SETTINGS>
3583 * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
3584 to get an idea which commands to use and their syntax.
3585 #lyx::LyXRC::LyXRCTags has the list of possible commands.
3588 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
3590 * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
3591 * \li Action: Determine whether to keep cursor inside the editing window regardless
3592 of the scrollbar movement.
3593 * \li Syntax: toggle-cursor-follows-scrollbar
3594 * \li Origin: ARRae, 2 Dec 1997
3597 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
3599 * \var lyx::FuncCode lyx::LFUN_SET_COLOR
3600 * \li Action: Set the given LyX color to the color defined by the X11 name given.
3601 * \li Notion: A new color entry is created if the color is unknown.
3602 Color names can be stored as a part of user settings.
3603 * \li Syntax: set-color <LYX_NAME> <X11_NAME>
3604 * \li Origin: SLior, 11 Jun 2000
3607 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
3609 * \var lyx::FuncCode lyx::LFUN_STATISTICS
3610 * \li Action: Count the statistics (number of words and characters)
3611 in the document or in the given selection and display it
3613 * \li Notion: Note that this function gives the number of words/chars written,
3614 not the number of characters which will be typeset.
3615 * \li Syntax: statistics
3616 * \li Origin: lasgouttes, Jan 27 2004; sanda, Jan 8 2008
3619 { LFUN_STATISTICS, "statistics", ReadOnly, System },
3621 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_STATISTICS
3622 * \li Action: Returns the statistics (number of words and characters)
3623 in the document or in the given selection.
3624 * \li Notion: Note that this function gives the number of words/chars written,
3625 not the number of characters which will be typeset.
3626 * \li Syntax: server-get-statistics [<TYPE>]
3627 * \li Params: <TYPE>: <words|chars|chars-space> The requested count; if not
3628 specified, the three values are returned, separated
3630 words: count words.\n
3631 chars: count characters.\n
3632 chars-space: count characters and spaces.
3633 * \li Origin: brokenclock, Oct 10 2014
3636 { LFUN_SERVER_GET_STATISTICS, "server-get-statistics", ReadOnly, System },
3638 * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
3639 * \li Action: Show the inline completion at the cursor position.
3640 * \li Syntax: completion-inline
3641 * \li Origin: sts, Feb 19 2008
3644 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
3646 * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
3647 * \li Action: Show the completion popup at the cursor position.
3648 * \li Syntax: completion-popup
3649 * \li Origin: sts, Feb 19 2008
3652 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
3654 * \var lyx::FuncCode lyx::LFUN_COMPLETE
3655 * \li Action: Try to complete the word or command at the cursor position.
3656 * \li Syntax: complete
3657 * \li Origin: sts, Feb 19 2008
3660 { LFUN_COMPLETE, "complete", SingleParUpdate, Edit },
3663 * \var lyx::FuncCode lyx::LFUN_COMPLETION_CANCEL
3664 * \li Action: Try to cancel completion, either the popup or the inline completion.
3665 * \li Syntax: completion-cancel
3666 * \li Origin: sts, Sep 07 2008
3669 { LFUN_COMPLETION_CANCEL, "completion-cancel", SingleParUpdate, Edit },
3671 * \var lyx::FuncCode lyx::LFUN_COMPLETION_ACCEPT
3672 * \li Action: Accept suggested completion.
3673 * \li Syntax: completion-accept
3674 * \li Origin: sanda, Sep 08 2008
3677 { LFUN_COMPLETION_ACCEPT, "completion-accept", SingleParUpdate, Edit },
3681 * \var lyx::FuncCode lyx::LFUN_BRANCH_ADD
3682 * \li Action: Add a branch to the buffer's BranchList.
3683 * \li Syntax: branch-add <BRANCH>
3684 * \li Params: <BRANCH>: Name of the branch to add
3685 * \li Origin: spitz, 7 Jul 2009
3688 { LFUN_BRANCH_ADD, "branch-add", AtPoint, Buffer },
3692 * \var lyx::FuncCode lyx::LFUN_BRANCH_INVERT
3693 * \li Action: Toggles inversion status of branch inset.
3694 * \li Syntax: branch-invert
3695 * \li Origin: rgheck, 12 July 2016
3698 { LFUN_BRANCH_INVERT, "branch-invert", AtPoint, Buffer },
3701 * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
3702 * \li Action: Activate the branch.
3703 * \li Syntax: branch-activate <BRANCH>
3704 * \li Params: <BRANCH>: The branch to activate
3705 * \li Sample: lyx -x "branch-activate answers" -e pdf2 finalexam.lyx \n
3706 could be used to export a pdf with the answers branch included
3707 without one's having to open LyX and activate the branch manually.
3708 * \li Origin: rgh, 27 May 2008
3711 { LFUN_BRANCH_ACTIVATE, "branch-activate", AtPoint, Buffer },
3713 * \var lyx::FuncCode lyx::LFUN_BRANCH_DEACTIVATE
3714 * \li Action: De-activate the branch.
3715 * \li Syntax: branch-deactivate <BRANCH>
3716 * \li Params: <BRANCH>: The branch to deactivate
3717 * \li Origin: rgh, 27 May 2008
3720 { LFUN_BRANCH_DEACTIVATE, "branch-deactivate", AtPoint, Buffer },
3722 * \var lyx::FuncCode lyx::LFUN_BRANCH_MASTER_ACTIVATE
3723 * \li Action: Activate the branch in the master buffer.
3724 * \li Syntax: branch-master-activate <BRANCH>
3725 * \li Params: <BRANCH>: The branch to activate
3726 * \li Sample: lyx -x "branch-activate answers" -e pdf2 finalexam.lyx \n
3727 could be used to export a pdf with the answers branch included
3728 without one's having to open LyX and activate the branch manually.
3729 * \li Origin: spitz, 30 Sep 2012
3732 { LFUN_BRANCH_MASTER_ACTIVATE, "branch-master-activate", AtPoint, Buffer },
3734 * \var lyx::FuncCode lyx::LFUN_BRANCH_MASTER_DEACTIVATE
3735 * \li Action: De-activate the branch in the master buffer.
3736 * \li Syntax: branch-master-deactivate <BRANCH>
3737 * \li Params: <BRANCH>: The branch to deactivate
3738 * \li Origin: spitz, 30 Sep 2012
3741 { LFUN_BRANCH_MASTER_DEACTIVATE, "branch-master-deactivate", AtPoint, Buffer },
3744 * \var lyx::FuncCode lyx::LFUN_BRANCHES_RENAME
3745 * \li Action: Rename all branches of a given name in a document.
3746 * \li Syntax: branches-rename <OLDNAME> <NEWNAME>
3747 * \li Params: <OLDNAME>: Current name of the branch to be renamed
3748 * <NEWNAME>: New name of the branch
3749 * \li Origin: spitz, 9 Jul 2009
3752 { LFUN_BRANCHES_RENAME, "branches-rename", Noop, Buffer },
3754 * \var lyx::FuncCode lyx::LFUN_BRANCH_ADD_INSERT
3755 * \li Action: Create new branch and directly put the branch inset into
3757 * \li Syntax: branch-add-insert [<NAME>]
3758 * \li Params: <NAME>: Branch name. If it is not specified, you will be asked.
3759 * \li Origin: sanda, 10 Jul 2009
3762 { LFUN_BRANCH_ADD_INSERT, "branch-add-insert", Noop, Buffer },
3766 * \var lyx::FuncCode lyx::LFUN_LABEL_COPY_AS_REF
3767 * \li Action: Copies the label at the cursor as a cross-reference to be pasted elsewhere.
3768 * \li Syntax: copy-label-as-reference <LABEL>
3769 * \li Params: <LABEL>: The label to copy (for multi-line math)
3770 * \li Origin: sts, 16 Nov 2008
3773 { LFUN_LABEL_COPY_AS_REFERENCE, "label-copy-as-reference",
3774 ReadOnly | NoUpdate | AtPoint, Edit },
3777 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT_AS_REFERENCE
3778 * \li Action: Inserts the label (in ToC pane) as a cross-reference at the position of the cursor.
3779 * \li Syntax: label-insert-as-reference
3780 * \li Origin: vfr, 7 Apr 2009
3783 { LFUN_LABEL_INSERT_AS_REFERENCE, "label-insert-as-reference", Noop, Edit},
3786 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_IN
3787 * \li Action: Increases the zoom of the screen fonts.
3788 * \li Syntax: buffer-zoom-in [<ZOOM>]
3789 * \li Params: <ZOOM>: The zoom in % points (neg. or pos.), the default is 20.
3790 * \li Origin: vfr, 30 Mar 2009
3793 { LFUN_BUFFER_ZOOM_IN, "buffer-zoom-in", ReadOnly, Buffer },
3796 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_OUT
3797 * \li Action: Decreases the zoom of the screen fonts.
3798 * \li Syntax: buffer-zoom-out [<ZOOM>]
3799 * \li Params: <ZOOM>: The zoom in % points (neg. or pos.), the default is -20.
3800 * \li Origin: vfr, 30 Mar 2009
3803 { LFUN_BUFFER_ZOOM_OUT, "buffer-zoom-out", ReadOnly, Buffer },
3806 * \var lyx::FuncCode lyx::LFUN_INSET_COPY_AS
3807 * \li Action: Copies the inset to the clipboard as a certain type.
3808 * \li Notion: Currently used only for InsetInfo where its content is copied as a text.
3809 * \li Syntax: inset-copy-as
3810 * \li Origin: vfr, 18 Apr 2010
3813 { LFUN_INSET_COPY_AS, "inset-copy-as", ReadOnly | NoUpdate | AtPoint, Edit },
3816 * \var lyx::FuncCode lyx::LFUN_ENVIRONMENT_SPLIT
3817 * \li Action: Splits the current environment with a Separator.
3818 * \li Syntax: environment-split [outer]
3819 * \li Params: outer: If this is given, LyX will split the outermost environment in
3820 * the current nesting hierarchy.
3821 * \li Origin: spitz, 23 Dec 2012
3824 { LFUN_ENVIRONMENT_SPLIT, "environment-split", Noop, Layout },
3826 { LFUN_NOACTION, "", Noop, Hidden }
3827 #ifndef DOXYGEN_SHOULD_SKIP_THIS
3830 for (int i = 0; items[i].action != LFUN_NOACTION; ++i)
3831 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
3837 LyXAction::LyXAction()
3843 FuncRequest LyXAction::lookupFunc(string const & func) const
3845 string const func2 = trim(func);
3848 return FuncRequest(LFUN_NOACTION);
3851 string const arg = split(func2, cmd, ' ');
3853 FuncMap::const_iterator const fit = lyx_func_map.find(cmd);
3855 return fit != lyx_func_map.end()
3856 ? FuncRequest(fit->second, arg)
3857 : FuncRequest(LFUN_UNKNOWN_ACTION);
3861 string const LyXAction::getActionName(FuncCode action) const
3863 InfoMap::const_iterator const it = lyx_info_map.find(action);
3864 return it != lyx_info_map.end() ? it->second.name : string();
3868 LyXAction::FuncType LyXAction::getActionType(FuncCode action) const
3870 InfoMap::const_iterator const it = lyx_info_map.find(action);
3871 return it != lyx_info_map.end() ? it->second.type : Hidden;
3875 bool LyXAction::funcHasFlag(FuncCode action,
3876 LyXAction::FuncAttribs flag) const
3878 InfoMap::const_iterator ici = lyx_info_map.find(action);
3880 if (ici == lyx_info_map.end()) {
3881 LYXERR0("action: " << action << " is not known.");
3882 LASSERT(false, return false);
3885 return ici->second.attrib & flag;
3889 LyXAction::const_iterator LyXAction::func_begin() const
3891 return lyx_func_map.begin();
3895 LyXAction::const_iterator LyXAction::func_end() const
3897 return lyx_func_map.end();
3901 LyXErr & operator<<(LyXErr & l, FuncCode code)
3904 l.stream() << lyxaction.getActionName(code);