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>]
407 * \li Params: <TYPE>: 'single' for single quotes, otherwise double quotes will be used.
410 { LFUN_QUOTE_INSERT, "quote-insert", Noop, Edit },
412 * \var lyx::FuncCode lyx::LFUN_INFO_INSERT
413 * \li Action: Displays shortcuts, lyxrc, package and textclass availability and menu
414 information in a non-editable boxed InsetText.
415 * \li Notion: Apart from lfun arguments you can use the following method: \n
416 1. input the type and argument of this inset, e.g. "menu paste", in
418 2. select the text and run info-insert lfun.
419 * \li Syntax: info-insert <TYPE> <ARG>
420 * \li Params: <TYPE>: shortcut[s]|lyxrc|lyxinfo|package|textclass|menu|buffer \n
421 <ARG>: argument for a given type. Look into InsetInfo.h for detailed
423 shortcut[s]: name of lfun (e.g math-insert \alpha) \n
424 lyxrc: name of rc_entry (e.g. bind_file) \n
425 lyxinfo: "version" - used version of LyX \n
426 package: name of latex package (e.g. listings) \n
427 textclass: name of textclass (e.g. article) \n
428 menu: name of lfun used in menu \n
429 icon: icon of lfun used in toolbar or direct icon name\n
430 buffer: "name"|"path"|"class"|"vcs-tree-revision"|
431 "vcs-revision"|"vcs-author"|"vcs-date"|"vcs-time"
432 * \li Sample: command-sequence info-insert buffer path; info-insert buffer name
433 * \li Origin: bpeng, 7 Oct 2007
436 { LFUN_INFO_INSERT, "info-insert", Noop, Edit },
438 * \var lyx::FuncCode lyx::LFUN_BRANCH_INSERT
439 * \li Action: Inserts branch inset.
440 * \li Syntax: branch-insert <BRANCH-NAME>
441 * \li Origin: vermeer, 17 Aug 2003
444 { LFUN_BRANCH_INSERT, "branch-insert", Noop, Edit },
446 * \var lyx::FuncCode lyx::LFUN_BOX_INSERT
447 * \li Action: Inserts Box inset.
448 * \li Syntax: box-insert [<TYPE>]
449 * \li Params: <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox \n
450 Framed is the default one.
451 * \li Origin: vermeer, 7 Oct 2003
454 { LFUN_BOX_INSERT, "box-insert", Noop, Edit },
456 * \var lyx::FuncCode lyx::LFUN_FLEX_INSERT
457 * \li Action: Inserts CharStyle, Custom inset or XML short element.
458 * \li Notion: Look into the Customization manual for more information about
460 To make this command enabled the layout file for the document
461 class you're using has to load the character styles. There are
462 a few contained in the Logical Markup module. You can also of
463 course create some yourself. \n
464 For dissolving the element see #LFUN_INSET_DISSOLVE.
465 * \li Syntax: flex-insert Name
466 * \li Params: Name: This name must be defined either in your layout file
467 or imported by some module. The definition is
468 InsetLayout Name or InsetLayout <Flex:Name>. The Flex:
470 * \li Sample: flex-insert Code
473 { LFUN_FLEX_INSERT, "flex-insert", Noop, Edit },
475 * \var lyx::FuncCode lyx::LFUN_SELF_INSERT
476 * \li Action: Inserts the given string (accordingly to the correct keymap).
477 * \li Notion: Automatically replace the currently selected text. Depends on lyxrc
478 settings "auto_region_delete".
479 * \li Syntax: self-insert <STRING>
482 { LFUN_SELF_INSERT, "self-insert", SingleParUpdate, Hidden },
484 * \var lyx::FuncCode lyx::LFUN_SPACE_INSERT
485 * \li Action: Inserts one of horizontal space insets.
486 * \li Syntax: space-insert <NAME> [<LEN>]
487 * \li Params: <NAME>: normal, protected, visible, thin, quad, qquad, enspace,
488 enskip, negthinspace, negmedspace, negthickspace, hfill,
489 hfill*, dotfill, hrulefill, hspace, hspace* \n
490 Only in math mode: med and thick.\n
491 <LEN>: length for custom spaces (hspace, hspace* for protected)
492 * \li Origin: JSpitzm, 20 May 2003, Mar 17 2008
495 { LFUN_SPACE_INSERT, "space-insert", Noop, Edit },
497 * \var lyx::FuncCode lyx::LFUN_HREF_INSERT
498 * \li Action: Inserts hyperlinks into the document (clickable in pdf output).
499 * \li Notion: Hyperlink target can be set via selection + hyperlink-insert function.
500 * \li Syntax: href-insert [<TARGET>]
501 * \li Origin: CFO-G, 21 Nov 1997
504 { LFUN_HREF_INSERT, "href-insert", Noop, Edit },
506 * \var lyx::FuncCode lyx::LFUN_SPECIALCHAR_INSERT
507 * \li Action: Inserts various characters into the document.
508 * \li Syntax: specialchar-insert <CHAR>
509 * \li Params: <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots,
510 end-of-sentence, menu-separator, lyx, tex, latex, latex2e.
511 * \li Origin: JSpitzm, 6 Dec 2007
514 { LFUN_SPECIALCHAR_INSERT, "specialchar-insert", Noop, Edit },
516 * \var lyx::FuncCode lyx::LFUN_SCRIPT_INSERT
517 * \li Action: Inserts a subscript or superscript inset.
518 * \li Syntax: script-insert <TYPE>
519 * \li Params: <TYPE>: subscript|superscript
520 * \li Origin: Georg, 23 Nov 2010
523 { LFUN_SCRIPT_INSERT, "script-insert", Noop, Edit },
525 * \var lyx::FuncCode lyx::LFUN_APPENDIX
526 * \li Action: Start (or remove) Appendix on the given cursor position.
527 * \li Syntax: appendix
528 * \li Origin: ettrich, 5 May 1998
531 { LFUN_APPENDIX, "appendix", Noop, Edit },
534 * \var lyx::FuncCode lyx::LFUN_INDEX_INSERT
535 * \li Action: Inserts Index entry.
536 * \li Notion: It automatically takes the word on the cursor position.
537 * \li Syntax: index-insert [<TYPE:Name>]
538 * \li Params: <TYPE:Name>: name of the index, if multiple indices are defined.
539 With an empty argument, the default index is selected.
540 * \li Origin: leeming, 3 Aug 2000
543 { LFUN_INDEX_INSERT, "index-insert", Noop, Edit },
545 * \var lyx::FuncCode lyx::LFUN_INDEX_PRINT
546 * \li Action: Inserts list of Index entries on a new page.
547 * \li Syntax: index-print [<TYPE:Name>]
548 * \li Params: <TYPE:Name>: name of the index, if multiple indices are defined.
549 With an empty argument, the default index is selected.
550 * \li Origin: Lgb, 27 Feb 1997
553 { LFUN_INDEX_PRINT, "index-print", Noop, Edit },
555 * \var lyx::FuncCode lyx::LFUN_IPA_INSERT
556 * \li Action: Inserts an IPA inset.
557 * \li Syntax: ipa-insert
558 * \li Origin: spitz, 05 Mar 2012
561 { LFUN_IPA_INSERT, "ipa-insert", Noop, Edit },
563 * \var lyx::FuncCode lyx::LFUN_IN_IPA
564 * \li Action: Only active in IPA inset.
565 * \li Notion: Dummy function which is only active in a IPA inset.
566 It's used to toggle the IPA toolbar if the cursor moves
569 * \li Origin: spitz, 20 May 2012
572 { LFUN_IN_IPA, "in-ipa", Noop, Edit },
574 * \var lyx::FuncCode lyx::LFUN_IPAMACRO_INSERT
575 * \li Action: Inserts special IPA macros into the document.
576 * \li Syntax: ipamacro-insert <CHAR>
577 * \li Params: <CHAR>: tone-falling, tone-rising, tone-high-rising, tone-low-rising,
578 * tone-high-rising-falling, deco bottomtiebar, deco toptiebar.
579 * \li Origin: JSpitzm, 22 Aug 2012
582 { LFUN_IPAMACRO_INSERT, "ipamacro-insert", Noop, Edit },
584 * \var lyx::FuncCode lyx::LFUN_NOMENCL_INSERT
585 * \li Action: Inserts Nomenclature entry.
586 * \li Notion: It automatically takes the word on the cursor position if no symbol is given.
587 * \li Syntax: nomencl-insert [<SYMBOL>]
588 * \li Origin: Ugras, 4 Nov 2006
591 { LFUN_NOMENCL_INSERT, "nomencl-insert", Noop, Edit },
593 * \var lyx::FuncCode lyx::LFUN_NOMENCLATURE_PRINT
594 * \li Action: Inserts list of Nomenclature entries.
595 * \li Syntax: nomenclature-print
596 * \li Origin: Ugras, 4 Nov 2006
599 { LFUN_NOMENCL_PRINT, "nomencl-print", Noop, Edit },
602 * \var lyx::FuncCode lyx::LFUN_NOTE_INSERT
603 * \li Action: Inserts Note on the current cursor position,
604 move selection inside the inset.
605 * \li Syntax: note-insert [<TYPE>]
606 * \li Params: <TYPE>: <Note|Greyedout|Comment> default: Note
609 { LFUN_NOTE_INSERT, "note-insert", Noop, Edit },
611 * \var lyx::FuncCode lyx::LFUN_NOTE_NEXT
612 * \li Action: Moves the cursor to the beginning of next Note inset.
613 * \li Syntax: note-next
616 { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
618 * \var lyx::FuncCode lyx::LFUN_PHANTOM_INSERT
619 * \li Action: Inserts phantom on the current cursor position,
620 move selection inside the inset.
621 * \li Syntax: phantom-insert [<TYPE>]
622 * \li Params: <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
623 * \li Origin: uwestoehr, 30 Jan 2009
626 { LFUN_PHANTOM_INSERT, "phantom-insert", Noop, Edit },
628 * \var lyx::FuncCode lyx::LFUN_NEWLINE_INSERT
629 * \li Action: Inserts a line break or new line.
630 * \li Syntax: newline-insert [<ARG>]
631 * \li Params: <ARG>: <newline|linebreak> default: newline
632 * \li Origin: JSpitzm, 25 Mar 2008
635 { LFUN_NEWLINE_INSERT, "newline-insert", Noop, Edit },
637 * \var lyx::FuncCode lyx::LFUN_SEPARATOR_INSERT
638 * \li Action: Inserts an environment separator or latex paragraph break.
639 * \li Syntax: separator-insert [<ARG>]
640 * \li Params: <ARG>: <plain|parbreak|latexpar> default: plain
641 * \li Origin: ef, 2 May 2014
644 { LFUN_SEPARATOR_INSERT, "separator-insert", Noop, Edit },
646 * \var lyx::FuncCode lyx::LFUN_ESCAPE
647 * \li Action: Clears the selection. If no text is selected call #LFUN_FINISHED_FORWARD.
648 Inside math mode jumps out of the math inset.
650 * \li Origin: Lgb, 17 May 2001
653 { LFUN_ESCAPE, "escape", ReadOnly, Edit },
655 * \var lyx::FuncCode lyx::LFUN_DOWN
656 * \li Action: Moves the cursor one line in downward direction.
660 { LFUN_DOWN, "down", ReadOnly | NoUpdate, Edit },
662 * \var lyx::FuncCode lyx::LFUN_UP
663 * \li Action: Moves the cursor one line in upward direction.
667 { LFUN_UP, "up", ReadOnly | NoUpdate, Edit },
669 * \var lyx::FuncCode lyx::LFUN_DOWN_SELECT
670 * \li Action: Moves the cursor one line in downward direction adding the current
671 position to the selection.
672 * \li Syntax: down-select
675 { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, Edit },
677 * \var lyx::FuncCode lyx::LFUN_UP_SELECT
678 * \li Action: Moves the cursor one line in upward direction adding the current
679 position to the selection.
680 * \li Syntax: up-select
683 { LFUN_UP_SELECT, "up-select", ReadOnly | SingleParUpdate, Edit },
685 * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN
686 * \li Action: Moves the cursor one page in downward direction.
687 * \li Syntax: screen-down
690 { LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit },
692 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP
693 * \li Action: Moves the cursor one page in upward direction.
694 * \li Syntax: screen-up
697 { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit },
699 * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN_SELECT
700 * \li Action: Moves the cursor one screen in downward direction adding the current
701 position to the selection.
702 * \li Syntax: screen-down-select
705 { LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit },
707 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP_SELECT
708 * \li Action: Moves the cursor one page in upward direction adding the current
709 position to the selection.
710 * \li Syntax: screen-up-select
713 { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit },
715 * \var lyx::FuncCode lyx::LFUN_SCROLL
716 * \li Action: Scroll the buffer view.
717 * \li Notion: Only scrolls the screen up or down; does not move the cursor.
718 * \li Syntax: scroll <TYPE> <QUANTITY>
719 * \li Params: <TYPE>: line|page\n
720 <QUANTITY>: up|down|<number>
721 * \li Origin: Abdel, Dec 27 2007
724 { LFUN_SCROLL, "scroll", ReadOnly, Edit },
726 * \var lyx::FuncCode lyx::LFUN_SCREEN_RECENTER
727 * \li Action: Recenters the screen on the current cursor position.
728 * \li Syntax: screen-recenter
731 { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit },
734 * \var lyx::FuncCode lyx::LFUN_SCREEN_SHOW_CURSOR
735 * \li Action: Repositions the screen such that the cursor is visible.
736 * \li Syntax: screen-show-cursor
737 * \li Origin: vfr, 25 Mar 2009
740 { LFUN_SCREEN_SHOW_CURSOR, "screen-show-cursor", ReadOnly, Edit },
743 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD
744 * \li Action: Moves the cursor one position logically backwards.
745 * \li Notion: This is not the action which should be bound to the arrow keys,
746 because backwards may be left or right, depending on the
747 language. The arrow keys should be bound to #LFUN_CHAR_LEFT or
748 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
749 * \li Syntax: char-backward
752 { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit },
754 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD_SELECT
755 * \li Action: Moves the cursor one position logically backwards, adding
756 traversed position to the selection.
757 * \li Notion: See also #LFUN_CHAR_BACKWARD.
758 * \li Syntax: char-backward-select
761 { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit },
763 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_BACKWARD
764 * \li Action: Deletes one character in the backward direction (usually the "BackSpace" key).
765 * \li Syntax: char-delete-backward
768 { LFUN_CHAR_DELETE_BACKWARD, "char-delete-backward", SingleParUpdate, Edit },
770 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_FORWARD
771 * \li Action: Deletes one character in the backward direction (usually the "Delete" key).
772 * \li Syntax: char-delete-forward
775 { LFUN_CHAR_DELETE_FORWARD, "char-delete-forward", SingleParUpdate, Edit },
777 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD
778 * \li Action: Moves the cursor one position logically forward.
779 * \li Notion: This is not the action which should be bound to the arrow keys,
780 because forward may be left or right, depending on the language.
781 The arrow keys should be bound to #LFUN_CHAR_LEFT or
782 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
783 * \li Syntax: char-forward
786 { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit },
788 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD_SELECT
789 * \li Action: Moves the cursor one position logically forward, adding
790 traversed position to the selection.
791 * \li Notion: See also #LFUN_CHAR_FORWARD.
792 * \li Syntax: char-forward-select
795 { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit },
797 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT
798 * \li Action: Moves the cursor one position "to the left".
799 * \li Notion: This is the action which should be taken when the "left" key
800 is pressed. Generally, it moves the cursor one position to the
801 left. However, in Bidi text this become slightly more
802 complicated, and there are different modes of cursor movement.
803 In "visual mode", this moves left, plain and simple. In "logical
804 mode", movement is logically forward in RTL paragraphs, and
805 logically backwards in LTR paragraphs.
806 * \li Syntax: char-left
809 { LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit },
811 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT_SELECT
812 * \li Action: Moves the cursor one position "to the left", adding
813 traversed position to the selection.
814 * \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement.
815 * \li Syntax: char-left-select
818 { LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit },
820 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT
821 * \li Action: Moves the cursor one position "to the right".
822 * \li Notion: This is the action which should be taken when the "right" key
823 is pressed. Generally, it moves the cursor one position to the
824 right. However, in Bidi text this become slightly more
825 complicated, and there are different modes of cursor movement.
826 In "visual mode", this moves right, plain and simple. In "logical
827 mode", movement is logically forward in LTR paragraphs, and
828 logically backwards in RTL paragraphs.
829 * \li Syntax: char-right
832 { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit },
834 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT_SELECT
835 * \li Action: Moves the cursor one position "to the right", adding
836 traversed position to the selection.
837 * \li Notion: See also #LFUN_CHAR_RIGHT for exact details of the movement.
838 * \li Syntax: char-right-select
841 { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit },
844 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD
845 * \li Action: Moves the cursor to the logically previous beginning of a word.
846 * \li Notion: This is not the action which should be bound to the arrow keys,
847 because backwards may be left or right, depending on the
848 language. The arrow keys should be bound to #LFUN_WORD_LEFT or
849 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
850 * \li Syntax: word-backward
853 { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit },
855 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD_SELECT
856 * \li Action: Moves the cursor to the logically previous beginning of a word,
857 adding the logically traversed text to the selection.
858 * \li Notion: See also #LFUN_WORD_BACKWARD.
859 * \li Syntax: word-backward-select
862 { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
864 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_BACKWARD
865 * \li Action: Deletes characters to the beginning of the word (usually the "C+BackSpace" key).
866 * \li Syntax: word-delete-backward
869 { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
871 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_FORWARD
872 * \li Action: Deletes characters to the end of the word (usually the "C+Delete" key).
873 * \li Syntax: word-delete-forward
876 { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
878 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_FORWARD
879 * \li Action: Search for a given string in forward direction.
880 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
881 * \li Syntax: word-find-forward [<STRING>]
882 * \li Origin: Etienne, 16 Feb 1998
885 { LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit },
887 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_BACKWARD
888 * \li Action: Search for a given string in backward direction.
889 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
890 * \li Syntax: word-find-backward [<STRING>]
891 * \li Origin: Etienne, 20 Feb 1998
894 { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
896 * \var lyx::FuncCode lyx::LFUN_WORD_FIND
897 * \li Action: Search for next occurrence of a string.
898 * \li Syntax: word-find [<DATA>]
899 * \li Params: <DATA>: data encoded from Find dialog (see #lyx::find2string()).
900 If no parameter is given, search with last find-dialog
901 data is used for search (i.e. find-next).
902 * \li Origin: Andre, Jan 7 2004
905 { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
907 * \var lyx::FuncCode lyx::LFUN_WORD_REPLACE
908 * \li Action: Replace a string in the document.
909 * \li Syntax: word-replace [<DATA>]
910 * \li Params: <DATA>: data is of the form
913 <casesensitive> <matchword> <all> <forward> <findnext>"
914 * \li Origin: Andre, Jan 7 2004
917 { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
919 * \var lyx::FuncCode lyx::LFUN_WORD_FINDADV
920 * \li Action: Search for next occurrence of a pattern.
921 * \li Syntax: word-findadv [<DATA>]
922 * \li Params: <DATA>: data encoded from FindAdv dialog (see #lyx::findadv2string()).
923 If no parameter is given, search with last find-dialog
924 data is used for search (i.e. find-next).
925 * \li Origin: Tommaso, Nov 15 2007
928 { LFUN_WORD_FINDADV, "word-findadv", ReadOnly | NoBuffer, Edit },
930 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD
931 * \li Action: Moves the cursor to the logically next beginning of a word.
932 * \li Notion: This is not the action which should be bound to the arrow keys,
933 because forward may be left or right, depending on the language.
934 The arrow keys should be bound to #LFUN_WORD_LEFT or
935 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
936 * \li Syntax: word-forward
939 { LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
941 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD_SELECT
942 * \li Action: Moves the cursor to the logically next beginning of a word,
943 adding the logically traversed text to the selection.
944 * \li Notion: See also #LFUN_WORD_FORWARD.
945 * \li Syntax: word-forward-select
948 { LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
950 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT
951 * \li Action: Moves the cursor to the next beginning of a word "on the left".
952 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
953 "left" key is pressed. Generally, it moves the cursor to the
954 next beginning of a word on the left. However, in Bidi text this
955 become slightly more complicated, and there are different modes
956 of cursor movement. In "visual mode", this moves left, plain and
957 simple. In "logical mode", movement is logically forward in RTL
958 paragraphs, and logically backwards in LTR paragraphs.
959 * \li Syntax: word-left
960 * \li Origin: dov, 28 Oct 2007
963 { LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
965 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT_SELECT
966 * \li Action: Moves the cursor to the next beginning of a word "on the left",
967 adding *logically* traversed text to the selection.
968 * \li Notion: See also #LFUN_WORD_LEFT for exact details of the movement.
969 * \li Syntax: word-left-select
970 * \li Origin: dov, 28 Oct 2007
973 { LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit },
975 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT
976 * \li Action: Moves the cursor to the next beginning of a word "on the right".
977 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
978 "right" key is pressed. Generally, it moves the cursor to the
979 next beginning of a word on the right. However, in Bidi text
980 this become slightly more complicated, and there are different
981 modes of cursor movement. In "visual mode", this moves right,
982 plain and simple. In "logical mode", movement is logically
983 forward in LTR paragraphs, and logically backwards in RTL
985 * \li Syntax: word-right
986 * \li Origin: dov, 28 Oct 2007
989 { LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit },
991 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT_SELECT
992 * \li Action: Moves the cursor to the next beginning of a word "on the right",
993 adding *logically* traversed text to the selection.
994 * \li Notion: See also #LFUN_WORD_RIGHT for exact details of the movement.
995 * \li Syntax: word-right-select
996 * \li Origin: dov, 28 Oct 2007
999 { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
1001 * \var lyx::FuncCode lyx::LFUN_WORD_SELECT
1002 * \li Action: Puts the word where the cursor stands into the selection.
1003 * \li Syntax: word-select
1004 * \li Origin: Andre, 11 Sep 2002
1007 { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
1009 * \var lyx::FuncCode lyx::LFUN_WORD_CAPITALIZE
1010 * \li Action: Capitalizes the words in the selection (i.e. the first letters)
1011 or the first letter of word at cursor position.
1012 * \li Syntax: word-capitalize [<SEL_TYPE>]
1013 * \li Params: <SEL_TYPE>: if this is equal to "partial", then the
1014 * default word starts at cursor position (emacs-style).
1015 * Otherwise, the whole word is considered.
1018 { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
1020 * \var lyx::FuncCode lyx::LFUN_WORD_UPCASE
1021 * \li Action: Change the words in the selection or word at cursor position
1023 * \li Syntax: word-upcase [<SEL_TYPE>]
1024 * \li Params: <SEL_TYPE>: if this is equal to "partial", then the
1025 * default word starts at cursor position (emacs-style).
1026 * Otherwise, the whole word is considered.
1029 { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
1031 * \var lyx::FuncCode lyx::LFUN_WORD_LOWCASE
1032 * \li Action: Change the words in the selection or word at cursor position
1034 * \li Syntax: word-lowcase [<SEL_TYPE>]
1035 * \li Params: <SEL_TYPE>: if this is equal to "partial", then the
1036 * default word starts at cursor position (emacs-style).
1037 * Otherwise, the whole word is considered.
1040 { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
1042 * \var lyx::FuncCode lyx::LFUN_SPELLING_ADD
1043 * \li Action: Add the word under the cursor to the respective
1044 * spell checker dictionary.
1045 * The default for the language is retrieved from the cursor position.
1046 * \li Syntax: spelling-add [<STRING>] [<LANG>]
1047 * \li Params: <WORD>: word to add
1048 <LANG>: language name (see file languages)
1049 * \li Origin: JSpitzm, 18 Jan 2010
1052 { LFUN_SPELLING_ADD, "spelling-add", ReadOnly, Edit },
1054 * \var lyx::FuncCode lyx::LFUN_SPELLING_IGNORE
1055 * \li Action: Let the spell checker ignore the word under the cursor
1056 * in the current session for the given language.
1057 * The default for the language is retrieved from the cursor position.
1058 * \li Syntax: spelling-ignore [<WORD>] [<LANG>]
1059 * \li Params: <WORD>: word to ignore
1060 <LANG>: language name (see file languages)
1061 * \li Origin: JSpitzm, 18 Jan 2010
1064 { LFUN_SPELLING_IGNORE, "spelling-ignore", ReadOnly, Edit },
1066 * \var lyx::FuncCode lyx::LFUN_SPELLING_REMOVE
1067 * \li Action: Remove the word under the cursor from the respective
1068 * spell checker dictionary.
1069 * The default for the language is retrieved from the cursor position.
1070 * \li Syntax: spelling-remove [<STRING>] [<LANG>]
1071 * \li Params: <WORD>: word to remove
1072 * <LANG>: language name (see file languages)
1073 * \li Origin: SWitt, 28 July 2010
1076 { LFUN_SPELLING_REMOVE, "spelling-remove", ReadOnly, Edit },
1079 * \var lyx::FuncCode lyx::LFUN_SPELLING_CONTINUOUSLY
1080 * \li Action: Toggle continuous spell checking.
1081 * \li Syntax: spelling-continuously
1082 * \li Origin: vfr, 24 March 2013
1085 { LFUN_SPELLING_CONTINUOUSLY, "spelling-continuously", ReadOnly, Edit },
1088 * \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
1089 * \li Action: Look up thesaurus entries with respect to the word under the cursor.
1090 * \li Syntax: thesaurus-entry [<STRING>] [lang=<LANG>]
1091 * \li Params: <STRING>: word to look up
1092 <LANG>: language (see file languages)
1093 * \li Origin: Levon, 20 Jul 2001
1096 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
1098 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN
1099 * \li Action: Move the cursor to the beginning of the document.
1100 * \li Syntax: buffer-begin
1103 { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
1105 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN_SELECT
1106 * \li Action: Move the cursor to the beginning of the document adding the
1107 traversed text to the selection.
1108 * \li Syntax: buffer-begin-select
1111 { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
1113 * \var lyx::FuncCode lyx::LFUN_BUFFER_END
1114 * \li Action: Move the cursor to the end of the document.
1115 * \li Syntax: buffer-end
1118 { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
1120 * \var lyx::FuncCode lyx::LFUN_BUFFER_END_SELECT
1121 * \li Action: Move the cursor to the end of the document adding the
1122 traversed text to the selection.
1123 * \li Syntax: buffer-end-select
1126 { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
1129 * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN
1130 * \li Action: Move the cursor to the beginning of the current inset
1131 if it is not already there, or at the beginning of the
1132 enclosing inset otherwise
1133 * \li Syntax: inset-begin
1134 * \li Origin: lasgouttes, 16 Mar 2009
1137 { LFUN_INSET_BEGIN, "inset-begin", ReadOnly, Edit },
1139 * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN_SELECT
1140 * \li Action: Move the cursor to the beginning of the current inset
1141 if it is not already there, or at the beginning of the
1142 enclosing inset otherwise (adding the
1143 traversed text to the selection).
1144 * \li Syntax: inset-begin-select
1145 * \li Origin: lasgouttes, 16 Mar 2009
1148 { LFUN_INSET_BEGIN_SELECT, "inset-begin-select", ReadOnly, Edit },
1150 * \var lyx::FuncCode lyx::LFUN_INSET_END
1151 * \li Action: Move the cursor to the end of the current inset
1152 if it is not already there, or at the end of the
1153 enclosing inset otherwise
1154 * \li Syntax: inset-end
1155 * \li Origin: lasgouttes, 16 Mar 2009
1158 { LFUN_INSET_END, "inset-end", ReadOnly, Edit },
1160 * \var lyx::FuncCode lyx::LFUN_INSET_END_SELECT
1161 * \li Action: Move the cursor to the end of the current inset
1162 if it is not already there, or at the end of the
1163 enclosing inset otherwise (adding the
1164 traversed text to the selection).
1165 * \li Syntax: inset-end-select
1166 * \li Origin: lasgouttes, 16 Mar 2009
1169 { LFUN_INSET_END_SELECT, "inset-end-select", ReadOnly, Edit },
1172 * \var lyx::FuncCode lyx::LFUN_INSET_SELECT_ALL
1173 * \li Action: Select all contents of an inset.
1174 * \li Notion: There are 3 successive levels: select current cell,
1175 * select all cells of inset, select the inset from outside
1176 * (in the enclosing inset).
1177 * \li Syntax: inset-select-all
1178 * \li Origin: vfr, 22 Aug 2009; lasgouttes 1 Nov 2014
1181 { LFUN_INSET_SELECT_ALL, "inset-select-all", ReadOnly, Edit },
1184 * \var lyx::FuncCode lyx::LFUN_SECTION_SELECT
1185 * \li Action: Select the whole section.
1186 * \li Notion: The cursor should be in a section heading
1187 before calling this lfun.
1188 * \li Syntax: section-select
1189 * \li Origin: vfr, 05 May 2009
1192 { LFUN_SECTION_SELECT, "section-select", ReadOnly, Edit },
1195 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN
1196 * \li Action: Move the cursor to the beginning of the (screen) line.
1197 * \li Syntax: line-begin
1200 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
1202 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN_SELECT
1203 * \li Action: Move the cursor to the beginning of the (screen) line adding the
1204 traversed text to the selection.
1205 * \li Syntax: line-begin-select
1208 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
1210 * \var lyx::FuncCode lyx::LFUN_LINE_END
1211 * \li Action: Move the cursor to the end of the (screen) line.
1212 * \li Syntax: line-end
1215 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
1217 * \var lyx::FuncCode lyx::LFUN_LINE_END_SELECT
1218 * \li Action: Move the cursor to the end of the (screen) line adding the
1219 traversed text to the selection.
1220 * \li Syntax: line-end-select
1223 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
1225 * \var lyx::FuncCode lyx::LFUN_LINE_DELETE_FORWARD
1226 * \li Action: Deletes the letters to the end of the (screen) line or
1227 deletes the selection.
1228 * \li Syntax: line-delete-forward
1231 { LFUN_LINE_DELETE_FORWARD, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
1233 * \var lyx::FuncCode lyx::LFUN_COPY
1234 * \li Action: Copies the current selection to the clipboard.
1238 { LFUN_COPY, "copy", ReadOnly, Edit },
1240 * \var lyx::FuncCode lyx::LFUN_CUT
1241 * \li Action: Cuts to the clipboard.
1245 { LFUN_CUT, "cut", Noop, Edit },
1247 * \var lyx::FuncCode lyx::LFUN_PASTE
1248 * \li Action: Pastes material (text or picture) from the active clipboard.
1249 * \li Syntax: paste [<TYPE>|<NUM>]
1250 * \li Params: <TYPE>: emf|pdf|png|jpeg|linkback|wmf|latex|html \n
1251 <NUM>: number of the selection in the internal clipboard stack to be pasted.
1254 { LFUN_PASTE, "paste", Noop, Edit },
1256 * \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE
1257 * \li Action: Pastes text from the active clipboard (retains formatting if the
1258 clipboard contains formatted text). Pastes plain text if plain text is
1259 on the clipboard, but tries to interpret it in special ways for certain
1260 insets, e.g. converting csv data to rows and columns if the paste happens
1262 * \li Notion: Historically, LFUN_CLIPBOARD_PASTE was introduced as a counterpart of
1263 LFUN_PRIMARY_SELECTION_PASTE: It behaved exactly the same, but the source
1264 is the clipboard, not the selection.
1265 * \li Syntax: clipboard-paste [<ARG>]
1266 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1267 * \li Origin: Georg, 10 Jul 2006
1270 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
1272 * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
1273 * \li Action: Pastes the currently selected text.
1274 * \li Notion: Primary selection mechanism is linux-only thing.
1275 * \li Syntax: primary-selection-paste [<ARG>]
1276 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1279 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
1281 * \var lyx::FuncCode lyx::LFUN_SELECTION_PASTE
1282 * \li Action: Pastes the internal selection text in permanent selection.
1283 * \li Notion: Created in order to have middle mouse button pasting correct (bound to
1284 command-alternatives selection-paste ; primary-selection-paste paragraph).
1285 * \li Syntax: selection-paste
1286 * \li Origin: lasgouttes, 14 Jan 2009
1289 { LFUN_SELECTION_PASTE, "selection-paste", Noop, Edit },
1291 * \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE_SIMPLE
1292 * \li Action: Pastes plain text from the active clipboard even if formatted
1293 LyX content is in the clipboard. Pastes plain text if plain text
1294 is on the clipboard, without trying to interpret it in special
1295 ways for certain insets, e.g. converting csv data to rows and
1296 columns if the paste happens in a tabular inset.
1297 * \li Syntax: clipboard-paste-simple [<ARG>]
1298 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1301 { LFUN_CLIPBOARD_PASTE_SIMPLE, "clipboard-paste-simple", Noop, Edit },
1303 * \var lyx::FuncCode lyx::LFUN_UNDO
1304 * \li Action: Undoes the last edit.
1308 { LFUN_UNDO, "undo", ReadOnly, Edit },
1310 * \var lyx::FuncCode lyx::LFUN_REDO
1311 * \li Action: Redoes the last thing undone.
1315 { LFUN_REDO, "redo", ReadOnly, Edit },
1317 * \var lyx::FuncCode lyx::LFUN_REPEAT
1318 * \li Action: Repeat the given command.
1319 * \li Syntax: repeat <COUNT> <LFUN-COMMAND>
1320 * \li Origin: Andre, 27 Oct 2003
1323 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
1325 * \var lyx::FuncCode lyx::LFUN_CHARS_TRANSPOSE
1326 * \li Action: Transposes the character at the cursor with the one before it.
1327 * \li Syntax: chars-transpose
1328 * \li Origin: Lgb, 25 Apr 2001
1331 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
1334 * \var lyx::FuncCode lyx::LFUN_DEPTH_DECREMENT
1335 * \li Action: Decrease the nesting depth of the (selected) paragraph(s)
1337 * \li Syntax: depth-decrement
1340 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
1342 * \var lyx::FuncCode lyx::LFUN_DEPTH_INCREMENT
1343 * \li Action: Increase the nesting depth of the (selected) paragraph(s)
1345 * \li Syntax: depth-increment
1348 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
1351 * \var lyx::FuncCode lyx::LFUN_FONT_BOLD
1352 * \li Action: Toggles the bold font (selection-wise) using mathbf in math.
1353 * \li Syntax: font-bold
1356 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
1359 * \var lyx::FuncCode lyx::LFUN_FONT_BOLDSYMBOL
1360 * \li Action: Toggles the bold font (selection-wise) using boldsymbol in math.
1361 * \li Syntax: font-boldsymbol
1364 { LFUN_FONT_BOLDSYMBOL, "font-boldsymbol", Noop, Layout },
1366 * \var lyx::FuncCode lyx::LFUN_FONT_TYPEWRITER
1367 * \li Action: Toggles the typewriter family font (selection-wise).
1368 * \li Syntax: font-typewriter
1371 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
1373 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERLINE
1374 * \li Action: Toggles underline in the font (selection-wise).
1375 * \li Syntax: font-underline
1378 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
1380 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERUNDERLINE
1381 * \li Action: Toggles double underline in the font (selection-wise).
1382 * \li Syntax: font-underunderline
1383 * \li Origin: sanda, 5 May 2009
1386 { LFUN_FONT_UNDERUNDERLINE, "font-underunderline", Noop, Layout },
1388 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERWAVE
1389 * \li Action: Toggles wavy underline in the font (selection-wise).
1390 * \li Syntax: font-underwave
1391 * \li Origin: sanda, 5 May 2009
1394 { LFUN_FONT_UNDERWAVE, "font-underwave", Noop, Layout },
1396 * \var lyx::FuncCode lyx::LFUN_FONT_STRIKEOUT
1397 * \li Action: Toggles strikeout (strike-through) in the font (selection-wise).
1398 * \li Syntax: font-strikeout
1399 * \li Origin: sanda, 3 May 2009
1402 { LFUN_FONT_STRIKEOUT, "font-strikeout", Noop, Layout },
1404 * \var lyx::FuncCode lyx::LFUN_FONT_EMPH
1405 * \li Action: Toggles the emphasis font style (selection-wise).
1406 * \li Syntax: font-emph
1409 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
1411 * \var lyx::FuncCode lyx::LFUN_FONT_NOUN
1412 * \li Action: Toggles Noun text style font (selection-wise).
1413 * \li Syntax: font-noun
1416 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
1418 * \var lyx::FuncCode lyx::LFUN_FONT_ROMAN
1419 * \li Action: Toggles Roman family font (selection-wise).
1420 * \li Syntax: font-roman
1423 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
1425 * \var lyx::FuncCode lyx::LFUN_FONT_SANS
1426 * \li Action: Toggles Sans Serif family font (selection-wise).
1427 * \li Syntax: font-sans
1430 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
1432 * \var lyx::FuncCode lyx::LFUN_FONT_FRAK
1433 * \li Action: Toggles Fraktur family font (math-mode, selection-wise).
1434 * \li Syntax: font-frak
1435 * \li Origin: vermeer, 10 Jan 2002
1438 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
1440 * \var lyx::FuncCode lyx::LFUN_FONT_ITAL
1441 * \li Action: Toggles Italics font shape (math-mode, selection-wise).
1442 * \li Syntax: font-ital
1443 * \li Origin: vermeer, 10 Jan 2002
1446 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
1448 * \var lyx::FuncCode lyx::LFUN_FONT_DEFAULT
1449 * \li Action: Reverts the settings of the font to the default values (selection-wise).
1450 * \li Syntax: font-default
1453 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
1455 * \var lyx::FuncCode lyx::LFUN_FONT_SIZE
1456 * \li Action: Sets font size according to lyx format string.
1457 * \li Syntax: font-size <SIZE>
1458 * \li Params: <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|\n
1459 largest|huge|giant|increase|decrease|default
1462 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
1464 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_APPLY
1465 * \li Action: Toggle user-defined (=last-time used) text style.
1466 * \li Notion: This style is set via #LFUN_TEXTSTYLE_UPDATE, which is
1467 automatically triggered when using Text Style dialog.
1468 * \li Syntax: textstyle-apply
1469 * \li Origin: leeming, 12 Mar 2003
1472 { LFUN_TEXTSTYLE_APPLY, "textstyle-apply", Noop, Layout },
1474 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_UPDATE
1475 * \li Action: Apply text style and update the settings to be used by #LFUN_TEXTSTYLE_APPLY.
1476 * \li Syntax: textstyle-update <FONT_INFO>
1477 * \li Params: <FONT_INFO>: specifies font atributes, e.g. family, series, shape,
1478 size, emph, noun, underbar, number, color, language,
1480 Use lyx -dbg action for exact syntax of text-style
1482 * \li Origin: leeming, 12 Mar 2003
1485 { LFUN_TEXTSTYLE_UPDATE, "textstyle-update", Noop, Layout },
1487 * \var lyx::FuncCode lyx::LFUN_SCREEN_FONT_UPDATE
1488 * \li Action: Update fonts and its metrics.
1489 * \li Notion: Automatically called after zoom, dpi, font names, or norm change.
1490 * \li Syntax: screen-font-update
1491 * \li Origin: ARRae, 13 Aug 2000
1494 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
1496 * \var lyx::FuncCode lyx::LFUN_FONT_STATE
1497 * \li Action: Returns the info about the current font.
1498 * \li Syntax: font-state
1501 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
1504 * \var lyx::FuncCode lyx::LFUN_CITATION_INSERT
1505 * \li Action: Inserts citation from loaded citation database.
1506 * \li Syntax: citation-insert [<KEY>[|<TEXT_BEFORE>]]
1507 * \li Params: <KEY>: Citation (shortcut listed in available citations). \n
1508 <TEXT_BEFORE>: text which should appear before citation.
1509 * \li Origin: AAS, 97-02-23
1512 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
1514 * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_ADD
1515 * \li Action: Adds database, which will be used for bibtex citations.
1516 * \li Notion: Databases are added to the first BibTeX inset
1517 (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
1518 * \li Syntax: bibtex-database-add <DATABASE-NAME>
1519 * \li Origin: Ale, 30 May 1997
1522 { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit },
1524 * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_DEL
1525 * \li Action: Adds database, which will be used for bibtex citations.
1526 * \li Notion: Databases are deleted from the first BibTeX inset
1527 (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
1528 * \li Syntax: bibtex-database-del <DATABASE-NAME>
1529 * \li Origin: Ale, 30 May 1997
1532 { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
1535 * \var lyx::FuncCode lyx::LFUN_LAYOUT
1536 * \li Action: Sets the layout (that is, environment) for the current paragraph.
1537 * \li Syntax: layout <LAYOUT>
1538 * \li Params: <LAYOUT>: the layout to use
1541 { LFUN_LAYOUT, "layout", Noop, Layout },
1543 * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH
1544 * \li Action: Launches the paragraph settings dialog.
1545 * \li Syntax: layout-paragraph
1548 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
1550 * \var lyx::FuncCode lyx::LFUN_LAYOUT_TABULAR
1551 * \li Action: Launches the tabular settings dialog.
1552 * \li Syntax: layout-tabular
1553 * \li Origin: Jug, 31 Jul 2000
1556 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
1558 * \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE
1559 * \li Action: Displays list of layout choices.
1560 * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
1561 dropbox allowing for choice of layout.
1562 * \li Syntax: drop-layouts-choice
1565 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
1567 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
1568 * \li Action: Clears the module list.
1569 * \li Notion: Clears the list of included modules for the current buffer.
1570 * \li Syntax: layout-modules-clear
1571 * \li Origin: rgh, 25 August 2007
1574 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", NoInternal, Layout },
1576 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULE_ADD
1577 * \li Action: Adds a module.
1578 * \li Notion: Adds a module to the list of included modules for the current buffer.
1579 * \li Syntax: layout-module-add <MODULE>
1580 * \li Params: <MODULE>: the module to be added
1581 * \li Origin: rgh, 25 August 2007
1584 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", NoInternal, Layout },
1586 * \var lyx::FuncCode lyx::LFUN_LAYOUT_RELOAD
1587 * \li Action: Reloads layout information.
1588 * \li Notion: Reloads all layout information for the current buffer from disk, thus
1589 recognizing any changes that have been made to layout files on the fly.
1590 This is intended to be used only by layout developers and should not be
1591 used when one is trying to do actual work.
1592 * \li Syntax: layout-reload
1593 * \li Origin: rgh, 3 September 2007
1596 { LFUN_LAYOUT_RELOAD, "layout-reload", NoInternal, Layout },
1598 * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW_CACHE
1599 * \li Action: Opens the file that was created from last preview of this buffer.
1600 * \li Notion: This LFUN is called by the "Show Output Anyway" button in the LaTeX
1601 * Errors dialog. It can also be called by the user, which is useful
1602 * if the document takes a long time to compile, and you just
1603 * want to see the last previewed version.
1604 * \li Syntax: buffer-view-cache
1607 { LFUN_BUFFER_VIEW_CACHE, "buffer-view-cache", ReadOnly, Buffer },
1609 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
1610 * \li Action: Sets the text class for the current buffer.
1611 * \li Syntax: textclass-apply <TEXTCLASS>
1612 * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
1613 the filename, minus the ".layout" extension.
1616 { LFUN_TEXTCLASS_APPLY, "textclass-apply", NoInternal, Layout },
1618 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
1619 * \li Action: Loads information for a textclass from disk.
1620 * \li Syntax: textclass-load <TEXTCLASS>
1621 * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
1622 the filename, minus the ".layout" extension.
1625 { LFUN_TEXTCLASS_LOAD, "textclass-load", NoInternal, Layout },
1628 * \var lyx::FuncCode lyx::LFUN_MARK_OFF
1629 * \li Action: Disable selecting of text-region.
1630 * \li Syntax: mark-off
1633 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
1635 * \var lyx::FuncCode lyx::LFUN_MARK_ON
1636 * \li Action: Enable selecting of text-region.
1637 * \li Notion: After enabling you can simply move arrow keys to get selected region.
1638 * \li Syntax: mark-on
1641 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
1643 * \var lyx::FuncCode lyx::LFUN_MARK_TOGGLE
1644 * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
1645 * \li Syntax: mark-toggle
1646 * \li Origin: Andre, May 5 2006
1649 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
1652 * \var lyx::FuncCode lyx::LFUN_MATH_DELIM
1653 * \li Action: Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
1654 * \li Syntax: math-delim [<LEFT>] [<RIGHT>]
1655 * \li Params: <LEFT/RIGHT>: Delimiters to be used. Each delimiter can be specified by
1656 either a LaTeX name or a valid character.
1657 ( is the default letter.
1658 * \li Sample: math-delim { rangle
1659 * \li Origin: Alejandro, 18 Jun 1996
1662 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
1664 * \var lyx::FuncCode lyx::LFUN_MATH_BIGDELIM
1665 * \li Action: Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
1666 * \li Syntax: math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
1667 * \li Params: <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r \n
1668 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
1669 * \li Sample: math-bigdelim "Bigl" "\Downarrow" "Bigr" "\}"
1670 * \li Origin: Enrico & Georg, 7 May 2006
1673 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
1675 * \var lyx::FuncCode lyx::LFUN_MATH_DISPLAY
1676 * \li Action: Creates a new displayed equation in text mode.
1677 Toggles inlined/display formula in math mode.
1678 * \li Syntax: math-display [<ARG>]
1679 * \li Params: <ARG>: this argument will be passed to #LFUN_MATH_INSERT when creating
1680 new equation from the text mode.
1681 * \li Origin: Alejandro, 18 Jun 1996
1684 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
1686 * \var lyx::FuncCode lyx::LFUN_MATH_INSERT
1687 * \li Action: Inserts math objects and symbols.
1688 * \li Syntax: math-insert <ARG>
1689 * \li Params: <ARG>: Symbol or LaTeX code to be inserted.
1690 * \li Notion: When <ARG> is a _single_ math inset with more than one cell
1691 (such as "x_y^z" or "\frac{x}{y}"), the content of cell(0) is
1692 replaced by the current selection (only works if the selection
1693 is in mathed). As an example, if "abc" is selected in mathed,
1694 "math-insert \frac{x}{y}" replaces "abc" with "\frac{abc}{y}",
1695 and "math-insert x_y^z" replaces "abc" with "abc_y^z".
1696 If nothing is selected (or the selection is not in mathed),
1697 math-insert works as expected.
1700 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
1702 * \var lyx::FuncCode lyx::LFUN_MATH_SUBSCRIPT
1703 * \li Action: Enters subscript expression in math expression.
1704 * \li Syntax: math-subscript
1705 * \li Origin: vermeer, 12 Dec 2001
1708 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
1710 * \var lyx::FuncCode lyx::LFUN_MATH_SUPERSCRIPT
1711 * \li Action: Enters superscript expression in math expression.
1712 * \li Syntax: math-superscript
1713 * \li Origin: vermeer, 12 Dec 2001
1716 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
1718 * \var lyx::FuncCode lyx::LFUN_MATH_LIMITS
1719 * \li Action: Toggles the position of the limits from above/below to the right
1720 side an vice versa in integral symbol, a limit, a summation, etc.
1721 * \li Notion: Put the cursor before the symbol with the limits and then invoke
1723 * \li Syntax: math-limits [<STATE>]
1724 * \li Params: <STATE>: limits|nolimits
1727 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
1729 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO
1730 * \li Action: Inserts a math macro definition at the cursor position in the text.
1731 * \li Syntax: math-macro <NAME> [<NARGS>] [def]
1732 * \li Params: <NAME>: The name of the macro, e.g. "mymacro".\n
1733 <NARGS>: The number of parameters of the macro. Default is 0.
1734 "def": Has no effect anymore, just for compatibility with former LyX versions.
1735 * \li Origin: ale, 10 May 1997; sts, 21 Dec 2007
1738 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
1740 * \var lyx::FuncCode lyx::LFUN_MATH_MUTATE
1741 * \li Action: Mutates the type of math inset to the newly selected one.
1742 * \li Syntax: math-mutate <TYPE>
1743 * \li Params: <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
1744 multline|gather|flalign
1745 * \li Origin: Andre, 23 May 2001
1748 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
1750 * \var lyx::FuncCode lyx::LFUN_MATH_SPACE
1751 * \li Action: Inserts space into math expression.
1752 * \li Notion: Use spacebar after entering this space to change type of space.
1753 * \li Syntax: math-space [<TYPE>] [<LEN>]
1754 * \li Params: <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace \n
1755 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad \n
1756 custom space: hspace \n
1757 "," used by default.\n
1758 Note that ! is equivalent to negthinspace, , = thinspace,
1759 : = medspace, and ; = thickspace.\n
1760 <LEN>: length for custom spaces (hspace)
1761 * \li Origin: Andre, 25 Jul 2001; sanda, 16 Jun 2008
1764 { LFUN_MATH_SPACE, "math-space", Noop, Math },
1766 * \var lyx::FuncCode lyx::LFUN_MATH_MATRIX
1767 * \li Action: Inserts a matrix.
1768 * \li Syntax: math-matrix <COLS> <ROWS> [<ALIGN>]
1769 * \li Params: <ALIGN>: Alignment is a word composed of the vertical alignment
1770 (b, c or t) (i.e. 1 char) and the horizontal alignments
1771 (l, c or r) (i.e. <COL> chars).
1772 * \li Sample: math-matrix 3 3 bccc
1775 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
1777 * \var lyx::FuncCode lyx::LFUN_MATH_AMS_MATRIX
1778 * \li Action: Inserts an extended matrix as provided by the amsmath package.
1779 * \li Syntax: math-matrix <COLS> <ROWS> [<DECORATION>]
1780 * \li Params: <DECORATION>: Decoration determines the LaTeX name of the matrix
1781 that should be created. Possible values include
1782 pmatrix, bmatrix, Bmatrix, vmatrix, Vmatrix and
1783 matrix. The default is 'matrix'.
1784 * \li Sample: math-ams-matrix 3 3 bmatrix
1787 { LFUN_MATH_AMS_MATRIX, "math-ams-matrix", Noop, Math },
1789 * \var lyx::FuncCode lyx::LFUN_MATH_MODE
1790 * \li Action: In text mode enters math mode (i.e. puts math insets on the current
1791 cursor position), in math mode enters text mode inside math expression.
1792 * \li Notion: If there is some selected text, it puts the text inside created math box.
1793 * \li Syntax: math-mode [on|<ARG>]
1794 * \li Params: <ARG>: eventual argument (LaTeX code) is passed to #LFUN_MATH_INSERT .\n
1795 "on": allow only entering of math mode from text mode.
1796 * \li Origin: Alejandro, 4 Jun 1996
1799 { LFUN_MATH_MODE, "math-mode", Noop, Math },
1801 * \var lyx::FuncCode lyx::LFUN_REGEXP_MODE
1802 * \li Action: Enters regexp mode (i.e., puts regexp insets on the current
1803 cursor position). Used by the advanced search dialog.
1804 * \li Notion: If there is any selected text, then it is moved inside the created
1806 * \li Syntax: regexp-mode [<ARG>]
1807 * \li Params: <ARG>: eventual argument (regular expression).
1808 * \li Origin: Tommaso, 4 Oct 2008
1811 { LFUN_REGEXP_MODE, "regexp-mode", Noop, Math },
1813 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
1814 * \li Action: Toggles numbering of the current formula line.
1815 * \li Notion: Must be in display formula mode.
1816 * \li Syntax: math-number-line-toggle
1817 * \li Origin: Alejandro, 18 Jun 1996
1820 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
1822 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
1823 * \li Action: Toggles numbering/labeling of the current formula.
1824 * \li Notion: Must be in display formula mode.
1825 * \li Syntax: math-number-toggle
1826 * \li Origin: Alejandro, 4 Jun 1996
1829 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
1831 * \var lyx::FuncCode lyx::LFUN_MATH_EXTERN
1832 * \li Action: Calls external program and passes the current expression/equation
1833 as an argument for the calculation in the format appropriate to the
1835 * \li Notion: Selection can be used to determine the input for the external program.
1836 * \li Syntax: math-extern <LANG> [<COMMAND>]
1837 * \li Params: <LANG>: octave|maxima|maple|mathematica|script \n
1838 where "script" stands for the external script (normalized
1839 expression will be passed)
1840 * \li Origin: Andre, 24 Apr 2001
1841 * \li Sample: math-extern maple simplify
1844 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
1846 * \var lyx::FuncCode lyx::LFUN_MATH_SIZE
1847 * \li Action: Changes arbitrarily the size used by math fonts inside a context.
1848 * \li Notion: Provides an interface to the LaTeX math mode font size commands.
1849 * \li Syntax: math-size <STYLE>
1850 * \li Params: <STYLE>: \displaystyle|\textstyle|\scriptstyle|\scriptscriptstyle
1851 * \li Origin: Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
1854 { LFUN_MATH_SIZE, "math-size", Noop, Math },
1856 * \var lyx::FuncCode lyx::LFUN_MATH_FONT_STYLE
1857 * \li Action: Changes the text style used in math.
1858 * \li Syntax: math-font-style <STYLE>
1859 * \li Params: <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf|textnormal\n
1860 |textrm|textsf|texttt|textbf|textmd|textit|textsc|textsl|textup
1861 * \li Origin: vfr, 9 jan 2009
1864 { LFUN_MATH_FONT_STYLE, "math-font-style", Noop, Math },
1866 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
1867 * \li Action: Unfold a Math Macro.
1868 * \li Notion: Unfold the Math Macro the cursor is in, i.e.
1870 * \li Syntax: math-macro-unfold
1871 * \li Origin: sts, 06 January 2008
1874 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
1876 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
1877 * \li Action: Fold a Math Macro.
1878 * \li Notion: Fold the Math Macro the cursor is in if it was
1879 unfolded, i.e. displayed as \foo before.
1880 * \li Syntax: math-macro-fold
1881 * \li Origin: sts, 06 January 2008
1884 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
1886 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
1887 * \li Action: Add a parameter.
1888 * \li Notion: Add a parameter to a Math Macro.
1889 * \li Params: <NUM>: The number of the parameter behind which the new one
1890 will be added (1 for the first, i.e. use 0 for add a
1891 parameter at the left), defaults to the last one.
1892 * \li Syntax: math-macro-add-param <NUM>
1893 * \li Origin: sts, 06 January 2008
1896 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
1898 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
1899 * \li Action: Remove the last parameter.
1900 * \li Notion: Remove the last parameter of a Math Macro and
1901 remove its value in all instances of the macro
1903 * \li Params: <NUM>: The number of the parameter to be deleted (1 for
1904 the first), defaults to the last one.
1905 * \li Syntax: math-macro-remove-param <NUM>
1906 * \li Origin: sts, 06 January 2008
1909 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
1911 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
1912 * \li Action: Append a greedy parameter.
1913 * \li Notion: Append a greedy parameter to a Math Macro which
1914 eats the following mathed cell in every instance of
1915 the macro in the buffer.
1916 * \li Syntax: math-macro-append-greedy-param
1917 * \li Origin: sts, 06 January 2008
1920 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
1922 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
1923 * \li Action: Remove a greedy parameter.
1924 * \li Notion: Remove a greedy parameter of a Math Macro and spit
1925 out the values of it in every instance of the macro
1926 in the buffer. If it is an optional parameter the [valud]
1928 * \li Syntax: math-macro-remove-greedy-param
1929 * \li Origin: sts, 06 January 2008
1932 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
1934 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
1935 * \li Action: Make a parameter optional.
1936 * \li Notion: Turn the first non-optional parameter of a Math Macro
1937 into an optional parameter with a default value.
1938 * \li Syntax: math-macro-make-optional
1939 * \li Origin: sts, 06 January 2008
1942 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
1944 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
1945 * \li Action: Make a parameter non-optional.
1946 * \li Notion: Turn the last optional parameter of a Math Macro
1947 into a non-optional parameter. The default value is
1948 remembered to be reused later if the user changes his mind.
1949 * \li Syntax: math-macro-make-nonoptional
1950 * \li Origin: sts, 06 January 2008
1953 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
1955 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
1956 * \li Action: Add an optional parameter.
1957 * \li Notion: Insert an optional parameter just behind the
1958 already existing optional parameters.
1959 * \li Syntax: math-macro-add-optional-param
1960 * \li Origin: sts, 06 January 2008
1963 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
1965 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
1966 * \li Action: Remove the last optional parameter.
1967 * \li Notion: Remove the last optional parameter of a Math Macro and
1968 remove it in all the instances of the macro in the buffer.
1969 * \li Syntax: math-macro-remove-optional-param
1970 * \li Origin: sts, 06 January 2008
1973 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
1975 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
1976 * \li Action: Add a greedy optional parameter.
1977 * \li Notion: Add a greedy optional parameter which eats the value
1978 from the following cells in mathed which are in the [value]
1980 * \li Syntax: math-macro-add-greedy-optional-param
1981 * \li Origin: sts, 06 January 2008
1984 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
1986 * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
1987 * \li Action: Only active in Math Macro definition.
1988 * \li Notion: Dummy function which is only active in a Math Macro definition.
1989 It's used to toggle the Math Macro toolbar if the cursor moves
1990 into a Math Macro definition.
1991 * \li Syntax: in-mathmacrotemplate
1992 * \li Origin: sts, 06 January 2008
1995 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
1998 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
1999 * \li Action: Moves the current paragraph downwards in the document.
2000 * \li Syntax: paragraph-move-down
2001 * \li Origin: Edwin, 8 Apr 2006
2004 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
2006 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
2007 * \li Action: Moves the current paragraph upwards in the document.
2008 * \li Notion: Movement through the document will possibly break the paragraph-depth
2009 (e.g. itemize structure).
2010 * \li Syntax: paragraph-move-up
2011 * \li Origin: Edwin, 8 Apr 2006
2014 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
2017 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP
2018 * \li Action: Move the cursor to the next paragraph (or beginning of the current one)
2019 in upward direction.
2020 * \li Syntax: paragraph-up
2021 * \li Origin: Asger, 1 Oct 1996
2024 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
2026 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP_SELECT
2027 * \li Action: Move the cursor and select the text to the next paragraph (or
2028 beginning of the current one) in upward direction.
2029 * \li Syntax: paragraph-up-select
2030 * \li Origin: Asger, 1 Oct 1996
2033 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
2035 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN
2036 * \li Action: Move the cursor to the next paragraph (or beginning of the current one)
2037 in downward direction.
2038 * \li Syntax: paragraph-down
2039 * \li Origin: Asger, 1 Oct 1996
2042 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
2044 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN_SELECT
2045 * \li Action: Move the cursor and select the text to the next paragraph (or
2046 beginning of the current one) in downward direction.
2047 * \li Syntax: paragraph-down-select
2048 * \li Origin: Asger, 1 Oct 1996
2051 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
2053 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
2054 * \li Action: Jump to a paragraph given by its id number and optionally the
2055 desired position within the paragraph.
2056 If given four arguments id_start, pos_start, id_end, pos_end,
2057 perform a selection from start to end.
2058 * \li Notion: Note that id number of paragraph is not the sequential number of
2059 paragraph seen on the screen. Moreover the id is unique for all
2060 opened buffers (documents). Both ids must belong to the same
2062 * \li Syntax: paragraph-goto <PAR_ID> <POS_IN_PAR> [<PAR_ID> <POS_IN_PAR>]
2063 * \li Params: <PAR_ID>: paragraph id \n
2064 <POS_IN_PAR>: desired position within the paragraph
2065 * \li Origin: Dekel, 26 Aug 2000
2069 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly | NoInternal, Edit },
2071 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_BREAK
2072 * \li Action: Breaks the current paragraph at the current location.
2073 * \li Notion: Removes the selection.
2074 * \li Syntax: paragraph-break [<LAYOUT>]
2075 * \li Params: <LAYOUT>: "inverse" - decreases depth by one (or change layout
2076 to default layout) when the cursor is at the end of
2080 { LFUN_PARAGRAPH_BREAK, "paragraph-break", Noop, Edit },
2082 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
2083 * \li Action: Change paragraph settings.
2084 * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
2085 This function only modifies, and does not override, existing settings.
2086 Note that the "leftindent" indent setting is deprecated.
2087 * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
2088 * \li Params: <INDENT>: \noindent|\indent|\indent-toggle|\leftindent LENGTH\n
2089 <SPACING>: \paragraph_spacing default|single|onehalf|double|other SIZE \n
2090 <ALIGN>: \align block|left|right|center|default\n
2091 <OTHERS>: \labelwidthstring WIDTH|\start_of_appendix
2092 * \li Origin: rgh, Aug 15 2007
2095 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
2097 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
2098 * \li Action: Change paragraph settings.
2099 * \li Notion: Overwrite all nonspecified settings to the default ones.
2100 Use paragraph-params lfun if you don't want to overwrite others settings.
2101 * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
2102 * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
2103 * \li Origin: leeming, 30 Mar 2004
2106 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
2108 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UPDATE
2109 * \li Action: Updates the values inside the paragraph dialog from the paragraph.
2110 * \li Notion: This is an internal LFUN, not to be used by users. Called internally
2111 by #LFUN_DIALOG_UPDATE.
2112 * \li Origin: leeming, 13 Mar 2003
2115 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
2118 * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
2119 * \li Action: Move the current group in the upward direction in the
2120 structure of the document.
2121 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
2122 the whole substructure of the group.
2123 * \li Syntax: outline-up
2124 * \li Origin: Vermeer, 23 Mar 2006
2127 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
2129 * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
2130 * \li Action: Move the current group in the downward direction in the
2131 structure of the document.
2132 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
2133 the whole substructure of the group.
2134 * \li Syntax: outline-down
2135 * \li Origin: Vermeer, 23 Mar 2006
2138 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
2140 * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
2141 * \li Action: Moves the current group in the downward direction in the
2142 hierarchy of the document structure.
2143 * \li Notion: Part -> Chapter -> Section -> etc.
2144 * \li Syntax: outline-in
2145 * \li Origin: Vermeer, 23 Mar 2006
2148 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
2150 * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
2151 * \li Action: Moves the current group in the upward direction in the
2152 hierarchy of the document structure.
2153 * \li Notion: Part <- Chapter <- Section <- etc.
2154 * \li Syntax: outline-out
2155 * \li Origin: Vermeer, 23 Mar 2006
2158 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
2161 * \var lyx::FuncCode lyx::LFUN_INSET_EDIT
2162 * \li Action: Edit the inset at cursor with an external application,
2163 if one is attributed.
2164 * \li Syntax: inset-edit [<INSET_PARAMS>]
2165 * \li Params: <INSET_PARAMS>: Parameters for the inset. \n
2166 Currently only the filename will be considered.
2167 * \li Origin: JSpitzm, 27 Apr 2006
2170 { LFUN_INSET_EDIT, "inset-edit", ReadOnly | AtPoint, Edit },
2173 * \var lyx::FuncCode lyx::LFUN_TABULAR_INSERT
2174 * \li Action: Inserts table into the document.
2175 * \li Notion: See #LFUN_TABULAR_FEATURE for some more details
2176 about tabular modifications.
2177 * \li Syntax: tabular-insert [<ROWS> <COLUMNS>]
2178 * \li Params: In case no arguments are given show insert dialog.
2179 * \li Origin: Jug, 12 Apr 2000
2182 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
2185 * \var lyx::FuncCode lyx::LFUN_CELL_BACKWARD
2186 * \li Action: Moves the cursor to the previous cell inside the table.
2187 * \li Syntax: cell-backward
2188 * \li Origin: Jug, 22 May 2000
2191 { LFUN_CELL_BACKWARD, "cell-backward", ReadOnly | NoUpdate, Edit },
2193 * \var lyx::FuncCode lyx::LFUN_CELL_FORWARD
2194 * \li Action: Moves the cursor to the next cell inside the table.
2195 * \li Syntax: cell-forward
2198 { LFUN_CELL_FORWARD, "cell-forward", ReadOnly | NoUpdate, Edit },
2200 * \var lyx::FuncCode lyx::LFUN_CELL_SPLIT
2201 * \li Action: Splits cell and shifts right part to the next cell (inside the math grid).
2202 * \li Syntax: cell-split
2203 * \li Origin: Ale, 15 May 1997
2206 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
2209 * \var lyx::FuncCode lyx::LFUN_VC_REGISTER
2210 * \li Action: Register the document as an file inside version control system.
2211 * \li Notion: File is registered inside cvs, svn or rcs repository acording to the existence
2212 of cvs/svn/rcs entries in the document's directory. \n
2213 See LyX Additional Features Manual (Version Control Chapter) for additional
2215 * \li Syntax: vc-register
2216 * \li Origin: Lgb, 1 Jul 1997
2219 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
2221 * \var lyx::FuncCode lyx::LFUN_VC_RENAME
2222 * \li Action: Renames the document to another name.
2223 * \li Notion: Renaming with revision history is only supported by SVN.
2224 For CVS it is simulated by adding the document under a new
2225 name and deleting the old one. For RCS it is not supported.
2226 Disabled if uncommitted changes exist.
2227 * \li Syntax: vc-rename <FILENAME>
2228 * \li Params: <FILENAME>: New name of the document.\n
2229 * A file dialog is opened if no filename is given.
2230 * \li Origin: gb, 05 Feb 2013
2233 { LFUN_VC_RENAME, "vc-rename", ReadOnly, System },
2235 * \var lyx::FuncCode lyx::LFUN_VC_COPY
2236 * \li Action: Copies the document to another name.
2237 * \li Notion: Copying with revision history is only supported by SVN.
2238 For RCS and CVS it is simulated by adding the document
2240 Disabled if uncommitted changes exist.
2241 * \li Syntax: vc-copy <FILENAME>
2242 * \li Params: <FILENAME>: New name of the document.\n
2243 * A file dialog is opened if no filename is given.
2244 * \li Origin: gb, 05 Feb 2013
2247 { LFUN_VC_COPY, "vc-copy", ReadOnly, System },
2249 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_IN
2250 * \li Action: Checks-in/commits the changes of the registered file to the repository.
2251 * \li Notion: In RCS case this also unlocks the file.
2252 * \li Syntax: vc-check-in
2253 * \li Origin: Lgb, 1 Jul 1997
2256 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
2258 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_OUT
2259 * \li Action: Checks-out the document for edit (and locks it in some cases).
2260 * \li Syntax: vc-check-out
2261 * \li Origin: Lgb, 1 Jul 1997
2264 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
2266 * \var lyx::FuncCode lyx::LFUN_VC_REVERT
2267 * \li Action: Reverts the document to the last check-in/commit in VCS.
2268 * \li Syntax: vc-revert
2269 * \li Origin: Lgb, 1 Jul 1997
2272 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
2274 * \var lyx::FuncCode lyx::LFUN_VC_UNDO_LAST
2275 * \li Action: Undo last check-in.
2276 * \li Notion: This is currently implemented only for RCS.
2277 * \li Syntax: vc-check-out
2278 * \li Origin: Lgb, 1 Jul 1997
2281 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
2283 * \var lyx::FuncCode lyx::LFUN_VC_COMMAND
2284 * \li Action: Executes external command. This command is intended to support
2285 additional VCS commands.
2286 * \li Syntax: vc-command <FLAG> <PATH> <COMMAND>
2287 * \li Params: <FLAG>: Flags for the command can be combined together.\n
2288 U - dUmmy - no flags \n
2289 D - Doc - need document loaded to proceed \n
2290 I - dIrty - mark document dirty \n
2291 R - Reload - ensure that the document is saved and reload it after command execution \n
2292 M - Message - ask for input string (commit message)\n
2293 <PATH>: path where to start. $$p will be replaced by the current document path.\n
2294 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current
2295 document(with absolute path)/path/message.
2296 * \li Sample: vc-command DR $$p "svn up"
2297 * \li Origin: sanda, 13 Jan 2009
2300 { LFUN_VC_COMMAND, "vc-command", NoBuffer | ReadOnly, System },
2302 * \var lyx::FuncCode lyx::LFUN_VC_LOCKING_TOGGLE
2303 * \li Action: Toggles the locking property of the edited file.
2304 * \li Notion: This is currently implemented only for SVN.
2305 * \li Syntax: vc-locking-toggle
2306 * \li Origin: sanda, 25 Jun 2009
2309 { LFUN_VC_LOCKING_TOGGLE, "vc-locking-toggle", ReadOnly, System },
2311 * \var lyx::FuncCode lyx::LFUN_VC_REPO_UPDATE
2312 * \li Action: Update the local archive directory in which resides
2313 the current document with the remote repository.
2314 * \li Syntax: vc-repo-update
2315 * \li Origin: sanda, 16 Oct 2009
2318 { LFUN_VC_REPO_UPDATE, "vc-repo-update", ReadOnly, System },
2320 * \var lyx::FuncCode lyx::LFUN_VC_COMPARE
2321 * \li Action: Compares two revisions of the same file under version control.
2322 * \li Syntax: vc-compare [<REV1>] [<REV2>]
2323 * \li Params: Revision number either points directly to commit in history
2324 or if negative number -x it points to (last commit - x).\n
2325 In RCS we subtract only in the last number of revision specification.
2326 Special case "0" is reserved for the last committed revision.\n
2327 <REV1>: Older file.\n
2328 <REV2>: Newer file. Used only if REV1 > 0.\n
2329 If no parameter is given, interactive dialog will be shown.
2330 * \li Sample: Compare current document against last commit\n
2332 Compare current document against current revision - 5 commits\n
2334 Compare revisions 120 and 155\n
2336 * \li Origin: sanda, 12 Feb 2010
2339 { LFUN_VC_COMPARE, "vc-compare", ReadOnly, System },
2342 * \var lyx::FuncCode lyx::LFUN_CHANGES_TRACK
2343 * \li Action: Toggles change tracking to on/off.
2344 * \li Syntax: changes-track
2345 * \li Origin: levon, 1 Oct 2002
2348 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
2350 * \var lyx::FuncCode lyx::LFUN_CHANGES_OUTPUT
2351 * \li Action: Toggles showing of change tracking in typeset output.
2352 * \li Syntax: changes-output
2353 * \li Origin: jspitzm, 21 Jan 2005
2356 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
2358 * \var lyx::FuncCode lyx::LFUN_CHANGE_NEXT
2359 * \li Action: Moves the cursor to the position of the next change
2360 of the change tracking records.
2361 * \li Syntax: change-next
2362 * \li Origin: schmitt, 4 Oct 2006
2365 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
2367 * \var lyx::FuncCode lyx::LFUN_CHANGE_PREVIOUS
2368 * \li Action: Moves the cursor to the position of the previous change
2369 of the change tracking records.
2370 * \li Syntax: change-previous
2371 * \li Origin: vfr, 4 Apr 2009
2374 { LFUN_CHANGE_PREVIOUS, "change-previous", ReadOnly, Edit },
2376 * \var lyx::FuncCode lyx::LFUN_CHANGES_MERGE
2377 * \li Action: Open change tracking dialog for merging and moves the cursor
2378 to the position of the next change.
2379 * \li Syntax: changes-merge
2380 * \li Origin: Levon, 16 Oct 2002
2383 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
2385 * \var lyx::FuncCode lyx::LFUN_CHANGE_ACCEPT
2386 * \li Action: Accepts tracked change inside the selection.
2387 * \li Syntax: change-accept
2388 * \li Origin: Levon, 16 Oct 2002
2391 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
2393 * \var lyx::FuncCode lyx::LFUN_CHANGE_REJECT
2394 * \li Action: Rejects tracked change inside the selection.
2395 * \li Syntax: change-reject
2396 * \li Origin: Levon, 16 Oct 2002
2399 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
2401 * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_ACCEPT
2402 * \li Action: Accepts all tracked changes in the document.
2403 * \li Syntax: all-changes-accept
2404 * \li Origin: Levon, 16 Oct 2002
2407 { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
2409 * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_REJECT
2410 * \li Action: Rejects all tracked changes in the document.
2411 * \li Notion: Reject does not work recursively; the user may have to repeat the operation.
2412 * \li Syntax: all-changes-reject
2413 * \li Origin: Levon, 16 Oct 2002
2416 { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
2419 * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
2420 * \li Action: Apply data for an inset.
2421 * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
2422 be applied. This is either changed to #LFUN_INSET_MODIFY or
2423 #LFUN_INSET_INSERT depending on the context where it is called.
2424 * \li Syntax: inset-apply <ARGS>
2425 * \li Params: See #LFUN_INSET_INSERT .
2428 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
2430 * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE
2431 * \li Action: Dissolve the current inset into text.
2432 * \li Syntax: inset-dissolve [<INSET>]
2433 * \li Params: <INSET>: this can be used to make sure the right kind of inset
2434 is dissolved. For example "dissolve" entry in the charstyles
2435 sub-menu should only dissolve the charstyle inset, even if the
2436 cursor is inside several nested insets of different type.\n
2437 For values see #lyx::InsetLayout::lyxtype_ .
2438 * \li Origin: JSpitz, 7 Aug 2006
2441 { LFUN_INSET_DISSOLVE, "inset-dissolve", AtPoint, Edit },
2443 * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
2444 * \li Action: Insert new inset (type given by the parameters).
2445 * \li Syntax: inset-insert <INSET> <ARGS>
2446 * \li Params: <INSET>: <bibitem|bibtex|citation|ert|listings|external|graphics|tabular|\n
2447 hyperlink|include|index|label|line|nomencl|vspace|ref|toc|script>\n
2448 <ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
2449 * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
2450 where <label name> is the name of the referenced label and
2451 <Format> is one of the following: \n
2452 ref -- <reference> \n
2453 eqref -- (<reference>) \n
2454 pageref -- <page> \n
2455 vpageref -- on <page> \n
2456 vref -- <reference> on <page> \n
2457 formatted -- Formatted reference
2460 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
2462 * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
2463 * \li Action: Modify some properties of an inset.
2464 * \li Notion: Used for bibitem, bibtex, box, branch, command, ert, external,
2465 floats, graphics, include, index, info, label,
2466 listings, newline, newpage, nomencl, note, phantom,
2467 ref, space, tabular, vspace, wrap insets.
2468 * \li Syntax: inset-modify <INSET> <ARGS> \n
2469 inset-modify changetype <TYPE>
2470 * \li Sample: inset-modify note Note Comment \n
2471 inset-modify changetype Ovalbox
2474 { LFUN_INSET_MODIFY, "inset-modify", AtPoint, Edit },
2476 * \var lyx::FuncCode lyx::LFUN_TABULAR_FEATURE
2477 * \li Action: Modify properties of tabulars and table-like math environments.
2478 * \li Syntax: tabular-feature <FEATURE> [<ARG>]
2479 * \li Params: Generally see #LFUN_INSET_INSERT for further details.\n
2480 * <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|\n
2481 copy-column|move-column-right|move-column-left|move-row-down|move-row-up|\n
2482 toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|\n
2483 align-left|align-right|align-center|align-block|align-decimal|set-decimal-point|\n
2484 valign-top|valign-bottom|valign-middle|longtabular-align-left|\n
2485 longtabular-align-center|longtabular-align-right|m-align-left|m-align-right|\n
2486 m-align-center|m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|\n
2487 set-all-lines|unset-all-lines|toggle-longtabular|set-longtabular|unset-longtabular|set-pwidth|\n
2488 set-mpwidth|set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|\n
2489 set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|\n
2490 unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|\n
2491 set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|\n
2492 set-special-column|set-special-multicolumn|set-special-multirow|\n
2493 toggle-booktabs|set-booktabs|unset-booktabs|set-top-space|set-bottom-space|\n
2494 set-interline-space|set-border-lines|tabular-valign-top|\n
2495 tabular-valign-middle|tabular-valign-bottom|set-tabular-width\n
2496 Various math-environment features are handled as well, e.g. add-vline-left/right for\n
2497 the Grid/Array environment.\n
2498 <ARG>: additional argument for some commands, use debug mode to explore its values.
2499 * \li Origin: gm, 10 Dec 2015
2502 { LFUN_TABULAR_FEATURE, "tabular-feature", Noop, Edit },
2504 * \var lyx::FuncCode lyx::LFUN_INSET_DIALOG_UPDATE
2505 * \li Action: Updates the values inside the dialog from the inset.
2506 * \li Notion: This is an internal LFUN, not to be used by users. Called internally
2507 by #LFUN_DIALOG_UPDATE
2508 * \li Params: <DIALOG-NAME>
2509 * \li Origin: leeming, 25 Feb 2003
2512 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
2514 * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
2515 * \li Action: Open the inset's properties dialog.
2516 * \li Notion: Used for bibitem, bibtex, box, branch, citation, ert, external,
2517 float, graphics, href, include, index, index_print, label, line,
2518 listings, note, phantom, ref, space, tabular, vspace, wrap insets.
2519 * \li Syntax: inset-settings <INSET>
2520 * \li Params: <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|\n
2521 graphics|href|include|index|index_print|label|line|\n
2522 listings|note|phantom|ref|space|tabular|vspace|wrap>.
2525 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly | AtPoint, Edit },
2527 * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
2528 * \li Action: Toggles the collapsible inset at cursor position,
2529 or the inset we are currently in.
2530 * \li Syntax: inset-toggle [<ARG>]
2531 * \li Params: <ARG>: <open|close|toggle|assign>. \n
2532 open/close/toggle are for collapsible insets. toggle is used when no argument is given.\n
2533 assign synchronize the branch-inset with activation status of the branch.
2534 Used for global toggling when changed activation.
2535 * \li Origin: lasgouttes, 19 Jul 2001
2538 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly | AtPoint, Edit },
2540 * \var lyx::FuncCode lyx::LFUN_INSET_FORALL
2541 * \li Action: Apply the given commands on insets of a given name.
2542 * \li Notion: WARNING: use at your own risks; this function gives
2543 you too many ways of shooting yourself in the foot.
2544 A typical example is
2545 inset-forall Note note-insert
2546 which starts an infinite loop. This is mitigated by the fact
2547 that the number of actions is arbitrarily limited to 100000.
2548 Note also that inset-forall does not update metrics between
2549 iterations, which can lead to bugs. This has to be eventually
2551 * \li Syntax: inset-forall <NAME> <LFUN-COMMAND> \n
2552 <NAME>: Type of Inset. If <NAME> is *, all insets are matched.
2553 The name is used like for InsetLayout in layout files: "Note"
2554 matches all note insets, while "Note:Note" only matches LyX
2556 * \li Sample: Remove all index insets: \n
2557 inset-forall Index char-delete-forward \n
2558 Close all Notes (also works for a particular branch, for example): \n
2559 inset-forall Note inset-toggle close \n
2560 Transform all yellow notes to comments \n
2561 inset-forall Note:Note inset-modify note Note Comment \n
2562 Try to put LyX in an infinite loop if there is at least a Note: \n
2563 inset-forall Note char-backward
2564 * \li Origin: lasgouttes, 27 Nov 2009
2567 { LFUN_INSET_FORALL, "inset-forall", ReadOnly, Edit },
2570 * \var lyx::FuncCode lyx::LFUN_GRAPHICS_RELOAD
2571 * \li Action: Reloads the image if necessary.
2572 * \li Syntax: graphics-reload
2573 * \li Origin: vfr, 10 Aug 2009
2576 { LFUN_GRAPHICS_RELOAD, "graphics-reload", ReadOnly | AtPoint, Edit },
2578 * \var lyx::FuncCode lyx::LFUN_SET_GRAPHICS_GROUP
2579 * \li Action: Set the group for the graphics inset on the cursor position.
2580 * \li Syntax: set-graphics-group [<GROUP>]
2581 * \li Params: <GROUP>: Id for an existing group. In case the Id is an empty string,
2582 the graphics inset is removed from the current group.
2583 * \li Origin: sanda, 6 May 2008
2586 { LFUN_SET_GRAPHICS_GROUP, "set-graphics-group", Noop, Edit },
2589 * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
2590 * \li Action: Moves the cursor out of the current slice, going forward.
2591 * \li Notion: Cursor movement within an inset may be different than cursor
2592 movement in the surrounding text. This action should be called
2593 automatically by the cursor movement within the inset, when
2594 movement within the inset has ceased (reached the end of the
2595 last paragraph, for example), in order to move correctly
2596 back into the surrounding text.
2599 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
2601 * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
2602 * \li Action: Moves the cursor out of the current slice, going backwards.
2603 * \li Notion: See also #LFUN_FINISHED_FORWARD.
2606 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
2608 * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
2609 * \li Action: Moves the cursor out of the current slice, going right.
2610 * \li Notion: See also #LFUN_FINISHED_FORWARD
2613 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
2615 * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
2616 * \li Action: Moves the cursor out of the current slice, going left.
2617 * \li Notion: See also #LFUN_FINISHED_FORWARD.
2620 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
2623 * \var lyx::FuncCode lyx::LFUN_LANGUAGE
2624 * \li Action: Set language from the current cursor position.
2625 * \li Syntax: language <LANG> [set]
2626 * \li Params: <LANG>: Requested language. Look in lib/languages for
2627 the list. "language reset" or "language" (without param)
2628 reset to the document language.
2629 set: If used, the language will be set to the specified
2630 language. Otherwise, the language will be toggled (i.e., if
2631 the current language is LANG, switch to the document language
2632 or the default language, if LANG is the document language).
2633 * \li Origin: Dekel, 2 Mar 2000
2636 { LFUN_LANGUAGE, "language", Noop, Edit },
2639 * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
2640 * \li Action: Goto a label.
2641 * \li Syntax: label-goto [<LABEL>]
2642 * \li Params: <LABEL>: Requested label. If no label is given and reference
2643 is on cursor position, Bookmark 0 is saved and
2644 cursor moves to the position of referenced label.
2645 * \li Origin: Ale, 6 Aug 1997
2648 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
2650 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT
2651 * \li Action: Inserts label to text or displayed formula.
2652 * \li Syntax: label-insert [<LABEL>]
2653 * \li Params: <LABEL>: Requested label. If no label is given dialog requesting
2654 name will be opened.
2657 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
2659 * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
2660 * \li Action: Go to the next label or cross-reference.
2661 * \li Syntax: reference-next
2662 * \li Origin: Dekel, 14 Jan 2001
2665 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
2668 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
2669 * \li Action: Moves the cursor to the numbered bookmark, opening the file
2670 if necessary. Note that bookmarks are saved per-session, not
2672 * \li Notion: Bookmark 0 has a special purpose. It is automatically set \n
2673 1. to the paragraph you are currently editing \n
2674 2. to the paragraph from where you are jumping to the last-edited
2675 position (jump-back feature) \n
2676 3. when jumping from crossreference to the requested label by
2678 * \li Syntax: bookmark-goto <NUMBER>
2679 * \li Params: <NUMBER>: the number of the bookmark to restore.
2680 * \li Origin: Dekel, 27 January 2001
2683 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
2685 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
2686 * \li Action: Save a bookmark.
2687 * \li Notion: Saves a numbered bookmark to the sessions file. The number
2688 must be between 1 and 9, inclusive. Note that bookmarks are
2689 saved per-session, not per file.
2690 * \li Syntax: bookmark-save <NUMBER>
2691 * \li Params: <NUMBER>: the number of the bookmark to save.
2692 * \li Origin: Dekel, 27 January 2001
2695 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
2697 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
2698 * \li Action: Clears the list of saved bookmarks.
2699 * \li Syntax: bookmark-clear
2700 * \li Origin: bpeng, 31 October 2006
2703 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
2706 * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
2707 * \li Action: Open the given help file according to the language setting.
2708 * \li Syntax: help-open <FILE>[.lyx]
2709 * \li Params: <FILE>: any document from (/usr/share/)doc directory.
2710 * \li Origin: Jug, 27 Jun 1999
2713 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
2715 * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
2716 * \li Action: Terminates the current LyX instance.
2717 * \li Notion: Terminates the current LyX instance, asking whether to save
2718 modified documents, etc.
2719 * \li Syntax: lyx-quit
2722 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
2724 * \var lyx::FuncCode lyx::LFUN_LYX_ACTIVATE
2725 * \li Action: Activates the LyX window.
2726 * \li Notion: On Linux and Mac OS, this action brings the LyX window
2727 into focus. Such behavior is not allowed by Windows OS
2728 so instead the color of the taskbar entry is changed to
2729 indicate that the window has changed in some way.
2730 This action is useful in combination with reverse search.
2731 * \li Syntax: lyx-activate
2732 * \li Origin: skostysh, 4 Aug 2016
2735 { LFUN_LYX_ACTIVATE, "lyx-activate", ReadOnly | NoBuffer, Hidden },
2737 * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
2738 * \li Action: Toggles visibility of a given toolbar between on/off/auto.
2739 * \li Notion: Skipping "auto" when allowauto is false.
2740 * \li Syntax: toolbar-toggle <NAME> [allowauto]
2741 * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|\n
2742 minibuffer|review|view/update|math_panels|vcs|
2743 view-others|update-others
2744 * \li Origin: Edwin, 21 May 2007
2747 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
2749 * \var lyx::FuncCode lyx::LFUN_MENU_OPEN
2750 * \li Action: Opens the menu given by its name.
2751 * \li Syntax: menu-open <NAME>
2752 * \li Params: <NAME>: menu name. See various .inc files in lib/ui for candidates.
2755 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
2757 * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
2758 * \li Action: Various UI visibility-toggling actions.
2759 * \li Syntax: ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
2760 * \li Params: statusbar : Toggle visibility of the statusbar.\n
2761 menubar : Toggle visibility of the menubar.\n
2762 scrollbar : Toggle visibility of the scrollbar.\n
2763 frame : Toggle visibility of the frames around editing window.\n
2764 fullscreen : Toggle fullscreen mode. This also covers calling the
2765 previous functions. However #LFUN_TOOLBAR_TOGGLE for the
2766 custom tweaks of the toolbars should be used.
2767 * \li Origin: sanda, 9 Feb 2007
2770 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
2773 * \var lyx::FuncCode lyx::LFUN_WINDOW_NEW
2774 * \li Action: Creates new empty LyX window.
2775 * \li Notion: Already opened documents from the previous window can be found under View menu.
2776 * \li Syntax: window-new [<GEOMETRY>]
2777 * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently
2778 accepted only on Windows platform.
2779 * \li Origin: Abdel, 21 Oct 2006
2782 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
2784 * \var lyx::FuncCode lyx::LFUN_WINDOW_CLOSE
2785 * \li Action: Closes the current LyX window.
2786 * \li Syntax: window-close
2787 * \li Origin: Abdel, 23 Oct 2006
2790 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
2793 * \var lyx::FuncCode lyx::LFUN_VIEW_SPLIT
2794 * \li Action: Creates another split view of current buffer.
2795 * \li Notion: All split views act in the same way independently.
2796 * \li Syntax: view-split <vertical|horizontal>
2797 * \li Params: horizontal : The work areas are laid out side by side.\n
2798 vertical : The work areas laid out vertically.
2799 * \li Origin: Abdel, 20 Feb 2008
2802 { LFUN_VIEW_SPLIT, "view-split", ReadOnly, Buffer },
2805 * \var lyx::FuncCode lyx::LFUN_VIEW_CLOSE
2806 * \li Action: Close the current document work area.
2807 * \li Notion: Close the current work area. If no other work areas are showing the buffer,
2808 then close the associated buffer as well.
2809 * \li Syntax: view-close
2810 * \li Origin: Tommaso, 15 Sep 2012
2813 { LFUN_VIEW_CLOSE, "view-close", ReadOnly, Buffer },
2816 * \var lyx::FuncCode lyx::LFUN_TAB_GROUP_CLOSE
2817 * \li Action: Close the current tab group.
2818 * \li Notion: This only closes the work areas, not the buffers themselves.
2819 The still opened buffers can be visualized in another tab group.
2820 * \li Syntax: tab-group-close
2821 * \li Origin: Abdel, 21 Feb 2008
2824 { LFUN_TAB_GROUP_CLOSE, "tab-group-close", ReadOnly, Buffer },
2827 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW
2828 * \li Action: Shows hidden dialog or creates new one for a given function/inset settings etc.
2829 * \li Syntax: dialog-show <NAME> [<DATA>]
2830 * \li Params: <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|\n
2831 compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|\n
2832 graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimiter|\n
2833 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|\n
2834 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|\n
2835 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL> \n
2836 <SPECIAL>: latexlog|vclog \n
2837 <DATA>: data, usually settings for the given dialog. Use debug mode for the
2839 * \li Origin: leeming, 17 Jun 2003
2842 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
2844 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW_NEW_INSET
2845 * \li Action: Shows hidden dialog or create new one for a given inset settings etc.
2846 * \li Notion: Internally uses #LFUN_DIALOG_SHOW with processed data for a given inset.
2847 * \li Syntax: dialog-show-new-inset <NAME> [<DATA>]
2848 * \li Params: See #LFUN_DIALOG_SHOW .
2849 * \li Origin: leeming, 25 Feb 2003
2852 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
2854 * \var lyx::FuncCode lyx::LFUN_DIALOG_UPDATE
2855 * \li Action: Updates the dialog values from the inset/paragraph/document.
2856 * \li Syntax: dialog-update <NAME>
2857 * \li Params: <NAME>: paragraph|prefs|<INSET> \n
2859 * \li Origin: leeming, 25 Feb 2003
2862 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
2864 * \var lyx::FuncCode lyx::LFUN_DIALOG_HIDE
2865 * \li Action: Hides showed dialog. Counterpart to #LFUN_DIALOG_SHOW .
2866 * \li Syntax: dialog-hide <NAME>
2867 * \li Params: See #LFUN_DIALOG_SHOW .
2868 * \li Origin: leeming, 25 Feb 2003
2871 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
2873 * \var lyx::FuncCode lyx::LFUN_DIALOG_TOGGLE
2874 * \li Action: Toggles dialog between showed/hidden state.
2875 * \li Notion: Internally uses #LFUN_DIALOG_SHOW , #LFUN_DIALOG_HIDE .
2876 * \li Syntax: dialog-toggle <NAME> [<DATA>]
2877 * \li Params: See #LFUN_DIALOG_SHOW .
2878 * \li Origin: JSpitzm, 30 Apr 2007
2881 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
2883 * \var lyx::FuncCode lyx::LFUN_DIALOG_DISCONNECT_INSET
2884 * \li Action: Closes opened connection to opened inset.
2885 * \li Notion: Connection is used for apply functions.
2886 * \li Syntax: dialog-disconnect-inset <INSET-NAME>
2887 * \li Origin: leeming, 25 Feb 2003
2890 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
2893 * \var lyx::FuncCode lyx::LFUN_MOUSE_PRESS
2894 * \li Action: This function is called when mouse button is pressed (inside workarea).
2895 Action depends on the context.
2896 * \li Notion: This is an internal LFUN, not to be used by users.
2897 * \li Origin: Andre, 9 Aug 2002
2900 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
2902 * \var lyx::FuncCode lyx::LFUN_MOUSE_DOUBLE
2903 * \li Action: This function is called when double click on mouse button is
2904 pressed (inside workarea). Action depends on the context.
2905 * \li Notion: This is an internal LFUN, not to be used by users.
2906 * \li Origin: Andre, 9 Aug 2002
2909 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
2911 * \var lyx::FuncCode lyx::LFUN_MOUSE_TRIPLE
2912 * \li Action: This function is called when triple click on mouse button is
2913 pressed (inside workarea). Action depends on the context.
2914 * \li Notion: This is an internal LFUN, not to be used by users.
2915 * \li Origin: Andre, 9 Aug 2002
2918 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
2920 * \var lyx::FuncCode lyx::LFUN_MOUSE_MOTION
2921 * \li Action: This function is called when mouse cursor is moving over the text.
2922 Action depends on the context.
2923 * \li Notion: This is an internal LFUN, not to be used by users.
2924 * \li Origin: Andre, 9 Aug 2002
2927 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
2929 * \var lyx::FuncCode lyx::LFUN_MOUSE_RELEASE
2930 * \li Action: This function is called when mouse button is released (inside workarea).
2931 Action depends on the context.
2932 * \li Notion: This is an internal LFUN, not to be used by users.
2933 * \li Origin: Andre, 9 Aug 2002
2936 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
2939 * \var lyx::FuncCode lyx::LFUN_KEYMAP_OFF
2940 * \li Action: Turn off the loaded keyboard map.
2941 * \li Syntax: keymap-off
2944 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
2946 * \var lyx::FuncCode lyx::LFUN_KEYMAP_PRIMARY
2947 * \li Action: Turn on the primary keyboard map.
2948 * \li Notion: Maps were widely used in past, when X-windows didn't have nowadays
2949 keyboard support. They can be still used to maintain uniform keyboard
2950 layout across the various platforms.\n
2951 The language is to be set in the Preferences dialog.
2952 * \li Syntax: keymap-primary
2955 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
2957 * \var lyx::FuncCode lyx::LFUN_KEYMAP_SECONDARY
2958 * \li Action: Turn on the secondary keyboard map.
2959 * \li Syntax: keymap-secondary
2962 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
2964 * \var lyx::FuncCode lyx::LFUN_KEYMAP_TOGGLE
2965 * \li Action: Toggles keyboard maps (first/second/off).
2966 * \li Syntax: keymap-toggle
2967 * \li Origin: leeming, 30 Mar 2004
2970 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
2973 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_LAYOUT
2974 * \li Action: Returns the current layout (that is environment) name
2975 on the cursor position.
2976 * \li Syntax: server-get-layout
2979 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
2981 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_FILENAME
2982 * \li Action: Returns path and file name of the currently edited document.
2983 * \li Syntax: server-get-filename
2986 { LFUN_SERVER_GET_FILENAME, "server-get-filename", ReadOnly, System },
2988 * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
2989 * \li Action: Sets the cursor position in LyX based on the row number of generated TeX file.
2990 * \li Notion: This can be useful for DVI inverse-search or detection of the problematic
2991 line from LaTeX compilation. Note that before this function can be used
2992 export to LaTeX output must occur (in order to map the row numbers).
2993 * \li Syntax: server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
2994 * \li Params: <FILE>: the path and filename. Environment variables are expanded in the path.
2995 In case this LFUN does not work make sure you are giving correct
2997 If the file is located inside LyX temporary directory it will be
2998 mapped back into the appropriate opened buffer (e.g. for the case
2999 of generated .tex file).\n
3000 .ext: extensions will be automatically replaced by .lyx.\n
3001 <ROW_NUMBER> The row number of the LaTeX file to which to go.
3002 * \li Sample: server-goto-file-row /home/user/example.lyx 41\n
3003 server-goto-file-row /tmp/lyx_tmpdir.XM3088/lyx_tmpbuf0/example.tex 41
3004 * \li Origin: Edmar, 23 Dec 1998
3007 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly | NoBuffer, System },
3009 * \var lyx::FuncCode lyx::LFUN_FORWARD_SEARCH
3010 * \li Action: Sets the cursor position in the previewed (dvi/pdf) file based on the row
3011 number in LyX window.
3012 * \li Notion: The external program used for forward search call can be specified in
3013 LyX Output preferences. See Additional manual for details of these
3015 * \li Syntax: forward-search
3016 * \li Origin: sanda, 14 Apr 2010
3019 { LFUN_FORWARD_SEARCH, "forward-search", ReadOnly, System },
3021 * \var lyx::FuncCode lyx::LFUN_SERVER_NOTIFY
3022 * \li Action: Sends notify message about the last key-sequence to client.
3023 * \li Notion: This can be used to grab last key-sequence used inside the LyX window.
3024 See also Debug extensions section in Additional features manual.
3025 * \li Syntax: server-notify
3028 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
3030 * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
3031 * \li Action: Sets the cursor position based on the editing area coordinates
3032 (similar to clicking on that point with left mouse button).
3033 * \li Syntax: server-set-xy <X> <Y>
3036 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
3038 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
3039 * \li Action: Returns the coordinates of cursor position in the editing area.
3040 * \li Syntax: server-get-xy
3043 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
3046 * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
3047 * \li Action: Generates the code (literate programming).
3048 * \li Notion: Latex file with extension \literate_extension is generated.
3049 Then LyX invokes \build_command (with a default of ``make'') to generate the code and
3050 \build_error_filter to process the compilation error messages. \n
3051 In case you want to process your literate file with a script, or some other program,
3052 just insert in your lyxrc file an entry with:\n
3053 \build_command "my_script my_arguments" \n
3054 The \build_error_filter differs from the \literate_error_filter only in that the
3055 former will identify error messages from your compiler.
3056 * \li Syntax: build-program
3059 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
3062 * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
3063 * \li Action: Saves the current buffer to a temporary file.
3064 * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
3065 is called automatically by LyX, to "autosave" the current buffer.
3066 * \li Syntax: buffer-auto-save
3069 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
3071 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHILD_OPEN
3072 * \li Action: Loads the given child document.
3073 * \li Notion: The current document is treated as a parent.
3074 * \li Syntax: buffer-child-open <FILE>
3075 * \li Params: <FILE>: Filename of the child. The directory of the parent is assumed by default.
3076 * \li Origin: Ale, 28 May 1997
3079 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
3081 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHKTEX
3082 * \li Action: Runs chktex for the current document.
3083 * \li Syntax: buffer-chktex
3084 * \li Origin: Asger, 30 Oct 1997
3087 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
3089 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
3090 * \li Action: Toggles compression of the current document on/off.
3091 * \li Syntax: buffer-toggle-compression
3092 * \li Origin: bpeng, 27 Apr 2006
3095 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
3097 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_OUTPUT_SYNC
3098 * \li Action: Toggles including of resources for forward/reverse search of the given document.
3099 * \li Notion: When toggled on, SyncTeX is invoked for PDF, while srcltx package
3100 is used for DVI. Custom LaTeX macro can be defined in preferences.
3101 * \li Syntax: buffer-toggle-output-sync
3102 * \li Origin: sanda, 25 May 2010
3105 { LFUN_BUFFER_TOGGLE_OUTPUT_SYNC, "buffer-toggle-output-sync", Noop, System },
3107 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
3108 * \li Action: Closes the current buffer.
3109 * \li Notion: Closes the current buffer, asking whether to save it, etc,
3110 if the buffer has been modified.
3111 * \li Syntax: buffer-close
3114 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
3116 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE_ALL
3117 * \li Action: Closes all buffers.
3118 * \li Notion: Closes all buffers, asking whether to save it, etc,
3119 if a buffer has been modified.
3120 * \li Syntax: buffer-close-all
3123 { LFUN_BUFFER_CLOSE_ALL, "buffer-close-all", ReadOnly, Buffer },
3125 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
3126 * \li Action: Exports the current buffer (document) to the given format.
3127 * \li Syntax: buffer-export <FORMAT> [<DEST>]
3128 * \li Params: <FORMAT> is either "custom" or one of the formats which you
3129 can find in Tools->Preferences->File formats->Format.
3130 Usual format you will enter is "pdf2" (pdflatex),
3131 "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
3132 In case of "custom" you will be asked for a format you
3133 want to start from and for the command that you want to
3134 apply to this format. Internally the control is then passed
3135 to #LFUN_BUFFER_EXPORT_CUSTOM.
3136 <DEST> If present, this argument provides the export destination
3137 filename. Its containing folder will also be the destination
3138 folder, where all the needed external files will be copied.
3139 * \li Origin: Lgb, 29 Jul 1997
3142 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
3144 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
3145 * \li Action: Exports the current buffer (document) from the given format using
3146 the given command on it.
3147 * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
3148 * \li Params: <FORMAT> format to start from (LyX will care to produce such
3149 intermediate file).\n
3150 <COMMAND> this command will be launched on the file. Note that you can
3151 use "$$FName" string to qualify the intermediate file.
3152 * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
3153 * \li Origin: leeming, 27 Mar 2004
3156 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
3158 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_AS
3159 * \li Action: Opens a dialog for exporting the current buffer.
3160 * \li Syntax: buffer-export-as [<FORMAT>]
3161 * \li Params: <FORMAT> is the export format initially selected in the dialog.
3162 * You can pass any of the formats which you can find in
3163 * Tools->Preferences->File formats->Format, provided it
3164 * has the "document" flag set. If no format is specified
3165 * the dialog will start with the default output format of
3166 * the current document.
3167 * \li Sample: buffer-export-as pdf2
3168 * \li Origin: tommaso, 6 Oct 2011
3171 { LFUN_BUFFER_EXPORT_AS, "buffer-export-as", ReadOnly, Buffer },
3173 * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
3174 * \li Action: Import a given file as a lyx document.
3175 * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
3176 defined converters in preferences. Look in the File->Import menu to get
3177 an idea of the currently active import formats.
3178 * \li Syntax: buffer-import <FORMAT> [<FILE>]
3179 * \li Origin: Asger, 24 Jul 1998
3182 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
3184 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
3185 * \li Action: Creates a new buffer (that is, document) and switches to it.
3186 * \li Notion: Implicit path can be set in Preferences dialog.
3187 * \li Syntax: buffer-new [<FILE>]
3188 * \li Params: <FILE>: filename of created file with absolute path.
3191 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
3193 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
3194 * \li Action: Creates a new buffer (that is, document) from a template.
3195 * \li Notion: Path for new files and templates can be set in Preferences dialog.
3196 Template will be asked for via Open-dialog.
3197 * \li Syntax: buffer-new-template [<FILE>]
3198 * \li Params: <FILE>: filename of created file with absolute path.
3201 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
3203 * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
3204 * \li Action: Reverts opened document.
3205 * \li Syntax: buffer-reload
3206 * \li Origin: Asger, 2 Feb 1997
3209 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
3211 * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
3212 * \li Action: Display and switch to the given buffer.
3213 * \li Syntax: buffer-switch <BUFFER>
3214 * \li Params: <BUFFER>: path and filename of already opened (but possibly hidden)
3215 document which is to be shown.
3218 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
3220 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
3221 * \li Action: Toggle editing mode of the current document between read/write and read-only.
3222 * \li Notion: This function is not allowed if the file is under version control, since
3223 read-only flag is often used in version control file locking.
3224 * \li Syntax: buffer-toggle-read-only
3225 * \li Origin: Lgb, 27 May 1997
3228 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
3230 * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
3231 * \li Action: Displays current buffer in chosen format.
3232 * \li Notion: Displays the contents of the current buffer in the chosen
3233 format, for example, PDF or DVI. This runs the necessary
3234 converter, calls the defined viewer, and so forth.
3235 * \li Syntax: buffer-view [<FORMAT>]
3236 * \li Params: <FORMAT>: The format to display, where this is one of the
3237 formats defined (in the current GUI) in the
3238 Tools>Preferences>File Formats dialog.
3239 If no format is given, the default format as
3240 specified in the same dialog is used.
3243 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
3245 * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
3246 * \li Action: Exports the current document and put the result into the
3247 temporary directory.
3248 * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
3249 the output will be rewritten - updated. This is useful in case your viewer
3250 is able to detect such changes (e.g. ghostview for postscript).
3251 * \li Syntax: buffer-update [<FORMAT>]
3252 * \li Params: <FORMAT>: The format to display, where this is one of the
3253 formats defined (in the current GUI) in the
3254 Tools>Preferences>File Formats dialog.
3255 If no format is given, the default format as
3256 specified in the same dialog is used.
3257 * \li Origin: Dekel, 5 Aug 2000
3260 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
3263 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
3264 * \li Action: Saves the current buffer.
3265 * \li Notion: Saves the current buffer to disk, using the filename that
3266 is already associated with the buffer, asking for one if
3267 none is yet assigned.
3268 * \li Syntax: buffer-write
3271 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
3273 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
3274 * \li Action: Rename and save current buffer.
3275 * \li Syntax: buffer-write-as <FILENAME>
3276 * \li Params: <FILENAME>: New name of the buffer/file. A relative path
3277 is with respect to the original location of the buffer/file.
3280 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
3282 * \var lyx::FuncCode lyx::LFUN_BUFFER_FORALL
3283 * \li Action: Applies a command to all non-hidden buffers.
3284 * \li Notion: a buffer is `hidden' if it is internally open in LyX, but not
3285 visible in any window.
3286 * \li Syntax: buffer-forall <LFUN-COMMAND>
3287 * \li Params: <LFUN-COMMAND>: The command to be applied to the buffers.
3288 * \li Sample: Close all Notes in buffers: \n
3289 buffer-forall inset-forall Note inset-toggle close \n
3290 Toggle change tracking on buffers: \n
3291 buffer-forall changes-track \n
3292 Toggle read-only for buffers: \n
3293 buffer-forall buffer-toggle-read-only \n
3294 Show statistics for individual buffers: \n
3295 buffer-forall statistics \n
3296 Activate the branch named "Solutions" in buffers: \n
3297 buffer-forall branch-activate Solutions \n
3298 Export buffers to PDF (pdflatex): \n
3299 buffer-forall buffer-export pdf2 \n
3300 * \li Origin: skostysh, 20 Jul 2012
3303 { LFUN_BUFFER_FORALL, "buffer-forall", ReadOnly | Argument, Buffer },
3305 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
3306 * \li Action: Save all changed documents.
3307 * \li Syntax: buffer-write-all
3308 * \li Origin: rgh, gpothier 6 Aug 2007
3311 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
3313 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEXT
3314 * \li Action: Switch to the next opened document.
3315 * \li Notion: Note that this does not necessarily mean next in tabbar
3316 (for full list see View menu).
3317 * \li Syntax: buffer-next
3320 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
3322 * \var lyx::FuncCode lyx::LFUN_BUFFER_MOVE_NEXT
3323 * \li Action: Moves the current tab one spot to the right.
3324 * \li Syntax: buffer-move-next
3325 * \li Origin: skostysh, 7 Apr 2015
3328 { LFUN_BUFFER_MOVE_NEXT, "buffer-move-next", ReadOnly, Buffer },
3330 * \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS
3331 * \li Action: Switch to the previous opened document.
3332 * \li Syntax: buffer-previous
3335 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
3337 * \var lyx::FuncCode lyx::LFUN_BUFFER_MOVE_PREVIOUS
3338 * \li Action: Moves the current tab one spot to the left.
3339 * \li Syntax: buffer-move-previous
3340 * \li Origin: skostysh, 7 Apr 2015
3343 { LFUN_BUFFER_MOVE_PREVIOUS, "buffer-move-previous", ReadOnly, Buffer },
3345 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
3346 * \li Action: Update (export) the document built from the master buffer,
3347 if the current buffer is part of a master/child document.
3348 * \li Syntax: master-buffer-update [<FORMAT>]
3349 * \li Params: <FORMAT>: The format to display, where this is one of the
3350 formats defined (in the current GUI) in the
3351 Tools>Preferences>File Formats dialog.
3352 If no format is given, the default format as
3353 specified in the same dialog is used.
3354 * \li Origin: Tommaso, 20 Sep 2007
3357 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
3359 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
3360 * \li Action: Show a preview built from the master buffer, if available.
3361 if the current buffer is part of a master/child document.
3362 * \li Syntax: master-buffer-view [<FORMAT>]
3363 * \li Params: <FORMAT>: The format to display, where this is one of the
3364 formats defined (in the current GUI) in the
3365 Tools>Preferences>File Formats dialog.
3366 If no format is given, the default format as
3367 specified in the same dialog is used.
3368 * \li Origin: Tommaso, 20 Sep 2007
3371 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
3373 * \var lyx::FuncCode lyx::LFUN_BUFFER_LANGUAGE
3374 * \li Action: Set language of the current document.
3375 * \li Syntax: buffer-language <LANG>
3376 * \li Params: <LANG>: language name. See lib/languages for list.
3377 * \li Origin: leeming, 30 Mar 2004
3380 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
3382 * \var lyx::FuncCode lyx::LFUN_BUFFER_SAVE_AS_DEFAULT
3383 * \li Action: Save the current document settings as default.
3384 * \li Notion: The file will will be saved into ~/.lyx/templates/defaults.lyx .
3385 * \li Syntax: buffer-save-as-default [<ARGS>]
3386 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
3387 you can find in document header of usual .lyx file.
3388 * \li Origin: leeming, 30 Mar 2004
3391 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
3393 * \var lyx::FuncCode lyx::LFUN_BUFFER_PARAMS_APPLY
3394 * \li Action: Apply the given settings to the current document.
3395 * \li Syntax: buffer-params-apply [<ARGS>]
3396 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
3397 you can find in document header of usual .lyx file.
3398 * \li Origin: leeming, 30 Mar 2004
3401 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", NoInternal, Buffer },
3404 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
3405 * \li Action: Inserts another LyX file.
3406 * \li Syntax: file-insert [<FILE>]
3407 * \li Params: <FILE>: Filename to be inserted.
3410 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
3412 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
3413 * \li Action: Inserts plain text file.
3414 * \li Syntax: file-insert-plaintext [<FILE>]
3415 * \li Params: <FILE>: Filename to be inserted.
3416 * \li Origin: CFO-G, 19 Nov 1997
3419 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
3421 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
3422 * \li Action: Inserts plain text file as paragraph (i.e. join lines).
3423 * \li Syntax: file-insert-plaintext-para [<FILE>]
3424 * \li Params: <FILE>: Filename to be inserted.
3425 * \li Origin: Levon, 14 Feb 2001
3428 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
3430 * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
3431 * \li Action: Open LyX document.
3432 * \li Syntax: file-open [<FILE>]
3433 * \li Params: <FILE>: Filename to be opened.
3436 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
3439 * \var lyx::FuncCode lyx::LFUN_CALL
3440 * \li Action: Executes a command defined in a .def file.
3441 * \li Notion: The definitions are by default read from lib/commands/default.def.\n
3442 A .def file allows to define a command with \define "<NAME>" "<LFUN>"
3443 where <NAME> is the name of the new command and <LFUN> is the lfun code
3444 to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
3445 \def_file "FileName" allows to include another .def file. \n
3446 This is particularly useful in connection with toolbar buttons:
3447 Since the name of the button image for this lfun is
3448 lib/images/commands/<NAME>.png this is the way to assign an image
3449 to a complex command-sequence.
3450 * \li Syntax: call <NAME>
3451 * \li Params: <NAME>: Name of the command that must be called.
3452 * \li Origin: broider, 2 Oct 2007
3455 { LFUN_CALL, "call", NoBuffer, System },
3457 * \var lyx::FuncCode lyx::LFUN_META_PREFIX
3458 * \li Action: Simulate halting Meta key (Alt key on PCs).
3459 * \li Notion: Used for buffer edition not for GUI control.
3460 * \li Syntax: meta-prefix
3463 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
3465 * \var lyx::FuncCode lyx::LFUN_CANCEL
3466 * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
3467 * \li Syntax: cancel
3470 { LFUN_CANCEL, "cancel", NoBuffer, System },
3473 * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
3474 * \li Action: Switches the focus to the minibuffer so that the user can type
3475 in there. If necessary, it opens the minibuffer toolbar.
3476 * \li Notion: Usually bound to M-x shortcut.
3477 * \li Syntax: command-execute
3480 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
3483 * \var lyx::FuncCode lyx::LFUN_COMMAND_PREFIX
3484 * \li Action: Return the current key sequence and available options as a string.
3485 * \li Notion: No options are added if no current map exists. \n
3486 This is probably usable only with connection to lyxserver.
3487 * \li Syntax: command-prefix
3490 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
3492 * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
3493 * \li Action: Run more commands (LFUN and its parameters) in a sequence.
3494 * \li Syntax: command-sequence <CMDS>
3495 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
3496 * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
3497 * \li Origin: Andre, 11 Nov 1999
3500 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
3502 * \var lyx::FuncCode lyx::LFUN_COMMAND_ALTERNATIVES
3503 * \li Action: Runs the first listed command that is enabled.
3504 * \li Notion: This can be used to bind multiple functions to a single key,
3505 and then which one is used will depend upon the context.
3506 * \li Syntax: command-alternatives <CMDS>
3507 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
3508 * \li Sample: command-alternatives completion-accept;cell-forward
3509 * \li Origin: rgh, 24 September 2008
3512 { LFUN_COMMAND_ALTERNATIVES, "command-alternatives", NoBuffer, System },
3514 * \var lyx::FuncCode lyx::LFUN_MESSAGE
3515 * \li Action: Shows message in statusbar (for script purposes).
3516 * \li Syntax: message <STRING>
3517 * \li Origin: Lgb, 8 Apr 2001
3520 { LFUN_MESSAGE, "message", NoBuffer, System },
3522 * \var lyx::FuncCode lyx::LFUN_DEBUG_LEVEL_SET
3523 * \li Action: Set debug output level.
3524 * \li Syntax: debug-level-set <LEVEL>
3525 * \li Params: <LEVEL>: comma separated list of levels or the correspondent number
3526 of their combination. 0 is equivalent to disabling all debug
3527 events. See lyx -dbg for the current list of debug levels
3529 * \li Origin: sanda, 28 Dec 2009
3532 { LFUN_DEBUG_LEVEL_SET, "debug-level-set", NoBuffer, System },
3535 * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
3536 * \li Action: Save user preferences.
3537 * \li Syntax: preferences-save
3538 * \li Origin: Lgb, 27 Nov 1999
3541 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
3543 * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
3544 * \li Action: Reconfigure the automatic settings.
3545 * \li Syntax: reconfigure
3546 * \li Origin: Asger, 14 Feb 1997
3549 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
3551 * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
3552 * \li Action: Apply the given settings to user preferences.
3553 * \li Syntax: lyxrc-apply <SETTINGS>
3554 * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
3555 to get an idea which commands to use and their syntax.
3556 #lyx::LyXRC::LyXRCTags has the list of possible commands.
3559 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
3561 * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
3562 * \li Action: Determine whether to keep cursor inside the editing window regardless
3563 of the scrollbar movement.
3564 * \li Syntax: toggle-cursor-follows-scrollbar
3565 * \li Origin: ARRae, 2 Dec 1997
3568 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
3570 * \var lyx::FuncCode lyx::LFUN_SET_COLOR
3571 * \li Action: Set the given LyX color to the color defined by the X11 name given.
3572 * \li Notion: A new color entry is created if the color is unknown.
3573 Color names can be stored as a part of user settings.
3574 * \li Syntax: set-color <LYX_NAME> <X11_NAME>
3575 * \li Origin: SLior, 11 Jun 2000
3578 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
3580 * \var lyx::FuncCode lyx::LFUN_STATISTICS
3581 * \li Action: Count the statistics (number of words and characters)
3582 in the document or in the given selection and display it
3584 * \li Notion: Note that this function gives the number of words/chars written,
3585 not the number of characters which will be typeset.
3586 * \li Syntax: statistics
3587 * \li Origin: lasgouttes, Jan 27 2004; sanda, Jan 8 2008
3590 { LFUN_STATISTICS, "statistics", ReadOnly, System },
3592 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_STATISTICS
3593 * \li Action: Returns the statistics (number of words and characters)
3594 in the document or in the given selection.
3595 * \li Notion: Note that this function gives the number of words/chars written,
3596 not the number of characters which will be typeset.
3597 * \li Syntax: server-get-statistics [<TYPE>]
3598 * \li Params: <TYPE>: <words|chars|chars-space> The requested count; if not
3599 specified, the three values are returned, separated
3601 words: count words.\n
3602 chars: count characters.\n
3603 chars-space: count characters and spaces.
3604 * \li Origin: brokenclock, Oct 10 2014
3607 { LFUN_SERVER_GET_STATISTICS, "server-get-statistics", ReadOnly, System },
3609 * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
3610 * \li Action: Show the inline completion at the cursor position.
3611 * \li Syntax: completion-inline
3612 * \li Origin: sts, Feb 19 2008
3615 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
3617 * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
3618 * \li Action: Show the completion popup at the cursor position.
3619 * \li Syntax: completion-popup
3620 * \li Origin: sts, Feb 19 2008
3623 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
3625 * \var lyx::FuncCode lyx::LFUN_COMPLETE
3626 * \li Action: Try to complete the word or command at the cursor position.
3627 * \li Syntax: complete
3628 * \li Origin: sts, Feb 19 2008
3631 { LFUN_COMPLETE, "complete", SingleParUpdate, Edit },
3634 * \var lyx::FuncCode lyx::LFUN_COMPLETION_CANCEL
3635 * \li Action: Try to cancel completion, either the popup or the inline completion.
3636 * \li Syntax: completion-cancel
3637 * \li Origin: sts, Sep 07 2008
3640 { LFUN_COMPLETION_CANCEL, "completion-cancel", SingleParUpdate, Edit },
3642 * \var lyx::FuncCode lyx::LFUN_COMPLETION_ACCEPT
3643 * \li Action: Accept suggested completion.
3644 * \li Syntax: completion-accept
3645 * \li Origin: sanda, Sep 08 2008
3648 { LFUN_COMPLETION_ACCEPT, "completion-accept", SingleParUpdate, Edit },
3652 * \var lyx::FuncCode lyx::LFUN_BRANCH_ADD
3653 * \li Action: Add a branch to the buffer's BranchList.
3654 * \li Syntax: branch-add <BRANCH>
3655 * \li Params: <BRANCH>: Name of the branch to add
3656 * \li Origin: spitz, 7 Jul 2009
3659 { LFUN_BRANCH_ADD, "branch-add", AtPoint, Buffer },
3663 * \var lyx::FuncCode lyx::LFUN_BRANCH_INVERT
3664 * \li Action: Toggles inversion status of branch inset.
3665 * \li Syntax: branch-invert
3666 * \li Origin: rgheck, 12 July 2016
3669 { LFUN_BRANCH_INVERT, "branch-invert", AtPoint, Buffer },
3672 * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
3673 * \li Action: Activate the branch.
3674 * \li Syntax: branch-activate <BRANCH>
3675 * \li Params: <BRANCH>: The branch to activate
3676 * \li Sample: lyx -x "branch-activate answers" -e pdf2 finalexam.lyx \n
3677 could be used to export a pdf with the answers branch included
3678 without one's having to open LyX and activate the branch manually.
3679 * \li Origin: rgh, 27 May 2008
3682 { LFUN_BRANCH_ACTIVATE, "branch-activate", AtPoint, Buffer },
3684 * \var lyx::FuncCode lyx::LFUN_BRANCH_DEACTIVATE
3685 * \li Action: De-activate the branch.
3686 * \li Syntax: branch-deactivate <BRANCH>
3687 * \li Params: <BRANCH>: The branch to deactivate
3688 * \li Origin: rgh, 27 May 2008
3691 { LFUN_BRANCH_DEACTIVATE, "branch-deactivate", AtPoint, Buffer },
3693 * \var lyx::FuncCode lyx::LFUN_BRANCH_MASTER_ACTIVATE
3694 * \li Action: Activate the branch in the master buffer.
3695 * \li Syntax: branch-master-activate <BRANCH>
3696 * \li Params: <BRANCH>: The branch to activate
3697 * \li Sample: lyx -x "branch-activate answers" -e pdf2 finalexam.lyx \n
3698 could be used to export a pdf with the answers branch included
3699 without one's having to open LyX and activate the branch manually.
3700 * \li Origin: spitz, 30 Sep 2012
3703 { LFUN_BRANCH_MASTER_ACTIVATE, "branch-master-activate", AtPoint, Buffer },
3705 * \var lyx::FuncCode lyx::LFUN_BRANCH_MASTER_DEACTIVATE
3706 * \li Action: De-activate the branch in the master buffer.
3707 * \li Syntax: branch-master-deactivate <BRANCH>
3708 * \li Params: <BRANCH>: The branch to deactivate
3709 * \li Origin: spitz, 30 Sep 2012
3712 { LFUN_BRANCH_MASTER_DEACTIVATE, "branch-master-deactivate", AtPoint, Buffer },
3715 * \var lyx::FuncCode lyx::LFUN_BRANCHES_RENAME
3716 * \li Action: Rename all branches of a given name in a document.
3717 * \li Syntax: branches-rename <OLDNAME> <NEWNAME>
3718 * \li Params: <OLDNAME>: Current name of the branch to be renamed
3719 * <NEWNAME>: New name of the branch
3720 * \li Origin: spitz, 9 Jul 2009
3723 { LFUN_BRANCHES_RENAME, "branches-rename", Noop, Buffer },
3725 * \var lyx::FuncCode lyx::LFUN_BRANCH_ADD_INSERT
3726 * \li Action: Create new branch and directly put the branch inset into
3728 * \li Syntax: branch-add-insert [<NAME>]
3729 * \li Params: <NAME>: Branch name. If it is not specified, you will be asked.
3730 * \li Origin: sanda, 10 Jul 2009
3733 { LFUN_BRANCH_ADD_INSERT, "branch-add-insert", Noop, Buffer },
3737 * \var lyx::FuncCode lyx::LFUN_LABEL_COPY_AS_REF
3738 * \li Action: Copies the label at the cursor as a cross-reference to be pasted elsewhere.
3739 * \li Syntax: copy-label-as-reference <LABEL>
3740 * \li Params: <LABEL>: The label to copy (for multi-line math)
3741 * \li Origin: sts, 16 Nov 2008
3744 { LFUN_LABEL_COPY_AS_REFERENCE, "label-copy-as-reference",
3745 ReadOnly | NoUpdate | AtPoint, Edit },
3748 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT_AS_REFERENCE
3749 * \li Action: Inserts the label (in ToC pane) as a cross-reference at the position of the cursor.
3750 * \li Syntax: label-insert-as-reference
3751 * \li Origin: vfr, 7 Apr 2009
3754 { LFUN_LABEL_INSERT_AS_REFERENCE, "label-insert-as-reference", Noop, Edit},
3757 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_IN
3758 * \li Action: Increases the zoom of the screen fonts.
3759 * \li Syntax: buffer-zoom-in [<ZOOM>]
3760 * \li Params: <ZOOM>: The zoom in % points (neg. or pos.), the default is 20.
3761 * \li Origin: vfr, 30 Mar 2009
3764 { LFUN_BUFFER_ZOOM_IN, "buffer-zoom-in", ReadOnly, Buffer },
3767 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_OUT
3768 * \li Action: Decreases the zoom of the screen fonts.
3769 * \li Syntax: buffer-zoom-out [<ZOOM>]
3770 * \li Params: <ZOOM>: The zoom in % points (neg. or pos.), the default is -20.
3771 * \li Origin: vfr, 30 Mar 2009
3774 { LFUN_BUFFER_ZOOM_OUT, "buffer-zoom-out", ReadOnly, Buffer },
3777 * \var lyx::FuncCode lyx::LFUN_INSET_COPY_AS
3778 * \li Action: Copies the inset to the clipboard as a certain type.
3779 * \li Notion: Currently used only for InsetInfo where its content is copied as a text.
3780 * \li Syntax: inset-copy-as
3781 * \li Origin: vfr, 18 Apr 2010
3784 { LFUN_INSET_COPY_AS, "inset-copy-as", ReadOnly | NoUpdate | AtPoint, Edit },
3787 * \var lyx::FuncCode lyx::LFUN_ENVIRONMENT_SPLIT
3788 * \li Action: Splits the current environment with a Separator.
3789 * \li Syntax: environment-split [outer]
3790 * \li Params: outer: If this is given, LyX will split the outermost environment in
3791 * the current nesting hierarchy.
3792 * \li Origin: spitz, 23 Dec 2012
3795 { LFUN_ENVIRONMENT_SPLIT, "environment-split", Noop, Layout },
3797 { LFUN_NOACTION, "", Noop, Hidden }
3798 #ifndef DOXYGEN_SHOULD_SKIP_THIS
3801 for (int i = 0; items[i].action != LFUN_NOACTION; ++i)
3802 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
3808 LyXAction::LyXAction()
3814 FuncRequest LyXAction::lookupFunc(string const & func) const
3816 string const func2 = trim(func);
3819 return FuncRequest(LFUN_NOACTION);
3822 string const arg = split(func2, cmd, ' ');
3824 FuncMap::const_iterator const fit = lyx_func_map.find(cmd);
3826 return fit != lyx_func_map.end()
3827 ? FuncRequest(fit->second, arg)
3828 : FuncRequest(LFUN_UNKNOWN_ACTION);
3832 string const LyXAction::getActionName(FuncCode action) const
3834 InfoMap::const_iterator const it = lyx_info_map.find(action);
3835 return it != lyx_info_map.end() ? it->second.name : string();
3839 LyXAction::FuncType LyXAction::getActionType(FuncCode action) const
3841 InfoMap::const_iterator const it = lyx_info_map.find(action);
3842 return it != lyx_info_map.end() ? it->second.type : Hidden;
3846 bool LyXAction::funcHasFlag(FuncCode action,
3847 LyXAction::FuncAttribs flag) const
3849 InfoMap::const_iterator ici = lyx_info_map.find(action);
3851 if (ici == lyx_info_map.end()) {
3852 LYXERR0("action: " << action << " is not known.");
3853 LASSERT(false, return false);
3856 return ici->second.attrib & flag;
3860 LyXAction::const_iterator LyXAction::func_begin() const
3862 return lyx_func_map.begin();
3866 LyXAction::const_iterator LyXAction::func_end() const
3868 return lyx_func_map.end();
3872 LyXErr & operator<<(LyXErr & l, FuncCode code)
3875 l.stream() << lyxaction.getActionName(code);