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 [<TYPE>] [<SIDE>] [<LANG>]
407 * \li Params: <TYPE>: 'single' for single quotes, otherwise double quotes will be used.
408 * <SIDE>: 'left' for opening quotes, 'right' for closing quotes, otherwise
409 * the side will be guessed from the context.
410 * <STYLE>: 'english' for ``English'' quote style
411 * 'swedish' for ''Swedish'' quote style
412 * 'german' for ,,German`` quote style
413 * 'polish' for ,,Polish'' quote style
414 * 'french' for <<French>> quote style
415 * 'danish' for >>Danish<< quote style
416 * If no quote style is specified, the document-wide will be used.
419 { LFUN_QUOTE_INSERT, "quote-insert", Noop, Edit },
421 * \var lyx::FuncCode lyx::LFUN_INFO_INSERT
422 * \li Action: Displays shortcuts, lyxrc, package and textclass availability and menu
423 information in a non-editable boxed InsetText.
424 * \li Notion: Apart from lfun arguments you can use the following method: \n
425 1. input the type and argument of this inset, e.g. "menu paste", in
427 2. select the text and run info-insert lfun.
428 * \li Syntax: info-insert <TYPE> <ARG>
429 * \li Params: <TYPE>: shortcut[s]|lyxrc|lyxinfo|package|textclass|menu|buffer \n
430 <ARG>: argument for a given type. Look into InsetInfo.h for detailed
432 shortcut[s]: name of lfun (e.g math-insert \alpha) \n
433 lyxrc: name of rc_entry (e.g. bind_file) \n
434 lyxinfo: "version" - used version of LyX \n
435 package: name of latex package (e.g. listings) \n
436 textclass: name of textclass (e.g. article) \n
437 menu: name of lfun used in menu \n
438 icon: icon of lfun used in toolbar or direct icon name\n
439 buffer: "name"|"path"|"class"|"vcs-tree-revision"|
440 "vcs-revision"|"vcs-author"|"vcs-date"|"vcs-time"
441 * \li Sample: command-sequence info-insert buffer path; info-insert buffer name
442 * \li Origin: bpeng, 7 Oct 2007
445 { LFUN_INFO_INSERT, "info-insert", Noop, Edit },
447 * \var lyx::FuncCode lyx::LFUN_BRANCH_INSERT
448 * \li Action: Inserts branch inset.
449 * \li Syntax: branch-insert <BRANCH-NAME>
450 * \li Origin: vermeer, 17 Aug 2003
453 { LFUN_BRANCH_INSERT, "branch-insert", Noop, Edit },
455 * \var lyx::FuncCode lyx::LFUN_BOX_INSERT
456 * \li Action: Inserts Box inset.
457 * \li Syntax: box-insert [<TYPE>]
458 * \li Params: <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox \n
459 Framed is the default one.
460 * \li Origin: vermeer, 7 Oct 2003
463 { LFUN_BOX_INSERT, "box-insert", Noop, Edit },
465 * \var lyx::FuncCode lyx::LFUN_FLEX_INSERT
466 * \li Action: Inserts CharStyle, Custom inset or XML short element.
467 * \li Notion: Look into the Customization manual for more information about
469 To make this command enabled the layout file for the document
470 class you're using has to load the character styles. There are
471 a few contained in the Logical Markup module. You can also of
472 course create some yourself. \n
473 For dissolving the element see #LFUN_INSET_DISSOLVE.
474 * \li Syntax: flex-insert Name
475 * \li Params: Name: This name must be defined either in your layout file
476 or imported by some module. The definition is
477 InsetLayout Name or InsetLayout <Flex:Name>. The Flex:
479 * \li Sample: flex-insert Code
482 { LFUN_FLEX_INSERT, "flex-insert", Noop, Edit },
484 * \var lyx::FuncCode lyx::LFUN_SELF_INSERT
485 * \li Action: Inserts the given string (accordingly to the correct keymap).
486 * \li Notion: Automatically replace the currently selected text. Depends on lyxrc
487 settings "auto_region_delete".
488 * \li Syntax: self-insert <STRING>
491 { LFUN_SELF_INSERT, "self-insert", SingleParUpdate, Hidden },
493 * \var lyx::FuncCode lyx::LFUN_SPACE_INSERT
494 * \li Action: Inserts one of horizontal space insets.
495 * \li Syntax: space-insert <NAME> [<LEN>]
496 * \li Params: <NAME>: normal, protected, visible, thin, quad, qquad, enspace,
497 enskip, negthinspace, negmedspace, negthickspace, hfill,
498 hfill*, dotfill, hrulefill, hspace, hspace* \n
499 Only in math mode: med and thick.\n
500 <LEN>: length for custom spaces (hspace, hspace* for protected)
501 * \li Origin: JSpitzm, 20 May 2003, Mar 17 2008
504 { LFUN_SPACE_INSERT, "space-insert", Noop, Edit },
506 * \var lyx::FuncCode lyx::LFUN_HREF_INSERT
507 * \li Action: Inserts hyperlinks into the document (clickable in pdf output).
508 * \li Notion: Hyperlink target can be set via selection + hyperlink-insert function.
509 * \li Syntax: href-insert [<TARGET>]
510 * \li Origin: CFO-G, 21 Nov 1997
513 { LFUN_HREF_INSERT, "href-insert", Noop, Edit },
515 * \var lyx::FuncCode lyx::LFUN_SPECIALCHAR_INSERT
516 * \li Action: Inserts various characters into the document.
517 * \li Syntax: specialchar-insert <CHAR>
518 * \li Params: <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots,
519 end-of-sentence, menu-separator, lyx, tex, latex, latex2e.
520 * \li Origin: JSpitzm, 6 Dec 2007
523 { LFUN_SPECIALCHAR_INSERT, "specialchar-insert", Noop, Edit },
525 * \var lyx::FuncCode lyx::LFUN_SCRIPT_INSERT
526 * \li Action: Inserts a subscript or superscript inset.
527 * \li Syntax: script-insert <TYPE>
528 * \li Params: <TYPE>: subscript|superscript
529 * \li Origin: Georg, 23 Nov 2010
532 { LFUN_SCRIPT_INSERT, "script-insert", Noop, Edit },
534 * \var lyx::FuncCode lyx::LFUN_APPENDIX
535 * \li Action: Start (or remove) Appendix on the given cursor position.
536 * \li Syntax: appendix
537 * \li Origin: ettrich, 5 May 1998
540 { LFUN_APPENDIX, "appendix", Noop, Edit },
543 * \var lyx::FuncCode lyx::LFUN_INDEX_INSERT
544 * \li Action: Inserts Index entry.
545 * \li Notion: It automatically takes the word on the cursor position.
546 * \li Syntax: index-insert [<TYPE:Name>]
547 * \li Params: <TYPE:Name>: name of the index, if multiple indices are defined.
548 With an empty argument, the default index is selected.
549 * \li Origin: leeming, 3 Aug 2000
552 { LFUN_INDEX_INSERT, "index-insert", Noop, Edit },
554 * \var lyx::FuncCode lyx::LFUN_INDEX_PRINT
555 * \li Action: Inserts list of Index entries on a new page.
556 * \li Syntax: index-print [<TYPE:Name>]
557 * \li Params: <TYPE:Name>: name of the index, if multiple indices are defined.
558 With an empty argument, the default index is selected.
559 * \li Origin: Lgb, 27 Feb 1997
562 { LFUN_INDEX_PRINT, "index-print", Noop, Edit },
564 * \var lyx::FuncCode lyx::LFUN_IPA_INSERT
565 * \li Action: Inserts an IPA inset.
566 * \li Syntax: ipa-insert
567 * \li Origin: spitz, 05 Mar 2012
570 { LFUN_IPA_INSERT, "ipa-insert", Noop, Edit },
572 * \var lyx::FuncCode lyx::LFUN_IN_IPA
573 * \li Action: Only active in IPA inset.
574 * \li Notion: Dummy function which is only active in a IPA inset.
575 It's used to toggle the IPA toolbar if the cursor moves
578 * \li Origin: spitz, 20 May 2012
581 { LFUN_IN_IPA, "in-ipa", Noop, Edit },
583 * \var lyx::FuncCode lyx::LFUN_IPAMACRO_INSERT
584 * \li Action: Inserts special IPA macros into the document.
585 * \li Syntax: ipamacro-insert <CHAR>
586 * \li Params: <CHAR>: tone-falling, tone-rising, tone-high-rising, tone-low-rising,
587 * tone-high-rising-falling, deco bottomtiebar, deco toptiebar.
588 * \li Origin: JSpitzm, 22 Aug 2012
591 { LFUN_IPAMACRO_INSERT, "ipamacro-insert", Noop, Edit },
593 * \var lyx::FuncCode lyx::LFUN_NOMENCL_INSERT
594 * \li Action: Inserts Nomenclature entry.
595 * \li Notion: It automatically takes the word on the cursor position if no symbol is given.
596 * \li Syntax: nomencl-insert [<SYMBOL>]
597 * \li Origin: Ugras, 4 Nov 2006
600 { LFUN_NOMENCL_INSERT, "nomencl-insert", Noop, Edit },
602 * \var lyx::FuncCode lyx::LFUN_NOMENCLATURE_PRINT
603 * \li Action: Inserts list of Nomenclature entries.
604 * \li Syntax: nomenclature-print
605 * \li Origin: Ugras, 4 Nov 2006
608 { LFUN_NOMENCL_PRINT, "nomencl-print", Noop, Edit },
611 * \var lyx::FuncCode lyx::LFUN_NOTE_INSERT
612 * \li Action: Inserts Note on the current cursor position,
613 move selection inside the inset.
614 * \li Syntax: note-insert [<TYPE>]
615 * \li Params: <TYPE>: <Note|Greyedout|Comment> default: Note
618 { LFUN_NOTE_INSERT, "note-insert", Noop, Edit },
620 * \var lyx::FuncCode lyx::LFUN_NOTE_NEXT
621 * \li Action: Moves the cursor to the beginning of next Note inset.
622 * \li Syntax: note-next
625 { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
627 * \var lyx::FuncCode lyx::LFUN_PHANTOM_INSERT
628 * \li Action: Inserts phantom on the current cursor position,
629 move selection inside the inset.
630 * \li Syntax: phantom-insert [<TYPE>]
631 * \li Params: <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
632 * \li Origin: uwestoehr, 30 Jan 2009
635 { LFUN_PHANTOM_INSERT, "phantom-insert", Noop, Edit },
637 * \var lyx::FuncCode lyx::LFUN_NEWLINE_INSERT
638 * \li Action: Inserts a line break or new line.
639 * \li Syntax: newline-insert [<ARG>]
640 * \li Params: <ARG>: <newline|linebreak> default: newline
641 * \li Origin: JSpitzm, 25 Mar 2008
644 { LFUN_NEWLINE_INSERT, "newline-insert", Noop, Edit },
646 * \var lyx::FuncCode lyx::LFUN_SEPARATOR_INSERT
647 * \li Action: Inserts an environment separator or latex paragraph break.
648 * \li Syntax: separator-insert [<ARG>]
649 * \li Params: <ARG>: <plain|parbreak|latexpar> default: plain
650 * \li Origin: ef, 2 May 2014
653 { LFUN_SEPARATOR_INSERT, "separator-insert", Noop, Edit },
655 * \var lyx::FuncCode lyx::LFUN_ESCAPE
656 * \li Action: Clears the selection. If no text is selected call #LFUN_FINISHED_FORWARD.
657 Inside math mode jumps out of the math inset.
659 * \li Origin: Lgb, 17 May 2001
662 { LFUN_ESCAPE, "escape", ReadOnly, Edit },
664 * \var lyx::FuncCode lyx::LFUN_DOWN
665 * \li Action: Moves the cursor one line in downward direction.
669 { LFUN_DOWN, "down", ReadOnly | NoUpdate, Edit },
671 * \var lyx::FuncCode lyx::LFUN_UP
672 * \li Action: Moves the cursor one line in upward direction.
676 { LFUN_UP, "up", ReadOnly | NoUpdate, Edit },
678 * \var lyx::FuncCode lyx::LFUN_DOWN_SELECT
679 * \li Action: Moves the cursor one line in downward direction adding the current
680 position to the selection.
681 * \li Syntax: down-select
684 { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, Edit },
686 * \var lyx::FuncCode lyx::LFUN_UP_SELECT
687 * \li Action: Moves the cursor one line in upward direction adding the current
688 position to the selection.
689 * \li Syntax: up-select
692 { LFUN_UP_SELECT, "up-select", ReadOnly | SingleParUpdate, Edit },
694 * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN
695 * \li Action: Moves the cursor one page in downward direction.
696 * \li Syntax: screen-down
699 { LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit },
701 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP
702 * \li Action: Moves the cursor one page in upward direction.
703 * \li Syntax: screen-up
706 { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit },
708 * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN_SELECT
709 * \li Action: Moves the cursor one screen in downward direction adding the current
710 position to the selection.
711 * \li Syntax: screen-down-select
714 { LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit },
716 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP_SELECT
717 * \li Action: Moves the cursor one page in upward direction adding the current
718 position to the selection.
719 * \li Syntax: screen-up-select
722 { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit },
724 * \var lyx::FuncCode lyx::LFUN_SCROLL
725 * \li Action: Scroll the buffer view.
726 * \li Notion: Only scrolls the screen up or down; does not move the cursor.
727 * \li Syntax: scroll <TYPE> <QUANTITY>
728 * \li Params: <TYPE>: line|page\n
729 <QUANTITY>: up|down|<number>
730 * \li Origin: Abdel, Dec 27 2007
733 { LFUN_SCROLL, "scroll", ReadOnly, Edit },
735 * \var lyx::FuncCode lyx::LFUN_SCREEN_RECENTER
736 * \li Action: Recenters the screen on the current cursor position.
737 * \li Syntax: screen-recenter
740 { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit },
743 * \var lyx::FuncCode lyx::LFUN_SCREEN_SHOW_CURSOR
744 * \li Action: Repositions the screen such that the cursor is visible.
745 * \li Syntax: screen-show-cursor
746 * \li Origin: vfr, 25 Mar 2009
749 { LFUN_SCREEN_SHOW_CURSOR, "screen-show-cursor", ReadOnly, Edit },
752 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD
753 * \li Action: Moves the cursor one position logically backwards.
754 * \li Notion: This is not the action which should be bound to the arrow keys,
755 because backwards may be left or right, depending on the
756 language. The arrow keys should be bound to #LFUN_CHAR_LEFT or
757 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
758 * \li Syntax: char-backward
761 { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit },
763 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD_SELECT
764 * \li Action: Moves the cursor one position logically backwards, adding
765 traversed position to the selection.
766 * \li Notion: See also #LFUN_CHAR_BACKWARD.
767 * \li Syntax: char-backward-select
770 { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit },
772 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_BACKWARD
773 * \li Action: Deletes one character in the backward direction (usually the "BackSpace" key).
774 * \li Syntax: char-delete-backward
777 { LFUN_CHAR_DELETE_BACKWARD, "char-delete-backward", SingleParUpdate, Edit },
779 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_FORWARD
780 * \li Action: Deletes one character in the backward direction (usually the "Delete" key).
781 * \li Syntax: char-delete-forward
784 { LFUN_CHAR_DELETE_FORWARD, "char-delete-forward", SingleParUpdate, Edit },
786 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD
787 * \li Action: Moves the cursor one position logically forward.
788 * \li Notion: This is not the action which should be bound to the arrow keys,
789 because forward may be left or right, depending on the language.
790 The arrow keys should be bound to #LFUN_CHAR_LEFT or
791 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
792 * \li Syntax: char-forward
795 { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit },
797 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD_SELECT
798 * \li Action: Moves the cursor one position logically forward, adding
799 traversed position to the selection.
800 * \li Notion: See also #LFUN_CHAR_FORWARD.
801 * \li Syntax: char-forward-select
804 { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit },
806 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT
807 * \li Action: Moves the cursor one position "to the left".
808 * \li Notion: This is the action which should be taken when the "left" key
809 is pressed. Generally, it moves the cursor one position to the
810 left. However, in Bidi text this become slightly more
811 complicated, and there are different modes of cursor movement.
812 In "visual mode", this moves left, plain and simple. In "logical
813 mode", movement is logically forward in RTL paragraphs, and
814 logically backwards in LTR paragraphs.
815 * \li Syntax: char-left
818 { LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit },
820 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT_SELECT
821 * \li Action: Moves the cursor one position "to the left", adding
822 traversed position to the selection.
823 * \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement.
824 * \li Syntax: char-left-select
827 { LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit },
829 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT
830 * \li Action: Moves the cursor one position "to the right".
831 * \li Notion: This is the action which should be taken when the "right" key
832 is pressed. Generally, it moves the cursor one position to the
833 right. However, in Bidi text this become slightly more
834 complicated, and there are different modes of cursor movement.
835 In "visual mode", this moves right, plain and simple. In "logical
836 mode", movement is logically forward in LTR paragraphs, and
837 logically backwards in RTL paragraphs.
838 * \li Syntax: char-right
841 { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit },
843 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT_SELECT
844 * \li Action: Moves the cursor one position "to the right", adding
845 traversed position to the selection.
846 * \li Notion: See also #LFUN_CHAR_RIGHT for exact details of the movement.
847 * \li Syntax: char-right-select
850 { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit },
853 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD
854 * \li Action: Moves the cursor to the logically previous beginning of a word.
855 * \li Notion: This is not the action which should be bound to the arrow keys,
856 because backwards may be left or right, depending on the
857 language. The arrow keys should be bound to #LFUN_WORD_LEFT or
858 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
859 * \li Syntax: word-backward
862 { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit },
864 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD_SELECT
865 * \li Action: Moves the cursor to the logically previous beginning of a word,
866 adding the logically traversed text to the selection.
867 * \li Notion: See also #LFUN_WORD_BACKWARD.
868 * \li Syntax: word-backward-select
871 { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
873 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_BACKWARD
874 * \li Action: Deletes characters to the beginning of the word (usually the "C+BackSpace" key).
875 * \li Syntax: word-delete-backward
878 { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
880 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_FORWARD
881 * \li Action: Deletes characters to the end of the word (usually the "C+Delete" key).
882 * \li Syntax: word-delete-forward
885 { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
887 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_FORWARD
888 * \li Action: Search for a given string in forward direction.
889 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
890 * \li Syntax: word-find-forward [<STRING>]
891 * \li Origin: Etienne, 16 Feb 1998
894 { LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit },
896 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_BACKWARD
897 * \li Action: Search for a given string in backward direction.
898 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
899 * \li Syntax: word-find-backward [<STRING>]
900 * \li Origin: Etienne, 20 Feb 1998
903 { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
905 * \var lyx::FuncCode lyx::LFUN_WORD_FIND
906 * \li Action: Search for next occurrence of a string.
907 * \li Syntax: word-find [<DATA>]
908 * \li Params: <DATA>: data encoded from Find dialog (see #lyx::find2string()).
909 If no parameter is given, search with last find-dialog
910 data is used for search (i.e. find-next).
911 * \li Origin: Andre, Jan 7 2004
914 { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
916 * \var lyx::FuncCode lyx::LFUN_WORD_REPLACE
917 * \li Action: Replace a string in the document.
918 * \li Syntax: word-replace [<DATA>]
919 * \li Params: <DATA>: data is of the form
922 <casesensitive> <matchword> <all> <forward> <findnext>"
923 * \li Origin: Andre, Jan 7 2004
926 { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
928 * \var lyx::FuncCode lyx::LFUN_WORD_FINDADV
929 * \li Action: Search for next occurrence of a pattern.
930 * \li Syntax: word-findadv [<DATA>]
931 * \li Params: <DATA>: data encoded from FindAdv dialog (see #lyx::findadv2string()).
932 If no parameter is given, search with last find-dialog
933 data is used for search (i.e. find-next).
934 * \li Origin: Tommaso, Nov 15 2007
937 { LFUN_WORD_FINDADV, "word-findadv", ReadOnly | NoBuffer, Edit },
939 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD
940 * \li Action: Moves the cursor to the logically next beginning of a word.
941 * \li Notion: This is not the action which should be bound to the arrow keys,
942 because forward may be left or right, depending on the language.
943 The arrow keys should be bound to #LFUN_WORD_LEFT or
944 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
945 * \li Syntax: word-forward
948 { LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
950 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD_SELECT
951 * \li Action: Moves the cursor to the logically next beginning of a word,
952 adding the logically traversed text to the selection.
953 * \li Notion: See also #LFUN_WORD_FORWARD.
954 * \li Syntax: word-forward-select
957 { LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
959 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT
960 * \li Action: Moves the cursor to the next beginning of a word "on the left".
961 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
962 "left" key is pressed. Generally, it moves the cursor to the
963 next beginning of a word on the left. However, in Bidi text this
964 become slightly more complicated, and there are different modes
965 of cursor movement. In "visual mode", this moves left, plain and
966 simple. In "logical mode", movement is logically forward in RTL
967 paragraphs, and logically backwards in LTR paragraphs.
968 * \li Syntax: word-left
969 * \li Origin: dov, 28 Oct 2007
972 { LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
974 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT_SELECT
975 * \li Action: Moves the cursor to the next beginning of a word "on the left",
976 adding *logically* traversed text to the selection.
977 * \li Notion: See also #LFUN_WORD_LEFT for exact details of the movement.
978 * \li Syntax: word-left-select
979 * \li Origin: dov, 28 Oct 2007
982 { LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit },
984 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT
985 * \li Action: Moves the cursor to the next beginning of a word "on the right".
986 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
987 "right" key is pressed. Generally, it moves the cursor to the
988 next beginning of a word on the right. However, in Bidi text
989 this become slightly more complicated, and there are different
990 modes of cursor movement. In "visual mode", this moves right,
991 plain and simple. In "logical mode", movement is logically
992 forward in LTR paragraphs, and logically backwards in RTL
994 * \li Syntax: word-right
995 * \li Origin: dov, 28 Oct 2007
998 { LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit },
1000 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT_SELECT
1001 * \li Action: Moves the cursor to the next beginning of a word "on the right",
1002 adding *logically* traversed text to the selection.
1003 * \li Notion: See also #LFUN_WORD_RIGHT for exact details of the movement.
1004 * \li Syntax: word-right-select
1005 * \li Origin: dov, 28 Oct 2007
1008 { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
1010 * \var lyx::FuncCode lyx::LFUN_WORD_SELECT
1011 * \li Action: Puts the word where the cursor stands into the selection.
1012 * \li Syntax: word-select
1013 * \li Origin: Andre, 11 Sep 2002
1016 { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
1018 * \var lyx::FuncCode lyx::LFUN_WORD_CAPITALIZE
1019 * \li Action: Capitalizes the words in the selection (i.e. the first letters)
1020 or the first letter of word at cursor position.
1021 * \li Syntax: word-capitalize [<SEL_TYPE>]
1022 * \li Params: <SEL_TYPE>: if this is equal to "partial", then the
1023 * default word starts at cursor position (emacs-style).
1024 * Otherwise, the whole word is considered.
1027 { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
1029 * \var lyx::FuncCode lyx::LFUN_WORD_UPCASE
1030 * \li Action: Change the words in the selection or word at cursor position
1032 * \li Syntax: word-upcase [<SEL_TYPE>]
1033 * \li Params: <SEL_TYPE>: if this is equal to "partial", then the
1034 * default word starts at cursor position (emacs-style).
1035 * Otherwise, the whole word is considered.
1038 { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
1040 * \var lyx::FuncCode lyx::LFUN_WORD_LOWCASE
1041 * \li Action: Change the words in the selection or word at cursor position
1043 * \li Syntax: word-lowcase [<SEL_TYPE>]
1044 * \li Params: <SEL_TYPE>: if this is equal to "partial", then the
1045 * default word starts at cursor position (emacs-style).
1046 * Otherwise, the whole word is considered.
1049 { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
1051 * \var lyx::FuncCode lyx::LFUN_SPELLING_ADD
1052 * \li Action: Add the word under the cursor to the respective
1053 * spell checker dictionary.
1054 * The default for the language is retrieved from the cursor position.
1055 * \li Syntax: spelling-add [<STRING>] [<LANG>]
1056 * \li Params: <WORD>: word to add
1057 <LANG>: language name (see file languages)
1058 * \li Origin: JSpitzm, 18 Jan 2010
1061 { LFUN_SPELLING_ADD, "spelling-add", ReadOnly, Edit },
1063 * \var lyx::FuncCode lyx::LFUN_SPELLING_IGNORE
1064 * \li Action: Let the spell checker ignore the word under the cursor
1065 * in the current session for the given language.
1066 * The default for the language is retrieved from the cursor position.
1067 * \li Syntax: spelling-ignore [<WORD>] [<LANG>]
1068 * \li Params: <WORD>: word to ignore
1069 <LANG>: language name (see file languages)
1070 * \li Origin: JSpitzm, 18 Jan 2010
1073 { LFUN_SPELLING_IGNORE, "spelling-ignore", ReadOnly, Edit },
1075 * \var lyx::FuncCode lyx::LFUN_SPELLING_REMOVE
1076 * \li Action: Remove the word under the cursor from the respective
1077 * spell checker dictionary.
1078 * The default for the language is retrieved from the cursor position.
1079 * \li Syntax: spelling-remove [<STRING>] [<LANG>]
1080 * \li Params: <WORD>: word to remove
1081 * <LANG>: language name (see file languages)
1082 * \li Origin: SWitt, 28 July 2010
1085 { LFUN_SPELLING_REMOVE, "spelling-remove", ReadOnly, Edit },
1088 * \var lyx::FuncCode lyx::LFUN_SPELLING_CONTINUOUSLY
1089 * \li Action: Toggle continuous spell checking.
1090 * \li Syntax: spelling-continuously
1091 * \li Origin: vfr, 24 March 2013
1094 { LFUN_SPELLING_CONTINUOUSLY, "spelling-continuously", ReadOnly, Edit },
1097 * \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
1098 * \li Action: Look up thesaurus entries with respect to the word under the cursor.
1099 * \li Syntax: thesaurus-entry [<STRING>] [lang=<LANG>]
1100 * \li Params: <STRING>: word to look up
1101 <LANG>: language (see file languages)
1102 * \li Origin: Levon, 20 Jul 2001
1105 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
1107 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN
1108 * \li Action: Move the cursor to the beginning of the document.
1109 * \li Syntax: buffer-begin
1112 { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
1114 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN_SELECT
1115 * \li Action: Move the cursor to the beginning of the document adding the
1116 traversed text to the selection.
1117 * \li Syntax: buffer-begin-select
1120 { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
1122 * \var lyx::FuncCode lyx::LFUN_BUFFER_END
1123 * \li Action: Move the cursor to the end of the document.
1124 * \li Syntax: buffer-end
1127 { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
1129 * \var lyx::FuncCode lyx::LFUN_BUFFER_END_SELECT
1130 * \li Action: Move the cursor to the end of the document adding the
1131 traversed text to the selection.
1132 * \li Syntax: buffer-end-select
1135 { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
1138 * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN
1139 * \li Action: Move the cursor to the beginning of the current inset
1140 if it is not already there, or at the beginning of the
1141 enclosing inset otherwise
1142 * \li Syntax: inset-begin
1143 * \li Origin: lasgouttes, 16 Mar 2009
1146 { LFUN_INSET_BEGIN, "inset-begin", ReadOnly, Edit },
1148 * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN_SELECT
1149 * \li Action: Move the cursor to the beginning of the current inset
1150 if it is not already there, or at the beginning of the
1151 enclosing inset otherwise (adding the
1152 traversed text to the selection).
1153 * \li Syntax: inset-begin-select
1154 * \li Origin: lasgouttes, 16 Mar 2009
1157 { LFUN_INSET_BEGIN_SELECT, "inset-begin-select", ReadOnly, Edit },
1159 * \var lyx::FuncCode lyx::LFUN_INSET_END
1160 * \li Action: Move the cursor to the end of the current inset
1161 if it is not already there, or at the end of the
1162 enclosing inset otherwise
1163 * \li Syntax: inset-end
1164 * \li Origin: lasgouttes, 16 Mar 2009
1167 { LFUN_INSET_END, "inset-end", ReadOnly, Edit },
1169 * \var lyx::FuncCode lyx::LFUN_INSET_END_SELECT
1170 * \li Action: Move the cursor to the end of the current inset
1171 if it is not already there, or at the end of the
1172 enclosing inset otherwise (adding the
1173 traversed text to the selection).
1174 * \li Syntax: inset-end-select
1175 * \li Origin: lasgouttes, 16 Mar 2009
1178 { LFUN_INSET_END_SELECT, "inset-end-select", ReadOnly, Edit },
1181 * \var lyx::FuncCode lyx::LFUN_INSET_SELECT_ALL
1182 * \li Action: Select all contents of an inset.
1183 * \li Notion: There are 3 successive levels: select current cell,
1184 * select all cells of inset, select the inset from outside
1185 * (in the enclosing inset).
1186 * \li Syntax: inset-select-all
1187 * \li Origin: vfr, 22 Aug 2009; lasgouttes 1 Nov 2014
1190 { LFUN_INSET_SELECT_ALL, "inset-select-all", ReadOnly, Edit },
1193 * \var lyx::FuncCode lyx::LFUN_SECTION_SELECT
1194 * \li Action: Select the whole section.
1195 * \li Notion: The cursor should be in a section heading
1196 before calling this lfun.
1197 * \li Syntax: section-select
1198 * \li Origin: vfr, 05 May 2009
1201 { LFUN_SECTION_SELECT, "section-select", ReadOnly, Edit },
1204 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN
1205 * \li Action: Move the cursor to the beginning of the (screen) line.
1206 * \li Syntax: line-begin
1209 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
1211 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN_SELECT
1212 * \li Action: Move the cursor to the beginning of the (screen) line adding the
1213 traversed text to the selection.
1214 * \li Syntax: line-begin-select
1217 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
1219 * \var lyx::FuncCode lyx::LFUN_LINE_END
1220 * \li Action: Move the cursor to the end of the (screen) line.
1221 * \li Syntax: line-end
1224 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
1226 * \var lyx::FuncCode lyx::LFUN_LINE_END_SELECT
1227 * \li Action: Move the cursor to the end of the (screen) line adding the
1228 traversed text to the selection.
1229 * \li Syntax: line-end-select
1232 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
1234 * \var lyx::FuncCode lyx::LFUN_LINE_DELETE_FORWARD
1235 * \li Action: Deletes the letters to the end of the (screen) line or
1236 deletes the selection.
1237 * \li Syntax: line-delete-forward
1240 { LFUN_LINE_DELETE_FORWARD, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
1242 * \var lyx::FuncCode lyx::LFUN_COPY
1243 * \li Action: Copies the current selection to the clipboard.
1247 { LFUN_COPY, "copy", ReadOnly, Edit },
1249 * \var lyx::FuncCode lyx::LFUN_CUT
1250 * \li Action: Cuts to the clipboard.
1254 { LFUN_CUT, "cut", Noop, Edit },
1256 * \var lyx::FuncCode lyx::LFUN_PASTE
1257 * \li Action: Pastes material (text or picture) from the active clipboard.
1258 * \li Syntax: paste [<TYPE>|<NUM>]
1259 * \li Params: <TYPE>: emf|pdf|png|jpeg|linkback|wmf|latex|html \n
1260 <NUM>: number of the selection in the internal clipboard stack to be pasted.
1263 { LFUN_PASTE, "paste", Noop, Edit },
1265 * \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE
1266 * \li Action: Pastes text from the active clipboard (retains formatting if the
1267 clipboard contains formatted text). Pastes plain text if plain text is
1268 on the clipboard, but tries to interpret it in special ways for certain
1269 insets, e.g. converting csv data to rows and columns if the paste happens
1271 * \li Notion: Historically, LFUN_CLIPBOARD_PASTE was introduced as a counterpart of
1272 LFUN_PRIMARY_SELECTION_PASTE: It behaved exactly the same, but the source
1273 is the clipboard, not the selection.
1274 * \li Syntax: clipboard-paste [<ARG>]
1275 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1276 * \li Origin: Georg, 10 Jul 2006
1279 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
1281 * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
1282 * \li Action: Pastes the currently selected text.
1283 * \li Notion: Primary selection mechanism is linux-only thing.
1284 * \li Syntax: primary-selection-paste [<ARG>]
1285 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1288 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
1290 * \var lyx::FuncCode lyx::LFUN_SELECTION_PASTE
1291 * \li Action: Pastes the internal selection text in permanent selection.
1292 * \li Notion: Created in order to have middle mouse button pasting correct (bound to
1293 command-alternatives selection-paste ; primary-selection-paste paragraph).
1294 * \li Syntax: selection-paste
1295 * \li Origin: lasgouttes, 14 Jan 2009
1298 { LFUN_SELECTION_PASTE, "selection-paste", Noop, Edit },
1300 * \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE_SIMPLE
1301 * \li Action: Pastes plain text from the active clipboard even if formatted
1302 LyX content is in the clipboard. Pastes plain text if plain text
1303 is on the clipboard, without trying to interpret it in special
1304 ways for certain insets, e.g. converting csv data to rows and
1305 columns if the paste happens in a tabular inset.
1306 * \li Syntax: clipboard-paste-simple [<ARG>]
1307 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1310 { LFUN_CLIPBOARD_PASTE_SIMPLE, "clipboard-paste-simple", Noop, Edit },
1312 * \var lyx::FuncCode lyx::LFUN_UNDO
1313 * \li Action: Undoes the last edit.
1317 { LFUN_UNDO, "undo", ReadOnly, Edit },
1319 * \var lyx::FuncCode lyx::LFUN_REDO
1320 * \li Action: Redoes the last thing undone.
1324 { LFUN_REDO, "redo", ReadOnly, Edit },
1326 * \var lyx::FuncCode lyx::LFUN_REPEAT
1327 * \li Action: Repeat the given command.
1328 * \li Syntax: repeat <COUNT> <LFUN-COMMAND>
1329 * \li Origin: Andre, 27 Oct 2003
1332 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
1334 * \var lyx::FuncCode lyx::LFUN_CHARS_TRANSPOSE
1335 * \li Action: Transposes the character at the cursor with the one before it.
1336 * \li Syntax: chars-transpose
1337 * \li Origin: Lgb, 25 Apr 2001
1340 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
1343 * \var lyx::FuncCode lyx::LFUN_DEPTH_DECREMENT
1344 * \li Action: Decrease the nesting depth of the (selected) paragraph(s)
1346 * \li Syntax: depth-decrement
1349 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
1351 * \var lyx::FuncCode lyx::LFUN_DEPTH_INCREMENT
1352 * \li Action: Increase the nesting depth of the (selected) paragraph(s)
1354 * \li Syntax: depth-increment
1357 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
1360 * \var lyx::FuncCode lyx::LFUN_FONT_BOLD
1361 * \li Action: Toggles the bold font (selection-wise) using mathbf in math.
1362 * \li Syntax: font-bold
1365 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
1368 * \var lyx::FuncCode lyx::LFUN_FONT_BOLDSYMBOL
1369 * \li Action: Toggles the bold font (selection-wise) using boldsymbol in math.
1370 * \li Syntax: font-boldsymbol
1373 { LFUN_FONT_BOLDSYMBOL, "font-boldsymbol", Noop, Layout },
1375 * \var lyx::FuncCode lyx::LFUN_FONT_TYPEWRITER
1376 * \li Action: Toggles the typewriter family font (selection-wise).
1377 * \li Syntax: font-typewriter
1380 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
1382 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERLINE
1383 * \li Action: Toggles underline in the font (selection-wise).
1384 * \li Syntax: font-underline
1387 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
1389 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERUNDERLINE
1390 * \li Action: Toggles double underline in the font (selection-wise).
1391 * \li Syntax: font-underunderline
1392 * \li Origin: sanda, 5 May 2009
1395 { LFUN_FONT_UNDERUNDERLINE, "font-underunderline", Noop, Layout },
1397 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERWAVE
1398 * \li Action: Toggles wavy underline in the font (selection-wise).
1399 * \li Syntax: font-underwave
1400 * \li Origin: sanda, 5 May 2009
1403 { LFUN_FONT_UNDERWAVE, "font-underwave", Noop, Layout },
1405 * \var lyx::FuncCode lyx::LFUN_FONT_STRIKEOUT
1406 * \li Action: Toggles strikeout (strike-through) in the font (selection-wise).
1407 * \li Syntax: font-strikeout
1408 * \li Origin: sanda, 3 May 2009
1411 { LFUN_FONT_STRIKEOUT, "font-strikeout", Noop, Layout },
1413 * \var lyx::FuncCode lyx::LFUN_FONT_EMPH
1414 * \li Action: Toggles the emphasis font style (selection-wise).
1415 * \li Syntax: font-emph
1418 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
1420 * \var lyx::FuncCode lyx::LFUN_FONT_NOUN
1421 * \li Action: Toggles Noun text style font (selection-wise).
1422 * \li Syntax: font-noun
1425 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
1427 * \var lyx::FuncCode lyx::LFUN_FONT_ROMAN
1428 * \li Action: Toggles Roman family font (selection-wise).
1429 * \li Syntax: font-roman
1432 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
1434 * \var lyx::FuncCode lyx::LFUN_FONT_SANS
1435 * \li Action: Toggles Sans Serif family font (selection-wise).
1436 * \li Syntax: font-sans
1439 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
1441 * \var lyx::FuncCode lyx::LFUN_FONT_FRAK
1442 * \li Action: Toggles Fraktur family font (math-mode, selection-wise).
1443 * \li Syntax: font-frak
1444 * \li Origin: vermeer, 10 Jan 2002
1447 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
1449 * \var lyx::FuncCode lyx::LFUN_FONT_ITAL
1450 * \li Action: Toggles Italics font shape (math-mode, selection-wise).
1451 * \li Syntax: font-ital
1452 * \li Origin: vermeer, 10 Jan 2002
1455 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
1457 * \var lyx::FuncCode lyx::LFUN_FONT_DEFAULT
1458 * \li Action: Reverts the settings of the font to the default values (selection-wise).
1459 * \li Syntax: font-default
1462 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
1464 * \var lyx::FuncCode lyx::LFUN_FONT_SIZE
1465 * \li Action: Sets font size according to lyx format string.
1466 * \li Syntax: font-size <SIZE>
1467 * \li Params: <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|\n
1468 largest|huge|giant|increase|decrease|default
1471 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
1473 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_APPLY
1474 * \li Action: Toggle user-defined (=last-time used) text style.
1475 * \li Notion: This style is set via #LFUN_TEXTSTYLE_UPDATE, which is
1476 automatically triggered when using Text Style dialog.
1477 * \li Syntax: textstyle-apply
1478 * \li Origin: leeming, 12 Mar 2003
1481 { LFUN_TEXTSTYLE_APPLY, "textstyle-apply", Noop, Layout },
1483 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_UPDATE
1484 * \li Action: Apply text style and update the settings to be used by #LFUN_TEXTSTYLE_APPLY.
1485 * \li Syntax: textstyle-update <FONT_INFO>
1486 * \li Params: <FONT_INFO>: specifies font atributes, e.g. family, series, shape,
1487 size, emph, noun, underbar, number, color, language,
1489 Use lyx -dbg action for exact syntax of text-style
1491 * \li Origin: leeming, 12 Mar 2003
1494 { LFUN_TEXTSTYLE_UPDATE, "textstyle-update", Noop, Layout },
1496 * \var lyx::FuncCode lyx::LFUN_SCREEN_FONT_UPDATE
1497 * \li Action: Update fonts and its metrics.
1498 * \li Notion: Automatically called after zoom, dpi, font names, or norm change.
1499 * \li Syntax: screen-font-update
1500 * \li Origin: ARRae, 13 Aug 2000
1503 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
1505 * \var lyx::FuncCode lyx::LFUN_FONT_STATE
1506 * \li Action: Returns the info about the current font.
1507 * \li Syntax: font-state
1510 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
1513 * \var lyx::FuncCode lyx::LFUN_CITATION_INSERT
1514 * \li Action: Inserts citation from loaded citation database.
1515 * \li Syntax: citation-insert [<KEY>[|<TEXT_BEFORE>]]
1516 * \li Params: <KEY>: Citation (shortcut listed in available citations). \n
1517 <TEXT_BEFORE>: text which should appear before citation.
1518 * \li Origin: AAS, 97-02-23
1521 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
1523 * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_ADD
1524 * \li Action: Adds database, which will be used for bibtex citations.
1525 * \li Notion: Databases are added to the first BibTeX inset
1526 (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
1527 * \li Syntax: bibtex-database-add <DATABASE-NAME>
1528 * \li Origin: Ale, 30 May 1997
1531 { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit },
1533 * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_DEL
1534 * \li Action: Adds database, which will be used for bibtex citations.
1535 * \li Notion: Databases are deleted from the first BibTeX inset
1536 (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
1537 * \li Syntax: bibtex-database-del <DATABASE-NAME>
1538 * \li Origin: Ale, 30 May 1997
1541 { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
1544 * \var lyx::FuncCode lyx::LFUN_LAYOUT
1545 * \li Action: Sets the layout (that is, environment) for the current paragraph.
1546 * \li Syntax: layout <LAYOUT>
1547 * \li Params: <LAYOUT>: the layout to use
1550 { LFUN_LAYOUT, "layout", Noop, Layout },
1552 * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH
1553 * \li Action: Launches the paragraph settings dialog.
1554 * \li Syntax: layout-paragraph
1557 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
1559 * \var lyx::FuncCode lyx::LFUN_LAYOUT_TABULAR
1560 * \li Action: Launches the tabular settings dialog.
1561 * \li Syntax: layout-tabular
1562 * \li Origin: Jug, 31 Jul 2000
1565 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
1567 * \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE
1568 * \li Action: Displays list of layout choices.
1569 * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
1570 dropbox allowing for choice of layout.
1571 * \li Syntax: drop-layouts-choice
1574 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
1576 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
1577 * \li Action: Clears the module list.
1578 * \li Notion: Clears the list of included modules for the current buffer.
1579 * \li Syntax: layout-modules-clear
1580 * \li Origin: rgh, 25 August 2007
1583 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", NoInternal, Layout },
1585 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULE_ADD
1586 * \li Action: Adds a module.
1587 * \li Notion: Adds a module to the list of included modules for the current buffer.
1588 * \li Syntax: layout-module-add <MODULE>
1589 * \li Params: <MODULE>: the module to be added
1590 * \li Origin: rgh, 25 August 2007
1593 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", NoInternal, Layout },
1595 * \var lyx::FuncCode lyx::LFUN_LAYOUT_RELOAD
1596 * \li Action: Reloads layout information.
1597 * \li Notion: Reloads all layout information for the current buffer from disk, thus
1598 recognizing any changes that have been made to layout files on the fly.
1599 This is intended to be used only by layout developers and should not be
1600 used when one is trying to do actual work.
1601 * \li Syntax: layout-reload
1602 * \li Origin: rgh, 3 September 2007
1605 { LFUN_LAYOUT_RELOAD, "layout-reload", NoInternal, Layout },
1607 * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW_CACHE
1608 * \li Action: Opens the file that was created from last preview of this buffer.
1609 * \li Notion: This LFUN is called by the "Show Output Anyway" button in the LaTeX
1610 * Errors dialog. It can also be called by the user, which is useful
1611 * if the document takes a long time to compile, and you just
1612 * want to see the last previewed version.
1613 * \li Syntax: buffer-view-cache
1616 { LFUN_BUFFER_VIEW_CACHE, "buffer-view-cache", ReadOnly, Buffer },
1618 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
1619 * \li Action: Sets the text class for the current buffer.
1620 * \li Syntax: textclass-apply <TEXTCLASS>
1621 * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
1622 the filename, minus the ".layout" extension.
1625 { LFUN_TEXTCLASS_APPLY, "textclass-apply", NoInternal, Layout },
1627 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
1628 * \li Action: Loads information for a textclass from disk.
1629 * \li Syntax: textclass-load <TEXTCLASS>
1630 * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
1631 the filename, minus the ".layout" extension.
1634 { LFUN_TEXTCLASS_LOAD, "textclass-load", NoInternal, Layout },
1637 * \var lyx::FuncCode lyx::LFUN_MARK_OFF
1638 * \li Action: Disable selecting of text-region.
1639 * \li Syntax: mark-off
1642 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
1644 * \var lyx::FuncCode lyx::LFUN_MARK_ON
1645 * \li Action: Enable selecting of text-region.
1646 * \li Notion: After enabling you can simply move arrow keys to get selected region.
1647 * \li Syntax: mark-on
1650 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
1652 * \var lyx::FuncCode lyx::LFUN_MARK_TOGGLE
1653 * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
1654 * \li Syntax: mark-toggle
1655 * \li Origin: Andre, May 5 2006
1658 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
1661 * \var lyx::FuncCode lyx::LFUN_MATH_DELIM
1662 * \li Action: Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
1663 * \li Syntax: math-delim [<LEFT>] [<RIGHT>]
1664 * \li Params: <LEFT/RIGHT>: Delimiters to be used. Each delimiter can be specified by
1665 either a LaTeX name or a valid character.
1666 ( is the default letter.
1667 * \li Sample: math-delim { rangle
1668 * \li Origin: Alejandro, 18 Jun 1996
1671 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
1673 * \var lyx::FuncCode lyx::LFUN_MATH_BIGDELIM
1674 * \li Action: Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
1675 * \li Syntax: math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
1676 * \li Params: <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r \n
1677 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
1678 * \li Sample: math-bigdelim "Bigl" "\Downarrow" "Bigr" "\}"
1679 * \li Origin: Enrico & Georg, 7 May 2006
1682 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
1684 * \var lyx::FuncCode lyx::LFUN_MATH_DISPLAY
1685 * \li Action: Creates a new displayed equation in text mode.
1686 Toggles inlined/display formula in math mode.
1687 * \li Syntax: math-display [<ARG>]
1688 * \li Params: <ARG>: this argument will be passed to #LFUN_MATH_INSERT when creating
1689 new equation from the text mode.
1690 * \li Origin: Alejandro, 18 Jun 1996
1693 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
1695 * \var lyx::FuncCode lyx::LFUN_MATH_INSERT
1696 * \li Action: Inserts math objects and symbols.
1697 * \li Syntax: math-insert <ARG>
1698 * \li Params: <ARG>: Symbol or LaTeX code to be inserted.
1699 * \li Notion: When <ARG> is a _single_ math inset with more than one cell
1700 (such as "x_y^z" or "\frac{x}{y}"), the content of cell(0) is
1701 replaced by the current selection (only works if the selection
1702 is in mathed). As an example, if "abc" is selected in mathed,
1703 "math-insert \frac{x}{y}" replaces "abc" with "\frac{abc}{y}",
1704 and "math-insert x_y^z" replaces "abc" with "abc_y^z".
1705 If nothing is selected (or the selection is not in mathed),
1706 math-insert works as expected.
1709 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
1711 * \var lyx::FuncCode lyx::LFUN_MATH_SUBSCRIPT
1712 * \li Action: Enters subscript expression in math expression.
1713 * \li Syntax: math-subscript
1714 * \li Origin: vermeer, 12 Dec 2001
1717 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
1719 * \var lyx::FuncCode lyx::LFUN_MATH_SUPERSCRIPT
1720 * \li Action: Enters superscript expression in math expression.
1721 * \li Syntax: math-superscript
1722 * \li Origin: vermeer, 12 Dec 2001
1725 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
1727 * \var lyx::FuncCode lyx::LFUN_MATH_LIMITS
1728 * \li Action: Toggles the position of the limits from above/below to the right
1729 side an vice versa in integral symbol, a limit, a summation, etc.
1730 * \li Notion: Put the cursor before the symbol with the limits and then invoke
1732 * \li Syntax: math-limits [<STATE>]
1733 * \li Params: <STATE>: limits|nolimits
1736 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
1738 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO
1739 * \li Action: Inserts a math macro definition at the cursor position in the text.
1740 * \li Syntax: math-macro <NAME> [<NARGS>] [def]
1741 * \li Params: <NAME>: The name of the macro, e.g. "mymacro".\n
1742 <NARGS>: The number of parameters of the macro. Default is 0.
1743 "def": Has no effect anymore, just for compatibility with former LyX versions.
1744 * \li Origin: ale, 10 May 1997; sts, 21 Dec 2007
1747 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
1749 * \var lyx::FuncCode lyx::LFUN_MATH_MUTATE
1750 * \li Action: Mutates the type of math inset to the newly selected one.
1751 * \li Syntax: math-mutate <TYPE>
1752 * \li Params: <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
1753 multline|gather|flalign
1754 * \li Origin: Andre, 23 May 2001
1757 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
1759 * \var lyx::FuncCode lyx::LFUN_MATH_SPACE
1760 * \li Action: Inserts space into math expression.
1761 * \li Notion: Use spacebar after entering this space to change type of space.
1762 * \li Syntax: math-space [<TYPE>] [<LEN>]
1763 * \li Params: <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace \n
1764 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad \n
1765 custom space: hspace \n
1766 "," used by default.\n
1767 Note that ! is equivalent to negthinspace, , = thinspace,
1768 : = medspace, and ; = thickspace.\n
1769 <LEN>: length for custom spaces (hspace)
1770 * \li Origin: Andre, 25 Jul 2001; sanda, 16 Jun 2008
1773 { LFUN_MATH_SPACE, "math-space", Noop, Math },
1775 * \var lyx::FuncCode lyx::LFUN_MATH_MATRIX
1776 * \li Action: Inserts a matrix.
1777 * \li Syntax: math-matrix <COLS> <ROWS> [<ALIGN>]
1778 * \li Params: <ALIGN>: Alignment is a word composed of the vertical alignment
1779 (b, c or t) (i.e. 1 char) and the horizontal alignments
1780 (l, c or r) (i.e. <COL> chars).
1781 * \li Sample: math-matrix 3 3 bccc
1784 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
1786 * \var lyx::FuncCode lyx::LFUN_MATH_AMS_MATRIX
1787 * \li Action: Inserts an extended matrix as provided by the amsmath package.
1788 * \li Syntax: math-matrix <COLS> <ROWS> [<DECORATION>]
1789 * \li Params: <DECORATION>: Decoration determines the LaTeX name of the matrix
1790 that should be created. Possible values include
1791 pmatrix, bmatrix, Bmatrix, vmatrix, Vmatrix and
1792 matrix. The default is 'matrix'.
1793 * \li Sample: math-ams-matrix 3 3 bmatrix
1796 { LFUN_MATH_AMS_MATRIX, "math-ams-matrix", Noop, Math },
1798 * \var lyx::FuncCode lyx::LFUN_MATH_MODE
1799 * \li Action: In text mode enters math mode (i.e. puts math insets on the current
1800 cursor position), in math mode enters text mode inside math expression.
1801 * \li Notion: If there is some selected text, it puts the text inside created math box.
1802 * \li Syntax: math-mode [on|<ARG>]
1803 * \li Params: <ARG>: eventual argument (LaTeX code) is passed to #LFUN_MATH_INSERT .\n
1804 "on": allow only entering of math mode from text mode.
1805 * \li Origin: Alejandro, 4 Jun 1996
1808 { LFUN_MATH_MODE, "math-mode", Noop, Math },
1810 * \var lyx::FuncCode lyx::LFUN_REGEXP_MODE
1811 * \li Action: Enters regexp mode (i.e., puts regexp insets on the current
1812 cursor position). Used by the advanced search dialog.
1813 * \li Notion: If there is any selected text, then it is moved inside the created
1815 * \li Syntax: regexp-mode [<ARG>]
1816 * \li Params: <ARG>: eventual argument (regular expression).
1817 * \li Origin: Tommaso, 4 Oct 2008
1820 { LFUN_REGEXP_MODE, "regexp-mode", Noop, Math },
1822 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
1823 * \li Action: Toggles numbering of the current formula line.
1824 * \li Notion: Must be in display formula mode.
1825 * \li Syntax: math-number-line-toggle
1826 * \li Origin: Alejandro, 18 Jun 1996
1829 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
1831 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
1832 * \li Action: Toggles numbering/labeling of the current formula.
1833 * \li Notion: Must be in display formula mode.
1834 * \li Syntax: math-number-toggle
1835 * \li Origin: Alejandro, 4 Jun 1996
1838 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
1840 * \var lyx::FuncCode lyx::LFUN_MATH_EXTERN
1841 * \li Action: Calls external program and passes the current expression/equation
1842 as an argument for the calculation in the format appropriate to the
1844 * \li Notion: Selection can be used to determine the input for the external program.
1845 * \li Syntax: math-extern <LANG> [<COMMAND>]
1846 * \li Params: <LANG>: octave|maxima|maple|mathematica|script \n
1847 where "script" stands for the external script (normalized
1848 expression will be passed)
1849 * \li Origin: Andre, 24 Apr 2001
1850 * \li Sample: math-extern maple simplify
1853 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
1855 * \var lyx::FuncCode lyx::LFUN_MATH_SIZE
1856 * \li Action: Changes arbitrarily the size used by math fonts inside a context.
1857 * \li Notion: Provides an interface to the LaTeX math mode font size commands.
1858 * \li Syntax: math-size <STYLE>
1859 * \li Params: <STYLE>: \displaystyle|\textstyle|\scriptstyle|\scriptscriptstyle
1860 * \li Origin: Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
1863 { LFUN_MATH_SIZE, "math-size", Noop, Math },
1865 * \var lyx::FuncCode lyx::LFUN_MATH_FONT_STYLE
1866 * \li Action: Changes the text style used in math.
1867 * \li Syntax: math-font-style <STYLE>
1868 * \li Params: <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf|textnormal\n
1869 |textrm|textsf|texttt|textbf|textmd|textit|textsc|textsl|textup
1870 * \li Origin: vfr, 9 jan 2009
1873 { LFUN_MATH_FONT_STYLE, "math-font-style", Noop, Math },
1875 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
1876 * \li Action: Unfold a Math Macro.
1877 * \li Notion: Unfold the Math Macro the cursor is in, i.e.
1879 * \li Syntax: math-macro-unfold
1880 * \li Origin: sts, 06 January 2008
1883 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
1885 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
1886 * \li Action: Fold a Math Macro.
1887 * \li Notion: Fold the Math Macro the cursor is in if it was
1888 unfolded, i.e. displayed as \foo before.
1889 * \li Syntax: math-macro-fold
1890 * \li Origin: sts, 06 January 2008
1893 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
1895 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
1896 * \li Action: Add a parameter.
1897 * \li Notion: Add a parameter to a Math Macro.
1898 * \li Params: <NUM>: The number of the parameter behind which the new one
1899 will be added (1 for the first, i.e. use 0 for add a
1900 parameter at the left), defaults to the last one.
1901 * \li Syntax: math-macro-add-param <NUM>
1902 * \li Origin: sts, 06 January 2008
1905 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
1907 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
1908 * \li Action: Remove the last parameter.
1909 * \li Notion: Remove the last parameter of a Math Macro and
1910 remove its value in all instances of the macro
1912 * \li Params: <NUM>: The number of the parameter to be deleted (1 for
1913 the first), defaults to the last one.
1914 * \li Syntax: math-macro-remove-param <NUM>
1915 * \li Origin: sts, 06 January 2008
1918 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
1920 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
1921 * \li Action: Append a greedy parameter.
1922 * \li Notion: Append a greedy parameter to a Math Macro which
1923 eats the following mathed cell in every instance of
1924 the macro in the buffer.
1925 * \li Syntax: math-macro-append-greedy-param
1926 * \li Origin: sts, 06 January 2008
1929 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
1931 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
1932 * \li Action: Remove a greedy parameter.
1933 * \li Notion: Remove a greedy parameter of a Math Macro and spit
1934 out the values of it in every instance of the macro
1935 in the buffer. If it is an optional parameter the [valud]
1937 * \li Syntax: math-macro-remove-greedy-param
1938 * \li Origin: sts, 06 January 2008
1941 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
1943 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
1944 * \li Action: Make a parameter optional.
1945 * \li Notion: Turn the first non-optional parameter of a Math Macro
1946 into an optional parameter with a default value.
1947 * \li Syntax: math-macro-make-optional
1948 * \li Origin: sts, 06 January 2008
1951 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
1953 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
1954 * \li Action: Make a parameter non-optional.
1955 * \li Notion: Turn the last optional parameter of a Math Macro
1956 into a non-optional parameter. The default value is
1957 remembered to be reused later if the user changes his mind.
1958 * \li Syntax: math-macro-make-nonoptional
1959 * \li Origin: sts, 06 January 2008
1962 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
1964 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
1965 * \li Action: Add an optional parameter.
1966 * \li Notion: Insert an optional parameter just behind the
1967 already existing optional parameters.
1968 * \li Syntax: math-macro-add-optional-param
1969 * \li Origin: sts, 06 January 2008
1972 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
1974 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
1975 * \li Action: Remove the last optional parameter.
1976 * \li Notion: Remove the last optional parameter of a Math Macro and
1977 remove it in all the instances of the macro in the buffer.
1978 * \li Syntax: math-macro-remove-optional-param
1979 * \li Origin: sts, 06 January 2008
1982 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
1984 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
1985 * \li Action: Add a greedy optional parameter.
1986 * \li Notion: Add a greedy optional parameter which eats the value
1987 from the following cells in mathed which are in the [value]
1989 * \li Syntax: math-macro-add-greedy-optional-param
1990 * \li Origin: sts, 06 January 2008
1993 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
1995 * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
1996 * \li Action: Only active in Math Macro definition.
1997 * \li Notion: Dummy function which is only active in a Math Macro definition.
1998 It's used to toggle the Math Macro toolbar if the cursor moves
1999 into a Math Macro definition.
2000 * \li Syntax: in-mathmacrotemplate
2001 * \li Origin: sts, 06 January 2008
2004 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
2007 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
2008 * \li Action: Moves the current paragraph downwards in the document.
2009 * \li Syntax: paragraph-move-down
2010 * \li Origin: Edwin, 8 Apr 2006
2013 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
2015 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
2016 * \li Action: Moves the current paragraph upwards in the document.
2017 * \li Notion: Movement through the document will possibly break the paragraph-depth
2018 (e.g. itemize structure).
2019 * \li Syntax: paragraph-move-up
2020 * \li Origin: Edwin, 8 Apr 2006
2023 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
2026 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP
2027 * \li Action: Move the cursor to the next paragraph (or beginning of the current one)
2028 in upward direction.
2029 * \li Syntax: paragraph-up
2030 * \li Origin: Asger, 1 Oct 1996
2033 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
2035 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP_SELECT
2036 * \li Action: Move the cursor and select the text to the next paragraph (or
2037 beginning of the current one) in upward direction.
2038 * \li Syntax: paragraph-up-select
2039 * \li Origin: Asger, 1 Oct 1996
2042 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
2044 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN
2045 * \li Action: Move the cursor to the next paragraph (or beginning of the current one)
2046 in downward direction.
2047 * \li Syntax: paragraph-down
2048 * \li Origin: Asger, 1 Oct 1996
2051 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
2053 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN_SELECT
2054 * \li Action: Move the cursor and select the text to the next paragraph (or
2055 beginning of the current one) in downward direction.
2056 * \li Syntax: paragraph-down-select
2057 * \li Origin: Asger, 1 Oct 1996
2060 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
2062 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
2063 * \li Action: Jump to a paragraph given by its id number and optionally the
2064 desired position within the paragraph.
2065 If given four arguments id_start, pos_start, id_end, pos_end,
2066 perform a selection from start to end.
2067 * \li Notion: Note that id number of paragraph is not the sequential number of
2068 paragraph seen on the screen. Moreover the id is unique for all
2069 opened buffers (documents). Both ids must belong to the same
2071 * \li Syntax: paragraph-goto <PAR_ID> <POS_IN_PAR> [<PAR_ID> <POS_IN_PAR>]
2072 * \li Params: <PAR_ID>: paragraph id \n
2073 <POS_IN_PAR>: desired position within the paragraph
2074 * \li Origin: Dekel, 26 Aug 2000
2078 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly | NoInternal, Edit },
2080 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_BREAK
2081 * \li Action: Breaks the current paragraph at the current location.
2082 * \li Notion: Removes the selection.
2083 * \li Syntax: paragraph-break [<LAYOUT>]
2084 * \li Params: <LAYOUT>: "inverse" - decreases depth by one (or change layout
2085 to default layout) when the cursor is at the end of
2089 { LFUN_PARAGRAPH_BREAK, "paragraph-break", Noop, Edit },
2091 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
2092 * \li Action: Change paragraph settings.
2093 * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
2094 This function only modifies, and does not override, existing settings.
2095 Note that the "leftindent" indent setting is deprecated.
2096 * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
2097 * \li Params: <INDENT>: \noindent|\indent|\indent-toggle|\leftindent LENGTH\n
2098 <SPACING>: \paragraph_spacing default|single|onehalf|double|other SIZE \n
2099 <ALIGN>: \align block|left|right|center|default\n
2100 <OTHERS>: \labelwidthstring WIDTH|\start_of_appendix
2101 * \li Origin: rgh, Aug 15 2007
2104 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
2106 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
2107 * \li Action: Change paragraph settings.
2108 * \li Notion: Overwrite all nonspecified settings to the default ones.
2109 Use paragraph-params lfun if you don't want to overwrite others settings.
2110 * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
2111 * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
2112 * \li Origin: leeming, 30 Mar 2004
2115 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
2117 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UPDATE
2118 * \li Action: Updates the values inside the paragraph dialog from the paragraph.
2119 * \li Notion: This is an internal LFUN, not to be used by users. Called internally
2120 by #LFUN_DIALOG_UPDATE.
2121 * \li Origin: leeming, 13 Mar 2003
2124 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
2127 * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
2128 * \li Action: Move the current group in the upward direction in the
2129 structure of the document.
2130 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
2131 the whole substructure of the group.
2132 * \li Syntax: outline-up
2133 * \li Origin: Vermeer, 23 Mar 2006
2136 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
2138 * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
2139 * \li Action: Move the current group in the downward direction in the
2140 structure of the document.
2141 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
2142 the whole substructure of the group.
2143 * \li Syntax: outline-down
2144 * \li Origin: Vermeer, 23 Mar 2006
2147 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
2149 * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
2150 * \li Action: Moves the current group in the downward direction in the
2151 hierarchy of the document structure.
2152 * \li Notion: Part -> Chapter -> Section -> etc.
2153 * \li Syntax: outline-in
2154 * \li Origin: Vermeer, 23 Mar 2006
2157 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
2159 * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
2160 * \li Action: Moves the current group in the upward direction in the
2161 hierarchy of the document structure.
2162 * \li Notion: Part <- Chapter <- Section <- etc.
2163 * \li Syntax: outline-out
2164 * \li Origin: Vermeer, 23 Mar 2006
2167 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
2170 * \var lyx::FuncCode lyx::LFUN_INSET_EDIT
2171 * \li Action: Edit the inset at cursor with an external application,
2172 if one is attributed.
2173 * \li Syntax: inset-edit [<INSET_PARAMS>]
2174 * \li Params: <INSET_PARAMS>: Parameters for the inset. \n
2175 Currently only the filename will be considered.
2176 * \li Origin: JSpitzm, 27 Apr 2006
2179 { LFUN_INSET_EDIT, "inset-edit", ReadOnly | AtPoint, Edit },
2182 * \var lyx::FuncCode lyx::LFUN_TABULAR_INSERT
2183 * \li Action: Inserts table into the document.
2184 * \li Notion: See #LFUN_TABULAR_FEATURE for some more details
2185 about tabular modifications.
2186 * \li Syntax: tabular-insert [<ROWS> <COLUMNS>]
2187 * \li Params: In case no arguments are given show insert dialog.
2188 * \li Origin: Jug, 12 Apr 2000
2191 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
2194 * \var lyx::FuncCode lyx::LFUN_CELL_BACKWARD
2195 * \li Action: Moves the cursor to the previous cell inside the table.
2196 * \li Syntax: cell-backward
2197 * \li Origin: Jug, 22 May 2000
2200 { LFUN_CELL_BACKWARD, "cell-backward", ReadOnly | NoUpdate, Edit },
2202 * \var lyx::FuncCode lyx::LFUN_CELL_FORWARD
2203 * \li Action: Moves the cursor to the next cell inside the table.
2204 * \li Syntax: cell-forward
2207 { LFUN_CELL_FORWARD, "cell-forward", ReadOnly | NoUpdate, Edit },
2209 * \var lyx::FuncCode lyx::LFUN_CELL_SPLIT
2210 * \li Action: Splits cell and shifts right part to the next cell (inside the math grid).
2211 * \li Syntax: cell-split
2212 * \li Origin: Ale, 15 May 1997
2215 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
2218 * \var lyx::FuncCode lyx::LFUN_VC_REGISTER
2219 * \li Action: Register the document as an file inside version control system.
2220 * \li Notion: File is registered inside cvs, svn or rcs repository acording to the existence
2221 of cvs/svn/rcs entries in the document's directory. \n
2222 See LyX Additional Features Manual (Version Control Chapter) for additional
2224 * \li Syntax: vc-register
2225 * \li Origin: Lgb, 1 Jul 1997
2228 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
2230 * \var lyx::FuncCode lyx::LFUN_VC_RENAME
2231 * \li Action: Renames the document to another name.
2232 * \li Notion: Renaming with revision history is only supported by SVN.
2233 For CVS it is simulated by adding the document under a new
2234 name and deleting the old one. For RCS it is not supported.
2235 Disabled if uncommitted changes exist.
2236 * \li Syntax: vc-rename <FILENAME>
2237 * \li Params: <FILENAME>: New name of the document.\n
2238 * A file dialog is opened if no filename is given.
2239 * \li Origin: gb, 05 Feb 2013
2242 { LFUN_VC_RENAME, "vc-rename", ReadOnly, System },
2244 * \var lyx::FuncCode lyx::LFUN_VC_COPY
2245 * \li Action: Copies the document to another name.
2246 * \li Notion: Copying with revision history is only supported by SVN.
2247 For RCS and CVS it is simulated by adding the document
2249 Disabled if uncommitted changes exist.
2250 * \li Syntax: vc-copy <FILENAME>
2251 * \li Params: <FILENAME>: New name of the document.\n
2252 * A file dialog is opened if no filename is given.
2253 * \li Origin: gb, 05 Feb 2013
2256 { LFUN_VC_COPY, "vc-copy", ReadOnly, System },
2258 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_IN
2259 * \li Action: Checks-in/commits the changes of the registered file to the repository.
2260 * \li Notion: In RCS case this also unlocks the file.
2261 * \li Syntax: vc-check-in
2262 * \li Origin: Lgb, 1 Jul 1997
2265 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
2267 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_OUT
2268 * \li Action: Checks-out the document for edit (and locks it in some cases).
2269 * \li Syntax: vc-check-out
2270 * \li Origin: Lgb, 1 Jul 1997
2273 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
2275 * \var lyx::FuncCode lyx::LFUN_VC_REVERT
2276 * \li Action: Reverts the document to the last check-in/commit in VCS.
2277 * \li Syntax: vc-revert
2278 * \li Origin: Lgb, 1 Jul 1997
2281 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
2283 * \var lyx::FuncCode lyx::LFUN_VC_UNDO_LAST
2284 * \li Action: Undo last check-in.
2285 * \li Notion: This is currently implemented only for RCS.
2286 * \li Syntax: vc-check-out
2287 * \li Origin: Lgb, 1 Jul 1997
2290 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
2292 * \var lyx::FuncCode lyx::LFUN_VC_COMMAND
2293 * \li Action: Executes external command. This command is intended to support
2294 additional VCS commands.
2295 * \li Syntax: vc-command <FLAG> <PATH> <COMMAND>
2296 * \li Params: <FLAG>: Flags for the command can be combined together.\n
2297 U - dUmmy - no flags \n
2298 D - Doc - need document loaded to proceed \n
2299 I - dIrty - mark document dirty \n
2300 R - Reload - ensure that the document is saved and reload it after command execution \n
2301 M - Message - ask for input string (commit message)\n
2302 <PATH>: path where to start. $$p will be replaced by the current document path.\n
2303 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current
2304 document(with absolute path)/path/message.
2305 * \li Sample: vc-command DR $$p "svn up"
2306 * \li Origin: sanda, 13 Jan 2009
2309 { LFUN_VC_COMMAND, "vc-command", NoBuffer | ReadOnly, System },
2311 * \var lyx::FuncCode lyx::LFUN_VC_LOCKING_TOGGLE
2312 * \li Action: Toggles the locking property of the edited file.
2313 * \li Notion: This is currently implemented only for SVN.
2314 * \li Syntax: vc-locking-toggle
2315 * \li Origin: sanda, 25 Jun 2009
2318 { LFUN_VC_LOCKING_TOGGLE, "vc-locking-toggle", ReadOnly, System },
2320 * \var lyx::FuncCode lyx::LFUN_VC_REPO_UPDATE
2321 * \li Action: Update the local archive directory in which resides
2322 the current document with the remote repository.
2323 * \li Syntax: vc-repo-update
2324 * \li Origin: sanda, 16 Oct 2009
2327 { LFUN_VC_REPO_UPDATE, "vc-repo-update", ReadOnly, System },
2329 * \var lyx::FuncCode lyx::LFUN_VC_COMPARE
2330 * \li Action: Compares two revisions of the same file under version control.
2331 * \li Syntax: vc-compare [<REV1>] [<REV2>]
2332 * \li Params: Revision number either points directly to commit in history
2333 or if negative number -x it points to (last commit - x).\n
2334 In RCS we subtract only in the last number of revision specification.
2335 Special case "0" is reserved for the last committed revision.\n
2336 <REV1>: Older file.\n
2337 <REV2>: Newer file. Used only if REV1 > 0.\n
2338 If no parameter is given, interactive dialog will be shown.
2339 * \li Sample: Compare current document against last commit\n
2341 Compare current document against current revision - 5 commits\n
2343 Compare revisions 120 and 155\n
2345 * \li Origin: sanda, 12 Feb 2010
2348 { LFUN_VC_COMPARE, "vc-compare", ReadOnly, System },
2351 * \var lyx::FuncCode lyx::LFUN_CHANGES_TRACK
2352 * \li Action: Toggles change tracking to on/off.
2353 * \li Syntax: changes-track
2354 * \li Origin: levon, 1 Oct 2002
2357 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
2359 * \var lyx::FuncCode lyx::LFUN_CHANGES_OUTPUT
2360 * \li Action: Toggles showing of change tracking in typeset output.
2361 * \li Syntax: changes-output
2362 * \li Origin: jspitzm, 21 Jan 2005
2365 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
2367 * \var lyx::FuncCode lyx::LFUN_CHANGE_NEXT
2368 * \li Action: Moves the cursor to the position of the next change
2369 of the change tracking records.
2370 * \li Syntax: change-next
2371 * \li Origin: schmitt, 4 Oct 2006
2374 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
2376 * \var lyx::FuncCode lyx::LFUN_CHANGE_PREVIOUS
2377 * \li Action: Moves the cursor to the position of the previous change
2378 of the change tracking records.
2379 * \li Syntax: change-previous
2380 * \li Origin: vfr, 4 Apr 2009
2383 { LFUN_CHANGE_PREVIOUS, "change-previous", ReadOnly, Edit },
2385 * \var lyx::FuncCode lyx::LFUN_CHANGES_MERGE
2386 * \li Action: Open change tracking dialog for merging and moves the cursor
2387 to the position of the next change.
2388 * \li Syntax: changes-merge
2389 * \li Origin: Levon, 16 Oct 2002
2392 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
2394 * \var lyx::FuncCode lyx::LFUN_CHANGE_ACCEPT
2395 * \li Action: Accepts tracked change inside the selection.
2396 * \li Syntax: change-accept
2397 * \li Origin: Levon, 16 Oct 2002
2400 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
2402 * \var lyx::FuncCode lyx::LFUN_CHANGE_REJECT
2403 * \li Action: Rejects tracked change inside the selection.
2404 * \li Syntax: change-reject
2405 * \li Origin: Levon, 16 Oct 2002
2408 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
2410 * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_ACCEPT
2411 * \li Action: Accepts all tracked changes in the document.
2412 * \li Syntax: all-changes-accept
2413 * \li Origin: Levon, 16 Oct 2002
2416 { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
2418 * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_REJECT
2419 * \li Action: Rejects all tracked changes in the document.
2420 * \li Notion: Reject does not work recursively; the user may have to repeat the operation.
2421 * \li Syntax: all-changes-reject
2422 * \li Origin: Levon, 16 Oct 2002
2425 { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
2428 * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
2429 * \li Action: Apply data for an inset.
2430 * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
2431 be applied. This is either changed to #LFUN_INSET_MODIFY or
2432 #LFUN_INSET_INSERT depending on the context where it is called.
2433 * \li Syntax: inset-apply <ARGS>
2434 * \li Params: See #LFUN_INSET_INSERT .
2437 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
2439 * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE
2440 * \li Action: Dissolve the current inset into text.
2441 * \li Syntax: inset-dissolve [<INSET>]
2442 * \li Params: <INSET>: this can be used to make sure the right kind of inset
2443 is dissolved. For example "dissolve" entry in the charstyles
2444 sub-menu should only dissolve the charstyle inset, even if the
2445 cursor is inside several nested insets of different type.\n
2446 For values see #lyx::InsetLayout::lyxtype_ .
2447 * \li Origin: JSpitz, 7 Aug 2006
2450 { LFUN_INSET_DISSOLVE, "inset-dissolve", AtPoint, Edit },
2452 * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
2453 * \li Action: Insert new inset (type given by the parameters).
2454 * \li Syntax: inset-insert <INSET> <ARGS>
2455 * \li Params: <INSET>: <bibitem|bibtex|citation|ert|listings|external|graphics|tabular|\n
2456 hyperlink|include|index|label|line|nomencl|vspace|ref|toc|script>\n
2457 <ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
2458 * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
2459 where <label name> is the name of the referenced label and
2460 <Format> is one of the following: \n
2461 ref -- <reference> \n
2462 eqref -- (<reference>) \n
2463 pageref -- <page> \n
2464 vpageref -- on <page> \n
2465 vref -- <reference> on <page> \n
2466 formatted -- Formatted reference
2469 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
2471 * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
2472 * \li Action: Modify some properties of an inset.
2473 * \li Notion: Used for bibitem, bibtex, box, branch, command, ert, external,
2474 floats, graphics, include, index, info, label,
2475 listings, newline, newpage, nomencl, note, phantom,
2476 ref, space, tabular, vspace, wrap insets.
2477 * \li Syntax: inset-modify <INSET> <ARGS> \n
2478 inset-modify changetype <TYPE>
2479 * \li Sample: inset-modify note Note Comment \n
2480 inset-modify changetype Ovalbox
2483 { LFUN_INSET_MODIFY, "inset-modify", AtPoint, Edit },
2485 * \var lyx::FuncCode lyx::LFUN_TABULAR_FEATURE
2486 * \li Action: Modify properties of tabulars and table-like math environments.
2487 * \li Syntax: tabular-feature <FEATURE> [<ARG>]
2488 * \li Params: Generally see #LFUN_INSET_INSERT for further details.\n
2489 * <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|\n
2490 copy-column|move-column-right|move-column-left|move-row-down|move-row-up|\n
2491 toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|\n
2492 align-left|align-right|align-center|align-block|align-decimal|set-decimal-point|\n
2493 valign-top|valign-bottom|valign-middle|longtabular-align-left|\n
2494 longtabular-align-center|longtabular-align-right|m-align-left|m-align-right|\n
2495 m-align-center|m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|\n
2496 set-all-lines|unset-all-lines|toggle-longtabular|set-longtabular|unset-longtabular|set-pwidth|\n
2497 set-mpwidth|set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|\n
2498 set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|\n
2499 unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|\n
2500 set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|\n
2501 set-special-column|set-special-multicolumn|set-special-multirow|\n
2502 toggle-booktabs|set-booktabs|unset-booktabs|set-top-space|set-bottom-space|\n
2503 set-interline-space|set-border-lines|tabular-valign-top|\n
2504 tabular-valign-middle|tabular-valign-bottom|set-tabular-width\n
2505 Various math-environment features are handled as well, e.g. add-vline-left/right for\n
2506 the Grid/Array environment.\n
2507 <ARG>: additional argument for some commands, use debug mode to explore its values.
2508 * \li Origin: gm, 10 Dec 2015
2511 { LFUN_TABULAR_FEATURE, "tabular-feature", Noop, Edit },
2513 * \var lyx::FuncCode lyx::LFUN_INSET_DIALOG_UPDATE
2514 * \li Action: Updates the values inside the dialog from the inset.
2515 * \li Notion: This is an internal LFUN, not to be used by users. Called internally
2516 by #LFUN_DIALOG_UPDATE
2517 * \li Params: <DIALOG-NAME>
2518 * \li Origin: leeming, 25 Feb 2003
2521 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
2523 * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
2524 * \li Action: Open the inset's properties dialog.
2525 * \li Notion: Used for bibitem, bibtex, box, branch, citation, ert, external,
2526 float, graphics, href, include, index, index_print, label, line,
2527 listings, note, phantom, ref, space, tabular, vspace, wrap insets.
2528 * \li Syntax: inset-settings <INSET>
2529 * \li Params: <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|\n
2530 graphics|href|include|index|index_print|label|line|\n
2531 listings|note|phantom|ref|space|tabular|vspace|wrap>.
2534 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly | AtPoint, Edit },
2536 * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
2537 * \li Action: Toggles the collapsible inset at cursor position,
2538 or the inset we are currently in.
2539 * \li Syntax: inset-toggle [<ARG>]
2540 * \li Params: <ARG>: <open|close|toggle|assign>. \n
2541 open/close/toggle are for collapsible insets. toggle is used when no argument is given.\n
2542 assign synchronize the branch-inset with activation status of the branch.
2543 Used for global toggling when changed activation.
2544 * \li Origin: lasgouttes, 19 Jul 2001
2547 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly | AtPoint, Edit },
2549 * \var lyx::FuncCode lyx::LFUN_INSET_FORALL
2550 * \li Action: Apply the given commands on insets of a given name.
2551 * \li Notion: WARNING: use at your own risks; this function gives
2552 you too many ways of shooting yourself in the foot.
2553 A typical example is
2554 inset-forall Note note-insert
2555 which starts an infinite loop. This is mitigated by the fact
2556 that the number of actions is arbitrarily limited to 100000.
2557 Note also that inset-forall does not update metrics between
2558 iterations, which can lead to bugs. This has to be eventually
2560 * \li Syntax: inset-forall <NAME> <LFUN-COMMAND> \n
2561 <NAME>: Type of Inset. If <NAME> is *, all insets are matched.
2562 The name is used like for InsetLayout in layout files: "Note"
2563 matches all note insets, while "Note:Note" only matches LyX
2565 * \li Sample: Remove all index insets: \n
2566 inset-forall Index char-delete-forward \n
2567 Close all Notes (also works for a particular branch, for example): \n
2568 inset-forall Note inset-toggle close \n
2569 Transform all yellow notes to comments \n
2570 inset-forall Note:Note inset-modify note Note Comment \n
2571 Try to put LyX in an infinite loop if there is at least a Note: \n
2572 inset-forall Note char-backward
2573 * \li Origin: lasgouttes, 27 Nov 2009
2576 { LFUN_INSET_FORALL, "inset-forall", ReadOnly, Edit },
2579 * \var lyx::FuncCode lyx::LFUN_GRAPHICS_RELOAD
2580 * \li Action: Reloads the image if necessary.
2581 * \li Syntax: graphics-reload
2582 * \li Origin: vfr, 10 Aug 2009
2585 { LFUN_GRAPHICS_RELOAD, "graphics-reload", ReadOnly | AtPoint, Edit },
2587 * \var lyx::FuncCode lyx::LFUN_SET_GRAPHICS_GROUP
2588 * \li Action: Set the group for the graphics inset on the cursor position.
2589 * \li Syntax: set-graphics-group [<GROUP>]
2590 * \li Params: <GROUP>: Id for an existing group. In case the Id is an empty string,
2591 the graphics inset is removed from the current group.
2592 * \li Origin: sanda, 6 May 2008
2595 { LFUN_SET_GRAPHICS_GROUP, "set-graphics-group", Noop, Edit },
2598 * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
2599 * \li Action: Moves the cursor out of the current slice, going forward.
2600 * \li Notion: Cursor movement within an inset may be different than cursor
2601 movement in the surrounding text. This action should be called
2602 automatically by the cursor movement within the inset, when
2603 movement within the inset has ceased (reached the end of the
2604 last paragraph, for example), in order to move correctly
2605 back into the surrounding text.
2608 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
2610 * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
2611 * \li Action: Moves the cursor out of the current slice, going backwards.
2612 * \li Notion: See also #LFUN_FINISHED_FORWARD.
2615 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
2617 * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
2618 * \li Action: Moves the cursor out of the current slice, going right.
2619 * \li Notion: See also #LFUN_FINISHED_FORWARD
2622 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
2624 * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
2625 * \li Action: Moves the cursor out of the current slice, going left.
2626 * \li Notion: See also #LFUN_FINISHED_FORWARD.
2629 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
2632 * \var lyx::FuncCode lyx::LFUN_LANGUAGE
2633 * \li Action: Set language from the current cursor position.
2634 * \li Syntax: language <LANG> [set]
2635 * \li Params: <LANG>: Requested language. Look in lib/languages for
2636 the list. "language reset" or "language" (without param)
2637 reset to the document language.
2638 set: If used, the language will be set to the specified
2639 language. Otherwise, the language will be toggled (i.e., if
2640 the current language is LANG, switch to the document language
2641 or the default language, if LANG is the document language).
2642 * \li Origin: Dekel, 2 Mar 2000
2645 { LFUN_LANGUAGE, "language", Noop, Edit },
2648 * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
2649 * \li Action: Goto a label.
2650 * \li Syntax: label-goto [<LABEL>]
2651 * \li Params: <LABEL>: Requested label. If no label is given and reference
2652 is on cursor position, Bookmark 0 is saved and
2653 cursor moves to the position of referenced label.
2654 * \li Origin: Ale, 6 Aug 1997
2657 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
2659 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT
2660 * \li Action: Inserts label to text or displayed formula.
2661 * \li Syntax: label-insert [<LABEL>]
2662 * \li Params: <LABEL>: Requested label. If no label is given dialog requesting
2663 name will be opened.
2666 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
2668 * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
2669 * \li Action: Go to the next label or cross-reference.
2670 * \li Syntax: reference-next
2671 * \li Origin: Dekel, 14 Jan 2001
2674 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
2677 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
2678 * \li Action: Moves the cursor to the numbered bookmark, opening the file
2679 if necessary. Note that bookmarks are saved per-session, not
2681 * \li Notion: Bookmark 0 has a special purpose. It is automatically set \n
2682 1. to the paragraph you are currently editing \n
2683 2. to the paragraph from where you are jumping to the last-edited
2684 position (jump-back feature) \n
2685 3. when jumping from crossreference to the requested label by
2687 * \li Syntax: bookmark-goto <NUMBER>
2688 * \li Params: <NUMBER>: the number of the bookmark to restore.
2689 * \li Origin: Dekel, 27 January 2001
2692 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
2694 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
2695 * \li Action: Save a bookmark.
2696 * \li Notion: Saves a numbered bookmark to the sessions file. The number
2697 must be between 1 and 9, inclusive. Note that bookmarks are
2698 saved per-session, not per file.
2699 * \li Syntax: bookmark-save <NUMBER>
2700 * \li Params: <NUMBER>: the number of the bookmark to save.
2701 * \li Origin: Dekel, 27 January 2001
2704 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
2706 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
2707 * \li Action: Clears the list of saved bookmarks.
2708 * \li Syntax: bookmark-clear
2709 * \li Origin: bpeng, 31 October 2006
2712 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
2715 * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
2716 * \li Action: Open the given help file according to the language setting.
2717 * \li Syntax: help-open <FILE>[.lyx]
2718 * \li Params: <FILE>: any document from (/usr/share/)doc directory.
2719 * \li Origin: Jug, 27 Jun 1999
2722 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
2724 * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
2725 * \li Action: Terminates the current LyX instance.
2726 * \li Notion: Terminates the current LyX instance, asking whether to save
2727 modified documents, etc.
2728 * \li Syntax: lyx-quit
2731 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
2733 * \var lyx::FuncCode lyx::LFUN_LYX_ACTIVATE
2734 * \li Action: Activates the LyX window.
2735 * \li Notion: On Linux and Mac OS, this action brings the LyX window
2736 into focus. Such behavior is not allowed by Windows OS
2737 so instead the color of the taskbar entry is changed to
2738 indicate that the window has changed in some way.
2739 This action is useful in combination with reverse search.
2740 * \li Syntax: lyx-activate
2741 * \li Origin: skostysh, 4 Aug 2016
2744 { LFUN_LYX_ACTIVATE, "lyx-activate", ReadOnly | NoBuffer, Hidden },
2746 * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
2747 * \li Action: Toggles visibility of a given toolbar between on/off/auto.
2748 * \li Notion: Skipping "auto" when allowauto is false.
2749 * \li Syntax: toolbar-toggle <NAME> [allowauto]
2750 * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|\n
2751 minibuffer|review|view/update|math_panels|vcs|
2752 view-others|update-others
2753 * \li Origin: Edwin, 21 May 2007
2756 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
2758 * \var lyx::FuncCode lyx::LFUN_ICON_SIZE
2759 * \li Action: Sets icon size of toolbars.
2760 * \li Syntax: icon-size [<SIZE>]
2761 * \li Params: <SIZE> : the icon size in px or one of the logical settings
2762 small|normal|big|huge|giant, the default is normal
2763 (whose size in px is icon set dependent).
2764 * \li Origin: 11 July 2016
2767 { LFUN_ICON_SIZE, "icon-size", NoBuffer, Buffer },
2769 * \var lyx::FuncCode lyx::LFUN_MENU_OPEN
2770 * \li Action: Opens the menu given by its name.
2771 * \li Syntax: menu-open <NAME>
2772 * \li Params: <NAME>: menu name. See various .inc files in lib/ui for candidates.
2775 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
2777 * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
2778 * \li Action: Various UI visibility-toggling actions.
2779 * \li Syntax: ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
2780 * \li Params: statusbar : Toggle visibility of the statusbar.\n
2781 menubar : Toggle visibility of the menubar.\n
2782 scrollbar : Toggle visibility of the scrollbar.\n
2783 frame : Toggle visibility of the frames around editing window.\n
2784 fullscreen : Toggle fullscreen mode. This also covers calling the
2785 previous functions. However #LFUN_TOOLBAR_TOGGLE for the
2786 custom tweaks of the toolbars should be used.
2787 * \li Origin: sanda, 9 Feb 2007
2790 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
2793 * \var lyx::FuncCode lyx::LFUN_WINDOW_NEW
2794 * \li Action: Creates new empty LyX window.
2795 * \li Notion: Already opened documents from the previous window can be found under View menu.
2796 * \li Syntax: window-new [<GEOMETRY>]
2797 * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently
2798 accepted only on Windows platform.
2799 * \li Origin: Abdel, 21 Oct 2006
2802 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
2804 * \var lyx::FuncCode lyx::LFUN_WINDOW_CLOSE
2805 * \li Action: Closes the current LyX window.
2806 * \li Syntax: window-close
2807 * \li Origin: Abdel, 23 Oct 2006
2810 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
2813 * \var lyx::FuncCode lyx::LFUN_VIEW_SPLIT
2814 * \li Action: Creates another split view of current buffer.
2815 * \li Notion: All split views act in the same way independently.
2816 * \li Syntax: view-split <vertical|horizontal>
2817 * \li Params: horizontal : The work areas are laid out side by side.\n
2818 vertical : The work areas laid out vertically.
2819 * \li Origin: Abdel, 20 Feb 2008
2822 { LFUN_VIEW_SPLIT, "view-split", ReadOnly, Buffer },
2825 * \var lyx::FuncCode lyx::LFUN_VIEW_CLOSE
2826 * \li Action: Close the current document work area.
2827 * \li Notion: Close the current work area. If no other work areas are showing the buffer,
2828 then close the associated buffer as well.
2829 * \li Syntax: view-close
2830 * \li Origin: Tommaso, 15 Sep 2012
2833 { LFUN_VIEW_CLOSE, "view-close", ReadOnly, Buffer },
2836 * \var lyx::FuncCode lyx::LFUN_TAB_GROUP_CLOSE
2837 * \li Action: Close the current tab group.
2838 * \li Notion: This only closes the work areas, not the buffers themselves.
2839 The still opened buffers can be visualized in another tab group.
2840 * \li Syntax: tab-group-close
2841 * \li Origin: Abdel, 21 Feb 2008
2844 { LFUN_TAB_GROUP_CLOSE, "tab-group-close", ReadOnly, Buffer },
2847 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW
2848 * \li Action: Shows hidden dialog or creates new one for a given function/inset settings etc.
2849 * \li Syntax: dialog-show <NAME> [<DATA>]
2850 * \li Params: <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|\n
2851 compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|\n
2852 graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimiter|\n
2853 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|\n
2854 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|\n
2855 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL> \n
2856 <SPECIAL>: latexlog|vclog \n
2857 <DATA>: data, usually settings for the given dialog. Use debug mode for the
2859 * \li Origin: leeming, 17 Jun 2003
2862 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
2864 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW_NEW_INSET
2865 * \li Action: Shows hidden dialog or create new one for a given inset settings etc.
2866 * \li Notion: Internally uses #LFUN_DIALOG_SHOW with processed data for a given inset.
2867 * \li Syntax: dialog-show-new-inset <NAME> [<DATA>]
2868 * \li Params: See #LFUN_DIALOG_SHOW .
2869 * \li Origin: leeming, 25 Feb 2003
2872 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
2874 * \var lyx::FuncCode lyx::LFUN_DIALOG_UPDATE
2875 * \li Action: Updates the dialog values from the inset/paragraph/document.
2876 * \li Syntax: dialog-update <NAME>
2877 * \li Params: <NAME>: paragraph|prefs|<INSET> \n
2879 * \li Origin: leeming, 25 Feb 2003
2882 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
2884 * \var lyx::FuncCode lyx::LFUN_DIALOG_HIDE
2885 * \li Action: Hides showed dialog. Counterpart to #LFUN_DIALOG_SHOW .
2886 * \li Syntax: dialog-hide <NAME>
2887 * \li Params: See #LFUN_DIALOG_SHOW .
2888 * \li Origin: leeming, 25 Feb 2003
2891 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
2893 * \var lyx::FuncCode lyx::LFUN_DIALOG_TOGGLE
2894 * \li Action: Toggles dialog between showed/hidden state.
2895 * \li Notion: Internally uses #LFUN_DIALOG_SHOW , #LFUN_DIALOG_HIDE .
2896 * \li Syntax: dialog-toggle <NAME> [<DATA>]
2897 * \li Params: See #LFUN_DIALOG_SHOW .
2898 * \li Origin: JSpitzm, 30 Apr 2007
2901 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
2903 * \var lyx::FuncCode lyx::LFUN_DIALOG_DISCONNECT_INSET
2904 * \li Action: Closes opened connection to opened inset.
2905 * \li Notion: Connection is used for apply functions.
2906 * \li Syntax: dialog-disconnect-inset <INSET-NAME>
2907 * \li Origin: leeming, 25 Feb 2003
2910 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
2913 * \var lyx::FuncCode lyx::LFUN_MOUSE_PRESS
2914 * \li Action: This function is called when mouse button is pressed (inside workarea).
2915 Action depends on the context.
2916 * \li Notion: This is an internal LFUN, not to be used by users.
2917 * \li Origin: Andre, 9 Aug 2002
2920 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
2922 * \var lyx::FuncCode lyx::LFUN_MOUSE_DOUBLE
2923 * \li Action: This function is called when double click on mouse button is
2924 pressed (inside workarea). 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_DOUBLE, "", ReadOnly, Hidden },
2931 * \var lyx::FuncCode lyx::LFUN_MOUSE_TRIPLE
2932 * \li Action: This function is called when triple 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_TRIPLE, "", ReadOnly, Hidden },
2940 * \var lyx::FuncCode lyx::LFUN_MOUSE_MOTION
2941 * \li Action: This function is called when mouse cursor is moving over the text.
2942 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_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
2949 * \var lyx::FuncCode lyx::LFUN_MOUSE_RELEASE
2950 * \li Action: This function is called when mouse button is released (inside workarea).
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_RELEASE, "", ReadOnly, Hidden },
2959 * \var lyx::FuncCode lyx::LFUN_KEYMAP_OFF
2960 * \li Action: Turn off the loaded keyboard map.
2961 * \li Syntax: keymap-off
2964 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
2966 * \var lyx::FuncCode lyx::LFUN_KEYMAP_PRIMARY
2967 * \li Action: Turn on the primary keyboard map.
2968 * \li Notion: Maps were widely used in past, when X-windows didn't have nowadays
2969 keyboard support. They can be still used to maintain uniform keyboard
2970 layout across the various platforms.\n
2971 The language is to be set in the Preferences dialog.
2972 * \li Syntax: keymap-primary
2975 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
2977 * \var lyx::FuncCode lyx::LFUN_KEYMAP_SECONDARY
2978 * \li Action: Turn on the secondary keyboard map.
2979 * \li Syntax: keymap-secondary
2982 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
2984 * \var lyx::FuncCode lyx::LFUN_KEYMAP_TOGGLE
2985 * \li Action: Toggles keyboard maps (first/second/off).
2986 * \li Syntax: keymap-toggle
2987 * \li Origin: leeming, 30 Mar 2004
2990 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
2993 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_LAYOUT
2994 * \li Action: Returns the current layout (that is environment) name
2995 on the cursor position.
2996 * \li Syntax: server-get-layout
2999 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
3001 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_FILENAME
3002 * \li Action: Returns path and file name of the currently edited document.
3003 * \li Syntax: server-get-filename
3006 { LFUN_SERVER_GET_FILENAME, "server-get-filename", ReadOnly, System },
3008 * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
3009 * \li Action: Sets the cursor position in LyX based on the row number of generated TeX file.
3010 * \li Notion: This can be useful for DVI inverse-search or detection of the problematic
3011 line from LaTeX compilation. Note that before this function can be used
3012 export to LaTeX output must occur (in order to map the row numbers).
3013 * \li Syntax: server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
3014 * \li Params: <FILE>: the path and filename. Environment variables are expanded in the path.
3015 In case this LFUN does not work make sure you are giving correct
3017 If the file is located inside LyX temporary directory it will be
3018 mapped back into the appropriate opened buffer (e.g. for the case
3019 of generated .tex file).\n
3020 .ext: extensions will be automatically replaced by .lyx.\n
3021 <ROW_NUMBER> The row number of the LaTeX file to which to go.
3022 * \li Sample: server-goto-file-row /home/user/example.lyx 41\n
3023 server-goto-file-row /tmp/lyx_tmpdir.XM3088/lyx_tmpbuf0/example.tex 41
3024 * \li Origin: Edmar, 23 Dec 1998
3027 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly | NoBuffer, System },
3029 * \var lyx::FuncCode lyx::LFUN_FORWARD_SEARCH
3030 * \li Action: Sets the cursor position in the previewed (dvi/pdf) file based on the row
3031 number in LyX window.
3032 * \li Notion: The external program used for forward search call can be specified in
3033 LyX Output preferences. See Additional manual for details of these
3035 * \li Syntax: forward-search
3036 * \li Origin: sanda, 14 Apr 2010
3039 { LFUN_FORWARD_SEARCH, "forward-search", ReadOnly, System },
3041 * \var lyx::FuncCode lyx::LFUN_SERVER_NOTIFY
3042 * \li Action: Sends notify message about the last key-sequence to client.
3043 * \li Notion: This can be used to grab last key-sequence used inside the LyX window.
3044 See also Debug extensions section in Additional features manual.
3045 * \li Syntax: server-notify
3048 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
3050 * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
3051 * \li Action: Sets the cursor position based on the editing area coordinates
3052 (similar to clicking on that point with left mouse button).
3053 * \li Syntax: server-set-xy <X> <Y>
3056 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
3058 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
3059 * \li Action: Returns the coordinates of cursor position in the editing area.
3060 * \li Syntax: server-get-xy
3063 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
3066 * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
3067 * \li Action: Generates the code (literate programming).
3068 * \li Notion: Latex file with extension \literate_extension is generated.
3069 Then LyX invokes \build_command (with a default of ``make'') to generate the code and
3070 \build_error_filter to process the compilation error messages. \n
3071 In case you want to process your literate file with a script, or some other program,
3072 just insert in your lyxrc file an entry with:\n
3073 \build_command "my_script my_arguments" \n
3074 The \build_error_filter differs from the \literate_error_filter only in that the
3075 former will identify error messages from your compiler.
3076 * \li Syntax: build-program
3079 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
3082 * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
3083 * \li Action: Saves the current buffer to a temporary file.
3084 * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
3085 is called automatically by LyX, to "autosave" the current buffer.
3086 * \li Syntax: buffer-auto-save
3089 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
3091 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHILD_OPEN
3092 * \li Action: Loads the given child document.
3093 * \li Notion: The current document is treated as a parent.
3094 * \li Syntax: buffer-child-open <FILE>
3095 * \li Params: <FILE>: Filename of the child. The directory of the parent is assumed by default.
3096 * \li Origin: Ale, 28 May 1997
3099 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
3101 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHKTEX
3102 * \li Action: Runs chktex for the current document.
3103 * \li Syntax: buffer-chktex
3104 * \li Origin: Asger, 30 Oct 1997
3107 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
3109 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
3110 * \li Action: Toggles compression of the current document on/off.
3111 * \li Syntax: buffer-toggle-compression
3112 * \li Origin: bpeng, 27 Apr 2006
3115 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
3117 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_OUTPUT_SYNC
3118 * \li Action: Toggles including of resources for forward/reverse search of the given document.
3119 * \li Notion: When toggled on, SyncTeX is invoked for PDF, while srcltx package
3120 is used for DVI. Custom LaTeX macro can be defined in preferences.
3121 * \li Syntax: buffer-toggle-output-sync
3122 * \li Origin: sanda, 25 May 2010
3125 { LFUN_BUFFER_TOGGLE_OUTPUT_SYNC, "buffer-toggle-output-sync", Noop, System },
3127 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
3128 * \li Action: Closes the current buffer.
3129 * \li Notion: Closes the current buffer, asking whether to save it, etc,
3130 if the buffer has been modified.
3131 * \li Syntax: buffer-close
3134 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
3136 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE_ALL
3137 * \li Action: Closes all buffers.
3138 * \li Notion: Closes all buffers, asking whether to save it, etc,
3139 if a buffer has been modified.
3140 * \li Syntax: buffer-close-all
3143 { LFUN_BUFFER_CLOSE_ALL, "buffer-close-all", ReadOnly, Buffer },
3145 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
3146 * \li Action: Exports the current buffer (document) to the given format.
3147 * \li Syntax: buffer-export <FORMAT> [<DEST>]
3148 * \li Params: <FORMAT> is either "custom" or one of the formats which you
3149 can find in Tools->Preferences->File formats->Format.
3150 Usual format you will enter is "pdf2" (pdflatex),
3151 "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
3152 In case of "custom" you will be asked for a format you
3153 want to start from and for the command that you want to
3154 apply to this format. Internally the control is then passed
3155 to #LFUN_BUFFER_EXPORT_CUSTOM.
3156 <DEST> If present, this argument provides the export destination
3157 filename. Its containing folder will also be the destination
3158 folder, where all the needed external files will be copied.
3159 * \li Origin: Lgb, 29 Jul 1997
3162 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
3164 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
3165 * \li Action: Exports the current buffer (document) from the given format using
3166 the given command on it.
3167 * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
3168 * \li Params: <FORMAT> format to start from (LyX will care to produce such
3169 intermediate file).\n
3170 <COMMAND> this command will be launched on the file. Note that you can
3171 use "$$FName" string to qualify the intermediate file.
3172 * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
3173 * \li Origin: leeming, 27 Mar 2004
3176 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
3178 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_AS
3179 * \li Action: Opens a dialog for exporting the current buffer.
3180 * \li Syntax: buffer-export-as [<FORMAT>]
3181 * \li Params: <FORMAT> is the export format initially selected in the dialog.
3182 * You can pass any of the formats which you can find in
3183 * Tools->Preferences->File formats->Format, provided it
3184 * has the "document" flag set. If no format is specified
3185 * the dialog will start with the default output format of
3186 * the current document.
3187 * \li Sample: buffer-export-as pdf2
3188 * \li Origin: tommaso, 6 Oct 2011
3191 { LFUN_BUFFER_EXPORT_AS, "buffer-export-as", ReadOnly, Buffer },
3193 * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
3194 * \li Action: Import a given file as a lyx document.
3195 * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
3196 defined converters in preferences. Look in the File->Import menu to get
3197 an idea of the currently active import formats.
3198 * \li Syntax: buffer-import <FORMAT> [<FILE>]
3199 * \li Origin: Asger, 24 Jul 1998
3202 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
3204 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
3205 * \li Action: Creates a new buffer (that is, document) and switches to it.
3206 * \li Notion: Implicit path can be set in Preferences dialog.
3207 * \li Syntax: buffer-new [<FILE>]
3208 * \li Params: <FILE>: filename of created file with absolute path.
3211 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
3213 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
3214 * \li Action: Creates a new buffer (that is, document) from a template.
3215 * \li Notion: Path for new files and templates can be set in Preferences dialog.
3216 Template will be asked for via Open-dialog.
3217 * \li Syntax: buffer-new-template [<FILE>]
3218 * \li Params: <FILE>: filename of created file with absolute path.
3221 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
3223 * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
3224 * \li Action: Reverts opened document.
3225 * \li Syntax: buffer-reload
3226 * \li Origin: Asger, 2 Feb 1997
3229 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
3231 * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
3232 * \li Action: Display and switch to the given buffer.
3233 * \li Syntax: buffer-switch <BUFFER>
3234 * \li Params: <BUFFER>: path and filename of already opened (but possibly hidden)
3235 document which is to be shown.
3238 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
3240 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
3241 * \li Action: Toggle editing mode of the current document between read/write and read-only.
3242 * \li Notion: This function is not allowed if the file is under version control, since
3243 read-only flag is often used in version control file locking.
3244 * \li Syntax: buffer-toggle-read-only
3245 * \li Origin: Lgb, 27 May 1997
3248 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
3250 * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
3251 * \li Action: Displays current buffer in chosen format.
3252 * \li Notion: Displays the contents of the current buffer in the chosen
3253 format, for example, PDF or DVI. This runs the necessary
3254 converter, calls the defined viewer, and so forth.
3255 * \li Syntax: buffer-view [<FORMAT>]
3256 * \li Params: <FORMAT>: The format to display, where this is one of the
3257 formats defined (in the current GUI) in the
3258 Tools>Preferences>File Formats dialog.
3259 If no format is given, the default format as
3260 specified in the same dialog is used.
3263 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
3265 * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
3266 * \li Action: Exports the current document and put the result into the
3267 temporary directory.
3268 * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
3269 the output will be rewritten - updated. This is useful in case your viewer
3270 is able to detect such changes (e.g. ghostview for postscript).
3271 * \li Syntax: buffer-update [<FORMAT>]
3272 * \li Params: <FORMAT>: The format to display, where this is one of the
3273 formats defined (in the current GUI) in the
3274 Tools>Preferences>File Formats dialog.
3275 If no format is given, the default format as
3276 specified in the same dialog is used.
3277 * \li Origin: Dekel, 5 Aug 2000
3280 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
3283 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
3284 * \li Action: Saves the current buffer.
3285 * \li Notion: Saves the current buffer to disk, using the filename that
3286 is already associated with the buffer, asking for one if
3287 none is yet assigned.
3288 * \li Syntax: buffer-write
3291 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
3293 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
3294 * \li Action: Rename and save current buffer.
3295 * \li Syntax: buffer-write-as <FILENAME>
3296 * \li Params: <FILENAME>: New name of the buffer/file. A relative path
3297 is with respect to the original location of the buffer/file.
3300 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
3302 * \var lyx::FuncCode lyx::LFUN_BUFFER_FORALL
3303 * \li Action: Applies a command to all non-hidden buffers.
3304 * \li Notion: a buffer is `hidden' if it is internally open in LyX, but not
3305 visible in any window.
3306 * \li Syntax: buffer-forall <LFUN-COMMAND>
3307 * \li Params: <LFUN-COMMAND>: The command to be applied to the buffers.
3308 * \li Sample: Close all Notes in buffers: \n
3309 buffer-forall inset-forall Note inset-toggle close \n
3310 Toggle change tracking on buffers: \n
3311 buffer-forall changes-track \n
3312 Toggle read-only for buffers: \n
3313 buffer-forall buffer-toggle-read-only \n
3314 Show statistics for individual buffers: \n
3315 buffer-forall statistics \n
3316 Activate the branch named "Solutions" in buffers: \n
3317 buffer-forall branch-activate Solutions \n
3318 Export buffers to PDF (pdflatex): \n
3319 buffer-forall buffer-export pdf2 \n
3320 * \li Origin: skostysh, 20 Jul 2012
3323 { LFUN_BUFFER_FORALL, "buffer-forall", ReadOnly | Argument, Buffer },
3325 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
3326 * \li Action: Save all changed documents.
3327 * \li Syntax: buffer-write-all
3328 * \li Origin: rgh, gpothier 6 Aug 2007
3331 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
3333 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEXT
3334 * \li Action: Switch to the next opened document.
3335 * \li Notion: Note that this does not necessarily mean next in tabbar
3336 (for full list see View menu).
3337 * \li Syntax: buffer-next
3340 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
3342 * \var lyx::FuncCode lyx::LFUN_BUFFER_MOVE_NEXT
3343 * \li Action: Moves the current tab one spot to the right.
3344 * \li Syntax: buffer-move-next
3345 * \li Origin: skostysh, 7 Apr 2015
3348 { LFUN_BUFFER_MOVE_NEXT, "buffer-move-next", ReadOnly, Buffer },
3350 * \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS
3351 * \li Action: Switch to the previous opened document.
3352 * \li Syntax: buffer-previous
3355 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
3357 * \var lyx::FuncCode lyx::LFUN_BUFFER_MOVE_PREVIOUS
3358 * \li Action: Moves the current tab one spot to the left.
3359 * \li Syntax: buffer-move-previous
3360 * \li Origin: skostysh, 7 Apr 2015
3363 { LFUN_BUFFER_MOVE_PREVIOUS, "buffer-move-previous", ReadOnly, Buffer },
3365 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
3366 * \li Action: Update (export) the document built from the master buffer,
3367 if the current buffer is part of a master/child document.
3368 * \li Syntax: master-buffer-update [<FORMAT>]
3369 * \li Params: <FORMAT>: The format to display, where this is one of the
3370 formats defined (in the current GUI) in the
3371 Tools>Preferences>File Formats dialog.
3372 If no format is given, the default format as
3373 specified in the same dialog is used.
3374 * \li Origin: Tommaso, 20 Sep 2007
3377 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
3379 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
3380 * \li Action: Show a preview built from the master buffer, if available.
3381 if the current buffer is part of a master/child document.
3382 * \li Syntax: master-buffer-view [<FORMAT>]
3383 * \li Params: <FORMAT>: The format to display, where this is one of the
3384 formats defined (in the current GUI) in the
3385 Tools>Preferences>File Formats dialog.
3386 If no format is given, the default format as
3387 specified in the same dialog is used.
3388 * \li Origin: Tommaso, 20 Sep 2007
3391 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
3393 * \var lyx::FuncCode lyx::LFUN_BUFFER_LANGUAGE
3394 * \li Action: Set language of the current document.
3395 * \li Syntax: buffer-language <LANG>
3396 * \li Params: <LANG>: language name. See lib/languages for list.
3397 * \li Origin: leeming, 30 Mar 2004
3400 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
3402 * \var lyx::FuncCode lyx::LFUN_BUFFER_SAVE_AS_DEFAULT
3403 * \li Action: Save the current document settings as default.
3404 * \li Notion: The file will will be saved into ~/.lyx/templates/defaults.lyx .
3405 * \li Syntax: buffer-save-as-default [<ARGS>]
3406 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
3407 you can find in document header of usual .lyx file.
3408 * \li Origin: leeming, 30 Mar 2004
3411 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
3413 * \var lyx::FuncCode lyx::LFUN_BUFFER_PARAMS_APPLY
3414 * \li Action: Apply the given settings to the current document.
3415 * \li Syntax: buffer-params-apply [<ARGS>]
3416 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
3417 you can find in document header of usual .lyx file.
3418 * \li Origin: leeming, 30 Mar 2004
3421 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", NoInternal, Buffer },
3424 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
3425 * \li Action: Inserts another LyX file.
3426 * \li Syntax: file-insert [<FILE>]
3427 * \li Params: <FILE>: Filename to be inserted.
3430 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
3432 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
3433 * \li Action: Inserts plain text file.
3434 * \li Syntax: file-insert-plaintext [<FILE>]
3435 * \li Params: <FILE>: Filename to be inserted.
3436 * \li Origin: CFO-G, 19 Nov 1997
3439 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
3441 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
3442 * \li Action: Inserts plain text file as paragraph (i.e. join lines).
3443 * \li Syntax: file-insert-plaintext-para [<FILE>]
3444 * \li Params: <FILE>: Filename to be inserted.
3445 * \li Origin: Levon, 14 Feb 2001
3448 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
3450 * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
3451 * \li Action: Open LyX document.
3452 * \li Syntax: file-open [<FILE>]
3453 * \li Params: <FILE>: Filename to be opened.
3456 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
3459 * \var lyx::FuncCode lyx::LFUN_CALL
3460 * \li Action: Executes a command defined in a .def file.
3461 * \li Notion: The definitions are by default read from lib/commands/default.def.\n
3462 A .def file allows to define a command with \define "<NAME>" "<LFUN>"
3463 where <NAME> is the name of the new command and <LFUN> is the lfun code
3464 to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
3465 \def_file "FileName" allows to include another .def file. \n
3466 This is particularly useful in connection with toolbar buttons:
3467 Since the name of the button image for this lfun is
3468 lib/images/commands/<NAME>.png this is the way to assign an image
3469 to a complex command-sequence.
3470 * \li Syntax: call <NAME>
3471 * \li Params: <NAME>: Name of the command that must be called.
3472 * \li Origin: broider, 2 Oct 2007
3475 { LFUN_CALL, "call", NoBuffer, System },
3477 * \var lyx::FuncCode lyx::LFUN_META_PREFIX
3478 * \li Action: Simulate halting Meta key (Alt key on PCs).
3479 * \li Notion: Used for buffer edition not for GUI control.
3480 * \li Syntax: meta-prefix
3483 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
3485 * \var lyx::FuncCode lyx::LFUN_CANCEL
3486 * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
3487 * \li Syntax: cancel
3490 { LFUN_CANCEL, "cancel", NoBuffer, System },
3493 * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
3494 * \li Action: Switches the focus to the minibuffer so that the user can type
3495 in there. If necessary, it opens the minibuffer toolbar.
3496 * \li Notion: Usually bound to M-x shortcut.
3497 * \li Syntax: command-execute
3500 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
3503 * \var lyx::FuncCode lyx::LFUN_COMMAND_PREFIX
3504 * \li Action: Return the current key sequence and available options as a string.
3505 * \li Notion: No options are added if no current map exists. \n
3506 This is probably usable only with connection to lyxserver.
3507 * \li Syntax: command-prefix
3510 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
3512 * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
3513 * \li Action: Run more commands (LFUN and its parameters) in a sequence.
3514 * \li Syntax: command-sequence <CMDS>
3515 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
3516 * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
3517 * \li Origin: Andre, 11 Nov 1999
3520 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
3522 * \var lyx::FuncCode lyx::LFUN_COMMAND_ALTERNATIVES
3523 * \li Action: Runs the first listed command that is enabled.
3524 * \li Notion: This can be used to bind multiple functions to a single key,
3525 and then which one is used will depend upon the context.
3526 * \li Syntax: command-alternatives <CMDS>
3527 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
3528 * \li Sample: command-alternatives completion-accept;cell-forward
3529 * \li Origin: rgh, 24 September 2008
3532 { LFUN_COMMAND_ALTERNATIVES, "command-alternatives", NoBuffer, System },
3534 * \var lyx::FuncCode lyx::LFUN_MESSAGE
3535 * \li Action: Shows message in statusbar (for script purposes).
3536 * \li Syntax: message <STRING>
3537 * \li Origin: Lgb, 8 Apr 2001
3540 { LFUN_MESSAGE, "message", NoBuffer, System },
3542 * \var lyx::FuncCode lyx::LFUN_DEBUG_LEVEL_SET
3543 * \li Action: Set debug output level.
3544 * \li Syntax: debug-level-set <LEVEL>
3545 * \li Params: <LEVEL>: comma separated list of levels or the correspondent number
3546 of their combination. 0 is equivalent to disabling all debug
3547 events. See lyx -dbg for the current list of debug levels
3549 * \li Origin: sanda, 28 Dec 2009
3552 { LFUN_DEBUG_LEVEL_SET, "debug-level-set", NoBuffer, System },
3555 * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
3556 * \li Action: Save user preferences.
3557 * \li Syntax: preferences-save
3558 * \li Origin: Lgb, 27 Nov 1999
3561 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
3563 * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
3564 * \li Action: Reconfigure the automatic settings.
3565 * \li Syntax: reconfigure
3566 * \li Origin: Asger, 14 Feb 1997
3569 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
3571 * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
3572 * \li Action: Apply the given settings to user preferences.
3573 * \li Syntax: lyxrc-apply <SETTINGS>
3574 * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
3575 to get an idea which commands to use and their syntax.
3576 #lyx::LyXRC::LyXRCTags has the list of possible commands.
3579 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
3581 * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
3582 * \li Action: Determine whether to keep cursor inside the editing window regardless
3583 of the scrollbar movement.
3584 * \li Syntax: toggle-cursor-follows-scrollbar
3585 * \li Origin: ARRae, 2 Dec 1997
3588 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
3590 * \var lyx::FuncCode lyx::LFUN_SET_COLOR
3591 * \li Action: Set the given LyX color to the color defined by the X11 name given.
3592 * \li Notion: A new color entry is created if the color is unknown.
3593 Color names can be stored as a part of user settings.
3594 * \li Syntax: set-color <LYX_NAME> <X11_NAME>
3595 * \li Origin: SLior, 11 Jun 2000
3598 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
3600 * \var lyx::FuncCode lyx::LFUN_STATISTICS
3601 * \li Action: Count the statistics (number of words and characters)
3602 in the document or in the given selection and display it
3604 * \li Notion: Note that this function gives the number of words/chars written,
3605 not the number of characters which will be typeset.
3606 * \li Syntax: statistics
3607 * \li Origin: lasgouttes, Jan 27 2004; sanda, Jan 8 2008
3610 { LFUN_STATISTICS, "statistics", ReadOnly, System },
3612 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_STATISTICS
3613 * \li Action: Returns the statistics (number of words and characters)
3614 in the document or in the given selection.
3615 * \li Notion: Note that this function gives the number of words/chars written,
3616 not the number of characters which will be typeset.
3617 * \li Syntax: server-get-statistics [<TYPE>]
3618 * \li Params: <TYPE>: <words|chars|chars-space> The requested count; if not
3619 specified, the three values are returned, separated
3621 words: count words.\n
3622 chars: count characters.\n
3623 chars-space: count characters and spaces.
3624 * \li Origin: brokenclock, Oct 10 2014
3627 { LFUN_SERVER_GET_STATISTICS, "server-get-statistics", ReadOnly, System },
3629 * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
3630 * \li Action: Show the inline completion at the cursor position.
3631 * \li Syntax: completion-inline
3632 * \li Origin: sts, Feb 19 2008
3635 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
3637 * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
3638 * \li Action: Show the completion popup at the cursor position.
3639 * \li Syntax: completion-popup
3640 * \li Origin: sts, Feb 19 2008
3643 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
3645 * \var lyx::FuncCode lyx::LFUN_COMPLETE
3646 * \li Action: Try to complete the word or command at the cursor position.
3647 * \li Syntax: complete
3648 * \li Origin: sts, Feb 19 2008
3651 { LFUN_COMPLETE, "complete", SingleParUpdate, Edit },
3654 * \var lyx::FuncCode lyx::LFUN_COMPLETION_CANCEL
3655 * \li Action: Try to cancel completion, either the popup or the inline completion.
3656 * \li Syntax: completion-cancel
3657 * \li Origin: sts, Sep 07 2008
3660 { LFUN_COMPLETION_CANCEL, "completion-cancel", SingleParUpdate, Edit },
3662 * \var lyx::FuncCode lyx::LFUN_COMPLETION_ACCEPT
3663 * \li Action: Accept suggested completion.
3664 * \li Syntax: completion-accept
3665 * \li Origin: sanda, Sep 08 2008
3668 { LFUN_COMPLETION_ACCEPT, "completion-accept", SingleParUpdate, Edit },
3672 * \var lyx::FuncCode lyx::LFUN_BRANCH_ADD
3673 * \li Action: Add a branch to the buffer's BranchList.
3674 * \li Syntax: branch-add <BRANCH>
3675 * \li Params: <BRANCH>: Name of the branch to add
3676 * \li Origin: spitz, 7 Jul 2009
3679 { LFUN_BRANCH_ADD, "branch-add", AtPoint, Buffer },
3683 * \var lyx::FuncCode lyx::LFUN_BRANCH_INVERT
3684 * \li Action: Toggles inversion status of branch inset.
3685 * \li Syntax: branch-invert
3686 * \li Origin: rgheck, 12 July 2016
3689 { LFUN_BRANCH_INVERT, "branch-invert", AtPoint, Buffer },
3692 * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
3693 * \li Action: Activate the branch.
3694 * \li Syntax: branch-activate <BRANCH>
3695 * \li Params: <BRANCH>: The branch to activate
3696 * \li Sample: lyx -x "branch-activate answers" -e pdf2 finalexam.lyx \n
3697 could be used to export a pdf with the answers branch included
3698 without one's having to open LyX and activate the branch manually.
3699 * \li Origin: rgh, 27 May 2008
3702 { LFUN_BRANCH_ACTIVATE, "branch-activate", AtPoint, Buffer },
3704 * \var lyx::FuncCode lyx::LFUN_BRANCH_DEACTIVATE
3705 * \li Action: De-activate the branch.
3706 * \li Syntax: branch-deactivate <BRANCH>
3707 * \li Params: <BRANCH>: The branch to deactivate
3708 * \li Origin: rgh, 27 May 2008
3711 { LFUN_BRANCH_DEACTIVATE, "branch-deactivate", AtPoint, Buffer },
3713 * \var lyx::FuncCode lyx::LFUN_BRANCH_MASTER_ACTIVATE
3714 * \li Action: Activate the branch in the master buffer.
3715 * \li Syntax: branch-master-activate <BRANCH>
3716 * \li Params: <BRANCH>: The branch to activate
3717 * \li Sample: lyx -x "branch-activate answers" -e pdf2 finalexam.lyx \n
3718 could be used to export a pdf with the answers branch included
3719 without one's having to open LyX and activate the branch manually.
3720 * \li Origin: spitz, 30 Sep 2012
3723 { LFUN_BRANCH_MASTER_ACTIVATE, "branch-master-activate", AtPoint, Buffer },
3725 * \var lyx::FuncCode lyx::LFUN_BRANCH_MASTER_DEACTIVATE
3726 * \li Action: De-activate the branch in the master buffer.
3727 * \li Syntax: branch-master-deactivate <BRANCH>
3728 * \li Params: <BRANCH>: The branch to deactivate
3729 * \li Origin: spitz, 30 Sep 2012
3732 { LFUN_BRANCH_MASTER_DEACTIVATE, "branch-master-deactivate", AtPoint, Buffer },
3735 * \var lyx::FuncCode lyx::LFUN_BRANCHES_RENAME
3736 * \li Action: Rename all branches of a given name in a document.
3737 * \li Syntax: branches-rename <OLDNAME> <NEWNAME>
3738 * \li Params: <OLDNAME>: Current name of the branch to be renamed
3739 * <NEWNAME>: New name of the branch
3740 * \li Origin: spitz, 9 Jul 2009
3743 { LFUN_BRANCHES_RENAME, "branches-rename", Noop, Buffer },
3745 * \var lyx::FuncCode lyx::LFUN_BRANCH_ADD_INSERT
3746 * \li Action: Create new branch and directly put the branch inset into
3748 * \li Syntax: branch-add-insert [<NAME>]
3749 * \li Params: <NAME>: Branch name. If it is not specified, you will be asked.
3750 * \li Origin: sanda, 10 Jul 2009
3753 { LFUN_BRANCH_ADD_INSERT, "branch-add-insert", Noop, Buffer },
3757 * \var lyx::FuncCode lyx::LFUN_LABEL_COPY_AS_REF
3758 * \li Action: Copies the label at the cursor as a cross-reference to be pasted elsewhere.
3759 * \li Syntax: copy-label-as-reference <LABEL>
3760 * \li Params: <LABEL>: The label to copy (for multi-line math)
3761 * \li Origin: sts, 16 Nov 2008
3764 { LFUN_LABEL_COPY_AS_REFERENCE, "label-copy-as-reference",
3765 ReadOnly | NoUpdate | AtPoint, Edit },
3768 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT_AS_REFERENCE
3769 * \li Action: Inserts the label (in ToC pane) as a cross-reference at the position of the cursor.
3770 * \li Syntax: label-insert-as-reference
3771 * \li Origin: vfr, 7 Apr 2009
3774 { LFUN_LABEL_INSERT_AS_REFERENCE, "label-insert-as-reference", Noop, Edit},
3777 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_IN
3778 * \li Action: Increases the zoom of the screen fonts.
3779 * \li Syntax: buffer-zoom-in [<ZOOM>]
3780 * \li Params: <ZOOM>: The zoom in % points (neg. or pos.), the default is 20.
3781 * \li Origin: vfr, 30 Mar 2009
3784 { LFUN_BUFFER_ZOOM_IN, "buffer-zoom-in", ReadOnly, Buffer },
3787 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_OUT
3788 * \li Action: Decreases the zoom of the screen fonts.
3789 * \li Syntax: buffer-zoom-out [<ZOOM>]
3790 * \li Params: <ZOOM>: The zoom in % points (neg. or pos.), the default is -20.
3791 * \li Origin: vfr, 30 Mar 2009
3794 { LFUN_BUFFER_ZOOM_OUT, "buffer-zoom-out", ReadOnly, Buffer },
3797 * \var lyx::FuncCode lyx::LFUN_INSET_COPY_AS
3798 * \li Action: Copies the inset to the clipboard as a certain type.
3799 * \li Notion: Currently used only for InsetInfo where its content is copied as a text.
3800 * \li Syntax: inset-copy-as
3801 * \li Origin: vfr, 18 Apr 2010
3804 { LFUN_INSET_COPY_AS, "inset-copy-as", ReadOnly | NoUpdate | AtPoint, Edit },
3807 * \var lyx::FuncCode lyx::LFUN_ENVIRONMENT_SPLIT
3808 * \li Action: Splits the current environment with a Separator.
3809 * \li Syntax: environment-split [outer]
3810 * \li Params: outer: If this is given, LyX will split the outermost environment in
3811 * the current nesting hierarchy.
3812 * \li Origin: spitz, 23 Dec 2012
3815 { LFUN_ENVIRONMENT_SPLIT, "environment-split", Noop, Layout },
3817 { LFUN_NOACTION, "", Noop, Hidden }
3818 #ifndef DOXYGEN_SHOULD_SKIP_THIS
3821 for (int i = 0; items[i].action != LFUN_NOACTION; ++i)
3822 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
3828 LyXAction::LyXAction()
3834 FuncRequest LyXAction::lookupFunc(string const & func) const
3836 string const func2 = trim(func);
3839 return FuncRequest(LFUN_NOACTION);
3842 string const arg = split(func2, cmd, ' ');
3844 FuncMap::const_iterator const fit = lyx_func_map.find(cmd);
3846 return fit != lyx_func_map.end()
3847 ? FuncRequest(fit->second, arg)
3848 : FuncRequest(LFUN_UNKNOWN_ACTION);
3852 string const LyXAction::getActionName(FuncCode action) const
3854 InfoMap::const_iterator const it = lyx_info_map.find(action);
3855 return it != lyx_info_map.end() ? it->second.name : string();
3859 LyXAction::FuncType LyXAction::getActionType(FuncCode action) const
3861 InfoMap::const_iterator const it = lyx_info_map.find(action);
3862 return it != lyx_info_map.end() ? it->second.type : Hidden;
3866 bool LyXAction::funcHasFlag(FuncCode action,
3867 LyXAction::FuncAttribs flag) const
3869 InfoMap::const_iterator ici = lyx_info_map.find(action);
3871 if (ici == lyx_info_map.end()) {
3872 LYXERR0("action: " << action << " is not known.");
3873 LASSERT(false, return false);
3876 return ici->second.attrib & flag;
3880 LyXAction::const_iterator LyXAction::func_begin() const
3882 return lyx_func_map.begin();
3886 LyXAction::const_iterator LyXAction::func_end() const
3888 return lyx_func_map.end();
3892 LyXErr & operator<<(LyXErr & l, FuncCode code)
3895 l.stream() << lyxaction.getActionName(code);