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 or direct icon name\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 * The default for the language is retrieved from the cursor position.
1029 * \li Syntax: spelling-add [<STRING>] [<LANG>]
1030 * \li Params: <WORD>: word to add
1031 <LANG>: language name (see file languages)
1032 * \li Origin: JSpitzm, 18 Jan 2010
1035 { LFUN_SPELLING_ADD, "spelling-add", ReadOnly, Edit },
1037 * \var lyx::FuncCode lyx::LFUN_SPELLING_IGNORE
1038 * \li Action: Let the spell checker ignore the word under the cursor
1039 * in the current session for the given language.
1040 * The default for the language is retrieved from the cursor position.
1041 * \li Syntax: spelling-ignore [<WORD>] [<LANG>]
1042 * \li Params: <WORD>: word to ignore
1043 <LANG>: language name (see file languages)
1044 * \li Origin: JSpitzm, 18 Jan 2010
1047 { LFUN_SPELLING_IGNORE, "spelling-ignore", ReadOnly, Edit },
1049 * \var lyx::FuncCode lyx::LFUN_SPELLING_REMOVE
1050 * \li Action: Remove the word under the cursor from the respective
1051 * spell checker dictionary.
1052 * The default for the language is retrieved from the cursor position.
1053 * \li Syntax: spelling-remove [<STRING>] [<LANG>]
1054 * \li Params: <WORD>: word to remove
1055 * <LANG>: language name (see file languages)
1056 * \li Origin: SWitt, 28 July 2010
1059 { LFUN_SPELLING_REMOVE, "spelling-remove", ReadOnly, Edit },
1062 * \var lyx::FuncCode lyx::LFUN_SPELLING_CONTINUOUSLY
1063 * \li Action: Toggle continuous spell checking.
1064 * \li Syntax: spelling-continuously
1065 * \li Origin: vfr, 24 March 2013
1068 { LFUN_SPELLING_CONTINUOUSLY, "spelling-continuously", ReadOnly, Edit },
1071 * \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
1072 * \li Action: Look up thesaurus entries with respect to the word under the cursor.
1073 * \li Syntax: thesaurus-entry [<STRING>] [lang=<LANG>]
1074 * \li Params: <STRING>: word to look up
1075 <LANG>: language (see file languages)
1076 * \li Origin: Levon, 20 Jul 2001
1079 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
1081 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN
1082 * \li Action: Move the cursor to the beginning of the document.
1083 * \li Syntax: buffer-begin
1086 { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
1088 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN_SELECT
1089 * \li Action: Move the cursor to the beginning of the document adding the
1090 traversed text to the selection.
1091 * \li Syntax: buffer-begin-select
1094 { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
1096 * \var lyx::FuncCode lyx::LFUN_BUFFER_END
1097 * \li Action: Move the cursor to the end of the document.
1098 * \li Syntax: buffer-end
1101 { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
1103 * \var lyx::FuncCode lyx::LFUN_BUFFER_END_SELECT
1104 * \li Action: Move the cursor to the end of the document adding the
1105 traversed text to the selection.
1106 * \li Syntax: buffer-end-select
1109 { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
1112 * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN
1113 * \li Action: Move the cursor to the beginning of the current inset
1114 if it is not already there, or at the beginning of the
1115 enclosing inset otherwise
1116 * \li Syntax: inset-begin
1117 * \li Origin: lasgouttes, 16 Mar 2009
1120 { LFUN_INSET_BEGIN, "inset-begin", ReadOnly, Edit },
1122 * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN_SELECT
1123 * \li Action: Move the cursor to the beginning of the current inset
1124 if it is not already there, or at the beginning of the
1125 enclosing inset otherwise (adding the
1126 traversed text to the selection).
1127 * \li Syntax: inset-begin-select
1128 * \li Origin: lasgouttes, 16 Mar 2009
1131 { LFUN_INSET_BEGIN_SELECT, "inset-begin-select", ReadOnly, Edit },
1133 * \var lyx::FuncCode lyx::LFUN_INSET_END
1134 * \li Action: Move the cursor to the end of the current inset
1135 if it is not already there, or at the end of the
1136 enclosing inset otherwise
1137 * \li Syntax: inset-end
1138 * \li Origin: lasgouttes, 16 Mar 2009
1141 { LFUN_INSET_END, "inset-end", ReadOnly, Edit },
1143 * \var lyx::FuncCode lyx::LFUN_INSET_END_SELECT
1144 * \li Action: Move the cursor to the end of the current inset
1145 if it is not already there, or at the end of the
1146 enclosing inset otherwise (adding the
1147 traversed text to the selection).
1148 * \li Syntax: inset-end-select
1149 * \li Origin: lasgouttes, 16 Mar 2009
1152 { LFUN_INSET_END_SELECT, "inset-end-select", ReadOnly, Edit },
1155 * \var lyx::FuncCode lyx::LFUN_INSET_SELECT_ALL
1156 * \li Action: Select all contents of an inset.
1157 * \li Notion: There are 3 successive levels: select current cell,
1158 * select all cells of inset, select the inset from outside
1159 * (in the enclosing inset).
1160 * \li Syntax: inset-select-all
1161 * \li Origin: vfr, 22 Aug 2009; lasgouttes 1 Nov 2014
1164 { LFUN_INSET_SELECT_ALL, "inset-select-all", ReadOnly, Edit },
1167 * \var lyx::FuncCode lyx::LFUN_SECTION_SELECT
1168 * \li Action: Select the whole section.
1169 * \li Notion: The cursor should be in a section heading
1170 before calling this lfun.
1171 * \li Syntax: section-select
1172 * \li Origin: vfr, 05 May 2009
1175 { LFUN_SECTION_SELECT, "section-select", ReadOnly, Edit },
1178 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN
1179 * \li Action: Move the cursor to the beginning of the (screen) line.
1180 * \li Syntax: line-begin
1183 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
1185 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN_SELECT
1186 * \li Action: Move the cursor to the beginning of the (screen) line adding the
1187 traversed text to the selection.
1188 * \li Syntax: line-begin-select
1191 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
1193 * \var lyx::FuncCode lyx::LFUN_LINE_END
1194 * \li Action: Move the cursor to the end of the (screen) line.
1195 * \li Syntax: line-end
1198 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
1200 * \var lyx::FuncCode lyx::LFUN_LINE_END_SELECT
1201 * \li Action: Move the cursor to the end of the (screen) line adding the
1202 traversed text to the selection.
1203 * \li Syntax: line-end-select
1206 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
1208 * \var lyx::FuncCode lyx::LFUN_LINE_DELETE_FORWARD
1209 * \li Action: Deletes the letters to the end of the (screen) line or
1210 deletes the selection.
1211 * \li Syntax: line-delete-forward
1214 { LFUN_LINE_DELETE_FORWARD, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
1216 * \var lyx::FuncCode lyx::LFUN_COPY
1217 * \li Action: Copies the current selection to the clipboard.
1221 { LFUN_COPY, "copy", ReadOnly, Edit },
1223 * \var lyx::FuncCode lyx::LFUN_CUT
1224 * \li Action: Cuts to the clipboard.
1228 { LFUN_CUT, "cut", Noop, Edit },
1230 * \var lyx::FuncCode lyx::LFUN_PASTE
1231 * \li Action: Pastes material (text or picture) from the active clipboard.
1232 * \li Syntax: paste [<TYPE>|<NUM>]
1233 * \li Params: <TYPE>: emf|pdf|png|jpeg|linkback|wmf|latex|html \n
1234 <NUM>: number of the selection in the internal clipboard stack to be pasted.
1237 { LFUN_PASTE, "paste", Noop, Edit },
1239 * \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE
1240 * \li Action: Pastes text from the active clipboard (retains formatting if the
1241 clipboard contains formatted text). Pastes plain text if plain text is
1242 on the clipboard, but tries to interpret it in special ways for certain
1243 insets, e.g. converting csv data to rows and columns if the paste happens
1245 * \li Notion: Historically, LFUN_CLIPBOARD_PASTE was introduced as a counterpart of
1246 LFUN_PRIMARY_SELECTION_PASTE: It behaved exactly the same, but the source
1247 is the clipboard, not the selection.
1248 * \li Syntax: clipboard-paste [<ARG>]
1249 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1250 * \li Origin: Georg, 10 Jul 2006
1253 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
1255 * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
1256 * \li Action: Pastes the currently selected text.
1257 * \li Notion: Primary selection mechanism is linux-only thing.
1258 * \li Syntax: primary-selection-paste [<ARG>]
1259 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1262 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
1264 * \var lyx::FuncCode lyx::LFUN_SELECTION_PASTE
1265 * \li Action: Pastes the internal selection text in permanent selection.
1266 * \li Notion: Created in order to have middle mouse button pasting correct (bound to
1267 command-alternatives selection-paste ; primary-selection-paste paragraph).
1268 * \li Syntax: selection-paste
1269 * \li Origin: lasgouttes, 14 Jan 2009
1272 { LFUN_SELECTION_PASTE, "selection-paste", Noop, Edit },
1274 * \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE_SIMPLE
1275 * \li Action: Pastes plain text from the active clipboard even if formatted
1276 LyX content is in the clipboard. Pastes plain text if plain text
1277 is on the clipboard, without trying to interpret it in special
1278 ways for certain insets, e.g. converting csv data to rows and
1279 columns if the paste happens in a tabular inset.
1280 * \li Syntax: clipboard-paste-simple [<ARG>]
1281 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1284 { LFUN_CLIPBOARD_PASTE_SIMPLE, "clipboard-paste-simple", Noop, Edit },
1286 * \var lyx::FuncCode lyx::LFUN_UNDO
1287 * \li Action: Undoes the last edit.
1291 { LFUN_UNDO, "undo", ReadOnly, Edit },
1293 * \var lyx::FuncCode lyx::LFUN_REDO
1294 * \li Action: Redoes the last thing undone.
1298 { LFUN_REDO, "redo", ReadOnly, Edit },
1300 * \var lyx::FuncCode lyx::LFUN_REPEAT
1301 * \li Action: Repeat the given command.
1302 * \li Syntax: repeat <COUNT> <LFUN-COMMAND>
1303 * \li Origin: Andre, 27 Oct 2003
1306 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
1308 * \var lyx::FuncCode lyx::LFUN_CHARS_TRANSPOSE
1309 * \li Action: Transposes the character at the cursor with the one before it.
1310 * \li Syntax: chars-transpose
1311 * \li Origin: Lgb, 25 Apr 2001
1314 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
1317 * \var lyx::FuncCode lyx::LFUN_DEPTH_DECREMENT
1318 * \li Action: Decrease the nesting depth of the (selected) paragraph(s)
1320 * \li Syntax: depth-decrement
1323 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
1325 * \var lyx::FuncCode lyx::LFUN_DEPTH_INCREMENT
1326 * \li Action: Increase the nesting depth of the (selected) paragraph(s)
1328 * \li Syntax: depth-increment
1331 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
1334 * \var lyx::FuncCode lyx::LFUN_FONT_BOLD
1335 * \li Action: Toggles the bold font (selection-wise) using mathbf in math.
1336 * \li Syntax: font-bold
1339 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
1342 * \var lyx::FuncCode lyx::LFUN_FONT_BOLDSYMBOL
1343 * \li Action: Toggles the bold font (selection-wise) using boldsymbol in math.
1344 * \li Syntax: font-boldsymbol
1347 { LFUN_FONT_BOLDSYMBOL, "font-boldsymbol", Noop, Layout },
1349 * \var lyx::FuncCode lyx::LFUN_FONT_TYPEWRITER
1350 * \li Action: Toggles the typewriter family font (selection-wise).
1351 * \li Syntax: font-typewriter
1354 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
1356 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERLINE
1357 * \li Action: Toggles underline in the font (selection-wise).
1358 * \li Syntax: font-underline
1361 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
1363 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERUNDERLINE
1364 * \li Action: Toggles double underline in the font (selection-wise).
1365 * \li Syntax: font-underunderline
1366 * \li Origin: sanda, 5 May 2009
1369 { LFUN_FONT_UNDERUNDERLINE, "font-underunderline", Noop, Layout },
1371 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERWAVE
1372 * \li Action: Toggles wavy underline in the font (selection-wise).
1373 * \li Syntax: font-underwave
1374 * \li Origin: sanda, 5 May 2009
1377 { LFUN_FONT_UNDERWAVE, "font-underwave", Noop, Layout },
1379 * \var lyx::FuncCode lyx::LFUN_FONT_STRIKEOUT
1380 * \li Action: Toggles strikeout (strike-through) in the font (selection-wise).
1381 * \li Syntax: font-strikeout
1382 * \li Origin: sanda, 3 May 2009
1385 { LFUN_FONT_STRIKEOUT, "font-strikeout", Noop, Layout },
1387 * \var lyx::FuncCode lyx::LFUN_FONT_EMPH
1388 * \li Action: Toggles the emphasis font style (selection-wise).
1389 * \li Syntax: font-emph
1392 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
1394 * \var lyx::FuncCode lyx::LFUN_FONT_NOUN
1395 * \li Action: Toggles Noun text style font (selection-wise).
1396 * \li Syntax: font-noun
1399 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
1401 * \var lyx::FuncCode lyx::LFUN_FONT_ROMAN
1402 * \li Action: Toggles Roman family font (selection-wise).
1403 * \li Syntax: font-roman
1406 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
1408 * \var lyx::FuncCode lyx::LFUN_FONT_SANS
1409 * \li Action: Toggles Sans Serif family font (selection-wise).
1410 * \li Syntax: font-sans
1413 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
1415 * \var lyx::FuncCode lyx::LFUN_FONT_FRAK
1416 * \li Action: Toggles Fraktur family font (math-mode, selection-wise).
1417 * \li Syntax: font-frak
1418 * \li Origin: vermeer, 10 Jan 2002
1421 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
1423 * \var lyx::FuncCode lyx::LFUN_FONT_ITAL
1424 * \li Action: Toggles Italics font shape (math-mode, selection-wise).
1425 * \li Syntax: font-ital
1426 * \li Origin: vermeer, 10 Jan 2002
1429 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
1431 * \var lyx::FuncCode lyx::LFUN_FONT_DEFAULT
1432 * \li Action: Reverts the settings of the font to the default values (selection-wise).
1433 * \li Syntax: font-default
1436 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
1438 * \var lyx::FuncCode lyx::LFUN_FONT_SIZE
1439 * \li Action: Sets font size according to lyx format string.
1440 * \li Syntax: font-size <SIZE>
1441 * \li Params: <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|\n
1442 largest|huge|giant|increase|decrease|default
1445 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
1447 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_APPLY
1448 * \li Action: Toggle user-defined (=last-time used) text style.
1449 * \li Notion: This style is set via #LFUN_TEXTSTYLE_UPDATE, which is
1450 automatically triggered when using Text Style dialog.
1451 * \li Syntax: textstyle-apply
1452 * \li Origin: leeming, 12 Mar 2003
1455 { LFUN_TEXTSTYLE_APPLY, "textstyle-apply", Noop, Layout },
1457 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_UPDATE
1458 * \li Action: Apply text style and update the settings to be used by #LFUN_TEXTSTYLE_APPLY.
1459 * \li Syntax: textstyle-update <FONT_INFO>
1460 * \li Params: <FONT_INFO>: specifies font atributes, e.g. family, series, shape,
1461 size, emph, noun, underbar, number, color, language,
1463 Use lyx -dbg action for exact syntax of text-style
1465 * \li Origin: leeming, 12 Mar 2003
1468 { LFUN_TEXTSTYLE_UPDATE, "textstyle-update", Noop, Layout },
1470 * \var lyx::FuncCode lyx::LFUN_SCREEN_FONT_UPDATE
1471 * \li Action: Update fonts and its metrics.
1472 * \li Notion: Automatically called after zoom, dpi, font names, or norm change.
1473 * \li Syntax: screen-font-update
1474 * \li Origin: ARRae, 13 Aug 2000
1477 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
1479 * \var lyx::FuncCode lyx::LFUN_FONT_STATE
1480 * \li Action: Returns the info about the current font.
1481 * \li Syntax: font-state
1484 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
1487 * \var lyx::FuncCode lyx::LFUN_CITATION_INSERT
1488 * \li Action: Inserts citation from loaded citation database.
1489 * \li Syntax: citation-insert [<KEY>[|<TEXT_BEFORE>]]
1490 * \li Params: <KEY>: Citation (shortcut listed in available citations). \n
1491 <TEXT_BEFORE>: text which should appear before citation.
1492 * \li Origin: AAS, 97-02-23
1495 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
1497 * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_ADD
1498 * \li Action: Adds database, which will be used for bibtex citations.
1499 * \li Notion: Databases are added to the first BibTeX inset
1500 (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
1501 * \li Syntax: bibtex-database-add <DATABASE-NAME>
1502 * \li Origin: Ale, 30 May 1997
1505 { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit },
1507 * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_DEL
1508 * \li Action: Adds database, which will be used for bibtex citations.
1509 * \li Notion: Databases are deleted from the first BibTeX inset
1510 (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
1511 * \li Syntax: bibtex-database-del <DATABASE-NAME>
1512 * \li Origin: Ale, 30 May 1997
1515 { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
1518 * \var lyx::FuncCode lyx::LFUN_LAYOUT
1519 * \li Action: Sets the layout (that is, environment) for the current paragraph.
1520 * \li Syntax: layout <LAYOUT>
1521 * \li Params: <LAYOUT>: the layout to use
1524 { LFUN_LAYOUT, "layout", Noop, Layout },
1526 * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH
1527 * \li Action: Launches the paragraph settings dialog.
1528 * \li Syntax: layout-paragraph
1531 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
1533 * \var lyx::FuncCode lyx::LFUN_LAYOUT_TABULAR
1534 * \li Action: Launches the tabular settings dialog.
1535 * \li Syntax: layout-tabular
1536 * \li Origin: Jug, 31 Jul 2000
1539 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
1541 * \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE
1542 * \li Action: Displays list of layout choices.
1543 * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
1544 dropbox allowing for choice of layout.
1545 * \li Syntax: drop-layouts-choice
1548 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
1550 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
1551 * \li Action: Clears the module list.
1552 * \li Notion: Clears the list of included modules for the current buffer.
1553 * \li Syntax: layout-modules-clear
1554 * \li Origin: rgh, 25 August 2007
1557 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", NoInternal, Layout },
1559 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULE_ADD
1560 * \li Action: Adds a module.
1561 * \li Notion: Adds a module to the list of included modules for the current buffer.
1562 * \li Syntax: layout-module-add <MODULE>
1563 * \li Params: <MODULE>: the module to be added
1564 * \li Origin: rgh, 25 August 2007
1567 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", NoInternal, Layout },
1569 * \var lyx::FuncCode lyx::LFUN_LAYOUT_RELOAD
1570 * \li Action: Reloads layout information.
1571 * \li Notion: Reloads all layout information for the current buffer from disk, thus
1572 recognizing any changes that have been made to layout files on the fly.
1573 This is intended to be used only by layout developers and should not be
1574 used when one is trying to do actual work.
1575 * \li Syntax: layout-reload
1576 * \li Origin: rgh, 3 September 2007
1579 { LFUN_LAYOUT_RELOAD, "layout-reload", NoInternal, Layout },
1581 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
1582 * \li Action: Sets the text class for the current buffer.
1583 * \li Syntax: textclass-apply <TEXTCLASS>
1584 * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
1585 the filename, minus the ".layout" extension.
1588 { LFUN_TEXTCLASS_APPLY, "textclass-apply", NoInternal, Layout },
1590 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
1591 * \li Action: Loads information for a textclass from disk.
1592 * \li Syntax: textclass-load <TEXTCLASS>
1593 * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
1594 the filename, minus the ".layout" extension.
1597 { LFUN_TEXTCLASS_LOAD, "textclass-load", NoInternal, Layout },
1600 * \var lyx::FuncCode lyx::LFUN_MARK_OFF
1601 * \li Action: Disable selecting of text-region.
1602 * \li Syntax: mark-off
1605 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
1607 * \var lyx::FuncCode lyx::LFUN_MARK_ON
1608 * \li Action: Enable selecting of text-region.
1609 * \li Notion: After enabling you can simply move arrow keys to get selected region.
1610 * \li Syntax: mark-on
1613 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
1615 * \var lyx::FuncCode lyx::LFUN_MARK_TOGGLE
1616 * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
1617 * \li Syntax: mark-toggle
1618 * \li Origin: Andre, May 5 2006
1621 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
1624 * \var lyx::FuncCode lyx::LFUN_MATH_DELIM
1625 * \li Action: Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
1626 * \li Syntax: math-delim [<LEFT>] [<RIGHT>]
1627 * \li Params: <LEFT/RIGHT>: Delimiters to be used. Each delimiter can be specified by
1628 either a LaTeX name or a valid character.
1629 ( is the default letter.
1630 * \li Sample: math-delim { rangle
1631 * \li Origin: Alejandro, 18 Jun 1996
1634 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
1636 * \var lyx::FuncCode lyx::LFUN_MATH_BIGDELIM
1637 * \li Action: Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
1638 * \li Syntax: math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
1639 * \li Params: <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r \n
1640 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
1641 * \li Sample: math-bigdelim "Bigl" "\Downarrow" "Bigr" "\}"
1642 * \li Origin: Enrico & Georg, 7 May 2006
1645 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
1647 * \var lyx::FuncCode lyx::LFUN_MATH_DISPLAY
1648 * \li Action: Creates a new displayed equation in text mode.
1649 Toggles inlined/display formula in math mode.
1650 * \li Syntax: math-display [<ARG>]
1651 * \li Params: <ARG>: this argument will be passed to #LFUN_MATH_INSERT when creating
1652 new equation from the text mode.
1653 * \li Origin: Alejandro, 18 Jun 1996
1656 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
1658 * \var lyx::FuncCode lyx::LFUN_MATH_INSERT
1659 * \li Action: Inserts math objects and symbols.
1660 * \li Syntax: math-insert <ARG>
1661 * \li Params: <ARG>: Symbol or LaTeX code to be inserted.
1662 * \li Notion: When <ARG> is a _single_ math inset with more than one cell
1663 (such as "x_y^z" or "\frac{x}{y}"), the content of cell(0) is
1664 replaced by the current selection (only works if the selection
1665 is in mathed). As an example, if "abc" is selected in mathed,
1666 "math-insert \frac{x}{y}" replaces "abc" with "\frac{abc}{y}",
1667 and "math-insert x_y^z" replaces "abc" with "abc_y^z".
1668 If nothing is selected (or the selection is not in mathed),
1669 math-insert works as expected.
1672 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
1674 * \var lyx::FuncCode lyx::LFUN_MATH_SUBSCRIPT
1675 * \li Action: Enters subscript expression in math expression.
1676 * \li Syntax: math-subscript
1677 * \li Origin: vermeer, 12 Dec 2001
1680 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
1682 * \var lyx::FuncCode lyx::LFUN_MATH_SUPERSCRIPT
1683 * \li Action: Enters superscript expression in math expression.
1684 * \li Syntax: math-superscript
1685 * \li Origin: vermeer, 12 Dec 2001
1688 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
1690 * \var lyx::FuncCode lyx::LFUN_MATH_LIMITS
1691 * \li Action: Toggles the position of the limits from above/below to the right
1692 side an vice versa in integral symbol, a limit, a summation, etc.
1693 * \li Notion: Put the cursor before the symbol with the limits and then invoke
1695 * \li Syntax: math-limits [<STATE>]
1696 * \li Params: <STATE>: limits|nolimits
1699 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
1701 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO
1702 * \li Action: Inserts a math macro definition at the cursor position in the text.
1703 * \li Syntax: math-macro <NAME> [<NARGS>] [def]
1704 * \li Params: <NAME>: The name of the macro, e.g. "mymacro".\n
1705 <NARGS>: The number of parameters of the macro. Default is 0.
1706 "def": Has no effect anymore, just for compatibility with former LyX versions.
1707 * \li Origin: ale, 10 May 1997; sts, 21 Dec 2007
1710 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
1712 * \var lyx::FuncCode lyx::LFUN_MATH_MUTATE
1713 * \li Action: Mutates the type of math inset to the newly selected one.
1714 * \li Syntax: math-mutate <TYPE>
1715 * \li Params: <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
1716 multline|gather|flalign
1717 * \li Origin: Andre, 23 May 2001
1720 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
1722 * \var lyx::FuncCode lyx::LFUN_MATH_SPACE
1723 * \li Action: Inserts space into math expression.
1724 * \li Notion: Use spacebar after entering this space to change type of space.
1725 * \li Syntax: math-space [<TYPE>] [<LEN>]
1726 * \li Params: <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace \n
1727 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad \n
1728 custom space: hspace \n
1729 "," used by default.\n
1730 Note that ! is equivalent to negthinspace, , = thinspace,
1731 : = medspace, and ; = thickspace.\n
1732 <LEN>: length for custom spaces (hspace)
1733 * \li Origin: Andre, 25 Jul 2001; sanda, 16 Jun 2008
1736 { LFUN_MATH_SPACE, "math-space", Noop, Math },
1738 * \var lyx::FuncCode lyx::LFUN_MATH_MATRIX
1739 * \li Action: Inserts a matrix.
1740 * \li Syntax: math-matrix <COLS> <ROWS> [<ALIGN>]
1741 * \li Params: <ALIGN>: Alignment is a word composed of the vertical alignment
1742 (b, c or t) (i.e. 1 char) and the horizontal alignments
1743 (l, c or r) (i.e. <COL> chars).
1744 * \li Sample: math-matrix 3 3 bccc
1747 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
1749 * \var lyx::FuncCode lyx::LFUN_MATH_AMS_MATRIX
1750 * \li Action: Inserts an extended matrix as provided by the amsmath package.
1751 * \li Syntax: math-matrix <COLS> <ROWS> [<DECORATION>]
1752 * \li Params: <DECORATION>: Decoration determines the LaTeX name of the matrix
1753 that should be created. Possible values include
1754 pmatrix, bmatrix, Bmatrix, vmatrix, Vmatrix and
1755 matrix. The default is 'matrix'.
1756 * \li Sample: math-ams-matrix 3 3 bmatrix
1759 { LFUN_MATH_AMS_MATRIX, "math-ams-matrix", Noop, Math },
1761 * \var lyx::FuncCode lyx::LFUN_MATH_MODE
1762 * \li Action: In text mode enters math mode (i.e. puts math insets on the current
1763 cursor position), in math mode enters text mode inside math expression.
1764 * \li Notion: If there is some selected text, it puts the text inside created math box.
1765 * \li Syntax: math-mode [on|<ARG>]
1766 * \li Params: <ARG>: eventual argument (LaTeX code) is passed to #LFUN_MATH_INSERT .\n
1767 "on": allow only entering of math mode from text mode.
1768 * \li Origin: Alejandro, 4 Jun 1996
1771 { LFUN_MATH_MODE, "math-mode", Noop, Math },
1773 * \var lyx::FuncCode lyx::LFUN_REGEXP_MODE
1774 * \li Action: Enters regexp mode (i.e., puts regexp insets on the current
1775 cursor position). Used by the advanced search dialog.
1776 * \li Notion: If there is any selected text, then it is moved inside the created
1778 * \li Syntax: regexp-mode [<ARG>]
1779 * \li Params: <ARG>: eventual argument (regular expression).
1780 * \li Origin: Tommaso, 4 Oct 2008
1783 { LFUN_REGEXP_MODE, "regexp-mode", Noop, Math },
1785 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
1786 * \li Action: Toggles numbering of the current formula line.
1787 * \li Notion: Must be in display formula mode.
1788 * \li Syntax: math-number-line-toggle
1789 * \li Origin: Alejandro, 18 Jun 1996
1792 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
1794 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
1795 * \li Action: Toggles numbering/labeling of the current formula.
1796 * \li Notion: Must be in display formula mode.
1797 * \li Syntax: math-number-toggle
1798 * \li Origin: Alejandro, 4 Jun 1996
1801 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
1803 * \var lyx::FuncCode lyx::LFUN_MATH_EXTERN
1804 * \li Action: Calls external program and passes the current expression/equation
1805 as an argument for the calculation in the format appropriate to the
1807 * \li Notion: Selection can be used to determine the input for the external program.
1808 * \li Syntax: math-extern <LANG> [<COMMAND>]
1809 * \li Params: <LANG>: octave|maxima|maple|mathematica|script \n
1810 where "script" stands for the external script (normalized
1811 expression will be passed)
1812 * \li Origin: Andre, 24 Apr 2001
1813 * \li Sample: math-extern maple simplify
1816 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
1818 * \var lyx::FuncCode lyx::LFUN_MATH_SIZE
1819 * \li Action: Changes arbitrarily the size used by math fonts inside a context.
1820 * \li Notion: Provides an interface to the LaTeX math mode font size commands.
1821 * \li Syntax: math-size <STYLE>
1822 * \li Params: <STYLE>: \displaystyle|\textstyle|\scriptstyle|\scriptscriptstyle
1823 * \li Origin: Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
1826 { LFUN_MATH_SIZE, "math-size", Noop, Math },
1828 * \var lyx::FuncCode lyx::LFUN_MATH_FONT_STYLE
1829 * \li Action: Changes the text style used in math.
1830 * \li Syntax: math-font-style <STYLE>
1831 * \li Params: <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf|textnormal\n
1832 |textrm|textsf|texttt|textbf|textmd|textit|textsc|textsl|textup
1833 * \li Origin: vfr, 9 jan 2009
1836 { LFUN_MATH_FONT_STYLE, "math-font-style", Noop, Math },
1838 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
1839 * \li Action: Unfold a Math Macro.
1840 * \li Notion: Unfold the Math Macro the cursor is in, i.e.
1842 * \li Syntax: math-macro-unfold
1843 * \li Origin: sts, 06 January 2008
1846 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
1848 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
1849 * \li Action: Fold a Math Macro.
1850 * \li Notion: Fold the Math Macro the cursor is in if it was
1851 unfolded, i.e. displayed as \foo before.
1852 * \li Syntax: math-macro-fold
1853 * \li Origin: sts, 06 January 2008
1856 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
1858 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
1859 * \li Action: Add a parameter.
1860 * \li Notion: Add a parameter to a Math Macro.
1861 * \li Params: <NUM>: The number of the parameter behind which the new one
1862 will be added (1 for the first, i.e. use 0 for add a
1863 parameter at the left), defaults to the last one.
1864 * \li Syntax: math-macro-add-param <NUM>
1865 * \li Origin: sts, 06 January 2008
1868 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
1870 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
1871 * \li Action: Remove the last parameter.
1872 * \li Notion: Remove the last parameter of a Math Macro and
1873 remove its value in all instances of the macro
1875 * \li Params: <NUM>: The number of the parameter to be deleted (1 for
1876 the first), defaults to the last one.
1877 * \li Syntax: math-macro-remove-param <NUM>
1878 * \li Origin: sts, 06 January 2008
1881 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
1883 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
1884 * \li Action: Append a greedy parameter.
1885 * \li Notion: Append a greedy parameter to a Math Macro which
1886 eats the following mathed cell in every instance of
1887 the macro in the buffer.
1888 * \li Syntax: math-macro-append-greedy-param
1889 * \li Origin: sts, 06 January 2008
1892 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
1894 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
1895 * \li Action: Remove a greedy parameter.
1896 * \li Notion: Remove a greedy parameter of a Math Macro and spit
1897 out the values of it in every instance of the macro
1898 in the buffer. If it is an optional parameter the [valud]
1900 * \li Syntax: math-macro-remove-greedy-param
1901 * \li Origin: sts, 06 January 2008
1904 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
1906 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
1907 * \li Action: Make a parameter optional.
1908 * \li Notion: Turn the first non-optional parameter of a Math Macro
1909 into an optional parameter with a default value.
1910 * \li Syntax: math-macro-make-optional
1911 * \li Origin: sts, 06 January 2008
1914 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
1916 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
1917 * \li Action: Make a parameter non-optional.
1918 * \li Notion: Turn the last optional parameter of a Math Macro
1919 into a non-optional parameter. The default value is
1920 remembered to be reused later if the user changes his mind.
1921 * \li Syntax: math-macro-make-nonoptional
1922 * \li Origin: sts, 06 January 2008
1925 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
1927 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
1928 * \li Action: Add an optional parameter.
1929 * \li Notion: Insert an optional parameter just behind the
1930 already existing optional parameters.
1931 * \li Syntax: math-macro-add-optional-param
1932 * \li Origin: sts, 06 January 2008
1935 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
1937 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
1938 * \li Action: Remove the last optional parameter.
1939 * \li Notion: Remove the last optional parameter of a Math Macro and
1940 remove it in all the instances of the macro in the buffer.
1941 * \li Syntax: math-macro-remove-optional-param
1942 * \li Origin: sts, 06 January 2008
1945 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
1947 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
1948 * \li Action: Add a greedy optional parameter.
1949 * \li Notion: Add a greedy optional parameter which eats the value
1950 from the following cells in mathed which are in the [value]
1952 * \li Syntax: math-macro-add-greedy-optional-param
1953 * \li Origin: sts, 06 January 2008
1956 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
1958 * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
1959 * \li Action: Only active in Math Macro definition.
1960 * \li Notion: Dummy function which is only active in a Math Macro definition.
1961 It's used to toggle the Math Macro toolbar if the cursor moves
1962 into a Math Macro definition.
1963 * \li Syntax: in-mathmacrotemplate
1964 * \li Origin: sts, 06 January 2008
1967 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
1970 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
1971 * \li Action: Moves the current paragraph downwards in the document.
1972 * \li Syntax: paragraph-move-down
1973 * \li Origin: Edwin, 8 Apr 2006
1976 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
1978 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
1979 * \li Action: Moves the current paragraph upwards in the document.
1980 * \li Notion: Movement through the document will possibly break the paragraph-depth
1981 (e.g. itemize structure).
1982 * \li Syntax: paragraph-move-up
1983 * \li Origin: Edwin, 8 Apr 2006
1986 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
1989 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP
1990 * \li Action: Move the cursor to the next paragraph (or beginning of the current one)
1991 in upward direction.
1992 * \li Syntax: paragraph-up
1993 * \li Origin: Asger, 1 Oct 1996
1996 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
1998 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP_SELECT
1999 * \li Action: Move the cursor and select the text to the next paragraph (or
2000 beginning of the current one) in upward direction.
2001 * \li Syntax: paragraph-up-select
2002 * \li Origin: Asger, 1 Oct 1996
2005 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
2007 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN
2008 * \li Action: Move the cursor to the next paragraph (or beginning of the current one)
2009 in downward direction.
2010 * \li Syntax: paragraph-down
2011 * \li Origin: Asger, 1 Oct 1996
2014 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
2016 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN_SELECT
2017 * \li Action: Move the cursor and select the text to the next paragraph (or
2018 beginning of the current one) in downward direction.
2019 * \li Syntax: paragraph-down-select
2020 * \li Origin: Asger, 1 Oct 1996
2023 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
2025 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
2026 * \li Action: Jump to a paragraph given by its id number and optionally the
2027 desired position within the paragraph.
2028 * \li Notion: Note that id number of paragraph is not the sequential number of paragraph
2029 seen on the screen. Moreover the id is unique for all opened buffers (documents).
2030 * \li Syntax: paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
2031 * \li Params: <PAR_ID_NUMBER>: paragraph id \n
2032 <POSITION_IN_PAR>: desired position within the paragraph
2033 * \li Origin: Dekel, 26 Aug 2000
2036 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly | NoInternal, Edit },
2038 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_BREAK
2039 * \li Action: Breaks the current paragraph at the current location.
2040 * \li Notion: Removes the selection.
2041 * \li Syntax: paragraph-break [<LAYOUT>]
2042 * \li Params: <LAYOUT>: "inverse" - decreases depth by one (or change layout
2043 to default layout) when the cursor is at the end of
2047 { LFUN_PARAGRAPH_BREAK, "paragraph-break", Noop, Edit },
2049 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
2050 * \li Action: Change paragraph settings.
2051 * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
2052 This function only modifies, and does not override, existing settings.
2053 Note that the "leftindent" indent setting is deprecated.
2054 * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
2055 * \li Params: <INDENT>: \noindent|\indent|\indent-toggle|\leftindent LENGTH\n
2056 <SPACING>: \paragraph_spacing default|single|onehalf|double|other SIZE \n
2057 <ALIGN>: \align block|left|right|center|default\n
2058 <OTHERS>: \labelwidthstring WIDTH|\start_of_appendix
2059 * \li Origin: rgh, Aug 15 2007
2062 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
2064 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
2065 * \li Action: Change paragraph settings.
2066 * \li Notion: Overwrite all nonspecified settings to the default ones.
2067 Use paragraph-params lfun if you don't want to overwrite others settings.
2068 * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
2069 * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
2070 * \li Origin: leeming, 30 Mar 2004
2073 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
2075 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UPDATE
2076 * \li Action: Updates the values inside the paragraph dialog from the paragraph.
2077 * \li Notion: This is an internal LFUN, not to be used by users. Called internally
2078 by #LFUN_DIALOG_UPDATE.
2079 * \li Origin: leeming, 13 Mar 2003
2082 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
2085 * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
2086 * \li Action: Move the current group in the upward direction in the
2087 structure of the document.
2088 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
2089 the whole substructure of the group.
2090 * \li Syntax: outline-up
2091 * \li Origin: Vermeer, 23 Mar 2006
2094 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
2096 * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
2097 * \li Action: Move the current group in the downward direction in the
2098 structure of the document.
2099 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
2100 the whole substructure of the group.
2101 * \li Syntax: outline-down
2102 * \li Origin: Vermeer, 23 Mar 2006
2105 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
2107 * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
2108 * \li Action: Moves the current group in the downward direction in the
2109 hierarchy of the document structure.
2110 * \li Notion: Part -> Chapter -> Section -> etc.
2111 * \li Syntax: outline-in
2112 * \li Origin: Vermeer, 23 Mar 2006
2115 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
2117 * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
2118 * \li Action: Moves the current group in the upward direction in the
2119 hierarchy of the document structure.
2120 * \li Notion: Part <- Chapter <- Section <- etc.
2121 * \li Syntax: outline-out
2122 * \li Origin: Vermeer, 23 Mar 2006
2125 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
2128 * \var lyx::FuncCode lyx::LFUN_INSET_EDIT
2129 * \li Action: Edit the inset at cursor with an external application,
2130 if one is attributed.
2131 * \li Syntax: inset-edit [<INSET_PARAMS>]
2132 * \li Params: <INSET_PARAMS>: Parameters for the inset. \n
2133 Currently only the filename will be considered.
2134 * \li Origin: JSpitzm, 27 Apr 2006
2137 { LFUN_INSET_EDIT, "inset-edit", ReadOnly | AtPoint, Edit },
2140 * \var lyx::FuncCode lyx::LFUN_TABULAR_INSERT
2141 * \li Action: Inserts table into the document.
2142 * \li Notion: See #LFUN_INSET_MODIFY for some more details
2143 about tabular modifications.
2144 * \li Syntax: tabular-insert [<ROWS> <COLUMNS>]
2145 * \li Params: In case no arguments are given show insert dialog.
2146 * \li Origin: Jug, 12 Apr 2000
2149 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
2152 * \var lyx::FuncCode lyx::LFUN_CELL_BACKWARD
2153 * \li Action: Moves the cursor to the previous cell inside the table.
2154 * \li Syntax: cell-backward
2155 * \li Origin: Jug, 22 May 2000
2158 { LFUN_CELL_BACKWARD, "cell-backward", ReadOnly | NoUpdate, Edit },
2160 * \var lyx::FuncCode lyx::LFUN_CELL_FORWARD
2161 * \li Action: Moves the cursor to the next cell inside the table.
2162 * \li Syntax: cell-forward
2165 { LFUN_CELL_FORWARD, "cell-forward", ReadOnly | NoUpdate, Edit },
2167 * \var lyx::FuncCode lyx::LFUN_CELL_SPLIT
2168 * \li Action: Splits cell and shifts right part to the next cell (inside the math grid).
2169 * \li Syntax: cell-split
2170 * \li Origin: Ale, 15 May 1997
2173 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
2176 * \var lyx::FuncCode lyx::LFUN_VC_REGISTER
2177 * \li Action: Register the document as an file inside version control system.
2178 * \li Notion: File is registered inside cvs, svn or rcs repository acording to the existence
2179 of cvs/svn/rcs entries in the document's directory. \n
2180 See LyX Additional Features Manual (Version Control Chapter) for additional
2182 * \li Syntax: vc-register
2183 * \li Origin: Lgb, 1 Jul 1997
2186 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
2188 * \var lyx::FuncCode lyx::LFUN_VC_RENAME
2189 * \li Action: Renames the document to another name.
2190 * \li Notion: Renaming with revision history is only supported by SVN.
2191 For CVS it is simulated by adding the document under a new
2192 name and deleting the old one. For RCS it is not supported.
2193 Disabled if uncommitted changes exist.
2194 * \li Syntax: vc-rename <FILENAME>
2195 * \li Params: <FILENAME>: New name of the document.\n
2196 * A file dialog is opened if no filename is given.
2197 * \li Origin: gb, 05 Feb 2013
2200 { LFUN_VC_RENAME, "vc-rename", ReadOnly, System },
2202 * \var lyx::FuncCode lyx::LFUN_VC_COPY
2203 * \li Action: Copies the document to another name.
2204 * \li Notion: Copying with revision history is only supported by SVN.
2205 For RCS and CVS it is simulated by adding the document
2207 Disabled if uncommitted changes exist.
2208 * \li Syntax: vc-copy <FILENAME>
2209 * \li Params: <FILENAME>: New name of the document.\n
2210 * A file dialog is opened if no filename is given.
2211 * \li Origin: gb, 05 Feb 2013
2214 { LFUN_VC_COPY, "vc-copy", ReadOnly, System },
2216 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_IN
2217 * \li Action: Checks-in/commits the changes of the registered file to the repository.
2218 * \li Notion: In RCS case this also unlocks the file.
2219 * \li Syntax: vc-check-in
2220 * \li Origin: Lgb, 1 Jul 1997
2223 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
2225 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_OUT
2226 * \li Action: Checks-out the document for edit (and locks it in some cases).
2227 * \li Syntax: vc-check-out
2228 * \li Origin: Lgb, 1 Jul 1997
2231 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
2233 * \var lyx::FuncCode lyx::LFUN_VC_REVERT
2234 * \li Action: Reverts the document to the last check-in/commit in VCS.
2235 * \li Syntax: vc-revert
2236 * \li Origin: Lgb, 1 Jul 1997
2239 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
2241 * \var lyx::FuncCode lyx::LFUN_VC_UNDO_LAST
2242 * \li Action: Undo last check-in.
2243 * \li Notion: This is currently implemented only for RCS.
2244 * \li Syntax: vc-check-out
2245 * \li Origin: Lgb, 1 Jul 1997
2248 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
2250 * \var lyx::FuncCode lyx::LFUN_VC_COMMAND
2251 * \li Action: Executes external command. This command is intended to support
2252 additional VCS commands.
2253 * \li Syntax: vc-command <FLAG> <PATH> <COMMAND>
2254 * \li Params: <FLAG>: Flags for the command can be combined together.\n
2255 U - dUmmy - no flags \n
2256 D - Doc - need document loaded to proceed \n
2257 I - dIrty - mark document dirty \n
2258 R - Reload - ensure that the document is saved and reload it after command execution \n
2259 M - Message - ask for input string (commit message)\n
2260 <PATH>: path where to start. $$p will be replaced by the current document path.\n
2261 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current
2262 document(with absolute path)/path/message.
2263 * \li Sample: vc-command DR $$p "svn up"
2264 * \li Origin: sanda, 13 Jan 2009
2267 { LFUN_VC_COMMAND, "vc-command", NoBuffer | ReadOnly, System },
2269 * \var lyx::FuncCode lyx::LFUN_VC_LOCKING_TOGGLE
2270 * \li Action: Toggles the locking property of the edited file.
2271 * \li Notion: This is currently implemented only for SVN.
2272 * \li Syntax: vc-locking-toggle
2273 * \li Origin: sanda, 25 Jun 2009
2276 { LFUN_VC_LOCKING_TOGGLE, "vc-locking-toggle", ReadOnly, System },
2278 * \var lyx::FuncCode lyx::LFUN_VC_REPO_UPDATE
2279 * \li Action: Update the local archive directory in which resides
2280 the current document with the remote repository.
2281 * \li Syntax: vc-repo-update
2282 * \li Origin: sanda, 16 Oct 2009
2285 { LFUN_VC_REPO_UPDATE, "vc-repo-update", ReadOnly, System },
2287 * \var lyx::FuncCode lyx::LFUN_VC_COMPARE
2288 * \li Action: Compares two revisions of the same file under version control.
2289 * \li Syntax: vc-compare [<REV1>] [<REV2>]
2290 * \li Params: Revision number either points directly to commit in history
2291 or if negative number -x it points to (last commit - x).\n
2292 In RCS we subtract only in the last number of revision specification.
2293 Special case "0" is reserved for the last committed revision.\n
2294 <REV1>: Older file.\n
2295 <REV2>: Newer file. Used only if REV1 > 0.\n
2296 If no parameter is given, interactive dialog will be shown.
2297 * \li Sample: Compare current document against last commit\n
2299 Compare current document against current revision - 5 commits\n
2301 Compare revisions 120 and 155\n
2303 * \li Origin: sanda, 12 Feb 2010
2306 { LFUN_VC_COMPARE, "vc-compare", ReadOnly, System },
2309 * \var lyx::FuncCode lyx::LFUN_CHANGES_TRACK
2310 * \li Action: Toggles change tracking to on/off.
2311 * \li Syntax: changes-track
2312 * \li Origin: levon, 1 Oct 2002
2315 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
2317 * \var lyx::FuncCode lyx::LFUN_CHANGES_OUTPUT
2318 * \li Action: Toggles showing of change tracking in typeset output.
2319 * \li Syntax: changes-output
2320 * \li Origin: jspitzm, 21 Jan 2005
2323 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
2325 * \var lyx::FuncCode lyx::LFUN_CHANGE_NEXT
2326 * \li Action: Moves the cursor to the position of the next change
2327 of the change tracking records.
2328 * \li Syntax: change-next
2329 * \li Origin: schmitt, 4 Oct 2006
2332 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
2334 * \var lyx::FuncCode lyx::LFUN_CHANGE_PREVIOUS
2335 * \li Action: Moves the cursor to the position of the previous change
2336 of the change tracking records.
2337 * \li Syntax: change-previous
2338 * \li Origin: vfr, 4 Apr 2009
2341 { LFUN_CHANGE_PREVIOUS, "change-previous", ReadOnly, Edit },
2343 * \var lyx::FuncCode lyx::LFUN_CHANGES_MERGE
2344 * \li Action: Open change tracking dialog for merging and moves the cursor
2345 to the position of the next change.
2346 * \li Syntax: changes-merge
2347 * \li Origin: Levon, 16 Oct 2002
2350 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
2352 * \var lyx::FuncCode lyx::LFUN_CHANGE_ACCEPT
2353 * \li Action: Accepts tracked change inside the selection.
2354 * \li Syntax: change-accept
2355 * \li Origin: Levon, 16 Oct 2002
2358 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
2360 * \var lyx::FuncCode lyx::LFUN_CHANGE_REJECT
2361 * \li Action: Rejects tracked change inside the selection.
2362 * \li Syntax: change-reject
2363 * \li Origin: Levon, 16 Oct 2002
2366 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
2368 * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_ACCEPT
2369 * \li Action: Accepts all tracked changes in the document.
2370 * \li Syntax: all-changes-accept
2371 * \li Origin: Levon, 16 Oct 2002
2374 { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
2376 * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_REJECT
2377 * \li Action: Rejects all tracked changes in the document.
2378 * \li Notion: Reject does not work recursively; the user may have to repeat the operation.
2379 * \li Syntax: all-changes-reject
2380 * \li Origin: Levon, 16 Oct 2002
2383 { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
2386 * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
2387 * \li Action: Apply data for an inset.
2388 * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
2389 be applied. This is either changed to #LFUN_INSET_MODIFY or
2390 #LFUN_INSET_INSERT depending on the context where it is called.
2391 * \li Syntax: inset-apply <ARGS>
2392 * \li Params: See #LFUN_INSET_INSERT .
2395 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
2397 * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE
2398 * \li Action: Dissolve the current inset into text.
2399 * \li Syntax: inset-dissolve [<INSET>]
2400 * \li Params: <INSET>: this can be used to make sure the right kind of inset
2401 is dissolved. For example "dissolve" entry in the charstyles
2402 sub-menu should only dissolve the charstyle inset, even if the
2403 cursor is inside several nested insets of different type.\n
2404 For values see #lyx::InsetLayout::lyxtype_ .
2405 * \li Origin: JSpitz, 7 Aug 2006
2408 { LFUN_INSET_DISSOLVE, "inset-dissolve", AtPoint, Edit },
2410 * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
2411 * \li Action: Insert new inset (type given by the parameters).
2412 * \li Syntax: inset-insert <INSET> <ARGS>
2413 * \li Params: <INSET>: <bibitem|bibtex|citation|ert|listings|external|graphics|tabular|\n
2414 hyperlink|include|index|label|line|nomencl|vspace|ref|toc|script>\n
2415 <ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
2416 * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
2417 where <label name> is the name of the referenced label and
2418 <Format> is one of the following: \n
2419 ref -- <reference> \n
2420 eqref -- (<reference>) \n
2421 pageref -- <page> \n
2422 vpageref -- on <page> \n
2423 vref -- <reference> on <page> \n
2424 formatted -- Formatted reference
2427 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
2429 * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
2430 * \li Action: Modify some properties of an inset.
2431 * \li Notion: Used for bibitem, bibtex, box, branch, command, ert, external,
2432 floats, graphics, include, index, info, label,
2433 listings, newline, newpage, nomencl, note, phantom,
2434 ref, space, tabular, vspace, wrap insets.
2435 * \li Syntax: inset-modify <INSET> <ARGS>
2436 * \li Syntax: inset-modify changetype <TYPE>
2437 * \li Syntax: inset-modify tabular <FEATURE> [<ARG>]
2438 * \li Params: Generally see #LFUN_INSET_INSERT for further details.\n
2439 In case that <INSET> is "tabular" various math-environment features
2440 are handled as well, e.g. add-vline-left/right for the Grid/Array environment.\n
2441 <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|\n
2442 copy-column|move-column-right|move-column-left|move-row-down|move-row-up|\n
2443 toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|\n
2444 align-left|align-right|align-center|align-block|align-decimal|set-decimal-point|\n
2445 valign-top|valign-bottom|valign-middle|longtabular-align-left|\n
2446 longtabular-align-center|longtabular-align-right|m-align-left|m-align-right|\n
2447 m-align-center|m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|\n
2448 set-all-lines|unset-all-lines|set-longtabular|unset-longtabular|set-pwidth|\n
2449 set-mpwidth|set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|\n
2450 set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|\n
2451 unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|\n
2452 set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|\n
2453 set-special-column|set-special-multicolumn|set-special-multirow|\n
2454 set-booktabs|unset-booktabs|set-top-space|set-bottom-space|\n
2455 set-interline-space|set-border-lines|tabular-valign-top|\n
2456 tabular-valign-middle|tabular-valign-bottom|set-tabular-width
2457 <ARG>: additional argument for some commands, use debug mode to explore its values.
2458 * \li Sample: inset-modify note Note Comment \n
2459 inset-modify changetype Ovalbox
2462 { LFUN_INSET_MODIFY, "inset-modify", AtPoint, Edit },
2464 * \var lyx::FuncCode lyx::LFUN_INSET_DIALOG_UPDATE
2465 * \li Action: Updates the values inside the dialog from the inset.
2466 * \li Notion: This is an internal LFUN, not to be used by users. Called internally
2467 by #LFUN_DIALOG_UPDATE
2468 * \li Params: <DIALOG-NAME>
2469 * \li Origin: leeming, 25 Feb 2003
2472 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
2474 * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
2475 * \li Action: Open the inset's properties dialog.
2476 * \li Notion: Used for bibitem, bibtex, box, branch, citation, ert, external,
2477 float, graphics, href, include, index, index_print, label, line,
2478 listings, note, phantom, ref, space, tabular, vspace, wrap insets.
2479 * \li Syntax: inset-settings <INSET>
2480 * \li Params: <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|\n
2481 graphics|href|include|index|index_print|label|line|\n
2482 listings|note|phantom|ref|space|tabular|vspace|wrap>.
2485 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly | AtPoint, Edit },
2487 * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
2488 * \li Action: Toggles the collapsible inset at cursor position,
2489 or the inset we are currently in.
2490 * \li Syntax: inset-toggle [<ARG>]
2491 * \li Params: <ARG>: <open|close|toggle|assign>. \n
2492 open/close/toggle are for collapsible insets. toggle is used when no argument is given.\n
2493 assign synchronize the branch-inset with activation status of the branch.
2494 Used for global toggling when changed activation.
2495 * \li Origin: lasgouttes, 19 Jul 2001
2498 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly | AtPoint, Edit },
2500 * \var lyx::FuncCode lyx::LFUN_INSET_FORALL
2501 * \li Action: Apply the given commands on insets of a given name.
2502 * \li Notion: WARNING: use at your own risks; this function gives
2503 you too many ways of shooting yourself in the foot.
2504 A typical example is
2505 inset-forall Note note-insert
2506 which starts an infinite loop. This is mitigated by the fact
2507 that the number of actions is arbitrarily limited to 100000.
2508 Note also that inset-forall does not update metrics between
2509 iterations, which can lead to bugs. This has to be eventually
2511 * \li Syntax: inset-forall <NAME> <LFUN-COMMAND> \n
2512 <NAME>: Type of Inset. If <NAME> is *, all insets are matched.
2513 The name is used like for InsetLayout in layout files: "Note"
2514 matches all note insets, while "Note:Note" only matches LyX
2516 * \li Sample: Remove all index insets: \n
2517 inset-forall Index char-delete-forward \n
2518 Close all Notes (also works for a particular branch, for example): \n
2519 inset-forall Note inset-toggle close \n
2520 Transform all yellow notes to comments \n
2521 inset-forall Note:Note inset-modify note Note Comment \n
2522 Try to put LyX in an infinite loop if there is at least a Note: \n
2523 inset-forall Note char-backward
2524 * \li Origin: lasgouttes, 27 Nov 2009
2527 { LFUN_INSET_FORALL, "inset-forall", ReadOnly, Edit },
2530 * \var lyx::FuncCode lyx::LFUN_GRAPHICS_RELOAD
2531 * \li Action: Reloads the image if necessary.
2532 * \li Syntax: graphics-reload
2533 * \li Origin: vfr, 10 Aug 2009
2536 { LFUN_GRAPHICS_RELOAD, "graphics-reload", ReadOnly | AtPoint, Edit },
2538 * \var lyx::FuncCode lyx::LFUN_SET_GRAPHICS_GROUP
2539 * \li Action: Set the group for the graphics inset on the cursor position.
2540 * \li Syntax: set-graphics-group [<GROUP>]
2541 * \li Params: <GROUP>: Id for an existing group. In case the Id is an empty string,
2542 the graphics inset is removed from the current group.
2543 * \li Origin: sanda, 6 May 2008
2546 { LFUN_SET_GRAPHICS_GROUP, "set-graphics-group", Noop, Edit },
2549 * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
2550 * \li Action: Moves the cursor out of the current slice, going forward.
2551 * \li Notion: Cursor movement within an inset may be different than cursor
2552 movement in the surrounding text. This action should be called
2553 automatically by the cursor movement within the inset, when
2554 movement within the inset has ceased (reached the end of the
2555 last paragraph, for example), in order to move correctly
2556 back into the surrounding text.
2559 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
2561 * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
2562 * \li Action: Moves the cursor out of the current slice, going backwards.
2563 * \li Notion: See also #LFUN_FINISHED_FORWARD.
2566 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
2568 * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
2569 * \li Action: Moves the cursor out of the current slice, going right.
2570 * \li Notion: See also #LFUN_FINISHED_FORWARD
2573 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
2575 * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
2576 * \li Action: Moves the cursor out of the current slice, going left.
2577 * \li Notion: See also #LFUN_FINISHED_FORWARD.
2580 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
2583 * \var lyx::FuncCode lyx::LFUN_LANGUAGE
2584 * \li Action: Set language from the current cursor position.
2585 * \li Syntax: language <LANG> [set]
2586 * \li Params: <LANG>: Requested language. Look in lib/languages for
2587 the list. "language reset" or "language" (without param)
2588 reset to the document language.
2589 set: If used, the language will be set to the specified
2590 language. Otherwise, the language will be toggled (i.e., if
2591 the current language is LANG, switch to the document language
2592 or the default language, if LANG is the document language).
2593 * \li Origin: Dekel, 2 Mar 2000
2596 { LFUN_LANGUAGE, "language", Noop, Edit },
2599 * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
2600 * \li Action: Goto a label.
2601 * \li Syntax: label-goto [<LABEL>]
2602 * \li Params: <LABEL>: Requested label. If no label is given and reference
2603 is on cursor position, Bookmark 0 is saved and
2604 cursor moves to the position of referenced label.
2605 * \li Origin: Ale, 6 Aug 1997
2608 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
2610 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT
2611 * \li Action: Inserts label to text or displayed formula.
2612 * \li Syntax: label-insert [<LABEL>]
2613 * \li Params: <LABEL>: Requested label. If no label is given dialog requesting
2614 name will be opened.
2617 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
2619 * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
2620 * \li Action: Go to the next label or cross-reference.
2621 * \li Syntax: reference-next
2622 * \li Origin: Dekel, 14 Jan 2001
2625 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
2628 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
2629 * \li Action: Moves the cursor to the numbered bookmark, opening the file
2630 if necessary. Note that bookmarks are saved per-session, not
2632 * \li Notion: Bookmark 0 has a special purpose. It is automatically set \n
2633 1. to the paragraph you are currently editing \n
2634 2. to the paragraph from where you are jumping to the last-edited
2635 position (jump-back feature) \n
2636 3. when jumping from crossreference to the requested label by
2638 * \li Syntax: bookmark-goto <NUMBER>
2639 * \li Params: <NUMBER>: the number of the bookmark to restore.
2640 * \li Origin: Dekel, 27 January 2001
2643 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
2645 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
2646 * \li Action: Save a bookmark.
2647 * \li Notion: Saves a numbered bookmark to the sessions file. The number
2648 must be between 1 and 9, inclusive. Note that bookmarks are
2649 saved per-session, not per file.
2650 * \li Syntax: bookmark-save <NUMBER>
2651 * \li Params: <NUMBER>: the number of the bookmark to save.
2652 * \li Origin: Dekel, 27 January 2001
2655 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
2657 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
2658 * \li Action: Clears the list of saved bookmarks.
2659 * \li Syntax: bookmark-clear
2660 * \li Origin: bpeng, 31 October 2006
2663 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
2666 * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
2667 * \li Action: Open the given help file according to the language setting.
2668 * \li Syntax: help-open <FILE>[.lyx]
2669 * \li Params: <FILE>: any document from (/usr/share/)doc directory.
2670 * \li Origin: Jug, 27 Jun 1999
2673 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
2675 * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
2676 * \li Action: Terminates the current LyX instance.
2677 * \li Notion: Terminates the current LyX instance, asking whether to save
2678 modified documents, etc.
2679 * \li Syntax: lyx-quit
2682 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
2684 * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
2685 * \li Action: Toggles visibility of a given toolbar between on/off/auto.
2686 * \li Notion: Skipping "auto" when allowauto is false.
2687 * \li Syntax: toolbar-toggle <NAME> [allowauto]
2688 * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|\n
2689 minibuffer|review|view/update|math_panels|vcs|
2690 view-others|update-others
2691 * \li Origin: Edwin, 21 May 2007
2694 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
2696 * \var lyx::FuncCode lyx::LFUN_MENU_OPEN
2697 * \li Action: Opens the menu given by its name.
2698 * \li Syntax: menu-open <NAME>
2699 * \li Params: <NAME>: menu name. See various .inc files in lib/ui for candidates.
2702 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
2704 * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
2705 * \li Action: Various UI visibility-toggling actions.
2706 * \li Syntax: ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
2707 * \li Params: statusbar : Toggle visibility of the statusbar.\n
2708 menubar : Toggle visibility of the menubar.\n
2709 scrollbar : Toggle visibility of the scrollbar.\n
2710 frame : Toggle visibility of the frames around editing window.\n
2711 fullscreen : Toggle fullscreen mode. This also covers calling the
2712 previous functions. However #LFUN_TOOLBAR_TOGGLE for the
2713 custom tweaks of the toolbars should be used.
2714 * \li Origin: sanda, 9 Feb 2007
2717 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
2720 * \var lyx::FuncCode lyx::LFUN_WINDOW_NEW
2721 * \li Action: Creates new empty LyX window.
2722 * \li Notion: Already opened documents from the previous window can be found under View menu.
2723 * \li Syntax: window-new [<GEOMETRY>]
2724 * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently
2725 accepted only on Windows platform.
2726 * \li Origin: Abdel, 21 Oct 2006
2729 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
2731 * \var lyx::FuncCode lyx::LFUN_WINDOW_CLOSE
2732 * \li Action: Closes the current LyX window.
2733 * \li Syntax: window-close
2734 * \li Origin: Abdel, 23 Oct 2006
2737 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
2740 * \var lyx::FuncCode lyx::LFUN_VIEW_SPLIT
2741 * \li Action: Creates another split view of current buffer.
2742 * \li Notion: All split views act in the same way independently.
2743 * \li Syntax: view-split <vertical|horizontal>
2744 * \li Params: horizontal : The work areas are laid out side by side.\n
2745 vertical : The work areas laid out vertically.
2746 * \li Origin: Abdel, 20 Feb 2008
2749 { LFUN_VIEW_SPLIT, "view-split", ReadOnly, Buffer },
2752 * \var lyx::FuncCode lyx::LFUN_VIEW_CLOSE
2753 * \li Action: Close the current document work area.
2754 * \li Notion: Close the current work area. If no other work areas are showing the buffer,
2755 then close the associated buffer as well.
2756 * \li Syntax: view-close
2757 * \li Origin: Tommaso, 15 Sep 2012
2760 { LFUN_VIEW_CLOSE, "view-close", ReadOnly, Buffer },
2763 * \var lyx::FuncCode lyx::LFUN_TAB_GROUP_CLOSE
2764 * \li Action: Close the current tab group.
2765 * \li Notion: This only closes the work areas, not the buffers themselves.
2766 The still opened buffers can be visualized in another tab group.
2767 * \li Syntax: tab-group-close
2768 * \li Origin: Abdel, 21 Feb 2008
2771 { LFUN_TAB_GROUP_CLOSE, "tab-group-close", ReadOnly, Buffer },
2774 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW
2775 * \li Action: Shows hidden dialog or creates new one for a given function/inset settings etc.
2776 * \li Syntax: dialog-show <NAME> [<DATA>]
2777 * \li Params: <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|\n
2778 compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|\n
2779 graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimiter|\n
2780 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|\n
2781 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|\n
2782 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL> \n
2783 <SPECIAL>: latexlog|vclog \n
2784 <DATA>: data, usually settings for the given dialog. Use debug mode for the
2786 * \li Origin: leeming, 17 Jun 2003
2789 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
2791 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW_NEW_INSET
2792 * \li Action: Shows hidden dialog or create new one for a given inset settings etc.
2793 * \li Notion: Internally uses #LFUN_DIALOG_SHOW with processed data for a given inset.
2794 * \li Syntax: dialog-show-new-inset <NAME> [<DATA>]
2795 * \li Params: See #LFUN_DIALOG_SHOW .
2796 * \li Origin: leeming, 25 Feb 2003
2799 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
2801 * \var lyx::FuncCode lyx::LFUN_DIALOG_UPDATE
2802 * \li Action: Updates the dialog values from the inset/paragraph/document.
2803 * \li Syntax: dialog-update <NAME>
2804 * \li Params: <NAME>: paragraph|prefs|<INSET> \n
2806 * \li Origin: leeming, 25 Feb 2003
2809 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
2811 * \var lyx::FuncCode lyx::LFUN_DIALOG_HIDE
2812 * \li Action: Hides showed dialog. Counterpart to #LFUN_DIALOG_SHOW .
2813 * \li Syntax: dialog-hide <NAME>
2814 * \li Params: See #LFUN_DIALOG_SHOW .
2815 * \li Origin: leeming, 25 Feb 2003
2818 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
2820 * \var lyx::FuncCode lyx::LFUN_DIALOG_TOGGLE
2821 * \li Action: Toggles dialog between showed/hidden state.
2822 * \li Notion: Internally uses #LFUN_DIALOG_SHOW , #LFUN_DIALOG_HIDE .
2823 * \li Syntax: dialog-toggle <NAME> [<DATA>]
2824 * \li Params: See #LFUN_DIALOG_SHOW .
2825 * \li Origin: JSpitzm, 30 Apr 2007
2828 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
2830 * \var lyx::FuncCode lyx::LFUN_DIALOG_DISCONNECT_INSET
2831 * \li Action: Closes opened connection to opened inset.
2832 * \li Notion: Connection is used for apply functions.
2833 * \li Syntax: dialog-disconnect-inset <INSET-NAME>
2834 * \li Origin: leeming, 25 Feb 2003
2837 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
2840 * \var lyx::FuncCode lyx::LFUN_MOUSE_PRESS
2841 * \li Action: This function is called when mouse button is pressed (inside workarea).
2842 Action depends on the context.
2843 * \li Notion: This is an internal LFUN, not to be used by users.
2844 * \li Origin: Andre, 9 Aug 2002
2847 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
2849 * \var lyx::FuncCode lyx::LFUN_MOUSE_DOUBLE
2850 * \li Action: This function is called when double click on mouse button is
2851 pressed (inside workarea). Action depends on the context.
2852 * \li Notion: This is an internal LFUN, not to be used by users.
2853 * \li Origin: Andre, 9 Aug 2002
2856 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
2858 * \var lyx::FuncCode lyx::LFUN_MOUSE_TRIPLE
2859 * \li Action: This function is called when triple click on mouse button is
2860 pressed (inside workarea). Action depends on the context.
2861 * \li Notion: This is an internal LFUN, not to be used by users.
2862 * \li Origin: Andre, 9 Aug 2002
2865 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
2867 * \var lyx::FuncCode lyx::LFUN_MOUSE_MOTION
2868 * \li Action: This function is called when mouse cursor is moving over the text.
2869 Action depends on the context.
2870 * \li Notion: This is an internal LFUN, not to be used by users.
2871 * \li Origin: Andre, 9 Aug 2002
2874 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
2876 * \var lyx::FuncCode lyx::LFUN_MOUSE_RELEASE
2877 * \li Action: This function is called when mouse button is released (inside workarea).
2878 Action depends on the context.
2879 * \li Notion: This is an internal LFUN, not to be used by users.
2880 * \li Origin: Andre, 9 Aug 2002
2883 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
2886 * \var lyx::FuncCode lyx::LFUN_KEYMAP_OFF
2887 * \li Action: Turn off the loaded keyboard map.
2888 * \li Syntax: keymap-off
2891 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
2893 * \var lyx::FuncCode lyx::LFUN_KEYMAP_PRIMARY
2894 * \li Action: Turn on the primary keyboard map.
2895 * \li Notion: Maps were widely used in past, when X-windows didn't have nowadays
2896 keyboard support. They can be still used to maintain uniform keyboard
2897 layout across the various platforms.\n
2898 The language is to be set in the Preferences dialog.
2899 * \li Syntax: keymap-primary
2902 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
2904 * \var lyx::FuncCode lyx::LFUN_KEYMAP_SECONDARY
2905 * \li Action: Turn on the secondary keyboard map.
2906 * \li Syntax: keymap-secondary
2909 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
2911 * \var lyx::FuncCode lyx::LFUN_KEYMAP_TOGGLE
2912 * \li Action: Toggles keyboard maps (first/second/off).
2913 * \li Syntax: keymap-toggle
2914 * \li Origin: leeming, 30 Mar 2004
2917 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
2920 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_LAYOUT
2921 * \li Action: Returns the current layout (that is environment) name
2922 on the cursor position.
2923 * \li Syntax: server-get-layout
2926 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
2928 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_FILENAME
2929 * \li Action: Returns path and file name of the currently edited document.
2930 * \li Syntax: server-get-filename
2933 { LFUN_SERVER_GET_FILENAME, "server-get-filename", ReadOnly, System },
2935 * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
2936 * \li Action: Sets the cursor position in LyX based on the row number of generated TeX file.
2937 * \li Notion: This can be useful for DVI inverse-search or detection of the problematic
2938 line from LaTeX compilation. Note that before this function can be used
2939 export to LaTeX output must occur (in order to map the row numbers).
2940 * \li Syntax: server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
2941 * \li Params: <FILE>: the path and filename. Environment variables are expanded in the path.
2942 In case this LFUN does not work make sure you are giving correct
2944 If the file is located inside LyX temporary directory it will be
2945 mapped back into the appropriate opened buffer (e.g. for the case
2946 of generated .tex file).\n
2947 .ext: extensions will be automatically replaced by .lyx.\n
2948 <ROW_NUMBER> The row number of the LaTeX file to which to go.
2949 * \li Sample: server-goto-file-row /home/user/example.lyx 41\n
2950 server-goto-file-row /tmp/lyx_tmpdir.XM3088/lyx_tmpbuf0/example.tex 41
2951 * \li Origin: Edmar, 23 Dec 1998
2954 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly | NoBuffer, System },
2956 * \var lyx::FuncCode lyx::LFUN_FORWARD_SEARCH
2957 * \li Action: Sets the cursor position in the previewed (dvi/pdf) file based on the row
2958 number in LyX window.
2959 * \li Notion: The external program used for forward search call can be specified in
2960 LyX Output preferences. See Additional manual for details of these
2962 * \li Syntax: forward-search
2963 * \li Origin: sanda, 14 Apr 2010
2966 { LFUN_FORWARD_SEARCH, "forward-search", ReadOnly, System },
2968 * \var lyx::FuncCode lyx::LFUN_SERVER_NOTIFY
2969 * \li Action: Sends notify message about the last key-sequence to client.
2970 * \li Notion: This can be used to grab last key-sequence used inside the LyX window.
2971 See also Debug extensions section in Additional features manual.
2972 * \li Syntax: server-notify
2975 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
2977 * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
2978 * \li Action: Sets the cursor position based on the editing area coordinates
2979 (similar to clicking on that point with left mouse button).
2980 * \li Syntax: server-set-xy <X> <Y>
2983 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
2985 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
2986 * \li Action: Returns the coordinates of cursor position in the editing area.
2987 * \li Syntax: server-get-xy
2990 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
2993 * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
2994 * \li Action: Generates the code (literate programming).
2995 * \li Notion: Latex file with extension \literate_extension is generated.
2996 Then LyX invokes \build_command (with a default of ``make'') to generate the code and
2997 \build_error_filter to process the compilation error messages. \n
2998 In case you want to process your literate file with a script, or some other program,
2999 just insert in your lyxrc file an entry with:\n
3000 \build_command "my_script my_arguments" \n
3001 The \build_error_filter differs from the \literate_error_filter only in that the
3002 former will identify error messages from your compiler.
3003 * \li Syntax: build-program
3006 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
3009 * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
3010 * \li Action: Saves the current buffer to a temporary file.
3011 * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
3012 is called automatically by LyX, to "autosave" the current buffer.
3013 * \li Syntax: buffer-auto-save
3016 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
3018 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHILD_OPEN
3019 * \li Action: Loads the given child document.
3020 * \li Notion: The current document is treated as a parent.
3021 * \li Syntax: buffer-child-open <FILE>
3022 * \li Params: <FILE>: Filename of the child. The directory of the parent is assumed by default.
3023 * \li Origin: Ale, 28 May 1997
3026 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
3028 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHKTEX
3029 * \li Action: Runs chktex for the current document.
3030 * \li Syntax: buffer-chktex
3031 * \li Origin: Asger, 30 Oct 1997
3034 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
3036 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
3037 * \li Action: Toggles compression of the current document on/off.
3038 * \li Syntax: buffer-toggle-compression
3039 * \li Origin: bpeng, 27 Apr 2006
3042 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
3044 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_OUTPUT_SYNC
3045 * \li Action: Toggles including of resources for forward/reverse search of the given document.
3046 * \li Notion: When toggled on, SyncTeX is invoked for PDF, while srcltx package
3047 is used for DVI. Custom LaTeX macro can be defined in preferences.
3048 * \li Syntax: buffer-toggle-output-sync
3049 * \li Origin: sanda, 25 May 2010
3052 { LFUN_BUFFER_TOGGLE_OUTPUT_SYNC, "buffer-toggle-output-sync", Noop, System },
3054 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
3055 * \li Action: Closes the current buffer.
3056 * \li Notion: Closes the current buffer, asking whether to save it, etc,
3057 if the buffer has been modified.
3058 * \li Syntax: buffer-close
3061 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
3063 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE_ALL
3064 * \li Action: Closes all buffers.
3065 * \li Notion: Closes all buffers, asking whether to save it, etc,
3066 if a buffer has been modified.
3067 * \li Syntax: buffer-close-all
3070 { LFUN_BUFFER_CLOSE_ALL, "buffer-close-all", ReadOnly, Buffer },
3072 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
3073 * \li Action: Exports the current buffer (document) to the given format.
3074 * \li Syntax: buffer-export <FORMAT> [<DEST>]
3075 * \li Params: <FORMAT> is either "custom" or one of the formats which you
3076 can find in Tools->Preferences->File formats->Format.
3077 Usual format you will enter is "pdf2" (pdflatex),
3078 "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
3079 In case of "custom" you will be asked for a format you
3080 want to start from and for the command that you want to
3081 apply to this format. Internally the control is then passed
3082 to #LFUN_BUFFER_EXPORT_CUSTOM.
3083 <DEST> If present, this argument provides the export destination
3084 filename. Its containing folder will also be the destination
3085 folder, where all the needed external files will be copied.
3086 * \li Origin: Lgb, 29 Jul 1997
3089 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
3091 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
3092 * \li Action: Exports the current buffer (document) from the given format using
3093 the given command on it.
3094 * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
3095 * \li Params: <FORMAT> format to start from (LyX will care to produce such
3096 intermediate file).\n
3097 <COMMAND> this command will be launched on the file. Note that you can
3098 use "$$FName" string to qualify the intermediate file.
3099 * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
3100 * \li Origin: leeming, 27 Mar 2004
3103 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
3105 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_AS
3106 * \li Action: Opens a dialog for exporting the current buffer.
3107 * \li Syntax: buffer-export-as [<FORMAT>]
3108 * \li Params: <FORMAT> is the export format initially selected in the dialog.
3109 * You can pass any of the formats which you can find in
3110 * Tools->Preferences->File formats->Format, provided it
3111 * has the "document" flag set. If no format is specified
3112 * the dialog will start with the default output format of
3113 * the current document.
3114 * \li Sample: buffer-export-as pdf2
3115 * \li Origin: tommaso, 6 Oct 2011
3118 { LFUN_BUFFER_EXPORT_AS, "buffer-export-as", ReadOnly, Buffer },
3120 * \var lyx::FuncCode lyx::LFUN_BUFFER_PRINT
3121 * \li Action: Prints the current document.
3122 * \li Notion: Many settings can be given via the preferences dialog.
3123 * \li Syntax: buffer-print <TARGET> <TARGET-NAME> <COMMAND>
3124 * \li Params: <TARGET> is either "printer" or "file".\n
3125 <TARGER-NAME> is either "default" or file name or printer name.\n
3126 <COMMAND> command ensuring the printing job.
3127 * \li Sample: buffer-print file "/trash/newfile1.ps" "dvips"
3128 * \li Origin: leeming, 28 Mar 2004
3131 { LFUN_BUFFER_PRINT, "buffer-print", ReadOnly, Buffer },
3133 * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
3134 * \li Action: Import a given file as a lyx document.
3135 * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
3136 defined converters in preferences. Look in the File->Import menu to get
3137 an idea of the currently active import formats.
3138 * \li Syntax: buffer-import <FORMAT> [<FILE>]
3139 * \li Origin: Asger, 24 Jul 1998
3142 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
3144 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
3145 * \li Action: Creates a new buffer (that is, document) and switches to it.
3146 * \li Notion: Implicit path can be set in Preferences dialog.
3147 * \li Syntax: buffer-new [<FILE>]
3148 * \li Params: <FILE>: filename of created file with absolute path.
3151 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
3153 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
3154 * \li Action: Creates a new buffer (that is, document) from a template.
3155 * \li Notion: Path for new files and templates can be set in Preferences dialog.
3156 Template will be asked for via Open-dialog.
3157 * \li Syntax: buffer-new-template [<FILE>]
3158 * \li Params: <FILE>: filename of created file with absolute path.
3161 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
3163 * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
3164 * \li Action: Reverts opened document.
3165 * \li Syntax: buffer-reload
3166 * \li Origin: Asger, 2 Feb 1997
3169 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
3171 * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
3172 * \li Action: Display and switch to the given buffer.
3173 * \li Syntax: buffer-switch <BUFFER>
3174 * \li Params: <BUFFER>: path and filename of already opened (but possibly hidden)
3175 document which is to be shown.
3178 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
3180 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
3181 * \li Action: Toggle editing mode of the current document between read/write and read-only.
3182 * \li Notion: This function is not allowed if the file is under version control, since
3183 read-only flag is often used in version control file locking.
3184 * \li Syntax: buffer-toggle-read-only
3185 * \li Origin: Lgb, 27 May 1997
3188 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
3190 * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
3191 * \li Action: Displays current buffer in chosen format.
3192 * \li Notion: Displays the contents of the current buffer in the chosen
3193 format, for example, PDF or DVI. This runs the necessary
3194 converter, calls the defined viewer, and so forth.
3195 * \li Syntax: buffer-view [<FORMAT>]
3196 * \li Params: <FORMAT>: The format to display, where this is one of the
3197 formats defined (in the current GUI) in the
3198 Tools>Preferences>File Formats dialog.
3199 If no format is given, the default format as
3200 specified in the same dialog is used.
3203 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
3205 * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
3206 * \li Action: Exports the current document and put the result into the
3207 temporary directory.
3208 * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
3209 the output will be rewritten - updated. This is useful in case your viewer
3210 is able to detect such changes (e.g. ghostview for postscript).
3211 * \li Syntax: buffer-update [<FORMAT>]
3212 * \li Params: <FORMAT>: The format to display, where this is one of the
3213 formats defined (in the current GUI) in the
3214 Tools>Preferences>File Formats dialog.
3215 If no format is given, the default format as
3216 specified in the same dialog is used.
3217 * \li Origin: Dekel, 5 Aug 2000
3220 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
3223 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
3224 * \li Action: Saves the current buffer.
3225 * \li Notion: Saves the current buffer to disk, using the filename that
3226 is already associated with the buffer, asking for one if
3227 none is yet assigned.
3228 * \li Syntax: buffer-write
3231 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
3233 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
3234 * \li Action: Rename and save current buffer.
3235 * \li Syntax: buffer-write-as <FILENAME>
3236 * \li Params: <FILENAME>: New name of the buffer/file. A relative path
3237 is with respect to the original location of the buffer/file.
3240 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
3242 * \var lyx::FuncCode lyx::LFUN_BUFFER_FORALL
3243 * \li Action: Applies a command to all non-hidden buffers.
3244 * \li Notion: a buffer is `hidden' if it is internally open in LyX, but not
3245 visible in any window.
3246 * \li Syntax: buffer-forall <LFUN-COMMAND>
3247 * \li Params: <LFUN-COMMAND>: The command to be applied to the buffers.
3248 * \li Sample: Close all Notes in buffers: \n
3249 buffer-forall inset-forall Note inset-toggle close \n
3250 Toggle change tracking on buffers: \n
3251 buffer-forall changes-track \n
3252 Toggle read-only for buffers: \n
3253 buffer-forall buffer-toggle-read-only \n
3254 Show statistics for individual buffers: \n
3255 buffer-forall statistics \n
3256 Activate the branch named "Solutions" in buffers: \n
3257 buffer-forall branch-activate Solutions \n
3258 Export buffers to PDF (pdflatex): \n
3259 buffer-forall buffer-export pdf2 \n
3260 * \li Origin: scottkostyshak, 20 Jul 2012
3263 { LFUN_BUFFER_FORALL, "buffer-forall", ReadOnly | Argument, Buffer },
3265 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
3266 * \li Action: Save all changed documents.
3267 * \li Syntax: buffer-write-all
3268 * \li Origin: rgh, gpothier 6 Aug 2007
3271 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
3273 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEXT
3274 * \li Action: Switch to the next opened document.
3275 * \li Notion: Note that this does not necessarily mean next in tabbar
3276 (for full list see View menu).
3277 * \li Syntax: buffer-next
3280 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
3282 * \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS
3283 * \li Action: Switch to the previous opened document.
3284 * \li Syntax: buffer-previous
3287 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
3289 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
3290 * \li Action: Update (export) the document built from the master buffer,
3291 if the current buffer is part of a master/child document.
3292 * \li Syntax: master-buffer-update [<FORMAT>]
3293 * \li Params: <FORMAT>: The format to display, where this is one of the
3294 formats defined (in the current GUI) in the
3295 Tools>Preferences>File Formats dialog.
3296 If no format is given, the default format as
3297 specified in the same dialog is used.
3298 * \li Origin: Tommaso, 20 Sep 2007
3301 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
3303 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
3304 * \li Action: Show a preview built from the master buffer, if available.
3305 if the current buffer is part of a master/child document.
3306 * \li Syntax: master-buffer-view [<FORMAT>]
3307 * \li Params: <FORMAT>: The format to display, where this is one of the
3308 formats defined (in the current GUI) in the
3309 Tools>Preferences>File Formats dialog.
3310 If no format is given, the default format as
3311 specified in the same dialog is used.
3312 * \li Origin: Tommaso, 20 Sep 2007
3315 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
3317 * \var lyx::FuncCode lyx::LFUN_BUFFER_LANGUAGE
3318 * \li Action: Set language of the current document.
3319 * \li Syntax: buffer-language <LANG>
3320 * \li Params: <LANG>: language name. See lib/languages for list.
3321 * \li Origin: leeming, 30 Mar 2004
3324 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
3326 * \var lyx::FuncCode lyx::LFUN_BUFFER_SAVE_AS_DEFAULT
3327 * \li Action: Save the current document settings as default.
3328 * \li Notion: The file will will be saved into ~/.lyx/templates/defaults.lyx .
3329 * \li Syntax: buffer-save-as-default [<ARGS>]
3330 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
3331 you can find in document header of usual .lyx file.
3332 * \li Origin: leeming, 30 Mar 2004
3335 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
3337 * \var lyx::FuncCode lyx::LFUN_BUFFER_PARAMS_APPLY
3338 * \li Action: Apply the given settings to the current document.
3339 * \li Syntax: buffer-params-apply [<ARGS>]
3340 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
3341 you can find in document header of usual .lyx file.
3342 * \li Origin: leeming, 30 Mar 2004
3345 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", NoInternal, Buffer },
3348 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
3349 * \li Action: Inserts another LyX file.
3350 * \li Syntax: file-insert [<FILE>]
3351 * \li Params: <FILE>: Filename to be inserted.
3354 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
3356 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
3357 * \li Action: Inserts plain text file.
3358 * \li Syntax: file-insert-plaintext [<FILE>]
3359 * \li Params: <FILE>: Filename to be inserted.
3360 * \li Origin: CFO-G, 19 Nov 1997
3363 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
3365 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
3366 * \li Action: Inserts plain text file as paragraph (i.e. join lines).
3367 * \li Syntax: file-insert-plaintext-para [<FILE>]
3368 * \li Params: <FILE>: Filename to be inserted.
3369 * \li Origin: Levon, 14 Feb 2001
3372 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
3374 * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
3375 * \li Action: Open LyX document.
3376 * \li Syntax: file-open [<FILE>]
3377 * \li Params: <FILE>: Filename to be opened.
3380 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
3383 * \var lyx::FuncCode lyx::LFUN_CALL
3384 * \li Action: Executes a command defined in a .def file.
3385 * \li Notion: The definitions are by default read from lib/commands/default.def.\n
3386 A .def file allows to define a command with \define "<NAME>" "<LFUN>"
3387 where <NAME> is the name of the new command and <LFUN> is the lfun code
3388 to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
3389 \def_file "FileName" allows to include another .def file. \n
3390 This is particularly useful in connection with toolbar buttons:
3391 Since the name of the button image for this lfun is
3392 lib/images/commands/<NAME>.png this is the way to assign an image
3393 to a complex command-sequence.
3394 * \li Syntax: call <NAME>
3395 * \li Params: <NAME>: Name of the command that must be called.
3396 * \li Origin: broider, 2 Oct 2007
3399 { LFUN_CALL, "call", NoBuffer, System },
3401 * \var lyx::FuncCode lyx::LFUN_META_PREFIX
3402 * \li Action: Simulate halting Meta key (Alt key on PCs).
3403 * \li Notion: Used for buffer edition not for GUI control.
3404 * \li Syntax: meta-prefix
3407 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
3409 * \var lyx::FuncCode lyx::LFUN_CANCEL
3410 * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
3411 * \li Syntax: cancel
3414 { LFUN_CANCEL, "cancel", NoBuffer, System },
3417 * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
3418 * \li Action: Switches the focus to the minibuffer so that the user can type
3419 in there. If necessary, it opens the minibuffer toolbar.
3420 * \li Notion: Usually bound to M-x shortcut.
3421 * \li Syntax: command-execute
3424 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
3427 * \var lyx::FuncCode lyx::LFUN_COMMAND_PREFIX
3428 * \li Action: Return the current key sequence and available options as a string.
3429 * \li Notion: No options are added if no current map exists. \n
3430 This is probably usable only with connection to lyxserver.
3431 * \li Syntax: command-prefix
3434 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
3436 * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
3437 * \li Action: Run more commands (LFUN and its parameters) in a sequence.
3438 * \li Syntax: command-sequence <CMDS>
3439 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
3440 * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
3441 * \li Origin: Andre, 11 Nov 1999
3444 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
3446 * \var lyx::FuncCode lyx::LFUN_COMMAND_ALTERNATIVES
3447 * \li Action: Runs the first listed command that is enabled.
3448 * \li Notion: This can be used to bind multiple functions to a single key,
3449 and then which one is used will depend upon the context.
3450 * \li Syntax: command-alternatives <CMDS>
3451 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
3452 * \li Sample: command-alternatives completion-accept;cell-forward
3453 * \li Origin: rgh, 24 September 2008
3456 { LFUN_COMMAND_ALTERNATIVES, "command-alternatives", NoBuffer, System },
3458 * \var lyx::FuncCode lyx::LFUN_MESSAGE
3459 * \li Action: Shows message in statusbar (for script purposes).
3460 * \li Syntax: message <STRING>
3461 * \li Origin: Lgb, 8 Apr 2001
3464 { LFUN_MESSAGE, "message", NoBuffer, System },
3466 * \var lyx::FuncCode lyx::LFUN_DEBUG_LEVEL_SET
3467 * \li Action: Set debug output level.
3468 * \li Syntax: debug-level-set <LEVEL>
3469 * \li Params: <LEVEL>: comma separated list of levels or the correspondent number
3470 of their combination. 0 is equivalent to disabling all debug
3471 events. See lyx -dbg for the current list of debug levels
3473 * \li Origin: sanda, 28 Dec 2009
3476 { LFUN_DEBUG_LEVEL_SET, "debug-level-set", NoBuffer, System },
3479 * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
3480 * \li Action: Save user preferences.
3481 * \li Syntax: preferences-save
3482 * \li Origin: Lgb, 27 Nov 1999
3485 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
3487 * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
3488 * \li Action: Reconfigure the automatic settings.
3489 * \li Syntax: reconfigure
3490 * \li Origin: Asger, 14 Feb 1997
3493 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
3495 * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
3496 * \li Action: Apply the given settings to user preferences.
3497 * \li Syntax: lyxrc-apply <SETTINGS>
3498 * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
3499 to get an idea which commands to use and their syntax.
3500 #lyx::LyXRC::LyXRCTags has the list of possible commands.
3503 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
3505 * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
3506 * \li Action: Determine whether to keep cursor inside the editing window regardless
3507 of the scrollbar movement.
3508 * \li Syntax: toggle-cursor-follows-scrollbar
3509 * \li Origin: ARRae, 2 Dec 1997
3512 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
3514 * \var lyx::FuncCode lyx::LFUN_SET_COLOR
3515 * \li Action: Set the given LyX color to the color defined by the X11 name given.
3516 * \li Notion: A new color entry is created if the color is unknown.
3517 Color names can be stored as a part of user settings.
3518 * \li Syntax: set-color <LYX_NAME> <X11_NAME>
3519 * \li Origin: SLior, 11 Jun 2000
3522 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
3524 * \var lyx::FuncCode lyx::LFUN_STATISTICS
3525 * \li Action: Count the statistics (number of words and characters)
3526 in the document or in the given selection and display it
3528 * \li Notion: Note that this function gives the number of words/chars written,
3529 not the number of characters which will be typeset.
3530 * \li Syntax: statistics
3531 * \li Origin: lasgouttes, Jan 27 2004; sanda, Jan 8 2008
3534 { LFUN_STATISTICS, "statistics", ReadOnly, System },
3536 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_STATISTICS
3537 * \li Action: Returns the statistics (number of words and characters)
3538 in the document or in the given selection.
3539 * \li Notion: Note that this function gives the number of words/chars written,
3540 not the number of characters which will be typeset.
3541 * \li Syntax: server-get-statistics [<TYPE>]
3542 * \li Params: <TYPE>: <words|chars|chars-space> The requested count; if not
3543 specified, the three values are returned, separated
3545 words: count words.\n
3546 chars: count characters.\n
3547 chars-space: count characters and spaces.
3548 * \li Origin: brokenclock, Oct 10 2014
3551 { LFUN_SERVER_GET_STATISTICS, "server-get-statistics", ReadOnly, System },
3553 * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
3554 * \li Action: Show the inline completion at the cursor position.
3555 * \li Syntax: completion-inline
3556 * \li Origin: sts, Feb 19 2008
3559 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
3561 * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
3562 * \li Action: Show the completion popup at the cursor position.
3563 * \li Syntax: completion-popup
3564 * \li Origin: sts, Feb 19 2008
3567 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
3569 * \var lyx::FuncCode lyx::LFUN_COMPLETE
3570 * \li Action: Try to complete the word or command at the cursor position.
3571 * \li Syntax: complete
3572 * \li Origin: sts, Feb 19 2008
3575 { LFUN_COMPLETE, "complete", SingleParUpdate, Edit },
3578 * \var lyx::FuncCode lyx::LFUN_COMPLETION_CANCEL
3579 * \li Action: Try to cancel completion, either the popup or the inline completion.
3580 * \li Syntax: completion-cancel
3581 * \li Origin: sts, Sep 07 2008
3584 { LFUN_COMPLETION_CANCEL, "completion-cancel", SingleParUpdate, Edit },
3586 * \var lyx::FuncCode lyx::LFUN_COMPLETION_ACCEPT
3587 * \li Action: Accept suggested completion.
3588 * \li Syntax: completion-accept
3589 * \li Origin: sanda, Sep 08 2008
3592 { LFUN_COMPLETION_ACCEPT, "completion-accept", SingleParUpdate, Edit },
3596 * \var lyx::FuncCode lyx::LFUN_BRANCH_ADD
3597 * \li Action: Add a branch to the buffer's BranchList.
3598 * \li Syntax: branch-add <BRANCH>
3599 * \li Params: <BRANCH>: Name of the branch to add
3600 * \li Origin: spitz, 7 Jul 2009
3603 { LFUN_BRANCH_ADD, "branch-add", AtPoint, Buffer },
3607 * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
3608 * \li Action: Activate the branch.
3609 * \li Syntax: branch-activate <BRANCH>
3610 * \li Params: <BRANCH>: The branch to activate
3611 * \li Sample: lyx -x "branch-activate answers" -e pdf2 finalexam.lyx \n
3612 could be used to export a pdf with the answers branch included
3613 without one's having to open LyX and activate the branch manually.
3614 * \li Origin: rgh, 27 May 2008
3617 { LFUN_BRANCH_ACTIVATE, "branch-activate", AtPoint, Buffer },
3619 * \var lyx::FuncCode lyx::LFUN_BRANCH_DEACTIVATE
3620 * \li Action: De-activate the branch.
3621 * \li Syntax: branch-deactivate <BRANCH>
3622 * \li Params: <BRANCH>: The branch to deactivate
3623 * \li Origin: rgh, 27 May 2008
3626 { LFUN_BRANCH_DEACTIVATE, "branch-deactivate", AtPoint, Buffer },
3628 * \var lyx::FuncCode lyx::LFUN_BRANCH_MASTER_ACTIVATE
3629 * \li Action: Activate the branch in the master buffer.
3630 * \li Syntax: branch-master-activate <BRANCH>
3631 * \li Params: <BRANCH>: The branch to activate
3632 * \li Sample: lyx -x "branch-activate answers" -e pdf2 finalexam.lyx \n
3633 could be used to export a pdf with the answers branch included
3634 without one's having to open LyX and activate the branch manually.
3635 * \li Origin: spitz, 30 Sep 2012
3638 { LFUN_BRANCH_MASTER_ACTIVATE, "branch-master-activate", AtPoint, Buffer },
3640 * \var lyx::FuncCode lyx::LFUN_BRANCH_MASTER_DEACTIVATE
3641 * \li Action: De-activate the branch in the master buffer.
3642 * \li Syntax: branch-master-deactivate <BRANCH>
3643 * \li Params: <BRANCH>: The branch to deactivate
3644 * \li Origin: spitz, 30 Sep 2012
3647 { LFUN_BRANCH_MASTER_DEACTIVATE, "branch-master-deactivate", AtPoint, Buffer },
3650 * \var lyx::FuncCode lyx::LFUN_BRANCHES_RENAME
3651 * \li Action: Rename all branches of a given name in a document.
3652 * \li Syntax: branches-rename <OLDNAME> <NEWNAME>
3653 * \li Params: <OLDNAME>: Current name of the branch to be renamed
3654 * <NEWNAME>: New name of the branch
3655 * \li Origin: spitz, 9 Jul 2009
3658 { LFUN_BRANCHES_RENAME, "branches-rename", Noop, Buffer },
3660 * \var lyx::FuncCode lyx::LFUN_BRANCH_ADD_INSERT
3661 * \li Action: Create new branch and directly put the branch inset into
3663 * \li Syntax: branch-add-insert [<NAME>]
3664 * \li Params: <NAME>: Branch name. If it is not specified, you will be asked.
3665 * \li Origin: sanda, 10 Jul 2009
3668 { LFUN_BRANCH_ADD_INSERT, "branch-add-insert", Noop, Buffer },
3672 * \var lyx::FuncCode lyx::LFUN_LABEL_COPY_AS_REF
3673 * \li Action: Copies the label at the cursor as a cross-reference to be pasted elsewhere.
3674 * \li Syntax: copy-label-as-reference <LABEL>
3675 * \li Params: <LABEL>: The label to copy (for multi-line math)
3676 * \li Origin: sts, 16 Nov 2008
3679 { LFUN_LABEL_COPY_AS_REFERENCE, "label-copy-as-reference",
3680 ReadOnly | NoUpdate | AtPoint, Edit },
3683 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT_AS_REFERENCE
3684 * \li Action: Inserts the label (in ToC pane) as a cross-reference at the position of the cursor.
3685 * \li Syntax: label-insert-as-reference
3686 * \li Origin: vfr, 7 Apr 2009
3689 { LFUN_LABEL_INSERT_AS_REFERENCE, "label-insert-as-reference", Noop, Edit},
3692 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_IN
3693 * \li Action: Increases the zoom of the screen fonts.
3694 * \li Syntax: buffer-zoom-in [<ZOOM>]
3695 * \li Params: <ZOOM>: The zoom in %, the default is 20.
3696 * \li Origin: vfr, 30 Mar 2009
3699 { LFUN_BUFFER_ZOOM_IN, "buffer-zoom-in", ReadOnly, Buffer },
3702 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_OUT
3703 * \li Action: Decreases the zoom of the screen fonts.
3704 * \li Syntax: buffer-zoom-out [<ZOOM>]
3705 * \li Params: <ZOOM>: The zoom in %, the default is 20.
3706 * \li Origin: vfr, 30 Mar 2009
3709 { LFUN_BUFFER_ZOOM_OUT, "buffer-zoom-out", ReadOnly, Buffer },
3712 * \var lyx::FuncCode lyx::LFUN_INSET_COPY_AS
3713 * \li Action: Copies the inset to the clipboard as a certain type.
3714 * \li Notion: Currently used only for InsetInfo where its content is copied as a text.
3715 * \li Syntax: inset-copy-as
3716 * \li Origin: vfr, 18 Apr 2010
3719 { LFUN_INSET_COPY_AS, "inset-copy-as", ReadOnly | NoUpdate | AtPoint, Edit },
3722 * \var lyx::FuncCode lyx::LFUN_ENVIRONMENT_SPLIT
3723 * \li Action: Splits the current environment with a Separator.
3724 * \li Syntax: environment-split [outer]
3725 * \li Params: outer: If this is given, LyX will split the outermost environment in
3726 * the current nesting hierarchy.
3727 * \li Origin: spitz, 23 Dec 2012
3730 { LFUN_ENVIRONMENT_SPLIT, "environment-split", Noop, Layout },
3732 { LFUN_NOACTION, "", Noop, Hidden }
3733 #ifndef DOXYGEN_SHOULD_SKIP_THIS
3736 for (int i = 0; items[i].action != LFUN_NOACTION; ++i)
3737 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
3743 LyXAction::LyXAction()
3749 FuncRequest LyXAction::lookupFunc(string const & func) const
3751 string const func2 = trim(func);
3754 return FuncRequest(LFUN_NOACTION);
3757 string const arg = split(func2, cmd, ' ');
3759 FuncMap::const_iterator const fit = lyx_func_map.find(cmd);
3761 return fit != lyx_func_map.end()
3762 ? FuncRequest(fit->second, arg)
3763 : FuncRequest(LFUN_UNKNOWN_ACTION);
3767 string const LyXAction::getActionName(FuncCode action) const
3769 InfoMap::const_iterator const it = lyx_info_map.find(action);
3770 return it != lyx_info_map.end() ? it->second.name : string();
3774 LyXAction::FuncType LyXAction::getActionType(FuncCode action) const
3776 InfoMap::const_iterator const it = lyx_info_map.find(action);
3777 return it != lyx_info_map.end() ? it->second.type : Hidden;
3781 bool LyXAction::funcHasFlag(FuncCode action,
3782 LyXAction::FuncAttribs flag) const
3784 InfoMap::const_iterator ici = lyx_info_map.find(action);
3786 if (ici == lyx_info_map.end()) {
3787 LYXERR0("action: " << action << " is not known.");
3788 LASSERT(false, return false);
3791 return ici->second.attrib & flag;
3795 LyXAction::const_iterator LyXAction::func_begin() const
3797 return lyx_func_map.begin();
3801 LyXAction::const_iterator LyXAction::func_end() const
3803 return lyx_func_map.end();
3807 LyXErr & operator<<(LyXErr & l, FuncCode code)
3810 l.stream() << lyxaction.getActionName(code);