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"
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_THESAURUS_ENTRY
985 * \li Action: Look up thesaurus entries with respect to the word under the cursor.
986 * \li Syntax: thesaurus-entry [<STRING>] [lang=<LANG>]
987 * \li Params: <STRING>: word to look up
988 <LANG>: language (see file languages)
989 * \li Origin: Levon, 20 Jul 2001
992 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
994 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN
995 * \li Action: Move the cursor to the beginning of the document.
996 * \li Syntax: buffer-begin
999 { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
1001 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN_SELECT
1002 * \li Action: Move the cursor to the beginning of the document adding the
1003 traversed text to the selection.
1004 * \li Syntax: buffer-begin-select
1007 { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
1009 * \var lyx::FuncCode lyx::LFUN_BUFFER_END
1010 * \li Action: Move the cursor to the end of the document.
1011 * \li Syntax: buffer-end
1014 { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
1016 * \var lyx::FuncCode lyx::LFUN_BUFFER_END_SELECT
1017 * \li Action: Move the cursor to the end of the document adding the
1018 traversed text to the selection.
1019 * \li Syntax: buffer-end-select
1022 { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
1025 * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN
1026 * \li Action: Move the cursor to the beginning of the current inset
1027 if it is not already there, or at the beginning of the
1028 enclosing inset otherwise
1029 * \li Syntax: inset-begin
1030 * \li Origin: lasgouttes, 16 Mar 2009
1033 { LFUN_INSET_BEGIN, "inset-begin", ReadOnly, Edit },
1035 * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN_SELECT
1036 * \li Action: Move the cursor to the beginning of the current inset
1037 if it is not already there, or at the beginning of the
1038 enclosing inset otherwise (adding the
1039 traversed text to the selection).
1040 * \li Syntax: inset-begin-select
1041 * \li Origin: lasgouttes, 16 Mar 2009
1044 { LFUN_INSET_BEGIN_SELECT, "inset-begin-select", ReadOnly, Edit },
1046 * \var lyx::FuncCode lyx::LFUN_INSET_END
1047 * \li Action: Move the cursor to the end of the current inset
1048 if it is not already there, or at the end of the
1049 enclosing inset otherwise
1050 * \li Syntax: inset-end
1051 * \li Origin: lasgouttes, 16 Mar 2009
1054 { LFUN_INSET_END, "inset-end", ReadOnly, Edit },
1056 * \var lyx::FuncCode lyx::LFUN_INSET_END_SELECT
1057 * \li Action: Move the cursor to the end of the current inset
1058 if it is not already there, or at the end of the
1059 enclosing inset otherwise (adding the
1060 traversed text to the selection).
1061 * \li Syntax: inset-end-select
1062 * \li Origin: lasgouttes, 16 Mar 2009
1065 { LFUN_INSET_END_SELECT, "inset-end-select", ReadOnly, Edit },
1068 * \var lyx::FuncCode lyx::LFUN_INSET_SELECT_ALL
1069 * \li Action: Selects all contents of an inset.
1070 * \li Syntax: inset-select-all
1071 * \li Origin: vfr, 22 Aug 2009
1074 { LFUN_INSET_SELECT_ALL, "inset-select-all", ReadOnly, Edit },
1077 * \var lyx::FuncCode lyx::LFUN_SECTION_SELECT
1078 * \li Action: Selects the whole section.
1079 * \li Notion: The cursor should be in a section heading
1080 before calling this lfun.
1081 * \li Syntax: section-select
1082 * \li Origin: vfr, 05 May 2009
1085 { LFUN_SECTION_SELECT, "section-select", ReadOnly, Edit },
1088 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN
1089 * \li Action: Move the cursor to the begining of the (screen) line.
1090 * \li Syntax: line-begin
1093 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
1095 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN_SELECT
1096 * \li Action: Move the cursor to the beginning of the (screen) line adding the
1097 traversed text to the selection.
1098 * \li Syntax: line-begin-select
1101 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
1103 * \var lyx::FuncCode lyx::LFUN_LINE_END
1104 * \li Action: Move the cursor to the end of the (screen) line.
1105 * \li Syntax: line-end
1108 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
1110 * \var lyx::FuncCode lyx::LFUN_LINE_END_SELECT
1111 * \li Action: Move the cursor to the end of the (screen) line adding the
1112 traversed text to the selection.
1113 * \li Syntax: line-end-select
1116 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
1118 * \var lyx::FuncCode lyx::LFUN_LINE_DELETE
1119 * \li Action: Deletes the letters to the end of the (screen) line or
1120 deletes the selection.
1121 * \li Syntax: line-delete-forward
1124 { LFUN_LINE_DELETE, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
1126 * \var lyx::FuncCode lyx::LFUN_COPY
1127 * \li Action: Copies to the clipboard the last edit.
1131 { LFUN_COPY, "copy", ReadOnly, Edit },
1133 * \var lyx::FuncCode lyx::LFUN_CUT
1134 * \li Action: Cuts to the clipboard.
1138 { LFUN_CUT, "cut", Noop, Edit },
1140 * \var lyx::FuncCode lyx::LFUN_PASTE
1141 * \li Action: Pastes material (text or picture) from the active clipboard.
1142 * \li Syntax: paste [<TYPE>|<NUM>]
1143 * \li Params: <TYPE>: emf|pdf|png|jpeg|linkback|wmf \n
1144 <NUM>: number of the selection in the internal clipboard stack to be pasted.
1147 { LFUN_PASTE, "paste", Noop, Edit },
1149 * \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE
1150 * \li Action: Pastes text from the active clipboard.
1151 * \li Syntax: clipboard-paste [<ARG>]
1152 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1153 * \li Origin: baum, 10 Jul 2006
1156 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
1158 * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
1159 * \li Action: Pastes the currently text selected text.
1160 * \li Notion: Primary selection mechanism is linux-only thing.
1161 * \li Syntax: primary-selection-paste [<ARG>]
1162 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1165 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
1167 * \var lyx::FuncCode lyx::LFUN_SELECTION_PASTE
1168 * \li Action: Pastes the text in permanent selection.
1169 * \li Syntax: selection-paste
1172 { LFUN_SELECTION_PASTE, "selection-paste", Noop, Edit },
1174 * \var lyx::FuncCode lyx::LFUN_UNDO
1175 * \li Action: Undoes the last edit.
1179 { LFUN_UNDO, "undo", Noop, Edit },
1181 * \var lyx::FuncCode lyx::LFUN_REDO
1182 * \li Action: Redoes the last thing undone.
1186 { LFUN_REDO, "redo", Noop, Edit },
1188 * \var lyx::FuncCode lyx::LFUN_REPEAT
1189 * \li Action: Repeat the given command.
1190 * \li Syntax: repeat <COUNT> <LFUN-COMMAND>
1191 * \li Origin: Andre, 27 Oct 2003
1194 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
1196 * \var lyx::FuncCode lyx::LFUN_CHARS_TRANSPOSE
1197 * \li Action: Transposes the character at the cursor with the one before it.
1198 * \li Syntax: chars-transpose
1199 * \li Origin: Lgb, 25 Apr 2001
1202 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
1205 * \var lyx::FuncCode lyx::LFUN_DEPTH_DECREMENT
1206 * \li Action: Decrease the nesting depth of the (selected) paragraph(s)
1208 * \li Syntax: depth-decrement
1211 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
1213 * \var lyx::FuncCode lyx::LFUN_DEPTH_INCREMENT
1214 * \li Action: Increase the nesting depth of the (selected) paragraph(s)
1216 * \li Syntax: depth-increment
1219 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
1222 * \var lyx::FuncCode lyx::LFUN_FONT_BOLD
1223 * \li Action: Toggles the bold font (selection-wise) using mathbf in math.
1224 * \li Syntax: font-bold
1227 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
1230 * \var lyx::FuncCode lyx::LFUN_FONT_BOLDSYMBOL
1231 * \li Action: Toggles the bold font (selection-wise) using boldsymbol in math.
1232 * \li Syntax: font-boldsymbol
1235 { LFUN_FONT_BOLDSYMBOL, "font-boldsymbol", Noop, Layout },
1237 * \var lyx::FuncCode lyx::LFUN_FONT_TYPEWRITER
1238 * \li Action: Toggles the typewriter family font (selection-wise).
1239 * \li Syntax: font-typewriter
1242 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
1244 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERLINE
1245 * \li Action: Toggles underline in the font (selection-wise).
1246 * \li Syntax: font-underline
1249 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
1251 * \var lyx::FuncCode lyx::LFUN_FONT_UULINE
1252 * \li Action: Toggles double underline in the font (selection-wise).
1253 * \li Syntax: font-underunderline
1254 * \li Origin: sanda, 5 May 2009
1257 { LFUN_FONT_UULINE, "font-underunderline", Noop, Layout },
1259 * \var lyx::FuncCode lyx::LFUN_FONT_UWAVE
1260 * \li Action: Toggles wavy underline in the font (selection-wise).
1261 * \li Syntax: font-underwave
1262 * \li Origin: sanda, 5 May 2009
1265 { LFUN_FONT_UWAVE, "font-underwave", Noop, Layout },
1267 * \var lyx::FuncCode lyx::LFUN_FONT_STRIKEOUT
1268 * \li Action: Toggles strikeout (strike-through) in the font (selection-wise).
1269 * \li Syntax: font-strikeout
1270 * \li Origin: sanda, 3 May 2009
1273 { LFUN_FONT_STRIKEOUT, "font-strikeout", Noop, Layout },
1275 * \var lyx::FuncCode lyx::LFUN_FONT_EMPH
1276 * \li Action: Toggles the emphasis font style (selection-wise).
1277 * \li Syntax: font-emph
1280 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
1282 * \var lyx::FuncCode lyx::LFUN_FONT_NOUN
1283 * \li Action: Toggles Noun text style font (selection-wise).
1284 * \li Syntax: font-noun
1287 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
1289 * \var lyx::FuncCode lyx::LFUN_FONT_ROMAN
1290 * \li Action: Toggles Roman family font (selection-wise).
1291 * \li Syntax: font-roman
1294 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
1296 * \var lyx::FuncCode lyx::LFUN_FONT_SANS
1297 * \li Action: Toggles Sans Serif family font (selection-wise).
1298 * \li Syntax: font-sans
1301 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
1303 * \var lyx::FuncCode lyx::LFUN_FONT_FRAK
1304 * \li Action: Toggles Fraktur family font (math-mode, selection-wise).
1305 * \li Syntax: font-frak
1306 * \li Origin: vermeer, 10 Jan 2002
1309 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
1311 * \var lyx::FuncCode lyx::LFUN_FONT_ITAL
1312 * \li Action: Toggles Italics font shape (math-mode, selection-wise).
1313 * \li Syntax: font-ital
1314 * \li Origin: vermeer, 10 Jan 2002
1317 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
1319 * \var lyx::FuncCode lyx::LFUN_FONT_DEFAULT
1320 * \li Action: Reverts the settings of the font to the default values (selection-wise).
1321 * \li Syntax: font-default
1324 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
1326 * \var lyx::FuncCode lyx::LFUN_FONT_SIZE
1327 * \li Action: Sets font size according to lyx format string.
1328 * \li Syntax: font-size <SIZE>
1329 * \li Params: <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|\n
1330 largest|huge|giant|increase|decrease|default
1333 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
1335 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_APPLY
1336 * \li Action: Toggle user-defined (=last-time used) text style.
1337 * \li Notion: This style is set via #LFUN_TEXTSTYLE_UPDATE, which is
1338 automatically trigerred when using Text Style dialog.
1339 * \li Syntax: textstyle-apply
1340 * \li Origin: leeming, 12 Mar 2003
1343 { LFUN_TEXTSTYLE_APPLY, "textstyle-apply", Noop, Layout },
1345 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_UPDATE
1346 * \li Action: Apply text style and update the settings to be used by #LFUN_TEXTSTYLE_APPLY.
1347 * \li Syntax: textstyle-update <FONT_INFO>
1348 * \li Params: <FONT_INFO>: specifies font atributes, e.g. family, series, shape,
1349 size, emph, noun, underbar, number, color, language,
1351 Use lyx -dbg action for exact syntax of text-style
1353 * \li Origin: leeming, 12 Mar 2003
1356 { LFUN_TEXTSTYLE_UPDATE, "textstyle-update", Noop, Layout },
1358 * \var lyx::FuncCode lyx::LFUN_SCREEN_FONT_UPDATE
1359 * \li Action: Update fonts and its metrics.
1360 * \li Notion: Automatically called after zoom, dpi, font names, or norm change.
1361 * \li Syntax: screen-font-update
1362 * \li Origin: ARRae, 13 Aug 2000
1365 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
1367 * \var lyx::FuncCode lyx::LFUN_FONT_STATE
1368 * \li Action: Returns the info about the current font.
1369 * \li Syntax: font-state
1372 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
1375 * \var lyx::FuncCode lyx::LFUN_CITATION_INSERT
1376 * \li Action: Inserts citation from loaded citation database.
1377 * \li Syntax: citation-insert [<KEY>[|<TEXT_BEFORE>]]
1378 * \li Params: <KEY>: Citation (shortcut listed in available citations). \n
1379 <TEXT_BEFORE>: text which should appear before citation.
1380 * \li Origin: AAS, 97-02-23
1383 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
1385 * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_ADD
1386 * \li Action: Adds database, which will be used for bibtex citations.
1387 * \li Notion: Databases are added to the first BibTeX inset
1388 (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
1389 * \li Syntax: bibtex-database-add <DATABASE-NAME>
1390 * \li Origin: Ale, 30 May 1997
1393 { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit },
1395 * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_DEL
1396 * \li Action: Adds database, which will be used for bibtex citations.
1397 * \li Notion: Databases are deleted from the first BibTeX inset
1398 (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
1399 * \li Syntax: bibtex-database-del <DATABASE-NAME>
1400 * \li Origin: Ale, 30 May 1997
1403 { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
1406 * \var lyx::FuncCode lyx::LFUN_LAYOUT
1407 * \li Action: Sets the layout (that is, environment) for the current paragraph.
1408 * \li Syntax: layout <LAYOUT>
1409 * \li Params: <LAYOUT>: the layout to use
1412 { LFUN_LAYOUT, "layout", Noop, Layout },
1414 * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH
1415 * \li Action: Launches the paragraph settings dialog.
1416 * \li Syntax: layout-paragraph
1419 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
1421 * \var lyx::FuncCode lyx::LFUN_LAYOUT_TABULAR
1422 * \li Action: Launches the tabular settings dialog.
1423 * \li Syntax: layout-tabular
1424 * \li Origin: Jug, 31 Jul 2000
1427 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
1429 * \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE
1430 * \li Action: Displays list of layout choices.
1431 * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
1432 dropbox allowing for choice of layout.
1433 * \li Syntax: drop-layouts-choice
1436 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
1438 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
1439 * \li Action: Clears the module list.
1440 * \li Notion: Clears the list of included modules for the current buffer.
1441 * \li Syntax: layout-modules-clear
1442 * \li Origin: rgh, 25 August 2007
1445 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", NoInternal, Layout },
1447 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULE_ADD
1448 * \li Action: Adds a module.
1449 * \li Notion: Adds a module to the list of included modules for the current buffer.
1450 * \li Syntax: layout-module-add <MODULE>
1451 * \li Params: <MODULE>: the module to be added
1452 * \li Origin: rgh, 25 August 2007
1455 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", NoInternal, Layout },
1457 * \var lyx::FuncCode lyx::LFUN_LAYOUT_RELOAD
1458 * \li Action: Reloads layout information.
1459 * \li Notion: Reloads all layout information for the current buffer from disk, thus
1460 recognizing any changes that have been made to layout files on the fly.
1461 This is intended to be used only by layout developers and should not be
1462 used when one is trying to do actual work.
1463 * \li Syntax: layout-reload
1464 * \li Origin: rgh, 3 September 2007
1467 { LFUN_LAYOUT_RELOAD, "layout-reload", NoInternal, Layout },
1469 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
1470 * \li Action: Sets the text class for the current buffer.
1471 * \li Syntax: textclass-apply <TEXTCLASS>
1472 * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
1473 the filename, minus the ".layout" extension.
1476 { LFUN_TEXTCLASS_APPLY, "textclass-apply", NoInternal, Layout },
1478 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
1479 * \li Action: Loads information for a textclass from disk.
1480 * \li Syntax: textclass-load <TEXTCLASS>
1481 * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
1482 the filename, minus the ".layout" extension.
1485 { LFUN_TEXTCLASS_LOAD, "textclass-load", NoInternal, Layout },
1488 * \var lyx::FuncCode lyx::LFUN_MARK_OFF
1489 * \li Action: Disable selecting of text-region.
1490 * \li Syntax: mark-off
1493 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
1495 * \var lyx::FuncCode lyx::LFUN_MARK_ON
1496 * \li Action: Enable selecting of text-region.
1497 * \li Notion: After enabling you can simply move arrow keys to get selected region.
1498 * \li Syntax: mark-on
1501 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
1503 * \var lyx::FuncCode lyx::LFUN_MARK_TOGGLE
1504 * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
1505 * \li Syntax: mark-toggle
1506 * \li Origin: Andre, May 5 2006
1509 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
1512 * \var lyx::FuncCode lyx::LFUN_MATH_DELIM
1513 * \li Action: Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
1514 * \li Syntax: math-delim [<LEFT>] [<RIGHT>]
1515 * \li Params: <LEFT/RIGHT>: Delimiters to be used. Each delimiter can be specified by
1516 either a LaTeX name or a valid character.
1517 ( is the default letter.
1518 * \li Sample: math-delim { rangle
1519 * \li Origin: Alejandro, 18 Jun 1996
1522 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
1524 * \var lyx::FuncCode lyx::LFUN_MATH_BIGDELIM
1525 * \li Action: Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
1526 * \li Syntax: math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
1527 * \li Params: <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r \n
1528 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
1529 * \li Sample: math-bigdelim "Bigl" "\Downarrow" "Bigr" "\}"
1530 * \li Origin: Enrico & Georg, 7 May 2006
1533 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
1535 * \var lyx::FuncCode lyx::LFUN_MATH_DISPLAY
1536 * \li Action: Creates a new displayed equation in text mode.
1537 Toggles inlined/display formula in math mode.
1538 * \li Syntax: math-display [<ARG>]
1539 * \li Params: <ARG>: this argument will be passed to #LFUN_MATH_INSERT when creating
1540 new equation from the text mode.
1541 * \li Origin: Alejandro, 18 Jun 1996
1544 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
1546 * \var lyx::FuncCode lyx::LFUN_MATH_INSERT
1547 * \li Action: Inserts math objects and symbols.
1548 * \li Syntax: math-insert <ARG>
1549 * \li Params: <ARG>: Symbol or LaTeX code to be inserted.
1550 * \li Notion: When <ARG> is a _single_ math inset with more than one cell
1551 (such as "x_y^z" or "\frac{x}{y}"), the content of cell(0) is
1552 replaced by the current selection (only works if the selection
1553 is in mathed). As an example, if "abc" is selected in mathed,
1554 "math-insert \frac{x}{y}" replaces "abc" with "\frac{abc}{y}",
1555 and "math-insert x_y^z" replaces "abc" with "abc_y^z".
1556 If nothing is selected (or the selection is not in mathed),
1557 math-insert works as expected.
1560 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
1562 * \var lyx::FuncCode lyx::LFUN_MATH_SUBSCRIPT
1563 * \li Action: Enters subscript expression in math expression.
1564 * \li Syntax: math-subscript
1565 * \li Origin: vermeer, 12 Dec 2001
1568 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
1570 * \var lyx::FuncCode lyx::LFUN_MATH_SUPERSCRIPT
1571 * \li Action: Enters subscript expression in math expression.
1572 * \li Syntax: math-superscript
1573 * \li Origin: vermeer, 12 Dec 2001
1576 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
1578 * \var lyx::FuncCode lyx::LFUN_MATH_LIMITS
1579 * \li Action: Toggles the position of the limits from above/below to the right
1580 side an vice versa in integral symbol, a limit, a summation, etc.
1581 * \li Notion: Put the cursor before the symbol with the limits and then invoke
1583 * \li Syntax: math-limits [<STATE>]
1584 * \li Params: <STATE>: limits|nolimits
1587 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
1589 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO
1590 * \li Action: Inserts a math macro definition at the cursor position in the text.
1591 * \li Syntax: math-macro <NAME> [<NARGS>] [def]
1592 * \li Params: <NAME>: The name of the macro, e.g. "mymacro".\n
1593 <NARGS>: The number of parameters of the macro. Default is 0.
1594 "def": Has no effect anymore, just for compatibility with former LyX versions.
1595 * \li Origin: ale, 10 May 1997; sts, 21 Dec 2007
1598 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
1600 * \var lyx::FuncCode lyx::LFUN_MATH_MUTATE
1601 * \li Action: Mutates the type of math inset to the newly selected one.
1602 * \li Syntax: math-mutate <TYPE>
1603 * \li Params: <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
1604 multline|gather|flalign
1605 * \li Origin: Andre, 23 May 2001
1608 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
1610 * \var lyx::FuncCode lyx::LFUN_MATH_SPACE
1611 * \li Action: Inserts space into math expression.
1612 * \li Notion: Use spacebar after entering this space to change type of space.
1613 * \li Syntax: math-space [<TYPE>] [<LEN>]
1614 * \li Params: <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace \n
1615 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad \n
1616 custom space: hspace \n
1617 "," used by default.\n
1618 Note that ! is equivalent to negthinspace, , = thinspace,
1619 : = medspace, and ; = thickspace.\n
1620 <LEN>: length for custom spaces (hspace)
1621 * \li Origin: Andre, 25 Jul 2001; sanda, 16 Jun 2008
1624 { LFUN_MATH_SPACE, "math-space", Noop, Math },
1626 * \var lyx::FuncCode lyx::LFUN_MATH_MATRIX
1627 * \li Action: Inserts a matrix.
1628 * \li Syntax: math-matrix <COLS> <ROWS> [<ALIGN>]
1629 * \li Params: <ALIGN>: Alignment is a word composed of the vertical alignment
1630 (b, c or t) (i.e. 1 char) and the horizontal alignments
1631 (l, c or r) (i.e. <COL> chars).
1632 * \li Sample: math-matrix 3 3 bccc
1635 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
1637 * \var lyx::FuncCode lyx::LFUN_MATH_AMS_MATRIX
1638 * \li Action: Inserts a matrix.
1639 * \li Syntax: math-matrix <COLS> <ROWS> [<DECORATION>]
1640 * \li Params: <DECORATION>: Decoration determines the LaTeX name of the matrix
1641 that should be created.
1642 * \li Sample: math-ams-matrix 3 3 bmatrix
1645 { LFUN_MATH_AMS_MATRIX, "math-ams-matrix", Noop, Math },
1647 * \var lyx::FuncCode lyx::LFUN_MATH_MODE
1648 * \li Action: In text mode enters math mode (i.e. puts math insets on the current
1649 cursor position), in math mode enters text mode inside math expression.
1650 * \li Notion: If there is some selected text, it puts the text inside created math box.
1651 * \li Syntax: math-mode [on|<ARG>]
1652 * \li Params: <ARG>: eventual argument (LaTeX code) is passed to #LFUN_MATH_INSERT .\n
1653 "on": allow only entering of math mode from text mode.
1654 * \li Origin: Alejandro, 4 Jun 1996
1657 { LFUN_MATH_MODE, "math-mode", Noop, Math },
1659 * \var lyx::FuncCode lyx::LFUN_REGEXP_MODE
1660 * \li Action: Enters regexp mode (i.e., puts regexp insets on the current
1661 cursor position). Used by the advanced search dialog.
1662 * \li Notion: If there is any selected text, then it is moved inside the created
1664 * \li Syntax: regexp-mode [<ARG>]
1665 * \li Params: <ARG>: eventual argument (regular expression).
1666 * \li Origin: Tommaso, 4 Oct 2008
1669 { LFUN_REGEXP_MODE, "regexp-mode", Noop, Math },
1671 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
1672 * \li Action: Toggles numbering of the current formula line.
1673 * \li Notion: Must be in display formula mode.
1674 * \li Syntax: math-number-line-toggle
1675 * \li Origin: Alejandro, 18 Jun 1996
1678 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
1680 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
1681 * \li Action: Toggles numbering/labeling of the current formula.
1682 * \li Notion: Must be in display formula mode.
1683 * \li Syntax: math-number-toggle
1684 * \li Origin: Alejandro, 4 Jun 1996
1687 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
1689 * \var lyx::FuncCode lyx::LFUN_MATH_EXTERN
1690 * \li Action: Calls external program and passes the current expression/equation
1691 as an argument for the calculation in the format appropriate to the
1693 * \li Notion: Selection can be used to determine the input for the external program.
1694 * \li Syntax: math-extern <LANG> [<COMMAND>]
1695 * \li Params: <LANG>: octave|maxima|maple|mathematica|script \n
1696 where "script" stands fot the external script (normalized
1697 expression will be passed)
1698 * \li Origin: Andre, 24 Apr 2001
1699 * \li Sample: math-extern maple simplify
1702 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
1704 * \var lyx::FuncCode lyx::LFUN_MATH_SIZE
1705 * \li Action: Changes arbitrarily the size used by math fonts inside a context.
1706 * \li Notion: Provides an interface to the LaTeX math mode font size commands.
1707 * \li Syntax: math-size <STYLE>
1708 * \li Params: <STYLE>: \displaystyle|\textstyle|\scriptstyle|\scriptscriptstyle
1709 * \li Origin: Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
1712 { LFUN_MATH_SIZE, "math-size", Noop, Math },
1714 * \var lyx::FuncCode lyx::LFUN_MATH_FONT_STYLE
1715 * \li Action: Changes the text style used in math.
1716 * \li Syntax: math-font-style <STYLE>
1717 * \li Params: <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf
1718 |textnormal|textrm|textsf|texttt|textbf|textmd|textit
1719 |textsc|textsl|textup
1720 * \li Origin: vfr, 9 jan 2009
1723 { LFUN_MATH_FONT_STYLE, "math-font-style", Noop, Math },
1725 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
1726 * \li Action: Unfold a Math Macro.
1727 * \li Notion: Unfold the Math Macro the cursor is in, i.e.
1729 * \li Syntax: math-macro-unfold
1730 * \li Origin: sts, 06 January 2008
1733 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
1735 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
1736 * \li Action: Fold a Math Macro.
1737 * \li Notion: Fold the Math Macro the cursor is in if it was
1738 unfolded, i.e. displayed as \foo before.
1739 * \li Syntax: math-macro-fold
1740 * \li Origin: sts, 06 January 2008
1743 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
1745 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
1746 * \li Action: Add a parameter.
1747 * \li Notion: Add a parameter to a Math Macro.
1748 * \li Params: <NUM>: The number of the parameter behind which the new one
1749 will be added (1 for the first, i.e. use 0 for add a
1750 parameter at the left), defaults to the last one.
1751 * \li Syntax: math-macro-add-param <NUM>
1752 * \li Origin: sts, 06 January 2008
1755 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
1757 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
1758 * \li Action: Remove the last parameter.
1759 * \li Notion: Remove the last parameter of a Math Macro and
1760 remove its value in all instances of the macro
1762 * \li Params: <NUM>: The number of the parameter to be deleted (1 for
1763 the first), defaults to the last one.
1764 * \li Syntax: math-macro-remove-param <NUM>
1765 * \li Origin: sts, 06 January 2008
1768 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
1770 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
1771 * \li Action: Append a greedy parameter.
1772 * \li Notion: Append a greedy parameter to a Math Macro which
1773 eats the following mathed cell in every instance of
1774 the macro in the buffer.
1775 * \li Syntax: math-macro-append-greedy-param
1776 * \li Origin: sts, 06 January 2008
1779 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
1781 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
1782 * \li Action: Remove a greedy parameter.
1783 * \li Notion: Remove a greedy parameter of a Math Macro and spit
1784 out the values of it in every instance of the macro
1785 in the buffer. If it is an optional parameter the [valud]
1787 * \li Syntax: math-macro-remove-greedy-param
1788 * \li Origin: sts, 06 January 2008
1791 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
1793 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
1794 * \li Action: Make a parameter optional.
1795 * \li Notion: Turn the first non-optional parameter of a Math Macro
1796 into an optional parameter with a default value.
1797 * \li Syntax: math-macro-make-optional
1798 * \li Origin: sts, 06 January 2008
1801 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
1803 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
1804 * \li Action: Make a parameter non-optional.
1805 * \li Notion: Turn the last optional parameter of a Math Macro
1806 into a non-optional parameter. The default value is
1807 remembered to be reused later if the user changes his mind.
1808 * \li Syntax: math-macro-make-nonoptional
1809 * \li Origin: sts, 06 January 2008
1812 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
1814 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
1815 * \li Action: Add an optional parameter.
1816 * \li Notion: Insert an optional parameter just behind the
1817 already existing optional parameters.
1818 * \li Syntax: math-macro-add-optional-param
1819 * \li Origin: sts, 06 January 2008
1822 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
1824 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
1825 * \li Action: Remove the last optional parameter.
1826 * \li Notion: Remove the last optional parameter of a Math Macro and
1827 remove it in all the instances of the macro in the buffer.
1828 * \li Syntax: math-macro-remove-optional-param
1829 * \li Origin: sts, 06 January 2008
1832 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
1834 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
1835 * \li Action: Add a greedy optional parameter.
1836 * \li Notion: Add a greedy optional parameter which eats the value
1837 from the following cells in mathed which are in the [value]
1839 * \li Syntax: math-macro-add-greedy-optional-param
1840 * \li Origin: sts, 06 January 2008
1843 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
1845 * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
1846 * \li Action: Only active in Math Macro definition.
1847 * \li Notion: Dummy function which is only active in a Math Macro definition.
1848 It's used to toggle the Math Macro toolbar if the cursor moves
1849 into a Math Macro definition.
1850 * \li Syntax: in-mathmacrotemplate
1851 * \li Origin: sts, 06 January 2008
1854 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
1857 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
1858 * \li Action: Moves the current paragraph downwards in the document.
1859 * \li Syntax: paragraph-move-down
1860 * \li Origin: Edwin, 8 Apr 2006
1863 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
1865 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
1866 * \li Action: Moves the current paragraph upwards in the document.
1867 * \li Syntax: paragraph-move-up
1868 * \li Origin: Edwin, 8 Apr 2006
1871 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
1874 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP
1875 * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1876 in upward direction.
1877 * \li Syntax: paragraph-up
1878 * \li Origin: Asger, 1 Oct 1996
1881 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
1883 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP_SELECT
1884 * \li Action: Move the cursor and select the text to the next paragraph (or
1885 begining of the current one) in upward direction.
1886 * \li Syntax: paragraph-up-select
1887 * \li Origin: Asger, 1 Oct 1996
1890 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
1892 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN
1893 * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1894 in downward direction.
1895 * \li Syntax: paragraph-down
1896 * \li Origin: Asger, 1 Oct 1996
1899 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
1901 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN_SELECT
1902 * \li Action: Move the cursor and select the text to the next paragraph (or
1903 begining of the current one) in downward direction.
1904 * \li Syntax: paragraph-down-select
1905 * \li Origin: Asger, 1 Oct 1996
1908 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
1910 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
1911 * \li Action: Jump to a paragraph given by its id number and optionally the
1912 desired position within the paragraph.
1913 * \li Notion: Note that id number of paragraph is not the sequential number of paragraph
1914 seen on the screen. Moreover the id is unique for all opened buffers (documents).
1915 * \li Syntax: paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
1916 * \li Params: <PAR_ID_NUMBER>: paragraph id \n
1917 <POSITION_IN_PAR>: desired position within the paragraph
1918 * \li Origin: Dekel, 26 Aug 2000
1921 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly | NoInternal, Edit },
1923 * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1924 * \li Action: Breaks the current paragraph at the current location.
1925 * \li Notion: Removes the selection.
1926 * \li Syntax: break-paragraph [<LAYOUT>]
1927 * \li Params: <LAYOUT>: "inverse" - decreases depth by one (or change layout
1928 to default layout) when the cursor is at the end of
1932 { LFUN_BREAK_PARAGRAPH, "break-paragraph", Noop, Edit },
1934 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
1935 * \li Action: Change paragraph settings.
1936 * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
1937 This function only modifies, and does not override, existing settings.
1938 Note that the "leftindent" indent setting is deprecated.
1939 * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
1940 * \li Params: <INDENT>: \noindent|\indent|\indent-toggle|\leftindent LENGTH\n
1941 <SPACING>: \paragraph_spacing default|single|onehalf|double|other SIZE \n
1942 <ALIGN>: \align block|left|right|center|default\n
1943 <OTHERS>: \labelwidthstring WIDTH|\start_of_appendix
1944 * \li Origin: rgh, Aug 15 2007
1947 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
1949 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
1950 * \li Action: Change paragraph settings.
1951 * \li Notion: Overwrite all nonspecified settings to the default ones.
1952 Use paragraph-params lfun if you don't want to overwrite others settings.
1953 * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
1954 * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
1955 * \li Origin: leeming, 30 Mar 2004
1958 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
1960 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UPDATE
1961 * \li Action: Updates the values inside the paragraph dialog from the paragraph.
1962 * \li Notion: This is internal LFUN, not to be used by users. Called internally
1963 by #LFUN_DIALOG_UPDATE.
1964 * \li Origin: leeming, 13 Mar 2003
1967 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
1970 * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
1971 * \li Action: Move the current group in the upward direction in the
1972 structure of the document.
1973 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1974 the whole substructure of the group.
1975 * \li Syntax: outline-up
1976 * \li Origin: Vermeer, 23 Mar 2006
1979 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
1981 * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
1982 * \li Action: Move the current group in the downward direction in the
1983 structure of the document.
1984 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1985 the whole substructure of the group.
1986 * \li Syntax: outline-down
1987 * \li Origin: Vermeer, 23 Mar 2006
1990 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
1992 * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
1993 * \li Action: Moves the current group in the downward direction in the
1994 hierarchy of the document structure.
1995 * \li Notion: Part -> Chapter -> Section -> etc.
1996 * \li Syntax: outline-in
1997 * \li Origin: Vermeer, 23 Mar 2006
2000 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
2002 * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
2003 * \li Action: Moves the current group in the upward direction in the
2004 hierarchy of the document structure.
2005 * \li Notion: Part <- Chapter <- Section <- etc.
2006 * \li Syntax: outline-out
2007 * \li Origin: Vermeer, 23 Mar 2006
2010 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
2013 * \var lyx::FuncCode lyx::LFUN_INSET_EDIT
2014 * \li Action: Edit the inset at cursor with an external application,
2015 if one is attributed.
2016 * \li Syntax: inset-edit [<INSET_PARAMS>]
2017 * \li Params: <INSET_PARAMS>: Parameters for the inset. \n
2018 Currently only the filename will be considered.
2019 * \li Origin: JSpitzm, 27 Apr 2006
2022 { LFUN_INSET_EDIT, "inset-edit", ReadOnly, Edit },
2025 * \var lyx::FuncCode lyx::LFUN_TABULAR_INSERT
2026 * \li Action: Inserts table into the document.
2027 * \li Syntax: tabular-insert [<ROWS> <COLUMNS>]
2028 * \li Params: In case no arguments are given show insert dialog.
2029 * \li Origin: Jug, 12 Apr 2000
2032 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
2034 * \var lyx::FuncCode lyx::LFUN_TABULAR_FEATURE
2035 * \li Action: Sets various features to the table/cell on the current cursor position.
2036 * \li Notion: Various math-environment features are handled here as well, e.g.
2037 add-vline-left/right for the Grid/Array environment
2038 * \li Syntax: tabular-feature <FEATURE> [<ARG>]
2039 * \li Params: <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|copy-column|
2040 toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
2041 align-left|align-right|align-center|align-block|valign-top|valign-bottom|
2042 valign-middle|longtabular-align-left|longtabular-align-center|
2043 longtabular-align-right|m-align-left|m-align-right|m-align-center|
2044 m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|set-all-lines|
2045 unset-all-lines|set-longtabular|unset-longtabular|set-pwidth|set-mpwidth|
2046 set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|
2047 set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|
2048 unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|
2049 set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
2050 set-special-column|set-special-multi|set-booktabs|unset-booktabs|
2051 set-top-space|set-bottom-space|set-interline-space|set-border-lines|
2052 tabular-valign-top|tabular-valign-middle|tabular-valign-bottom \n
2053 <ARG>: additional argument for some commands, use debug mode to explore its values.
2054 * \li Origin: Jug, 28 Jul 2000
2057 { LFUN_TABULAR_FEATURE, "tabular-feature", Noop, Edit },
2059 * \var lyx::FuncCode lyx::LFUN_CELL_BACKWARD
2060 * \li Action: Moves the cursor to the previous cell inside the table.
2061 * \li Syntax: cell-backward
2062 * \li Origin: Jug, 22 May 2000
2065 { LFUN_CELL_BACKWARD, "cell-backward", Noop, Edit },
2067 * \var lyx::FuncCode lyx::LFUN_CELL_FORWARD
2068 * \li Action: Moves the cursor to the next cell inside the table.
2069 * \li Syntax: cell-forward
2072 { LFUN_CELL_FORWARD, "cell-forward", Noop, Edit },
2074 * \var lyx::FuncCode lyx::LFUN_CELL_SPLIT
2075 * \li Action: Splits cell and shifts right part to the next cell (inside the math grid).
2076 * \li Syntax: cell-split
2077 * \li Origin: Ale, 15 May 1997
2080 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
2083 * \var lyx::FuncCode lyx::LFUN_VC_REGISTER
2084 * \li Action: Register the document as an file inside version control system (RCS, CVS).
2085 * \li Notion: File is registered inside cvs, svn or rcs repository acording to the existence
2086 of cvs/svn/rcs entries in the document's directory. \n
2087 See LyX Additional Features Manual (Version Control Chapter) for additional
2089 * \li Syntax: vc-register
2090 * \li Origin: Lgb, 1 Jul 1997
2093 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
2095 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_IN
2096 * \li Action: Checks-in/commits the changes of the registered file to the repository.
2097 * \li Notion: In RCS case this also unlocks the file.
2098 * \li Syntax: vc-check-in
2099 * \li Origin: Lgb, 1 Jul 1997
2102 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
2104 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_OUT
2105 * \li Action: Checks-out the document for edit (and locks it for RCS).
2106 * \li Notion: This is implemented only for RCS and SVN, not CVS.
2107 * \li Syntax: vc-check-out
2108 * \li Origin: Lgb, 1 Jul 1997
2111 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
2113 * \var lyx::FuncCode lyx::LFUN_VC_REVERT
2114 * \li Action: Reverts the document to the last check-in/commit in VCS.
2115 * \li Syntax: vc-revert
2116 * \li Origin: Lgb, 1 Jul 1997
2119 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
2121 * \var lyx::FuncCode lyx::LFUN_VC_UNDO_LAST
2122 * \li Action: Undo last check-in.
2123 * \li Notion: This is currently implemented only for RCS.
2124 * \li Syntax: vc-check-out
2125 * \li Origin: Lgb, 1 Jul 1997
2128 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
2130 * \var lyx::FuncCode lyx::LFUN_VC_COMMAND
2131 * \li Action: Executes external command. This command is intended to support
2132 additional VCS commands.
2133 * \li Syntax: vc-command <FLAG> <PATH> <COMMAND>
2134 * \li Params: <FLAG>: Flags for the command can be combined together.\n
2135 U - dUmmy - no flags \n
2136 D - Doc - need document loaded to proceed \n
2137 I - dIrty - mark document dirty \n
2138 R - Reload - ensure that the document is saved and reload it after command execution \n
2139 M - Message - ask for input string (commit message)\n
2140 <PATH>: path where to start. $$p will be replaced by the current document path.\n
2141 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current document/path/message.
2142 * \li Sample: vc-command DR $$p "svn up"
2143 * \li Origin: sanda, 13 Jan 2009
2146 { LFUN_VC_COMMAND, "vc-command", NoBuffer | ReadOnly, System },
2148 * \var lyx::FuncCode lyx::LFUN_VC_LOCKING_TOGGLE
2149 * \li Action: Toggles the locking property of the edited file.
2150 * \li Notion: This is currently implemented only for SVN.
2151 * \li Syntax: vc-locking-toggle
2152 * \li Origin: sanda, 25 Jun 2009
2155 { LFUN_VC_LOCKING_TOGGLE, "vc-locking-toggle", ReadOnly, System },
2157 * \var lyx::FuncCode lyx::LFUN_VC_REPO_UPDATE
2158 * \li Action: Update the local archive directory in which resides
2159 the current document with the remote repository.
2160 * \li Notion: This is currently implemented only for SVN.
2161 * \li Syntax: vc-repo-update
2162 * \li Origin: sanda, 16 Oct 2009
2165 { LFUN_VC_REPO_UPDATE, "vc-repo-update", ReadOnly, System },
2168 * \var lyx::FuncCode lyx::LFUN_CHANGES_TRACK
2169 * \li Action: Toggles change tracking to on/off.
2170 * \li Syntax: changes-track
2171 * \li Origin: levon, 1 Oct 2002
2174 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
2176 * \var lyx::FuncCode lyx::LFUN_CHANGES_OUTPUT
2177 * \li Action: Toggles showing of change tracking in typesetted output.
2178 * \li Syntax: changes-output
2179 * \li Origin: jspitzm, 21 Jan 2005
2182 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
2184 * \var lyx::FuncCode lyx::LFUN_CHANGE_NEXT
2185 * \li Action: Moves the cursor to the position of the next change
2186 of the change tracking records.
2187 * \li Syntax: change-next
2188 * \li Origin: schmitt, 4 Oct 2006
2191 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
2193 * \var lyx::FuncCode lyx::LFUN_CHANGE_PREVIOUS
2194 * \li Action: Moves the cursor to the position of the previous change
2195 of the change tracking records.
2196 * \li Syntax: change-previous
2197 * \li Origin: vfr, 4 Apr 2009
2200 { LFUN_CHANGE_PREVIOUS, "change-previous", ReadOnly, Edit },
2202 * \var lyx::FuncCode lyx::LFUN_CHANGES_MERGE
2203 * \li Action: Open change tracking dialog for merging and moves the cursor
2204 to the position of the next change.
2205 * \li Syntax: changes-merge
2206 * \li Origin: Levon, 16 Oct 2002
2209 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
2211 * \var lyx::FuncCode lyx::LFUN_CHANGE_ACCEPT
2212 * \li Action: Accepts tracked change inside the selection.
2213 * \li Syntax: change-accept
2214 * \li Origin: Levon, 16 Oct 2002
2217 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
2219 * \var lyx::FuncCode lyx::LFUN_CHANGE_REJECT
2220 * \li Action: Rejects tracked change inside the selection.
2221 * \li Syntax: change-accept
2222 * \li Origin: Levon, 16 Oct 2002
2225 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
2227 * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_ACCEPT
2228 * \li Action: Accepts all tracked changes in the document.
2229 * \li Syntax: all-changes-accept
2230 * \li Origin: Levon, 16 Oct 2002
2233 { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
2235 * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_REJECT
2236 * \li Action: Rejects all tracked changes in the document.
2237 * \li Notion: Reject does not work recursively; the user may have to repeat the operation.
2238 * \li Syntax: all-changes-reject
2239 * \li Origin: Levon, 16 Oct 2002
2242 { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
2245 * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
2246 * \li Action: Apply data for an inset.
2247 * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
2248 be applied. This is either changed to #LFUN_INSET_MODIFY or
2249 #LFUN_INSET_INSERT depending on the context where it is called.
2250 * \li Syntax: inset-apply <ARGS>
2251 * \li Params: See #LFUN_INSET_INSERT .
2254 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
2256 * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE
2257 * \li Action: Dissolve the current inset into text.
2258 * \li Syntax: inset-dissolve [<INSET>]
2259 * \li Params: <INSET>: this can be used to make sure the right kind of inset
2260 is dissolved. For example "dissolve" entry in the charstyles
2261 sub-menu should only dissolve the charstyle inset, even if the
2262 cursor is inside several nested insets of different type.\n
2263 For values see #lyx::InsetLayout::lyxtype_ .
2264 * \li Origin: JSpitz, 7 Aug 2006
2267 { LFUN_INSET_DISSOLVE, "inset-dissolve", AtPoint, Edit },
2269 * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
2270 * \li Action: Insert new inset (type given by the parameters).
2271 * \li Syntax: inset-insert <INSET> <ARGS>
2272 * \li Params: <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics|
2273 hyperlink|include|index|label|nomencl|vspace|ref|toc>\n
2274 <ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
2275 * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
2276 where <label name> is the name of the referenced label and
2277 <Format> is one of the following: \n
2278 ref -- <reference> \n
2279 eqref -- (<reference>) \n
2280 pageref -- <page> \n
2281 vpageref -- on <page> \n
2282 vref -- <reference> on <page> \n
2283 prettyref -- Formatted reference
2286 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
2288 * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
2289 * \li Action: Modify some properties of an inset.
2290 * \li Notion: Used for bibitem, bibtex, box, branch, command, ert, external,
2291 floats, graphics, include, index, info, label,
2292 listings, newline, newpage, nomencl, note, phantom,
2293 ref, space, tabular, vspace, wrap insets.
2294 * \li Syntax: inset-modify <INSET> <ARGS>
2295 * \li Syntax: inset-modify changetype <TYPE>
2296 * \li Sample: inset-modify note Note Comment
2297 * \li Sample: inset-modify changetype Ovalbox
2298 * \li Params: See #LFUN_INSET_INSERT for further details.
2301 { LFUN_INSET_MODIFY, "inset-modify", AtPoint, Edit },
2303 * \var lyx::FuncCode lyx::LFUN_INSET_DIALOG_UPDATE
2304 * \li Action: Updates the values inside the dialog from the inset.
2305 * \li Notion: This is internal LFUN, not to be used by users. Called internally
2306 by #LFUN_DIALOG_UPDATE
2307 * \li Params: <DIALOG-NAME>
2308 * \li Origin: leeming, 25 Feb 2003
2311 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
2313 * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
2314 * \li Action: Open the inset's properties dialog.
2315 * \li Notion: Used for bibitem, bibtex, box, branch, citation, ert, external,
2316 float, graphics, href, include, index, index_print, label, listings,
2317 note, phantom, ref, space, tabular, vspace, wrap insets.
2318 * \li Syntax: inset-settings <INSET>
2319 * \li Params: <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|
2320 graphics|href|include|index|index_print|label|listings|
2321 note|phantom|ref|space|tabular|vspace|wrap>.
2324 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly | AtPoint, Edit },
2326 * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
2327 * \li Action: Toggles the collapsable inset at cursor position,
2328 or the inset we are currently in.
2329 * \li Syntax: inset-toggle [<ARG>]
2330 * \li Params: <ARG>: <open|close|toggle|assign>. \n
2331 open/close/toggle are for collapsable insets. toggle is used when no argument is given.\n
2332 assign synchronize the branch-inset with activation status of the branch.
2333 Used for global toggling when changed activation.
2334 * \li Origin: lasgouttes, 19 Jul 2001
2337 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly | AtPoint, Edit },
2339 * \var lyx::FuncCode lyx::LFUN_ALL_INSETS_TOGGLE
2340 * \li Action: Toggles (open/closes) all collapsable insets (of a given type) in the document.
2341 * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
2342 * \li Syntax: all-insets-toggle [<STATE>] [<INSET>]
2343 * \li Params: <STATE>: <toggle|open|close|assign> default: toggle \n
2344 <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all insets
2345 * \li Origin: leeming, 30 Mar 2004
2348 { LFUN_ALL_INSETS_TOGGLE, "all-insets-toggle", ReadOnly, Edit },
2350 * \var lyx::FuncCode lyx::LFUN_INSET_FORALL
2351 * \li Action: Apply the given commands on insets of a given name.
2352 * \li Notion: WARNING: use at your own risks; this function gives
2353 you too many ways of shooting yourself in the foot.
2354 A typical example is
2355 inset-forall Note note-insert
2356 which starts an infinite loop. This is mitigated by the fact
2357 that the number of actions is arbitrarily limited to 10000.
2358 * \li Syntax: inset-forall <NAME> <LFUN-COMMAND> \n
2359 <NAME>: Type of Inset. If <NAME> is *, all insets are matched.
2360 The name is used like for InsetLayout in layout files: "Note"
2361 matches all note insets, while "Note:Note" only matches LyX
2363 * \li Sample: Remove all index insets: \n
2364 inset-forall Index delete-char-forward \n
2365 Close all Notes (also works for a particular branch, for example): \n
2366 inset-forall Note inset-toggle close \n
2367 Transform all yellow notes to comments \n
2368 inset-forall Note:Note inset-modify note Note Comment \n
2369 Try to put LyX in an infinite loop if there is at least a Note: \n
2370 inset-forall Note char-backward
2371 * \li Origin: lasgouttes, 27 Nov 2009
2374 { LFUN_INSET_FORALL, "inset-forall", ReadOnly, Edit },
2377 * \var lyx::FuncCode lyx::LFUN_GRAPHICS_RELOAD
2378 * \li Action: Reloads the image if necessary.
2379 * \li Syntax: graphics-reload
2380 * \li Origin: vfr, 10 Aug 2009
2383 { LFUN_GRAPHICS_RELOAD, "graphics-reload", ReadOnly | AtPoint, Edit },
2385 * \var lyx::FuncCode lyx::LFUN_SET_GRAPHICS_GROUP
2386 * \li Action: Set the group for the graphics inset on the cursor position.
2387 * \li Syntax: set-graphics-group [<GROUP>]
2388 * \li Params: <GROUP>: Id for an existing group. In case the Id is an empty string,
2389 the graphics inset is removed from the current group.
2390 * \li Origin: sanda, 6 May 2008
2393 { LFUN_SET_GRAPHICS_GROUP, "set-graphics-group", Noop, Edit },
2396 * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
2397 * \li Action: Moves the cursor out of the current slice, going forward.
2398 * \li Notion: Cursor movement within an inset may be different than cursor
2399 movement in the surrounding text. This action should be called
2400 automatically by the cursor movement within the inset, when
2401 movement within the inset has ceased (reached the end of the
2402 last paragraph, for example), in order to move correctly
2403 back into the surrounding text.
2406 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
2408 * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
2409 * \li Action: Moves the cursor out of the current slice, going backwards.
2410 * \li Notion: See also #LFUN_FINISHED_FORWARD.
2413 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
2415 * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
2416 * \li Action: Moves the cursor out of the current slice, going right.
2417 * \li Notion: See also #LFUN_FINISHED_FORWARD
2420 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
2422 * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
2423 * \li Action: Moves the cursor out of the current slice, going left.
2424 * \li Notion: See also #LFUN_FINISHED_FORWARD.
2427 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
2430 * \var lyx::FuncCode lyx::LFUN_LANGUAGE
2431 * \li Action: Set language from the current cursor position.
2432 * \li Syntax: language <LANG>
2433 * \li Params: <LANG>: Requested language. Look in lib/languages for
2435 * \li Origin: Dekel, 2 Mar 2000
2438 { LFUN_LANGUAGE, "language", Noop, Edit },
2441 * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
2442 * \li Action: Goto a label.
2443 * \li Syntax: label-goto [<LABEL>]
2444 * \li Params: <LABEL>: Requested label. If no label is given and reference
2445 is on cursor position, Bookmark 0 is saved and
2446 cursor moves to the position of referenced label.
2447 * \li Origin: Ale, 6 Aug 1997
2450 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
2452 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT
2453 * \li Action: Inserts label to text or displayed formula.
2454 * \li Syntax: label-insert [<LABEL>]
2455 * \li Params: <LABEL>: Requested label. If no label is given dialog requesting
2456 name will be opened.
2459 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
2461 * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
2462 * \li Action: Go to the next label or cross-reference.
2463 * \li Syntax: reference-next
2464 * \li Origin: Dekel, 14 Jan 2001
2467 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
2470 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
2471 * \li Action: Moves the cursor to the numbered bookmark, opening the file
2472 if necessary. Note that bookmarsk are saved per-session, not
2474 * \li Notion: Bookmark 0 has a special purpose. It is automatically set \n
2475 1. to the paragraph you are currently editing \n
2476 2. to the paragraph from where you are jumping to the last-edited
2477 position (jump-back feature) \n
2478 3. when jumping from crossreference to the requested label by
2480 * \li Syntax: bookmark-goto <NUMBER>
2481 * \li Params: <NUMBER>: the number of the bookmark to restore.
2482 * \li Origin: Dekel, 27 January 2001
2485 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
2487 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
2488 * \li Action: Save a bookmark.
2489 * \li Notion: Saves a numbered bookmark to the sessions file. The number
2490 must be between 1 and 9, inclusive. Note that bookmarks are
2491 saved per-session, not per file.
2492 * \li Syntax: bookmark-save <NUMBER>
2493 * \li Params: <NUMBER>: the number of the bookmark to save.
2494 * \li Origin: Dekel, 27 January 2001
2497 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
2499 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
2500 * \li Action: Clears the list of saved bookmarks.
2501 * \li Syntax: bookmark-clear
2502 * \li Origin: bpeng, 31 October 2006
2505 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
2508 * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
2509 * \li Action: Open the given help file according to the language setting.
2510 * \li Syntax: help-open <FILE>[.lyx]
2511 * \li Params: <FILE>: any document from (/usr/share/)doc directory.
2512 * \li Origin: Jug, 27 Jun 1999
2515 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
2517 * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
2518 * \li Action: Terminates the current LyX instance.
2519 * \li Notion: Terminates the current LyX instance, asking whether to save
2520 modified documents, etc.
2521 * \li Syntax: lyx-quit
2524 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
2526 * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
2527 * \li Action: Toggles visibility of a given toolbar between on/off/auto.
2528 * \li Notion: Skipping "auto" when allowauto is false.
2529 * \li Syntax: toolbar-toggle <NAME> [allowauto]
2530 * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|
2531 minibuffer|review|view/update|math_panels|vcs
2532 * \li Origin: Edwin, 21 May 2007
2535 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
2537 * \var lyx::FuncCode lyx::LFUN_MENU_OPEN
2538 * \li Action: Opens the menu given by its name.
2539 * \li Syntax: menu-open <NAME>
2540 * \li Params: <NAME>: menu name. See various .inc files in lib/ui for candidates.
2543 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
2545 * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
2546 * \li Action: Various UI visibility-toggling actions.
2547 * \li Syntax: ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
2548 * \li Params: statusbar : Toggle visibility of the statusbar.\n
2549 menubar : Toggle visibility of the menubar.\n
2550 scrollbar : Toggle visibility of the scrollbar.\n
2551 frame : Toggle visibility of the frames around editing window.\n
2552 fullscreen : Toggle fullscreen mode. This also covers calling the
2553 previous functions. However #LFUN_TOOLBAR_TOGGLE for the
2554 custom tweaks of the toolbars should be used.
2555 * \li Origin: sanda, 9 Feb 2007
2558 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
2561 * \var lyx::FuncCode lyx::LFUN_WINDOW_NEW
2562 * \li Action: Creates new empty LyX window.
2563 * \li Notion: Already opened documents from the previous window can be found under View menu.
2564 * \li Syntax: window-new [<GEOMETRY>]
2565 * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently
2566 accepted only on Windows platform.
2567 * \li Origin: Abdel, 21 Oct 2006
2570 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
2572 * \var lyx::FuncCode lyx::LFUN_WINDOW_CLOSE
2573 * \li Action: Closes the current LyX window.
2574 * \li Syntax: window-close
2575 * \li Origin: Abdel, 23 Oct 2006
2578 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
2581 * \var lyx::FuncCode lyx::LFUN_SPLIT_VIEW
2582 * \li Action: Creates another split view of current buffer.
2583 * \li Notion: All split views act in the same way indpendently.
2584 * \li Syntax: split-view <vertical|horizontal>
2585 * \li Params: horizontal : The work areas are laid out side by side.\n
2586 vertical : The work areas laid out vertically.
2587 * \li Origin: Abdel, 20 Feb 2008
2590 { LFUN_SPLIT_VIEW, "split-view", ReadOnly, Buffer },
2593 * \var lyx::FuncCode lyx::LFUN_CLOSE_TAB_GROUP
2594 * \li Action: Close the current tab group.
2595 * \li Notion: This only closes the work areas, not the buffer themselves.
2596 The still opened buffers can be visualized in another tab group.
2597 * \li Syntax: close-tab-group
2598 * \li Origin: Abdel, 21 Feb 2008
2601 { LFUN_CLOSE_TAB_GROUP, "close-tab-group", ReadOnly, Buffer },
2603 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW
2604 * \li Action: Shows hidden dialog or create new one for a given function/inset settings etc.
2605 * \li Syntax: dialog-show <NAME> [<DATA>]
2606 * \li Params: <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|\n
2607 compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|\n
2608 graphics|href|include|index|index_print|info|label|listings|log|mathdelimiter|\n
2609 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|\n
2610 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|\n
2611 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL> \n
2612 <SPECIAL>: latexlog|vclog \n
2613 <DATA>: data, usually settings for the given dialog. Use debug mode for the
2615 * \li Origin: leeming, 17 Jun 2003
2618 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
2620 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW_NEW_INSET
2621 * \li Action: Shows hidden dialog or create new one for a given inset settings etc.
2622 * \li Notion: Internally uses #LFUN_DIALOG_SHOW with processed data for a given inset.
2623 * \li Syntax: dialog-show-new-inset <NAME> [<DATA>]
2624 * \li Params: See #LFUN_DIALOG_SHOW .
2625 * \li Origin: leeming, 25 Feb 2003
2628 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
2630 * \var lyx::FuncCode lyx::LFUN_DIALOG_UPDATE
2631 * \li Action: Updates the dialog values from the inset/paragraph/document.
2632 * \li Syntax: dialog-update <NAME>
2633 * \li Params: <NAME>: paragraph|prefs|<INSET> \n
2635 * \li Origin: leeming, 25 Feb 2003
2638 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
2640 * \var lyx::FuncCode lyx::LFUN_DIALOG_HIDE
2641 * \li Action: Hides showed dialog. Counterpart to #LFUN_DIALOG_SHOW .
2642 * \li Syntax: dialog-hide <NAME>
2643 * \li Params: See #LFUN_DIALOG_SHOW .
2644 * \li Origin: leeming, 25 Feb 2003
2647 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
2649 * \var lyx::FuncCode lyx::LFUN_DIALOG_TOGGLE
2650 * \li Action: Toggles dialog between showed/hidden state.
2651 * \li Notion: Internally uses #LFUN_DIALOG_SHOW , #LFUN_DIALOG_HIDE .
2652 * \li Syntax: dialog-toggle <NAME> [<DATA>]
2653 * \li Params: See #LFUN_DIALOG_SHOW .
2654 * \li Origin: JSpitzm, 30 Apr 2007
2657 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
2659 * \var lyx::FuncCode lyx::LFUN_DIALOG_DISCONNECT_INSET
2660 * \li Action: Closes opened connection to opened inset.
2661 * \li Notion: Connection is used for apply functions.
2662 * \li Syntax: dialog-disconnect-inset <INSET-NAME>
2663 * \li Origin: leeming, 25 Feb 2003
2666 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
2669 * \var lyx::FuncCode lyx::LFUN_MOUSE_PRESS
2670 * \li Action: This function is called when mouse button is pressed (inside workarea).
2671 Action depends on the context.
2672 * \li Notion: This is internal LFUN, not to be used by users.
2673 * \li Origin: Andre, 9 Aug 2002
2676 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
2678 * \var lyx::FuncCode lyx::LFUN_MOUSE_DOUBLE
2679 * \li Action: This function is called when double click on mouse button is
2680 pressed (inside workarea). Action depends on the context.
2681 * \li Notion: This is internal LFUN, not to be used by users.
2682 * \li Origin: Andre, 9 Aug 2002
2685 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
2687 * \var lyx::FuncCode lyx::LFUN_MOUSE_TRIPLE
2688 * \li Action: This function is called when triple click on mouse button is
2689 pressed (inside workarea). Action depends on the context.
2690 * \li Notion: This is internal LFUN, not to be used by users.
2691 * \li Origin: Andre, 9 Aug 2002
2694 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
2696 * \var lyx::FuncCode lyx::LFUN_MOUSE_MOTION
2697 * \li Action: This function is called when mouse cursor is moving over the text.
2698 Action depends on the context.
2699 * \li Notion: This is internal LFUN, not to be used by users.
2700 * \li Origin: Andre, 9 Aug 2002
2703 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
2705 * \var lyx::FuncCode lyx::LFUN_MOUSE_RELEASE
2706 * \li Action: This function is called when mouse button is released (inside workarea).
2707 Action depends on the context.
2708 * \li Notion: This is internal LFUN, not to be used by users.
2709 * \li Origin: Andre, 9 Aug 2002
2712 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
2715 * \var lyx::FuncCode lyx::LFUN_KEYMAP_OFF
2716 * \li Action: Turn off the loaded keyboard map.
2717 * \li Syntax: keymap-off
2720 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
2722 * \var lyx::FuncCode lyx::LFUN_KEYMAP_PRIMARY
2723 * \li Action: Turn on the primary keyboard map.
2724 * \li Notion: Maps were widely used in past, when X-windows didn't have nowadays
2725 keyboard support. They can be still used to maintain uniform keyboard
2726 layout across the various plaforms.\n
2727 The language is to be set in the Preferences dialog.
2728 * \li Syntax: keymap-primary
2731 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
2733 * \var lyx::FuncCode lyx::LFUN_KEYMAP_SECONDARY
2734 * \li Action: Turn on the secondary keyboard map.
2735 * \li Syntax: keymap-secondary
2738 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
2740 * \var lyx::FuncCode lyx::LFUN_KEYMAP_TOGGLE
2741 * \li Action: Toggles keyboard maps (first/second/off).
2742 * \li Syntax: keymap-toggle
2743 * \li Origin: leeming, 30 Mar 2004
2746 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
2749 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_LAYOUT
2750 * \li Action: Returns the current layout (that is environment) name
2751 on the cursor position.
2752 * \li Syntax: server-get-layout
2755 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
2757 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_FILENAME
2758 * \li Action: Returns path and file name of the currently edited document.
2759 * \li Syntax: server-get-filename
2762 { LFUN_SERVER_GET_FILENAME, "server-get-filename", ReadOnly, System },
2764 * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
2765 * \li Action: Sets the cursor position based on the row number of generated TeX file.
2766 * \li Notion: This can be useful for DVI inverse-search or detection of the problematic
2767 line from LaTeX compilation. Note that before this function can be used
2768 export to LaTeX output must occur (in order to map the row numbers).
2769 * \li Syntax: server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
2770 * \li Params: <FILE>: the filename. Environment variables are expanded in the path.
2771 In case this LFUN does not work make sure you are giving correct
2773 If the file is located inside LyX temporary directory it will be
2774 mapped back into the appropriate opened buffer (e.g. for the case
2775 of generated .tex file).
2776 .ext: extensions will be automatically replaced by .lyx.
2777 <ROW_NUMBER> The row number of the LaTeX file to which to go.
2778 * \li Origin: Edmar, 23 Dec 1998
2781 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly | NoBuffer, System },
2783 * \var lyx::FuncCode lyx::LFUN_SERVER_NOTIFY
2784 * \li Action: Sends notify message about the last key-sequence to client.
2785 * \li Notion: This can be used to grab last key-sequence used inside the LyX window.
2786 See also Debug extensions section in Additional features manual.
2787 * \li Syntax: server-notify
2790 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
2792 * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
2793 * \li Action: Sets the cursor position based on the editing area coordinates
2794 (similar as clicking on that point with left mouse button).
2795 * \li Syntax: server-set-xy <X> <Y>
2798 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
2800 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
2801 * \li Action: Returns the coordinates of cursor position in the editing area.
2802 * \li Syntax: server-get-xy
2805 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
2808 * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
2809 * \li Action: Generates the code (literate programming).
2810 * \li Notion: Latex file with extension \literate_extension is generated.
2811 Then LyX invokes \build_command (with a default of``make'') to generate the code and
2812 \build_error_filter to process the compilation error messages. \n
2813 In case you want to process your literate file with a script, or some other program,
2814 just insert in your lyxrc file an entry with:\n
2815 \build_command "my_script my_arguments" \n
2816 The \build_error_filter differs from the \literate_error_filter only in that the
2817 former will identify error messages from your compiler.
2818 * \li Syntax: build-program
2821 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
2824 * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
2825 * \li Action: Saves the current buffer to a temporary file.
2826 * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
2827 is called automatically by LyX, to "autosave" the current buffer.
2828 * \li Syntax: buffer-auto-save
2831 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
2833 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHILD_OPEN
2834 * \li Action: Loads the given child document.
2835 * \li Notion: The current document is treated as a parent.
2836 * \li Syntax: buffer-child-open <FILE>
2837 * \li Params: <FILE>: Filename of the child. The directory of the parent is assumed by default.
2838 * \li Origin: Ale, 28 May 1997
2841 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
2843 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHKTEX
2844 * \li Action: Runs chktex for the current document.
2845 * \li Syntax: buffer-chktex
2846 * \li Origin: Asger, 30 Oct 1997
2849 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
2851 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
2852 * \li Action: Toggles compression of the current document on/off.
2853 * \li Syntax: buffer-toggle-compression
2854 * \li Origin: bpeng, 27 Apr 2006
2857 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
2859 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
2860 * \li Action: Closes the current buffer.
2861 * \li Notion: Closes the current buffer, asking whether to save it, etc,
2862 if the buffer has been modified.
2863 * \li Syntax: buffer-close
2866 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
2868 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE_ALL
2869 * \li Action: Closes all buffers.
2870 * \li Notion: Closes all buffers, asking whether to save it, etc,
2871 if a buffer has been modified.
2872 * \li Syntax: buffer-close-all
2875 { LFUN_BUFFER_CLOSE_ALL, "buffer-close-all", ReadOnly, Buffer },
2877 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
2878 * \li Action: Exports the current buffer (document) to the given format.
2879 * \li Syntax: buffer-export <FORMAT>
2880 * \li Params: <FORMAT> is either "custom" or one of the formats which you
2881 can find in Tools->Preferences->File formats->Format.
2882 Usual format you will enter is "pdf2" (pdflatex),
2883 "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
2884 In case of "custom" you will be asked for a format you
2885 want to start from and for the command that you want to
2886 apply to this format. Internally the control is then passed
2887 to #LFUN_BUFFER_EXPORT_CUSTOM.
2888 * \li Origin: Lgb, 29 Jul 1997
2891 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
2893 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
2894 * \li Action: Exports the current buffer (document) from the given format using
2895 the given command on it.
2896 * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
2897 * \li Params: <FORMAT> format to start from (LyX will care to produce such
2898 intermediate file).\n
2899 <COMMAND> this command will be launched on the file. Note that you can
2900 use "$$FName" string to qualify the intermediate file.
2901 * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
2902 * \li Origin: leeming, 27 Mar 2004
2905 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
2907 * \var lyx::FuncCode lyx::LFUN_BUFFER_PRINT
2908 * \li Action: Prints the current document.
2909 * \li Notion: Many settings can be given via the preferences dialog.
2910 * \li Syntax: buffer-print <TARGET> <TARGET-NAME> <COMMAND>
2911 * \li Params: <TARGET> is either "printer" or "file".\n
2912 <TARGER-NAME> is either "default" or file name or printer name.\n
2913 <COMMAND> command ensuring the printing job.
2914 * \li Sample: buffer-print file "/trash/newfile1.ps" "dvips"
2915 * \li Origin: leeming, 28 Mar 2004
2918 { LFUN_BUFFER_PRINT, "buffer-print", ReadOnly, Buffer },
2920 * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
2921 * \li Action: Import a given file as a lyx document.
2922 * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
2923 defined convertors in preferences. Look into File->Import menu to get
2924 an idea of the currently active import formats.
2925 * \li Syntax: buffer-import <FORMAT> [<FILE>]
2926 * \li Origin: Asger, 24 Jul 1998
2929 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
2931 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
2932 * \li Action: Creates a new buffer (that is, document).
2933 * \li Notion: Implicit path can be set in Preferences dialog.
2934 * \li Syntax: buffer-new [<FILE>]
2935 * \li Params: <FILE>: filename of created file with absolute path.
2938 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
2940 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
2941 * \li Action: Creates a new buffer (that is, document) from a template.
2942 * \li Notion: Path for new files and templates can be set in Preferences dialog.
2943 Template will be asked for via Open-dialog.
2944 * \li Syntax: buffer-new-template [<FILE>]
2945 * \li Params: <FILE>: filename of created file with absolute path.
2948 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
2950 * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
2951 * \li Action: Reverts opened document.
2952 * \li Syntax: buffer-reload
2953 * \li Origin: Asger, 2 Feb 1997
2956 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
2958 * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
2959 * \li Action: Switch to the given buffer.
2960 * \li Notion: This is useful also in case you need simultaneously more views of the edited
2961 document in different LyX windows.
2962 * \li Syntax: buffer-new-template <BUFFER>
2963 * \li Params: <BUFFER>: already opened document which is to be shown.
2966 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
2968 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
2969 * \li Action: Toggle editing mode of the current document between read/write and read-only.
2970 * \li Notion: This function is not allowed if the file is under version control, since
2971 read-only flag is often used in version control file locking.
2972 * \li Syntax: buffer-toggle-read-only
2973 * \li Origin: Lgb, 27 May 1997
2976 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
2978 * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
2979 * \li Action: Displays current buffer in chosen format.
2980 * \li Notion: Displays the contents of the current buffer in the chosen
2981 format, for example, PDF or DVI. This runs the necessary
2982 converter, calls the defined viewer, and so forth.
2983 * \li Syntax: buffer-view [<FORMAT>]
2984 * \li Params: <FORMAT>: The format to display, where this is one of the
2985 formats defined (in the current GUI) in the
2986 Tools>Preferences>File Formats dialog.
2987 If no format is given, the default format as
2988 specified in the same dialog is used.
2991 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
2993 * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
2994 * \li Action: Exports the current document and put the result into the
2995 temporary directory.
2996 * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
2997 the output will be rewriten - updated. This is useful in case your viewer
2998 is able to detect such changes (e.g. ghostview for postscript).
2999 * \li Syntax: buffer-update [<FORMAT>]
3000 * \li Params: <FORMAT>: The format to display, where this is one of the
3001 formats defined (in the current GUI) in the
3002 Tools>Preferences>File Formats dialog.
3003 If no format is given, the default format as
3004 specified in the same dialog is used.
3005 * \li Origin: Dekel, 5 Aug 2000
3008 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
3011 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
3012 * \li Action: Saves the current buffer.
3013 * \li Notion: Saves the current buffer to disk, using the filename that
3014 is already associated with the buffer, asking for one if
3015 none is yet assigned.
3016 * \li Syntax: buffer-write
3019 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
3021 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
3022 * \li Action: Rename and save current buffer.
3023 * \li Syntax: buffer-write-as <FILENAME>
3024 * \li Params: <FILENAME>: New name of the buffer/file. A relative path
3025 is with respect to the original location of the buffer/file.
3028 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
3030 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
3031 * \li Action: Save all changed documents.
3032 * \li Syntax: buffer-write-all
3033 * \li Origin: rgh, gpothier 6 Aug 2007
3036 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
3038 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEXT
3039 * \li Action: Switch to the next opened document.
3040 * \li Notion: Note that this does not necessarily mean next in tabbar
3041 (for full list see View menu).
3042 * \li Syntax: buffer-next
3045 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
3047 * \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS
3048 * \li Action: Switch to the previous opened document.
3049 * \li Syntax: buffer-previous
3052 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
3054 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
3055 * \li Action: When run from a child document, this updates (exports) document built
3056 from the master buffer, if available.
3057 * \li Syntax: master-buffer-update [<FORMAT>]
3058 * \li Params: <FORMAT>: The format to display, where this is one of the
3059 formats defined (in the current GUI) in the
3060 Tools>Preferences>File Formats dialog.
3061 If no format is given, the default format as
3062 specified in the same dialog is used.
3063 * \li Origin: Tommaso, 20 Sep 2007
3066 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
3068 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
3069 * \li Action: When run from a child document, this command shows a preview built
3070 from the master buffer, if available.
3071 * \li Syntax: master-buffer-view [<FORMAT>]
3072 * \li Params: <FORMAT>: The format to display, where this is one of the
3073 formats defined (in the current GUI) in the
3074 Tools>Preferences>File Formats dialog.
3075 If no format is given, the default format as
3076 specified in the same dialog is used.
3077 * \li Origin: Tommaso, 20 Sep 2007
3080 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
3082 * \var lyx::FuncCode lyx::LFUN_BUFFER_LANGUAGE
3083 * \li Action: Set language of the current document.
3084 * \li Syntax: buffer-language <LANG>
3085 * \li Params: <LANG>: language name. See lib/languages for list.
3086 * \li Origin: leeming, 30 Mar 2004
3089 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
3091 * \var lyx::FuncCode lyx::LFUN_BUFFER_SAVE_AS_DEFAULT
3092 * \li Action: Save the current document settings as default.
3093 * \li Notion: The file will will be saved into ~/.lyx/templates/defaults.lyx .
3094 * \li Syntax: buffer-save-as-default [<ARGS>]
3095 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
3096 you can find in document header of usual .lyx file.
3097 * \li Origin: leeming, 30 Mar 2004
3100 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
3102 * \var lyx::FuncCode lyx::LFUN_BUFFER_PARAMS_APPLY
3103 * \li Action: Apply the given settings to the current document.
3104 * \li Syntax: buffer-params-apply [<ARGS>]
3105 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
3106 you can find in document header of usual .lyx file.
3107 * \li Origin: leeming, 30 Mar 2004
3110 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", NoInternal, Buffer },
3113 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
3114 * \li Action: Inserts another LyX file.
3115 * \li Syntax: file-insert [<FILE>]
3116 * \li Params: <FILE>: Filename to be inserted.
3119 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
3121 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
3122 * \li Action: Inserts plain text file.
3123 * \li Syntax: file-insert-plaintext [<FILE>]
3124 * \li Params: <FILE>: Filename to be inserted.
3125 * \li Origin: CFO-G, 19 Nov 1997
3128 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
3130 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
3131 * \li Action: Inserts plain text file as paragraph (i.e. join lines).
3132 * \li Syntax: file-insert-plaintext-para [<FILE>]
3133 * \li Params: <FILE>: Filename to be inserted.
3134 * \li Origin: Levon, 14 Feb 2001
3137 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
3139 * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
3140 * \li Action: Open LyX document.
3141 * \li Syntax: file-open [<FILE>]
3142 * \li Params: <FILE>: Filename to be opened.
3145 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
3148 * \var lyx::FuncCode lyx::LFUN_CALL
3149 * \li Action: Executes a command defined in a .def file.
3150 * \li Notion: The definitions are by default read from lib/commands/default.def.\n
3151 A .def file allows to define a command with \define "<NAME>" "<LFUN>"
3152 where <NAME> is the name of the new command and <LFUN> is the lfun code
3153 to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
3154 \def_file "FileName" allows to include another .def file. \n
3155 This is particularly useful in connection with toolbar buttons:
3156 Since the name of the button image for this lfun is
3157 lib/images/commands/<NAME>.png this is the way to assign an image
3158 to a complex command-sequence.
3159 * \li Syntax: call <NAME>
3160 * \li Params: <NAME>: Name of the command that must be called.
3161 * \li Origin: broider, 2 Oct 2007
3164 { LFUN_CALL, "call", NoBuffer, System },
3166 * \var lyx::FuncCode lyx::LFUN_META_PREFIX
3167 * \li Action: Simulate halting Meta key (Alt key on PCs).
3168 * \li Notion: Used for buffer editation not for GUI control.
3169 * \li Syntax: meta-prefix
3172 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
3174 * \var lyx::FuncCode lyx::LFUN_CANCEL
3175 * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
3176 * \li Syntax: cancel
3179 { LFUN_CANCEL, "cancel", NoBuffer, System },
3182 * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
3183 * \li Action: Switches the focus to the minibuffer so that the user can type
3184 in there. If necessary, it opens the minibuffer toolbar.
3185 * \li Notion: Usually bound to M-x shortcut.
3186 * \li Syntax: command-execute
3189 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
3192 * \var lyx::FuncCode lyx::LFUN_COMMAND_PREFIX
3193 * \li Action: Return the current key sequence and available options as a string.
3194 * \li Notion: No options are added if no current map exists. \n
3195 This is probably usable only with connection to lyxserver.
3196 * \li Syntax: command-prefix
3199 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
3201 * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
3202 * \li Action: Run more commands (LFUN and its parameters) in a sequence.
3203 * \li Syntax: command-sequence <CMDS>
3204 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
3205 * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
3206 * \li Origin: Andre, 11 Nov 1999
3209 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
3211 * \var lyx::FuncCode lyx::LFUN_COMMAND_ALTERNATIVES
3212 * \li Action: Runs the first listed command that is enabled.
3213 * \li Notion: This can be used to bind multiple functions to a single key,
3214 and then which one is used will depend upon the context.
3215 * \li Syntax: command-alternatives <CMDS>
3216 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
3217 * \li Sample: command-alternatives completion-accept;cell-forward
3218 * \li Origin: rgh, 24 September 2008
3221 { LFUN_COMMAND_ALTERNATIVES, "command-alternatives", NoBuffer, System },
3223 * \var lyx::FuncCode lyx::LFUN_MESSAGE
3224 * \li Action: Shows message in statusbar (for script purposes).
3225 * \li Syntax: message <STRING>
3226 * \li Origin: Lgb, 8 Apr 2001
3229 { LFUN_MESSAGE, "message", NoBuffer, System },
3231 * \var lyx::FuncCode lyx::LFUN_DEBUG_LEVEL_SET
3232 * \li Action: Set debug output level.
3233 * \li Syntax: debug-level-set <LEVEL>
3234 * \li Params: <LEVEL>: comma separated list of levels or the correspondent number
3235 of their combination. 0 is equivalent to disabling all debug
3236 events. See lyx -dbg for the current list of debug levels
3238 * \li Origin: sanda, 28 Dec 2009
3241 { LFUN_DEBUG_LEVEL_SET, "debug-level-set", NoBuffer, System },
3244 * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
3245 * \li Action: Save user preferences.
3246 * \li Syntax: preferences-save
3247 * \li Origin: Lgb, 27 Nov 1999
3250 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
3252 * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
3253 * \li Action: Reconfigure the automatic settings.
3254 * \li Syntax: reconfigure
3255 * \li Origin: Asger, 14 Feb 1997
3258 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
3260 * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
3261 * \li Action: Apply the given settings to user preferences.
3262 * \li Syntax: lyxrc-apply <SETTINGS>
3263 * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
3264 to get an idea which commands to use and their syntax.
3265 #lyx::LyXRC::LyXRCTags has the list of possible commands.
3268 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
3270 * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
3271 * \li Action: Determine whether keep cursor inside the editing window regardless
3272 the scrollbar movement.
3273 * \li Syntax: toggle-cursor-follows-scrollbar
3274 * \li Origin: ARRae, 2 Dec 1997
3277 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
3279 * \var lyx::FuncCode lyx::LFUN_SET_COLOR
3280 * \li Action: Set the given LyX color to the color defined by the X11 name given.
3281 * \li Notion: A new color entry is created if the color is unknown.
3282 Color names can be stored as a part of user settings.
3283 * \li Syntax: set-color <LYX_NAME> <X11_NAME>
3284 * \li Origin: SLior, 11 Jun 2000
3287 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
3289 * \var lyx::FuncCode lyx::LFUN_STATISTICS
3290 * \li Action: Count the statistics (number of words and characters)
3291 in the document or in the given selection.
3292 * \li Notion: Note that this function gives the number of words/chars written,
3293 not the number of characters which will be typeset.
3294 * \li Syntax: statistics
3295 * \li Origin: lasgouttes, Jan 27 2004; sanda, Jan 8 2008
3298 { LFUN_STATISTICS, "statistics", ReadOnly, System },
3300 * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
3301 * \li Action: Show the inline completion at the cursor position.
3302 * \li Syntax: completion-inline
3303 * \li Origin: sts, Feb 19 2008
3306 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
3308 * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
3309 * \li Action: Show the completion popup at the cursor position.
3310 * \li Syntax: completion-popup
3311 * \li Origin: sts, Feb 19 2008
3314 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
3316 * \var lyx::FuncCode lyx::LFUN_COMPLETION_COMPLETE
3317 * \li Action: Try to complete the word or command at the cursor position.
3318 * \li Syntax: complete
3319 * \li Origin: sts, Feb 19 2008
3322 { LFUN_COMPLETION_COMPLETE, "complete", SingleParUpdate, Edit },
3325 * \var lyx::FuncCode lyx::LFUN_COMPLETION_CANCEL
3326 * \li Action: Try to cancel completion, either the popup or the inline completion.
3327 * \li Syntax: completion-cancel
3328 * \li Origin: sts, Sep 07 2008
3331 { LFUN_COMPLETION_CANCEL, "completion-cancel", SingleParUpdate, Edit },
3333 * \var lyx::FuncCode lyx::LFUN_COMPLETION_ACCEPT
3334 * \li Action: Accept suggested completion.
3335 * \li Syntax: completion-accept
3336 * \li Origin: sanda, Sep 08 2008
3339 { LFUN_COMPLETION_ACCEPT, "completion-accept", SingleParUpdate, Edit },
3343 * \var lyx::FuncCode lyx::LFUN_BRANCH_ADD
3344 * \li Action: Add a branch to the buffer's BranchList.
3345 * \li Syntax: branch-add <BRANCH>
3346 * \li Params: <BRANCH>: Name of the branch to add
3347 * \li Origin: spitz, 7 Jul 2009
3350 { LFUN_BRANCH_ADD, "branch-add", Noop, Buffer },
3354 * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
3355 * \li Action: Activate the branch.
3356 * \li Syntax: branch-activate <BRANCH>
3357 * \li Params: <BRANCH>: The branch to activate
3358 * \li Sample: lyx -x "branch-activate answers" -e pdf2 finalexam.lyx \n
3359 could be used to export a pdf with the answers branch included
3360 without one's having to open LyX and activate the branch manually.
3361 * \li Origin: rgh, 27 May 2008
3364 { LFUN_BRANCH_ACTIVATE, "branch-activate", AtPoint, Buffer },
3366 * \var lyx::FuncCode lyx::LFUN_BRANCH_DEACTIVATE
3367 * \li Action: De-activate the branch.
3368 * \li Syntax: branch-deactivate <BRANCH>
3369 * \li Params: <BRANCH>: The branch to deactivate
3370 * \li Origin: rgh, 27 May 2008
3373 { LFUN_BRANCH_DEACTIVATE, "branch-deactivate", AtPoint, Buffer },
3376 * \var lyx::FuncCode lyx::LFUN_BRANCHES_RENAME
3377 * \li Action: Rename all branches of a given name in a document.
3378 * \li Syntax: branches-rename <OLDNAME> <NEWNAME>
3379 * \li Params: <OLDNAME>: Current name of the branch to be renamed
3380 * <NEWNAME>: New name of the branch
3381 * \li Origin: spitz, 9 Jul 2009
3384 { LFUN_BRANCHES_RENAME, "branches-rename", Noop, Buffer },
3386 * \var lyx::FuncCode lyx::LFUN_BRANCH_ADD_INSERT
3387 * \li Action: Create new branch and directly put the branch inset into
3389 * \li Syntax: branch-add-insert [<NAME>]
3390 * \li Params: <NAME>: Branch name. If it is not specified, you will be asked.
3391 * \li Origin: sanda, 10 Jul 2009
3394 { LFUN_BRANCH_ADD_INSERT, "branch-add-insert", Noop, Buffer },
3398 * \var lyx::FuncCode lyx::LFUN_LABEL_COPY_AS_REF
3399 * \li Action: Copies the label at the cursor as a cross-reference to be pasted elsewhere.
3400 * \li Syntax: copy-label-as-reference <LABEL>
3401 * \li Params: <LABEL>: The label to copy (for multi-line math)
3402 * \li Origin: sts, 16 Nov 2008
3405 { LFUN_LABEL_COPY_AS_REF, "copy-label-as-reference", ReadOnly | NoUpdate, Edit },
3408 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT_AS_REF
3409 * \li Action: Inserts the label as a cross-reference at the position of the cursor.
3410 * \li Syntax: label-insert-as-reference
3411 * \li Origin: vfr, 7 Apr 2009
3414 { LFUN_LABEL_INSERT_AS_REF, "label-insert-as-reference", Noop, Edit},
3417 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_IN
3418 * \li Action: Increases the zoom of the screen fonts.
3419 * \li Syntax: buffer-zoom-in [<ZOOM>]
3420 * \li Params: <ZOOM>: The zoom in %, the default is 20.
3421 * \li Origin: vfr, 30 Mar 2009
3424 { LFUN_BUFFER_ZOOM_IN, "buffer-zoom-in", ReadOnly, Buffer },
3427 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_OUT
3428 * \li Action: Decreases the zoom of the screen fonts.
3429 * \li Syntax: buffer-zoom-out [<ZOOM>]
3430 * \li Params: <ZOOM>: The zoom in %, the default is 20.
3431 * \li Origin: vfr, 30 Mar 2009
3434 { LFUN_BUFFER_ZOOM_OUT, "buffer-zoom-out", ReadOnly, Buffer },
3438 { LFUN_NOACTION, "", Noop, Hidden }
3439 #ifndef DOXYGEN_SHOULD_SKIP_THIS
3442 for (int i = 0; items[i].action != LFUN_NOACTION; ++i)
3443 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
3449 LyXAction::LyXAction()
3455 FuncRequest LyXAction::lookupFunc(string const & func) const
3457 string const func2 = trim(func);
3460 return FuncRequest(LFUN_NOACTION);
3463 string const arg = split(func2, cmd, ' ');
3465 FuncMap::const_iterator const fit = lyx_func_map.find(cmd);
3467 return fit != lyx_func_map.end()
3468 ? FuncRequest(fit->second, arg)
3469 : FuncRequest(LFUN_UNKNOWN_ACTION);
3473 string const LyXAction::getActionName(FuncCode action) const
3475 InfoMap::const_iterator const it = lyx_info_map.find(action);
3476 return it != lyx_info_map.end() ? it->second.name : string();
3480 LyXAction::FuncType LyXAction::getActionType(FuncCode action) const
3482 InfoMap::const_iterator const it = lyx_info_map.find(action);
3483 return it != lyx_info_map.end() ? it->second.type : Hidden;
3487 bool LyXAction::funcHasFlag(FuncCode action,
3488 LyXAction::FuncAttribs flag) const
3490 InfoMap::const_iterator ici = lyx_info_map.find(action);
3492 if (ici == lyx_info_map.end()) {
3493 LYXERR0("action: " << action << " is not known.");
3494 LASSERT(false, /**/);
3497 return ici->second.attrib & flag;
3501 LyXAction::const_iterator LyXAction::func_begin() const
3503 return lyx_func_map.begin();
3507 LyXAction::const_iterator LyXAction::func_end() const
3509 return lyx_func_map.end();
3513 LyXErr & operator<<(LyXErr & l, FuncCode code)
3516 l.stream() << lyxaction.getActionName(code);