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_TIE
204 * \li Action: Adds a tie \htmlonly (a͡)\endhtmlonly
205 over the next two character typed.
206 * \li Notion: The following char will finish the tie.
207 * \li Syntax: accent-tie
210 { LFUN_ACCENT_TIE, "accent-tie", Noop, Edit },
212 * \var lyx::FuncCode lyx::LFUN_ACCENT_TILDE
213 * \li Action: Adds a tilde \htmlonly (ã)\endhtmlonly
214 over the next character typed.
215 * \li Syntax: accent-tilde
218 { LFUN_ACCENT_TILDE, "accent-tilde", Noop, Edit },
220 * \var lyx::FuncCode lyx::LFUN_ACCENT_UMLAUT
221 * \li Action: Adds an umlaut \htmlonly (ä)\endhtmlonly
222 over the next character typed.
223 * \li Syntax: accent-umlaut
226 { LFUN_ACCENT_UMLAUT, "accent-umlaut", Noop, Edit },
228 * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERBAR
229 * \li Action: Adds a bar \htmlonly (a̠)\endhtmlonly
230 under the next character typed.
231 * \li Syntax: accent-underbar
234 { LFUN_ACCENT_UNDERBAR, "accent-underbar", Noop, Edit },
236 * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERDOT
237 * \li Action: Adds a dot \htmlonly (ạ)\endhtmlonly
238 under the next character typed.
239 * \li Syntax: accent-underdot
242 { LFUN_ACCENT_UNDERDOT, "accent-underdot", Noop, Edit },
245 * \var lyx::FuncCode lyx::LFUN_CAPTION_INSERT
246 * \li Action: Inserts a caption inset.
247 * \li Syntax: caption-insert
248 * \li Origin: Lgb, 18 Jul 2000
251 { LFUN_CAPTION_INSERT, "caption-insert", Noop, Edit },
253 * \var lyx::FuncCode lyx::LFUN_DATE_INSERT
254 * \li Action: Inserts the current date.
255 * \li Syntax: date-insert [<ARG>]
256 * \li Params: <ARG>: Format of date. The default value (%x) can be set
257 in Preferences->Date format. For possible formats
258 see manual page of strftime function.
259 * \li Origin: jdblair, 31 Jan 2000
262 { LFUN_DATE_INSERT, "date-insert", Noop, Edit },
264 * \var lyx::FuncCode lyx::LFUN_FOOTNOTE_INSERT
265 * \li Action: Inserts a footnote inset.
266 * \li Syntax: footnote-insert
267 * \li Origin: Jug, 7 Mar 2000
270 { LFUN_FOOTNOTE_INSERT, "footnote-insert", Noop, Edit },
272 * \var lyx::FuncCode lyx::LFUN_ERT_INSERT
273 * \li Action: Inserts an ERT inset.
274 * \li Syntax: ert-insert
275 * \li Origin: Jug, 18 Feb 2000
278 { LFUN_ERT_INSERT, "ert-insert", Noop, Edit },
280 * \var lyx::FuncCode lyx::LFUN_FLOAT_INSERT
281 * \li Action: Inserts a float inset.
282 * \li Syntax: float-insert <TYPE>
283 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
284 "algorithm", "table", "figure" parameters can be given.
285 * \li Origin: Lgb, 27 Jun 2000
288 { LFUN_FLOAT_INSERT, "float-insert", Noop, Edit },
290 * \var lyx::FuncCode lyx::LFUN_FLOAT_WIDE_INSERT
291 * \li Action: Inserts float insets as in #LFUN_FLOAT_INSERT but span multiple columns.
292 * \li Notion: Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
293 * \li Syntax: float-wide-insert <TYPE>
294 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
295 "algorithm", "table", "figure" parameters can be given.
296 * \li Origin: Lgb, 31 Oct 2001
299 { LFUN_FLOAT_WIDE_INSERT, "float-wide-insert", Noop, Edit },
301 * \var lyx::FuncCode lyx::LFUN_FLOAT_LIST_INSERT
302 * \li Action: Inserts the list of floats in the document.
303 * \li Syntax: float-list-insert <TYPE>
304 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
305 "algorithm", "table", "figure" parameters can be given.
306 * \li Origin: Lgb, 3 May 2001
309 { LFUN_FLOAT_LIST_INSERT, "float-list-insert", Noop, Edit },
311 * \var lyx::FuncCode lyx::LFUN_WRAP_INSERT
312 * \li Action: Inserts floats wrapped by the text around.
313 * \li Syntax: wrap-insert <TYPE>
314 * \li Params: <TYPE>: table|figure
315 * \li Origin: Dekel, 7 Apr 2002
318 { LFUN_WRAP_INSERT, "wrap-insert", Noop, Edit },
320 * \var lyx::FuncCode lyx::LFUN_ARGUMENT_INSERT
321 * \li Action: Inserts an argument (short title) inset.
322 * \li Syntax: argument-insert <argument nr>
323 * \li Params: <argument nr>: see layout declarations
324 * \li Origin: vermeer, 12 Aug 2002
327 { LFUN_ARGUMENT_INSERT, "argument-insert", Noop, Edit },
329 * \var lyx::FuncCode lyx::LFUN_NEWPAGE_INSERT
330 * \li Action: Inserts a new page.
331 * \li Syntax: newpage-insert <ARG>
332 * \li Params: <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
333 * \li Origin: uwestoehr, 24 Nov 2007
336 { LFUN_NEWPAGE_INSERT, "newpage-insert", Noop, Edit },
338 * \var lyx::FuncCode lyx::LFUN_MARGINALNOTE_INSERT
339 * \li Action: Inserts a marginal note.
340 * \li Syntax: marginalnote-insert
341 * \li Origin: Lgb, 26 Jun 2000
344 { LFUN_MARGINALNOTE_INSERT, "marginalnote-insert", Noop, Edit },
346 * \var lyx::FuncCode lyx::LFUN_UNICODE_INSERT
347 * \li Action: Inserts a single unicode character.
348 * \li Syntax: unicode-insert <CHAR>
349 * \li Params: <CHAR>: The character to insert, given as its code
350 point, in hexadecimal.
351 * \li Sample: unicode-insert 0x0100
352 * \li Origin: Lgb, 22 Oct 2006
355 { LFUN_UNICODE_INSERT, "unicode-insert", Noop, Edit },
357 * \var lyx::FuncCode lyx::LFUN_LISTING_INSERT
358 * \li Action: Inserts a new listings inset.
359 * \li Syntax: listing-insert
360 * \li Origin: Herbert, 10 Nov 2001; bpeng, 2 May 2007
363 { LFUN_LISTING_INSERT, "listing-insert", Noop, Edit },
365 * \var lyx::FuncCode lyx::LFUN_PREVIEW_INSERT
366 * \li Action: Inserts a new preview inset.
367 * \li Syntax: preview-insert
368 * \li Origin: vfr, 28 Mar 2010
371 { LFUN_PREVIEW_INSERT, "preview-insert", Noop, Edit },
373 * \var lyx::FuncCode lyx::LFUN_TAB_INSERT
374 * \li Action: Insert a tab into a listings inset.
375 * \li Notion: It also works on a selection.
376 * \li Syntax: tab-insert
377 * \li Origin: vfr, Sep 30 2008
380 { LFUN_TAB_INSERT, "tab-insert", SingleParUpdate, Edit },
382 * \var lyx::FuncCode lyx::LFUN_TAB_DELETE
383 * \li Action: Delete a tab or up to an equivalent amount of spaces from
385 * \li Notion: It also works on a selection - it removes a tab or spaces from the
386 beginning of each line spanned by the selection. This is useful if
387 you want to indent/unindent multiple lines in one action.
388 * \li Syntax: tab-delete
389 * \li Origin: vfr, Sep 30 2008
392 { LFUN_TAB_DELETE, "tab-delete", SingleParUpdate, Edit },
394 * \var lyx::FuncCode lyx::LFUN_QUOTE_INSERT
395 * \li Action: Inserts quotes according to the type and quote-language preference.
396 * \li Notion: Currently English, Swedish, German, Polish, French, Danish quotes
398 * \li Syntax: quote-insert [<TYPE>]
399 * \li Params: <TYPE>: 'single' for single quotes, otherwise double quotes will be used.
402 { LFUN_QUOTE_INSERT, "quote-insert", Noop, Edit },
404 * \var lyx::FuncCode lyx::LFUN_INFO_INSERT
405 * \li Action: Displays shortcuts, lyxrc, package and textclass availability and menu
406 information in a non-editable boxed InsetText.
407 * \li Notion: Apart from lfun arguments you can use the following method: \n
408 1. input the type and argument of this inset, e.g. "menu paste", in
410 2. select the text and run info-insert lfun.
411 * \li Syntax: info-insert <TYPE> <ARG>
412 * \li Params: <TYPE>: shortcut[s]|lyxrc|lyxinfo|package|textclass|menu|buffer \n
413 <ARG>: argument for a given type. Look into InsetInfo.h for detailed
415 shortcut[s]: name of lfun (e.g math-insert \alpha) \n
416 lyxrc: name of rc_entry (e.g. bind_file) \n
417 lyxinfo: "version" - used version of LyX \n
418 package: name of latex package (e.g. listings) \n
419 textclass: name of textclass (e.g. article) \n
420 menu: name of lfun used in menu \n
421 icon: icon of lfun used in toolbar \n
422 buffer: "name"|"path"|"class"|"vcs-tree-revision"|
423 "vcs-revision"|"vcs-author"|"vcs-date"|"vcs-time"
424 * \li Sample: command-sequence info-insert buffer path; info-insert buffer name
425 * \li Origin: bpeng, 7 Oct 2007
428 { LFUN_INFO_INSERT, "info-insert", Noop, Edit },
430 * \var lyx::FuncCode lyx::LFUN_BRANCH_INSERT
431 * \li Action: Inserts branch inset.
432 * \li Syntax: branch-insert <BRANCH-NAME>
433 * \li Origin: vermeer, 17 Aug 2003
436 { LFUN_BRANCH_INSERT, "branch-insert", Noop, Edit },
438 * \var lyx::FuncCode lyx::LFUN_BOX_INSERT
439 * \li Action: Inserts Box inset.
440 * \li Syntax: box-insert [<TYPE>]
441 * \li Params: <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox \n
442 Framed is the default one.
443 * \li Origin: vermeer, 7 Oct 2003
446 { LFUN_BOX_INSERT, "box-insert", Noop, Edit },
448 * \var lyx::FuncCode lyx::LFUN_FLEX_INSERT
449 * \li Action: Inserts CharStyle, Custom inset or XML short element.
450 * \li Notion: Look into the Customization manual for more information about
452 To make this command enabled the layout file for the document
453 class you're using has to load the character styles. There are
454 a few contained in the Logical Markup module. You can also of
455 course create some yourself. \n
456 For dissolving the element see #LFUN_INSET_DISSOLVE.
457 * \li Syntax: flex-insert Name
458 * \li Params: Name: This name must be defined either in your layout file
459 or imported by some module. The definition is
460 InsetLayout Name or InsetLayout <Flex:Name>. The Flex:
462 * \li Sample: flex-insert Code
465 { LFUN_FLEX_INSERT, "flex-insert", Noop, Edit },
467 * \var lyx::FuncCode lyx::LFUN_SELF_INSERT
468 * \li Action: Inserts the given string (accordingly to the correct keymap).
469 * \li Notion: Automatically replace the currently selected text. Depends on lyxrc
470 settings "auto_region_delete".
471 * \li Syntax: self-insert <STRING>
474 { LFUN_SELF_INSERT, "self-insert", SingleParUpdate, Hidden },
476 * \var lyx::FuncCode lyx::LFUN_SPACE_INSERT
477 * \li Action: Inserts one of horizontal space insets.
478 * \li Syntax: space-insert <NAME> [<LEN>]
479 * \li Params: <NAME>: normal, protected, visible, thin, quad, qquad, enspace,
480 enskip, negthinspace, negmedspace, negthickspace, hfill,
481 hfill*, dotfill, hrulefill, hspace, hspace* \n
482 Only in math mode: med and thick.\n
483 <LEN>: length for custom spaces (hspace, hspace* for protected)
484 * \li Origin: JSpitzm, 20 May 2003, Mar 17 2008
487 { LFUN_SPACE_INSERT, "space-insert", Noop, Edit },
489 * \var lyx::FuncCode lyx::LFUN_HREF_INSERT
490 * \li Action: Inserts hyperlinks into the document (clickable in pdf output).
491 * \li Notion: Hyperlink target can be set via selection + hyperlink-insert function.
492 * \li Syntax: href-insert [<TARGET>]
493 * \li Origin: CFO-G, 21 Nov 1997
496 { LFUN_HREF_INSERT, "href-insert", Noop, Edit },
498 * \var lyx::FuncCode lyx::LFUN_SPECIALCHAR_INSERT
499 * \li Action: Inserts various characters into the document.
500 * \li Syntax: specialchar-insert <CHAR>
501 * \li Params: <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots,
502 end-of-sentence, menu-separator, lyx, tex, latex, latex2e.
503 * \li Origin: JSpitzm, 6 Dec 2007
506 { LFUN_SPECIALCHAR_INSERT, "specialchar-insert", Noop, Edit },
508 * \var lyx::FuncCode lyx::LFUN_SCRIPT_INSERT
509 * \li Action: Inserts a subscript or superscript inset.
510 * \li Syntax: script-insert <TYPE>
511 * \li Params: <TYPE>: subscript|superscript
512 * \li Origin: Georg, 23 Nov 2010
515 { LFUN_SCRIPT_INSERT, "script-insert", Noop, Edit },
517 * \var lyx::FuncCode lyx::LFUN_APPENDIX
518 * \li Action: Start (or remove) Appendix on the given cursor position.
519 * \li Syntax: appendix
520 * \li Origin: ettrich, 5 May 1998
523 { LFUN_APPENDIX, "appendix", Noop, Edit },
526 * \var lyx::FuncCode lyx::LFUN_INDEX_INSERT
527 * \li Action: Inserts Index entry.
528 * \li Notion: It automatically takes the word on the cursor position.
529 * \li Syntax: index-insert [<TYPE:Name>]
530 * \li Params: <TYPE:Name>: name of the index, if multiple indices are defined.
531 With an empty argument, the default index is selected.
532 * \li Origin: leeming, 3 Aug 2000
535 { LFUN_INDEX_INSERT, "index-insert", Noop, Edit },
537 * \var lyx::FuncCode lyx::LFUN_INDEX_PRINT
538 * \li Action: Inserts list of Index entries on a new page.
539 * \li Syntax: index-print [<TYPE:Name>]
540 * \li Params: <TYPE:Name>: name of the index, if multiple indices are defined.
541 With an empty argument, the default index is selected.
542 * \li Origin: Lgb, 27 Feb 1997
545 { LFUN_INDEX_PRINT, "index-print", Noop, Edit },
547 * \var lyx::FuncCode lyx::LFUN_IPA_INSERT
548 * \li Action: Inserts an IPA inset.
549 * \li Syntax: ipa-insert
550 * \li Origin: spitz, 05 Mar 2012
553 { LFUN_IPA_INSERT, "ipa-insert", Noop, Edit },
555 * \var lyx::FuncCode lyx::LFUN_IN_IPA
556 * \li Action: Only active in IPA inset.
557 * \li Notion: Dummy function which is only active in a IPA inset.
558 It's used to toggle the IPA toolbar if the cursor moves
561 * \li Origin: spitz, 20 May 2012
564 { LFUN_IN_IPA, "in-ipa", Noop, Edit },
566 * \var lyx::FuncCode lyx::LFUN_IPAMACRO_INSERT
567 * \li Action: Inserts special IPA macros into the document.
568 * \li Syntax: ipamacro-insert <CHAR>
569 * \li Params: <CHAR>: tone-falling, tone-rising, tone-high-rising, tone-low-rising,
570 * tone-high-rising-falling, deco bottomtiebar, deco toptiebar.
571 * \li Origin: JSpitzm, 22 Aug 2012
574 { LFUN_IPAMACRO_INSERT, "ipamacro-insert", Noop, Edit },
576 * \var lyx::FuncCode lyx::LFUN_NOMENCL_INSERT
577 * \li Action: Inserts Nomenclature entry.
578 * \li Notion: It automatically takes the word on the cursor position if no symbol is given.
579 * \li Syntax: nomencl-insert [<SYMBOL>]
580 * \li Origin: Ugras, 4 Nov 2006
583 { LFUN_NOMENCL_INSERT, "nomencl-insert", Noop, Edit },
585 * \var lyx::FuncCode lyx::LFUN_NOMENCLATURE_PRINT
586 * \li Action: Inserts list of Nomenclature entries.
587 * \li Syntax: nomenclature-print
588 * \li Origin: Ugras, 4 Nov 2006
591 { LFUN_NOMENCL_PRINT, "nomencl-print", Noop, Edit },
594 * \var lyx::FuncCode lyx::LFUN_NOTE_INSERT
595 * \li Action: Inserts Note on the current cursor position,
596 move selection inside the inset.
597 * \li Syntax: note-insert [<TYPE>]
598 * \li Params: <TYPE>: <Note|Greyedout|Comment> default: Note
601 { LFUN_NOTE_INSERT, "note-insert", Noop, Edit },
603 * \var lyx::FuncCode lyx::LFUN_NOTE_NEXT
604 * \li Action: Moves the cursor to the beginning of next Note inset.
605 * \li Syntax: note-next
608 { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
610 * \var lyx::FuncCode lyx::LFUN_PHANTOM_INSERT
611 * \li Action: Inserts phantom on the current cursor position,
612 move selection inside the inset.
613 * \li Syntax: phantom-insert [<TYPE>]
614 * \li Params: <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
615 * \li Origin: uwestoehr, 30 Jan 2009
618 { LFUN_PHANTOM_INSERT, "phantom-insert", Noop, Edit },
620 * \var lyx::FuncCode lyx::LFUN_NEWLINE_INSERT
621 * \li Action: Inserts a line break or new line.
622 * \li Syntax: newline-insert [<ARG>]
623 * \li Params: <ARG>: <newline|linebreak> default: newline
624 * \li Origin: JSpitzm, 25 Mar 2008
627 { LFUN_NEWLINE_INSERT, "newline-insert", Noop, Edit },
629 * \var lyx::FuncCode lyx::LFUN_SEPARATOR_INSERT
630 * \li Action: Inserts an environment separator or paragraph break.
631 * \li Syntax: separator-insert [<ARG>]
632 * \li Params: <ARG>: <plain|parbreak> default: plain
633 * \li Origin: ef, 2 May 2014
636 { LFUN_SEPARATOR_INSERT, "separator-insert", Noop, Edit },
638 * \var lyx::FuncCode lyx::LFUN_ESCAPE
639 * \li Action: Clears the selection. If no text is selected call #LFUN_FINISHED_FORWARD.
640 Inside math mode jumps out of the math inset.
642 * \li Origin: Lgb, 17 May 2001
645 { LFUN_ESCAPE, "escape", ReadOnly, Edit },
647 * \var lyx::FuncCode lyx::LFUN_DOWN
648 * \li Action: Moves the cursor one line in downward direction.
652 { LFUN_DOWN, "down", ReadOnly | NoUpdate, Edit },
654 * \var lyx::FuncCode lyx::LFUN_UP
655 * \li Action: Moves the cursor one line in upward direction.
659 { LFUN_UP, "up", ReadOnly | NoUpdate, Edit },
661 * \var lyx::FuncCode lyx::LFUN_DOWN_SELECT
662 * \li Action: Moves the cursor one line in downward direction adding the current
663 position to the selection.
664 * \li Syntax: down-select
667 { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, Edit },
669 * \var lyx::FuncCode lyx::LFUN_UP_SELECT
670 * \li Action: Moves the cursor one line in upward direction adding the current
671 position to the selection.
672 * \li Syntax: up-select
675 { LFUN_UP_SELECT, "up-select", ReadOnly | SingleParUpdate, Edit },
677 * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN
678 * \li Action: Moves the cursor one page in downward direction.
679 * \li Syntax: screen-down
682 { LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit },
684 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP
685 * \li Action: Moves the cursor one page in upward direction.
686 * \li Syntax: screen-up
689 { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit },
691 * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN_SELECT
692 * \li Action: Moves the cursor one screen in downward direction adding the current
693 position to the selection.
694 * \li Syntax: screen-down-select
697 { LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit },
699 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP_SELECT
700 * \li Action: Moves the cursor one page in upward direction adding the current
701 position to the selection.
702 * \li Syntax: screen-up-select
705 { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit },
707 * \var lyx::FuncCode lyx::LFUN_SCROLL
708 * \li Action: Scroll the buffer view.
709 * \li Notion: Only scrolls the screen up or down; does not move the cursor.
710 * \li Syntax: scroll <TYPE> <QUANTITY>
711 * \li Params: <TYPE>: line|page\n
712 <QUANTITY>: up|down|<number>
713 * \li Origin: Abdel, Dec 27 2007
716 { LFUN_SCROLL, "scroll", ReadOnly, Edit },
718 * \var lyx::FuncCode lyx::LFUN_SCREEN_RECENTER
719 * \li Action: Recenters the screen on the current cursor position.
720 * \li Syntax: screen-recenter
723 { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit },
726 * \var lyx::FuncCode lyx::LFUN_SCREEN_SHOW_CURSOR
727 * \li Action: Repositions the screen such that the cursor is visible.
728 * \li Syntax: screen-show-cursor
729 * \li Origin: vfr, 25 Mar 2009
732 { LFUN_SCREEN_SHOW_CURSOR, "screen-show-cursor", ReadOnly, Edit },
735 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD
736 * \li Action: Moves the cursor one position logically backwards.
737 * \li Notion: This is not the action which should be bound to the arrow keys,
738 because backwards may be left or right, depending on the
739 language. The arrow keys should be bound to #LFUN_CHAR_LEFT or
740 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
741 * \li Syntax: char-backward
744 { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit },
746 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD_SELECT
747 * \li Action: Moves the cursor one position logically backwards, adding
748 traversed position to the selection.
749 * \li Notion: See also #LFUN_CHAR_BACKWARD.
750 * \li Syntax: char-backward-select
753 { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit },
755 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_BACKWARD
756 * \li Action: Deletes one character in the backward direction (usually the "BackSpace" key).
757 * \li Syntax: char-delete-backward
760 { LFUN_CHAR_DELETE_BACKWARD, "char-delete-backward", SingleParUpdate, Edit },
762 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_FORWARD
763 * \li Action: Deletes one character in the backward direction (usually the "Delete" key).
764 * \li Syntax: char-delete-forward
767 { LFUN_CHAR_DELETE_FORWARD, "char-delete-forward", SingleParUpdate, Edit },
769 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD
770 * \li Action: Moves the cursor one position logically forward.
771 * \li Notion: This is not the action which should be bound to the arrow keys,
772 because forward may be left or right, depending on the language.
773 The arrow keys should be bound to #LFUN_CHAR_LEFT or
774 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
775 * \li Syntax: char-forward
778 { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit },
780 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD_SELECT
781 * \li Action: Moves the cursor one position logically forward, adding
782 traversed position to the selection.
783 * \li Notion: See also #LFUN_CHAR_FORWARD.
784 * \li Syntax: char-forward-select
787 { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit },
789 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT
790 * \li Action: Moves the cursor one position "to the left".
791 * \li Notion: This is the action which should be taken when the "left" key
792 is pressed. Generally, it moves the cursor one position to the
793 left. However, in Bidi text this become slightly more
794 complicated, and there are different modes of cursor movement.
795 In "visual mode", this moves left, plain and simple. In "logical
796 mode", movement is logically forward in RTL paragraphs, and
797 logically backwards in LTR paragraphs.
798 * \li Syntax: char-left
801 { LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit },
803 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT_SELECT
804 * \li Action: Moves the cursor one position "to the left", adding
805 traversed position to the selection.
806 * \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement.
807 * \li Syntax: char-left-select
810 { LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit },
812 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT
813 * \li Action: Moves the cursor one position "to the right".
814 * \li Notion: This is the action which should be taken when the "right" key
815 is pressed. Generally, it moves the cursor one position to the
816 right. However, in Bidi text this become slightly more
817 complicated, and there are different modes of cursor movement.
818 In "visual mode", this moves right, plain and simple. In "logical
819 mode", movement is logically forward in LTR paragraphs, and
820 logically backwards in RTL paragraphs.
821 * \li Syntax: char-right
824 { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit },
826 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT_SELECT
827 * \li Action: Moves the cursor one position "to the right", adding
828 traversed position to the selection.
829 * \li Notion: See also #LFUN_CHAR_RIGHT for exact details of the movement.
830 * \li Syntax: char-right-select
833 { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit },
836 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD
837 * \li Action: Moves the cursor to the logically previous beginning of a word.
838 * \li Notion: This is not the action which should be bound to the arrow keys,
839 because backwards may be left or right, depending on the
840 language. The arrow keys should be bound to #LFUN_WORD_LEFT or
841 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
842 * \li Syntax: word-backward
845 { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit },
847 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD_SELECT
848 * \li Action: Moves the cursor to the logically previous beginning of a word,
849 adding the logically traversed text to the selection.
850 * \li Notion: See also #LFUN_WORD_BACKWARD.
851 * \li Syntax: word-backward-select
854 { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
856 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_BACKWARD
857 * \li Action: Deletes characters to the beginning of the word (usually the "C+BackSpace" key).
858 * \li Syntax: word-delete-backward
861 { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
863 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_FORWARD
864 * \li Action: Deletes characters to the end of the word (usually the "C+Delete" key).
865 * \li Syntax: word-delete-forward
868 { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
870 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_FORWARD
871 * \li Action: Search for a given string in forward direction.
872 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
873 * \li Syntax: word-find-forward [<STRING>]
874 * \li Origin: Etienne, 16 Feb 1998
877 { LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit },
879 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_BACKWARD
880 * \li Action: Search for a given string in backward direction.
881 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
882 * \li Syntax: word-find-backward [<STRING>]
883 * \li Origin: Etienne, 20 Feb 1998
886 { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
888 * \var lyx::FuncCode lyx::LFUN_WORD_FIND
889 * \li Action: Search for next occurrence of a string.
890 * \li Syntax: word-find [<DATA>]
891 * \li Params: <DATA>: data encoded from Find dialog (see #lyx::find2string()).
892 If no parameter is given, search with last find-dialog
893 data is used for search (i.e. find-next).
894 * \li Origin: Andre, Jan 7 2004
897 { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
899 * \var lyx::FuncCode lyx::LFUN_WORD_REPLACE
900 * \li Action: Replace a string in the document.
901 * \li Syntax: word-replace [<DATA>]
902 * \li Params: <DATA>: data is of the form
905 <casesensitive> <matchword> <all> <forward> <findnext>"
906 * \li Origin: Andre, Jan 7 2004
909 { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
911 * \var lyx::FuncCode lyx::LFUN_WORD_FINDADV
912 * \li Action: Search for next occurrence of a pattern.
913 * \li Syntax: word-findadv [<DATA>]
914 * \li Params: <DATA>: data encoded from FindAdv dialog (see #lyx::findadv2string()).
915 If no parameter is given, search with last find-dialog
916 data is used for search (i.e. find-next).
917 * \li Origin: Tommaso, Nov 15 2007
920 { LFUN_WORD_FINDADV, "word-findadv", ReadOnly | NoBuffer, Edit },
922 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD
923 * \li Action: Moves the cursor to the logically next beginning of a word.
924 * \li Notion: This is not the action which should be bound to the arrow keys,
925 because forward may be left or right, depending on the language.
926 The arrow keys should be bound to #LFUN_WORD_LEFT or
927 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
928 * \li Syntax: word-forward
931 { LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
933 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD_SELECT
934 * \li Action: Moves the cursor to the logically next beginning of a word,
935 adding the logically traversed text to the selection.
936 * \li Notion: See also #LFUN_WORD_FORWARD.
937 * \li Syntax: word-forward-select
940 { LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
942 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT
943 * \li Action: Moves the cursor to the next beginning of a word "on the left".
944 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
945 "left" key is pressed. Generally, it moves the cursor to the
946 next beginning of a word on the left. However, in Bidi text this
947 become slightly more complicated, and there are different modes
948 of cursor movement. In "visual mode", this moves left, plain and
949 simple. In "logical mode", movement is logically forward in RTL
950 paragraphs, and logically backwards in LTR paragraphs.
951 * \li Syntax: word-left
952 * \li Origin: dov, 28 Oct 2007
955 { LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
957 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT_SELECT
958 * \li Action: Moves the cursor to the next beginning of a word "on the left",
959 adding *logically* traversed text to the selection.
960 * \li Notion: See also #LFUN_WORD_LEFT for exact details of the movement.
961 * \li Syntax: word-left-select
962 * \li Origin: dov, 28 Oct 2007
965 { LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit },
967 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT
968 * \li Action: Moves the cursor to the next beginning of a word "on the right".
969 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
970 "right" key is pressed. Generally, it moves the cursor to the
971 next beginning of a word on the right. However, in Bidi text
972 this become slightly more complicated, and there are different
973 modes of cursor movement. In "visual mode", this moves right,
974 plain and simple. In "logical mode", movement is logically
975 forward in LTR paragraphs, and logically backwards in RTL
977 * \li Syntax: word-right
978 * \li Origin: dov, 28 Oct 2007
981 { LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit },
983 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT_SELECT
984 * \li Action: Moves the cursor to the next beginning of a word "on the right",
985 adding *logically* traversed text to the selection.
986 * \li Notion: See also #LFUN_WORD_RIGHT for exact details of the movement.
987 * \li Syntax: word-right-select
988 * \li Origin: dov, 28 Oct 2007
991 { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
993 * \var lyx::FuncCode lyx::LFUN_WORD_SELECT
994 * \li Action: Puts the word where the cursor stands into the selection.
995 * \li Syntax: word-select
996 * \li Origin: Andre, 11 Sep 2002
999 { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
1001 * \var lyx::FuncCode lyx::LFUN_WORD_CAPITALIZE
1002 * \li Action: Capitalizes the words in the selection (i.e. the first letters)
1003 or the letter on the cursor position.
1004 * \li Syntax: word-capitalize
1007 { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
1009 * \var lyx::FuncCode lyx::LFUN_WORD_UPCASE
1010 * \li Action: Change the words in the selection or from the cursor position
1011 to the end of word to the upper case.
1012 * \li Syntax: word-upcase
1015 { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
1017 * \var lyx::FuncCode lyx::LFUN_WORD_LOWCASE
1018 * \li Action: Change the words in the selection or from the cursor position
1019 to the end of word to the lower case.
1020 * \li Syntax: word-lowcase
1023 { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
1025 * \var lyx::FuncCode lyx::LFUN_SPELLING_ADD
1026 * \li Action: Add the word under the cursor to the respective
1027 * spell checker dictionary.
1028 * \li Syntax: spelling-add [<STRING>] [<LANG>]
1029 * \li Params: <WORD>: word to add
1030 <LANG>: language name (see file languages)
1031 * \li Origin: JSpitzm, 18 Jan 2010
1034 { LFUN_SPELLING_ADD, "spelling-add", ReadOnly, Edit },
1036 * \var lyx::FuncCode lyx::LFUN_SPELLING_IGNORE
1037 * \li Action: Let the spell checker ignore the word under the cursor
1038 * in the current session for the given language.
1039 * \li Syntax: spelling-ignore [<WORD>] [<LANG>]
1040 * \li Params: <WORD>: word to ignore
1041 <LANG>: language name (see file languages)
1042 * \li Origin: JSpitzm, 18 Jan 2010
1045 { LFUN_SPELLING_IGNORE, "spelling-ignore", ReadOnly, Edit },
1047 * \var lyx::FuncCode lyx::LFUN_SPELLING_REMOVE
1048 * \li Action: Remove the word under the cursor from the respective
1049 * spell checker dictionary.
1050 * \li Syntax: spelling-remove [<STRING>] [<LANG>]
1051 * \li Params: <WORD>: word to remove
1052 <LANG>: language name (see file languages)
1053 * \li Origin: SWitt, 28 July 2010
1056 { LFUN_SPELLING_REMOVE, "spelling-remove", ReadOnly, Edit },
1059 * \var lyx::FuncCode lyx::LFUN_SPELLING_CONTINUOUSLY
1060 * \li Action: Toggle continuous spell checking.
1061 * \li Syntax: spelling-continuously
1062 * \li Origin: vfr, 24 March 2013
1065 { LFUN_SPELLING_CONTINUOUSLY, "spelling-continuously", ReadOnly, Edit },
1068 * \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
1069 * \li Action: Look up thesaurus entries with respect to the word under the cursor.
1070 * \li Syntax: thesaurus-entry [<STRING>] [lang=<LANG>]
1071 * \li Params: <STRING>: word to look up
1072 <LANG>: language (see file languages)
1073 * \li Origin: Levon, 20 Jul 2001
1076 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
1078 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN
1079 * \li Action: Move the cursor to the beginning of the document.
1080 * \li Syntax: buffer-begin
1083 { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
1085 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN_SELECT
1086 * \li Action: Move the cursor to the beginning of the document adding the
1087 traversed text to the selection.
1088 * \li Syntax: buffer-begin-select
1091 { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
1093 * \var lyx::FuncCode lyx::LFUN_BUFFER_END
1094 * \li Action: Move the cursor to the end of the document.
1095 * \li Syntax: buffer-end
1098 { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
1100 * \var lyx::FuncCode lyx::LFUN_BUFFER_END_SELECT
1101 * \li Action: Move the cursor to the end of the document adding the
1102 traversed text to the selection.
1103 * \li Syntax: buffer-end-select
1106 { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
1109 * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN
1110 * \li Action: Move the cursor to the beginning of the current inset
1111 if it is not already there, or at the beginning of the
1112 enclosing inset otherwise
1113 * \li Syntax: inset-begin
1114 * \li Origin: lasgouttes, 16 Mar 2009
1117 { LFUN_INSET_BEGIN, "inset-begin", ReadOnly, Edit },
1119 * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN_SELECT
1120 * \li Action: Move the cursor to the beginning of the current inset
1121 if it is not already there, or at the beginning of the
1122 enclosing inset otherwise (adding the
1123 traversed text to the selection).
1124 * \li Syntax: inset-begin-select
1125 * \li Origin: lasgouttes, 16 Mar 2009
1128 { LFUN_INSET_BEGIN_SELECT, "inset-begin-select", ReadOnly, Edit },
1130 * \var lyx::FuncCode lyx::LFUN_INSET_END
1131 * \li Action: Move the cursor to the end of the current inset
1132 if it is not already there, or at the end of the
1133 enclosing inset otherwise
1134 * \li Syntax: inset-end
1135 * \li Origin: lasgouttes, 16 Mar 2009
1138 { LFUN_INSET_END, "inset-end", ReadOnly, Edit },
1140 * \var lyx::FuncCode lyx::LFUN_INSET_END_SELECT
1141 * \li Action: Move the cursor to the end of the current inset
1142 if it is not already there, or at the end of the
1143 enclosing inset otherwise (adding the
1144 traversed text to the selection).
1145 * \li Syntax: inset-end-select
1146 * \li Origin: lasgouttes, 16 Mar 2009
1149 { LFUN_INSET_END_SELECT, "inset-end-select", ReadOnly, Edit },
1152 * \var lyx::FuncCode lyx::LFUN_INSET_SELECT_ALL
1153 * \li Action: Select all contents of an inset.
1154 * \li Notion: There are 3 successive levels: select current cell,
1155 * select all cells of inset, select the inset from outside
1156 * (in the enclosing inset).
1157 * \li Syntax: inset-select-all
1158 * \li Origin: vfr, 22 Aug 2009; lasgouttes 1 Nov 2014
1161 { LFUN_INSET_SELECT_ALL, "inset-select-all", ReadOnly, Edit },
1164 * \var lyx::FuncCode lyx::LFUN_SECTION_SELECT
1165 * \li Action: Select the whole section.
1166 * \li Notion: The cursor should be in a section heading
1167 before calling this lfun.
1168 * \li Syntax: section-select
1169 * \li Origin: vfr, 05 May 2009
1172 { LFUN_SECTION_SELECT, "section-select", ReadOnly, Edit },
1175 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN
1176 * \li Action: Move the cursor to the beginning of the (screen) line.
1177 * \li Syntax: line-begin
1180 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
1182 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN_SELECT
1183 * \li Action: Move the cursor to the beginning of the (screen) line adding the
1184 traversed text to the selection.
1185 * \li Syntax: line-begin-select
1188 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
1190 * \var lyx::FuncCode lyx::LFUN_LINE_END
1191 * \li Action: Move the cursor to the end of the (screen) line.
1192 * \li Syntax: line-end
1195 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
1197 * \var lyx::FuncCode lyx::LFUN_LINE_END_SELECT
1198 * \li Action: Move the cursor to the end of the (screen) line adding the
1199 traversed text to the selection.
1200 * \li Syntax: line-end-select
1203 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
1205 * \var lyx::FuncCode lyx::LFUN_LINE_DELETE_FORWARD
1206 * \li Action: Deletes the letters to the end of the (screen) line or
1207 deletes the selection.
1208 * \li Syntax: line-delete-forward
1211 { LFUN_LINE_DELETE_FORWARD, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
1213 * \var lyx::FuncCode lyx::LFUN_COPY
1214 * \li Action: Copies the current selection to the clipboard.
1218 { LFUN_COPY, "copy", ReadOnly, Edit },
1220 * \var lyx::FuncCode lyx::LFUN_CUT
1221 * \li Action: Cuts to the clipboard.
1225 { LFUN_CUT, "cut", Noop, Edit },
1227 * \var lyx::FuncCode lyx::LFUN_PASTE
1228 * \li Action: Pastes material (text or picture) from the active clipboard.
1229 * \li Syntax: paste [<TYPE>|<NUM>]
1230 * \li Params: <TYPE>: emf|pdf|png|jpeg|linkback|wmf|latex|html \n
1231 <NUM>: number of the selection in the internal clipboard stack to be pasted.
1234 { LFUN_PASTE, "paste", Noop, Edit },
1236 * \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE
1237 * \li Action: Pastes text from the active clipboard (retains formatting if the
1238 clipboard contains formatted text). Pastes plain text if plain text is
1239 on the clipboard, but tries to interpret it in special ways for certain
1240 insets, e.g. converting csv data to rows and columns if the paste happens
1242 * \li Notion: Historically, LFUN_CLIPBOARD_PASTE was introduced as a counterpart of
1243 LFUN_PRIMARY_SELECTION_PASTE: It behaved exactly the same, but the source
1244 is the clipboard, not the selection.
1245 * \li Syntax: clipboard-paste [<ARG>]
1246 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1247 * \li Origin: Georg, 10 Jul 2006
1250 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
1252 * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
1253 * \li Action: Pastes the currently selected text.
1254 * \li Notion: Primary selection mechanism is linux-only thing.
1255 * \li Syntax: primary-selection-paste [<ARG>]
1256 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1259 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
1261 * \var lyx::FuncCode lyx::LFUN_SELECTION_PASTE
1262 * \li Action: Pastes the internal selection text in permanent selection.
1263 * \li Notion: Created in order to have middle mouse button pasting correct (bound to
1264 command-alternatives selection-paste ; primary-selection-paste paragraph).
1265 * \li Syntax: selection-paste
1266 * \li Origin: lasgouttes, 14 Jan 2009
1269 { LFUN_SELECTION_PASTE, "selection-paste", Noop, Edit },
1271 * \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE_SIMPLE
1272 * \li Action: Pastes plain text from the active clipboard even if formatted
1273 LyX content is in the clipboard. Pastes plain text if plain text
1274 is on the clipboard, without trying to interpret it in special
1275 ways for certain insets, e.g. converting csv data to rows and
1276 columns if the paste happens in a tabular inset.
1277 * \li Syntax: clipboard-paste-simple [<ARG>]
1278 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1281 { LFUN_CLIPBOARD_PASTE_SIMPLE, "clipboard-paste-simple", Noop, Edit },
1283 * \var lyx::FuncCode lyx::LFUN_UNDO
1284 * \li Action: Undoes the last edit.
1288 { LFUN_UNDO, "undo", ReadOnly, Edit },
1290 * \var lyx::FuncCode lyx::LFUN_REDO
1291 * \li Action: Redoes the last thing undone.
1295 { LFUN_REDO, "redo", ReadOnly, Edit },
1297 * \var lyx::FuncCode lyx::LFUN_REPEAT
1298 * \li Action: Repeat the given command.
1299 * \li Syntax: repeat <COUNT> <LFUN-COMMAND>
1300 * \li Origin: Andre, 27 Oct 2003
1303 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
1305 * \var lyx::FuncCode lyx::LFUN_CHARS_TRANSPOSE
1306 * \li Action: Transposes the character at the cursor with the one before it.
1307 * \li Syntax: chars-transpose
1308 * \li Origin: Lgb, 25 Apr 2001
1311 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
1314 * \var lyx::FuncCode lyx::LFUN_DEPTH_DECREMENT
1315 * \li Action: Decrease the nesting depth of the (selected) paragraph(s)
1317 * \li Syntax: depth-decrement
1320 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
1322 * \var lyx::FuncCode lyx::LFUN_DEPTH_INCREMENT
1323 * \li Action: Increase the nesting depth of the (selected) paragraph(s)
1325 * \li Syntax: depth-increment
1328 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
1331 * \var lyx::FuncCode lyx::LFUN_FONT_BOLD
1332 * \li Action: Toggles the bold font (selection-wise) using mathbf in math.
1333 * \li Syntax: font-bold
1336 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
1339 * \var lyx::FuncCode lyx::LFUN_FONT_BOLDSYMBOL
1340 * \li Action: Toggles the bold font (selection-wise) using boldsymbol in math.
1341 * \li Syntax: font-boldsymbol
1344 { LFUN_FONT_BOLDSYMBOL, "font-boldsymbol", Noop, Layout },
1346 * \var lyx::FuncCode lyx::LFUN_FONT_TYPEWRITER
1347 * \li Action: Toggles the typewriter family font (selection-wise).
1348 * \li Syntax: font-typewriter
1351 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
1353 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERLINE
1354 * \li Action: Toggles underline in the font (selection-wise).
1355 * \li Syntax: font-underline
1358 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
1360 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERUNDERLINE
1361 * \li Action: Toggles double underline in the font (selection-wise).
1362 * \li Syntax: font-underunderline
1363 * \li Origin: sanda, 5 May 2009
1366 { LFUN_FONT_UNDERUNDERLINE, "font-underunderline", Noop, Layout },
1368 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERWAVE
1369 * \li Action: Toggles wavy underline in the font (selection-wise).
1370 * \li Syntax: font-underwave
1371 * \li Origin: sanda, 5 May 2009
1374 { LFUN_FONT_UNDERWAVE, "font-underwave", Noop, Layout },
1376 * \var lyx::FuncCode lyx::LFUN_FONT_STRIKEOUT
1377 * \li Action: Toggles strikeout (strike-through) in the font (selection-wise).
1378 * \li Syntax: font-strikeout
1379 * \li Origin: sanda, 3 May 2009
1382 { LFUN_FONT_STRIKEOUT, "font-strikeout", Noop, Layout },
1384 * \var lyx::FuncCode lyx::LFUN_FONT_EMPH
1385 * \li Action: Toggles the emphasis font style (selection-wise).
1386 * \li Syntax: font-emph
1389 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
1391 * \var lyx::FuncCode lyx::LFUN_FONT_NOUN
1392 * \li Action: Toggles Noun text style font (selection-wise).
1393 * \li Syntax: font-noun
1396 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
1398 * \var lyx::FuncCode lyx::LFUN_FONT_ROMAN
1399 * \li Action: Toggles Roman family font (selection-wise).
1400 * \li Syntax: font-roman
1403 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
1405 * \var lyx::FuncCode lyx::LFUN_FONT_SANS
1406 * \li Action: Toggles Sans Serif family font (selection-wise).
1407 * \li Syntax: font-sans
1410 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
1412 * \var lyx::FuncCode lyx::LFUN_FONT_FRAK
1413 * \li Action: Toggles Fraktur family font (math-mode, selection-wise).
1414 * \li Syntax: font-frak
1415 * \li Origin: vermeer, 10 Jan 2002
1418 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
1420 * \var lyx::FuncCode lyx::LFUN_FONT_ITAL
1421 * \li Action: Toggles Italics font shape (math-mode, selection-wise).
1422 * \li Syntax: font-ital
1423 * \li Origin: vermeer, 10 Jan 2002
1426 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
1428 * \var lyx::FuncCode lyx::LFUN_FONT_DEFAULT
1429 * \li Action: Reverts the settings of the font to the default values (selection-wise).
1430 * \li Syntax: font-default
1433 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
1435 * \var lyx::FuncCode lyx::LFUN_FONT_SIZE
1436 * \li Action: Sets font size according to lyx format string.
1437 * \li Syntax: font-size <SIZE>
1438 * \li Params: <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|\n
1439 largest|huge|giant|increase|decrease|default
1442 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
1444 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_APPLY
1445 * \li Action: Toggle user-defined (=last-time used) text style.
1446 * \li Notion: This style is set via #LFUN_TEXTSTYLE_UPDATE, which is
1447 automatically triggered when using Text Style dialog.
1448 * \li Syntax: textstyle-apply
1449 * \li Origin: leeming, 12 Mar 2003
1452 { LFUN_TEXTSTYLE_APPLY, "textstyle-apply", Noop, Layout },
1454 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_UPDATE
1455 * \li Action: Apply text style and update the settings to be used by #LFUN_TEXTSTYLE_APPLY.
1456 * \li Syntax: textstyle-update <FONT_INFO>
1457 * \li Params: <FONT_INFO>: specifies font atributes, e.g. family, series, shape,
1458 size, emph, noun, underbar, number, color, language,
1460 Use lyx -dbg action for exact syntax of text-style
1462 * \li Origin: leeming, 12 Mar 2003
1465 { LFUN_TEXTSTYLE_UPDATE, "textstyle-update", Noop, Layout },
1467 * \var lyx::FuncCode lyx::LFUN_SCREEN_FONT_UPDATE
1468 * \li Action: Update fonts and its metrics.
1469 * \li Notion: Automatically called after zoom, dpi, font names, or norm change.
1470 * \li Syntax: screen-font-update
1471 * \li Origin: ARRae, 13 Aug 2000
1474 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
1476 * \var lyx::FuncCode lyx::LFUN_FONT_STATE
1477 * \li Action: Returns the info about the current font.
1478 * \li Syntax: font-state
1481 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
1484 * \var lyx::FuncCode lyx::LFUN_CITATION_INSERT
1485 * \li Action: Inserts citation from loaded citation database.
1486 * \li Syntax: citation-insert [<KEY>[|<TEXT_BEFORE>]]
1487 * \li Params: <KEY>: Citation (shortcut listed in available citations). \n
1488 <TEXT_BEFORE>: text which should appear before citation.
1489 * \li Origin: AAS, 97-02-23
1492 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
1494 * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_ADD
1495 * \li Action: Adds database, which will be used for bibtex citations.
1496 * \li Notion: Databases are added to the first BibTeX inset
1497 (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
1498 * \li Syntax: bibtex-database-add <DATABASE-NAME>
1499 * \li Origin: Ale, 30 May 1997
1502 { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit },
1504 * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_DEL
1505 * \li Action: Adds database, which will be used for bibtex citations.
1506 * \li Notion: Databases are deleted from the first BibTeX inset
1507 (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
1508 * \li Syntax: bibtex-database-del <DATABASE-NAME>
1509 * \li Origin: Ale, 30 May 1997
1512 { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
1515 * \var lyx::FuncCode lyx::LFUN_LAYOUT
1516 * \li Action: Sets the layout (that is, environment) for the current paragraph.
1517 * \li Syntax: layout <LAYOUT>
1518 * \li Params: <LAYOUT>: the layout to use
1521 { LFUN_LAYOUT, "layout", Noop, Layout },
1523 * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH
1524 * \li Action: Launches the paragraph settings dialog.
1525 * \li Syntax: layout-paragraph
1528 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
1530 * \var lyx::FuncCode lyx::LFUN_LAYOUT_TABULAR
1531 * \li Action: Launches the tabular settings dialog.
1532 * \li Syntax: layout-tabular
1533 * \li Origin: Jug, 31 Jul 2000
1536 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
1538 * \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE
1539 * \li Action: Displays list of layout choices.
1540 * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
1541 dropbox allowing for choice of layout.
1542 * \li Syntax: drop-layouts-choice
1545 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
1547 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
1548 * \li Action: Clears the module list.
1549 * \li Notion: Clears the list of included modules for the current buffer.
1550 * \li Syntax: layout-modules-clear
1551 * \li Origin: rgh, 25 August 2007
1554 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", NoInternal, Layout },
1556 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULE_ADD
1557 * \li Action: Adds a module.
1558 * \li Notion: Adds a module to the list of included modules for the current buffer.
1559 * \li Syntax: layout-module-add <MODULE>
1560 * \li Params: <MODULE>: the module to be added
1561 * \li Origin: rgh, 25 August 2007
1564 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", NoInternal, Layout },
1566 * \var lyx::FuncCode lyx::LFUN_LAYOUT_RELOAD
1567 * \li Action: Reloads layout information.
1568 * \li Notion: Reloads all layout information for the current buffer from disk, thus
1569 recognizing any changes that have been made to layout files on the fly.
1570 This is intended to be used only by layout developers and should not be
1571 used when one is trying to do actual work.
1572 * \li Syntax: layout-reload
1573 * \li Origin: rgh, 3 September 2007
1576 { LFUN_LAYOUT_RELOAD, "layout-reload", NoInternal, Layout },
1578 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
1579 * \li Action: Sets the text class for the current buffer.
1580 * \li Syntax: textclass-apply <TEXTCLASS>
1581 * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
1582 the filename, minus the ".layout" extension.
1585 { LFUN_TEXTCLASS_APPLY, "textclass-apply", NoInternal, Layout },
1587 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
1588 * \li Action: Loads information for a textclass from disk.
1589 * \li Syntax: textclass-load <TEXTCLASS>
1590 * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
1591 the filename, minus the ".layout" extension.
1594 { LFUN_TEXTCLASS_LOAD, "textclass-load", NoInternal, Layout },
1597 * \var lyx::FuncCode lyx::LFUN_MARK_OFF
1598 * \li Action: Disable selecting of text-region.
1599 * \li Syntax: mark-off
1602 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
1604 * \var lyx::FuncCode lyx::LFUN_MARK_ON
1605 * \li Action: Enable selecting of text-region.
1606 * \li Notion: After enabling you can simply move arrow keys to get selected region.
1607 * \li Syntax: mark-on
1610 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
1612 * \var lyx::FuncCode lyx::LFUN_MARK_TOGGLE
1613 * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
1614 * \li Syntax: mark-toggle
1615 * \li Origin: Andre, May 5 2006
1618 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
1621 * \var lyx::FuncCode lyx::LFUN_MATH_DELIM
1622 * \li Action: Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
1623 * \li Syntax: math-delim [<LEFT>] [<RIGHT>]
1624 * \li Params: <LEFT/RIGHT>: Delimiters to be used. Each delimiter can be specified by
1625 either a LaTeX name or a valid character.
1626 ( is the default letter.
1627 * \li Sample: math-delim { rangle
1628 * \li Origin: Alejandro, 18 Jun 1996
1631 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
1633 * \var lyx::FuncCode lyx::LFUN_MATH_BIGDELIM
1634 * \li Action: Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
1635 * \li Syntax: math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
1636 * \li Params: <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r \n
1637 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
1638 * \li Sample: math-bigdelim "Bigl" "\Downarrow" "Bigr" "\}"
1639 * \li Origin: Enrico & Georg, 7 May 2006
1642 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
1644 * \var lyx::FuncCode lyx::LFUN_MATH_DISPLAY
1645 * \li Action: Creates a new displayed equation in text mode.
1646 Toggles inlined/display formula in math mode.
1647 * \li Syntax: math-display [<ARG>]
1648 * \li Params: <ARG>: this argument will be passed to #LFUN_MATH_INSERT when creating
1649 new equation from the text mode.
1650 * \li Origin: Alejandro, 18 Jun 1996
1653 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
1655 * \var lyx::FuncCode lyx::LFUN_MATH_INSERT
1656 * \li Action: Inserts math objects and symbols.
1657 * \li Syntax: math-insert <ARG>
1658 * \li Params: <ARG>: Symbol or LaTeX code to be inserted.
1659 * \li Notion: When <ARG> is a _single_ math inset with more than one cell
1660 (such as "x_y^z" or "\frac{x}{y}"), the content of cell(0) is
1661 replaced by the current selection (only works if the selection
1662 is in mathed). As an example, if "abc" is selected in mathed,
1663 "math-insert \frac{x}{y}" replaces "abc" with "\frac{abc}{y}",
1664 and "math-insert x_y^z" replaces "abc" with "abc_y^z".
1665 If nothing is selected (or the selection is not in mathed),
1666 math-insert works as expected.
1669 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
1671 * \var lyx::FuncCode lyx::LFUN_MATH_SUBSCRIPT
1672 * \li Action: Enters subscript expression in math expression.
1673 * \li Syntax: math-subscript
1674 * \li Origin: vermeer, 12 Dec 2001
1677 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
1679 * \var lyx::FuncCode lyx::LFUN_MATH_SUPERSCRIPT
1680 * \li Action: Enters superscript expression in math expression.
1681 * \li Syntax: math-superscript
1682 * \li Origin: vermeer, 12 Dec 2001
1685 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
1687 * \var lyx::FuncCode lyx::LFUN_MATH_LIMITS
1688 * \li Action: Toggles the position of the limits from above/below to the right
1689 side an vice versa in integral symbol, a limit, a summation, etc.
1690 * \li Notion: Put the cursor before the symbol with the limits and then invoke
1692 * \li Syntax: math-limits [<STATE>]
1693 * \li Params: <STATE>: limits|nolimits
1696 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
1698 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO
1699 * \li Action: Inserts a math macro definition at the cursor position in the text.
1700 * \li Syntax: math-macro <NAME> [<NARGS>] [def]
1701 * \li Params: <NAME>: The name of the macro, e.g. "mymacro".\n
1702 <NARGS>: The number of parameters of the macro. Default is 0.
1703 "def": Has no effect anymore, just for compatibility with former LyX versions.
1704 * \li Origin: ale, 10 May 1997; sts, 21 Dec 2007
1707 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
1709 * \var lyx::FuncCode lyx::LFUN_MATH_MUTATE
1710 * \li Action: Mutates the type of math inset to the newly selected one.
1711 * \li Syntax: math-mutate <TYPE>
1712 * \li Params: <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
1713 multline|gather|flalign
1714 * \li Origin: Andre, 23 May 2001
1717 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
1719 * \var lyx::FuncCode lyx::LFUN_MATH_SPACE
1720 * \li Action: Inserts space into math expression.
1721 * \li Notion: Use spacebar after entering this space to change type of space.
1722 * \li Syntax: math-space [<TYPE>] [<LEN>]
1723 * \li Params: <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace \n
1724 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad \n
1725 custom space: hspace \n
1726 "," used by default.\n
1727 Note that ! is equivalent to negthinspace, , = thinspace,
1728 : = medspace, and ; = thickspace.\n
1729 <LEN>: length for custom spaces (hspace)
1730 * \li Origin: Andre, 25 Jul 2001; sanda, 16 Jun 2008
1733 { LFUN_MATH_SPACE, "math-space", Noop, Math },
1735 * \var lyx::FuncCode lyx::LFUN_MATH_MATRIX
1736 * \li Action: Inserts a matrix.
1737 * \li Syntax: math-matrix <COLS> <ROWS> [<ALIGN>]
1738 * \li Params: <ALIGN>: Alignment is a word composed of the vertical alignment
1739 (b, c or t) (i.e. 1 char) and the horizontal alignments
1740 (l, c or r) (i.e. <COL> chars).
1741 * \li Sample: math-matrix 3 3 bccc
1744 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
1746 * \var lyx::FuncCode lyx::LFUN_MATH_AMS_MATRIX
1747 * \li Action: Inserts an extended matrix as provided by the amsmath package.
1748 * \li Syntax: math-matrix <COLS> <ROWS> [<DECORATION>]
1749 * \li Params: <DECORATION>: Decoration determines the LaTeX name of the matrix
1750 that should be created. Possible values include
1751 pmatrix, bmatrix, Bmatrix, vmatrix, Vmatrix and
1752 matrix. The default is 'matrix'.
1753 * \li Sample: math-ams-matrix 3 3 bmatrix
1756 { LFUN_MATH_AMS_MATRIX, "math-ams-matrix", Noop, Math },
1758 * \var lyx::FuncCode lyx::LFUN_MATH_MODE
1759 * \li Action: In text mode enters math mode (i.e. puts math insets on the current
1760 cursor position), in math mode enters text mode inside math expression.
1761 * \li Notion: If there is some selected text, it puts the text inside created math box.
1762 * \li Syntax: math-mode [on|<ARG>]
1763 * \li Params: <ARG>: eventual argument (LaTeX code) is passed to #LFUN_MATH_INSERT .\n
1764 "on": allow only entering of math mode from text mode.
1765 * \li Origin: Alejandro, 4 Jun 1996
1768 { LFUN_MATH_MODE, "math-mode", Noop, Math },
1770 * \var lyx::FuncCode lyx::LFUN_REGEXP_MODE
1771 * \li Action: Enters regexp mode (i.e., puts regexp insets on the current
1772 cursor position). Used by the advanced search dialog.
1773 * \li Notion: If there is any selected text, then it is moved inside the created
1775 * \li Syntax: regexp-mode [<ARG>]
1776 * \li Params: <ARG>: eventual argument (regular expression).
1777 * \li Origin: Tommaso, 4 Oct 2008
1780 { LFUN_REGEXP_MODE, "regexp-mode", Noop, Math },
1782 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
1783 * \li Action: Toggles numbering of the current formula line.
1784 * \li Notion: Must be in display formula mode.
1785 * \li Syntax: math-number-line-toggle
1786 * \li Origin: Alejandro, 18 Jun 1996
1789 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
1791 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
1792 * \li Action: Toggles numbering/labeling of the current formula.
1793 * \li Notion: Must be in display formula mode.
1794 * \li Syntax: math-number-toggle
1795 * \li Origin: Alejandro, 4 Jun 1996
1798 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
1800 * \var lyx::FuncCode lyx::LFUN_MATH_EXTERN
1801 * \li Action: Calls external program and passes the current expression/equation
1802 as an argument for the calculation in the format appropriate to the
1804 * \li Notion: Selection can be used to determine the input for the external program.
1805 * \li Syntax: math-extern <LANG> [<COMMAND>]
1806 * \li Params: <LANG>: octave|maxima|maple|mathematica|script \n
1807 where "script" stands for the external script (normalized
1808 expression will be passed)
1809 * \li Origin: Andre, 24 Apr 2001
1810 * \li Sample: math-extern maple simplify
1813 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
1815 * \var lyx::FuncCode lyx::LFUN_MATH_SIZE
1816 * \li Action: Changes arbitrarily the size used by math fonts inside a context.
1817 * \li Notion: Provides an interface to the LaTeX math mode font size commands.
1818 * \li Syntax: math-size <STYLE>
1819 * \li Params: <STYLE>: \displaystyle|\textstyle|\scriptstyle|\scriptscriptstyle
1820 * \li Origin: Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
1823 { LFUN_MATH_SIZE, "math-size", Noop, Math },
1825 * \var lyx::FuncCode lyx::LFUN_MATH_FONT_STYLE
1826 * \li Action: Changes the text style used in math.
1827 * \li Syntax: math-font-style <STYLE>
1828 * \li Params: <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf|textnormal\n
1829 |textrm|textsf|texttt|textbf|textmd|textit|textsc|textsl|textup
1830 * \li Origin: vfr, 9 jan 2009
1833 { LFUN_MATH_FONT_STYLE, "math-font-style", Noop, Math },
1835 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
1836 * \li Action: Unfold a Math Macro.
1837 * \li Notion: Unfold the Math Macro the cursor is in, i.e.
1839 * \li Syntax: math-macro-unfold
1840 * \li Origin: sts, 06 January 2008
1843 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
1845 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
1846 * \li Action: Fold a Math Macro.
1847 * \li Notion: Fold the Math Macro the cursor is in if it was
1848 unfolded, i.e. displayed as \foo before.
1849 * \li Syntax: math-macro-fold
1850 * \li Origin: sts, 06 January 2008
1853 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
1855 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
1856 * \li Action: Add a parameter.
1857 * \li Notion: Add a parameter to a Math Macro.
1858 * \li Params: <NUM>: The number of the parameter behind which the new one
1859 will be added (1 for the first, i.e. use 0 for add a
1860 parameter at the left), defaults to the last one.
1861 * \li Syntax: math-macro-add-param <NUM>
1862 * \li Origin: sts, 06 January 2008
1865 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
1867 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
1868 * \li Action: Remove the last parameter.
1869 * \li Notion: Remove the last parameter of a Math Macro and
1870 remove its value in all instances of the macro
1872 * \li Params: <NUM>: The number of the parameter to be deleted (1 for
1873 the first), defaults to the last one.
1874 * \li Syntax: math-macro-remove-param <NUM>
1875 * \li Origin: sts, 06 January 2008
1878 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
1880 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
1881 * \li Action: Append a greedy parameter.
1882 * \li Notion: Append a greedy parameter to a Math Macro which
1883 eats the following mathed cell in every instance of
1884 the macro in the buffer.
1885 * \li Syntax: math-macro-append-greedy-param
1886 * \li Origin: sts, 06 January 2008
1889 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
1891 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
1892 * \li Action: Remove a greedy parameter.
1893 * \li Notion: Remove a greedy parameter of a Math Macro and spit
1894 out the values of it in every instance of the macro
1895 in the buffer. If it is an optional parameter the [valud]
1897 * \li Syntax: math-macro-remove-greedy-param
1898 * \li Origin: sts, 06 January 2008
1901 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
1903 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
1904 * \li Action: Make a parameter optional.
1905 * \li Notion: Turn the first non-optional parameter of a Math Macro
1906 into an optional parameter with a default value.
1907 * \li Syntax: math-macro-make-optional
1908 * \li Origin: sts, 06 January 2008
1911 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
1913 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
1914 * \li Action: Make a parameter non-optional.
1915 * \li Notion: Turn the last optional parameter of a Math Macro
1916 into a non-optional parameter. The default value is
1917 remembered to be reused later if the user changes his mind.
1918 * \li Syntax: math-macro-make-nonoptional
1919 * \li Origin: sts, 06 January 2008
1922 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
1924 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
1925 * \li Action: Add an optional parameter.
1926 * \li Notion: Insert an optional parameter just behind the
1927 already existing optional parameters.
1928 * \li Syntax: math-macro-add-optional-param
1929 * \li Origin: sts, 06 January 2008
1932 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
1934 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
1935 * \li Action: Remove the last optional parameter.
1936 * \li Notion: Remove the last optional parameter of a Math Macro and
1937 remove it in all the instances of the macro in the buffer.
1938 * \li Syntax: math-macro-remove-optional-param
1939 * \li Origin: sts, 06 January 2008
1942 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
1944 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
1945 * \li Action: Add a greedy optional parameter.
1946 * \li Notion: Add a greedy optional parameter which eats the value
1947 from the following cells in mathed which are in the [value]
1949 * \li Syntax: math-macro-add-greedy-optional-param
1950 * \li Origin: sts, 06 January 2008
1953 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
1955 * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
1956 * \li Action: Only active in Math Macro definition.
1957 * \li Notion: Dummy function which is only active in a Math Macro definition.
1958 It's used to toggle the Math Macro toolbar if the cursor moves
1959 into a Math Macro definition.
1960 * \li Syntax: in-mathmacrotemplate
1961 * \li Origin: sts, 06 January 2008
1964 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
1967 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
1968 * \li Action: Moves the current paragraph downwards in the document.
1969 * \li Syntax: paragraph-move-down
1970 * \li Origin: Edwin, 8 Apr 2006
1973 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
1975 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
1976 * \li Action: Moves the current paragraph upwards in the document.
1977 * \li Notion: Movement through the document will possibly break the paragraph-depth
1978 (e.g. itemize structure).
1979 * \li Syntax: paragraph-move-up
1980 * \li Origin: Edwin, 8 Apr 2006
1983 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
1986 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP
1987 * \li Action: Move the cursor to the next paragraph (or beginning of the current one)
1988 in upward direction.
1989 * \li Syntax: paragraph-up
1990 * \li Origin: Asger, 1 Oct 1996
1993 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
1995 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP_SELECT
1996 * \li Action: Move the cursor and select the text to the next paragraph (or
1997 beginning of the current one) in upward direction.
1998 * \li Syntax: paragraph-up-select
1999 * \li Origin: Asger, 1 Oct 1996
2002 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
2004 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN
2005 * \li Action: Move the cursor to the next paragraph (or beginning of the current one)
2006 in downward direction.
2007 * \li Syntax: paragraph-down
2008 * \li Origin: Asger, 1 Oct 1996
2011 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
2013 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN_SELECT
2014 * \li Action: Move the cursor and select the text to the next paragraph (or
2015 beginning of the current one) in downward direction.
2016 * \li Syntax: paragraph-down-select
2017 * \li Origin: Asger, 1 Oct 1996
2020 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
2022 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
2023 * \li Action: Jump to a paragraph given by its id number and optionally the
2024 desired position within the paragraph.
2025 * \li Notion: Note that id number of paragraph is not the sequential number of paragraph
2026 seen on the screen. Moreover the id is unique for all opened buffers (documents).
2027 * \li Syntax: paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
2028 * \li Params: <PAR_ID_NUMBER>: paragraph id \n
2029 <POSITION_IN_PAR>: desired position within the paragraph
2030 * \li Origin: Dekel, 26 Aug 2000
2033 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly | NoInternal, Edit },
2035 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_BREAK
2036 * \li Action: Breaks the current paragraph at the current location.
2037 * \li Notion: Removes the selection.
2038 * \li Syntax: paragraph-break [<LAYOUT>]
2039 * \li Params: <LAYOUT>: "inverse" - decreases depth by one (or change layout
2040 to default layout) when the cursor is at the end of
2044 { LFUN_PARAGRAPH_BREAK, "paragraph-break", Noop, Edit },
2046 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
2047 * \li Action: Change paragraph settings.
2048 * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
2049 This function only modifies, and does not override, existing settings.
2050 Note that the "leftindent" indent setting is deprecated.
2051 * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
2052 * \li Params: <INDENT>: \noindent|\indent|\indent-toggle|\leftindent LENGTH\n
2053 <SPACING>: \paragraph_spacing default|single|onehalf|double|other SIZE \n
2054 <ALIGN>: \align block|left|right|center|default\n
2055 <OTHERS>: \labelwidthstring WIDTH|\start_of_appendix
2056 * \li Origin: rgh, Aug 15 2007
2059 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
2061 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
2062 * \li Action: Change paragraph settings.
2063 * \li Notion: Overwrite all nonspecified settings to the default ones.
2064 Use paragraph-params lfun if you don't want to overwrite others settings.
2065 * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
2066 * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
2067 * \li Origin: leeming, 30 Mar 2004
2070 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
2072 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UPDATE
2073 * \li Action: Updates the values inside the paragraph dialog from the paragraph.
2074 * \li Notion: This is an internal LFUN, not to be used by users. Called internally
2075 by #LFUN_DIALOG_UPDATE.
2076 * \li Origin: leeming, 13 Mar 2003
2079 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
2082 * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
2083 * \li Action: Move the current group in the upward direction in the
2084 structure of the document.
2085 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
2086 the whole substructure of the group.
2087 * \li Syntax: outline-up
2088 * \li Origin: Vermeer, 23 Mar 2006
2091 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
2093 * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
2094 * \li Action: Move the current group in the downward direction in the
2095 structure of the document.
2096 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
2097 the whole substructure of the group.
2098 * \li Syntax: outline-down
2099 * \li Origin: Vermeer, 23 Mar 2006
2102 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
2104 * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
2105 * \li Action: Moves the current group in the downward direction in the
2106 hierarchy of the document structure.
2107 * \li Notion: Part -> Chapter -> Section -> etc.
2108 * \li Syntax: outline-in
2109 * \li Origin: Vermeer, 23 Mar 2006
2112 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
2114 * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
2115 * \li Action: Moves the current group in the upward direction in the
2116 hierarchy of the document structure.
2117 * \li Notion: Part <- Chapter <- Section <- etc.
2118 * \li Syntax: outline-out
2119 * \li Origin: Vermeer, 23 Mar 2006
2122 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
2125 * \var lyx::FuncCode lyx::LFUN_INSET_EDIT
2126 * \li Action: Edit the inset at cursor with an external application,
2127 if one is attributed.
2128 * \li Syntax: inset-edit [<INSET_PARAMS>]
2129 * \li Params: <INSET_PARAMS>: Parameters for the inset. \n
2130 Currently only the filename will be considered.
2131 * \li Origin: JSpitzm, 27 Apr 2006
2134 { LFUN_INSET_EDIT, "inset-edit", ReadOnly | AtPoint, Edit },
2137 * \var lyx::FuncCode lyx::LFUN_TABULAR_INSERT
2138 * \li Action: Inserts table into the document.
2139 * \li Notion: See #LFUN_INSET_MODIFY for some more details
2140 about tabular modifications.
2141 * \li Syntax: tabular-insert [<ROWS> <COLUMNS>]
2142 * \li Params: In case no arguments are given show insert dialog.
2143 * \li Origin: Jug, 12 Apr 2000
2146 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
2149 * \var lyx::FuncCode lyx::LFUN_CELL_BACKWARD
2150 * \li Action: Moves the cursor to the previous cell inside the table.
2151 * \li Syntax: cell-backward
2152 * \li Origin: Jug, 22 May 2000
2155 { LFUN_CELL_BACKWARD, "cell-backward", ReadOnly | NoUpdate, Edit },
2157 * \var lyx::FuncCode lyx::LFUN_CELL_FORWARD
2158 * \li Action: Moves the cursor to the next cell inside the table.
2159 * \li Syntax: cell-forward
2162 { LFUN_CELL_FORWARD, "cell-forward", ReadOnly | NoUpdate, Edit },
2164 * \var lyx::FuncCode lyx::LFUN_CELL_SPLIT
2165 * \li Action: Splits cell and shifts right part to the next cell (inside the math grid).
2166 * \li Syntax: cell-split
2167 * \li Origin: Ale, 15 May 1997
2170 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
2173 * \var lyx::FuncCode lyx::LFUN_VC_REGISTER
2174 * \li Action: Register the document as an file inside version control system.
2175 * \li Notion: File is registered inside cvs, svn or rcs repository acording to the existence
2176 of cvs/svn/rcs entries in the document's directory. \n
2177 See LyX Additional Features Manual (Version Control Chapter) for additional
2179 * \li Syntax: vc-register
2180 * \li Origin: Lgb, 1 Jul 1997
2183 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
2185 * \var lyx::FuncCode lyx::LFUN_VC_RENAME
2186 * \li Action: Renames the document to another name.
2187 * \li Notion: Renaming with revision history is only supported by SVN.
2188 For CVS it is simulated by adding the document under a new
2189 name and deleting the old one. For RCS it is not supported.
2190 Disabled if uncommitted changes exist.
2191 * \li Syntax: vc-rename <FILENAME>
2192 * \li Params: <FILENAME>: New name of the document.\n
2193 * A file dialog is opened if no filename is given.
2194 * \li Origin: gb, 05 Feb 2013
2197 { LFUN_VC_RENAME, "vc-rename", ReadOnly, System },
2199 * \var lyx::FuncCode lyx::LFUN_VC_COPY
2200 * \li Action: Copies the document to another name.
2201 * \li Notion: Copying with revision history is only supported by SVN.
2202 For RCS and CVS it is simulated by adding the document
2204 Disabled if uncommitted changes exist.
2205 * \li Syntax: vc-copy <FILENAME>
2206 * \li Params: <FILENAME>: New name of the document.\n
2207 * A file dialog is opened if no filename is given.
2208 * \li Origin: gb, 05 Feb 2013
2211 { LFUN_VC_COPY, "vc-copy", ReadOnly, System },
2213 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_IN
2214 * \li Action: Checks-in/commits the changes of the registered file to the repository.
2215 * \li Notion: In RCS case this also unlocks the file.
2216 * \li Syntax: vc-check-in
2217 * \li Origin: Lgb, 1 Jul 1997
2220 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
2222 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_OUT
2223 * \li Action: Checks-out the document for edit (and locks it in some cases).
2224 * \li Syntax: vc-check-out
2225 * \li Origin: Lgb, 1 Jul 1997
2228 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
2230 * \var lyx::FuncCode lyx::LFUN_VC_REVERT
2231 * \li Action: Reverts the document to the last check-in/commit in VCS.
2232 * \li Syntax: vc-revert
2233 * \li Origin: Lgb, 1 Jul 1997
2236 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
2238 * \var lyx::FuncCode lyx::LFUN_VC_UNDO_LAST
2239 * \li Action: Undo last check-in.
2240 * \li Notion: This is currently implemented only for RCS.
2241 * \li Syntax: vc-check-out
2242 * \li Origin: Lgb, 1 Jul 1997
2245 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
2247 * \var lyx::FuncCode lyx::LFUN_VC_COMMAND
2248 * \li Action: Executes external command. This command is intended to support
2249 additional VCS commands.
2250 * \li Syntax: vc-command <FLAG> <PATH> <COMMAND>
2251 * \li Params: <FLAG>: Flags for the command can be combined together.\n
2252 U - dUmmy - no flags \n
2253 D - Doc - need document loaded to proceed \n
2254 I - dIrty - mark document dirty \n
2255 R - Reload - ensure that the document is saved and reload it after command execution \n
2256 M - Message - ask for input string (commit message)\n
2257 <PATH>: path where to start. $$p will be replaced by the current document path.\n
2258 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current
2259 document(with absolute path)/path/message.
2260 * \li Sample: vc-command DR $$p "svn up"
2261 * \li Origin: sanda, 13 Jan 2009
2264 { LFUN_VC_COMMAND, "vc-command", NoBuffer | ReadOnly, System },
2266 * \var lyx::FuncCode lyx::LFUN_VC_LOCKING_TOGGLE
2267 * \li Action: Toggles the locking property of the edited file.
2268 * \li Notion: This is currently implemented only for SVN.
2269 * \li Syntax: vc-locking-toggle
2270 * \li Origin: sanda, 25 Jun 2009
2273 { LFUN_VC_LOCKING_TOGGLE, "vc-locking-toggle", ReadOnly, System },
2275 * \var lyx::FuncCode lyx::LFUN_VC_REPO_UPDATE
2276 * \li Action: Update the local archive directory in which resides
2277 the current document with the remote repository.
2278 * \li Syntax: vc-repo-update
2279 * \li Origin: sanda, 16 Oct 2009
2282 { LFUN_VC_REPO_UPDATE, "vc-repo-update", ReadOnly, System },
2284 * \var lyx::FuncCode lyx::LFUN_VC_COMPARE
2285 * \li Action: Compares two revisions of the same file under version control.
2286 * \li Syntax: vc-compare [<REV1>] [<REV2>]
2287 * \li Params: Revision number either points directly to commit in history
2288 or if negative number -x it points to (last commit - x).\n
2289 In RCS we subtract only in the last number of revision specification.
2290 Special case "0" is reserved for the last committed revision.\n
2291 <REV1>: Older file.\n
2292 <REV2>: Newer file. Used only if REV1 > 0.\n
2293 If no parameter is given, interactive dialog will be shown.
2294 * \li Sample: Compare current document against last commit\n
2296 Compare current document against current revision - 5 commits\n
2298 Compare revisions 120 and 155\n
2300 * \li Origin: sanda, 12 Feb 2010
2303 { LFUN_VC_COMPARE, "vc-compare", ReadOnly, System },
2306 * \var lyx::FuncCode lyx::LFUN_CHANGES_TRACK
2307 * \li Action: Toggles change tracking to on/off.
2308 * \li Syntax: changes-track
2309 * \li Origin: levon, 1 Oct 2002
2312 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
2314 * \var lyx::FuncCode lyx::LFUN_CHANGES_OUTPUT
2315 * \li Action: Toggles showing of change tracking in typeset output.
2316 * \li Syntax: changes-output
2317 * \li Origin: jspitzm, 21 Jan 2005
2320 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
2322 * \var lyx::FuncCode lyx::LFUN_CHANGE_NEXT
2323 * \li Action: Moves the cursor to the position of the next change
2324 of the change tracking records.
2325 * \li Syntax: change-next
2326 * \li Origin: schmitt, 4 Oct 2006
2329 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
2331 * \var lyx::FuncCode lyx::LFUN_CHANGE_PREVIOUS
2332 * \li Action: Moves the cursor to the position of the previous change
2333 of the change tracking records.
2334 * \li Syntax: change-previous
2335 * \li Origin: vfr, 4 Apr 2009
2338 { LFUN_CHANGE_PREVIOUS, "change-previous", ReadOnly, Edit },
2340 * \var lyx::FuncCode lyx::LFUN_CHANGES_MERGE
2341 * \li Action: Open change tracking dialog for merging and moves the cursor
2342 to the position of the next change.
2343 * \li Syntax: changes-merge
2344 * \li Origin: Levon, 16 Oct 2002
2347 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
2349 * \var lyx::FuncCode lyx::LFUN_CHANGE_ACCEPT
2350 * \li Action: Accepts tracked change inside the selection.
2351 * \li Syntax: change-accept
2352 * \li Origin: Levon, 16 Oct 2002
2355 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
2357 * \var lyx::FuncCode lyx::LFUN_CHANGE_REJECT
2358 * \li Action: Rejects tracked change inside the selection.
2359 * \li Syntax: change-reject
2360 * \li Origin: Levon, 16 Oct 2002
2363 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
2365 * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_ACCEPT
2366 * \li Action: Accepts all tracked changes in the document.
2367 * \li Syntax: all-changes-accept
2368 * \li Origin: Levon, 16 Oct 2002
2371 { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
2373 * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_REJECT
2374 * \li Action: Rejects all tracked changes in the document.
2375 * \li Notion: Reject does not work recursively; the user may have to repeat the operation.
2376 * \li Syntax: all-changes-reject
2377 * \li Origin: Levon, 16 Oct 2002
2380 { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
2383 * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
2384 * \li Action: Apply data for an inset.
2385 * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
2386 be applied. This is either changed to #LFUN_INSET_MODIFY or
2387 #LFUN_INSET_INSERT depending on the context where it is called.
2388 * \li Syntax: inset-apply <ARGS>
2389 * \li Params: See #LFUN_INSET_INSERT .
2392 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
2394 * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE
2395 * \li Action: Dissolve the current inset into text.
2396 * \li Syntax: inset-dissolve [<INSET>]
2397 * \li Params: <INSET>: this can be used to make sure the right kind of inset
2398 is dissolved. For example "dissolve" entry in the charstyles
2399 sub-menu should only dissolve the charstyle inset, even if the
2400 cursor is inside several nested insets of different type.\n
2401 For values see #lyx::InsetLayout::lyxtype_ .
2402 * \li Origin: JSpitz, 7 Aug 2006
2405 { LFUN_INSET_DISSOLVE, "inset-dissolve", AtPoint, Edit },
2407 * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
2408 * \li Action: Insert new inset (type given by the parameters).
2409 * \li Syntax: inset-insert <INSET> <ARGS>
2410 * \li Params: <INSET>: <bibitem|bibtex|citation|ert|listings|external|graphics|tabular|\n
2411 hyperlink|include|index|label|line|nomencl|vspace|ref|toc|script>\n
2412 <ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
2413 * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
2414 where <label name> is the name of the referenced label and
2415 <Format> is one of the following: \n
2416 ref -- <reference> \n
2417 eqref -- (<reference>) \n
2418 pageref -- <page> \n
2419 vpageref -- on <page> \n
2420 vref -- <reference> on <page> \n
2421 formatted -- Formatted reference
2424 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
2426 * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
2427 * \li Action: Modify some properties of an inset.
2428 * \li Notion: Used for bibitem, bibtex, box, branch, command, ert, external,
2429 floats, graphics, include, index, info, label,
2430 listings, newline, newpage, nomencl, note, phantom,
2431 ref, space, tabular, vspace, wrap insets.
2432 * \li Syntax: inset-modify <INSET> <ARGS>
2433 * \li Syntax: inset-modify changetype <TYPE>
2434 * \li Syntax: inset-modify tabular <FEATURE> [<ARG>]
2435 * \li Params: Generally see #LFUN_INSET_INSERT for further details.\n
2436 In case that <INSET> is "tabular" various math-environment features
2437 are handled as well, e.g. add-vline-left/right for the Grid/Array environment.\n
2438 <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|\n
2439 copy-column|move-column-right|move-column-left|move-row-down|move-row-up|\n
2440 toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|\n
2441 align-left|align-right|align-center|align-block|align-decimal|set-decimal-point|\n
2442 valign-top|valign-bottom|valign-middle|longtabular-align-left|\n
2443 longtabular-align-center|longtabular-align-right|m-align-left|m-align-right|\n
2444 m-align-center|m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|\n
2445 set-all-lines|unset-all-lines|set-longtabular|unset-longtabular|set-pwidth|\n
2446 set-mpwidth|set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|\n
2447 set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|\n
2448 unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|\n
2449 set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|\n
2450 set-special-column|set-special-multicolumn|set-special-multirow|\n
2451 set-booktabs|unset-booktabs|set-top-space|set-bottom-space|\n
2452 set-interline-space|set-border-lines|tabular-valign-top|\n
2453 tabular-valign-middle|tabular-valign-bottom|set-tabular-width
2454 <ARG>: additional argument for some commands, use debug mode to explore its values.
2455 * \li Sample: inset-modify note Note Comment \n
2456 inset-modify changetype Ovalbox
2459 { LFUN_INSET_MODIFY, "inset-modify", AtPoint, Edit },
2461 * \var lyx::FuncCode lyx::LFUN_INSET_DIALOG_UPDATE
2462 * \li Action: Updates the values inside the dialog from the inset.
2463 * \li Notion: This is an internal LFUN, not to be used by users. Called internally
2464 by #LFUN_DIALOG_UPDATE
2465 * \li Params: <DIALOG-NAME>
2466 * \li Origin: leeming, 25 Feb 2003
2469 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
2471 * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
2472 * \li Action: Open the inset's properties dialog.
2473 * \li Notion: Used for bibitem, bibtex, box, branch, citation, ert, external,
2474 float, graphics, href, include, index, index_print, label, line,
2475 listings, note, phantom, ref, space, tabular, vspace, wrap insets.
2476 * \li Syntax: inset-settings <INSET>
2477 * \li Params: <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|\n
2478 graphics|href|include|index|index_print|label|line|\n
2479 listings|note|phantom|ref|space|tabular|vspace|wrap>.
2482 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly | AtPoint, Edit },
2484 * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
2485 * \li Action: Toggles the collapsible inset at cursor position,
2486 or the inset we are currently in.
2487 * \li Syntax: inset-toggle [<ARG>]
2488 * \li Params: <ARG>: <open|close|toggle|assign>. \n
2489 open/close/toggle are for collapsible insets. toggle is used when no argument is given.\n
2490 assign synchronize the branch-inset with activation status of the branch.
2491 Used for global toggling when changed activation.
2492 * \li Origin: lasgouttes, 19 Jul 2001
2495 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly | AtPoint, Edit },
2497 * \var lyx::FuncCode lyx::LFUN_INSET_FORALL
2498 * \li Action: Apply the given commands on insets of a given name.
2499 * \li Notion: WARNING: use at your own risks; this function gives
2500 you too many ways of shooting yourself in the foot.
2501 A typical example is
2502 inset-forall Note note-insert
2503 which starts an infinite loop. This is mitigated by the fact
2504 that the number of actions is arbitrarily limited to 100000.
2505 Note also that inset-forall does not update metrics between
2506 iterations, which can lead to bugs. This has to be eventually
2508 * \li Syntax: inset-forall <NAME> <LFUN-COMMAND> \n
2509 <NAME>: Type of Inset. If <NAME> is *, all insets are matched.
2510 The name is used like for InsetLayout in layout files: "Note"
2511 matches all note insets, while "Note:Note" only matches LyX
2513 * \li Sample: Remove all index insets: \n
2514 inset-forall Index char-delete-forward \n
2515 Close all Notes (also works for a particular branch, for example): \n
2516 inset-forall Note inset-toggle close \n
2517 Transform all yellow notes to comments \n
2518 inset-forall Note:Note inset-modify note Note Comment \n
2519 Try to put LyX in an infinite loop if there is at least a Note: \n
2520 inset-forall Note char-backward
2521 * \li Origin: lasgouttes, 27 Nov 2009
2524 { LFUN_INSET_FORALL, "inset-forall", ReadOnly, Edit },
2527 * \var lyx::FuncCode lyx::LFUN_GRAPHICS_RELOAD
2528 * \li Action: Reloads the image if necessary.
2529 * \li Syntax: graphics-reload
2530 * \li Origin: vfr, 10 Aug 2009
2533 { LFUN_GRAPHICS_RELOAD, "graphics-reload", ReadOnly | AtPoint, Edit },
2535 * \var lyx::FuncCode lyx::LFUN_SET_GRAPHICS_GROUP
2536 * \li Action: Set the group for the graphics inset on the cursor position.
2537 * \li Syntax: set-graphics-group [<GROUP>]
2538 * \li Params: <GROUP>: Id for an existing group. In case the Id is an empty string,
2539 the graphics inset is removed from the current group.
2540 * \li Origin: sanda, 6 May 2008
2543 { LFUN_SET_GRAPHICS_GROUP, "set-graphics-group", Noop, Edit },
2546 * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
2547 * \li Action: Moves the cursor out of the current slice, going forward.
2548 * \li Notion: Cursor movement within an inset may be different than cursor
2549 movement in the surrounding text. This action should be called
2550 automatically by the cursor movement within the inset, when
2551 movement within the inset has ceased (reached the end of the
2552 last paragraph, for example), in order to move correctly
2553 back into the surrounding text.
2556 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
2558 * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
2559 * \li Action: Moves the cursor out of the current slice, going backwards.
2560 * \li Notion: See also #LFUN_FINISHED_FORWARD.
2563 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
2565 * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
2566 * \li Action: Moves the cursor out of the current slice, going right.
2567 * \li Notion: See also #LFUN_FINISHED_FORWARD
2570 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
2572 * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
2573 * \li Action: Moves the cursor out of the current slice, going left.
2574 * \li Notion: See also #LFUN_FINISHED_FORWARD.
2577 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
2580 * \var lyx::FuncCode lyx::LFUN_LANGUAGE
2581 * \li Action: Set language from the current cursor position.
2582 * \li Syntax: language <LANG> [set]
2583 * \li Params: <LANG>: Requested language. Look in lib/languages for
2584 the list. "language reset" or "language" (without param)
2585 reset to the document language.
2586 set: If used, the language will be set to the specified
2587 language. Otherwise, the language will be toggled (i.e., if
2588 the current language is LANG, switch to the document language
2589 or the default language, if LANG is the document language).
2590 * \li Origin: Dekel, 2 Mar 2000
2593 { LFUN_LANGUAGE, "language", Noop, Edit },
2596 * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
2597 * \li Action: Goto a label.
2598 * \li Syntax: label-goto [<LABEL>]
2599 * \li Params: <LABEL>: Requested label. If no label is given and reference
2600 is on cursor position, Bookmark 0 is saved and
2601 cursor moves to the position of referenced label.
2602 * \li Origin: Ale, 6 Aug 1997
2605 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
2607 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT
2608 * \li Action: Inserts label to text or displayed formula.
2609 * \li Syntax: label-insert [<LABEL>]
2610 * \li Params: <LABEL>: Requested label. If no label is given dialog requesting
2611 name will be opened.
2614 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
2616 * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
2617 * \li Action: Go to the next label or cross-reference.
2618 * \li Syntax: reference-next
2619 * \li Origin: Dekel, 14 Jan 2001
2622 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
2625 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
2626 * \li Action: Moves the cursor to the numbered bookmark, opening the file
2627 if necessary. Note that bookmarks are saved per-session, not
2629 * \li Notion: Bookmark 0 has a special purpose. It is automatically set \n
2630 1. to the paragraph you are currently editing \n
2631 2. to the paragraph from where you are jumping to the last-edited
2632 position (jump-back feature) \n
2633 3. when jumping from crossreference to the requested label by
2635 * \li Syntax: bookmark-goto <NUMBER>
2636 * \li Params: <NUMBER>: the number of the bookmark to restore.
2637 * \li Origin: Dekel, 27 January 2001
2640 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
2642 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
2643 * \li Action: Save a bookmark.
2644 * \li Notion: Saves a numbered bookmark to the sessions file. The number
2645 must be between 1 and 9, inclusive. Note that bookmarks are
2646 saved per-session, not per file.
2647 * \li Syntax: bookmark-save <NUMBER>
2648 * \li Params: <NUMBER>: the number of the bookmark to save.
2649 * \li Origin: Dekel, 27 January 2001
2652 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
2654 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
2655 * \li Action: Clears the list of saved bookmarks.
2656 * \li Syntax: bookmark-clear
2657 * \li Origin: bpeng, 31 October 2006
2660 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
2663 * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
2664 * \li Action: Open the given help file according to the language setting.
2665 * \li Syntax: help-open <FILE>[.lyx]
2666 * \li Params: <FILE>: any document from (/usr/share/)doc directory.
2667 * \li Origin: Jug, 27 Jun 1999
2670 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
2672 * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
2673 * \li Action: Terminates the current LyX instance.
2674 * \li Notion: Terminates the current LyX instance, asking whether to save
2675 modified documents, etc.
2676 * \li Syntax: lyx-quit
2679 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
2681 * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
2682 * \li Action: Toggles visibility of a given toolbar between on/off/auto.
2683 * \li Notion: Skipping "auto" when allowauto is false.
2684 * \li Syntax: toolbar-toggle <NAME> [allowauto]
2685 * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|\n
2686 minibuffer|review|view/update|math_panels|vcs|
2687 view-others|update-others
2688 * \li Origin: Edwin, 21 May 2007
2691 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
2693 * \var lyx::FuncCode lyx::LFUN_MENU_OPEN
2694 * \li Action: Opens the menu given by its name.
2695 * \li Syntax: menu-open <NAME>
2696 * \li Params: <NAME>: menu name. See various .inc files in lib/ui for candidates.
2699 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
2701 * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
2702 * \li Action: Various UI visibility-toggling actions.
2703 * \li Syntax: ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
2704 * \li Params: statusbar : Toggle visibility of the statusbar.\n
2705 menubar : Toggle visibility of the menubar.\n
2706 scrollbar : Toggle visibility of the scrollbar.\n
2707 frame : Toggle visibility of the frames around editing window.\n
2708 fullscreen : Toggle fullscreen mode. This also covers calling the
2709 previous functions. However #LFUN_TOOLBAR_TOGGLE for the
2710 custom tweaks of the toolbars should be used.
2711 * \li Origin: sanda, 9 Feb 2007
2714 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
2717 * \var lyx::FuncCode lyx::LFUN_WINDOW_NEW
2718 * \li Action: Creates new empty LyX window.
2719 * \li Notion: Already opened documents from the previous window can be found under View menu.
2720 * \li Syntax: window-new [<GEOMETRY>]
2721 * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently
2722 accepted only on Windows platform.
2723 * \li Origin: Abdel, 21 Oct 2006
2726 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
2728 * \var lyx::FuncCode lyx::LFUN_WINDOW_CLOSE
2729 * \li Action: Closes the current LyX window.
2730 * \li Syntax: window-close
2731 * \li Origin: Abdel, 23 Oct 2006
2734 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
2737 * \var lyx::FuncCode lyx::LFUN_VIEW_SPLIT
2738 * \li Action: Creates another split view of current buffer.
2739 * \li Notion: All split views act in the same way independently.
2740 * \li Syntax: view-split <vertical|horizontal>
2741 * \li Params: horizontal : The work areas are laid out side by side.\n
2742 vertical : The work areas laid out vertically.
2743 * \li Origin: Abdel, 20 Feb 2008
2746 { LFUN_VIEW_SPLIT, "view-split", ReadOnly, Buffer },
2749 * \var lyx::FuncCode lyx::LFUN_VIEW_CLOSE
2750 * \li Action: Close the current document work area.
2751 * \li Notion: Close the current work area. If no other work areas are showing the buffer,
2752 then close the associated buffer as well.
2753 * \li Syntax: view-close
2754 * \li Origin: Tommaso, 15 Sep 2012
2757 { LFUN_VIEW_CLOSE, "view-close", ReadOnly, Buffer },
2760 * \var lyx::FuncCode lyx::LFUN_TAB_GROUP_CLOSE
2761 * \li Action: Close the current tab group.
2762 * \li Notion: This only closes the work areas, not the buffers themselves.
2763 The still opened buffers can be visualized in another tab group.
2764 * \li Syntax: tab-group-close
2765 * \li Origin: Abdel, 21 Feb 2008
2768 { LFUN_TAB_GROUP_CLOSE, "tab-group-close", ReadOnly, Buffer },
2771 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW
2772 * \li Action: Shows hidden dialog or creates new one for a given function/inset settings etc.
2773 * \li Syntax: dialog-show <NAME> [<DATA>]
2774 * \li Params: <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|\n
2775 compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|\n
2776 graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimiter|\n
2777 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|\n
2778 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|\n
2779 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL> \n
2780 <SPECIAL>: latexlog|vclog \n
2781 <DATA>: data, usually settings for the given dialog. Use debug mode for the
2783 * \li Origin: leeming, 17 Jun 2003
2786 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
2788 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW_NEW_INSET
2789 * \li Action: Shows hidden dialog or create new one for a given inset settings etc.
2790 * \li Notion: Internally uses #LFUN_DIALOG_SHOW with processed data for a given inset.
2791 * \li Syntax: dialog-show-new-inset <NAME> [<DATA>]
2792 * \li Params: See #LFUN_DIALOG_SHOW .
2793 * \li Origin: leeming, 25 Feb 2003
2796 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
2798 * \var lyx::FuncCode lyx::LFUN_DIALOG_UPDATE
2799 * \li Action: Updates the dialog values from the inset/paragraph/document.
2800 * \li Syntax: dialog-update <NAME>
2801 * \li Params: <NAME>: paragraph|prefs|<INSET> \n
2803 * \li Origin: leeming, 25 Feb 2003
2806 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
2808 * \var lyx::FuncCode lyx::LFUN_DIALOG_HIDE
2809 * \li Action: Hides showed dialog. Counterpart to #LFUN_DIALOG_SHOW .
2810 * \li Syntax: dialog-hide <NAME>
2811 * \li Params: See #LFUN_DIALOG_SHOW .
2812 * \li Origin: leeming, 25 Feb 2003
2815 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
2817 * \var lyx::FuncCode lyx::LFUN_DIALOG_TOGGLE
2818 * \li Action: Toggles dialog between showed/hidden state.
2819 * \li Notion: Internally uses #LFUN_DIALOG_SHOW , #LFUN_DIALOG_HIDE .
2820 * \li Syntax: dialog-toggle <NAME> [<DATA>]
2821 * \li Params: See #LFUN_DIALOG_SHOW .
2822 * \li Origin: JSpitzm, 30 Apr 2007
2825 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
2827 * \var lyx::FuncCode lyx::LFUN_DIALOG_DISCONNECT_INSET
2828 * \li Action: Closes opened connection to opened inset.
2829 * \li Notion: Connection is used for apply functions.
2830 * \li Syntax: dialog-disconnect-inset <INSET-NAME>
2831 * \li Origin: leeming, 25 Feb 2003
2834 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
2837 * \var lyx::FuncCode lyx::LFUN_MOUSE_PRESS
2838 * \li Action: This function is called when mouse button is pressed (inside workarea).
2839 Action depends on the context.
2840 * \li Notion: This is an internal LFUN, not to be used by users.
2841 * \li Origin: Andre, 9 Aug 2002
2844 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
2846 * \var lyx::FuncCode lyx::LFUN_MOUSE_DOUBLE
2847 * \li Action: This function is called when double click on mouse button is
2848 pressed (inside workarea). Action depends on the context.
2849 * \li Notion: This is an internal LFUN, not to be used by users.
2850 * \li Origin: Andre, 9 Aug 2002
2853 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
2855 * \var lyx::FuncCode lyx::LFUN_MOUSE_TRIPLE
2856 * \li Action: This function is called when triple click on mouse button is
2857 pressed (inside workarea). Action depends on the context.
2858 * \li Notion: This is an internal LFUN, not to be used by users.
2859 * \li Origin: Andre, 9 Aug 2002
2862 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
2864 * \var lyx::FuncCode lyx::LFUN_MOUSE_MOTION
2865 * \li Action: This function is called when mouse cursor is moving over the text.
2866 Action depends on the context.
2867 * \li Notion: This is an internal LFUN, not to be used by users.
2868 * \li Origin: Andre, 9 Aug 2002
2871 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
2873 * \var lyx::FuncCode lyx::LFUN_MOUSE_RELEASE
2874 * \li Action: This function is called when mouse button is released (inside workarea).
2875 Action depends on the context.
2876 * \li Notion: This is an internal LFUN, not to be used by users.
2877 * \li Origin: Andre, 9 Aug 2002
2880 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
2883 * \var lyx::FuncCode lyx::LFUN_KEYMAP_OFF
2884 * \li Action: Turn off the loaded keyboard map.
2885 * \li Syntax: keymap-off
2888 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
2890 * \var lyx::FuncCode lyx::LFUN_KEYMAP_PRIMARY
2891 * \li Action: Turn on the primary keyboard map.
2892 * \li Notion: Maps were widely used in past, when X-windows didn't have nowadays
2893 keyboard support. They can be still used to maintain uniform keyboard
2894 layout across the various platforms.\n
2895 The language is to be set in the Preferences dialog.
2896 * \li Syntax: keymap-primary
2899 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
2901 * \var lyx::FuncCode lyx::LFUN_KEYMAP_SECONDARY
2902 * \li Action: Turn on the secondary keyboard map.
2903 * \li Syntax: keymap-secondary
2906 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
2908 * \var lyx::FuncCode lyx::LFUN_KEYMAP_TOGGLE
2909 * \li Action: Toggles keyboard maps (first/second/off).
2910 * \li Syntax: keymap-toggle
2911 * \li Origin: leeming, 30 Mar 2004
2914 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
2917 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_LAYOUT
2918 * \li Action: Returns the current layout (that is environment) name
2919 on the cursor position.
2920 * \li Syntax: server-get-layout
2923 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
2925 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_FILENAME
2926 * \li Action: Returns path and file name of the currently edited document.
2927 * \li Syntax: server-get-filename
2930 { LFUN_SERVER_GET_FILENAME, "server-get-filename", ReadOnly, System },
2932 * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
2933 * \li Action: Sets the cursor position in LyX based on the row number of generated TeX file.
2934 * \li Notion: This can be useful for DVI inverse-search or detection of the problematic
2935 line from LaTeX compilation. Note that before this function can be used
2936 export to LaTeX output must occur (in order to map the row numbers).
2937 * \li Syntax: server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
2938 * \li Params: <FILE>: the path and filename. Environment variables are expanded in the path.
2939 In case this LFUN does not work make sure you are giving correct
2941 If the file is located inside LyX temporary directory it will be
2942 mapped back into the appropriate opened buffer (e.g. for the case
2943 of generated .tex file).\n
2944 .ext: extensions will be automatically replaced by .lyx.\n
2945 <ROW_NUMBER> The row number of the LaTeX file to which to go.
2946 * \li Sample: server-goto-file-row /home/user/example.lyx 41\n
2947 server-goto-file-row /tmp/lyx_tmpdir.XM3088/lyx_tmpbuf0/example.tex 41
2948 * \li Origin: Edmar, 23 Dec 1998
2951 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly | NoBuffer, System },
2953 * \var lyx::FuncCode lyx::LFUN_FORWARD_SEARCH
2954 * \li Action: Sets the cursor position in the previewed (dvi/pdf) file based on the row
2955 number in LyX window.
2956 * \li Notion: The external program used for forward search call can be specified in
2957 LyX Output preferences. See Additional manual for details of these
2959 * \li Syntax: forward-search
2960 * \li Origin: sanda, 14 Apr 2010
2963 { LFUN_FORWARD_SEARCH, "forward-search", ReadOnly, System },
2965 * \var lyx::FuncCode lyx::LFUN_SERVER_NOTIFY
2966 * \li Action: Sends notify message about the last key-sequence to client.
2967 * \li Notion: This can be used to grab last key-sequence used inside the LyX window.
2968 See also Debug extensions section in Additional features manual.
2969 * \li Syntax: server-notify
2972 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
2974 * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
2975 * \li Action: Sets the cursor position based on the editing area coordinates
2976 (similar to clicking on that point with left mouse button).
2977 * \li Syntax: server-set-xy <X> <Y>
2980 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
2982 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
2983 * \li Action: Returns the coordinates of cursor position in the editing area.
2984 * \li Syntax: server-get-xy
2987 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
2990 * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
2991 * \li Action: Generates the code (literate programming).
2992 * \li Notion: Latex file with extension \literate_extension is generated.
2993 Then LyX invokes \build_command (with a default of ``make'') to generate the code and
2994 \build_error_filter to process the compilation error messages. \n
2995 In case you want to process your literate file with a script, or some other program,
2996 just insert in your lyxrc file an entry with:\n
2997 \build_command "my_script my_arguments" \n
2998 The \build_error_filter differs from the \literate_error_filter only in that the
2999 former will identify error messages from your compiler.
3000 * \li Syntax: build-program
3003 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
3006 * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
3007 * \li Action: Saves the current buffer to a temporary file.
3008 * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
3009 is called automatically by LyX, to "autosave" the current buffer.
3010 * \li Syntax: buffer-auto-save
3013 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
3015 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHILD_OPEN
3016 * \li Action: Loads the given child document.
3017 * \li Notion: The current document is treated as a parent.
3018 * \li Syntax: buffer-child-open <FILE>
3019 * \li Params: <FILE>: Filename of the child. The directory of the parent is assumed by default.
3020 * \li Origin: Ale, 28 May 1997
3023 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
3025 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHKTEX
3026 * \li Action: Runs chktex for the current document.
3027 * \li Syntax: buffer-chktex
3028 * \li Origin: Asger, 30 Oct 1997
3031 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
3033 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
3034 * \li Action: Toggles compression of the current document on/off.
3035 * \li Syntax: buffer-toggle-compression
3036 * \li Origin: bpeng, 27 Apr 2006
3039 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
3041 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_OUTPUT_SYNC
3042 * \li Action: Toggles including of resources for forward/reverse search of the given document.
3043 * \li Notion: When toggled on, SyncTeX is invoked for PDF, while srcltx package
3044 is used for DVI. Custom LaTeX macro can be defined in preferences.
3045 * \li Syntax: buffer-toggle-output-sync
3046 * \li Origin: sanda, 25 May 2010
3049 { LFUN_BUFFER_TOGGLE_OUTPUT_SYNC, "buffer-toggle-output-sync", Noop, System },
3051 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
3052 * \li Action: Closes the current buffer.
3053 * \li Notion: Closes the current buffer, asking whether to save it, etc,
3054 if the buffer has been modified.
3055 * \li Syntax: buffer-close
3058 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
3060 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE_ALL
3061 * \li Action: Closes all buffers.
3062 * \li Notion: Closes all buffers, asking whether to save it, etc,
3063 if a buffer has been modified.
3064 * \li Syntax: buffer-close-all
3067 { LFUN_BUFFER_CLOSE_ALL, "buffer-close-all", ReadOnly, Buffer },
3069 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
3070 * \li Action: Exports the current buffer (document) to the given format.
3071 * \li Syntax: buffer-export <FORMAT> [<DEST>]
3072 * \li Params: <FORMAT> is either "custom" or one of the formats which you
3073 can find in Tools->Preferences->File formats->Format.
3074 Usual format you will enter is "pdf2" (pdflatex),
3075 "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
3076 In case of "custom" you will be asked for a format you
3077 want to start from and for the command that you want to
3078 apply to this format. Internally the control is then passed
3079 to #LFUN_BUFFER_EXPORT_CUSTOM.
3080 <DEST> If present, this argument provides the export destination
3081 filename. Its containing folder will also be the destination
3082 folder, where all the needed external files will be copied.
3083 * \li Origin: Lgb, 29 Jul 1997
3086 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
3088 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
3089 * \li Action: Exports the current buffer (document) from the given format using
3090 the given command on it.
3091 * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
3092 * \li Params: <FORMAT> format to start from (LyX will care to produce such
3093 intermediate file).\n
3094 <COMMAND> this command will be launched on the file. Note that you can
3095 use "$$FName" string to qualify the intermediate file.
3096 * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
3097 * \li Origin: leeming, 27 Mar 2004
3100 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
3102 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_AS
3103 * \li Action: Opens a dialog for exporting the current buffer.
3104 * \li Syntax: buffer-export-as [<FORMAT>]
3105 * \li Params: <FORMAT> is the export format initially selected in the dialog.
3106 * You can pass any of the formats which you can find in
3107 * Tools->Preferences->File formats->Format, provided it
3108 * has the "document" flag set. If no format is specified
3109 * the dialog will start with the default output format of
3110 * the current document.
3111 * \li Sample: buffer-export-as pdf2
3112 * \li Origin: tommaso, 6 Oct 2011
3115 { LFUN_BUFFER_EXPORT_AS, "buffer-export-as", ReadOnly, Buffer },
3117 * \var lyx::FuncCode lyx::LFUN_BUFFER_PRINT
3118 * \li Action: Prints the current document.
3119 * \li Notion: Many settings can be given via the preferences dialog.
3120 * \li Syntax: buffer-print <TARGET> <TARGET-NAME> <COMMAND>
3121 * \li Params: <TARGET> is either "printer" or "file".\n
3122 <TARGER-NAME> is either "default" or file name or printer name.\n
3123 <COMMAND> command ensuring the printing job.
3124 * \li Sample: buffer-print file "/trash/newfile1.ps" "dvips"
3125 * \li Origin: leeming, 28 Mar 2004
3128 { LFUN_BUFFER_PRINT, "buffer-print", ReadOnly, Buffer },
3130 * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
3131 * \li Action: Import a given file as a lyx document.
3132 * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
3133 defined converters in preferences. Look in the File->Import menu to get
3134 an idea of the currently active import formats.
3135 * \li Syntax: buffer-import <FORMAT> [<FILE>]
3136 * \li Origin: Asger, 24 Jul 1998
3139 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
3141 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
3142 * \li Action: Creates a new buffer (that is, document) and switches to it.
3143 * \li Notion: Implicit path can be set in Preferences dialog.
3144 * \li Syntax: buffer-new [<FILE>]
3145 * \li Params: <FILE>: filename of created file with absolute path.
3148 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
3150 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
3151 * \li Action: Creates a new buffer (that is, document) from a template.
3152 * \li Notion: Path for new files and templates can be set in Preferences dialog.
3153 Template will be asked for via Open-dialog.
3154 * \li Syntax: buffer-new-template [<FILE>]
3155 * \li Params: <FILE>: filename of created file with absolute path.
3158 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
3160 * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
3161 * \li Action: Reverts opened document.
3162 * \li Syntax: buffer-reload
3163 * \li Origin: Asger, 2 Feb 1997
3166 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
3168 * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
3169 * \li Action: Display and switch to the given buffer.
3170 * \li Syntax: buffer-switch <BUFFER>
3171 * \li Params: <BUFFER>: path and filename of already opened (but possibly hidden)
3172 document which is to be shown.
3175 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
3177 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
3178 * \li Action: Toggle editing mode of the current document between read/write and read-only.
3179 * \li Notion: This function is not allowed if the file is under version control, since
3180 read-only flag is often used in version control file locking.
3181 * \li Syntax: buffer-toggle-read-only
3182 * \li Origin: Lgb, 27 May 1997
3185 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
3187 * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
3188 * \li Action: Displays current buffer in chosen format.
3189 * \li Notion: Displays the contents of the current buffer in the chosen
3190 format, for example, PDF or DVI. This runs the necessary
3191 converter, calls the defined viewer, and so forth.
3192 * \li Syntax: buffer-view [<FORMAT>]
3193 * \li Params: <FORMAT>: The format to display, where this is one of the
3194 formats defined (in the current GUI) in the
3195 Tools>Preferences>File Formats dialog.
3196 If no format is given, the default format as
3197 specified in the same dialog is used.
3200 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
3202 * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
3203 * \li Action: Exports the current document and put the result into the
3204 temporary directory.
3205 * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
3206 the output will be rewritten - updated. This is useful in case your viewer
3207 is able to detect such changes (e.g. ghostview for postscript).
3208 * \li Syntax: buffer-update [<FORMAT>]
3209 * \li Params: <FORMAT>: The format to display, where this is one of the
3210 formats defined (in the current GUI) in the
3211 Tools>Preferences>File Formats dialog.
3212 If no format is given, the default format as
3213 specified in the same dialog is used.
3214 * \li Origin: Dekel, 5 Aug 2000
3217 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
3220 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
3221 * \li Action: Saves the current buffer.
3222 * \li Notion: Saves the current buffer to disk, using the filename that
3223 is already associated with the buffer, asking for one if
3224 none is yet assigned.
3225 * \li Syntax: buffer-write
3228 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
3230 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
3231 * \li Action: Rename and save current buffer.
3232 * \li Syntax: buffer-write-as <FILENAME>
3233 * \li Params: <FILENAME>: New name of the buffer/file. A relative path
3234 is with respect to the original location of the buffer/file.
3237 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
3239 * \var lyx::FuncCode lyx::LFUN_BUFFER_FORALL
3240 * \li Action: Applies a command to all non-hidden buffers.
3241 * \li Notion: a buffer is `hidden' if it is internally open in LyX, but not
3242 visible in any window.
3243 * \li Syntax: buffer-forall <LFUN-COMMAND>
3244 * \li Params: <LFUN-COMMAND>: The command to be applied to the buffers.
3245 * \li Sample: Close all Notes in buffers: \n
3246 buffer-forall inset-forall Note inset-toggle close \n
3247 Toggle change tracking on buffers: \n
3248 buffer-forall changes-track \n
3249 Toggle read-only for buffers: \n
3250 buffer-forall buffer-toggle-read-only \n
3251 Show statistics for individual buffers: \n
3252 buffer-forall statistics \n
3253 Activate the branch named "Solutions" in buffers: \n
3254 buffer-forall branch-activate Solutions \n
3255 Export buffers to PDF (pdflatex): \n
3256 buffer-forall buffer-export pdf2 \n
3257 * \li Origin: scottkostyshak, 20 Jul 2012
3260 { LFUN_BUFFER_FORALL, "buffer-forall", ReadOnly | Argument, Buffer },
3262 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
3263 * \li Action: Save all changed documents.
3264 * \li Syntax: buffer-write-all
3265 * \li Origin: rgh, gpothier 6 Aug 2007
3268 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
3270 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEXT
3271 * \li Action: Switch to the next opened document.
3272 * \li Notion: Note that this does not necessarily mean next in tabbar
3273 (for full list see View menu).
3274 * \li Syntax: buffer-next
3277 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
3279 * \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS
3280 * \li Action: Switch to the previous opened document.
3281 * \li Syntax: buffer-previous
3284 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
3286 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
3287 * \li Action: Update (export) the document built from the master buffer,
3288 if the current buffer is part of a master/child document.
3289 * \li Syntax: master-buffer-update [<FORMAT>]
3290 * \li Params: <FORMAT>: The format to display, where this is one of the
3291 formats defined (in the current GUI) in the
3292 Tools>Preferences>File Formats dialog.
3293 If no format is given, the default format as
3294 specified in the same dialog is used.
3295 * \li Origin: Tommaso, 20 Sep 2007
3298 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
3300 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
3301 * \li Action: Show a preview built from the master buffer, if available.
3302 if the current buffer is part of a master/child document.
3303 * \li Syntax: master-buffer-view [<FORMAT>]
3304 * \li Params: <FORMAT>: The format to display, where this is one of the
3305 formats defined (in the current GUI) in the
3306 Tools>Preferences>File Formats dialog.
3307 If no format is given, the default format as
3308 specified in the same dialog is used.
3309 * \li Origin: Tommaso, 20 Sep 2007
3312 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
3314 * \var lyx::FuncCode lyx::LFUN_BUFFER_LANGUAGE
3315 * \li Action: Set language of the current document.
3316 * \li Syntax: buffer-language <LANG>
3317 * \li Params: <LANG>: language name. See lib/languages for list.
3318 * \li Origin: leeming, 30 Mar 2004
3321 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
3323 * \var lyx::FuncCode lyx::LFUN_BUFFER_SAVE_AS_DEFAULT
3324 * \li Action: Save the current document settings as default.
3325 * \li Notion: The file will will be saved into ~/.lyx/templates/defaults.lyx .
3326 * \li Syntax: buffer-save-as-default [<ARGS>]
3327 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
3328 you can find in document header of usual .lyx file.
3329 * \li Origin: leeming, 30 Mar 2004
3332 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
3334 * \var lyx::FuncCode lyx::LFUN_BUFFER_PARAMS_APPLY
3335 * \li Action: Apply the given settings to the current document.
3336 * \li Syntax: buffer-params-apply [<ARGS>]
3337 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
3338 you can find in document header of usual .lyx file.
3339 * \li Origin: leeming, 30 Mar 2004
3342 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", NoInternal, Buffer },
3345 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
3346 * \li Action: Inserts another LyX file.
3347 * \li Syntax: file-insert [<FILE>]
3348 * \li Params: <FILE>: Filename to be inserted.
3351 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
3353 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
3354 * \li Action: Inserts plain text file.
3355 * \li Syntax: file-insert-plaintext [<FILE>]
3356 * \li Params: <FILE>: Filename to be inserted.
3357 * \li Origin: CFO-G, 19 Nov 1997
3360 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
3362 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
3363 * \li Action: Inserts plain text file as paragraph (i.e. join lines).
3364 * \li Syntax: file-insert-plaintext-para [<FILE>]
3365 * \li Params: <FILE>: Filename to be inserted.
3366 * \li Origin: Levon, 14 Feb 2001
3369 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
3371 * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
3372 * \li Action: Open LyX document.
3373 * \li Syntax: file-open [<FILE>]
3374 * \li Params: <FILE>: Filename to be opened.
3377 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
3380 * \var lyx::FuncCode lyx::LFUN_CALL
3381 * \li Action: Executes a command defined in a .def file.
3382 * \li Notion: The definitions are by default read from lib/commands/default.def.\n
3383 A .def file allows to define a command with \define "<NAME>" "<LFUN>"
3384 where <NAME> is the name of the new command and <LFUN> is the lfun code
3385 to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
3386 \def_file "FileName" allows to include another .def file. \n
3387 This is particularly useful in connection with toolbar buttons:
3388 Since the name of the button image for this lfun is
3389 lib/images/commands/<NAME>.png this is the way to assign an image
3390 to a complex command-sequence.
3391 * \li Syntax: call <NAME>
3392 * \li Params: <NAME>: Name of the command that must be called.
3393 * \li Origin: broider, 2 Oct 2007
3396 { LFUN_CALL, "call", NoBuffer, System },
3398 * \var lyx::FuncCode lyx::LFUN_META_PREFIX
3399 * \li Action: Simulate halting Meta key (Alt key on PCs).
3400 * \li Notion: Used for buffer edition not for GUI control.
3401 * \li Syntax: meta-prefix
3404 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
3406 * \var lyx::FuncCode lyx::LFUN_CANCEL
3407 * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
3408 * \li Syntax: cancel
3411 { LFUN_CANCEL, "cancel", NoBuffer, System },
3414 * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
3415 * \li Action: Switches the focus to the minibuffer so that the user can type
3416 in there. If necessary, it opens the minibuffer toolbar.
3417 * \li Notion: Usually bound to M-x shortcut.
3418 * \li Syntax: command-execute
3421 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
3424 * \var lyx::FuncCode lyx::LFUN_COMMAND_PREFIX
3425 * \li Action: Return the current key sequence and available options as a string.
3426 * \li Notion: No options are added if no current map exists. \n
3427 This is probably usable only with connection to lyxserver.
3428 * \li Syntax: command-prefix
3431 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
3433 * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
3434 * \li Action: Run more commands (LFUN and its parameters) in a sequence.
3435 * \li Syntax: command-sequence <CMDS>
3436 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
3437 * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
3438 * \li Origin: Andre, 11 Nov 1999
3441 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
3443 * \var lyx::FuncCode lyx::LFUN_COMMAND_ALTERNATIVES
3444 * \li Action: Runs the first listed command that is enabled.
3445 * \li Notion: This can be used to bind multiple functions to a single key,
3446 and then which one is used will depend upon the context.
3447 * \li Syntax: command-alternatives <CMDS>
3448 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
3449 * \li Sample: command-alternatives completion-accept;cell-forward
3450 * \li Origin: rgh, 24 September 2008
3453 { LFUN_COMMAND_ALTERNATIVES, "command-alternatives", NoBuffer, System },
3455 * \var lyx::FuncCode lyx::LFUN_MESSAGE
3456 * \li Action: Shows message in statusbar (for script purposes).
3457 * \li Syntax: message <STRING>
3458 * \li Origin: Lgb, 8 Apr 2001
3461 { LFUN_MESSAGE, "message", NoBuffer, System },
3463 * \var lyx::FuncCode lyx::LFUN_DEBUG_LEVEL_SET
3464 * \li Action: Set debug output level.
3465 * \li Syntax: debug-level-set <LEVEL>
3466 * \li Params: <LEVEL>: comma separated list of levels or the correspondent number
3467 of their combination. 0 is equivalent to disabling all debug
3468 events. See lyx -dbg for the current list of debug levels
3470 * \li Origin: sanda, 28 Dec 2009
3473 { LFUN_DEBUG_LEVEL_SET, "debug-level-set", NoBuffer, System },
3476 * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
3477 * \li Action: Save user preferences.
3478 * \li Syntax: preferences-save
3479 * \li Origin: Lgb, 27 Nov 1999
3482 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
3484 * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
3485 * \li Action: Reconfigure the automatic settings.
3486 * \li Syntax: reconfigure
3487 * \li Origin: Asger, 14 Feb 1997
3490 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
3492 * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
3493 * \li Action: Apply the given settings to user preferences.
3494 * \li Syntax: lyxrc-apply <SETTINGS>
3495 * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
3496 to get an idea which commands to use and their syntax.
3497 #lyx::LyXRC::LyXRCTags has the list of possible commands.
3500 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
3502 * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
3503 * \li Action: Determine whether to keep cursor inside the editing window regardless
3504 of the scrollbar movement.
3505 * \li Syntax: toggle-cursor-follows-scrollbar
3506 * \li Origin: ARRae, 2 Dec 1997
3509 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
3511 * \var lyx::FuncCode lyx::LFUN_SET_COLOR
3512 * \li Action: Set the given LyX color to the color defined by the X11 name given.
3513 * \li Notion: A new color entry is created if the color is unknown.
3514 Color names can be stored as a part of user settings.
3515 * \li Syntax: set-color <LYX_NAME> <X11_NAME>
3516 * \li Origin: SLior, 11 Jun 2000
3519 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
3521 * \var lyx::FuncCode lyx::LFUN_STATISTICS
3522 * \li Action: Count the statistics (number of words and characters)
3523 in the document or in the given selection and display it
3525 * \li Notion: Note that this function gives the number of words/chars written,
3526 not the number of characters which will be typeset.
3527 * \li Syntax: statistics
3528 * \li Origin: lasgouttes, Jan 27 2004; sanda, Jan 8 2008
3531 { LFUN_STATISTICS, "statistics", ReadOnly, System },
3533 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_STATISTICS
3534 * \li Action: Returns the statistics (number of words and characters)
3535 in the document or in the given selection.
3536 * \li Notion: Note that this function gives the number of words/chars written,
3537 not the number of characters which will be typeset.
3538 * \li Syntax: server-get-statistics [<TYPE>]
3539 * \li Params: <TYPE>: <words|chars|chars-space> The requested count; if not
3540 specified, the three values are returned, separated
3542 words: count words.\n
3543 chars: count characters.\n
3544 chars-space: count characters and spaces.
3545 * \li Origin: brokenclock, Oct 10 2014
3548 { LFUN_SERVER_GET_STATISTICS, "server-get-statistics", ReadOnly, System },
3550 * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
3551 * \li Action: Show the inline completion at the cursor position.
3552 * \li Syntax: completion-inline
3553 * \li Origin: sts, Feb 19 2008
3556 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
3558 * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
3559 * \li Action: Show the completion popup at the cursor position.
3560 * \li Syntax: completion-popup
3561 * \li Origin: sts, Feb 19 2008
3564 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
3566 * \var lyx::FuncCode lyx::LFUN_COMPLETE
3567 * \li Action: Try to complete the word or command at the cursor position.
3568 * \li Syntax: complete
3569 * \li Origin: sts, Feb 19 2008
3572 { LFUN_COMPLETE, "complete", SingleParUpdate, Edit },
3575 * \var lyx::FuncCode lyx::LFUN_COMPLETION_CANCEL
3576 * \li Action: Try to cancel completion, either the popup or the inline completion.
3577 * \li Syntax: completion-cancel
3578 * \li Origin: sts, Sep 07 2008
3581 { LFUN_COMPLETION_CANCEL, "completion-cancel", SingleParUpdate, Edit },
3583 * \var lyx::FuncCode lyx::LFUN_COMPLETION_ACCEPT
3584 * \li Action: Accept suggested completion.
3585 * \li Syntax: completion-accept
3586 * \li Origin: sanda, Sep 08 2008
3589 { LFUN_COMPLETION_ACCEPT, "completion-accept", SingleParUpdate, Edit },
3593 * \var lyx::FuncCode lyx::LFUN_BRANCH_ADD
3594 * \li Action: Add a branch to the buffer's BranchList.
3595 * \li Syntax: branch-add <BRANCH>
3596 * \li Params: <BRANCH>: Name of the branch to add
3597 * \li Origin: spitz, 7 Jul 2009
3600 { LFUN_BRANCH_ADD, "branch-add", AtPoint, Buffer },
3604 * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
3605 * \li Action: Activate the branch.
3606 * \li Syntax: branch-activate <BRANCH>
3607 * \li Params: <BRANCH>: The branch to activate
3608 * \li Sample: lyx -x "branch-activate answers" -e pdf2 finalexam.lyx \n
3609 could be used to export a pdf with the answers branch included
3610 without one's having to open LyX and activate the branch manually.
3611 * \li Origin: rgh, 27 May 2008
3614 { LFUN_BRANCH_ACTIVATE, "branch-activate", AtPoint, Buffer },
3616 * \var lyx::FuncCode lyx::LFUN_BRANCH_DEACTIVATE
3617 * \li Action: De-activate the branch.
3618 * \li Syntax: branch-deactivate <BRANCH>
3619 * \li Params: <BRANCH>: The branch to deactivate
3620 * \li Origin: rgh, 27 May 2008
3623 { LFUN_BRANCH_DEACTIVATE, "branch-deactivate", AtPoint, Buffer },
3625 * \var lyx::FuncCode lyx::LFUN_BRANCH_MASTER_ACTIVATE
3626 * \li Action: Activate the branch in the master buffer.
3627 * \li Syntax: branch-master-activate <BRANCH>
3628 * \li Params: <BRANCH>: The branch to activate
3629 * \li Sample: lyx -x "branch-activate answers" -e pdf2 finalexam.lyx \n
3630 could be used to export a pdf with the answers branch included
3631 without one's having to open LyX and activate the branch manually.
3632 * \li Origin: spitz, 30 Sep 2012
3635 { LFUN_BRANCH_MASTER_ACTIVATE, "branch-master-activate", AtPoint, Buffer },
3637 * \var lyx::FuncCode lyx::LFUN_BRANCH_MASTER_DEACTIVATE
3638 * \li Action: De-activate the branch in the master buffer.
3639 * \li Syntax: branch-master-deactivate <BRANCH>
3640 * \li Params: <BRANCH>: The branch to deactivate
3641 * \li Origin: spitz, 30 Sep 2012
3644 { LFUN_BRANCH_MASTER_DEACTIVATE, "branch-master-deactivate", AtPoint, Buffer },
3647 * \var lyx::FuncCode lyx::LFUN_BRANCHES_RENAME
3648 * \li Action: Rename all branches of a given name in a document.
3649 * \li Syntax: branches-rename <OLDNAME> <NEWNAME>
3650 * \li Params: <OLDNAME>: Current name of the branch to be renamed
3651 * <NEWNAME>: New name of the branch
3652 * \li Origin: spitz, 9 Jul 2009
3655 { LFUN_BRANCHES_RENAME, "branches-rename", Noop, Buffer },
3657 * \var lyx::FuncCode lyx::LFUN_BRANCH_ADD_INSERT
3658 * \li Action: Create new branch and directly put the branch inset into
3660 * \li Syntax: branch-add-insert [<NAME>]
3661 * \li Params: <NAME>: Branch name. If it is not specified, you will be asked.
3662 * \li Origin: sanda, 10 Jul 2009
3665 { LFUN_BRANCH_ADD_INSERT, "branch-add-insert", Noop, Buffer },
3669 * \var lyx::FuncCode lyx::LFUN_LABEL_COPY_AS_REF
3670 * \li Action: Copies the label at the cursor as a cross-reference to be pasted elsewhere.
3671 * \li Syntax: copy-label-as-reference <LABEL>
3672 * \li Params: <LABEL>: The label to copy (for multi-line math)
3673 * \li Origin: sts, 16 Nov 2008
3676 { LFUN_LABEL_COPY_AS_REFERENCE, "label-copy-as-reference",
3677 ReadOnly | NoUpdate | AtPoint, Edit },
3680 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT_AS_REFERENCE
3681 * \li Action: Inserts the label (in ToC pane) as a cross-reference at the position of the cursor.
3682 * \li Syntax: label-insert-as-reference
3683 * \li Origin: vfr, 7 Apr 2009
3686 { LFUN_LABEL_INSERT_AS_REFERENCE, "label-insert-as-reference", Noop, Edit},
3689 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_IN
3690 * \li Action: Increases the zoom of the screen fonts.
3691 * \li Syntax: buffer-zoom-in [<ZOOM>]
3692 * \li Params: <ZOOM>: The zoom in %, the default is 20.
3693 * \li Origin: vfr, 30 Mar 2009
3696 { LFUN_BUFFER_ZOOM_IN, "buffer-zoom-in", ReadOnly, Buffer },
3699 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_OUT
3700 * \li Action: Decreases the zoom of the screen fonts.
3701 * \li Syntax: buffer-zoom-out [<ZOOM>]
3702 * \li Params: <ZOOM>: The zoom in %, the default is 20.
3703 * \li Origin: vfr, 30 Mar 2009
3706 { LFUN_BUFFER_ZOOM_OUT, "buffer-zoom-out", ReadOnly, Buffer },
3709 * \var lyx::FuncCode lyx::LFUN_INSET_COPY_AS
3710 * \li Action: Copies the inset to the clipboard as a certain type.
3711 * \li Notion: Currently used only for InsetInfo where its content is copied as a text.
3712 * \li Syntax: inset-copy-as
3713 * \li Origin: vfr, 18 Apr 2010
3716 { LFUN_INSET_COPY_AS, "inset-copy-as", ReadOnly | NoUpdate | AtPoint, Edit },
3719 * \var lyx::FuncCode lyx::LFUN_ENVIRONMENT_SPLIT
3720 * \li Action: Splits the current environment with a Separator.
3721 * \li Syntax: environment-split [outer]
3722 * \li Params: outer: If this is given, LyX will split the outermost environment in
3723 * the current nesting hierarchy.
3724 * \li Origin: spitz, 23 Dec 2012
3727 { LFUN_ENVIRONMENT_SPLIT, "environment-split", Noop, Layout },
3729 { LFUN_NOACTION, "", Noop, Hidden }
3730 #ifndef DOXYGEN_SHOULD_SKIP_THIS
3733 for (int i = 0; items[i].action != LFUN_NOACTION; ++i)
3734 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
3740 LyXAction::LyXAction()
3746 FuncRequest LyXAction::lookupFunc(string const & func) const
3748 string const func2 = trim(func);
3751 return FuncRequest(LFUN_NOACTION);
3754 string const arg = split(func2, cmd, ' ');
3756 FuncMap::const_iterator const fit = lyx_func_map.find(cmd);
3758 return fit != lyx_func_map.end()
3759 ? FuncRequest(fit->second, arg)
3760 : FuncRequest(LFUN_UNKNOWN_ACTION);
3764 string const LyXAction::getActionName(FuncCode action) const
3766 InfoMap::const_iterator const it = lyx_info_map.find(action);
3767 return it != lyx_info_map.end() ? it->second.name : string();
3771 LyXAction::FuncType LyXAction::getActionType(FuncCode action) const
3773 InfoMap::const_iterator const it = lyx_info_map.find(action);
3774 return it != lyx_info_map.end() ? it->second.type : Hidden;
3778 bool LyXAction::funcHasFlag(FuncCode action,
3779 LyXAction::FuncAttribs flag) const
3781 InfoMap::const_iterator ici = lyx_info_map.find(action);
3783 if (ici == lyx_info_map.end()) {
3784 LYXERR0("action: " << action << " is not known.");
3785 LASSERT(false, return false);
3788 return ici->second.attrib & flag;
3792 LyXAction::const_iterator LyXAction::func_begin() const
3794 return lyx_func_map.begin();
3798 LyXAction::const_iterator LyXAction::func_end() const
3800 return lyx_func_map.end();
3804 LyXErr & operator<<(LyXErr & l, FuncCode code)
3807 l.stream() << lyxaction.getActionName(code);