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.
63 * \var lyx::FuncCode lyx::LFUN_
76 void LyXAction::newFunc(FuncCode action, string const & name,
77 unsigned int attrib, LyXAction::FuncType type)
79 lyx_func_map[name] = action;
82 tmpinfo.attrib = attrib;
84 lyx_info_map[action] = tmpinfo;
88 // Needed for LFUNs documentation to be accepted, since doxygen won't take
89 // \var inside functions.
90 #ifndef DOXYGEN_SHOULD_SKIP_THIS
91 void LyXAction::init()
93 // This function was changed to use the array below in initalization
94 // instead of calling newFunc numerous times because of compilation
95 // times. Since the array is not static we get back the memory it
96 // occupies after the init is completed. It compiles several
110 ev_item const items[] = {
113 * \var lyx::FuncCode lyx::LFUN_ACCENT_ACUTE
114 * \li Action: Adds an acute accent \htmlonly (á)\endhtmlonly
115 to the next character typed.
116 * \li Syntax: accent-acute
119 { LFUN_ACCENT_ACUTE, "accent-acute", Noop, Edit },
121 * \var lyx::FuncCode lyx::LFUN_ACCENT_BREVE
122 * \li Action: Adds a breve accent \htmlonly (ă)\endhtmlonly
123 to the next character typed.
124 * \li Syntax: accent-breve
127 { LFUN_ACCENT_BREVE, "accent-breve", Noop, Edit },
129 * \var lyx::FuncCode lyx::LFUN_ACCENT_CARON
130 * \li Action: Adds a caron \htmlonly (ǎ)\endhtmlonly
131 to the next character typed.
132 * \li Syntax: accent-caron
135 { LFUN_ACCENT_CARON, "accent-caron", Noop, Edit },
137 * \var lyx::FuncCode lyx::LFUN_ACCENT_CEDILLA
138 * \li Action: Adds a cedilla \htmlonly (ç)\endhtmlonly
139 to the next character typed.
140 * \li Syntax: accent-cedilla
143 { LFUN_ACCENT_CEDILLA, "accent-cedilla", Noop, Edit },
145 * \var lyx::FuncCode lyx::LFUN_ACCENT_CIRCLE
146 * \li Action: Adds a circle accent \htmlonly (å)\endhtmlonly
147 to the next character typed.
148 * \li Syntax: accent-circle
151 { LFUN_ACCENT_CIRCLE, "accent-circle", Noop, Edit },
153 * \var lyx::FuncCode lyx::LFUN_ACCENT_CIRCUMFLEX
154 * \li Action: Adds a circumflex \htmlonly (ê)\endhtmlonly
155 to the next character typed.
156 * \li Syntax: accent-circumflex
159 { LFUN_ACCENT_CIRCUMFLEX, "accent-circumflex", Noop, Edit },
161 * \var lyx::FuncCode lyx::LFUN_ACCENT_DOT
162 * \li Action: Adds a dot accent \htmlonly (ż)\endhtmlonly
163 to the next character typed.
164 * \li Syntax: accent-dot
167 { LFUN_ACCENT_DOT, "accent-dot", Noop, Edit },
169 * \var lyx::FuncCode lyx::LFUN_ACCENT_GRAVE
170 * \li Action: Adds a grave accent \htmlonly (è)\endhtmlonly
171 to the next character typed.
172 * \li Syntax: accent-grave
175 { LFUN_ACCENT_GRAVE, "accent-grave", Noop, Edit },
177 * \var lyx::FuncCode lyx::LFUN_ACCENT_HUNGARIAN_UMLAUT
178 * \li Action: Adds a Hungarian umlaut \htmlonly (ő)\endhtmlonly
179 to the next character typed.
180 * \li Syntax: accent-grave
183 { LFUN_ACCENT_HUNGARIAN_UMLAUT, "accent-hungarian-umlaut", Noop, Edit },
185 * \var lyx::FuncCode lyx::LFUN_ACCENT_MACRON
186 * \li Action: Adds a macron \htmlonly (ā)\endhtmlonly
187 to the next character typed.
188 * \li Syntax: accent-macron
191 { LFUN_ACCENT_MACRON, "accent-macron", Noop, Edit },
193 * \var lyx::FuncCode lyx::LFUN_ACCENT_OGONEK
194 * \li Action: Adds an ogonek accent \htmlonly (ą)\endhtmlonly
195 to the next character typed.
196 * \li Syntax: accent-ogonek
199 { LFUN_ACCENT_OGONEK, "accent-ogonek", Noop, Edit },
201 * \var lyx::FuncCode lyx::LFUN_ACCENT_TIE
202 * \li Action: Adds a tie \htmlonly (a͡)\endhtmlonly
203 over the next two character typed.
204 * \li Notion: The following char will finish the tie.
205 * \li Syntax: accent-tie
208 { LFUN_ACCENT_TIE, "accent-tie", Noop, Edit },
210 * \var lyx::FuncCode lyx::LFUN_ACCENT_TILDE
211 * \li Action: Adds a tilde \htmlonly (ã)\endhtmlonly
212 over the next character typed.
213 * \li Syntax: accent-tilde
216 { LFUN_ACCENT_TILDE, "accent-tilde", Noop, Edit },
218 * \var lyx::FuncCode lyx::LFUN_ACCENT_UMLAUT
219 * \li Action: Adds an umlaut \htmlonly (ä)\endhtmlonly
220 over the next character typed.
221 * \li Syntax: accent-umlaut
224 { LFUN_ACCENT_UMLAUT, "accent-umlaut", Noop, Edit },
226 * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERBAR
227 * \li Action: Adds a bar \htmlonly (a̠)\endhtmlonly
228 under the next character typed.
229 * \li Syntax: accent-underbar
232 { LFUN_ACCENT_UNDERBAR, "accent-underbar", Noop, Edit },
234 * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERDOT
235 * \li Action: Adds a dot \htmlonly (ạ)\endhtmlonly
236 under the next character typed.
237 * \li Syntax: accent-underdot
240 { LFUN_ACCENT_UNDERDOT, "accent-underdot", Noop, Edit },
243 * \var lyx::FuncCode lyx::LFUN_CAPTION_INSERT
244 * \li Action: Inserts a caption inset.
245 * \li Syntax: caption-insert
246 * \li Origin: Lgb, 18 Jul 2000
249 { LFUN_CAPTION_INSERT, "caption-insert", Noop, Edit },
251 * \var lyx::FuncCode lyx::LFUN_DATE_INSERT
252 * \li Action: Inserts the current date.
253 * \li Syntax: date-insert [<ARG>]
254 * \li Params: <ARG>: Format of date. The default value (%x) can be set
255 in Preferences->Date format. For possible formats
256 see manual page of strftime function.
257 * \li Origin: jdblair, 31 Jan 2000
260 { LFUN_DATE_INSERT, "date-insert", Noop, Edit },
262 * \var lyx::FuncCode lyx::LFUN_FOOTNOTE_INSERT
263 * \li Action: Inserts a footnote inset.
264 * \li Syntax: footnote-insert
265 * \li Origin: Jug, 7 Mar 2000
268 { LFUN_FOOTNOTE_INSERT, "footnote-insert", Noop, Edit },
270 * \var lyx::FuncCode lyx::LFUN_ERT_INSERT
271 * \li Action: Inserts an ERT inset.
272 * \li Syntax: ert-insert
273 * \li Origin: Jug, 18 Feb 2000
276 { LFUN_ERT_INSERT, "ert-insert", Noop, Edit },
278 * \var lyx::FuncCode lyx::LFUN_FLOAT_INSERT
279 * \li Action: Inserts a float inset.
280 * \li Syntax: float-insert <TYPE>
281 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
282 "algorithm", "table", "figure" parameters can be given.
283 * \li Origin: Lgb, 27 Jun 2000
286 { LFUN_FLOAT_INSERT, "float-insert", Noop, Edit },
288 * \var lyx::FuncCode lyx::LFUN_FLOAT_WIDE_INSERT
289 * \li Action: Inserts float insets as in #LFUN_FLOAT_INSERT but span multiple columns.
290 * \li Notion: Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
291 * \li Syntax: float-wide-insert <TYPE>
292 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
293 "algorithm", "table", "figure" parameters can be given.
294 * \li Origin: Lgb, 31 Oct 2001
297 { LFUN_FLOAT_WIDE_INSERT, "float-wide-insert", Noop, Edit },
299 * \var lyx::FuncCode lyx::LFUN_FLOAT_LIST_INSERT
300 * \li Action: Inserts the list of floats in the document.
301 * \li Syntax: float-list-insert <TYPE>
302 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
303 "algorithm", "table", "figure" parameters can be given.
304 * \li Origin: Lgb, 3 May 2001
307 { LFUN_FLOAT_LIST_INSERT, "float-list-insert", Noop, Edit },
309 * \var lyx::FuncCode lyx::LFUN_WRAP_INSERT
310 * \li Action: Inserts floats wrapped by the text around.
311 * \li Syntax: wrap-insert <TYPE>
312 * \li Params: <TYPE>: table|figure
313 * \li Origin: Dekel, 7 Apr 2002
316 { LFUN_WRAP_INSERT, "wrap-insert", Noop, Edit },
318 * \var lyx::FuncCode lyx::LFUN_OPTIONAL_INSERT
319 * \li Action: Inserts an optional-argument (short title) inset.
320 * \li Syntax: optional-insert
321 * \li Origin: vermeer, 12 Aug 2002
324 { LFUN_OPTIONAL_INSERT, "optional-insert", Noop, Edit },
326 * \var lyx::FuncCode lyx::LFUN_LINE_INSERT
327 * \li Action: Inserts a horizontal line.
328 * \li Syntax: line-insert
329 * \li Origin: Andre, Oct 27 2003
332 { LFUN_LINE_INSERT, "line-insert", Noop, Edit },
334 * \var lyx::FuncCode lyx::LFUN_NEWPAGE_INSERT
335 * \li Action: Inserts a new page.
336 * \li Syntax: newpage-insert <ARG>
337 * \li Params: <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
338 * \li Origin: uwestoehr, 24 Nov 2007
341 { LFUN_NEWPAGE_INSERT, "newpage-insert", Noop, Edit },
343 * \var lyx::FuncCode lyx::LFUN_MARGINALNOTE_INSERT
344 * \li Action: Inserts a marginal note.
345 * \li Syntax: marginalnote-insert
346 * \li Origin: Lgb, 26 Jun 2000
349 { LFUN_MARGINALNOTE_INSERT, "marginalnote-insert", Noop, Edit },
351 * \var lyx::FuncCode lyx::LFUN_UNICODE_INSERT
352 * \li Action: Inserts a single unicode character.
353 * \li Syntax: unicode-insert <CHAR>
354 * \li Params: <CHAR>: The character to insert, given as its code
355 point, in hexadecimal.
356 * \li Sample: unicode-insert 0x0100
357 * \li Origin: Lgb, 22 Oct 2006
360 { LFUN_UNICODE_INSERT, "unicode-insert", Noop, Edit },
362 * \var lyx::FuncCode lyx::LFUN_LISTING_INSERT
363 * \li Action: Inserts a new listings inset.
364 * \li Syntax: listing-insert
365 * \li Origin: Herbert, 10 Nov 2001; bpeng, 2 May 2007
368 { LFUN_LISTING_INSERT, "listing-insert", Noop, Edit },
370 * \var lyx::FuncCode lyx::LFUN_TAB_INSERT
371 * \li Action: Insert a tab into a listings inset.
372 * \li Notion: It also works on a selection.
373 * \li Syntax: tab-insert
374 * \li Origin: vfr, Sep 30 2008
377 { LFUN_TAB_INSERT, "tab-insert", SingleParUpdate, Edit },
379 * \var lyx::FuncCode lyx::LFUN_TAB_DELETE
380 * \li Action: Delete a tab or up to an equivalent amount of spaces from
382 * \li Notion: It also works on a selection - it removes a tab or spaces from the
383 beginning of each line spanned by the selection. This is useful if
384 you want to indent/unindent multiple lines in one action.
385 * \li Syntax: tab-delete
386 * \li Origin: vfr, Sep 30 2008
389 { LFUN_TAB_DELETE, "tab-delete", SingleParUpdate, Edit },
391 * \var lyx::FuncCode lyx::LFUN_QUOTE_INSERT
392 * \li Action: Inserts quotes according to the type and quote-language preference.
393 * \li Notion: Currently English, Swedish, German, Polish, French, Danish quotes
395 * \li Syntax: quote-insert [<TYPE>]
396 * \li Params: <TYPE>: 'single' for single quotes, otherwise double quotes will be used.
399 { LFUN_QUOTE_INSERT, "quote-insert", Noop, Edit },
401 * \var lyx::FuncCode lyx::LFUN_INFO_INSERT
402 * \li Action: Displays shortcuts, lyxrc, package and textclass availability and menu
403 information in a non-editable boxed InsetText.
404 * \li Notion: Apart from lfun arguments you can use the following method: \n
405 1. input the type and argument of this inset, e.g. "menu paste", in
407 2. select the text and run info-insert lfun.
408 * \li Syntax: info-insert <TYPE> <ARG>
409 * \li Params: <TYPE>: shortcut[s]|lyxrc|package|textclass|menu|buffer \n
410 <ARG>: argument for a given type. Look into InsetInfo.h for detailed
412 shortcut[s]: name of lfun (e.g math-insert \alpha) \n
413 lyxrc: name of rc_entry (e.g. bind_file) \n
414 package: name of latex package (e.g. listings) \n
415 textclass: name of textclass (e.g. article) \n
416 menu: name of lfun used in menu \n
417 icon: name of lfun used in toolbar \n
418 buffer: "name"|"path"|"class"|"vcs-revision"|"vcs-tree-revision"
419 * \li Sample: command-sequence info-insert buffer path; info-insert buffer name
420 * \li Origin: bpeng, 7 Oct 2007
423 { LFUN_INFO_INSERT, "info-insert", Noop, Edit },
425 * \var lyx::FuncCode lyx::LFUN_BRANCH_INSERT
426 * \li Action: Inserts branch inset.
427 * \li Syntax: branch-insert <BRANCH-NAME>
428 * \li Origin: vermeer, 17 Aug 2003
431 { LFUN_BRANCH_INSERT, "branch-insert", Noop, Edit },
433 * \var lyx::FuncCode lyx::LFUN_BOX_INSERT
434 * \li Action: Inserts Box inset.
435 * \li Syntax: box-insert [<TYPE>]
436 * \li Params: <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox \n
437 Framed is the default one.
438 * \li Origin: vermeer, 7 Oct 2003
441 { LFUN_BOX_INSERT, "box-insert", Noop, Edit },
443 * \var lyx::FuncCode lyx::LFUN_FLEX_INSERT
444 * \li Action: Inserts CharStyle, Custom inset or XML short element.
445 * \li Notion: Look into the Customization manual for more information about
447 To make this command enabled the layout file for the document
448 class you're using has to load the character styles. There are
449 a few contained in the Logical Markup module. You can also of
450 course create some yourself. \n
451 For dissolving the element see #LFUN_INSET_DISSOLVE.
452 * \li Syntax: flex-insert <TYPE:Name>
453 * \li Params: TYPE: CharStyle|Custom|Element|Standard \n
454 Identifies whether this is a Character Style, a
455 Custom Inset or an XML Element, and which dynamical
456 sub-menu this flex inset is in on the LyX menu tree.
457 If Standard (currently unused): none of these.\n
458 Name: This name must be defined either in your layout file
459 or imported by some module. The definition is
460 InsetLayout <TYPE:Name>
461 * \li Sample: flex-insert CharStyle:Code
464 { LFUN_FLEX_INSERT, "flex-insert", Noop, Edit },
466 * \var lyx::FuncCode lyx::LFUN_SELF_INSERT
467 * \li Action: Inserts the given string (accordingly to the correct keymap).
468 * \li Notion: Automatically replace the currently selected text. Depends on lyxrc
469 settings "auto_region_delete".
470 * \li Syntax: self-insert <STRING>
473 { LFUN_SELF_INSERT, "self-insert", SingleParUpdate, Hidden },
475 * \var lyx::FuncCode lyx::LFUN_SPACE_INSERT
476 * \li Action: Inserts one of horizontal space insets.
477 * \li Syntax: space-insert <NAME> [<LEN>]
478 * \li Params: <NAME>: normal, protected, thin, quad, qquad, enspace, enskip,
479 negthinspace, hfill, hfill*, dotfill, hrulefill, hspace,
481 <LEN>: length for custom spaces (hspace, hspace* for protected)
482 * \li Origin: JSpitzm, 20 May 2003, Mar 17 2008
485 { LFUN_SPACE_INSERT, "space-insert", Noop, Edit },
487 * \var lyx::FuncCode lyx::LFUN_HYPERLINK_INSERT
488 * \li Action: Inserts hyperlinks into the document (clickable in pdf output).
489 * \li Notion: Hyperlink target can be set via selection + hyperlink-insert function.
490 * \li Syntax: href-insert [<TARGET>]
491 * \li Origin: CFO-G, 21 Nov 1997
494 { LFUN_HYPERLINK_INSERT, "href-insert", Noop, Edit },
496 * \var lyx::FuncCode lyx::LFUN_SPECIALCHAR_INSERT
497 * \li Action: Inserts various characters into the document.
498 * \li Syntax: specialchar-insert <CHAR>
499 * \li Params: <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots,
500 end-of-sentence, menu-separator.
501 * \li Origin: JSpitzm, 6 Dec 2007
504 { LFUN_SPECIALCHAR_INSERT, "specialchar-insert", Noop, Edit },
506 * \var lyx::FuncCode lyx::LFUN_TOC_INSERT
507 * \li Action: Inserts table of contents.
508 * \li Syntax: toc-insert
509 * \li Origin: Lgb, 27 May 97
512 { LFUN_TOC_INSERT, "toc-insert", Noop, Edit },
514 * \var lyx::FuncCode lyx::LFUN_APPENDIX
515 * \li Action: Start (or remove) Appendix on the given cursor position.
516 * \li Syntax: appendix
517 * \li Origin: ettrich, 5 May 1998
520 { LFUN_APPENDIX, "appendix", Noop, Edit },
523 * \var lyx::FuncCode lyx::LFUN_INDEX_INSERT
524 * \li Action: Inserts Index entry.
525 * \li Notion: It automatically takes the word on the cursor position.
526 * \li Syntax: index-insert [<TYPE:Name>]
527 * \li Params: <TYPE:Name>: name of the index, if multiple indices are defined.
528 with an empty argument, the default index is selected.
529 * \li Origin: leeming, 3 Aug 2000
532 { LFUN_INDEX_INSERT, "index-insert", Noop, Edit },
534 * \var lyx::FuncCode lyx::LFUN_INDEX_PRINT
535 * \li Action: Inserts list of Index entries on a new page.
536 * \li Syntax: index-print [<TYPE:Name>]
537 * \li Params: <TYPE:Name>: name of the index, if multiple indices are defined.
538 with an empty argument, the default index is selected.
539 * \li Origin: Lgb, 27 Feb 1997
542 { LFUN_INDEX_PRINT, "index-print", Noop, Edit },
545 * \var lyx::FuncCode lyx::LFUN_NOMENCL_INSERT
546 * \li Action: Inserts Nomenclature entry.
547 * \li Notion: It automatically takes the word on the cursor position if no symbol is given.
548 * \li Syntax: nomencl-insert [<SYMBOL>]
549 * \li Origin: Ugras, 4 Nov 2006
552 { LFUN_NOMENCL_INSERT, "nomencl-insert", Noop, Edit },
554 * \var lyx::FuncCode lyx::LFUN_NOMENCLATURE_PRINT
555 * \li Action: Inserts list of Nomenclature entries.
556 * \li Syntax: nomenclature-print
557 * \li Origin: Ugras, 4 Nov 2006
560 { LFUN_NOMENCL_PRINT, "nomencl-print", Noop, Edit },
563 * \var lyx::FuncCode lyx::LFUN_NOTE_INSERT
564 * \li Action: Inserts Note on the current cursor postion,
565 move selection inside the inset.
566 * \li Syntax: note-insert [<TYPE>]
567 * \li Params: <TYPE>: <Note|Greyedout|Comment> default: Note
570 { LFUN_NOTE_INSERT, "note-insert", Noop, Edit },
572 * \var lyx::FuncCode lyx::LFUN_NOTE_NEXT
573 * \li Action: Moves the cursor to the begining of next Note inset.
574 * \li Syntax: note-next
577 { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
579 * \var lyx::FuncCode lyx::LFUN_PHANTOM_INSERT
580 * \li Action: Inserts phantom on the current cursor postion,
581 move selection inside the inset.
582 * \li Syntax: phantom-insert [<TYPE>]
583 * \li Params: <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
584 * \li Origin: uwestoehr, 30 Jan 2009
587 { LFUN_PHANTOM_INSERT, "phantom-insert", Noop, Edit },
589 * \var lyx::FuncCode lyx::LFUN_NEWLINE_INSERT
590 * \li Action: Inserts a line break or new line.
591 * \li Syntax: newline-insert [<ARG>]
592 * \li Params: <ARG>: <newline|linebreak> default: newline
593 * \li Origin: JSpitzm, 25 Mar 2008
596 { LFUN_NEWLINE_INSERT, "newline-insert", Noop, Edit },
598 * \var lyx::FuncCode lyx::LFUN_ESCAPE
599 * \li Action: Clears the selection. If no text is selected call #LFUN_FINISHED_FORWARD.
601 * \li Origin: Lgb, 17 May 2001
604 { LFUN_ESCAPE, "escape", ReadOnly, Edit },
606 * \var lyx::FuncCode lyx::LFUN_DOWN
607 * \li Action: Moves the cursor one line in downward direction.
611 { LFUN_DOWN, "down", ReadOnly | NoUpdate, Edit },
613 * \var lyx::FuncCode lyx::LFUN_UP
614 * \li Action: Moves the cursor one line in upward direction.
618 { LFUN_UP, "up", ReadOnly | NoUpdate, Edit },
620 * \var lyx::FuncCode lyx::LFUN_DOWN_SELECT
621 * \li Action: Moves the cursor one line in downward direction adding the current
622 position to the selection.
623 * \li Syntax: down-select
626 { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, Edit },
628 * \var lyx::FuncCode lyx::LFUN_UP_SELECT
629 * \li Action: Moves the cursor one line in upward direction adding the current
630 position to the selection.
631 * \li Syntax: up-select
634 { LFUN_UP_SELECT, "up-select", ReadOnly | SingleParUpdate, Edit },
636 * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN
637 * \li Action: Moves the cursor one page in downward direction.
638 * \li Syntax: screen-down
641 { LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit },
643 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP
644 * \li Action: Moves the cursor one page in upward direction.
645 * \li Syntax: screen-up
648 { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit },
650 * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN_SELECT
651 * \li Action: Moves the cursor one screen in downward direction adding the current
652 position to the selection.
653 * \li Syntax: screen-down-select
656 { LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit },
658 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP_SELECT
659 * \li Action: Moves the cursor one page in upward direction adding the current
660 position to the selection.
661 * \li Syntax: screen-up-select
664 { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit },
666 * \var lyx::FuncCode lyx::LFUN_SCROLL
667 * \li Action: Scroll the buffer view.
668 * \li Notion: Only scrolls the screen up or down; does not move the cursor.
669 * \li Syntax: scroll <TYPE> <QUANTITY>
670 * \li Params: <TYPE>: line|page\n
671 <QUANTITY>: up|down|<number>
672 * \li Origin: Abdel, Dec 27 2007
675 { LFUN_SCROLL, "scroll", ReadOnly, Edit },
677 * \var lyx::FuncCode lyx::LFUN_SCREEN_RECENTER
678 * \li Action: Recenters the screen on the current cursor position.
679 * \li Syntax: screen-recenter
682 { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit },
685 * \var lyx::FuncCode lyx::LFUN_SCREEN_SHOW_CURSOR
686 * \li Action: Repositions the screen such that the cursor is visible.
687 * \li Syntax: screen-show-cursor
688 * \li Origin: vfr, 25 Mar 2009
691 { LFUN_SCREEN_SHOW_CURSOR, "screen-show-cursor", ReadOnly, Edit },
694 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD
695 * \li Action: Moves the cursor one position logically backwards.
696 * \li Notion: This is not the action which should be bound to the arrow keys,
697 because backwards may be left or right, depending on the
698 language. The arrow keys should be bound to #LFUN_CHAR_LEFT or
699 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
700 * \li Syntax: char-backward
703 { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit },
705 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD_SELECT
706 * \li Action: Moves the cursor one position logically backwards, adding
707 traversed position to the selection.
708 * \li Notion: See also #LFUN_CHAR_BACKWARD.
709 * \li Syntax: char-backward-select
712 { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit },
714 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_BACKWARD
715 * \li Action: Deletes one character in the backward direction (usually the "BackSpace" key).
716 * \li Syntax: char-delete-backward
719 { LFUN_CHAR_DELETE_BACKWARD, "char-delete-backward", SingleParUpdate, Edit },
721 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_FORWARD
722 * \li Action: Deletes one character in the backward direction (usually the "Delete" key).
723 * \li Syntax: char-delete-forward
726 { LFUN_CHAR_DELETE_FORWARD, "char-delete-forward", SingleParUpdate, Edit },
728 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD
729 * \li Action: Moves the cursor one position logically forward.
730 * \li Notion: This is not the action which should be bound to the arrow keys,
731 because forward may be left or right, depending on the language.
732 The arrow keys should be bound to #LFUN_CHAR_LEFT or
733 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
734 * \li Syntax: char-forward
737 { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit },
739 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD_SELECT
740 * \li Action: Moves the cursor one position logically forward, adding
741 traversed position to the selection.
742 * \li Notion: See also #LFUN_CHAR_FORWARD.
743 * \li Syntax: char-forward-select
746 { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit },
748 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT
749 * \li Action: Moves the cursor one position "to the left".
750 * \li Notion: This is the action which should be taken when the "left" key
751 is pressed. Generally, it moves the cursor one position to the
752 left. However, in Bidi text this become slightly more
753 complicated, and there are different modes of cursor movement.
754 In "visual mode", this moves left, plain and simple. In "logical
755 mode", movement is logically forward in RTL paragraphs, and
756 logically backwards in LTR paragraphs.
757 * \li Syntax: char-left
760 { LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit },
762 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT_SELECT
763 * \li Action: Moves the cursor one position "to the left", adding
764 traversed position to the selection.
765 * \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement.
766 * \li Syntax: char-left-select
769 { LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit },
771 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT
772 * \li Action: Moves the cursor one position "to the right".
773 * \li Notion: This is the action which should be taken when the "right" key
774 is pressed. Generally, it moves the cursor one position to the
775 right. However, in Bidi text this become slightly more
776 complicated, and there are different modes of cursor movement.
777 In "visual mode", this moves right, plain and simple. In "logical
778 mode", movement is logically forward in LTR paragraphs, and
779 logically backwards in RTL paragraphs.
780 * \li Syntax: char-right
783 { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit },
785 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT_SELECT
786 * \li Action: Moves the cursor one position "to the right", adding
787 traversed position to the selection.
788 * \li Notion: See also #LFUN_CHAR_RIGHT for exact details of the movement.
789 * \li Syntax: char-right-select
792 { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit },
795 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD
796 * \li Action: Moves the cursor to the logically previous beginning of a word.
797 * \li Notion: This is not the action which should be bound to the arrow keys,
798 because backwards may be left or right, depending on the
799 language. The arrow keys should be bound to #LFUN_WORD_LEFT or
800 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
801 * \li Syntax: word-backward
804 { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit },
806 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD_SELECT
807 * \li Action: Moves the cursor to the logically previous beginning of a word,
808 adding the logically traversed text to the selection.
809 * \li Notion: See also #LFUN_WORD_BACKWARD.
810 * \li Syntax: word-backward-select
813 { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
815 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_BACKWARD
816 * \li Action: Deletes characters to the begining of the word (usually the "C+BackSpace" key).
817 * \li Syntax: word-delete-backward
820 { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
822 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_FORWARD
823 * \li Action: Deletes characters to the end of the word (usually the "C+Delete" key).
824 * \li Syntax: word-delete-forward
827 { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
829 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_FORWARD
830 * \li Action: Search for a given string in forward direction.
831 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
832 * \li Syntax: word-find-forward [<STRING>]
833 * \li Origin: Etienne, 16 Feb 1998
836 { LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit },
838 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_BACKWARD
839 * \li Action: Search for a given string in backward direction.
840 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
841 * \li Syntax: word-find-backward [<STRING>]
842 * \li Origin: Etienne, 20 Feb 1998
845 { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
847 * \var lyx::FuncCode lyx::LFUN_WORD_FIND
848 * \li Action: Search for next occurence of a string.
849 * \li Syntax: word-find [<DATA>]
850 * \li Params: <DATA>: data encoded from Find dialog (see #lyx::find2string()).
851 If no parameter is given, search with last find-dialog
852 data is used for search (i.e. find-next).
853 * \li Origin: Andre, Jan 7 2004
856 { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
858 * \var lyx::FuncCode lyx::LFUN_WORD_REPLACE
859 * \li Action: Replace a string in the document.
860 * \li Syntax: word-replace [<DATA>]
861 * \li Params: <DATA>: data is of the form
864 <casesensitive> <matchword> <all> <forward>"
865 * \li Origin: Andre, Jan 7 2004
868 { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
870 * \var lyx::FuncCode lyx::LFUN_WORD_FINDADV
871 * \li Action: Search for next occurence of a pattern.
872 * \li Syntax: word-findadv [<DATA>]
873 * \li Params: <DATA>: data encoded from FindAdv dialog (see #lyx::findadv2string()).
874 If no parameter is given, search with last find-dialog
875 data is used for search (i.e. find-next).
876 * \li Origin: Tommaso, Nov 15 2007
879 { LFUN_WORD_FINDADV, "word-findadv", ReadOnly | NoBuffer, Edit },
881 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD
882 * \li Action: Moves the cursor to the logically next beginning of a word.
883 * \li Notion: This is not the action which should be bound to the arrow keys,
884 because forward may be left or right, depending on the language.
885 The arrow keys should be bound to #LFUN_WORD_LEFT or
886 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
887 * \li Syntax: word-forward
890 { LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
892 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD_SELECT
893 * \li Action: Moves the cursor to the logically next beginning of a word,
894 adding the logically traversed text to the selection.
895 * \li Notion: See also #LFUN_WORD_FORWARD.
896 * \li Syntax: word-forward-select
899 { LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
901 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT
902 * \li Action: Moves the cursor to the next beginning of a word "on the left".
903 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
904 "left" key is pressed. Generally, it moves the cursor to the
905 next beginning of a word on the left. However, in Bidi text this
906 become slightly more complicated, and there are different modes
907 of cursor movement. In "visual mode", this moves left, plain and
908 simple. In "logical mode", movement is logically forward in RTL
909 paragraphs, and logically backwards in LTR paragraphs.
910 * \li Syntax: word-left
911 * \li Origin: dov, 28 Oct 2007
914 { LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
916 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT_SELECT
917 * \li Action: Moves the cursor to the next beginning of a word "on the left",
918 adding *logically* traversed text to the selection.
919 * \li Notion: See also #LFUN_WORD_LEFT for exact details of the movement.
920 * \li Syntax: word-left-select
921 * \li Origin: dov, 28 Oct 2007
924 { LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit },
926 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT
927 * \li Action: Moves the cursor to the next beginning of a word "on the right".
928 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
929 "right" key is pressed. Generally, it moves the cursor to the
930 next beginning of a word on the right. However, in Bidi text
931 this become slightly more complicated, and there are different
932 modes of cursor movement. In "visual mode", this moves right,
933 plain and simple. In "logical mode", movement is logically
934 forward in LTR paragraphs, and logically backwards in RTL
936 * \li Syntax: word-right
937 * \li Origin: dov, 28 Oct 2007
940 { LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit },
942 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT_SELECT
943 * \li Action: Moves the cursor to the next beginning of a word "on the right",
944 adding *logically* traversed text to the selection.
945 * \li Notion: See also #LFUN_WORD_RIGHT for exact details of the movement.
946 * \li Syntax: word-right-select
947 * \li Origin: dov, 28 Oct 2007
950 { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
952 * \var lyx::FuncCode lyx::LFUN_WORD_SELECT
953 * \li Action: Puts the word where the cursor stands into the selection.
954 * \li Syntax: word-select
955 * \li Origin: Andre, 11 Sep 2002
958 { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
960 * \var lyx::FuncCode lyx::LFUN_WORD_CAPITALIZE
961 * \li Action: Capitalizes the words in the selection (i.e. the first letters)
962 or the letter on the cursor position.
963 * \li Syntax: word-capitalize
966 { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
968 * \var lyx::FuncCode lyx::LFUN_WORD_UPCASE
969 * \li Action: Change the words in the selection or from the cursor position
970 to the end of word to the upper case.
971 * \li Syntax: word-upcase
974 { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
976 * \var lyx::FuncCode lyx::LFUN_WORD_LOWCASE
977 * \li Action: Change the words in the selection or from the cursor position
978 to the end of word to the lower case.
979 * \li Syntax: word-lowcase
982 { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
984 * \var lyx::FuncCode lyx::LFUN_SPELLING_ADD
985 * \li Action: Add the word under the cursor to the respective
986 * spell checker dictionary.
987 * \li Syntax: spelling-add [<STRING>] [<LANG>]
988 * \li Params: <WORD>: word to add
989 <LANG>: language name (see file languages)
990 * \li Origin: JSpitzm, 18 Jan 2010
993 { LFUN_SPELLING_ADD, "spelling-add", ReadOnly, Edit },
995 * \var lyx::FuncCode lyx::LFUN_SPELLING_IGNORE
996 * \li Action: Let the spell checker ignore the word under the cursor
997 * in the current session for the given language.
998 * \li Syntax: spelling-ignore [<WORD>] [<LANG>]
999 * \li Params: <WORD>: word to ignore
1000 <LANG>: language name (see file languages)
1001 * \li Origin: JSpitzm, 18 Jan 2010
1004 { LFUN_SPELLING_IGNORE, "spelling-ignore", ReadOnly, Edit },
1006 * \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
1007 * \li Action: Look up thesaurus entries with respect to the word under the cursor.
1008 * \li Syntax: thesaurus-entry [<STRING>] [lang=<LANG>]
1009 * \li Params: <STRING>: word to look up
1010 <LANG>: language (see file languages)
1011 * \li Origin: Levon, 20 Jul 2001
1014 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
1016 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN
1017 * \li Action: Move the cursor to the beginning of the document.
1018 * \li Syntax: buffer-begin
1021 { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
1023 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN_SELECT
1024 * \li Action: Move the cursor to the beginning of the document adding the
1025 traversed text to the selection.
1026 * \li Syntax: buffer-begin-select
1029 { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
1031 * \var lyx::FuncCode lyx::LFUN_BUFFER_END
1032 * \li Action: Move the cursor to the end of the document.
1033 * \li Syntax: buffer-end
1036 { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
1038 * \var lyx::FuncCode lyx::LFUN_BUFFER_END_SELECT
1039 * \li Action: Move the cursor to the end of the document adding the
1040 traversed text to the selection.
1041 * \li Syntax: buffer-end-select
1044 { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
1047 * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN
1048 * \li Action: Move the cursor to the beginning of the current inset
1049 if it is not already there, or at the beginning of the
1050 enclosing inset otherwise
1051 * \li Syntax: inset-begin
1052 * \li Origin: lasgouttes, 16 Mar 2009
1055 { LFUN_INSET_BEGIN, "inset-begin", ReadOnly, Edit },
1057 * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN_SELECT
1058 * \li Action: Move the cursor to the beginning of the current inset
1059 if it is not already there, or at the beginning of the
1060 enclosing inset otherwise (adding the
1061 traversed text to the selection).
1062 * \li Syntax: inset-begin-select
1063 * \li Origin: lasgouttes, 16 Mar 2009
1066 { LFUN_INSET_BEGIN_SELECT, "inset-begin-select", ReadOnly, Edit },
1068 * \var lyx::FuncCode lyx::LFUN_INSET_END
1069 * \li Action: Move the cursor to the end of the current inset
1070 if it is not already there, or at the end of the
1071 enclosing inset otherwise
1072 * \li Syntax: inset-end
1073 * \li Origin: lasgouttes, 16 Mar 2009
1076 { LFUN_INSET_END, "inset-end", ReadOnly, Edit },
1078 * \var lyx::FuncCode lyx::LFUN_INSET_END_SELECT
1079 * \li Action: Move the cursor to the end of the current inset
1080 if it is not already there, or at the end of the
1081 enclosing inset otherwise (adding the
1082 traversed text to the selection).
1083 * \li Syntax: inset-end-select
1084 * \li Origin: lasgouttes, 16 Mar 2009
1087 { LFUN_INSET_END_SELECT, "inset-end-select", ReadOnly, Edit },
1090 * \var lyx::FuncCode lyx::LFUN_INSET_SELECT_ALL
1091 * \li Action: Selects all contents of an inset.
1092 * \li Syntax: inset-select-all
1093 * \li Origin: vfr, 22 Aug 2009
1096 { LFUN_INSET_SELECT_ALL, "inset-select-all", ReadOnly, Edit },
1099 * \var lyx::FuncCode lyx::LFUN_SECTION_SELECT
1100 * \li Action: Selects the whole section.
1101 * \li Notion: The cursor should be in a section heading
1102 before calling this lfun.
1103 * \li Syntax: section-select
1104 * \li Origin: vfr, 05 May 2009
1107 { LFUN_SECTION_SELECT, "section-select", ReadOnly, Edit },
1110 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN
1111 * \li Action: Move the cursor to the begining of the (screen) line.
1112 * \li Syntax: line-begin
1115 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
1117 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN_SELECT
1118 * \li Action: Move the cursor to the beginning of the (screen) line adding the
1119 traversed text to the selection.
1120 * \li Syntax: line-begin-select
1123 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
1125 * \var lyx::FuncCode lyx::LFUN_LINE_END
1126 * \li Action: Move the cursor to the end of the (screen) line.
1127 * \li Syntax: line-end
1130 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
1132 * \var lyx::FuncCode lyx::LFUN_LINE_END_SELECT
1133 * \li Action: Move the cursor to the end of the (screen) line adding the
1134 traversed text to the selection.
1135 * \li Syntax: line-end-select
1138 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
1140 * \var lyx::FuncCode lyx::LFUN_LINE_DELETE
1141 * \li Action: Deletes the letters to the end of the (screen) line or
1142 deletes the selection.
1143 * \li Syntax: line-delete-forward
1146 { LFUN_LINE_DELETE, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
1148 * \var lyx::FuncCode lyx::LFUN_COPY
1149 * \li Action: Copies to the clipboard the last edit.
1153 { LFUN_COPY, "copy", ReadOnly, Edit },
1155 * \var lyx::FuncCode lyx::LFUN_CUT
1156 * \li Action: Cuts to the clipboard.
1160 { LFUN_CUT, "cut", Noop, Edit },
1162 * \var lyx::FuncCode lyx::LFUN_PASTE
1163 * \li Action: Pastes material (text or picture) from the active clipboard.
1164 * \li Syntax: paste [<TYPE>|<NUM>]
1165 * \li Params: <TYPE>: emf|pdf|png|jpeg|linkback|wmf \n
1166 <NUM>: number of the selection in the internal clipboard stack to be pasted.
1169 { LFUN_PASTE, "paste", Noop, Edit },
1171 * \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE
1172 * \li Action: Pastes text from the active clipboard.
1173 * \li Syntax: clipboard-paste [<ARG>]
1174 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1175 * \li Origin: baum, 10 Jul 2006
1178 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
1180 * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
1181 * \li Action: Pastes the currently text selected text.
1182 * \li Notion: Primary selection mechanism is linux-only thing.
1183 * \li Syntax: primary-selection-paste [<ARG>]
1184 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1187 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
1189 * \var lyx::FuncCode lyx::LFUN_SELECTION_PASTE
1190 * \li Action: Pastes the text in permanent selection.
1191 * \li Syntax: selection-paste
1194 { LFUN_SELECTION_PASTE, "selection-paste", Noop, Edit },
1196 * \var lyx::FuncCode lyx::LFUN_UNDO
1197 * \li Action: Undoes the last edit.
1201 { LFUN_UNDO, "undo", Noop, Edit },
1203 * \var lyx::FuncCode lyx::LFUN_REDO
1204 * \li Action: Redoes the last thing undone.
1208 { LFUN_REDO, "redo", Noop, Edit },
1210 * \var lyx::FuncCode lyx::LFUN_REPEAT
1211 * \li Action: Repeat the given command.
1212 * \li Syntax: repeat <COUNT> <LFUN-COMMAND>
1213 * \li Origin: Andre, 27 Oct 2003
1216 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
1218 * \var lyx::FuncCode lyx::LFUN_CHARS_TRANSPOSE
1219 * \li Action: Transposes the character at the cursor with the one before it.
1220 * \li Syntax: chars-transpose
1221 * \li Origin: Lgb, 25 Apr 2001
1224 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
1227 * \var lyx::FuncCode lyx::LFUN_DEPTH_DECREMENT
1228 * \li Action: Decrease the nesting depth of the (selected) paragraph(s)
1230 * \li Syntax: depth-decrement
1233 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
1235 * \var lyx::FuncCode lyx::LFUN_DEPTH_INCREMENT
1236 * \li Action: Increase the nesting depth of the (selected) paragraph(s)
1238 * \li Syntax: depth-increment
1241 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
1244 * \var lyx::FuncCode lyx::LFUN_FONT_BOLD
1245 * \li Action: Toggles the bold font (selection-wise) using mathbf in math.
1246 * \li Syntax: font-bold
1249 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
1252 * \var lyx::FuncCode lyx::LFUN_FONT_BOLDSYMBOL
1253 * \li Action: Toggles the bold font (selection-wise) using boldsymbol in math.
1254 * \li Syntax: font-boldsymbol
1257 { LFUN_FONT_BOLDSYMBOL, "font-boldsymbol", Noop, Layout },
1259 * \var lyx::FuncCode lyx::LFUN_FONT_TYPEWRITER
1260 * \li Action: Toggles the typewriter family font (selection-wise).
1261 * \li Syntax: font-typewriter
1264 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
1266 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERLINE
1267 * \li Action: Toggles underline in the font (selection-wise).
1268 * \li Syntax: font-underline
1271 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
1273 * \var lyx::FuncCode lyx::LFUN_FONT_UULINE
1274 * \li Action: Toggles double underline in the font (selection-wise).
1275 * \li Syntax: font-underunderline
1276 * \li Origin: sanda, 5 May 2009
1279 { LFUN_FONT_UULINE, "font-underunderline", Noop, Layout },
1281 * \var lyx::FuncCode lyx::LFUN_FONT_UWAVE
1282 * \li Action: Toggles wavy underline in the font (selection-wise).
1283 * \li Syntax: font-underwave
1284 * \li Origin: sanda, 5 May 2009
1287 { LFUN_FONT_UWAVE, "font-underwave", Noop, Layout },
1289 * \var lyx::FuncCode lyx::LFUN_FONT_STRIKEOUT
1290 * \li Action: Toggles strikeout (strike-through) in the font (selection-wise).
1291 * \li Syntax: font-strikeout
1292 * \li Origin: sanda, 3 May 2009
1295 { LFUN_FONT_STRIKEOUT, "font-strikeout", Noop, Layout },
1297 * \var lyx::FuncCode lyx::LFUN_FONT_EMPH
1298 * \li Action: Toggles the emphasis font style (selection-wise).
1299 * \li Syntax: font-emph
1302 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
1304 * \var lyx::FuncCode lyx::LFUN_FONT_NOUN
1305 * \li Action: Toggles Noun text style font (selection-wise).
1306 * \li Syntax: font-noun
1309 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
1311 * \var lyx::FuncCode lyx::LFUN_FONT_ROMAN
1312 * \li Action: Toggles Roman family font (selection-wise).
1313 * \li Syntax: font-roman
1316 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
1318 * \var lyx::FuncCode lyx::LFUN_FONT_SANS
1319 * \li Action: Toggles Sans Serif family font (selection-wise).
1320 * \li Syntax: font-sans
1323 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
1325 * \var lyx::FuncCode lyx::LFUN_FONT_FRAK
1326 * \li Action: Toggles Fraktur family font (math-mode, selection-wise).
1327 * \li Syntax: font-frak
1328 * \li Origin: vermeer, 10 Jan 2002
1331 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
1333 * \var lyx::FuncCode lyx::LFUN_FONT_ITAL
1334 * \li Action: Toggles Italics font shape (math-mode, selection-wise).
1335 * \li Syntax: font-ital
1336 * \li Origin: vermeer, 10 Jan 2002
1339 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
1341 * \var lyx::FuncCode lyx::LFUN_FONT_DEFAULT
1342 * \li Action: Reverts the settings of the font to the default values (selection-wise).
1343 * \li Syntax: font-default
1346 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
1348 * \var lyx::FuncCode lyx::LFUN_FONT_SIZE
1349 * \li Action: Sets font size according to lyx format string.
1350 * \li Syntax: font-size <SIZE>
1351 * \li Params: <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|\n
1352 largest|huge|giant|increase|decrease|default
1355 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
1357 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_APPLY
1358 * \li Action: Toggle user-defined (=last-time used) text style.
1359 * \li Notion: This style is set via #LFUN_TEXTSTYLE_UPDATE, which is
1360 automatically trigerred when using Text Style dialog.
1361 * \li Syntax: textstyle-apply
1362 * \li Origin: leeming, 12 Mar 2003
1365 { LFUN_TEXTSTYLE_APPLY, "textstyle-apply", Noop, Layout },
1367 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_UPDATE
1368 * \li Action: Apply text style and update the settings to be used by #LFUN_TEXTSTYLE_APPLY.
1369 * \li Syntax: textstyle-update <FONT_INFO>
1370 * \li Params: <FONT_INFO>: specifies font atributes, e.g. family, series, shape,
1371 size, emph, noun, underbar, number, color, language,
1373 Use lyx -dbg action for exact syntax of text-style
1375 * \li Origin: leeming, 12 Mar 2003
1378 { LFUN_TEXTSTYLE_UPDATE, "textstyle-update", Noop, Layout },
1380 * \var lyx::FuncCode lyx::LFUN_SCREEN_FONT_UPDATE
1381 * \li Action: Update fonts and its metrics.
1382 * \li Notion: Automatically called after zoom, dpi, font names, or norm change.
1383 * \li Syntax: screen-font-update
1384 * \li Origin: ARRae, 13 Aug 2000
1387 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
1389 * \var lyx::FuncCode lyx::LFUN_FONT_STATE
1390 * \li Action: Returns the info about the current font.
1391 * \li Syntax: font-state
1394 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
1397 * \var lyx::FuncCode lyx::LFUN_CITATION_INSERT
1398 * \li Action: Inserts citation from loaded citation database.
1399 * \li Syntax: citation-insert [<KEY>[|<TEXT_BEFORE>]]
1400 * \li Params: <KEY>: Citation (shortcut listed in available citations). \n
1401 <TEXT_BEFORE>: text which should appear before citation.
1402 * \li Origin: AAS, 97-02-23
1405 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
1407 * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_ADD
1408 * \li Action: Adds database, which will be used for bibtex citations.
1409 * \li Notion: Databases are added to the first BibTeX inset
1410 (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
1411 * \li Syntax: bibtex-database-add <DATABASE-NAME>
1412 * \li Origin: Ale, 30 May 1997
1415 { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit },
1417 * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_DEL
1418 * \li Action: Adds database, which will be used for bibtex citations.
1419 * \li Notion: Databases are deleted from the first BibTeX inset
1420 (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
1421 * \li Syntax: bibtex-database-del <DATABASE-NAME>
1422 * \li Origin: Ale, 30 May 1997
1425 { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
1428 * \var lyx::FuncCode lyx::LFUN_LAYOUT
1429 * \li Action: Sets the layout (that is, environment) for the current paragraph.
1430 * \li Syntax: layout <LAYOUT>
1431 * \li Params: <LAYOUT>: the layout to use
1434 { LFUN_LAYOUT, "layout", Noop, Layout },
1436 * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH
1437 * \li Action: Launches the paragraph settings dialog.
1438 * \li Syntax: layout-paragraph
1441 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
1443 * \var lyx::FuncCode lyx::LFUN_LAYOUT_TABULAR
1444 * \li Action: Launches the tabular settings dialog.
1445 * \li Syntax: layout-tabular
1446 * \li Origin: Jug, 31 Jul 2000
1449 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
1451 * \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE
1452 * \li Action: Displays list of layout choices.
1453 * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
1454 dropbox allowing for choice of layout.
1455 * \li Syntax: drop-layouts-choice
1458 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
1460 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
1461 * \li Action: Clears the module list.
1462 * \li Notion: Clears the list of included modules for the current buffer.
1463 * \li Syntax: layout-modules-clear
1464 * \li Origin: rgh, 25 August 2007
1467 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", NoInternal, Layout },
1469 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULE_ADD
1470 * \li Action: Adds a module.
1471 * \li Notion: Adds a module to the list of included modules for the current buffer.
1472 * \li Syntax: layout-module-add <MODULE>
1473 * \li Params: <MODULE>: the module to be added
1474 * \li Origin: rgh, 25 August 2007
1477 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", NoInternal, Layout },
1479 * \var lyx::FuncCode lyx::LFUN_LAYOUT_RELOAD
1480 * \li Action: Reloads layout information.
1481 * \li Notion: Reloads all layout information for the current buffer from disk, thus
1482 recognizing any changes that have been made to layout files on the fly.
1483 This is intended to be used only by layout developers and should not be
1484 used when one is trying to do actual work.
1485 * \li Syntax: layout-reload
1486 * \li Origin: rgh, 3 September 2007
1489 { LFUN_LAYOUT_RELOAD, "layout-reload", NoInternal, Layout },
1491 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
1492 * \li Action: Sets the text class for the current buffer.
1493 * \li Syntax: textclass-apply <TEXTCLASS>
1494 * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
1495 the filename, minus the ".layout" extension.
1498 { LFUN_TEXTCLASS_APPLY, "textclass-apply", NoInternal, Layout },
1500 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
1501 * \li Action: Loads information for a textclass from disk.
1502 * \li Syntax: textclass-load <TEXTCLASS>
1503 * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
1504 the filename, minus the ".layout" extension.
1507 { LFUN_TEXTCLASS_LOAD, "textclass-load", NoInternal, Layout },
1510 * \var lyx::FuncCode lyx::LFUN_MARK_OFF
1511 * \li Action: Disable selecting of text-region.
1512 * \li Syntax: mark-off
1515 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
1517 * \var lyx::FuncCode lyx::LFUN_MARK_ON
1518 * \li Action: Enable selecting of text-region.
1519 * \li Notion: After enabling you can simply move arrow keys to get selected region.
1520 * \li Syntax: mark-on
1523 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
1525 * \var lyx::FuncCode lyx::LFUN_MARK_TOGGLE
1526 * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
1527 * \li Syntax: mark-toggle
1528 * \li Origin: Andre, May 5 2006
1531 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
1534 * \var lyx::FuncCode lyx::LFUN_MATH_DELIM
1535 * \li Action: Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
1536 * \li Syntax: math-delim [<LEFT>] [<RIGHT>]
1537 * \li Params: <LEFT/RIGHT>: Delimiters to be used. Each delimiter can be specified by
1538 either a LaTeX name or a valid character.
1539 ( is the default letter.
1540 * \li Sample: math-delim { rangle
1541 * \li Origin: Alejandro, 18 Jun 1996
1544 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
1546 * \var lyx::FuncCode lyx::LFUN_MATH_BIGDELIM
1547 * \li Action: Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
1548 * \li Syntax: math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
1549 * \li Params: <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r \n
1550 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
1551 * \li Sample: math-bigdelim "Bigl" "\Downarrow" "Bigr" "\}"
1552 * \li Origin: Enrico & Georg, 7 May 2006
1555 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
1557 * \var lyx::FuncCode lyx::LFUN_MATH_DISPLAY
1558 * \li Action: Creates a new displayed equation in text mode.
1559 Toggles inlined/display formula in math mode.
1560 * \li Syntax: math-display [<ARG>]
1561 * \li Params: <ARG>: this argument will be passed to #LFUN_MATH_INSERT when creating
1562 new equation from the text mode.
1563 * \li Origin: Alejandro, 18 Jun 1996
1566 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
1568 * \var lyx::FuncCode lyx::LFUN_MATH_INSERT
1569 * \li Action: Inserts math objects and symbols.
1570 * \li Syntax: math-insert <ARG>
1571 * \li Params: <ARG>: Symbol or LaTeX code to be inserted.
1572 * \li Notion: When <ARG> is a _single_ math inset with more than one cell
1573 (such as "x_y^z" or "\frac{x}{y}"), the content of cell(0) is
1574 replaced by the current selection (only works if the selection
1575 is in mathed). As an example, if "abc" is selected in mathed,
1576 "math-insert \frac{x}{y}" replaces "abc" with "\frac{abc}{y}",
1577 and "math-insert x_y^z" replaces "abc" with "abc_y^z".
1578 If nothing is selected (or the selection is not in mathed),
1579 math-insert works as expected.
1582 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
1584 * \var lyx::FuncCode lyx::LFUN_MATH_SUBSCRIPT
1585 * \li Action: Enters subscript expression in math expression.
1586 * \li Syntax: math-subscript
1587 * \li Origin: vermeer, 12 Dec 2001
1590 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
1592 * \var lyx::FuncCode lyx::LFUN_MATH_SUPERSCRIPT
1593 * \li Action: Enters subscript expression in math expression.
1594 * \li Syntax: math-superscript
1595 * \li Origin: vermeer, 12 Dec 2001
1598 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
1600 * \var lyx::FuncCode lyx::LFUN_MATH_LIMITS
1601 * \li Action: Toggles the position of the limits from above/below to the right
1602 side an vice versa in integral symbol, a limit, a summation, etc.
1603 * \li Notion: Put the cursor before the symbol with the limits and then invoke
1605 * \li Syntax: math-limits [<STATE>]
1606 * \li Params: <STATE>: limits|nolimits
1609 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
1611 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO
1612 * \li Action: Inserts a math macro definition at the cursor position in the text.
1613 * \li Syntax: math-macro <NAME> [<NARGS>] [def]
1614 * \li Params: <NAME>: The name of the macro, e.g. "mymacro".\n
1615 <NARGS>: The number of parameters of the macro. Default is 0.
1616 "def": Has no effect anymore, just for compatibility with former LyX versions.
1617 * \li Origin: ale, 10 May 1997; sts, 21 Dec 2007
1620 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
1622 * \var lyx::FuncCode lyx::LFUN_MATH_MUTATE
1623 * \li Action: Mutates the type of math inset to the newly selected one.
1624 * \li Syntax: math-mutate <TYPE>
1625 * \li Params: <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
1626 multline|gather|flalign
1627 * \li Origin: Andre, 23 May 2001
1630 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
1632 * \var lyx::FuncCode lyx::LFUN_MATH_SPACE
1633 * \li Action: Inserts space into math expression.
1634 * \li Notion: Use spacebar after entering this space to change type of space.
1635 * \li Syntax: math-space [<TYPE>] [<LEN>]
1636 * \li Params: <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace \n
1637 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad \n
1638 custom space: hspace \n
1639 "," used by default.\n
1640 Note that ! is equivalent to negthinspace, , = thinspace,
1641 : = medspace, and ; = thickspace.\n
1642 <LEN>: length for custom spaces (hspace)
1643 * \li Origin: Andre, 25 Jul 2001; sanda, 16 Jun 2008
1646 { LFUN_MATH_SPACE, "math-space", Noop, Math },
1648 * \var lyx::FuncCode lyx::LFUN_MATH_MATRIX
1649 * \li Action: Inserts a matrix.
1650 * \li Syntax: math-matrix <COLS> <ROWS> [<ALIGN>]
1651 * \li Params: <ALIGN>: Alignment is a word composed of the vertical alignment
1652 (b, c or t) (i.e. 1 char) and the horizontal alignments
1653 (l, c or r) (i.e. <COL> chars).
1654 * \li Sample: math-matrix 3 3 bccc
1657 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
1659 * \var lyx::FuncCode lyx::LFUN_MATH_AMS_MATRIX
1660 * \li Action: Inserts a matrix.
1661 * \li Syntax: math-matrix <COLS> <ROWS> [<DECORATION>]
1662 * \li Params: <DECORATION>: Decoration determines the LaTeX name of the matrix
1663 that should be created.
1664 * \li Sample: math-ams-matrix 3 3 bmatrix
1667 { LFUN_MATH_AMS_MATRIX, "math-ams-matrix", Noop, Math },
1669 * \var lyx::FuncCode lyx::LFUN_MATH_MODE
1670 * \li Action: In text mode enters math mode (i.e. puts math insets on the current
1671 cursor position), in math mode enters text mode inside math expression.
1672 * \li Notion: If there is some selected text, it puts the text inside created math box.
1673 * \li Syntax: math-mode [on|<ARG>]
1674 * \li Params: <ARG>: eventual argument (LaTeX code) is passed to #LFUN_MATH_INSERT .\n
1675 "on": allow only entering of math mode from text mode.
1676 * \li Origin: Alejandro, 4 Jun 1996
1679 { LFUN_MATH_MODE, "math-mode", Noop, Math },
1681 * \var lyx::FuncCode lyx::LFUN_REGEXP_MODE
1682 * \li Action: Enters regexp mode (i.e., puts regexp insets on the current
1683 cursor position). Used by the advanced search dialog.
1684 * \li Notion: If there is any selected text, then it is moved inside the created
1686 * \li Syntax: regexp-mode [<ARG>]
1687 * \li Params: <ARG>: eventual argument (regular expression).
1688 * \li Origin: Tommaso, 4 Oct 2008
1691 { LFUN_REGEXP_MODE, "regexp-mode", Noop, Math },
1693 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
1694 * \li Action: Toggles numbering of the current formula line.
1695 * \li Notion: Must be in display formula mode.
1696 * \li Syntax: math-number-line-toggle
1697 * \li Origin: Alejandro, 18 Jun 1996
1700 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
1702 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
1703 * \li Action: Toggles numbering/labeling of the current formula.
1704 * \li Notion: Must be in display formula mode.
1705 * \li Syntax: math-number-toggle
1706 * \li Origin: Alejandro, 4 Jun 1996
1709 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
1711 * \var lyx::FuncCode lyx::LFUN_MATH_EXTERN
1712 * \li Action: Calls external program and passes the current expression/equation
1713 as an argument for the calculation in the format appropriate to the
1715 * \li Notion: Selection can be used to determine the input for the external program.
1716 * \li Syntax: math-extern <LANG> [<COMMAND>]
1717 * \li Params: <LANG>: octave|maxima|maple|mathematica|script \n
1718 where "script" stands fot the external script (normalized
1719 expression will be passed)
1720 * \li Origin: Andre, 24 Apr 2001
1721 * \li Sample: math-extern maple simplify
1724 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
1726 * \var lyx::FuncCode lyx::LFUN_MATH_SIZE
1727 * \li Action: Changes arbitrarily the size used by math fonts inside a context.
1728 * \li Notion: Provides an interface to the LaTeX math mode font size commands.
1729 * \li Syntax: math-size <STYLE>
1730 * \li Params: <STYLE>: \displaystyle|\textstyle|\scriptstyle|\scriptscriptstyle
1731 * \li Origin: Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
1734 { LFUN_MATH_SIZE, "math-size", Noop, Math },
1736 * \var lyx::FuncCode lyx::LFUN_MATH_FONT_STYLE
1737 * \li Action: Changes the text style used in math.
1738 * \li Syntax: math-font-style <STYLE>
1739 * \li Params: <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf
1740 |textnormal|textrm|textsf|texttt|textbf|textmd|textit
1741 |textsc|textsl|textup
1742 * \li Origin: vfr, 9 jan 2009
1745 { LFUN_MATH_FONT_STYLE, "math-font-style", Noop, Math },
1747 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
1748 * \li Action: Unfold a Math Macro.
1749 * \li Notion: Unfold the Math Macro the cursor is in, i.e.
1751 * \li Syntax: math-macro-unfold
1752 * \li Origin: sts, 06 January 2008
1755 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
1757 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
1758 * \li Action: Fold a Math Macro.
1759 * \li Notion: Fold the Math Macro the cursor is in if it was
1760 unfolded, i.e. displayed as \foo before.
1761 * \li Syntax: math-macro-fold
1762 * \li Origin: sts, 06 January 2008
1765 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
1767 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
1768 * \li Action: Add a parameter.
1769 * \li Notion: Add a parameter to a Math Macro.
1770 * \li Params: <NUM>: The number of the parameter behind which the new one
1771 will be added (1 for the first, i.e. use 0 for add a
1772 parameter at the left), defaults to the last one.
1773 * \li Syntax: math-macro-add-param <NUM>
1774 * \li Origin: sts, 06 January 2008
1777 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
1779 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
1780 * \li Action: Remove the last parameter.
1781 * \li Notion: Remove the last parameter of a Math Macro and
1782 remove its value in all instances of the macro
1784 * \li Params: <NUM>: The number of the parameter to be deleted (1 for
1785 the first), defaults to the last one.
1786 * \li Syntax: math-macro-remove-param <NUM>
1787 * \li Origin: sts, 06 January 2008
1790 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
1792 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
1793 * \li Action: Append a greedy parameter.
1794 * \li Notion: Append a greedy parameter to a Math Macro which
1795 eats the following mathed cell in every instance of
1796 the macro in the buffer.
1797 * \li Syntax: math-macro-append-greedy-param
1798 * \li Origin: sts, 06 January 2008
1801 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
1803 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
1804 * \li Action: Remove a greedy parameter.
1805 * \li Notion: Remove a greedy parameter of a Math Macro and spit
1806 out the values of it in every instance of the macro
1807 in the buffer. If it is an optional parameter the [valud]
1809 * \li Syntax: math-macro-remove-greedy-param
1810 * \li Origin: sts, 06 January 2008
1813 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
1815 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
1816 * \li Action: Make a parameter optional.
1817 * \li Notion: Turn the first non-optional parameter of a Math Macro
1818 into an optional parameter with a default value.
1819 * \li Syntax: math-macro-make-optional
1820 * \li Origin: sts, 06 January 2008
1823 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
1825 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
1826 * \li Action: Make a parameter non-optional.
1827 * \li Notion: Turn the last optional parameter of a Math Macro
1828 into a non-optional parameter. The default value is
1829 remembered to be reused later if the user changes his mind.
1830 * \li Syntax: math-macro-make-nonoptional
1831 * \li Origin: sts, 06 January 2008
1834 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
1836 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
1837 * \li Action: Add an optional parameter.
1838 * \li Notion: Insert an optional parameter just behind the
1839 already existing optional parameters.
1840 * \li Syntax: math-macro-add-optional-param
1841 * \li Origin: sts, 06 January 2008
1844 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
1846 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
1847 * \li Action: Remove the last optional parameter.
1848 * \li Notion: Remove the last optional parameter of a Math Macro and
1849 remove it in all the instances of the macro in the buffer.
1850 * \li Syntax: math-macro-remove-optional-param
1851 * \li Origin: sts, 06 January 2008
1854 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
1856 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
1857 * \li Action: Add a greedy optional parameter.
1858 * \li Notion: Add a greedy optional parameter which eats the value
1859 from the following cells in mathed which are in the [value]
1861 * \li Syntax: math-macro-add-greedy-optional-param
1862 * \li Origin: sts, 06 January 2008
1865 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
1867 * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
1868 * \li Action: Only active in Math Macro definition.
1869 * \li Notion: Dummy function which is only active in a Math Macro definition.
1870 It's used to toggle the Math Macro toolbar if the cursor moves
1871 into a Math Macro definition.
1872 * \li Syntax: in-mathmacrotemplate
1873 * \li Origin: sts, 06 January 2008
1876 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
1879 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
1880 * \li Action: Moves the current paragraph downwards in the document.
1881 * \li Syntax: paragraph-move-down
1882 * \li Origin: Edwin, 8 Apr 2006
1885 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
1887 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
1888 * \li Action: Moves the current paragraph upwards in the document.
1889 * \li Syntax: paragraph-move-up
1890 * \li Origin: Edwin, 8 Apr 2006
1893 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
1896 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP
1897 * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1898 in upward direction.
1899 * \li Syntax: paragraph-up
1900 * \li Origin: Asger, 1 Oct 1996
1903 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
1905 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP_SELECT
1906 * \li Action: Move the cursor and select the text to the next paragraph (or
1907 begining of the current one) in upward direction.
1908 * \li Syntax: paragraph-up-select
1909 * \li Origin: Asger, 1 Oct 1996
1912 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
1914 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN
1915 * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1916 in downward direction.
1917 * \li Syntax: paragraph-down
1918 * \li Origin: Asger, 1 Oct 1996
1921 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
1923 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN_SELECT
1924 * \li Action: Move the cursor and select the text to the next paragraph (or
1925 begining of the current one) in downward direction.
1926 * \li Syntax: paragraph-down-select
1927 * \li Origin: Asger, 1 Oct 1996
1930 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
1932 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
1933 * \li Action: Jump to a paragraph given by its id number and optionally the
1934 desired position within the paragraph.
1935 * \li Notion: Note that id number of paragraph is not the sequential number of paragraph
1936 seen on the screen. Moreover the id is unique for all opened buffers (documents).
1937 * \li Syntax: paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
1938 * \li Params: <PAR_ID_NUMBER>: paragraph id \n
1939 <POSITION_IN_PAR>: desired position within the paragraph
1940 * \li Origin: Dekel, 26 Aug 2000
1943 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly | NoInternal, Edit },
1945 * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1946 * \li Action: Breaks the current paragraph at the current location.
1947 * \li Notion: Removes the selection.
1948 * \li Syntax: break-paragraph [<LAYOUT>]
1949 * \li Params: <LAYOUT>: "inverse" - decreases depth by one (or change layout
1950 to default layout) when the cursor is at the end of
1954 { LFUN_BREAK_PARAGRAPH, "break-paragraph", Noop, Edit },
1956 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
1957 * \li Action: Change paragraph settings.
1958 * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
1959 This function only modifies, and does not override, existing settings.
1960 Note that the "leftindent" indent setting is deprecated.
1961 * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
1962 * \li Params: <INDENT>: \noindent|\indent|\indent-toggle|\leftindent LENGTH\n
1963 <SPACING>: \paragraph_spacing default|single|onehalf|double|other SIZE \n
1964 <ALIGN>: \align block|left|right|center|default\n
1965 <OTHERS>: \labelwidthstring WIDTH|\start_of_appendix
1966 * \li Origin: rgh, Aug 15 2007
1969 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
1971 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
1972 * \li Action: Change paragraph settings.
1973 * \li Notion: Overwrite all nonspecified settings to the default ones.
1974 Use paragraph-params lfun if you don't want to overwrite others settings.
1975 * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
1976 * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
1977 * \li Origin: leeming, 30 Mar 2004
1980 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
1982 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UPDATE
1983 * \li Action: Updates the values inside the paragraph dialog from the paragraph.
1984 * \li Notion: This is internal LFUN, not to be used by users. Called internally
1985 by #LFUN_DIALOG_UPDATE.
1986 * \li Origin: leeming, 13 Mar 2003
1989 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
1992 * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
1993 * \li Action: Move the current group in the upward direction in the
1994 structure of the document.
1995 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1996 the whole substructure of the group.
1997 * \li Syntax: outline-up
1998 * \li Origin: Vermeer, 23 Mar 2006
2001 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
2003 * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
2004 * \li Action: Move the current group in the downward direction in the
2005 structure of the document.
2006 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
2007 the whole substructure of the group.
2008 * \li Syntax: outline-down
2009 * \li Origin: Vermeer, 23 Mar 2006
2012 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
2014 * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
2015 * \li Action: Moves the current group in the downward direction in the
2016 hierarchy of the document structure.
2017 * \li Notion: Part -> Chapter -> Section -> etc.
2018 * \li Syntax: outline-in
2019 * \li Origin: Vermeer, 23 Mar 2006
2022 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
2024 * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
2025 * \li Action: Moves the current group in the upward direction in the
2026 hierarchy of the document structure.
2027 * \li Notion: Part <- Chapter <- Section <- etc.
2028 * \li Syntax: outline-out
2029 * \li Origin: Vermeer, 23 Mar 2006
2032 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
2035 * \var lyx::FuncCode lyx::LFUN_INSET_EDIT
2036 * \li Action: Edit the inset at cursor with an external application,
2037 if one is attributed.
2038 * \li Syntax: inset-edit [<INSET_PARAMS>]
2039 * \li Params: <INSET_PARAMS>: Parameters for the inset. \n
2040 Currently only the filename will be considered.
2041 * \li Origin: JSpitzm, 27 Apr 2006
2044 { LFUN_INSET_EDIT, "inset-edit", ReadOnly, Edit },
2047 * \var lyx::FuncCode lyx::LFUN_TABULAR_INSERT
2048 * \li Action: Inserts table into the document.
2049 * \li Syntax: tabular-insert [<ROWS> <COLUMNS>]
2050 * \li Params: In case no arguments are given show insert dialog.
2051 * \li Origin: Jug, 12 Apr 2000
2054 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
2056 * \var lyx::FuncCode lyx::LFUN_TABULAR_FEATURE
2057 * \li Action: Sets various features to the table/cell on the current cursor position.
2058 * \li Notion: Various math-environment features are handled here as well, e.g.
2059 add-vline-left/right for the Grid/Array environment
2060 * \li Syntax: tabular-feature <FEATURE> [<ARG>]
2061 * \li Params: <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|copy-column|
2062 toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
2063 align-left|align-right|align-center|align-block|valign-top|valign-bottom|
2064 valign-middle|longtabular-align-left|longtabular-align-center|
2065 longtabular-align-right|m-align-left|m-align-right|m-align-center|
2066 m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|set-all-lines|
2067 unset-all-lines|set-longtabular|unset-longtabular|set-pwidth|set-mpwidth|
2068 set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|
2069 set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|
2070 unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|
2071 set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
2072 set-special-column|set-special-multicolumn|set-special-multirow|
2073 set-booktabs|unset-booktabs|set-top-space|set-bottom-space|
2074 set-interline-space|set-border-lines|tabular-valign-top|
2075 tabular-valign-middle|tabular-valign-bottom \n
2076 <ARG>: additional argument for some commands, use debug mode to explore its values.
2077 * \li Origin: Jug, 28 Jul 2000
2080 { LFUN_TABULAR_FEATURE, "tabular-feature", Noop, Edit },
2082 * \var lyx::FuncCode lyx::LFUN_CELL_BACKWARD
2083 * \li Action: Moves the cursor to the previous cell inside the table.
2084 * \li Syntax: cell-backward
2085 * \li Origin: Jug, 22 May 2000
2088 { LFUN_CELL_BACKWARD, "cell-backward", Noop, Edit },
2090 * \var lyx::FuncCode lyx::LFUN_CELL_FORWARD
2091 * \li Action: Moves the cursor to the next cell inside the table.
2092 * \li Syntax: cell-forward
2095 { LFUN_CELL_FORWARD, "cell-forward", Noop, Edit },
2097 * \var lyx::FuncCode lyx::LFUN_CELL_SPLIT
2098 * \li Action: Splits cell and shifts right part to the next cell (inside the math grid).
2099 * \li Syntax: cell-split
2100 * \li Origin: Ale, 15 May 1997
2103 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
2106 * \var lyx::FuncCode lyx::LFUN_VC_REGISTER
2107 * \li Action: Register the document as an file inside version control system (RCS, CVS).
2108 * \li Notion: File is registered inside cvs, svn or rcs repository acording to the existence
2109 of cvs/svn/rcs entries in the document's directory. \n
2110 See LyX Additional Features Manual (Version Control Chapter) for additional
2112 * \li Syntax: vc-register
2113 * \li Origin: Lgb, 1 Jul 1997
2116 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
2118 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_IN
2119 * \li Action: Checks-in/commits the changes of the registered file to the repository.
2120 * \li Notion: In RCS case this also unlocks the file.
2121 * \li Syntax: vc-check-in
2122 * \li Origin: Lgb, 1 Jul 1997
2125 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
2127 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_OUT
2128 * \li Action: Checks-out the document for edit (and locks it for RCS).
2129 * \li Notion: This is implemented only for RCS and SVN, not CVS.
2130 * \li Syntax: vc-check-out
2131 * \li Origin: Lgb, 1 Jul 1997
2134 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
2136 * \var lyx::FuncCode lyx::LFUN_VC_REVERT
2137 * \li Action: Reverts the document to the last check-in/commit in VCS.
2138 * \li Syntax: vc-revert
2139 * \li Origin: Lgb, 1 Jul 1997
2142 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
2144 * \var lyx::FuncCode lyx::LFUN_VC_UNDO_LAST
2145 * \li Action: Undo last check-in.
2146 * \li Notion: This is currently implemented only for RCS.
2147 * \li Syntax: vc-check-out
2148 * \li Origin: Lgb, 1 Jul 1997
2151 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
2153 * \var lyx::FuncCode lyx::LFUN_VC_COMMAND
2154 * \li Action: Executes external command. This command is intended to support
2155 additional VCS commands.
2156 * \li Syntax: vc-command <FLAG> <PATH> <COMMAND>
2157 * \li Params: <FLAG>: Flags for the command can be combined together.\n
2158 U - dUmmy - no flags \n
2159 D - Doc - need document loaded to proceed \n
2160 I - dIrty - mark document dirty \n
2161 R - Reload - ensure that the document is saved and reload it after command execution \n
2162 M - Message - ask for input string (commit message)\n
2163 <PATH>: path where to start. $$p will be replaced by the current document path.\n
2164 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current
2165 document(with absolute path)/path/message.
2166 * \li Sample: vc-command DR $$p "svn up"
2167 * \li Origin: sanda, 13 Jan 2009
2170 { LFUN_VC_COMMAND, "vc-command", NoBuffer | ReadOnly, System },
2172 * \var lyx::FuncCode lyx::LFUN_VC_LOCKING_TOGGLE
2173 * \li Action: Toggles the locking property of the edited file.
2174 * \li Notion: This is currently implemented only for SVN.
2175 * \li Syntax: vc-locking-toggle
2176 * \li Origin: sanda, 25 Jun 2009
2179 { LFUN_VC_LOCKING_TOGGLE, "vc-locking-toggle", ReadOnly, System },
2181 * \var lyx::FuncCode lyx::LFUN_VC_REPO_UPDATE
2182 * \li Action: Update the local archive directory in which resides
2183 the current document with the remote repository.
2184 * \li Notion: This is currently implemented only for SVN.
2185 * \li Syntax: vc-repo-update
2186 * \li Origin: sanda, 16 Oct 2009
2189 { LFUN_VC_REPO_UPDATE, "vc-repo-update", ReadOnly, System },
2192 * \var lyx::FuncCode lyx::LFUN_CHANGES_TRACK
2193 * \li Action: Toggles change tracking to on/off.
2194 * \li Syntax: changes-track
2195 * \li Origin: levon, 1 Oct 2002
2198 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
2200 * \var lyx::FuncCode lyx::LFUN_CHANGES_OUTPUT
2201 * \li Action: Toggles showing of change tracking in typesetted output.
2202 * \li Syntax: changes-output
2203 * \li Origin: jspitzm, 21 Jan 2005
2206 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
2208 * \var lyx::FuncCode lyx::LFUN_CHANGE_NEXT
2209 * \li Action: Moves the cursor to the position of the next change
2210 of the change tracking records.
2211 * \li Syntax: change-next
2212 * \li Origin: schmitt, 4 Oct 2006
2215 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
2217 * \var lyx::FuncCode lyx::LFUN_CHANGE_PREVIOUS
2218 * \li Action: Moves the cursor to the position of the previous change
2219 of the change tracking records.
2220 * \li Syntax: change-previous
2221 * \li Origin: vfr, 4 Apr 2009
2224 { LFUN_CHANGE_PREVIOUS, "change-previous", ReadOnly, Edit },
2226 * \var lyx::FuncCode lyx::LFUN_CHANGES_MERGE
2227 * \li Action: Open change tracking dialog for merging and moves the cursor
2228 to the position of the next change.
2229 * \li Syntax: changes-merge
2230 * \li Origin: Levon, 16 Oct 2002
2233 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
2235 * \var lyx::FuncCode lyx::LFUN_CHANGE_ACCEPT
2236 * \li Action: Accepts tracked change inside the selection.
2237 * \li Syntax: change-accept
2238 * \li Origin: Levon, 16 Oct 2002
2241 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
2243 * \var lyx::FuncCode lyx::LFUN_CHANGE_REJECT
2244 * \li Action: Rejects tracked change inside the selection.
2245 * \li Syntax: change-accept
2246 * \li Origin: Levon, 16 Oct 2002
2249 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
2251 * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_ACCEPT
2252 * \li Action: Accepts all tracked changes in the document.
2253 * \li Syntax: all-changes-accept
2254 * \li Origin: Levon, 16 Oct 2002
2257 { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
2259 * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_REJECT
2260 * \li Action: Rejects all tracked changes in the document.
2261 * \li Notion: Reject does not work recursively; the user may have to repeat the operation.
2262 * \li Syntax: all-changes-reject
2263 * \li Origin: Levon, 16 Oct 2002
2266 { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
2269 * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
2270 * \li Action: Apply data for an inset.
2271 * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
2272 be applied. This is either changed to #LFUN_INSET_MODIFY or
2273 #LFUN_INSET_INSERT depending on the context where it is called.
2274 * \li Syntax: inset-apply <ARGS>
2275 * \li Params: See #LFUN_INSET_INSERT .
2278 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
2280 * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE
2281 * \li Action: Dissolve the current inset into text.
2282 * \li Syntax: inset-dissolve [<INSET>]
2283 * \li Params: <INSET>: this can be used to make sure the right kind of inset
2284 is dissolved. For example "dissolve" entry in the charstyles
2285 sub-menu should only dissolve the charstyle inset, even if the
2286 cursor is inside several nested insets of different type.\n
2287 For values see #lyx::InsetLayout::lyxtype_ .
2288 * \li Origin: JSpitz, 7 Aug 2006
2291 { LFUN_INSET_DISSOLVE, "inset-dissolve", AtPoint, Edit },
2293 * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
2294 * \li Action: Insert new inset (type given by the parameters).
2295 * \li Syntax: inset-insert <INSET> <ARGS>
2296 * \li Params: <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics|
2297 hyperlink|include|index|label|nomencl|vspace|ref|toc>\n
2298 <ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
2299 * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
2300 where <label name> is the name of the referenced label and
2301 <Format> is one of the following: \n
2302 ref -- <reference> \n
2303 eqref -- (<reference>) \n
2304 pageref -- <page> \n
2305 vpageref -- on <page> \n
2306 vref -- <reference> on <page> \n
2307 prettyref -- Formatted reference
2310 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
2312 * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
2313 * \li Action: Modify some properties of an inset.
2314 * \li Notion: Used for bibitem, bibtex, box, branch, command, ert, external,
2315 floats, graphics, include, index, info, label,
2316 listings, newline, newpage, nomencl, note, phantom,
2317 ref, space, tabular, vspace, wrap insets.
2318 * \li Syntax: inset-modify <INSET> <ARGS>
2319 * \li Syntax: inset-modify changetype <TYPE>
2320 * \li Sample: inset-modify note Note Comment
2321 * \li Sample: inset-modify changetype Ovalbox
2322 * \li Params: See #LFUN_INSET_INSERT for further details.
2325 { LFUN_INSET_MODIFY, "inset-modify", AtPoint, Edit },
2327 * \var lyx::FuncCode lyx::LFUN_INSET_DIALOG_UPDATE
2328 * \li Action: Updates the values inside the dialog from the inset.
2329 * \li Notion: This is internal LFUN, not to be used by users. Called internally
2330 by #LFUN_DIALOG_UPDATE
2331 * \li Params: <DIALOG-NAME>
2332 * \li Origin: leeming, 25 Feb 2003
2335 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
2337 * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
2338 * \li Action: Open the inset's properties dialog.
2339 * \li Notion: Used for bibitem, bibtex, box, branch, citation, ert, external,
2340 float, graphics, href, include, index, index_print, label, listings,
2341 note, phantom, ref, space, tabular, vspace, wrap insets.
2342 * \li Syntax: inset-settings <INSET>
2343 * \li Params: <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|
2344 graphics|href|include|index|index_print|label|listings|
2345 note|phantom|ref|space|tabular|vspace|wrap>.
2348 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly | AtPoint, Edit },
2350 * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
2351 * \li Action: Toggles the collapsable inset at cursor position,
2352 or the inset we are currently in.
2353 * \li Syntax: inset-toggle [<ARG>]
2354 * \li Params: <ARG>: <open|close|toggle|assign>. \n
2355 open/close/toggle are for collapsable insets. toggle is used when no argument is given.\n
2356 assign synchronize the branch-inset with activation status of the branch.
2357 Used for global toggling when changed activation.
2358 * \li Origin: lasgouttes, 19 Jul 2001
2361 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly | AtPoint, Edit },
2363 * \var lyx::FuncCode lyx::LFUN_ALL_INSETS_TOGGLE
2364 * \li Action: Toggles (open/closes) all collapsable insets (of a given type) in the document.
2365 * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
2366 * \li Syntax: all-insets-toggle [<STATE>] [<INSET>]
2367 * \li Params: <STATE>: <toggle|open|close|assign> default: toggle \n
2368 <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all insets
2369 * \li Origin: leeming, 30 Mar 2004
2372 { LFUN_ALL_INSETS_TOGGLE, "all-insets-toggle", ReadOnly, Edit },
2374 * \var lyx::FuncCode lyx::LFUN_INSET_FORALL
2375 * \li Action: Apply the given commands on insets of a given name.
2376 * \li Notion: WARNING: use at your own risks; this function gives
2377 you too many ways of shooting yourself in the foot.
2378 A typical example is
2379 inset-forall Note note-insert
2380 which starts an infinite loop. This is mitigated by the fact
2381 that the number of actions is arbitrarily limited to 10000.
2382 * \li Syntax: inset-forall <NAME> <LFUN-COMMAND> \n
2383 <NAME>: Type of Inset. If <NAME> is *, all insets are matched.
2384 The name is used like for InsetLayout in layout files: "Note"
2385 matches all note insets, while "Note:Note" only matches LyX
2387 * \li Sample: Remove all index insets: \n
2388 inset-forall Index delete-char-forward \n
2389 Close all Notes (also works for a particular branch, for example): \n
2390 inset-forall Note inset-toggle close \n
2391 Transform all yellow notes to comments \n
2392 inset-forall Note:Note inset-modify note Note Comment \n
2393 Try to put LyX in an infinite loop if there is at least a Note: \n
2394 inset-forall Note char-backward
2395 * \li Origin: lasgouttes, 27 Nov 2009
2398 { LFUN_INSET_FORALL, "inset-forall", ReadOnly, Edit },
2401 * \var lyx::FuncCode lyx::LFUN_GRAPHICS_RELOAD
2402 * \li Action: Reloads the image if necessary.
2403 * \li Syntax: graphics-reload
2404 * \li Origin: vfr, 10 Aug 2009
2407 { LFUN_GRAPHICS_RELOAD, "graphics-reload", ReadOnly | AtPoint, Edit },
2409 * \var lyx::FuncCode lyx::LFUN_SET_GRAPHICS_GROUP
2410 * \li Action: Set the group for the graphics inset on the cursor position.
2411 * \li Syntax: set-graphics-group [<GROUP>]
2412 * \li Params: <GROUP>: Id for an existing group. In case the Id is an empty string,
2413 the graphics inset is removed from the current group.
2414 * \li Origin: sanda, 6 May 2008
2417 { LFUN_SET_GRAPHICS_GROUP, "set-graphics-group", Noop, Edit },
2420 * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
2421 * \li Action: Moves the cursor out of the current slice, going forward.
2422 * \li Notion: Cursor movement within an inset may be different than cursor
2423 movement in the surrounding text. This action should be called
2424 automatically by the cursor movement within the inset, when
2425 movement within the inset has ceased (reached the end of the
2426 last paragraph, for example), in order to move correctly
2427 back into the surrounding text.
2430 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
2432 * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
2433 * \li Action: Moves the cursor out of the current slice, going backwards.
2434 * \li Notion: See also #LFUN_FINISHED_FORWARD.
2437 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
2439 * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
2440 * \li Action: Moves the cursor out of the current slice, going right.
2441 * \li Notion: See also #LFUN_FINISHED_FORWARD
2444 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
2446 * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
2447 * \li Action: Moves the cursor out of the current slice, going left.
2448 * \li Notion: See also #LFUN_FINISHED_FORWARD.
2451 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
2454 * \var lyx::FuncCode lyx::LFUN_LANGUAGE
2455 * \li Action: Set language from the current cursor position.
2456 * \li Syntax: language <LANG>
2457 * \li Params: <LANG>: Requested language. Look in lib/languages for
2459 * \li Origin: Dekel, 2 Mar 2000
2462 { LFUN_LANGUAGE, "language", Noop, Edit },
2465 * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
2466 * \li Action: Goto a label.
2467 * \li Syntax: label-goto [<LABEL>]
2468 * \li Params: <LABEL>: Requested label. If no label is given and reference
2469 is on cursor position, Bookmark 0 is saved and
2470 cursor moves to the position of referenced label.
2471 * \li Origin: Ale, 6 Aug 1997
2474 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
2476 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT
2477 * \li Action: Inserts label to text or displayed formula.
2478 * \li Syntax: label-insert [<LABEL>]
2479 * \li Params: <LABEL>: Requested label. If no label is given dialog requesting
2480 name will be opened.
2483 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
2485 * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
2486 * \li Action: Go to the next label or cross-reference.
2487 * \li Syntax: reference-next
2488 * \li Origin: Dekel, 14 Jan 2001
2491 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
2494 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
2495 * \li Action: Moves the cursor to the numbered bookmark, opening the file
2496 if necessary. Note that bookmarsk are saved per-session, not
2498 * \li Notion: Bookmark 0 has a special purpose. It is automatically set \n
2499 1. to the paragraph you are currently editing \n
2500 2. to the paragraph from where you are jumping to the last-edited
2501 position (jump-back feature) \n
2502 3. when jumping from crossreference to the requested label by
2504 * \li Syntax: bookmark-goto <NUMBER>
2505 * \li Params: <NUMBER>: the number of the bookmark to restore.
2506 * \li Origin: Dekel, 27 January 2001
2509 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
2511 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
2512 * \li Action: Save a bookmark.
2513 * \li Notion: Saves a numbered bookmark to the sessions file. The number
2514 must be between 1 and 9, inclusive. Note that bookmarks are
2515 saved per-session, not per file.
2516 * \li Syntax: bookmark-save <NUMBER>
2517 * \li Params: <NUMBER>: the number of the bookmark to save.
2518 * \li Origin: Dekel, 27 January 2001
2521 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
2523 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
2524 * \li Action: Clears the list of saved bookmarks.
2525 * \li Syntax: bookmark-clear
2526 * \li Origin: bpeng, 31 October 2006
2529 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
2532 * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
2533 * \li Action: Open the given help file according to the language setting.
2534 * \li Syntax: help-open <FILE>[.lyx]
2535 * \li Params: <FILE>: any document from (/usr/share/)doc directory.
2536 * \li Origin: Jug, 27 Jun 1999
2539 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
2541 * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
2542 * \li Action: Terminates the current LyX instance.
2543 * \li Notion: Terminates the current LyX instance, asking whether to save
2544 modified documents, etc.
2545 * \li Syntax: lyx-quit
2548 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
2550 * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
2551 * \li Action: Toggles visibility of a given toolbar between on/off/auto.
2552 * \li Notion: Skipping "auto" when allowauto is false.
2553 * \li Syntax: toolbar-toggle <NAME> [allowauto]
2554 * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|
2555 minibuffer|review|view/update|math_panels|vcs
2556 * \li Origin: Edwin, 21 May 2007
2559 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
2561 * \var lyx::FuncCode lyx::LFUN_MENU_OPEN
2562 * \li Action: Opens the menu given by its name.
2563 * \li Syntax: menu-open <NAME>
2564 * \li Params: <NAME>: menu name. See various .inc files in lib/ui for candidates.
2567 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
2569 * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
2570 * \li Action: Various UI visibility-toggling actions.
2571 * \li Syntax: ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
2572 * \li Params: statusbar : Toggle visibility of the statusbar.\n
2573 menubar : Toggle visibility of the menubar.\n
2574 scrollbar : Toggle visibility of the scrollbar.\n
2575 frame : Toggle visibility of the frames around editing window.\n
2576 fullscreen : Toggle fullscreen mode. This also covers calling the
2577 previous functions. However #LFUN_TOOLBAR_TOGGLE for the
2578 custom tweaks of the toolbars should be used.
2579 * \li Origin: sanda, 9 Feb 2007
2582 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
2585 * \var lyx::FuncCode lyx::LFUN_WINDOW_NEW
2586 * \li Action: Creates new empty LyX window.
2587 * \li Notion: Already opened documents from the previous window can be found under View menu.
2588 * \li Syntax: window-new [<GEOMETRY>]
2589 * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently
2590 accepted only on Windows platform.
2591 * \li Origin: Abdel, 21 Oct 2006
2594 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
2596 * \var lyx::FuncCode lyx::LFUN_WINDOW_CLOSE
2597 * \li Action: Closes the current LyX window.
2598 * \li Syntax: window-close
2599 * \li Origin: Abdel, 23 Oct 2006
2602 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
2605 * \var lyx::FuncCode lyx::LFUN_SPLIT_VIEW
2606 * \li Action: Creates another split view of current buffer.
2607 * \li Notion: All split views act in the same way indpendently.
2608 * \li Syntax: split-view <vertical|horizontal>
2609 * \li Params: horizontal : The work areas are laid out side by side.\n
2610 vertical : The work areas laid out vertically.
2611 * \li Origin: Abdel, 20 Feb 2008
2614 { LFUN_SPLIT_VIEW, "split-view", ReadOnly, Buffer },
2617 * \var lyx::FuncCode lyx::LFUN_CLOSE_TAB_GROUP
2618 * \li Action: Close the current tab group.
2619 * \li Notion: This only closes the work areas, not the buffer themselves.
2620 The still opened buffers can be visualized in another tab group.
2621 * \li Syntax: close-tab-group
2622 * \li Origin: Abdel, 21 Feb 2008
2625 { LFUN_CLOSE_TAB_GROUP, "close-tab-group", ReadOnly, Buffer },
2627 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW
2628 * \li Action: Shows hidden dialog or create new one for a given function/inset settings etc.
2629 * \li Syntax: dialog-show <NAME> [<DATA>]
2630 * \li Params: <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|\n
2631 compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|\n
2632 graphics|href|include|index|index_print|info|label|listings|log|mathdelimiter|\n
2633 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|\n
2634 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|\n
2635 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL> \n
2636 <SPECIAL>: latexlog|vclog \n
2637 <DATA>: data, usually settings for the given dialog. Use debug mode for the
2639 * \li Origin: leeming, 17 Jun 2003
2642 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
2644 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW_NEW_INSET
2645 * \li Action: Shows hidden dialog or create new one for a given inset settings etc.
2646 * \li Notion: Internally uses #LFUN_DIALOG_SHOW with processed data for a given inset.
2647 * \li Syntax: dialog-show-new-inset <NAME> [<DATA>]
2648 * \li Params: See #LFUN_DIALOG_SHOW .
2649 * \li Origin: leeming, 25 Feb 2003
2652 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
2654 * \var lyx::FuncCode lyx::LFUN_DIALOG_UPDATE
2655 * \li Action: Updates the dialog values from the inset/paragraph/document.
2656 * \li Syntax: dialog-update <NAME>
2657 * \li Params: <NAME>: paragraph|prefs|<INSET> \n
2659 * \li Origin: leeming, 25 Feb 2003
2662 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
2664 * \var lyx::FuncCode lyx::LFUN_DIALOG_HIDE
2665 * \li Action: Hides showed dialog. Counterpart to #LFUN_DIALOG_SHOW .
2666 * \li Syntax: dialog-hide <NAME>
2667 * \li Params: See #LFUN_DIALOG_SHOW .
2668 * \li Origin: leeming, 25 Feb 2003
2671 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
2673 * \var lyx::FuncCode lyx::LFUN_DIALOG_TOGGLE
2674 * \li Action: Toggles dialog between showed/hidden state.
2675 * \li Notion: Internally uses #LFUN_DIALOG_SHOW , #LFUN_DIALOG_HIDE .
2676 * \li Syntax: dialog-toggle <NAME> [<DATA>]
2677 * \li Params: See #LFUN_DIALOG_SHOW .
2678 * \li Origin: JSpitzm, 30 Apr 2007
2681 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
2683 * \var lyx::FuncCode lyx::LFUN_DIALOG_DISCONNECT_INSET
2684 * \li Action: Closes opened connection to opened inset.
2685 * \li Notion: Connection is used for apply functions.
2686 * \li Syntax: dialog-disconnect-inset <INSET-NAME>
2687 * \li Origin: leeming, 25 Feb 2003
2690 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
2693 * \var lyx::FuncCode lyx::LFUN_MOUSE_PRESS
2694 * \li Action: This function is called when mouse button is pressed (inside workarea).
2695 Action depends on the context.
2696 * \li Notion: This is internal LFUN, not to be used by users.
2697 * \li Origin: Andre, 9 Aug 2002
2700 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
2702 * \var lyx::FuncCode lyx::LFUN_MOUSE_DOUBLE
2703 * \li Action: This function is called when double click on mouse button is
2704 pressed (inside workarea). Action depends on the context.
2705 * \li Notion: This is internal LFUN, not to be used by users.
2706 * \li Origin: Andre, 9 Aug 2002
2709 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
2711 * \var lyx::FuncCode lyx::LFUN_MOUSE_TRIPLE
2712 * \li Action: This function is called when triple click on mouse button is
2713 pressed (inside workarea). Action depends on the context.
2714 * \li Notion: This is internal LFUN, not to be used by users.
2715 * \li Origin: Andre, 9 Aug 2002
2718 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
2720 * \var lyx::FuncCode lyx::LFUN_MOUSE_MOTION
2721 * \li Action: This function is called when mouse cursor is moving over the text.
2722 Action depends on the context.
2723 * \li Notion: This is internal LFUN, not to be used by users.
2724 * \li Origin: Andre, 9 Aug 2002
2727 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
2729 * \var lyx::FuncCode lyx::LFUN_MOUSE_RELEASE
2730 * \li Action: This function is called when mouse button is released (inside workarea).
2731 Action depends on the context.
2732 * \li Notion: This is internal LFUN, not to be used by users.
2733 * \li Origin: Andre, 9 Aug 2002
2736 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
2739 * \var lyx::FuncCode lyx::LFUN_KEYMAP_OFF
2740 * \li Action: Turn off the loaded keyboard map.
2741 * \li Syntax: keymap-off
2744 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
2746 * \var lyx::FuncCode lyx::LFUN_KEYMAP_PRIMARY
2747 * \li Action: Turn on the primary keyboard map.
2748 * \li Notion: Maps were widely used in past, when X-windows didn't have nowadays
2749 keyboard support. They can be still used to maintain uniform keyboard
2750 layout across the various plaforms.\n
2751 The language is to be set in the Preferences dialog.
2752 * \li Syntax: keymap-primary
2755 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
2757 * \var lyx::FuncCode lyx::LFUN_KEYMAP_SECONDARY
2758 * \li Action: Turn on the secondary keyboard map.
2759 * \li Syntax: keymap-secondary
2762 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
2764 * \var lyx::FuncCode lyx::LFUN_KEYMAP_TOGGLE
2765 * \li Action: Toggles keyboard maps (first/second/off).
2766 * \li Syntax: keymap-toggle
2767 * \li Origin: leeming, 30 Mar 2004
2770 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
2773 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_LAYOUT
2774 * \li Action: Returns the current layout (that is environment) name
2775 on the cursor position.
2776 * \li Syntax: server-get-layout
2779 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
2781 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_FILENAME
2782 * \li Action: Returns path and file name of the currently edited document.
2783 * \li Syntax: server-get-filename
2786 { LFUN_SERVER_GET_FILENAME, "server-get-filename", ReadOnly, System },
2788 * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
2789 * \li Action: Sets the cursor position based on the row number of generated TeX file.
2790 * \li Notion: This can be useful for DVI inverse-search or detection of the problematic
2791 line from LaTeX compilation. Note that before this function can be used
2792 export to LaTeX output must occur (in order to map the row numbers).
2793 * \li Syntax: server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
2794 * \li Params: <FILE>: the filename. Environment variables are expanded in the path.
2795 In case this LFUN does not work make sure you are giving correct
2797 If the file is located inside LyX temporary directory it will be
2798 mapped back into the appropriate opened buffer (e.g. for the case
2799 of generated .tex file).
2800 .ext: extensions will be automatically replaced by .lyx.
2801 <ROW_NUMBER> The row number of the LaTeX file to which to go.
2802 * \li Origin: Edmar, 23 Dec 1998
2805 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly | NoBuffer, System },
2807 * \var lyx::FuncCode lyx::LFUN_SERVER_NOTIFY
2808 * \li Action: Sends notify message about the last key-sequence to client.
2809 * \li Notion: This can be used to grab last key-sequence used inside the LyX window.
2810 See also Debug extensions section in Additional features manual.
2811 * \li Syntax: server-notify
2814 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
2816 * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
2817 * \li Action: Sets the cursor position based on the editing area coordinates
2818 (similar as clicking on that point with left mouse button).
2819 * \li Syntax: server-set-xy <X> <Y>
2822 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
2824 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
2825 * \li Action: Returns the coordinates of cursor position in the editing area.
2826 * \li Syntax: server-get-xy
2829 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
2832 * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
2833 * \li Action: Generates the code (literate programming).
2834 * \li Notion: Latex file with extension \literate_extension is generated.
2835 Then LyX invokes \build_command (with a default of``make'') to generate the code and
2836 \build_error_filter to process the compilation error messages. \n
2837 In case you want to process your literate file with a script, or some other program,
2838 just insert in your lyxrc file an entry with:\n
2839 \build_command "my_script my_arguments" \n
2840 The \build_error_filter differs from the \literate_error_filter only in that the
2841 former will identify error messages from your compiler.
2842 * \li Syntax: build-program
2845 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
2848 * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
2849 * \li Action: Saves the current buffer to a temporary file.
2850 * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
2851 is called automatically by LyX, to "autosave" the current buffer.
2852 * \li Syntax: buffer-auto-save
2855 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
2857 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHILD_OPEN
2858 * \li Action: Loads the given child document.
2859 * \li Notion: The current document is treated as a parent.
2860 * \li Syntax: buffer-child-open <FILE>
2861 * \li Params: <FILE>: Filename of the child. The directory of the parent is assumed by default.
2862 * \li Origin: Ale, 28 May 1997
2865 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
2867 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHKTEX
2868 * \li Action: Runs chktex for the current document.
2869 * \li Syntax: buffer-chktex
2870 * \li Origin: Asger, 30 Oct 1997
2873 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
2875 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
2876 * \li Action: Toggles compression of the current document on/off.
2877 * \li Syntax: buffer-toggle-compression
2878 * \li Origin: bpeng, 27 Apr 2006
2881 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
2883 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
2884 * \li Action: Closes the current buffer.
2885 * \li Notion: Closes the current buffer, asking whether to save it, etc,
2886 if the buffer has been modified.
2887 * \li Syntax: buffer-close
2890 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
2892 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE_ALL
2893 * \li Action: Closes all buffers.
2894 * \li Notion: Closes all buffers, asking whether to save it, etc,
2895 if a buffer has been modified.
2896 * \li Syntax: buffer-close-all
2899 { LFUN_BUFFER_CLOSE_ALL, "buffer-close-all", ReadOnly, Buffer },
2901 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
2902 * \li Action: Exports the current buffer (document) to the given format.
2903 * \li Syntax: buffer-export <FORMAT>
2904 * \li Params: <FORMAT> is either "custom" or one of the formats which you
2905 can find in Tools->Preferences->File formats->Format.
2906 Usual format you will enter is "pdf2" (pdflatex),
2907 "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
2908 In case of "custom" you will be asked for a format you
2909 want to start from and for the command that you want to
2910 apply to this format. Internally the control is then passed
2911 to #LFUN_BUFFER_EXPORT_CUSTOM.
2912 * \li Origin: Lgb, 29 Jul 1997
2915 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
2917 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
2918 * \li Action: Exports the current buffer (document) from the given format using
2919 the given command on it.
2920 * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
2921 * \li Params: <FORMAT> format to start from (LyX will care to produce such
2922 intermediate file).\n
2923 <COMMAND> this command will be launched on the file. Note that you can
2924 use "$$FName" string to qualify the intermediate file.
2925 * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
2926 * \li Origin: leeming, 27 Mar 2004
2929 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
2931 * \var lyx::FuncCode lyx::LFUN_BUFFER_PRINT
2932 * \li Action: Prints the current document.
2933 * \li Notion: Many settings can be given via the preferences dialog.
2934 * \li Syntax: buffer-print <TARGET> <TARGET-NAME> <COMMAND>
2935 * \li Params: <TARGET> is either "printer" or "file".\n
2936 <TARGER-NAME> is either "default" or file name or printer name.\n
2937 <COMMAND> command ensuring the printing job.
2938 * \li Sample: buffer-print file "/trash/newfile1.ps" "dvips"
2939 * \li Origin: leeming, 28 Mar 2004
2942 { LFUN_BUFFER_PRINT, "buffer-print", ReadOnly, Buffer },
2944 * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
2945 * \li Action: Import a given file as a lyx document.
2946 * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
2947 defined convertors in preferences. Look into File->Import menu to get
2948 an idea of the currently active import formats.
2949 * \li Syntax: buffer-import <FORMAT> [<FILE>]
2950 * \li Origin: Asger, 24 Jul 1998
2953 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
2955 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
2956 * \li Action: Creates a new buffer (that is, document).
2957 * \li Notion: Implicit path can be set in Preferences dialog.
2958 * \li Syntax: buffer-new [<FILE>]
2959 * \li Params: <FILE>: filename of created file with absolute path.
2962 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
2964 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
2965 * \li Action: Creates a new buffer (that is, document) from a template.
2966 * \li Notion: Path for new files and templates can be set in Preferences dialog.
2967 Template will be asked for via Open-dialog.
2968 * \li Syntax: buffer-new-template [<FILE>]
2969 * \li Params: <FILE>: filename of created file with absolute path.
2972 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
2974 * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
2975 * \li Action: Reverts opened document.
2976 * \li Syntax: buffer-reload
2977 * \li Origin: Asger, 2 Feb 1997
2980 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
2982 * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
2983 * \li Action: Display/switch to the given buffer.
2984 * \li Syntax: buffer-switch <BUFFER>
2985 * \li Params: <BUFFER>: path and filename of already opened (but possibly hidden)
2986 document which is to be shown.
2989 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
2991 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
2992 * \li Action: Toggle editing mode of the current document between read/write and read-only.
2993 * \li Notion: This function is not allowed if the file is under version control, since
2994 read-only flag is often used in version control file locking.
2995 * \li Syntax: buffer-toggle-read-only
2996 * \li Origin: Lgb, 27 May 1997
2999 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
3001 * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
3002 * \li Action: Displays current buffer in chosen format.
3003 * \li Notion: Displays the contents of the current buffer in the chosen
3004 format, for example, PDF or DVI. This runs the necessary
3005 converter, calls the defined viewer, and so forth.
3006 * \li Syntax: buffer-view [<FORMAT>]
3007 * \li Params: <FORMAT>: The format to display, where this is one of the
3008 formats defined (in the current GUI) in the
3009 Tools>Preferences>File Formats dialog.
3010 If no format is given, the default format as
3011 specified in the same dialog is used.
3014 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
3016 * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
3017 * \li Action: Exports the current document and put the result into the
3018 temporary directory.
3019 * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
3020 the output will be rewriten - updated. This is useful in case your viewer
3021 is able to detect such changes (e.g. ghostview for postscript).
3022 * \li Syntax: buffer-update [<FORMAT>]
3023 * \li Params: <FORMAT>: The format to display, where this is one of the
3024 formats defined (in the current GUI) in the
3025 Tools>Preferences>File Formats dialog.
3026 If no format is given, the default format as
3027 specified in the same dialog is used.
3028 * \li Origin: Dekel, 5 Aug 2000
3031 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
3034 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
3035 * \li Action: Saves the current buffer.
3036 * \li Notion: Saves the current buffer to disk, using the filename that
3037 is already associated with the buffer, asking for one if
3038 none is yet assigned.
3039 * \li Syntax: buffer-write
3042 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
3044 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
3045 * \li Action: Rename and save current buffer.
3046 * \li Syntax: buffer-write-as <FILENAME>
3047 * \li Params: <FILENAME>: New name of the buffer/file. A relative path
3048 is with respect to the original location of the buffer/file.
3051 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
3053 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
3054 * \li Action: Save all changed documents.
3055 * \li Syntax: buffer-write-all
3056 * \li Origin: rgh, gpothier 6 Aug 2007
3059 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
3061 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEXT
3062 * \li Action: Switch to the next opened document.
3063 * \li Notion: Note that this does not necessarily mean next in tabbar
3064 (for full list see View menu).
3065 * \li Syntax: buffer-next
3068 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
3070 * \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS
3071 * \li Action: Switch to the previous opened document.
3072 * \li Syntax: buffer-previous
3075 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
3077 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
3078 * \li Action: When run from a child document, this updates (exports) document built
3079 from the master buffer, if available.
3080 * \li Syntax: master-buffer-update [<FORMAT>]
3081 * \li Params: <FORMAT>: The format to display, where this is one of the
3082 formats defined (in the current GUI) in the
3083 Tools>Preferences>File Formats dialog.
3084 If no format is given, the default format as
3085 specified in the same dialog is used.
3086 * \li Origin: Tommaso, 20 Sep 2007
3089 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
3091 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
3092 * \li Action: When run from a child document, this command shows a preview built
3093 from the master buffer, if available.
3094 * \li Syntax: master-buffer-view [<FORMAT>]
3095 * \li Params: <FORMAT>: The format to display, where this is one of the
3096 formats defined (in the current GUI) in the
3097 Tools>Preferences>File Formats dialog.
3098 If no format is given, the default format as
3099 specified in the same dialog is used.
3100 * \li Origin: Tommaso, 20 Sep 2007
3103 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
3105 * \var lyx::FuncCode lyx::LFUN_BUFFER_LANGUAGE
3106 * \li Action: Set language of the current document.
3107 * \li Syntax: buffer-language <LANG>
3108 * \li Params: <LANG>: language name. See lib/languages for list.
3109 * \li Origin: leeming, 30 Mar 2004
3112 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
3114 * \var lyx::FuncCode lyx::LFUN_BUFFER_SAVE_AS_DEFAULT
3115 * \li Action: Save the current document settings as default.
3116 * \li Notion: The file will will be saved into ~/.lyx/templates/defaults.lyx .
3117 * \li Syntax: buffer-save-as-default [<ARGS>]
3118 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
3119 you can find in document header of usual .lyx file.
3120 * \li Origin: leeming, 30 Mar 2004
3123 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
3125 * \var lyx::FuncCode lyx::LFUN_BUFFER_PARAMS_APPLY
3126 * \li Action: Apply the given settings to the current document.
3127 * \li Syntax: buffer-params-apply [<ARGS>]
3128 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
3129 you can find in document header of usual .lyx file.
3130 * \li Origin: leeming, 30 Mar 2004
3133 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", NoInternal, Buffer },
3136 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
3137 * \li Action: Inserts another LyX file.
3138 * \li Syntax: file-insert [<FILE>]
3139 * \li Params: <FILE>: Filename to be inserted.
3142 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
3144 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
3145 * \li Action: Inserts plain text file.
3146 * \li Syntax: file-insert-plaintext [<FILE>]
3147 * \li Params: <FILE>: Filename to be inserted.
3148 * \li Origin: CFO-G, 19 Nov 1997
3151 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
3153 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
3154 * \li Action: Inserts plain text file as paragraph (i.e. join lines).
3155 * \li Syntax: file-insert-plaintext-para [<FILE>]
3156 * \li Params: <FILE>: Filename to be inserted.
3157 * \li Origin: Levon, 14 Feb 2001
3160 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
3162 * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
3163 * \li Action: Open LyX document.
3164 * \li Syntax: file-open [<FILE>]
3165 * \li Params: <FILE>: Filename to be opened.
3168 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
3171 * \var lyx::FuncCode lyx::LFUN_CALL
3172 * \li Action: Executes a command defined in a .def file.
3173 * \li Notion: The definitions are by default read from lib/commands/default.def.\n
3174 A .def file allows to define a command with \define "<NAME>" "<LFUN>"
3175 where <NAME> is the name of the new command and <LFUN> is the lfun code
3176 to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
3177 \def_file "FileName" allows to include another .def file. \n
3178 This is particularly useful in connection with toolbar buttons:
3179 Since the name of the button image for this lfun is
3180 lib/images/commands/<NAME>.png this is the way to assign an image
3181 to a complex command-sequence.
3182 * \li Syntax: call <NAME>
3183 * \li Params: <NAME>: Name of the command that must be called.
3184 * \li Origin: broider, 2 Oct 2007
3187 { LFUN_CALL, "call", NoBuffer, System },
3189 * \var lyx::FuncCode lyx::LFUN_META_PREFIX
3190 * \li Action: Simulate halting Meta key (Alt key on PCs).
3191 * \li Notion: Used for buffer editation not for GUI control.
3192 * \li Syntax: meta-prefix
3195 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
3197 * \var lyx::FuncCode lyx::LFUN_CANCEL
3198 * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
3199 * \li Syntax: cancel
3202 { LFUN_CANCEL, "cancel", NoBuffer, System },
3205 * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
3206 * \li Action: Switches the focus to the minibuffer so that the user can type
3207 in there. If necessary, it opens the minibuffer toolbar.
3208 * \li Notion: Usually bound to M-x shortcut.
3209 * \li Syntax: command-execute
3212 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
3215 * \var lyx::FuncCode lyx::LFUN_COMMAND_PREFIX
3216 * \li Action: Return the current key sequence and available options as a string.
3217 * \li Notion: No options are added if no current map exists. \n
3218 This is probably usable only with connection to lyxserver.
3219 * \li Syntax: command-prefix
3222 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
3224 * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
3225 * \li Action: Run more commands (LFUN and its parameters) in a sequence.
3226 * \li Syntax: command-sequence <CMDS>
3227 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
3228 * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
3229 * \li Origin: Andre, 11 Nov 1999
3232 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
3234 * \var lyx::FuncCode lyx::LFUN_COMMAND_ALTERNATIVES
3235 * \li Action: Runs the first listed command that is enabled.
3236 * \li Notion: This can be used to bind multiple functions to a single key,
3237 and then which one is used will depend upon the context.
3238 * \li Syntax: command-alternatives <CMDS>
3239 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
3240 * \li Sample: command-alternatives completion-accept;cell-forward
3241 * \li Origin: rgh, 24 September 2008
3244 { LFUN_COMMAND_ALTERNATIVES, "command-alternatives", NoBuffer, System },
3246 * \var lyx::FuncCode lyx::LFUN_MESSAGE
3247 * \li Action: Shows message in statusbar (for script purposes).
3248 * \li Syntax: message <STRING>
3249 * \li Origin: Lgb, 8 Apr 2001
3252 { LFUN_MESSAGE, "message", NoBuffer, System },
3254 * \var lyx::FuncCode lyx::LFUN_DEBUG_LEVEL_SET
3255 * \li Action: Set debug output level.
3256 * \li Syntax: debug-level-set <LEVEL>
3257 * \li Params: <LEVEL>: comma separated list of levels or the correspondent number
3258 of their combination. 0 is equivalent to disabling all debug
3259 events. See lyx -dbg for the current list of debug levels
3261 * \li Origin: sanda, 28 Dec 2009
3264 { LFUN_DEBUG_LEVEL_SET, "debug-level-set", NoBuffer, System },
3267 * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
3268 * \li Action: Save user preferences.
3269 * \li Syntax: preferences-save
3270 * \li Origin: Lgb, 27 Nov 1999
3273 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
3275 * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
3276 * \li Action: Reconfigure the automatic settings.
3277 * \li Syntax: reconfigure
3278 * \li Origin: Asger, 14 Feb 1997
3281 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
3283 * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
3284 * \li Action: Apply the given settings to user preferences.
3285 * \li Syntax: lyxrc-apply <SETTINGS>
3286 * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
3287 to get an idea which commands to use and their syntax.
3288 #lyx::LyXRC::LyXRCTags has the list of possible commands.
3291 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
3293 * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
3294 * \li Action: Determine whether keep cursor inside the editing window regardless
3295 the scrollbar movement.
3296 * \li Syntax: toggle-cursor-follows-scrollbar
3297 * \li Origin: ARRae, 2 Dec 1997
3300 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
3302 * \var lyx::FuncCode lyx::LFUN_SET_COLOR
3303 * \li Action: Set the given LyX color to the color defined by the X11 name given.
3304 * \li Notion: A new color entry is created if the color is unknown.
3305 Color names can be stored as a part of user settings.
3306 * \li Syntax: set-color <LYX_NAME> <X11_NAME>
3307 * \li Origin: SLior, 11 Jun 2000
3310 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
3312 * \var lyx::FuncCode lyx::LFUN_STATISTICS
3313 * \li Action: Count the statistics (number of words and characters)
3314 in the document or in the given selection.
3315 * \li Notion: Note that this function gives the number of words/chars written,
3316 not the number of characters which will be typeset.
3317 * \li Syntax: statistics
3318 * \li Origin: lasgouttes, Jan 27 2004; sanda, Jan 8 2008
3321 { LFUN_STATISTICS, "statistics", ReadOnly, System },
3323 * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
3324 * \li Action: Show the inline completion at the cursor position.
3325 * \li Syntax: completion-inline
3326 * \li Origin: sts, Feb 19 2008
3329 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
3331 * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
3332 * \li Action: Show the completion popup at the cursor position.
3333 * \li Syntax: completion-popup
3334 * \li Origin: sts, Feb 19 2008
3337 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
3339 * \var lyx::FuncCode lyx::LFUN_COMPLETION_COMPLETE
3340 * \li Action: Try to complete the word or command at the cursor position.
3341 * \li Syntax: complete
3342 * \li Origin: sts, Feb 19 2008
3345 { LFUN_COMPLETION_COMPLETE, "complete", SingleParUpdate, Edit },
3348 * \var lyx::FuncCode lyx::LFUN_COMPLETION_CANCEL
3349 * \li Action: Try to cancel completion, either the popup or the inline completion.
3350 * \li Syntax: completion-cancel
3351 * \li Origin: sts, Sep 07 2008
3354 { LFUN_COMPLETION_CANCEL, "completion-cancel", SingleParUpdate, Edit },
3356 * \var lyx::FuncCode lyx::LFUN_COMPLETION_ACCEPT
3357 * \li Action: Accept suggested completion.
3358 * \li Syntax: completion-accept
3359 * \li Origin: sanda, Sep 08 2008
3362 { LFUN_COMPLETION_ACCEPT, "completion-accept", SingleParUpdate, Edit },
3366 * \var lyx::FuncCode lyx::LFUN_BRANCH_ADD
3367 * \li Action: Add a branch to the buffer's BranchList.
3368 * \li Syntax: branch-add <BRANCH>
3369 * \li Params: <BRANCH>: Name of the branch to add
3370 * \li Origin: spitz, 7 Jul 2009
3373 { LFUN_BRANCH_ADD, "branch-add", Noop, Buffer },
3377 * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
3378 * \li Action: Activate the branch.
3379 * \li Syntax: branch-activate <BRANCH>
3380 * \li Params: <BRANCH>: The branch to activate
3381 * \li Sample: lyx -x "branch-activate answers" -e pdf2 finalexam.lyx \n
3382 could be used to export a pdf with the answers branch included
3383 without one's having to open LyX and activate the branch manually.
3384 * \li Origin: rgh, 27 May 2008
3387 { LFUN_BRANCH_ACTIVATE, "branch-activate", AtPoint, Buffer },
3389 * \var lyx::FuncCode lyx::LFUN_BRANCH_DEACTIVATE
3390 * \li Action: De-activate the branch.
3391 * \li Syntax: branch-deactivate <BRANCH>
3392 * \li Params: <BRANCH>: The branch to deactivate
3393 * \li Origin: rgh, 27 May 2008
3396 { LFUN_BRANCH_DEACTIVATE, "branch-deactivate", AtPoint, Buffer },
3399 * \var lyx::FuncCode lyx::LFUN_BRANCHES_RENAME
3400 * \li Action: Rename all branches of a given name in a document.
3401 * \li Syntax: branches-rename <OLDNAME> <NEWNAME>
3402 * \li Params: <OLDNAME>: Current name of the branch to be renamed
3403 * <NEWNAME>: New name of the branch
3404 * \li Origin: spitz, 9 Jul 2009
3407 { LFUN_BRANCHES_RENAME, "branches-rename", Noop, Buffer },
3409 * \var lyx::FuncCode lyx::LFUN_BRANCH_ADD_INSERT
3410 * \li Action: Create new branch and directly put the branch inset into
3412 * \li Syntax: branch-add-insert [<NAME>]
3413 * \li Params: <NAME>: Branch name. If it is not specified, you will be asked.
3414 * \li Origin: sanda, 10 Jul 2009
3417 { LFUN_BRANCH_ADD_INSERT, "branch-add-insert", Noop, Buffer },
3421 * \var lyx::FuncCode lyx::LFUN_LABEL_COPY_AS_REF
3422 * \li Action: Copies the label at the cursor as a cross-reference to be pasted elsewhere.
3423 * \li Syntax: copy-label-as-reference <LABEL>
3424 * \li Params: <LABEL>: The label to copy (for multi-line math)
3425 * \li Origin: sts, 16 Nov 2008
3428 { LFUN_LABEL_COPY_AS_REF, "copy-label-as-reference", ReadOnly | NoUpdate, Edit },
3431 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT_AS_REF
3432 * \li Action: Inserts the label as a cross-reference at the position of the cursor.
3433 * \li Syntax: label-insert-as-reference
3434 * \li Origin: vfr, 7 Apr 2009
3437 { LFUN_LABEL_INSERT_AS_REF, "label-insert-as-reference", Noop, Edit},
3440 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_IN
3441 * \li Action: Increases the zoom of the screen fonts.
3442 * \li Syntax: buffer-zoom-in [<ZOOM>]
3443 * \li Params: <ZOOM>: The zoom in %, the default is 20.
3444 * \li Origin: vfr, 30 Mar 2009
3447 { LFUN_BUFFER_ZOOM_IN, "buffer-zoom-in", ReadOnly, Buffer },
3450 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_OUT
3451 * \li Action: Decreases the zoom of the screen fonts.
3452 * \li Syntax: buffer-zoom-out [<ZOOM>]
3453 * \li Params: <ZOOM>: The zoom in %, the default is 20.
3454 * \li Origin: vfr, 30 Mar 2009
3457 { LFUN_BUFFER_ZOOM_OUT, "buffer-zoom-out", ReadOnly, Buffer },
3461 { LFUN_NOACTION, "", Noop, Hidden }
3462 #ifndef DOXYGEN_SHOULD_SKIP_THIS
3465 for (int i = 0; items[i].action != LFUN_NOACTION; ++i)
3466 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
3472 LyXAction::LyXAction()
3478 FuncRequest LyXAction::lookupFunc(string const & func) const
3480 string const func2 = trim(func);
3483 return FuncRequest(LFUN_NOACTION);
3486 string const arg = split(func2, cmd, ' ');
3488 FuncMap::const_iterator const fit = lyx_func_map.find(cmd);
3490 return fit != lyx_func_map.end()
3491 ? FuncRequest(fit->second, arg)
3492 : FuncRequest(LFUN_UNKNOWN_ACTION);
3496 string const LyXAction::getActionName(FuncCode action) const
3498 InfoMap::const_iterator const it = lyx_info_map.find(action);
3499 return it != lyx_info_map.end() ? it->second.name : string();
3503 LyXAction::FuncType LyXAction::getActionType(FuncCode action) const
3505 InfoMap::const_iterator const it = lyx_info_map.find(action);
3506 return it != lyx_info_map.end() ? it->second.type : Hidden;
3510 bool LyXAction::funcHasFlag(FuncCode action,
3511 LyXAction::FuncAttribs flag) const
3513 InfoMap::const_iterator ici = lyx_info_map.find(action);
3515 if (ici == lyx_info_map.end()) {
3516 LYXERR0("action: " << action << " is not known.");
3517 LASSERT(false, /**/);
3520 return ici->second.attrib & flag;
3524 LyXAction::const_iterator LyXAction::func_begin() const
3526 return lyx_func_map.begin();
3530 LyXAction::const_iterator LyXAction::func_end() const
3532 return lyx_func_map.end();
3536 LyXErr & operator<<(LyXErr & l, FuncCode code)
3539 l.stream() << lyxaction.getActionName(code);