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::func_type 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
109 ev_item const items[] = {
112 * \var lyx::FuncCode lyx::LFUN_ACCENT_ACUTE
113 * \li Action: Adds an acute accent \htmlonly (á)\endhtmlonly
114 to the next character typed.
115 * \li Syntax: accent-acute
118 { LFUN_ACCENT_ACUTE, "accent-acute", Noop, Edit },
120 * \var lyx::FuncCode lyx::LFUN_ACCENT_BREVE
121 * \li Action: Adds a breve accent \htmlonly (ă)\endhtmlonly
122 to the next character typed.
123 * \li Syntax: accent-breve
126 { LFUN_ACCENT_BREVE, "accent-breve", Noop, Edit },
128 * \var lyx::FuncCode lyx::LFUN_ACCENT_CARON
129 * \li Action: Adds a caron \htmlonly (ǎ)\endhtmlonly
130 to the next character typed.
131 * \li Syntax: accent-caron
134 { LFUN_ACCENT_CARON, "accent-caron", Noop, Edit },
136 * \var lyx::FuncCode lyx::LFUN_ACCENT_CEDILLA
137 * \li Action: Adds a cedilla \htmlonly (ç)\endhtmlonly
138 to the next character typed.
139 * \li Syntax: accent-cedilla
142 { LFUN_ACCENT_CEDILLA, "accent-cedilla", Noop, Edit },
144 * \var lyx::FuncCode lyx::LFUN_ACCENT_CIRCLE
145 * \li Action: Adds a circle accent \htmlonly (å)\endhtmlonly
146 to the next character typed.
147 * \li Syntax: accent-circle
150 { LFUN_ACCENT_CIRCLE, "accent-circle", Noop, Edit },
152 * \var lyx::FuncCode lyx::LFUN_ACCENT_CIRCUMFLEX
153 * \li Action: Adds a circumflex \htmlonly (ê)\endhtmlonly
154 to the next character typed.
155 * \li Syntax: accent-circumflex
158 { LFUN_ACCENT_CIRCUMFLEX, "accent-circumflex", Noop, Edit },
160 * \var lyx::FuncCode lyx::LFUN_ACCENT_DOT
161 * \li Action: Adds a dot accent \htmlonly (ż)\endhtmlonly
162 to the next character typed.
163 * \li Syntax: accent-dot
166 { LFUN_ACCENT_DOT, "accent-dot", Noop, Edit },
168 * \var lyx::FuncCode lyx::LFUN_ACCENT_GRAVE
169 * \li Action: Adds a grave accent \htmlonly (è)\endhtmlonly
170 to the next character typed.
171 * \li Syntax: accent-grave
174 { LFUN_ACCENT_GRAVE, "accent-grave", Noop, Edit },
176 * \var lyx::FuncCode lyx::LFUN_ACCENT_HUNGARIAN_UMLAUT
177 * \li Action: Adds a Hungarian umlaut \htmlonly (ő)\endhtmlonly
178 to the next character typed.
179 * \li Syntax: accent-grave
182 { LFUN_ACCENT_HUNGARIAN_UMLAUT, "accent-hungarian-umlaut", Noop, Edit },
184 * \var lyx::FuncCode lyx::LFUN_ACCENT_MACRON
185 * \li Action: Adds a macron \htmlonly (ā)\endhtmlonly
186 to the next character typed.
187 * \li Syntax: accent-macron
190 { LFUN_ACCENT_MACRON, "accent-macron", Noop, Edit },
192 * \var lyx::FuncCode lyx::LFUN_ACCENT_OGONEK
193 * \li Action: Adds an ogonek accent \htmlonly (ą)\endhtmlonly
194 to the next character typed.
195 * \li Syntax: accent-ogonek
198 { LFUN_ACCENT_OGONEK, "accent-ogonek", Noop, Edit },
200 * \var lyx::FuncCode lyx::LFUN_ACCENT_TIE
201 * \li Action: Adds a tie \htmlonly (a͡)\endhtmlonly
202 over the next two character typed.
203 * \li Notion: The following char will finish the tie.
204 * \li Syntax: accent-tie
207 { LFUN_ACCENT_TIE, "accent-tie", Noop, Edit },
209 * \var lyx::FuncCode lyx::LFUN_ACCENT_TILDE
210 * \li Action: Adds a tilde \htmlonly (ã)\endhtmlonly
211 over the next character typed.
212 * \li Syntax: accent-tilde
215 { LFUN_ACCENT_TILDE, "accent-tilde", Noop, Edit },
217 * \var lyx::FuncCode lyx::LFUN_ACCENT_UMLAUT
218 * \li Action: Adds an umlaut \htmlonly (ä)\endhtmlonly
219 over the next character typed.
220 * \li Syntax: accent-umlaut
223 { LFUN_ACCENT_UMLAUT, "accent-umlaut", Noop, Edit },
225 * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERBAR
226 * \li Action: Adds a bar \htmlonly (a̠)\endhtmlonly
227 under the next character typed.
228 * \li Syntax: accent-underbar
231 { LFUN_ACCENT_UNDERBAR, "accent-underbar", Noop, Edit },
233 * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERDOT
234 * \li Action: Adds a dot \htmlonly (ạ)\endhtmlonly
235 under the next character typed.
236 * \li Syntax: accent-underdot
239 { LFUN_ACCENT_UNDERDOT, "accent-underdot", Noop, Edit },
242 * \var lyx::FuncCode lyx::LFUN_CAPTION_INSERT
243 * \li Action: Inserts a caption inset.
244 * \li Syntax: caption-insert
245 * \li Origin: Lgb, 18 Jul 2000
248 { LFUN_CAPTION_INSERT, "caption-insert", Noop, Edit },
250 * \var lyx::FuncCode lyx::LFUN_DATE_INSERT
251 * \li Action: Inserts the current date.
252 * \li Syntax: date-insert [<ARG>]
253 * \li Params: <ARG>: Format of date. The default value (%x) can be set
254 in Preferences->Date format. For possible formats
255 see manual page of strftime function.
256 * \li Origin: jdblair, 31 Jan 2000
259 { LFUN_DATE_INSERT, "date-insert", Noop, Edit },
261 * \var lyx::FuncCode lyx::LFUN_FOOTNOTE_INSERT
262 * \li Action: Inserts a footnote inset.
263 * \li Syntax: footnote-insert
264 * \li Origin: Jug, 7 Mar 2000
267 { LFUN_FOOTNOTE_INSERT, "footnote-insert", Noop, Edit },
269 * \var lyx::FuncCode lyx::LFUN_ERT_INSERT
270 * \li Action: Inserts an ERT inset.
271 * \li Syntax: ert-insert
272 * \li Origin: Jug, 18 Feb 2000
275 { LFUN_ERT_INSERT, "ert-insert", Noop, Edit },
277 * \var lyx::FuncCode lyx::LFUN_FLOAT_INSERT
278 * \li Action: Inserts a float inset.
279 * \li Syntax: float-insert <TYPE>
280 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
281 "algorithm", "table", "figure" parameters can be given.
282 * \li Origin: Lgb, 27 Jun 2000
285 { LFUN_FLOAT_INSERT, "float-insert", Noop, Edit },
287 * \var lyx::FuncCode lyx::LFUN_FLOAT_WIDE_INSERT
288 * \li Action: Inserts float insets as in #LFUN_FLOAT_INSERT but span multiple columns.
289 * \li Notion: Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
290 * \li Syntax: float-wide-insert <TYPE>
291 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
292 "algorithm", "table", "figure" parameters can be given.
293 * \li Origin: Lgb, 31 Oct 2001
296 { LFUN_FLOAT_WIDE_INSERT, "float-wide-insert", Noop, Edit },
298 * \var lyx::FuncCode lyx::LFUN_FLOAT_LIST_INSERT
299 * \li Action: Inserts the list of floats in the document.
300 * \li Syntax: float-list-insert <TYPE>
301 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
302 "algorithm", "table", "figure" parameters can be given.
303 * \li Origin: Lgb, 3 May 2001
306 { LFUN_FLOAT_LIST_INSERT, "float-list-insert", Noop, Edit },
308 * \var lyx::FuncCode lyx::LFUN_WRAP_INSERT
309 * \li Action: Inserts floats wrapped by the text around.
310 * \li Syntax: wrap-insert <TYPE>
311 * \li Params: <TYPE>: table|figure
312 * \li Origin: Dekel, 7 Apr 2002
315 { LFUN_WRAP_INSERT, "wrap-insert", Noop, Edit },
317 * \var lyx::FuncCode lyx::LFUN_OPTIONAL_INSERT
318 * \li Action: Inserts an optional-argument (short title) inset.
319 * \li Syntax: optional-insert
320 * \li Origin: vermeer, 12 Aug 2002
323 { LFUN_OPTIONAL_INSERT, "optional-insert", Noop, Edit },
325 * \var lyx::FuncCode lyx::LFUN_LINE_INSERT
326 * \li Action: Inserts a horizontal line.
327 * \li Syntax: line-insert
328 * \li Origin: Andre, Oct 27 2003
331 { LFUN_LINE_INSERT, "line-insert", Noop, Edit },
333 * \var lyx::FuncCode lyx::LFUN_NEWPAGE_INSERT
334 * \li Action: Inserts a new page.
335 * \li Syntax: newpage-insert <ARG>
336 * \li Params: <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
337 * \li Origin: uwestoehr, 24 Nov 2007
340 { LFUN_NEWPAGE_INSERT, "newpage-insert", Noop, Edit },
342 * \var lyx::FuncCode lyx::LFUN_MARGINALNOTE_INSERT
343 * \li Action: Inserts a marginal note.
344 * \li Syntax: marginalnote-insert
345 * \li Origin: Lgb, 26 Jun 2000
348 { LFUN_MARGINALNOTE_INSERT, "marginalnote-insert", Noop, Edit },
350 * \var lyx::FuncCode lyx::LFUN_UNICODE_INSERT
351 * \li Action: Inserts a single unicode character.
352 * \li Syntax: unicode-insert <CHAR>
353 * \li Params: <CHAR>: The character to insert, given as its code
354 point, in hexadecimal.
355 * \li Sample: unicode-insert 0x0100
356 * \li Origin: Lgb, 22 Oct 2006
359 { LFUN_UNICODE_INSERT, "unicode-insert", Noop, Edit },
361 * \var lyx::FuncCode lyx::LFUN_LISTING_INSERT
362 * \li Action: Inserts a new listings inset.
363 * \li Syntax: listing-insert
364 * \li Origin: Herbert, 10 Nov 2001; bpeng, 2 May 2007
367 { LFUN_LISTING_INSERT, "listing-insert", Noop, Edit },
369 * \var lyx::FuncCode lyx::LFUN_TAB_INSERT
370 * \li Action: Insert a tab into a listings inset.
371 * \li Notion: It also works on a selection.
372 * \li Syntax: tab-insert
373 * \li Origin: vfvanravesteijn, Sep 30 2008
376 { LFUN_TAB_INSERT, "tab-insert", SingleParUpdate, Edit },
378 * \var lyx::FuncCode lyx::LFUN_TAB_DELETE
379 * \li Action: Delete a tab or up to an equivalent amount of spaces from
381 * \li Notion: It also works on a selection - it removes a tab or spaces from the
382 beginning of each line spanned by the selection. This is useful if
383 you want to indent/unindent multiple lines in one action.
384 * \li Syntax: tab-delete
385 * \li Origin: vfvanravesteijn, Sep 30 2008
388 { LFUN_TAB_DELETE, "tab-delete", SingleParUpdate, Edit },
390 * \var lyx::FuncCode lyx::LFUN_QUOTE_INSERT
391 * \li Action: Inserts quotes according to the type and quote-language preference.
392 * \li Action: Currently English, Swedish, German, Polish, French, Danish quotes
394 * \li Syntax: quote-insert [<TYPE>]
395 * \li Params: <TYPE>: 'single' for single quotes, otherwise double quotes will be used.
398 { LFUN_QUOTE_INSERT, "quote-insert", Noop, Edit },
400 * \var lyx::FuncCode lyx::LFUN_INFO_INSERT
401 * \li Action: Displays shortcuts, lyxrc, package and textclass availability and menu
402 information in a non-editable boxed InsetText.
403 * \li Notion: Apart from lfun arguments you can use the following method: \n
404 1. input the type and argument of this inset, e.g. "menu paste", in
406 2. select the text and run info-insert lfun.
407 * \li Syntax: info-insert <TYPE> <ARG>
408 * \li Params: <TYPE>: shortcut|lyxrc|package|textclass|menu|buffer \n
409 <ARG>: argument for a given type. Look into InsetInfo.h for detailed
411 * \li Origin: bpeng, 7 Oct 2007
414 { LFUN_INFO_INSERT, "info-insert", Noop, Edit },
416 * \var lyx::FuncCode lyx::LFUN_BRANCH_INSERT
417 * \li Action: Inserts branch inset.
418 * \li Syntax: branch-insert <BRANCH-NAME>
419 * \li Origin: vermeer, 17 Aug 2003
422 { LFUN_BRANCH_INSERT, "branch-insert", Noop, Edit },
424 * \var lyx::FuncCode lyx::LFUN_BOX_INSERT
425 * \li Action: Inserts Box inset.
426 * \li Syntax: box-insert [<TYPE>]
427 * \li Params: <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox \n
428 Framed is the default one.
429 * \li Origin: vermeer, 7 Oct 2003
432 { LFUN_BOX_INSERT, "box-insert", Noop, Edit },
434 * \var lyx::FuncCode lyx::LFUN_FLEX_INSERT
435 * \li Action: Inserts CharStyle, Custom inset or XML short element.
436 * \li Notion: Look into the Customization manual for more information about
438 To make this command enabled the layout file for the document
439 class you're using has to load the character styles. There are
440 a few contained in the Logical Markup module. You can also of
441 course create some yourself. \n
442 For dissolving the element see #LFUN_INSET_DISSOLVE.
443 * \li Syntax: flex-insert <TYPE:Name>
444 * \li Params: TYPE: CharStyle|Custom|Element|Standard \n
445 Identifies whether this is a Character Style, a
446 Custom Inset or an XML Element, and which dynamical
447 sub-menu this flex inset is in on the LyX menu tree.
448 If Standard (currently unused): none of these.
449 Name: This name must be defined either in your layout file
450 or imported by some module. The definition is \n
451 InsetLayout <TYPE:Name>
452 * \li Sample: flex-insert CharStyle:Code
455 { LFUN_FLEX_INSERT, "flex-insert", Noop, Edit },
457 * \var lyx::FuncCode lyx::LFUN_SELF_INSERT
458 * \li Action: Inserts the given string (accordingly to the correct keymap).
459 * \li Notion: Automatically replace the currently selected text. Depends on lyxrc
460 settings "auto_region_delete".
461 * \li Syntax: self-insert <STRING>
464 { LFUN_SELF_INSERT, "self-insert", SingleParUpdate, Hidden },
466 * \var lyx::FuncCode lyx::LFUN_SPACE_INSERT
467 * \li Action: Inserts one of horizontal space insets.
468 * \li Syntax: space-insert <NAME> [<LEN>]
469 * \li Params: <NAME>: normal, protected, thin, quad, qquad, enspace, enskip,
470 negthinspace, hfill, hfill*, dotfill, hrulefill, hspace,
472 <LEN>: length for custom spaces (hspace, hspace* for protected)
473 * \li Origin: JSpitzm, 20 May 2003, Mar 17 2008
476 { LFUN_SPACE_INSERT, "space-insert", Noop, Edit },
478 * \var lyx::FuncCode lyx::LFUN_HYPERLINK_INSERT
479 * \li Action: Inserts hyperlinks into the document (clickable in pdf output).
480 * \li Notion: Hyperlink target can be set via selection + hyperlink-insert function.
481 * \li Syntax: href-insert [<TARGET>]
482 * \li Origin: CFO-G, 21 Nov 1997
485 { LFUN_HYPERLINK_INSERT, "href-insert", Noop, Edit },
487 * \var lyx::FuncCode lyx::LFUN_SPECIALCHAR_INSERT
488 * \li Action: Inserts various characters into the document.
489 * \li Syntax: specialchar-insert <CHAR>
490 * \li Params: <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots,
491 end-of-sentence, menu-separator.
492 * \li Origin: JSpitzm, 6 Dec 2007
495 { LFUN_SPECIALCHAR_INSERT, "specialchar-insert", Noop, Edit },
497 * \var lyx::FuncCode lyx::LFUN_TOC_INSERT
498 * \li Action: Inserts table of contents.
499 * \li Syntax: toc-insert
500 * \li Origin: Lgb, 27 May 97
503 { LFUN_TOC_INSERT, "toc-insert", Noop, Edit },
505 * \var lyx::FuncCode lyx::LFUN_APPENDIX
506 * \li Action: Start (or remove) Appendix on the given cursor position.
507 * \li Syntax: appendix
508 * \li Origin: ettrich, 5 May 1998
511 { LFUN_APPENDIX, "appendix", Noop, Edit },
514 * \var lyx::FuncCode lyx::LFUN_INDEX_INSERT
515 * \li Action: Inserts Index entry.
516 * \li Notion: It automatically takes the word on the cursor position.
517 * \li Syntax: index-insert
518 * \li Origin: leeming, 3 Aug 2000
521 { LFUN_INDEX_INSERT, "index-insert", Noop, Edit },
523 * \var lyx::FuncCode lyx::LFUN_INDEX_PRINT
524 * \li Action: Inserts list of Index entries on a new page.
525 * \li Syntax: index-print
526 * \li Origin: Lgb, 27 Feb 1997
529 { LFUN_INDEX_PRINT, "index-print", Noop, Edit },
532 * \var lyx::FuncCode lyx::LFUN_NOMENCL_INSERT
533 * \li Action: Inserts Nomenclature entry.
534 * \li Notion: It automatically takes the word on the cursor position if no symbol is given.
535 * \li Syntax: nomencl-insert [<SYMBOL>]
536 * \li Origin: Ugras, 4 Nov 2006
539 { LFUN_NOMENCL_INSERT, "nomencl-insert", Noop, Edit },
541 * \var lyx::FuncCode lyx::LFUN_NOMENCLATURE_PRINT
542 * \li Action: Inserts list of Nomenclature entries.
543 * \li Syntax: nomenclature-print
544 * \li Origin: Ugras, 4 Nov 2006
547 { LFUN_NOMENCL_PRINT, "nomencl-print", Noop, Edit },
550 * \var lyx::FuncCode lyx::LFUN_NOTE_INSERT
551 * \li Action: Inserts Note on the current cursor postion,
552 move selection inside the inset.
553 * \li Syntax: note-insert [<TYPE>]
554 * \li Params: <TYPE>: <Note|Greyedout|Comment> default: Note
557 { LFUN_NOTE_INSERT, "note-insert", Noop, Edit },
559 * \var lyx::FuncCode lyx::LFUN_NOTE_NEXT
560 * \li Action: Moves the cursor to the begining of next Note inset.
561 * \li Syntax: note-next
564 { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
566 * \var lyx::FuncCode lyx::LFUN_NOTES_MUTATE
567 * \li Action: Changes all Note insets of a particular type (source)
568 to a different type (target) fot the current document.
569 * \li Syntax: notes-mutate <SOURCE> <TARGET>
570 * \li Params: <SOURCE/TARGET>: Note|Comment|Greyedout
571 * \li Origin: sanda, 18 Jun 2008
574 { LFUN_NOTES_MUTATE, "notes-mutate", Argument, Edit },
576 * \var lyx::FuncCode lyx::LFUN_NEWLINE_INSERT
577 * \li Action: Inserts a line break or new line.
578 * \li Syntax: newline-insert [<ARG>]
579 * \li Params: <ARG>: <newline|linebreak> default: newline
580 * \li Origin: JSpitzm, 25 Mar 2008
583 { LFUN_NEWLINE_INSERT, "newline-insert", Noop, Edit },
586 * \var lyx::FuncCode lyx::LFUN_ESCAPE
587 * \li Action: Clears the selection. If no text is selected call #LFUN_FINISHED_FORWARD.
589 * \li Origin: Lgb, 17 May 2001
592 { LFUN_ESCAPE, "escape", ReadOnly, Edit },
594 * \var lyx::FuncCode lyx::LFUN_DOWN
595 * \li Action: Moves the cursor one line in downward direction.
599 { LFUN_DOWN, "down", ReadOnly | NoUpdate, Edit },
601 * \var lyx::FuncCode lyx::LFUN_UP
602 * \li Action: Moves the cursor one line in upward direction.
606 { LFUN_UP, "up", ReadOnly | NoUpdate, Edit },
608 * \var lyx::FuncCode lyx::LFUN_DOWN_SELECT
609 * \li Action: Moves the cursor one line in downward direction adding the current
610 position to the selection.
611 * \li Syntax: down-select
614 { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, Edit },
616 * \var lyx::FuncCode lyx::LFUN_UP_SELECT
617 * \li Action: Moves the cursor one line in upward direction adding the current
618 position to the selection.
619 * \li Syntax: up-select
622 { LFUN_UP_SELECT, "up-select", ReadOnly | SingleParUpdate, Edit },
624 * \var lyx::FuncCode lyx::SCREEN_DOWN
625 * \li Action: Moves the cursor one page in downward direction.
626 * \li Syntax: screen-down
629 { LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit },
631 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP
632 * \li Action: Moves the cursor one page in upward direction.
633 * \li Syntax: screen-up
636 { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit },
638 * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN_SELECT
639 * \li Action: Moves the cursor one screen in downward direction adding the current
640 position to the selection.
641 * \li Syntax: screen-down-select
644 { LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit },
646 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP_SELECT
647 * \li Action: Moves the cursor one page in upward direction adding the current
648 position to the selection.
649 * \li Syntax: screen-up-select
652 { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit },
654 * \var lyx::FuncCode lyx::LFUN_SCROLL
655 * \li Action: Scroll the buffer view.
656 * \li Notion: Only scrolls the screen up or down; does not move the cursor.
657 * \li Syntax: scroll <TYPE> <QUANTITY>
658 * \li Params: <TYPE>: line|page\n
659 <QUANTITY>: up|down|<number>
660 * \li Origin: Abdel, Dec 27 2007
663 { LFUN_SCROLL, "scroll", ReadOnly, Edit },
665 * \var lyx::FuncCode lyx::LFUN_SCREEN_RECENTER
666 * \li Action: Recenters the screen on the current cursor position.
667 * \li Syntax: screen-recenter
670 { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit },
673 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD
674 * \li Action: Moves the cursor one position logically backwards.
675 * \li Notion: This is not the action which should be bound to the arrow keys,
676 because backwards may be left or right, depending on the
677 language. The arrow keys should be bound to #LFUN_CHAR_LEFT or
678 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
679 * \li Syntax: char-backward
682 { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit },
684 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD_SELECT
685 * \li Action: Moves the cursor one position logically backwards, adding
686 traversed position to the selection.
687 * \li Notion: See also #LFUN_CHAR_BACKWARD.
688 * \li Syntax: char-backward-select
691 { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit },
693 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_BACKWARD
694 * \li Action: Deletes one character in the backward direction (usually the "BackSpace" key).
695 * \li Syntax: char-delete-backward
698 { LFUN_CHAR_DELETE_BACKWARD, "char-delete-backward", SingleParUpdate, Edit },
700 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_FORWARD
701 * \li Action: Deletes one character in the backward direction (usually the "Delete" key).
702 * \li Syntax: char-delete-forward
705 { LFUN_CHAR_DELETE_FORWARD, "char-delete-forward", SingleParUpdate, Edit },
707 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD
708 * \li Action: Moves the cursor one position logically forward.
709 * \li Notion: This is not the action which should be bound to the arrow keys,
710 because forward may be left or right, depending on the language.
711 The arrow keys should be bound to #LFUN_CHAR_LEFT or
712 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
713 * \li Syntax: char-forward
716 { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit },
718 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD_SELECT
719 * \li Action: Moves the cursor one position logically forward, adding
720 traversed position to the selection.
721 * \li Notion: See also #LFUN_CHAR_FORWARD.
722 * \li Syntax: char-forward-select
725 { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit },
727 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT
728 * \li Action: Moves the cursor one position "to the left".
729 * \li Notion: This is the action which should be taken when the "left" key
730 is pressed. Generally, it moves the cursor one position to the
731 left. However, in Bidi text this become slightly more
732 complicated, and there are different modes of cursor movement.
733 In "visual mode", this moves left, plain and simple. In "logical
734 mode", movement is logically forward in RTL paragraphs, and
735 logically backwards in LTR paragraphs.
736 * \li Syntax: char-left
739 { LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit },
741 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT_SELECT
742 * \li Action: Moves the cursor one position "to the left", adding
743 traversed position to the selection.
744 * \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement.
745 * \li Syntax: char-left-select
748 { LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit },
750 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT
751 * \li Action: Moves the cursor one position "to the right".
752 * \li Notion: This is the action which should be taken when the "right" key
753 is pressed. Generally, it moves the cursor one position to the
754 right. However, in Bidi text this become slightly more
755 complicated, and there are different modes of cursor movement.
756 In "visual mode", this moves right, plain and simple. In "logical
757 mode", movement is logically forward in LTR paragraphs, and
758 logically backwards in RTL paragraphs.
759 * \li Syntax: char-right
762 { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit },
764 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT_SELECT
765 * \li Action: Moves the cursor one position "to the right", adding
766 traversed position to the selection.
767 * \li Notion: See also #LFUN_CHAR_RIGHT for exact details of the movement.
768 * \li Syntax: char-right-select
771 { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit },
774 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD
775 * \li Action: Moves the cursor to the logically previous beginning of a word.
776 * \li Notion: This is not the action which should be bound to the arrow keys,
777 because backwards may be left or right, depending on the
778 language. The arrow keys should be bound to #LFUN_WORD_LEFT or
779 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
780 * \li Syntax: word-backward
783 { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit },
785 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD_SELECT
786 * \li Action: Moves the cursor to the logically previous beginning of a word,
787 adding the logically traversed text to the selection.
788 * \li Notion: See also #LFUN_WORD_BACKWARD.
789 * \li Syntax: word-backward-select
792 { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
794 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_BACKWARD
795 * \li Action: Deletes characters to the begining of the word (usually the "C+BackSpace" key).
796 * \li Syntax: word-delete-backward
799 { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
801 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_FORWARD
802 * \li Action: Deletes characters to the end of the word (usually the "C+Delete" key).
803 * \li Syntax: word-delete-forward
806 { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
808 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_FORWARD
809 * \li Action: Search for a given string in forward direction.
810 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
811 * \li Syntax: word-find-forward [<STRING>]
812 * \li Origin: Etienne, 16 Feb 1998
815 { LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit },
817 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_BACKWARD
818 * \li Action: Search for a given string in backward direction.
819 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
820 * \li Syntax: word-find-backward [<STRING>]
821 * \li Origin: Etienne, 20 Feb 1998
824 { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
826 * \var lyx::FuncCode lyx::LFUN_WORD_FIND
827 * \li Action: Search for next occurence of a string.
828 * \li Syntax: word-find [<DATA>]
829 * \li Params: <DATA>: data encoded from Find dialog (see #lyx::find2string()).
830 If no parameter is given, search with last find-dialog
831 data is used for search (i.e. find-next).
832 * \li Origin: Andre, Jan 7 2004
835 { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
837 * \var lyx::FuncCode lyx::LFUN_WORD_REPLACE
838 * \li Action: Replace a string in the document.
839 * \li Syntax: word-replace [<DATA>]
840 * \li Params: <DATA>: data is of the form
843 <casesensitive> <matchword> <all> <forward>"
844 * \li Origin: Andre, Jan 7 2004
847 { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
849 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD
850 * \li Action: Moves the cursor to the logically next beginning of a word.
851 * \li Notion: This is not the action which should be bound to the arrow keys,
852 because forward may be left or right, depending on the language.
853 The arrow keys should be bound to #LFUN_WORD_LEFT or
854 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
855 * \li Syntax: word-forward
858 { LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
860 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD_SELECT
861 * \li Action: Moves the cursor to the logically next beginning of a word,
862 adding the logically traversed text to the selection.
863 * \li Notion: See also #LFUN_WORD_FORWARD.
864 * \li Syntax: word-forward-select
867 { LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
869 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT
870 * \li Action: Moves the cursor to the next beginning of a word "on the left".
871 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
872 "left" key is pressed. Generally, it moves the cursor to the
873 next beginning of a word on the left. However, in Bidi text this
874 become slightly more complicated, and there are different modes
875 of cursor movement. In "visual mode", this moves left, plain and
876 simple. In "logical mode", movement is logically forward in RTL
877 paragraphs, and logically backwards in LTR paragraphs.
878 * \li Syntax: word-left
879 * \li Origin: dov, 28 Oct 2007
882 { LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
884 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT_SELECT
885 * \li Action: Moves the cursor to the next beginning of a word "on the left",
886 adding *logically* traversed text to the selection.
887 * \li Notion: See also #LFUN_WORD_LEFT for exact details of the movement.
888 * \li Syntax: word-left-select
889 * \li Origin: dov, 28 Oct 2007
892 { LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit },
894 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT
895 * \li Action: Moves the cursor to the next beginning of a word "on the right".
896 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
897 "right" key is pressed. Generally, it moves the cursor to the
898 next beginning of a word on the right. However, in Bidi text
899 this become slightly more complicated, and there are different
900 modes of cursor movement. In "visual mode", this moves right,
901 plain and simple. In "logical mode", movement is logically
902 forward in LTR paragraphs, and logically backwards in RTL
904 * \li Syntax: word-right
905 * \li Origin: dov, 28 Oct 2007
908 { LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit },
910 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT_SELECT
911 * \li Action: Moves the cursor to the next beginning of a word "on the right",
912 adding *logically* traversed text to the selection.
913 * \li Notion: See also #LFUN_WORD_RIGHT for exact details of the movement.
914 * \li Syntax: word-right-select
915 * \li Origin: dov, 28 Oct 2007
918 { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
920 * \var lyx::FuncCode lyx::LFUN_WORD_SELECT
921 * \li Action: Puts the word where the cursor stands into the selection.
922 * \li Syntax: word-select
923 * \li Origin: Andre, 11 Sep 2002
926 { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
928 * \var lyx::FuncCode lyx::LFUN_WORD_CAPITALIZE
929 * \li Action: Capitalizes the words in the selection (i.e. the first letters)
930 or the letter on the cursor position.
931 * \li Syntax: word-capitalize
934 { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
936 * \var lyx::FuncCode lyx::LFUN_WORD_UPCASE
937 * \li Action: Change the words in the selection or from the cursor position
938 to the end of word to the upper case.
939 * \li Syntax: word-upcase
942 { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
944 * \var lyx::FuncCode lyx::LFUN_WORD_LOWCASE
945 * \li Action: Change the words in the selection or from the cursor position
946 to the end of word to the lower case.
947 * \li Syntax: word-lowcase
950 { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
952 * \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
953 * \li Action: Look up thesaurus entries with respect to the word under the cursor.
954 * \li Syntax: thesaurus-entry
955 * \li Origin: Levon, 20 Jul 2001
958 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
960 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN
961 * \li Action: Move the cursor to the beginning of the document.
962 * \li Syntax: buffer-begin
965 { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
967 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN_SELECT
968 * \li Action: Move the cursor to the beginning of the document adding the
969 traversed text to the selection.
970 * \li Syntax: buffer-begin-select
973 { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
975 * \var lyx::FuncCode lyx::LFUN_BUFFER_END
976 * \li Action: Move the cursor to the end of the document.
977 * \li Syntax: buffer-end
980 { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
982 * \var lyx::FuncCode lyx::LFUN_BUFFER_END_SELECT
983 * \li Action: Move the cursor to the end of the document adding the
984 traversed text to the selection.
985 * \li Syntax: buffer-end-select
988 { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
991 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN
992 * \li Action: Move the cursor to the begining of the (screen) line.
993 * \li Syntax: line-begin
996 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
998 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN_SELECT
999 * \li Action: Move the cursor to the beginning of the (screen) line adding the
1000 traversed text to the selection.
1001 * \li Syntax: line-begin-select
1004 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
1006 * \var lyx::FuncCode lyx::LFUN_LINE_END
1007 * \li Action: Move the cursor to the end of the (screen) line.
1008 * \li Syntax: line-end
1011 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
1013 * \var lyx::FuncCode lyx::LFUN_LINE_END_SELECT
1014 * \li Action: Move the cursor to the end of the (screen) line adding the
1015 traversed text to the selection.
1016 * \li Syntax: line-end-select
1019 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
1021 * \var lyx::FuncCode lyx::LFUN_LINE_DELETE
1022 * \li Action: Deletes the letters to the end of the (screen) line or
1023 deletes the selection.
1024 * \li Syntax: line-delete-forward
1027 { LFUN_LINE_DELETE, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
1029 * \var lyx::FuncCode lyx::LFUN_COPY
1030 * \li Action: Copies to the clipboard the last edit.
1034 { LFUN_COPY, "copy", ReadOnly, Edit },
1036 * \var lyx::FuncCode lyx::LFUN_CUT
1037 * \li Action: Cuts to the clipboard.
1041 { LFUN_CUT, "cut", Noop, Edit },
1043 * \var lyx::FuncCode lyx::LFUN_PASTE
1044 * \li Action: Pastes material from the active clipboard.
1045 * \li Syntax: paste [<TYPE>]
1046 * \li Params: <TYPE>: pdf|png|jpeg|linkback
1049 { LFUN_PASTE, "paste", Noop, Edit },
1051 * \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE
1052 * \li Action: Pastes text from the active clipboard.
1053 * \li Syntax: clipboard-paste [<ARG>]
1054 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1055 * \li Origin: baum, 10 Jul 2006
1058 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
1060 * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
1061 * \li Action: Pastes the currently text selected text.
1062 * \li Notion: Primary selection mechanism is linux-only thing.
1063 * \li Syntax: primary-selection-paste [<ARG>]
1064 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1067 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
1069 * \var lyx::FuncCode lyx::LFUN_UNDO
1070 * \li Action: Undoes the last edit.
1074 { LFUN_UNDO, "undo", Noop, Edit },
1076 * \var lyx::FuncCode lyx::LFUN_REDO
1077 * \li Action: Redoes the last thing undone.
1081 { LFUN_REDO, "redo", Noop, Edit },
1083 * \var lyx::FuncCode lyx::LFUN_REPEAT
1084 * \li Action: Repeat the given command.
1085 * \li Syntax: repeat <COUNT> <LFUN-COMMAND>
1086 * \li Origin: Andre, , 27 Oct 2003
1089 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
1091 * \var lyx::FuncCode lyx::LFUN_CHARS_TRANSPOSE
1092 * \li Action: Transposes the character at the cursor with the one before it.
1093 * \li Syntax: chars-transpose
1094 * \li Origin: Lgb, 25 Apr 2001
1097 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
1100 * \var lyx::FuncCode lyx::LFUN_DEPTH_DECREMENT
1101 * \li Action: Decrease the nesting depth of the (selected) paragraph(s)
1103 * \li Syntax: depth-decrement
1106 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
1108 * \var lyx::FuncCode lyx::LFUN_DEPTH_INCREMENT
1109 * \li Action: Increase the nesting depth of the (selected) paragraph(s)
1111 * \li Syntax: depth-increment
1114 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
1117 * \var lyx::FuncCode lyx::LFUN_FONT_BOLD
1118 * \li Action: Toggles the bold font (selection-wise) using mathbf in math.
1119 * \li Syntax: font-bold
1122 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
1125 * \var lyx::FuncCode lyx::LFUN_FONT_BOLDSYMBOL
1126 * \li Action: Toggles the bold font (selection-wise) using boldsymbol in math.
1127 * \li Syntax: font-boldsymbol
1130 { LFUN_FONT_BOLDSYMBOL, "font-boldsymbol", Noop, Layout },
1132 * \var lyx::FuncCode lyx::LFUN_FONT_TYPEWRITER
1133 * \li Action: Toggles the typewriter family font (selection-wise).
1134 * \li Syntax: font-typewriter
1137 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
1139 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERLINE
1140 * \li Action: Toggles underline in the font (selection-wise).
1141 * \li Syntax: font-underline
1144 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
1146 * \var lyx::FuncCode lyx::LFUN_FONT_EMPH
1147 * \li Action: Toggles the emphasis font style (selection-wise).
1148 * \li Syntax: font-emph
1151 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
1153 * \var lyx::FuncCode lyx::LFUN_FONT_NOUN
1154 * \li Action: Toggles Noun text style font (selection-wise).
1155 * \li Syntax: font-noun
1158 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
1160 * \var lyx::FuncCode lyx::LFUN_FONT_ROMAN
1161 * \li Action: Toggles Roman family font (selection-wise).
1162 * \li Syntax: font-roman
1165 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
1167 * \var lyx::FuncCode lyx::LFUN_FONT_SANS
1168 * \li Action: Toggles Sans Serif family font (selection-wise).
1169 * \li Syntax: font-sans
1172 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
1174 * \var lyx::FuncCode lyx::LFUN_FONT_FRAK
1175 * \li Action: Toggles Fraktur family font (math-mode, selection-wise).
1176 * \li Syntax: font-frak
1177 * \li Origin: vermeer, 10 Jan 2002
1180 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
1182 * \var lyx::FuncCode lyx::LFUN_FONT_ITAL
1183 * \li Action: Toggles Italics font shape (math-mode, selection-wise).
1184 * \li Syntax: font-ital
1185 * \li Origin: vermeer, 10 Jan 2002
1188 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
1190 * \var lyx::FuncCode lyx::LFUN_FONT_DEFAULT
1191 * \li Action: Reverts the settings of the font to the default values (selection-wise).
1192 * \li Syntax: font-default
1195 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
1197 * \var lyx::FuncCode lyx::LFUN_FONT_SIZE
1198 * \li Action: Sets font size according to lyx format string.
1199 * \li Syntax: font-size <SIZE>
1200 * \li Params: <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|\n
1201 largest|huge|giant|increase|decrease|default
1204 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
1206 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_APPLY
1207 * \li Action: Toggle user-defined (=last-time used) text style.
1208 * \li Notion: This style is set via #LFUN_TEXTSTYLE_UPDATE, which is
1209 automatically trigerred when using Text Style dialog.
1210 * \li Syntax: textstyle-apply
1211 * \li Origin: leeming, 12 Mar 2003
1214 { LFUN_TEXTSTYLE_APPLY, "textstyle-apply", Noop, Layout },
1216 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_UPDATE
1217 * \li Action: Apply text style and update the settings to be used by #LFUN_TEXTSTYLE_APPLY.
1218 * \li Syntax: textstyle-update <FONT_INFO>
1219 * \li Params: <FONT_INFO>: specifies font atributes, e.g. family, series, shape,
1220 size, emph, noun, underbar, number, color, language,
1222 Use lyx -dbg action for exact syntax of text-style
1224 * \li Origin: leeming, 12 Mar 2003
1227 { LFUN_TEXTSTYLE_UPDATE, "textstyle-update", Noop, Layout },
1229 * \var lyx::FuncCode lyx::LFUN_SCREEN_FONT_UPDATE
1230 * \li Action: Update fonts and its metrics.
1231 * \li Notion: Automatically called after zoom, dpi, font names, or norm change.
1232 * \li Syntax: screen-font-update
1233 * \li Origin: ARRae, 13 Aug 2000
1236 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
1238 * \var lyx::FuncCode lyx::LFUN_FONT_STATE
1239 * \li Action: Returns the info about the current font.
1240 * \li Syntax: font-state
1243 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
1246 * \var lyx::FuncCode lyx::LFUN_CITATION_INSERT
1247 * \li Action: Inserts citation from loaded citation database.
1248 * \li Syntax: citation-insert [<KEY>[|<TEXT_BEFORE>]]
1249 * \li Params: <KEY>: Citation (shortcut listed in available citations). \n
1250 <TEXT_BEFORE>: text which should appear before citation.
1251 * \li Origin: AAS, 97-02-23
1254 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
1256 * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_ADD
1257 * \li Action: Adds database, which will be used for bibtex citations.
1258 * \li Notion: Databases are added to the first BibTeX inset
1259 (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
1260 * \li Syntax: bibtex-database-add <DATABASE-NAME>
1261 * \li Origin: Ale, 30 May 1997
1264 { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit },
1266 * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_DEL
1267 * \li Action: Adds database, which will be used for bibtex citations.
1268 * \li Notion: Databases are deleted from the first BibTeX inset
1269 (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
1270 * \li Syntax: bibtex-database-del <DATABASE-NAME>
1271 * \li Origin: Ale, 30 May 1997
1274 { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
1277 * \var lyx::FuncCode lyx::LFUN_LAYOUT
1278 * \li Action: Sets the layout (that is, environment) for the current paragraph.
1279 * \li Syntax: layout <LAYOUT>
1280 * \li Params: <LAYOUT>: the layout to use
1283 { LFUN_LAYOUT, "layout", Noop, Layout },
1285 * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH
1286 * \li Action: Launches the paragraph settings dialog.
1287 * \li Syntax: layout-paragraph
1290 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
1292 * \var lyx::FuncCode lyx::LFUN_LAYOUT_TABULAR
1293 * \li Action: Launches the tabular settings dialog.
1294 * \li Syntax: layout-tabular
1295 * \li Origin: Jug, 31 Jul 2000
1298 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
1300 * \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE
1301 * \li Action: Displays list of layout choices.
1302 * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
1303 dropbox allowing for choice of layout.
1304 * \li Syntax: drop-layouts-choice
1307 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
1309 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
1310 * \li Action: Clears the module list.
1311 * \li Notion: Clears the list of included modules for the current buffer.
1312 * \li Syntax: layout-modules-clear
1313 * \li Origin: rgh, 25 August 2007
1316 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", Noop, Layout },
1318 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULE_ADD
1319 * \li Action: Adds a module.
1320 * \li Notion: Adds a module to the list of included modules for the current buffer.
1321 * \li Syntax: layout-module-add <MODULE>
1322 * \li Params: <MODULE>: the module to be added
1323 * \li Origin: rgh, 25 August 2007
1326 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", Noop, Layout },
1328 * \var lyx::FuncCode lyx::LFUN_LAYOUT_RELOAD
1329 * \li Action: Reloads layout information.
1330 * \li Notion: Reloads all layout information for the current buffer from disk, thus
1331 recognizing any changes that have been made to layout files on the fly.
1332 This is intended to be used only by layout developers and should not be
1333 used when one is trying to do actual work.
1334 * \li Syntax: layout-reload
1335 * \li Origin: rgh, 3 September 2007
1338 { LFUN_LAYOUT_RELOAD, "layout-reload", Noop, Layout },
1340 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
1341 * \li Action: Sets the text class for the current buffer.
1342 * \li Syntax: textclass-apply <TEXTCLASS>
1343 * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
1344 the filename, minus the ".layout" extension.
1347 { LFUN_TEXTCLASS_APPLY, "textclass-apply", Noop, Layout },
1349 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
1350 * \li Action: Loads information for a textclass from disk.
1351 * \li Syntax: textclass-load <TEXTCLASS>
1352 * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
1353 the filename, minus the ".layout" extension.
1356 { LFUN_TEXTCLASS_LOAD, "textclass-load", Noop, Layout },
1359 * \var lyx::FuncCode lyx::LFUN_MARK_OFF
1360 * \li Action: Disable selecting of text-region.
1361 * \li Syntax: mark-off
1364 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
1366 * \var lyx::FuncCode lyx::LFUN_MARK_ON
1367 * \li Action: Enable selecting of text-region.
1368 * \li Notion: After enabling you can simply move arrow keys to get selected region.
1369 * \li Syntax: mark-on
1372 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
1374 * \var lyx::FuncCode lyx::LFUN_MARK_TOGGLE
1375 * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
1376 * \li Syntax: mark-toggle
1377 * \li Origin: Andre, May 5 2006
1380 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
1383 * \var lyx::FuncCode lyx::LFUN_MATH_DELIM
1384 * \li Action: Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
1385 * \li Syntax: math-delim [<LEFT>] [<RIGHT>]
1386 * \li Params: <LEFT/RIGHT>: Delimiters to be used. Each delimiter can be specified by
1387 either a LaTeX name or a valid character.
1388 ( is the default letter.
1389 * \li Sample: math-delim { rangle
1390 * \li Origin: Alejandro, 18 Jun 1996
1393 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
1395 * \var lyx::FuncCode lyx::LFUN_MATH_BIGDELIM
1396 * \li Action: Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
1397 * \li Syntax: math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
1398 * \li Params: <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r \n
1399 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
1400 * \li Sample: math-bigdelim "Bigl" "\Downarrow" "Bigr" "\}"
1401 * \li Origin: Enrico & Georg, 7 May 2006
1404 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
1406 * \var lyx::FuncCode lyx::LFUN_MATH_DISPLAY
1407 * \li Action: Creates a new displayed equation in text mode.
1408 Toggles inlined/display formula in math mode.
1409 * \li Syntax: math-display [<ARG>]
1410 * \li Params: <ARG>: this argument will be passed to #LFUN_MATH_INSERT when creating
1411 new equation from the text mode.
1412 * \li Origin: Alejandro, 18 Jun 1996
1415 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
1417 * \var lyx::FuncCode lyx::LFUN_MATH_INSERT
1418 * \li Action: Inserts math objects and symbols.
1419 * \li Syntax: math-insert <ARG>
1420 * \li Params: <ARG>: Symbol or LaTeX code to be inserted.
1423 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
1425 * \var lyx::FuncCode lyx::LFUN_MATH_SUBSCRIPT
1426 * \li Action: Enters subscript expression in math expression.
1427 * \li Syntax: math-subscript
1428 * \li Origin: vermeer, 12 Dec 2001
1431 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
1433 * \var lyx::FuncCode lyx::LFUN_MATH_SUPERSCRIPT
1434 * \li Action: Enters subscript expression in math expression.
1435 * \li Syntax: math-superscript
1436 * \li Origin: vermeer, 12 Dec 2001
1439 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
1441 * \var lyx::FuncCode lyx::LFUN_MATH_LIMITS
1442 * \li Action: Toggles the position of the limits from above/below to the right
1443 side an vice versa in integral symbol, a limit, a summation, etc.
1444 * \li Notion: Put the cursor before the symbol with the limits and then invoke
1446 * \li Syntax: math-limits [<STATE>]
1447 * \li Params: <STATE>: limits|nolimits
1450 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
1452 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO
1453 * \li Action: Inserts a math macro definition at the cursor position in the text.
1454 * \li Syntax: math-macro <NAME> [<NARGS>] [def]
1455 * \li Params: <NAME>: The name of the macro, e.g. "mymacro".
1456 <NARGS>: The number of parameters of the macro. Default is 0.
1457 "def": Has no effect anymore, just for compatibility with former LyX versions.
1458 * \li Origin: ale, 10 May 1997; sts, 21 Dec 2007
1461 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
1463 * \var lyx::FuncCode lyx::LFUN_MATH_MUTATE
1464 * \li Action: Mutates the type of math inset to the newly selected one.
1465 * \li Syntax: math-mutate <TYPE>
1466 * \li Params: <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
1467 multline|gather|flalign
1468 * \li Origin: Andre, 23 May 2001
1471 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
1473 * \var lyx::FuncCode lyx::LFUN_MATH_SPACE
1474 * \li Action: Inserts space into math expression.
1475 * \li Notion: Use spacebar after entering this space to change type of space.
1476 * \li Syntax: math-space [<TYPE>]
1477 * \li Params: <TYPE>: negative spaces: !|negmedspace|negthickspace \n
1478 positive spaces: ,|:|;|quad|qquad \n
1479 "," used by default.
1480 * \li Origin: Andre, 25 Jul 2001; sanda, 16 Jun 2008
1483 { LFUN_MATH_SPACE, "math-space", Noop, Math },
1485 * \var lyx::FuncCode lyx::LFUN_MATH_MATRIX
1486 * \li Action: Inserts a matrix.
1487 * \li Syntax: math-matrix <COLS> <ROWS> [<ALIGN>]
1488 * \li Params: <ALIGN>: Alignment is a word composed of the vertical alignment
1489 (b, c or t) (i.e. 1 char) and the horizontal alignments
1490 (l, c or r) (i.e. <COL> chars).
1491 * \li Sample: math-matrix 3 3 bccc
1494 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
1496 * \var lyx::FuncCode lyx::LFUN_MATH_MODE
1497 * \li Action: In text mode enters math mode (i.e. puts math insets on the current
1498 cursor position), in math mode enters text mode inside math expression.
1499 * \li Notion: If there is some selected text, it puts the text inside created math box.
1500 * \li Syntax: math-mode [<ARG>]
1501 * \li Params: <ARG>: eventual argument (LaTeX code) is passed to #LFUN_MATH_INSERT .
1502 * \li Origin: Alejandro, 4 Jun 1996
1505 { LFUN_MATH_MODE, "math-mode", Noop, Math },
1507 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
1508 * \li Action: Toggles numbering of the current formula line.
1509 * \li Notion: Must be in display formula mode.
1510 * \li Syntax: math-number-line-toggle
1511 * \li Origin: Alejandro, 18 Jun 1996
1514 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
1516 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
1517 * \li Action: Toggles numbering/labeling of the current formula.
1518 * \li Notion: Must be in display formula mode.
1519 * \li Syntax: math-number-toggle
1520 * \li Origin: Alejandro, 4 Jun 1996
1523 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
1525 * \var lyx::FuncCode lyx::LFUN_MATH_EXTERN
1526 * \li Action: Calls external program and passes the current expression/equation
1527 as an argument for the calculation in the format appropriate to the
1529 * \li Notion: Selection can be used to determine the input for the external program.
1530 * \li Syntax: math-extern <LANG> [<COMMAND>]
1531 * \li Params: <LANG>: octave|maxima|maple|mathematica|script \n
1532 where "script" stands fot the external script (normalized
1533 expression will be passed)
1534 * \li Origin: Andre, 24 Apr 2001
1535 * \li Sample: math-extern maple simplify
1538 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
1540 * \var lyx::FuncCode lyx::LFUN_MATH_SIZE
1541 * \li Action: Changes arbitrarily the size used by math fonts inside a context.
1542 * \li Notion: Provides an interface to the LaTeX math mode font size commands.
1543 * \li Syntax: math-size <STYLE>
1544 * \li Params: <STYLE>: \displaystyle|\textstyle|\scriptstyle|\scriptscriptstyle
1545 * \li Origin: Alejandro, 15 Aug 1996; ps, 14 Jun 2008
1548 { LFUN_MATH_SIZE, "math-size", Noop, Math },
1550 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
1551 * \li Action: Unfold a Math Macro.
1552 * \li Notion: Unfold the Math Macro the cursor is in, i.e.
1554 * \li Syntax: math-macro-unfold
1555 * \li Origin: sts, 06 January 2008
1558 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
1560 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
1561 * \li Action: Fold a Math Macro.
1562 * \li Notion: Fold the Math Macro the cursor is in if it was
1563 unfolded, i.e. displayed as \foo before.
1564 * \li Syntax: math-macro-fold
1565 * \li Origin: sts, 06 January 2008
1568 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
1570 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
1571 * \li Action: Add a parameter.
1572 * \li Notion: Add a parameter to a Math Macro.
1573 * \li Params: <NUM>: The number of the parameter behind which the new one
1574 will be added (1 for the first, i.e. use 0 for add a
1575 parameter at the left), defaults to the last one.
1576 * \li Syntax: math-macro-add-param <NUM>
1577 * \li Origin: sts, 06 January 2008
1580 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
1582 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
1583 * \li Action: Remove the last parameter.
1584 * \li Notion: Remove the last parameter of a Math Macro and
1585 remove its value in all instances of the macro
1587 * \li Params: <NUM>: The number of the parameter to be deleted (1 for
1588 the first), defaults to the last one.
1589 * \li Syntax: math-macro-remove-param <NUM>
1590 * \li Origin: sts, 06 January 2008
1593 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
1595 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
1596 * \li Action: Append a greedy parameter.
1597 * \li Notion: Append a greedy parameter to a Math Macro which
1598 eats the following mathed cell in every instance of
1599 the macro in the buffer.
1600 * \li Syntax: math-macro-append-greedy-param
1601 * \li Origin: sts, 06 January 2008
1604 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
1606 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
1607 * \li Action: Remove a greedy parameter.
1608 * \li Notion: Remove a greedy parameter of a Math Macro and spit
1609 out the values of it in every instance of the macro
1610 in the buffer. If it is an optional parameter the [valud]
1612 * \li Syntax: math-macro-remove-greedy-param
1613 * \li Origin: sts, 06 January 2008
1616 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
1618 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
1619 * \li Action: Make a parameter optional.
1620 * \li Notion: Turn the first non-optional parameter of a Math Macro
1621 into an optional parameter with a default value.
1622 * \li Syntax: math-macro-make-optional
1623 * \li Origin: sts, 06 January 2008
1626 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
1628 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
1629 * \li Action: Make a parameter non-optional.
1630 * \li Notion: Turn the last optional parameter of a Math Macro
1631 into a non-optional parameter. The default value is
1632 remembered to be reused later if the user changes his mind.
1633 * \li Syntax: math-macro-make-nonoptional
1634 * \li Origin: sts, 06 January 2008
1637 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
1639 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
1640 * \li Action: Add an optional parameter.
1641 * \li Notion: Insert an optional parameter just behind the
1642 already existing optional parameters.
1643 * \li Syntax: math-macro-add-optional-param
1644 * \li Origin: sts, 06 January 2008
1647 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
1649 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
1650 * \li Action: Remove the last optional parameter.
1651 * \li Notion: Remove the last optional parameter of a Math Macro and
1652 remove it in all the instances of the macro in the buffer.
1653 * \li Syntax: math-macro-remove-optional-param
1654 * \li Origin: sts, 06 January 2008
1657 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
1659 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
1660 * \li Action: Add a greedy optional parameter.
1661 * \li Notion: Add a greedy optional parameter which eats the value
1662 from the following cells in mathed which are in the [value]
1664 * \li Syntax: math-macro-add-greedy-optional-param
1665 * \li Origin: sts, 06 January 2008
1668 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
1670 * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
1671 * \li Action: Only active in Math Macro definition.
1672 * \li Notion: Dummy function which is only active in a Math Macro definition.
1673 It's used to toggle the Math Macro toolbar if the cursor moves
1674 into a Math Macro definition.
1675 * \li Syntax: in-mathmacrotemplate
1676 * \li Origin: sts, 06 January 2008
1679 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
1682 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
1683 * \li Action: Moves the current paragraph downwards in the document.
1684 * \li Syntax: paragraph-move-down
1685 * \li Origin: Edwin, 8 Apr 2006
1688 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
1690 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
1691 * \li Action: Moves the current paragraph upwards in the document.
1692 * \li Syntax: paragraph-move-up
1693 * \li Origin: Edwin, 8 Apr 2006
1696 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
1699 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP
1700 * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1701 in upward direction.
1702 * \li Syntax: paragraph-up
1703 * \li Origin: Asger, 1 Oct 1996
1706 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
1708 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP_SELECT
1709 * \li Action: Move the cursor and select the text to the next paragraph (or
1710 begining of the current one) in upward direction.
1711 * \li Syntax: paragraph-up-select
1712 * \li Origin: Asger, 1 Oct 1996
1715 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
1717 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN
1718 * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1719 in downward direction.
1720 * \li Syntax: paragraph-down
1721 * \li Origin: Asger, 1 Oct 1996
1724 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
1726 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN_SELECT
1727 * \li Action: Move the cursor and select the text to the next paragraph (or
1728 begining of the current one) in downward direction.
1729 * \li Syntax: paragraph-down-select
1730 * \li Origin: Asger, 1 Oct 1996
1733 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
1735 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
1736 * \li Action: Jump to a paragraph given by its id number and optionally the
1737 desired position within the paragraph.
1738 * \li Notion: Note that id number of paragraph is not the sequential number of paragraph
1739 seen on the screen. Moreover the id is unique for all opened buffers (documents).
1740 * \li Syntax: paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
1741 * \li Params: <PAR_ID_NUMBER>: paragraph id \n
1742 <POSITION_IN_PAR>: desired position within the paragraph
1743 * \li Origin: Dekel, 26 Aug 2000
1746 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly, Edit },
1748 * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1749 * \li Action: Breaks the current paragraph at the current location.
1750 * \li Syntax: break-paragraph
1753 { LFUN_PARAGRAPH_SPACING, "paragraph-spacing", Noop, Edit },
1755 * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1756 * \li Action: Breaks the current paragraph at the current location.
1757 * \li Notion: Removes the selection.
1758 * \li Syntax: break-paragraph [<LAYOUT>]
1759 * \li Params: <LAYOUT>: "inverse" - decreases depth by one (or change layout
1760 to default layout) when the cursor is at the end of
1764 { LFUN_BREAK_PARAGRAPH, "break-paragraph", Noop, Edit },
1766 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
1767 * \li Action: Change paragraph settings.
1768 * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
1769 This function only modifies, and does not override, existing settings.
1770 Note that the "leftindent" indent setting is deprecated.
1771 * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
1772 * \li Params: <INDENT>: \\noindent|\\indent|\\indent-toggle|\\leftindent LENGTH\n
1773 <SPACING>: \\paragraph_spacing default|single|onehalf|double|other\n
1774 <ALIGN>: \\align block|left|right|center|default\n
1775 <OTHERS>: \\labelwidthstring WIDTH|\\start_of_appendix\n
1776 * \li Origin: rgh, Aug 15 2007
1779 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
1781 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
1782 * \li Action: Change paragraph settings.
1783 * \li Notion: Overwrite all nonspecified settings to the default ones.
1784 Use paragraph-params lfun if you don't want to overwrite others settings.
1785 * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
1786 * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
1787 * \li Origin: leeming, 30 Mar 2004
1790 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
1792 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UPDATE
1793 * \li Action: Updates the values inside the paragraph dialog from the paragraph.
1794 * \li Notion: This is internal LFUN, not to be used by users. Called internally
1795 by #LFUN_DIALOG_UPDATE.
1796 * \li Origin: leeming, 13 Mar 2003
1799 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
1802 * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
1803 * \li Action: Move the current group in the upward direction in the
1804 structure of the document.
1805 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1806 the whole substructure of the group.
1807 * \li Syntax: outline-up
1808 * \li Origin: Vermeer, 23 Mar 2006
1811 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
1813 * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
1814 * \li Action: Move the current group in the downward direction in the
1815 structure of the document.
1816 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1817 the whole substructure of the group.
1818 * \li Syntax: outline-down
1819 * \li Origin: Vermeer, 23 Mar 2006
1822 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
1824 * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
1825 * \li Action: Moves the current group in the downward direction in the
1826 hierarchy of the document structure.
1827 * \li Notion: Part -> Chapter -> Section -> etc.
1828 * \li Syntax: outline-in
1829 * \li Origin: Vermeer, 23 Mar 2006
1832 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
1834 * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
1835 * \li Action: Moves the current group in the upward direction in the
1836 hierarchy of the document structure.
1837 * \li Notion: Part <- Chapter <- Section <- etc.
1838 * \li Syntax: outline-out
1839 * \li Origin: Vermeer, 23 Mar 2006
1842 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
1844 * \var lyx::FuncCode lyx::LFUN_INSET_EDIT
1845 * \li Action: Edit the inset at cursor with an external application,
1846 * if one is attributed.
1847 * \li Syntax: inset-edit [<INSET_PARAMS>]
1848 * \li Params: <INSET_PARAMS>: Parameters for the inset. \n
1849 Currently only the filename will be considered.
1850 * \li Origin: JSpitzm, 27 Apr 2006
1853 { LFUN_INSET_EDIT, "inset-edit", Noop, Edit },
1856 * \var lyx::FuncCode lyx::LFUN_TABULAR_INSERT
1857 * \li Action: Inserts table into the document.
1858 * \li Syntax: tabular-insert [<ROWS> <COLUMNS>]
1859 * \li Params: In case no arguments are given show insert dialog.
1860 * \li Origin: Jug, 12 Apr 2000
1863 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
1865 * \var lyx::FuncCode lyx::LFUN_TABULAR_FEATURE
1866 * \li Action: Sets various features to the table/cell on the current cursor position.
1867 * \li Notion: Various math-environment features are handled here as well, e.g.
1868 add-vline-left/right for Grid/Cases environment
1869 * \li Syntax: tabular-feature <FEATURE> [<ARG>]
1870 * \li Params: <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|copy-column|
1871 toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
1872 align-left|align-right|align-center|align-block|valign-top|valign-bottom|
1873 valign-middle|m-align-left|m-align-right|m-align-center|m-valign-top|
1874 m-valign-bottom|m-valign-middle|multicolumn|set-all-lines|unset-all-lines|
1875 set-longtabular|unset-longtabular|set-pwidth|set-mpwidth|
1876 set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|
1877 set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|
1878 unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|
1879 set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
1880 set-special-column|set-special-multi|set-booktabs|unset-booktabs|
1881 set-top-space|set-bottom-space|set-interline-space|set-border-lines \n
1882 <ARG>: additional argument for some commands, use debug mode to explore its values.
1883 * \li Origin: Jug, 28 Jul 2000
1886 { LFUN_TABULAR_FEATURE, "tabular-feature", Noop, Edit },
1888 * \var lyx::FuncCode lyx::LFUN_CELL_BACKWARD
1889 * \li Action: Moves the cursor to the previous cell inside the table.
1890 * \li Syntax: cell-backward
1891 * \li Origin: Jug, 22 May 2000
1894 { LFUN_CELL_BACKWARD, "cell-backward", Noop, Edit },
1896 * \var lyx::FuncCode lyx::LFUN_CELL_FORWARD
1897 * \li Action: Moves the cursor to the next cell inside the table.
1898 * \li Syntax: cell-forward
1901 { LFUN_CELL_FORWARD, "cell-forward", Noop, Edit },
1903 * \var lyx::FuncCode lyx::LFUN_CELL_SPLIT
1904 * \li Action: Splits cell and shifts right part to the next cell (inside the math grid).
1905 * \li Syntax: cell-split
1906 * \li Origin: Ale, 15 May 1997
1909 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
1912 * \var lyx::FuncCode lyx::LFUN_VC_REGISTER
1913 * \li Action: Register the document as an file inside version control system (RCS, CVS).
1914 * \li Notion: File is registered inside cvs, svn or rcs repository acording to the existence
1915 of cvs/svn/rcs entries in the document's directory. \n
1916 See LyX Extended Manual (Version Control Chapter) for additional information.
1917 * \li Syntax: vc-register
1918 * \li Origin: Lgb, 1 Jul 1997
1921 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
1923 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_IN
1924 * \li Action: Checks-in/commits the changes of the registered file to the repository.
1925 * \li Notion: In RCS case this also unlocks the file.
1926 * \li Syntax: vc-check-in
1927 * \li Origin: Lgb, 1 Jul 1997
1930 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
1932 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_OUT
1933 * \li Action: Checks-out the document for edit (and locks it for RCS).
1934 * \li Notion: This is implemented only for RCS and SVN, not CVS.
1935 * \li Syntax: vc-check-out
1936 * \li Origin: Lgb, 1 Jul 1997
1939 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
1941 * \var lyx::FuncCode lyx::LFUN_VC_REVERT
1942 * \li Action: Reverts the document to the last check-in/commit in VCS.
1943 * \li Syntax: vc-revert
1944 * \li Origin: Lgb, 1 Jul 1997
1947 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
1949 * \var lyx::FuncCode lyx::LFUN_VC_UNDO_LAST
1950 * \li Action: Undo last check-in.
1951 * \li Notion: This is currently implemented only for RCS.
1952 * \li Syntax: vc-check-out
1953 * \li Origin: Lgb, 1 Jul 1997
1956 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
1959 * \var lyx::FuncCode lyx::LFUN_CHANGES_TRACK
1960 * \li Action: Toggles change tracking to on/off.
1961 * \li Syntax: changes-track
1962 * \li Origin: levon, 1 Oct 2002
1965 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
1967 * \var lyx::FuncCode lyx::LFUN_CHANGES_OUTPUT
1968 * \li Action: Toggles showing of change tracking in typesetted output.
1969 * \li Syntax: changes-output
1970 * \li Origin: jspitzm, 21 Jan 2005
1973 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
1975 * \var lyx::FuncCode lyx::LFUN_CHANGE_NEXT
1976 * \li Action: Moves the cursor to the position of the next change
1977 of the change tracking records.
1978 * \li Syntax: change-next
1979 * \li Origin: schmitt, 4 Oct 2006
1982 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
1984 * \var lyx::FuncCode lyx::LFUN_CHANGES_MERGE
1985 * \li Action: Open change tracking dialog for merging and moves the cursor
1986 to the position of the next change.
1987 * \li Syntax: changes-merge
1988 * \li Origin: Levon, 16 Oct 2002
1991 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
1993 * \var lyx::FuncCode lyx::LFUN_CHANGE_ACCEPT
1994 * \li Action: Accepts tracked change inside the selection.
1995 * \li Syntax: change-accept
1996 * \li Origin: Levon, 16 Oct 2002
1999 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
2001 * \var lyx::FuncCode lyx::LFUN_CHANGE_REJECT
2002 * \li Action: Rejects tracked change inside the selection.
2003 * \li Syntax: change-accept
2004 * \li Origin: Levon, 16 Oct 2002
2007 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
2009 * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_ACCEPT
2010 * \li Action: Accepts all tracked changes in the document.
2011 * \li Syntax: all-changes-accept
2012 * \li Origin: Levon, 16 Oct 2002
2015 { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
2017 * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_REJECT
2018 * \li Action: Rejects all tracked changes in the document.
2019 * \li Notion: Reject does not work recursively; the user may have to repeat the operation.
2020 * \li Syntax: all-changes-reject
2021 * \li Origin: Levon, 16 Oct 2002
2024 { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
2027 * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
2028 * \li Action: Apply data for an inset.
2029 * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
2030 be applied. This is either changed to #LFUN_INSET_MODIFY or
2031 #LFUN_INSET_INSERT depending on the context where it is called.
2032 * \li Syntax: inset-apply <ARGS>
2033 * \li Params: See #LFUN_INSET_INSERT .
2036 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
2038 * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE
2039 * \li Action: Dissolve the current inset into text.
2040 * \li Syntax: inset-dissolve [<INSET>]
2041 * \li Params: <INSET>: this can be used to make sure the right kind of inset
2042 is dissolved. For example "dissolve" entry in the charstyles
2043 sub-menu should only dissolve the charstyle inset, even if the
2044 cursor is inside several nested insets of different type.\n
2045 For values see #lyx::InsetLayout::lyxtype_ .
2046 * \li Origin: JSpitz, 7 Aug 2006
2049 { LFUN_INSET_DISSOLVE, "inset-dissolve", Noop, Edit },
2051 * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
2052 * \li Action: Insert new inset (type given by the parameters).
2053 * \li Syntax: inset-insert <INSET> <ARGS>
2054 * \li Params: <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics|
2055 hyperlink|include|index|label|nomencl|vspace|ref|toc>\n
2056 <ARGS>: depends on the given inset. Use "lyx -dbg action" to
2058 * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
2059 where <label name> is the name of the referenced label and
2060 <Format> is one of the following: \n
2061 ref -- <reference> \n
2062 eqref -- (<reference>) \n
2063 pageref -- <page> \n
2064 vpageref -- on <page> \n
2065 vref -- <reference> on <page> \n
2066 prettyref -- Formatted reference
2069 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
2071 * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
2072 * \li Action: Modify existing inset.
2073 * \li Notion: Used for label, floats, listings, box, branch, external, wrap
2074 bibtex, ert, command, graphics, note, space, vspace, tabular,
2075 bibitem, inlude, ref insets.
2076 * \li Syntax: inset-modify <INSET> <ARGS>
2077 * \li Params: See #LFUN_INSET_INSERT for further details.
2080 { LFUN_INSET_MODIFY, "", Noop, Hidden },
2082 * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_MODIFY
2083 * \li Action: Modify the inset at cursor position, if there is one.
2084 * \li Notion: Used for label, floats, listings, box, branch, external, wrap
2085 bibtex, ert, command, graphics, note, space, vspace, tabular,
2086 bibitem, inlude, ref insets.
2087 * \li Syntax: next-inset-modify <INSET> <ARGS>
2088 * \li Syntax: next-inset-modify changetype <TYPE>
2089 * \li Params: See #LFUN_INSET_INSERT for further details.
2090 * \li Origin: JSpitzm, 23 Mar 2008
2093 { LFUN_NEXT_INSET_MODIFY, "next-inset-modify", ReadOnly, Edit },
2095 * \var lyx::FuncCode lyx::LFUN_INSET_DIALOG_UPDATE
2096 * \li Action: Updates the values inside the dialog from the inset.
2097 * \li Notion: This is internal LFUN, not to be used by users. Called internally
2098 by #LFUN_DIALOG_UPDATE
2099 * \li Params: <DIALOG-NAME>
2100 * \li Origin: leeming, 25 Feb 2003
2103 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
2105 * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
2106 * \li Action: Open the inset's properties dialog.
2107 * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
2108 * \li Syntax: inset-settings <INSET>
2109 * \li Params: <INSET>: <box|branch|ert|float|listings|note|tabular|wrap>
2112 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly, Edit },
2114 * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_TOGGLE
2115 * \li Action: Toggles the inset at cursor position. For collapsables, this means it will
2116 be (un-)collapsed, in case of other insets, the editing widget (dialog) will
2117 be entered. Also cf. #LFUN_INSET_SETTINGS.
2118 * \li Notion: Used for label, floats, listings, box, branch, external, wrap
2119 bibtex, ert, command, graphics, note, space, vspace, tabular,
2120 bibitem, inlude, ref insets.
2121 * \li Syntax: next-inset-toggle <ARG>
2122 * \li Params: <ARG>: these are passed as arguments to #LFUN_INSET_TOGGLE .
2123 * \li Origin: leeming, 30 Mar 2004
2126 { LFUN_NEXT_INSET_TOGGLE, "next-inset-toggle", ReadOnly, Edit },
2128 * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
2129 * \li Action: Toggles the collapsable inset we are currently in.
2130 * \li Syntax: inset-toggle [<ARG>]
2131 * \li Params: <ARG>: <open|close|toggle|assign>. \n
2132 open/close/toggle are for collapsable insets. close can be currently used
2133 by #LFUN_NEXT_INSET_TOGGLE. toggle is used when no argument is given.\n
2134 assign is for branch inset.
2135 * \li Origin: lasgouttes, 19 Jul 2001
2138 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly, Hidden },
2140 * \var lyx::FuncCode lyx::LFUN_ALL_INSETS_TOGGLE
2141 * \li Action: Toggles (open/closes) all collapsable insets (of a given type) in the document.
2142 * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
2143 * \li Syntax: all-insets-toggle <STATE> <INSET>
2144 * \li Params: <STATE>: <toggle|open|close> default: toggle \n
2145 <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all insets
2146 * \li Origin: leeming, 30 Mar 2004
2149 { LFUN_ALL_INSETS_TOGGLE, "all-insets-toggle", ReadOnly, Edit },
2151 * \var lyx::FuncCode lyx::LFUN_SET_GRAPHICS_GROUP
2152 * \li Action: Set the group for the graphics inset on the cursor position.
2153 * \li Syntax: set-graphics-group [<GROUP>]
2154 * \li Params: <GROUP>: Id for an existing group. In case the Id is an empty string,
2155 the graphics inset is removed from the current group.
2156 * \li Origin: sanda, 6 May 2008
2159 { LFUN_SET_GRAPHICS_GROUP, "set-graphics-group", Noop, Edit },
2162 * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
2163 * \li Action: Moves the cursor out of the current slice, going forward.
2164 * \li Notion: Cursor movement within an inset may be different than cursor
2165 movement in the surrounding text. This action should be called
2166 automatically by the cursor movement within the inset, when
2167 movement within the inset has ceased (reached the end of the
2168 last paragraph, for example), in order to move correctly
2169 back into the surrounding text.
2172 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
2174 * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
2175 * \li Action: Moves the cursor out of the current slice, going backwards.
2176 * \li Notion: See also #LFUN_FINISHED_FORWARD.
2179 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
2181 * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
2182 * \li Action: Moves the cursor out of the current slice, going right.
2183 * \li Notion: See also #LFUN_FINISHED_FORWARD
2186 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
2188 * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
2189 * \li Action: Moves the cursor out of the current slice, going left.
2190 * \li Notion: See also #LFUN_FINISHED_FORWARD.
2193 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
2196 * \var lyx::FuncCode lyx::LFUN_LANGUAGE
2197 * \li Action: Set language from the current cursor position.
2198 * \li Syntax: language <LANG>
2199 * \li Params: <LANG>: Requested language. Look in lib/languages for
2201 * \li Origin: Dekel, 2 Mar 2000
2204 { LFUN_LANGUAGE, "language", Noop, Edit },
2207 * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
2208 * \li Action: Goto a label.
2209 * \li Syntax: label-goto [<LABEL>]
2210 * \li Params: <LABEL>: Requested label. If no label is given and refernce
2211 is on cursor position, Bookmark 0 is saved and
2212 cursor moves to the position of referenced label.
2213 * \li Origin: Ale, 6 Aug 1997
2216 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
2218 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT
2219 * \li Action: Inserts label to text or displayed formula.
2220 * \li Syntax: label-insert [<LABEL>]
2221 * \li Params: <LABEL>: Requested label. If no label is given dialog requesting
2222 name will be opened.
2225 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
2227 * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
2228 * \li Action: Go to the next label or cross-reference.
2229 * \li Syntax: reference-next
2230 * \li Origin: Dekel, 14 Jan 2001
2233 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
2236 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
2237 * \li Action: Goto a bookmark.
2238 * \li Notion: Moves the cursor to the numbered bookmark, opening the file
2239 if necessary. Note that bookmarsk are saved per-session, not
2241 * \li Syntax: bookmark-goto <NUMBER>
2242 * \li Params: <NUMBER>: the number of the bookmark to restore.
2243 * \li Origin: Dekel, 27 January 2001
2246 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
2248 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
2249 * \li Action: Save a bookmark.
2250 * \li Notion: Saves a numbered bookmark to the sessions file. The number
2251 must be between 1 and 9, inclusive. Note that bookmarks are
2252 saved per-session, not per file.
2253 * \li Syntax: bookmark-save <NUMBER>
2254 * \li Params: <NUMBER>: the number of the bookmark to save.
2255 * \li Origin: Dekel, 27 January 2001
2258 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
2260 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
2261 * \li Action: Clears the list of saved bookmarks.
2262 * \li Syntax: bookmark-clear
2263 * \li Origin: bpeng, 31 October 2006
2266 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
2269 * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
2270 * \li Action: Open the given help file according to the language setting.
2271 * \li Syntax: help-open <FILE>[.lyx]
2272 * \li Params: <FILE>: any document from (/usr/share/)doc directory.
2273 * \li Origin: Jug, 27 Jun 1999
2276 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
2278 * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
2279 * \li Action: Terminates the current LyX instance.
2280 * \li Notion: Terminates the current LyX instance, asking whether to save
2281 modified documents, etc.
2282 * \li Syntax: lyx-quit
2285 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
2287 * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
2288 * \li Action: Toggles visibility of a given toolbar between on/off/auto.
2289 * \li Notion: Skiping "auto" when allowauto is false.
2290 * \li Syntax: toolbar-toggle <NAME> [allowauto]
2291 * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|
2292 minibuffer|review|view/update|math_panels|vcs
2293 * \li Origin: Edwin, 21 May 2007
2296 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
2298 * \var lyx::FuncCode lyx::LFUN_MENU_OPEN
2299 * \li Action: Opens the menu given by its name.
2300 * \li Syntax: menu-open <NAME>
2301 * \li Params: <NAME>: menu name. See various .inc files in lib/ui for candidates.
2304 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
2306 * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
2307 * \li Action: Various UI visibility-toggling actions.
2308 * \li Syntax: ui-toggle <statusbar|menubar|frame|fullscreen>
2309 * \li Params: statusbar : Toggle visibility of the statusbar.\n
2310 menubar : Toggle visibility of the menubar.\n
2311 scrollbar : Toggle visibility of the scrollbar.\n
2312 frame : Toggle visibility of the frames around editing window.\n
2313 fullscreen : Toggle fullscreen mode. This also covers calling the
2314 previous functions. However #LFUN_TOOLBAR_TOGGLE for the
2315 custom tweaks of the toolbars should be used.
2316 * \li Origin: sanda, 9 Feb 2007
2319 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
2322 * \var lyx::FuncCode lyx::WINDOW_NEW
2323 * \li Action: Creates new empty LyX window.
2324 * \li Notion: Already opened documents from the previous window can be found under View menu.
2325 * \li Syntax: window-new [<GEOMETRY>]
2326 * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently
2327 accepted only on Windows platform.
2328 * \li Origin: Abdel, 21 Oct 2006
2331 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
2333 * \var lyx::FuncCode lyx::LFUN_WINDOW_CLOSE
2334 * \li Action: Closes the current LyX window.
2335 * \li Syntax: window-close
2336 * \li Origin: Abdel, 23 Oct 2006
2339 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
2342 * \var lyx::FuncCode lyx::LFUN_SPLIT_VIEW
2343 * \li Action: Creates another split view of current buffer.
2344 * \li Notion: All split views act in the same way indpendently.
2345 * \li Syntax: split-view <vertical|horizontal>
2346 * \li Params: horizontal : The work areas are laid out side by side.\n
2347 vertical : The work areas laid out vertically.
2348 * \li Origin: Abdel, 20 Feb 2008
2351 { LFUN_SPLIT_VIEW, "split-view", ReadOnly, Buffer },
2354 * \var lyx::FuncCode lyx::LFUN_CLOSE_TAB_GROUP
2355 * \li Action: Close the current tab group.
2356 * \li Notion: This only closes the work areas, not the buffer themselves.
2357 The still opened buffers can be visualized in another tab group.
2358 * \li Syntax: close-tab-group
2359 * \li Origin: Abdel, 21 Feb 2008
2362 { LFUN_CLOSE_TAB_GROUP, "close-tab-group", ReadOnly, Buffer },
2364 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW
2365 * \li Action: Shows hidden dialog or create new one for a given function/inset settings etc.
2366 * \li Syntax: dialog-show <NAME> [<DATA>]
2367 * \li Params: <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|\n
2368 document|errorlist|ert|external|file|findreplace|float|graphics|\n
2369 include|index|info|nomenclature|label|log|mathdelimiter|mathmatrix|\n
2370 note|paragraph|prefs|print|ref|sendto|space|spellchecker|symbols|\n
2371 tabular|tabularcreate|thesaurus|texinfo|toc|href|view-source|vspace\n
2372 wrap|listings|<SPECIAL> \n
2373 <SPECIAL>: latexlog|vclog \n
2374 <DATA>: data, usually settings for the given dialog. Use debug mode for the
2376 * \li Origin: leeming, 17 Jun 2003
2379 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
2381 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW_NEW_INSET
2382 * \li Action: Shows hidden dialog or create new one for a given inset settings etc.
2383 * \li Notion: Internally uses #LFUN_DIALOG_SHOW with processed data for a given inset.
2384 * \li Syntax: dialog-show-new-inset <NAME> [<DATA>]
2385 * \li Params: See #LFUN_DIALOG_SHOW .
2386 * \li Origin: leeming, 25 Feb 2003
2389 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
2391 * \var lyx::FuncCode lyx::LFUN_DIALOG_UPDATE
2392 * \li Action: Updates the dialog values from the inset/paragraph/document.
2393 * \li Syntax: dialog-update <NAME>
2394 * \li Params: <NAME>: paragraph|prefs|<INSET> \n
2396 * \li Origin: leeming, 25 Feb 2003
2399 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
2401 * \var lyx::FuncCode lyx::LFUN_DIALOG_HIDE
2402 * \li Action: Hides showed dialog. Counterpart to #LFUN_DIALOG_SHOW .
2403 * \li Syntax: dialog-hide <NAME>
2404 * \li Params: See #LFUN_DIALOG_SHOW .
2405 * \li Origin: leeming, 25 Feb 2003
2408 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
2410 * \var lyx::FuncCode lyx::LFUN_DIALOG_TOGGLE
2411 * \li Action: Toggles dialog between showed/hidden state.
2412 * \li Notion: Internally uses #LFUN_DIALOG_SHOW , #LFUN_DIALOG_HIDE .
2413 * \li Syntax: dialog-toggle <NAME> [<DATA>]
2414 * \li Params: See #LFUN_DIALOG_SHOW .
2415 * \li Origin: JSpitzm, 30 Apr 2007
2418 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
2420 * \var lyx::FuncCode lyx::LFUN_DIALOG_DISCONNECT_INSET
2421 * \li Action: Closes opened connection to opened inset.
2422 * \li Notion: Connection is used for apply functions.
2423 * \li Syntax: dialog-disconnect-inset <INSET-NAME>
2424 * \li Origin: leeming, 25 Feb 2003
2427 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
2430 * \var lyx::FuncCode lyx::LFUN_MOUSE_PRESS
2431 * \li Action: This function is called when mouse button is pressed (inside workarea).
2432 Action depends on the context.
2433 * \li Notion: This is internal LFUN, not to be used by users.
2434 * \li Origin: Andre, 9 Aug 2002
2437 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
2439 * \var lyx::FuncCode lyx::LFUN_MOUSE_DOUBLE
2440 * \li Action: This function is called when double click on mouse button is
2441 pressed (inside workarea). Action depends on the context.
2442 * \li Notion: This is internal LFUN, not to be used by users.
2443 * \li Origin: Andre, 9 Aug 2002
2446 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
2448 * \var lyx::FuncCode lyx::LFUN_MOUSE_TRIPLE
2449 * \li Action: This function is called when triple click on mouse button is
2450 pressed (inside workarea). Action depends on the context.
2451 * \li Notion: This is internal LFUN, not to be used by users.
2452 * \li Origin: Andre, 9 Aug 2002
2455 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
2457 * \var lyx::FuncCode lyx::LFUN_MOUSE_MOTION
2458 * \li Action: This function is called when mouse cursor is moving over the text.
2459 Action depends on the context.
2460 * \li Notion: This is internal LFUN, not to be used by users.
2461 * \li Origin: Andre, 9 Aug 2002
2464 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
2466 * \var lyx::FuncCode lyx::LFUN_MOUSE_RELEASE
2467 * \li Action: This function is called when mouse button is released (inside workarea).
2468 Action depends on the context.
2469 * \li Notion: This is internal LFUN, not to be used by users.
2470 * \li Origin: Andre, 9 Aug 2002
2473 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
2476 * \var lyx::FuncCode lyx::LFUN_KEYMAP_OFF
2477 * \li Action: Turn off the loaded keyboard map.
2478 * \li Syntax: keymap-off
2481 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
2483 * \var lyx::FuncCode lyx::LFUN_KEYMAP_PRIMARY
2484 * \li Action: Turn on the primary keyboard map.
2485 * \li Notion: Maps were widely used in past, when X-windows didn't have nowadays
2486 keyboard support. They can be still used to maintain uniform keyboard
2487 layout across the various plaforms.\n
2488 The language is to be set in the Preferences dialog.
2489 * \li Syntax: keymap-primary
2492 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
2494 * \var lyx::FuncCode lyx::LFUN_KEYMAP_SECONDARY
2495 * \li Action: Turn on the secondary keyboard map.
2496 * \li Syntax: keymap-secondary
2499 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
2501 * \var lyx::FuncCode lyx::LFUN_KEYMAP_TOGGLE
2502 * \li Action: Toggles keyboard maps (first/second/off).
2503 * \li Syntax: keymap-toggle
2504 * \li Origin: leeming, 30 Mar 2004
2507 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
2510 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_LAYOUT
2511 * \li Action: Returns the current layout (that is environment) name
2512 on the cursor position.
2513 * \li Syntax: server-get-layout
2516 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
2518 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_FILENAME
2519 * \li Action: Returns path and file name of the currently edited document.
2520 * \li Syntax: server-get-filename
2523 { LFUN_SERVER_GET_FILENAME, "server-get-filename", ReadOnly, System },
2525 * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
2526 * \li Action: Sets the cursor position based on the row number of generated TeX file.
2527 * \li Syntax: server-goto-file-row <LYX_FILE_NAME> <ROW_NUMBER>
2528 * \li Origin: Edmar, 23 Dec 1998
2531 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly, System },
2533 * \var lyx::FuncCode lyx::LFUN_SERVER_NOTIFY
2534 * \li Action: Sends notify message about the last key-sequence to client.
2535 * \li Notion: This can be used to grab last key-sequence used inside the LyX window.
2536 See also Debug extensions section in Extended features manual.
2537 * \li Syntax: server-notify
2540 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
2542 * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
2543 * \li Action: Sets the cursor position based on the editing area coordinates
2544 (similar as clicking on that point with left mouse button).
2545 * \li Syntax: server-set-xy <X> <Y>
2548 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
2550 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
2551 * \li Action: Returns the coordinates of cursor position in the editing area.
2552 * \li Syntax: server-get-xy
2555 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
2558 * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
2559 * \li Action: Generates the code (literate programming).
2560 * \li Notion: Latex file with extension \literate_extension is generated.
2561 Then LyX invokes \build_command (with a default of``make'') to generate the code and
2562 \build_error_filter to process the compilation error messages. \n
2563 In case you want to process your literate file with a script, or some other program,
2564 just insert in your lyxrc file an entry with:\n
2565 \build_command "my_script my_arguments" \n
2566 The \build_error_filter differs from the \literate_error_filter only in that the
2567 former will identify error messages from your compiler.
2568 * \li Syntax: build-program
2571 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
2574 * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
2575 * \li Action: Saves the current buffer to a temporary file.
2576 * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
2577 is called automatically by LyX, to "autosave" the current buffer.
2578 * \li Syntax: buffer-auto-save
2581 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
2583 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHILD_OPEN
2584 * \li Action: Loads the given child document.
2585 * \li Notion: The current document is treated as a parent.
2586 * \li Syntax: buffer-child-open <FILE>
2587 * \li Params: <FILE>: Filename of the child. The directory of the parent is assumed by default.
2588 * \li Origin: Ale, 28 May 1997
2591 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
2593 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHKTEX
2594 * \li Action: Runs chktex for the current document.
2595 * \li Syntax: buffer-chktex
2596 * \li Origin: Asger, 30 Oct 1997
2599 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
2601 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
2602 * \li Action: Toggles compression of the current document on/off.
2603 * \li Syntax: buffer-toggle-compression
2604 * \li Origin: bpeng, 27 Apr 2006
2607 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
2609 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
2610 * \li Action: Closes the current buffer.
2611 * \li Notion: Closes the current buffer, asking whether to save it, etc,
2612 if the buffer has been modified.
2613 * \li Syntax: buffer-close
2616 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
2618 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
2619 * \li Action: Exports the current buffer (document) to the given format.
2620 * \li Syntax: buffer-export <FORMAT>
2621 * \li Params: <FORMAT> is either "custom" or one of the formats which you
2622 can find in Tools->Preferences->File formats->Format.
2623 Usual format you will enter is "pdf2" (pdflatex),
2624 "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
2625 In case of "custom" you will be asked for a format you
2626 want to start from and for the command that you want to
2627 apply to this format. Internally the control is then passed
2628 to #LFUN_BUFFER_EXPORT_CUSTOM.
2629 * \li Origin: Lgb, 29 Jul 1997
2632 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
2634 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
2635 * \li Action: Exports the current buffer (document) from the given format using
2636 the given command on it.
2637 * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
2638 * \li Params: <FORMAT> format to start from (LyX will care to produce such
2639 intermediate file).\n
2640 <COMMAND> this command will be launched on the file. Note that you can
2641 use "$$FName" string to qualify the intermediate file.
2642 * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
2643 * \li Origin: leeming, 27 Mar 2004
2646 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
2648 * \var lyx::FuncCode lyx::LFUN_BUFFER_PRINT
2649 * \li Action: Prints the current document.
2650 * \li Notion: Many settings can be given via the preferences dialog.
2651 * \li Syntax: buffer-print <TARGET> <TARGET-NAME> <COMMAND>
2652 * \li Params: <TARGET> is either "printer" or "file".\n
2653 <TARGER-NAME> is either "default" or file name or printer name.\n
2654 <COMMAND> command ensuring the printing job.
2655 * \li Sample: buffer-print file "/trash/newfile1.ps" "dvips"
2656 * \li Origin: leeming, 28 Mar 2004
2659 { LFUN_BUFFER_PRINT, "buffer-print", ReadOnly, Buffer },
2661 * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
2662 * \li Action: Import a given file as a lyx document.
2663 * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
2664 defined convertors in preferences. Look into File->Import menu to get
2665 an idea of the currently active import formats.
2666 * \li Syntax: buffer-import <FORMAT> [<FILE>]
2667 * \li Origin: Asger, 24 Jul 1998
2670 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
2672 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
2673 * \li Action: Creates a new buffer (that is, document).
2674 * \li Notion: Implicit path can be set in Preferences dialog.
2675 * \li Syntax: buffer-new [<FILE>]
2676 * \li Params: <FILE>: filename of created file with absolute path.
2679 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
2681 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
2682 * \li Action: Creates a new buffer (that is, document) from a template.
2683 * \li Notion: Path for new files and templates can be set in Preferences dialog.
2684 Template will be asked for via Open-dialog.
2685 * \li Syntax: buffer-new-template [<FILE>]
2686 * \li Params: <FILE>: filename of created file with absolute path.
2689 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
2691 * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
2692 * \li Action: Reverts opened document.
2693 * \li Syntax: buffer-reload
2694 * \li Origin: Asger, 2 Feb 1997
2697 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
2699 * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
2700 * \li Action: Switch to the given buffer.
2701 * \li Notion: This is useful also in case you need simultaneously more views of the edited
2702 document in different LyX windows.
2703 * \li Syntax: buffer-new-template <BUFFER>
2704 * \li Params: <BUFFER>: already opened document which is to be shown.
2707 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
2709 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
2710 * \li Action: Toggle editing mode of the current document between read/write and read-only.
2711 * \li Notion: In the ->Readonly mode checks-in/commits the data if the file is under version control.
2712 In the Readonly-> mode checkouts the data from repository. \n
2713 If these operations fail, buffer won't be toggled.
2714 * \li Syntax: buffer-toggle-read-only
2715 * \li Origin: Lgb, 27 May 1997
2718 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
2720 * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
2721 * \li Action: Displays current buffer in chosen format.
2722 * \li Notion: Displays the contents of the current buffer in the chosen
2723 format, for example, PDF or DVI. This runs the necessary
2724 converter, calls the defined viewer, and so forth.
2725 * \li Syntax: buffer-view <FORMAT>
2726 * \li Params: <FORMAT>: The format to display, where this is one of the
2727 formats defined (in the current GUI) in the
2728 Tools>Preferences>File Formats dialog.
2731 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
2733 * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
2734 * \li Action: Exports the current document and put the result into the
2735 temporary directory.
2736 * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
2737 the output will be rewriten - updated. This is useful in case your viewer
2738 is able to detect such changes (e.g. ghostview for postscript).
2739 * \li Syntax: buffer-update <FORMAT>
2740 * \li Params: <FORMAT>: The format to display, where this is one of the
2741 formats defined (in the current GUI) in the
2742 Tools>Preferences>File Formats dialog.
2743 * \li Origin: Dekel, 5 Aug 2000
2746 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
2749 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
2750 * \li Action: Saves the current buffer.
2751 * \li Notion: Saves the current buffer to disk, using the filename that
2752 is already associated with the buffer, asking for one if
2753 none is yet assigned.
2754 * \li Syntax: buffer-write
2757 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
2759 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
2760 * \li Action: Rename and save current buffer.
2761 * \li Syntax: buffer-write-as <FILENAME>
2762 * \li Params: <FILENAME>: New name of the buffer/file. A relative path
2763 is with respect to the original location of the buffer/file.
2766 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
2768 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
2769 * \li Action: Save all changed documents.
2770 * \li Syntax: buffer-write-all
2771 * \li Origin: rgh, gpothier 6 Aug 2007
2774 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
2776 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEXT
2777 * \li Action: Switch to the next opened document.
2778 * \li Notion: Note that this does not necessarily mean next in tabbar
2779 (for full list see View menu).
2780 * \li Syntax: buffer-next
2783 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
2785 * \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS
2786 * \li Action: Switch to the previous opened document.
2787 * \li Syntax: buffer-previous
2790 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
2792 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
2793 * \li Action: When run from a child document, this updates (exports) document built
2794 from the master buffer. If a master is not found, it updates the
2796 * \li Syntax: master-buffer-update
2797 * \li Origin: Tommaso, 20 Sep 2007
2800 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
2802 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
2803 * \li Action: When run from a child document, this command shows a preview built
2804 from the master buffer. If a master is not found, it previews the
2806 * \li Syntax: master-buffer-view
2807 * \li Origin: Tommaso, 20 Sep 2007
2810 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
2812 * \var lyx::FuncCode lyx::LFUN_BUFFER_LANGUAGE
2813 * \li Action: Set language of the current document.
2814 * \li Syntax: buffer-language <LANG>
2815 * \li Params: <LANG>: language name. See lib/languages for list.
2816 * \li Origin: leeming, 30 Mar 2004
2819 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
2821 * \var lyx::FuncCode lyx::LFUN_BUFFER_SAVE_AS_DEFAULT
2822 * \li Action: Save the current document settings as default.
2823 * \li Notion: The file will will be saved into ~/.lyx/templates/defaults.lyx .
2824 * \li Syntax: buffer-save-as-default [<ARGS>]
2825 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
2826 you can find in document header of usual .lyx file.
2827 * \li Origin: leeming, 30 Mar 2004
2830 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
2832 * \var lyx::FuncCode lyx::LFUN_BUFFER_PARAMS_APPLY
2833 * \li Action: Apply the given settings to the current document.
2834 * \li Syntax: buffer-params-apply [<ARGS>]
2835 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
2836 you can find in document header of usual .lyx file.
2837 * \li Origin: leeming, 30 Mar 2004
2840 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", Noop, Buffer },
2843 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
2844 * \li Action: Inserts another LyX file.
2845 * \li Syntax: file-insert [<FILE>]
2846 * \li Params: <FILE>: Filename to be inserted.
2849 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
2851 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
2852 * \li Action: Inserts plain text file.
2853 * \li Syntax: file-insert-plaintext [<FILE>]
2854 * \li Params: <FILE>: Filename to be inserted.
2855 * \li Origin: CFO-G, 19 Nov 1997
2858 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
2860 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
2861 * \li Action: Inserts plain text file as paragraph (i.e. join lines).
2862 * \li Syntax: file-insert-plaintext-para [<FILE>]
2863 * \li Params: <FILE>: Filename to be inserted.
2864 * \li Origin: Levon, 14 Feb 2001
2867 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
2869 * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
2870 * \li Action: Open LyX document.
2871 * \li Syntax: file-open [<FILE>]
2872 * \li Params: <FILE>: Filename to be opened.
2875 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
2878 * \var lyx::FuncCode lyx::LFUN_CALL
2879 * \li Action: Executes a command defined in a .def file.
2880 * \li Notion: The definitions are by default read from lib/commands/default.def.\n
2881 A .def file allows to define a command with \\define "<NAME>" "<LFUN>"
2882 where <NAME> is the name of the new command and <LFUN> is the lfun code
2883 to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
2884 \\def_file "FileName" allows to include another .def file. \n
2885 This is particularly useful in connection with toolbar buttons:
2886 Since the name of the button image for this lfun is
2887 lib/images/commands/<NAME>.png this is the way to assign an image
2888 to a complex command-sequence.
2889 * \li Syntax: call <NAME>
2890 * \li Params: <NAME>: Name of the command that must be called.
2891 * \li Origin: broider, 2 Oct 2007
2894 { LFUN_CALL, "call", NoBuffer, System },
2896 * \var lyx::FuncCode lyx::LFUN_META_PREFIX
2897 * \li Action: Simulate halting Meta key (Alt key on PCs).
2898 * \li Notion: Used for buffer editation not for GUI control.
2899 * \li Syntax: meta-prefix
2902 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
2904 * \var lyx::FuncCode lyx::LFUN_CANCEL
2905 * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
2906 * \li Syntax: cancel
2909 { LFUN_CANCEL, "cancel", NoBuffer, System },
2912 * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
2913 * \li Action: Opens the minibuffer toolbar so that the user can type in there.
2914 * \li Notion: Usually bound to M-x shortcut.
2915 * \li Syntax: command-execute
2918 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
2920 * \var lyx::FuncCode lyx::LFUN_COMMAND_PREFIX
2921 * \li Action: Return the current key sequence and available options as a string.
2922 * \li Notion: No options are added if no current map exists. \n
2923 This is probably usable only with connection to lyxserver.
2924 * \li Syntax: command-prefix
2927 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
2929 * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
2930 * \li Action: Run more commands (LFUN and its parameters) in a sequence.
2931 * \li Syntax: command-sequence <CMDS>
2932 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
2933 * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
2934 * \li Origin: Andre, 11 Nov 1999
2937 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
2939 * \var lyx::FuncCode lyx::LFUN_COMMAND_ALTERNATIVES
2940 * \li Action: Runs the first listed command that is enabled.
2941 * \li Notion: This can be used to bind multiple functions to a single key,
2942 and then which one is used will depend upon the context.
2943 * \li Syntax: command-alternatives <CMDS>
2944 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
2945 * \li Sample: command-alternatives completion-accept;cell-forward
2946 * \li Origin: rgh, 24 September 2008
2949 { LFUN_COMMAND_ALTERNATIVES, "command-alternatives", NoBuffer, System },
2951 * \var lyx::FuncCode lyx::LFUN_MESSAGE
2952 * \li Action: Shows message in statusbar (for script purposes).
2953 * \li Syntax: message <STRING>
2954 * \li Origin: Lgb, 8 Apr 2001
2957 { LFUN_MESSAGE, "message", NoBuffer, System },
2959 * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
2960 * \li Action: Save user preferences.
2961 * \li Syntax: preferences-save
2962 * \li Origin: Lgb, 27 Nov 1999
2965 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
2967 * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
2968 * \li Action: Reconfigure the automatic settings.
2969 * \li Syntax: reconfigure
2970 * \li Origin: Asger, 14 Feb 1997
2973 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
2975 * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
2976 * \li Action: Apply the given settings to user preferences.
2977 * \li Syntax: lyxrc-apply <SETTINGS>
2978 * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
2979 to get an idea which commands to use and their syntax.
2980 #lyx::LyXRC::LyXRCTags has the list of possible commands.
2983 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
2985 * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
2986 * \li Action: Determine whether keep cursor inside the editing window regardless
2987 the scrollbar movement.
2988 * \li Syntax: toggle-cursor-follows-scrollbar
2989 * \li Origin: ARRae, 2 Dec 1997
2992 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
2994 * \var lyx::FuncCode lyx::LFUN_SET_COLOR
2995 * \li Action: Set the given LyX color to the color defined by the X11 name given.
2996 * \li Notion: A new color entry is created if the color is unknown.
2997 Color names can be stored as a part of user settings.
2998 * \li Syntax: set-color <LYX_NAME> <X11_NAME>
2999 * \li Origin: SLior, 11 Jun 2000
3002 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
3004 * \var lyx::FuncCode lyx::LFUN_STATISTICS
3005 * \li Action: Count the statistics (number of words and characters)
3006 in the document or in the given selection.
3007 * \li Notion: Note that this function gives the number of words/chars written,
3008 not the number of characters which will be typeset.
3009 * \li Syntax: statistics
3010 * \li Origin: lasgouttes, Jan 27 2004; sanda, Jan 8 2008
3013 { LFUN_STATISTICS, "statistics", ReadOnly, System },
3015 * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
3016 * \li Action: Show the inline completion at the cursor position.
3017 * \li Syntax: completion-inline
3018 * \li Origin: sts, Feb 19 2008
3021 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
3023 * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
3024 * \li Action: Show the completion popup at the cursor position.
3025 * \li Syntax: completion-popup
3026 * \li Origin: sts, Feb 19 2008
3029 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
3031 * \var lyx::FuncCode lyx::LFUN_COMPLETION_COMPLETE
3032 * \li Action: Try to complete the word or command at the cursor position.
3033 * \li Syntax: complete
3034 * \li Origin: sts, Feb 19 2008
3037 { LFUN_COMPLETION_COMPLETE, "complete", SingleParUpdate, Edit },
3040 * \var lyx::FuncCode lyx::LFUN_COMPLETION_CANCEL
3041 * \li Action: Try to cancel completion, either the popup or the inline completion
3042 * \li Syntax: completion-cancel
3043 * \li Origin: sts, Sep 07 2008
3046 { LFUN_COMPLETION_CANCEL, "completion-cancel", SingleParUpdate, Edit },
3048 * \var lyx::FuncCode lyx::LFUN_COMPLETION_ACCEPT
3049 * \li Action: Accept suggested completion.
3050 * \li Syntax: completion-accept
3051 * \li Origin: sanda, Sep 08 2008
3054 { LFUN_COMPLETION_ACCEPT, "completion-accept", SingleParUpdate, Edit },
3058 * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
3059 * \li Action: Activate the branch
3060 * \li Syntax: branch-activate <BRANCH>
3061 * \li Params: <BRANCH>: The branch to activate
3062 * \li Sample: lyx -e pdf2 -x "branch-activate answers" finalexam.lyx \n
3063 could be used to export a pdf with the answers branch included
3064 without one's having to open LyX and activate the branch manually.
3065 * \li Origin: rgh, 27 May 2008
3068 { LFUN_BRANCH_ACTIVATE, "branch-activate", Argument, Buffer },
3070 * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
3071 * \li Action: De-activate the branch
3072 * \li Syntax: branch-deactivate <BRANCH>
3073 * \li Params: <BRANCH>: The branch to deactivate
3074 * \li Origin: rgh, 27 May 2008
3077 { LFUN_BRANCH_DEACTIVATE, "branch-deactivate", Argument, Buffer },
3079 { LFUN_NOACTION, "", Noop, Hidden }
3080 #ifndef DOXYGEN_SHOULD_SKIP_THIS
3083 for (int i = 0; items[i].action != LFUN_NOACTION; ++i) {
3084 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
3091 LyXAction::LyXAction()
3097 // Returns an action tag from a string.
3098 FuncRequest LyXAction::lookupFunc(string const & func) const
3100 string const func2 = trim(func);
3102 if (func2.empty()) {
3103 return FuncRequest(LFUN_NOACTION);
3107 string const arg = split(func2, cmd, ' ');
3109 func_map::const_iterator fit = lyx_func_map.find(cmd);
3111 return fit != lyx_func_map.end() ? FuncRequest(fit->second, arg) : FuncRequest(LFUN_UNKNOWN_ACTION);
3115 string const LyXAction::getActionName(FuncCode action) const
3117 info_map::const_iterator const it = lyx_info_map.find(action);
3118 return it != lyx_info_map.end() ? it->second.name : string();
3122 LyXAction::func_type const LyXAction::getActionType(FuncCode action) const
3124 info_map::const_iterator const it = lyx_info_map.find(action);
3125 return it != lyx_info_map.end() ? it->second.type : Hidden;
3129 bool LyXAction::funcHasFlag(FuncCode action,
3130 LyXAction::func_attrib flag) const
3132 info_map::const_iterator ici = lyx_info_map.find(action);
3134 if (ici == lyx_info_map.end()) {
3135 LYXERR0("action: " << action << " is not known.");
3136 LASSERT(false, /**/);
3139 return ici->second.attrib & flag;
3143 LyXAction::const_func_iterator LyXAction::func_begin() const
3145 return lyx_func_map.begin();
3149 LyXAction::const_func_iterator LyXAction::func_end() const
3151 return lyx_func_map.end();
3155 LyXErr & operator<<(LyXErr & l, FuncCode code)
3158 l.stream() << lyxaction.getActionName(code);