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 Syntax: tab-insert
372 * \li Origin: vfvanravesteijn, Sep 30 2008
375 { LFUN_TAB_INSERT, "tab-insert", SingleParUpdate, Edit },
377 * \var lyx::FuncCode lyx::LFUN_TAB_DELETE
378 * \li Action: Delete a tab or upto an equivalent amount of spaces from
380 * \li Syntax: tab-delete
381 * \li Origin: vfvanravesteijn, Sep 30 2008
384 { LFUN_TAB_DELETE, "tab-delete", SingleParUpdate, Edit },
386 * \var lyx::FuncCode lyx::LFUN_QUOTE_INSERT
387 * \li Action: Inserts quotes according to the type and quote-language preference.
388 * \li Action: Currently English, Swedish, German, Polish, French, Danish quotes
390 * \li Syntax: quote-insert [<TYPE>]
391 * \li Params: <TYPE>: 'single' for single quotes, otherwise double quotes will be used.
394 { LFUN_QUOTE_INSERT, "quote-insert", Noop, Edit },
396 * \var lyx::FuncCode lyx::LFUN_INFO_INSERT
397 * \li Action: Displays shortcuts, lyxrc, package and textclass availability and menu
398 information in a non-editable boxed InsetText.
399 * \li Notion: Apart from lfun arguments you can use the following method: \n
400 1. input the type and argument of this inset, e.g. "menu paste", in
402 2. select the text and run info-insert lfun.
403 * \li Syntax: info-insert <TYPE> <ARG>
404 * \li Params: <TYPE>: shortcut|lyxrc|package|textclass|menu|buffer \n
405 <ARG>: argument for a given type. Look into InsetInfo.h for detailed
407 * \li Origin: bpeng, 7 Oct 2007
410 { LFUN_INFO_INSERT, "info-insert", Noop, Edit },
412 * \var lyx::FuncCode lyx::LFUN_BRANCH_INSERT
413 * \li Action: Inserts branch inset.
414 * \li Syntax: branch-insert <BRANCH-NAME>
415 * \li Origin: vermeer, 17 Aug 2003
418 { LFUN_BRANCH_INSERT, "branch-insert", Noop, Edit },
420 * \var lyx::FuncCode lyx::LFUN_BOX_INSERT
421 * \li Action: Inserts Box inset.
422 * \li Syntax: box-insert [<TYPE>]
423 * \li Params: <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox \n
424 Framed is the default one.
425 * \li Origin: vermeer, 7 Oct 2003
428 { LFUN_BOX_INSERT, "box-insert", Noop, Edit },
430 * \var lyx::FuncCode lyx::LFUN_FLEX_INSERT
431 * \li Action: Inserts CharStyle, Custom inset or XML short element.
432 * \li Notion: Look into the Customization manual for more information about
434 To make this command enabled the layout file for the document
435 class you're using has to load the character styles. There are
436 a few contained in the Logical Markup module. You can also of
437 course create some yourself. \n
438 For dissolving the element see #LFUN_INSET_DISSOLVE.
439 * \li Syntax: flex-insert <TYPE:Name>
440 * \li Params: TYPE: CharStyle|Custom|Element|Standard \n
441 Identifies whether this is a Character Style, a
442 Custom Inset or an XML Element, and which dynamical
443 sub-menu this flex inset is in on the LyX menu tree.
444 If Standard (currently unused): none of these.
445 Name: This name must be defined either in your layout file
446 or imported by some module. The definition is \n
447 InsetLayout <TYPE:Name>
448 * \li Sample: flex-insert CharStyle:Code
451 { LFUN_FLEX_INSERT, "flex-insert", Noop, Edit },
453 * \var lyx::FuncCode lyx::LFUN_SELF_INSERT
454 * \li Action: Inserts the given string (accordingly to the correct keymap).
455 * \li Notion: Automatically replace the currently selected text. Depends on lyxrc
456 settings "auto_region_delete".
457 * \li Syntax: self-insert <STRING>
460 { LFUN_SELF_INSERT, "self-insert", SingleParUpdate, Hidden },
462 * \var lyx::FuncCode lyx::LFUN_SPACE_INSERT
463 * \li Action: Inserts one of horizontal space insets.
464 * \li Syntax: space-insert <NAME> [<LEN>]
465 * \li Params: <NAME>: normal, protected, thin, quad, qquad, enspace, enskip,
466 negthinspace, hfill, hfill*, dotfill, hrulefill, hspace,
468 <LEN>: length for custom spaces (hspace, hspace* for protected)
469 * \li Origin: JSpitzm, 20 May 2003, Mar 17 2008
472 { LFUN_SPACE_INSERT, "space-insert", Noop, Edit },
474 * \var lyx::FuncCode lyx::LFUN_HYPERLINK_INSERT
475 * \li Action: Inserts hyperlinks into the document (clickable in pdf output).
476 * \li Notion: Hyperlink target can be set via selection + hyperlink-insert function.
477 * \li Syntax: href-insert [<TARGET>]
478 * \li Origin: CFO-G, 21 Nov 1997
481 { LFUN_HYPERLINK_INSERT, "href-insert", Noop, Edit },
483 * \var lyx::FuncCode lyx::LFUN_SPECIALCHAR_INSERT
484 * \li Action: Inserts various characters into the document.
485 * \li Syntax: specialchar-insert <CHAR>
486 * \li Params: <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots,
487 end-of-sentence, menu-separator.
488 * \li Origin: JSpitzm, 6 Dec 2007
491 { LFUN_SPECIALCHAR_INSERT, "specialchar-insert", Noop, Edit },
493 * \var lyx::FuncCode lyx::LFUN_TOC_INSERT
494 * \li Action: Inserts table of contents.
495 * \li Syntax: toc-insert
496 * \li Origin: Lgb, 27 May 97
499 { LFUN_TOC_INSERT, "toc-insert", Noop, Edit },
501 * \var lyx::FuncCode lyx::LFUN_APPENDIX
502 * \li Action: Start (or remove) Appendix on the given cursor position.
503 * \li Syntax: appendix
504 * \li Origin: ettrich, 5 May 1998
507 { LFUN_APPENDIX, "appendix", Noop, Edit },
510 * \var lyx::FuncCode lyx::LFUN_INDEX_INSERT
511 * \li Action: Inserts Index entry.
512 * \li Notion: It automatically takes the word on the cursor position.
513 * \li Syntax: index-insert
514 * \li Origin: leeming, 3 Aug 2000
517 { LFUN_INDEX_INSERT, "index-insert", Noop, Edit },
519 * \var lyx::FuncCode lyx::LFUN_INDEX_PRINT
520 * \li Action: Inserts list of Index entries on a new page.
521 * \li Syntax: index-print
522 * \li Origin: Lgb, 27 Feb 1997
525 { LFUN_INDEX_PRINT, "index-print", Noop, Edit },
528 * \var lyx::FuncCode lyx::LFUN_NOMENCL_INSERT
529 * \li Action: Inserts Nomenclature entry.
530 * \li Notion: It automatically takes the word on the cursor position if no symbol is given.
531 * \li Syntax: nomencl-insert [<SYMBOL>]
532 * \li Origin: Ugras, 4 Nov 2006
535 { LFUN_NOMENCL_INSERT, "nomencl-insert", Noop, Edit },
537 * \var lyx::FuncCode lyx::LFUN_NOMENCLATURE_PRINT
538 * \li Action: Inserts list of Nomenclature entries.
539 * \li Syntax: nomenclature-print
540 * \li Origin: Ugras, 4 Nov 2006
543 { LFUN_NOMENCL_PRINT, "nomencl-print", Noop, Edit },
546 * \var lyx::FuncCode lyx::LFUN_NOTE_INSERT
547 * \li Action: Inserts Note on the current cursor postion,
548 move selection inside the inset.
549 * \li Syntax: note-insert [<TYPE>]
550 * \li Params: <TYPE>: <Note|Greyedout|Comment> default: Note
553 { LFUN_NOTE_INSERT, "note-insert", Noop, Edit },
555 * \var lyx::FuncCode lyx::LFUN_NOTE_NEXT
556 * \li Action: Moves the cursor to the begining of next Note inset.
557 * \li Syntax: note-next
560 { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
562 * \var lyx::FuncCode lyx::LFUN_NOTES_MUTATE
563 * \li Action: Changes all Note insets of a particular type (source)
564 to a different type (target) fot the current document.
565 * \li Syntax: notes-mutate <SOURCE> <TARGET>
566 * \li Params: <SOURCE/TARGET>: Note|Comment|Greyedout
567 * \li Origin: sanda, 18 Jun 2008
570 { LFUN_NOTES_MUTATE, "notes-mutate", Argument, Edit },
572 * \var lyx::FuncCode lyx::LFUN_NEWLINE_INSERT
573 * \li Action: Inserts a line break or new line.
574 * \li Syntax: newline-insert [<ARG>]
575 * \li Params: <ARG>: <newline|linebreak> default: newline
576 * \li Origin: JSpitzm, 25 Mar 2008
579 { LFUN_NEWLINE_INSERT, "newline-insert", Noop, Edit },
582 * \var lyx::FuncCode lyx::LFUN_ESCAPE
583 * \li Action: Clears the selection. If no text is selected call #LFUN_FINISHED_FORWARD.
585 * \li Origin: Lgb, 17 May 2001
588 { LFUN_ESCAPE, "escape", ReadOnly, Edit },
590 * \var lyx::FuncCode lyx::LFUN_DOWN
591 * \li Action: Moves the cursor one line in downward direction.
595 { LFUN_DOWN, "down", ReadOnly | NoUpdate, Edit },
597 * \var lyx::FuncCode lyx::LFUN_UP
598 * \li Action: Moves the cursor one line in upward direction.
602 { LFUN_UP, "up", ReadOnly | NoUpdate, Edit },
604 * \var lyx::FuncCode lyx::LFUN_DOWN_SELECT
605 * \li Action: Moves the cursor one line in downward direction adding the current
606 position to the selection.
607 * \li Syntax: down-select
610 { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, Edit },
612 * \var lyx::FuncCode lyx::LFUN_UP_SELECT
613 * \li Action: Moves the cursor one line in upward direction adding the current
614 position to the selection.
615 * \li Syntax: up-select
618 { LFUN_UP_SELECT, "up-select", ReadOnly | SingleParUpdate, Edit },
620 * \var lyx::FuncCode lyx::SCREEN_DOWN
621 * \li Action: Moves the cursor one page in downward direction.
622 * \li Syntax: screen-down
625 { LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit },
627 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP
628 * \li Action: Moves the cursor one page in upward direction.
629 * \li Syntax: screen-up
632 { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit },
634 * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN_SELECT
635 * \li Action: Moves the cursor one screen in downward direction adding the current
636 position to the selection.
637 * \li Syntax: screen-down-select
640 { LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit },
642 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP_SELECT
643 * \li Action: Moves the cursor one page in upward direction adding the current
644 position to the selection.
645 * \li Syntax: screen-up-select
648 { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit },
650 * \var lyx::FuncCode lyx::LFUN_SCROLL
651 * \li Action: Scroll the buffer view.
652 * \li Notion: Only scrolls the screen up or down; does not move the cursor.
653 * \li Syntax: scroll <TYPE> <QUANTITY>
654 * \li Params: <TYPE>: line|page\n
655 <QUANTITY>: up|down|<number>
656 * \li Origin: Abdel, Dec 27 2007
659 { LFUN_SCROLL, "scroll", ReadOnly, Edit },
661 * \var lyx::FuncCode lyx::LFUN_SCREEN_RECENTER
662 * \li Action: Recenters the screen on the current cursor position.
663 * \li Syntax: screen-recenter
666 { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit },
669 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD
670 * \li Action: Moves the cursor one position logically backwards.
671 * \li Notion: This is not the action which should be bound to the arrow keys,
672 because backwards may be left or right, depending on the
673 language. The arrow keys should be bound to #LFUN_CHAR_LEFT or
674 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
675 * \li Syntax: char-backward
678 { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit },
680 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD_SELECT
681 * \li Action: Moves the cursor one position logically backwards, adding
682 traversed position to the selection.
683 * \li Notion: See also #LFUN_CHAR_BACKWARD.
684 * \li Syntax: char-backward-select
687 { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit },
689 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_BACKWARD
690 * \li Action: Deletes one character in the backward direction (usually the "BackSpace" key).
691 * \li Syntax: char-delete-backward
694 { LFUN_CHAR_DELETE_BACKWARD, "char-delete-backward", SingleParUpdate, Edit },
696 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_FORWARD
697 * \li Action: Deletes one character in the backward direction (usually the "Delete" key).
698 * \li Syntax: char-delete-forward
701 { LFUN_CHAR_DELETE_FORWARD, "char-delete-forward", SingleParUpdate, Edit },
703 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD
704 * \li Action: Moves the cursor one position logically forward.
705 * \li Notion: This is not the action which should be bound to the arrow keys,
706 because forward may be left or right, depending on the language.
707 The arrow keys should be bound to #LFUN_CHAR_LEFT or
708 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
709 * \li Syntax: char-forward
712 { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit },
714 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD_SELECT
715 * \li Action: Moves the cursor one position logically forward, adding
716 traversed position to the selection.
717 * \li Notion: See also #LFUN_CHAR_FORWARD.
718 * \li Syntax: char-forward-select
721 { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit },
723 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT
724 * \li Action: Moves the cursor one position "to the left".
725 * \li Notion: This is the action which should be taken when the "left" key
726 is pressed. Generally, it moves the cursor one position to the
727 left. However, in Bidi text this become slightly more
728 complicated, and there are different modes of cursor movement.
729 In "visual mode", this moves left, plain and simple. In "logical
730 mode", movement is logically forward in RTL paragraphs, and
731 logically backwards in LTR paragraphs.
732 * \li Syntax: char-left
735 { LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit },
737 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT_SELECT
738 * \li Action: Moves the cursor one position "to the left", adding
739 traversed position to the selection.
740 * \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement.
741 * \li Syntax: char-left-select
744 { LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit },
746 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT
747 * \li Action: Moves the cursor one position "to the right".
748 * \li Notion: This is the action which should be taken when the "right" key
749 is pressed. Generally, it moves the cursor one position to the
750 right. However, in Bidi text this become slightly more
751 complicated, and there are different modes of cursor movement.
752 In "visual mode", this moves right, plain and simple. In "logical
753 mode", movement is logically forward in LTR paragraphs, and
754 logically backwards in RTL paragraphs.
755 * \li Syntax: char-right
758 { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit },
760 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT_SELECT
761 * \li Action: Moves the cursor one position "to the right", adding
762 traversed position to the selection.
763 * \li Notion: See also #LFUN_CHAR_RIGHT for exact details of the movement.
764 * \li Syntax: char-right-select
767 { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit },
770 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD
771 * \li Action: Moves the cursor to the logically previous beginning of a word.
772 * \li Notion: This is not the action which should be bound to the arrow keys,
773 because backwards may be left or right, depending on the
774 language. The arrow keys should be bound to #LFUN_WORD_LEFT or
775 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
776 * \li Syntax: word-backward
779 { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit },
781 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD_SELECT
782 * \li Action: Moves the cursor to the logically previous beginning of a word,
783 adding the logically traversed text to the selection.
784 * \li Notion: See also #LFUN_WORD_BACKWARD.
785 * \li Syntax: word-backward-select
788 { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
790 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_BACKWARD
791 * \li Action: Deletes characters to the begining of the word (usually the "C+BackSpace" key).
792 * \li Syntax: word-delete-backward
795 { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
797 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_FORWARD
798 * \li Action: Deletes characters to the end of the word (usually the "C+Delete" key).
799 * \li Syntax: word-delete-forward
802 { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
804 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_FORWARD
805 * \li Action: Search for a given string in forward direction.
806 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
807 * \li Syntax: word-find-forward [<STRING>]
808 * \li Origin: Etienne, 16 Feb 1998
811 { LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit },
813 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_BACKWARD
814 * \li Action: Search for a given string in backward direction.
815 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
816 * \li Syntax: word-find-backward [<STRING>]
817 * \li Origin: Etienne, 20 Feb 1998
820 { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
822 * \var lyx::FuncCode lyx::LFUN_WORD_FIND
823 * \li Action: Search for next occurence of a string.
824 * \li Syntax: word-find [<DATA>]
825 * \li Params: <DATA>: data encoded from Find dialog (see #lyx::find2string()).
826 If no parameter is given, search with last find-dialog
827 data is used for search (i.e. find-next).
828 * \li Origin: Andre, Jan 7 2004
831 { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
833 * \var lyx::FuncCode lyx::LFUN_WORD_REPLACE
834 * \li Action: Replace a string in the document.
835 * \li Syntax: word-replace [<DATA>]
836 * \li Params: <DATA>: data is of the form
839 <casesensitive> <matchword> <all> <forward>"
840 * \li Origin: Andre, Jan 7 2004
843 { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
845 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD
846 * \li Action: Moves the cursor to the logically next beginning of a word.
847 * \li Notion: This is not the action which should be bound to the arrow keys,
848 because forward may be left or right, depending on the language.
849 The arrow keys should be bound to #LFUN_WORD_LEFT or
850 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
851 * \li Syntax: word-forward
854 { LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
856 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD_SELECT
857 * \li Action: Moves the cursor to the logically next beginning of a word,
858 adding the logically traversed text to the selection.
859 * \li Notion: See also #LFUN_WORD_FORWARD.
860 * \li Syntax: word-forward-select
863 { LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
865 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT
866 * \li Action: Moves the cursor to the next beginning of a word "on the left".
867 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
868 "left" key is pressed. Generally, it moves the cursor to the
869 next beginning of a word on the left. However, in Bidi text this
870 become slightly more complicated, and there are different modes
871 of cursor movement. In "visual mode", this moves left, plain and
872 simple. In "logical mode", movement is logically forward in RTL
873 paragraphs, and logically backwards in LTR paragraphs.
874 * \li Syntax: word-left
875 * \li Origin: dov, 28 Oct 2007
878 { LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
880 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT_SELECT
881 * \li Action: Moves the cursor to the next beginning of a word "on the left",
882 adding *logically* traversed text to the selection.
883 * \li Notion: See also #LFUN_WORD_LEFT for exact details of the movement.
884 * \li Syntax: word-left-select
885 * \li Origin: dov, 28 Oct 2007
888 { LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit },
890 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT
891 * \li Action: Moves the cursor to the next beginning of a word "on the right".
892 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
893 "right" key is pressed. Generally, it moves the cursor to the
894 next beginning of a word on the right. However, in Bidi text
895 this become slightly more complicated, and there are different
896 modes of cursor movement. In "visual mode", this moves right,
897 plain and simple. In "logical mode", movement is logically
898 forward in LTR paragraphs, and logically backwards in RTL
900 * \li Syntax: word-right
901 * \li Origin: dov, 28 Oct 2007
904 { LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit },
906 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT_SELECT
907 * \li Action: Moves the cursor to the next beginning of a word "on the right",
908 adding *logically* traversed text to the selection.
909 * \li Notion: See also #LFUN_WORD_RIGHT for exact details of the movement.
910 * \li Syntax: word-right-select
911 * \li Origin: dov, 28 Oct 2007
914 { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
916 * \var lyx::FuncCode lyx::LFUN_WORD_SELECT
917 * \li Action: Puts the word where the cursor stands into the selection.
918 * \li Syntax: word-select
919 * \li Origin: Andre, 11 Sep 2002
922 { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
924 * \var lyx::FuncCode lyx::LFUN_WORD_CAPITALIZE
925 * \li Action: Capitalizes the words in the selection (i.e. the first letters)
926 or the letter on the cursor position.
927 * \li Syntax: word-capitalize
930 { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
932 * \var lyx::FuncCode lyx::LFUN_WORD_UPCASE
933 * \li Action: Change the words in the selection or from the cursor position
934 to the end of word to the upper case.
935 * \li Syntax: word-upcase
938 { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
940 * \var lyx::FuncCode lyx::LFUN_WORD_LOWCASE
941 * \li Action: Change the words in the selection or from the cursor position
942 to the end of word to the lower case.
943 * \li Syntax: word-lowcase
946 { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
948 * \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
949 * \li Action: Look up thesaurus entries with respect to the word under the cursor.
950 * \li Syntax: thesaurus-entry
951 * \li Origin: Levon, 20 Jul 2001
954 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
956 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN
957 * \li Action: Move the cursor to the beginning of the document.
958 * \li Syntax: buffer-begin
961 { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
963 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN_SELECT
964 * \li Action: Move the cursor to the beginning of the document adding the
965 traversed text to the selection.
966 * \li Syntax: buffer-begin-select
969 { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
971 * \var lyx::FuncCode lyx::LFUN_BUFFER_END
972 * \li Action: Move the cursor to the end of the document.
973 * \li Syntax: buffer-end
976 { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
978 * \var lyx::FuncCode lyx::LFUN_BUFFER_END_SELECT
979 * \li Action: Move the cursor to the end of the document adding the
980 traversed text to the selection.
981 * \li Syntax: buffer-end-select
984 { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
987 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN
988 * \li Action: Move the cursor to the begining of the (screen) line.
989 * \li Syntax: line-begin
992 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
994 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN_SELECT
995 * \li Action: Move the cursor to the beginning of the (screen) line adding the
996 traversed text to the selection.
997 * \li Syntax: line-begin-select
1000 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
1002 * \var lyx::FuncCode lyx::LFUN_LINE_END
1003 * \li Action: Move the cursor to the end of the (screen) line.
1004 * \li Syntax: line-end
1007 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
1009 * \var lyx::FuncCode lyx::LFUN_LINE_END_SELECT
1010 * \li Action: Move the cursor to the end of the (screen) line adding the
1011 traversed text to the selection.
1012 * \li Syntax: line-end-select
1015 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
1017 * \var lyx::FuncCode lyx::LFUN_LINE_DELETE
1018 * \li Action: Deletes the letters to the end of the (screen) line or
1019 deletes the selection.
1020 * \li Syntax: line-delete-forward
1023 { LFUN_LINE_DELETE, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
1025 * \var lyx::FuncCode lyx::LFUN_COPY
1026 * \li Action: Copies to the clipboard the last edit.
1030 { LFUN_COPY, "copy", ReadOnly, Edit },
1032 * \var lyx::FuncCode lyx::LFUN_CUT
1033 * \li Action: Cuts to the clipboard.
1037 { LFUN_CUT, "cut", Noop, Edit },
1039 * \var lyx::FuncCode lyx::LFUN_PASTE
1040 * \li Action: Pastes material from the active clipboard.
1041 * \li Syntax: paste [<TYPE>]
1042 * \li Params: <TYPE>: pdf|png|jpeg|linkback
1045 { LFUN_PASTE, "paste", Noop, Edit },
1047 * \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE
1048 * \li Action: Pastes text from the active clipboard.
1049 * \li Syntax: clipboard-paste [<ARG>]
1050 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1051 * \li Origin: baum, 10 Jul 2006
1054 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
1056 * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
1057 * \li Action: Pastes the currently text selected text.
1058 * \li Notion: Primary selection mechanism is linux-only thing.
1059 * \li Syntax: primary-selection-paste [<ARG>]
1060 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1063 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
1065 * \var lyx::FuncCode lyx::LFUN_UNDO
1066 * \li Action: Undoes the last edit.
1070 { LFUN_UNDO, "undo", Noop, Edit },
1072 * \var lyx::FuncCode lyx::LFUN_REDO
1073 * \li Action: Redoes the last thing undone.
1077 { LFUN_REDO, "redo", Noop, Edit },
1079 * \var lyx::FuncCode lyx::LFUN_REPEAT
1080 * \li Action: Repeat the given command.
1081 * \li Syntax: repeat <COUNT> <LFUN-COMMAND>
1082 * \li Origin: Andre, , 27 Oct 2003
1085 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
1087 * \var lyx::FuncCode lyx::LFUN_CHARS_TRANSPOSE
1088 * \li Action: Transposes the character at the cursor with the one before it.
1089 * \li Syntax: chars-transpose
1090 * \li Origin: Lgb, 25 Apr 2001
1093 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
1096 * \var lyx::FuncCode lyx::LFUN_DEPTH_DECREMENT
1097 * \li Action: Decrease the nesting depth of the (selected) paragraph(s)
1099 * \li Syntax: depth-decrement
1102 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
1104 * \var lyx::FuncCode lyx::LFUN_DEPTH_INCREMENT
1105 * \li Action: Increase the nesting depth of the (selected) paragraph(s)
1107 * \li Syntax: depth-increment
1110 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
1113 * \var lyx::FuncCode lyx::LFUN_FONT_BOLD
1114 * \li Action: Toggles the bold font (selection-wise) using mathbf in math.
1115 * \li Syntax: font-bold
1118 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
1121 * \var lyx::FuncCode lyx::LFUN_FONT_BOLDSYMBOL
1122 * \li Action: Toggles the bold font (selection-wise) using boldsymbol in math.
1123 * \li Syntax: font-boldsymbol
1126 { LFUN_FONT_BOLDSYMBOL, "font-boldsymbol", Noop, Layout },
1128 * \var lyx::FuncCode lyx::LFUN_FONT_TYPEWRITER
1129 * \li Action: Toggles the typewriter family font (selection-wise).
1130 * \li Syntax: font-typewriter
1133 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
1135 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERLINE
1136 * \li Action: Toggles underline in the font (selection-wise).
1137 * \li Syntax: font-underline
1140 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
1142 * \var lyx::FuncCode lyx::LFUN_FONT_EMPH
1143 * \li Action: Toggles the emphasis font style (selection-wise).
1144 * \li Syntax: font-emph
1147 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
1149 * \var lyx::FuncCode lyx::LFUN_FONT_NOUN
1150 * \li Action: Toggles Noun text style font (selection-wise).
1151 * \li Syntax: font-noun
1154 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
1156 * \var lyx::FuncCode lyx::LFUN_FONT_ROMAN
1157 * \li Action: Toggles Roman family font (selection-wise).
1158 * \li Syntax: font-roman
1161 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
1163 * \var lyx::FuncCode lyx::LFUN_FONT_SANS
1164 * \li Action: Toggles Sans Serif family font (selection-wise).
1165 * \li Syntax: font-sans
1168 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
1170 * \var lyx::FuncCode lyx::LFUN_FONT_FRAK
1171 * \li Action: Toggles Fraktur family font (math-mode, selection-wise).
1172 * \li Syntax: font-frak
1173 * \li Origin: vermeer, 10 Jan 2002
1176 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
1178 * \var lyx::FuncCode lyx::LFUN_FONT_ITAL
1179 * \li Action: Toggles Italics font shape (math-mode, selection-wise).
1180 * \li Syntax: font-ital
1181 * \li Origin: vermeer, 10 Jan 2002
1184 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
1186 * \var lyx::FuncCode lyx::LFUN_FONT_DEFAULT
1187 * \li Action: Reverts the settings of the font to the default values (selection-wise).
1188 * \li Syntax: font-default
1191 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
1193 * \var lyx::FuncCode lyx::LFUN_FONT_SIZE
1194 * \li Action: Sets font size according to lyx format string.
1195 * \li Syntax: font-size <SIZE>
1196 * \li Params: <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|\n
1197 largest|huge|giant|increase|decrease|default
1200 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
1202 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_APPLY
1203 * \li Action: Toggle user-defined (=last-time used) text style.
1204 * \li Notion: This style is set via #LFUN_TEXTSTYLE_UPDATE, which is
1205 automatically trigerred when using Text Style dialog.
1206 * \li Syntax: textstyle-apply
1207 * \li Origin: leeming, 12 Mar 2003
1210 { LFUN_TEXTSTYLE_APPLY, "textstyle-apply", Noop, Layout },
1212 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_UPDATE
1213 * \li Action: Apply text style and update the settings to be used by #LFUN_TEXTSTYLE_APPLY.
1214 * \li Syntax: textstyle-update <FONT_INFO>
1215 * \li Params: <FONT_INFO>: specifies font atributes, e.g. family, series, shape,
1216 size, emph, noun, underbar, number, color, language,
1218 Use lyx -dbg action for exact syntax of text-style
1220 * \li Origin: leeming, 12 Mar 2003
1223 { LFUN_TEXTSTYLE_UPDATE, "textstyle-update", Noop, Layout },
1225 * \var lyx::FuncCode lyx::LFUN_SCREEN_FONT_UPDATE
1226 * \li Action: Update fonts and its metrics.
1227 * \li Notion: Automatically called after zoom, dpi, font names, or norm change.
1228 * \li Syntax: screen-font-update
1229 * \li Origin: ARRae, 13 Aug 2000
1232 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
1234 * \var lyx::FuncCode lyx::LFUN_FONT_STATE
1235 * \li Action: Returns the info about the current font.
1236 * \li Syntax: font-state
1239 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
1242 * \var lyx::FuncCode lyx::LFUN_CITATION_INSERT
1243 * \li Action: Inserts citation from loaded citation database.
1244 * \li Syntax: citation-insert [<KEY>[|<TEXT_BEFORE>]]
1245 * \li Params: <KEY>: Citation (shortcut listed in available citations). \n
1246 <TEXT_BEFORE>: text which should appear before citation.
1247 * \li Origin: AAS, 97-02-23
1250 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
1252 * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_ADD
1253 * \li Action: Adds database, which will be used for bibtex citations.
1254 * \li Notion: Databases are added to the first BibTeX inset
1255 (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
1256 * \li Syntax: bibtex-database-add <DATABASE-NAME>
1257 * \li Origin: Ale, 30 May 1997
1260 { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit },
1262 * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_DEL
1263 * \li Action: Adds database, which will be used for bibtex citations.
1264 * \li Notion: Databases are deleted from the first BibTeX inset
1265 (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
1266 * \li Syntax: bibtex-database-del <DATABASE-NAME>
1267 * \li Origin: Ale, 30 May 1997
1270 { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
1273 * \var lyx::FuncCode lyx::LFUN_LAYOUT
1274 * \li Action: Sets the layout (that is, environment) for the current paragraph.
1275 * \li Syntax: layout <LAYOUT>
1276 * \li Params: <LAYOUT>: the layout to use
1279 { LFUN_LAYOUT, "layout", Noop, Layout },
1281 * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH
1282 * \li Action: Launches the paragraph settings dialog.
1283 * \li Syntax: layout-paragraph
1286 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
1288 * \var lyx::FuncCode lyx::LFUN_LAYOUT_TABULAR
1289 * \li Action: Launches the tabular settings dialog.
1290 * \li Syntax: layout-tabular
1291 * \li Origin: Jug, 31 Jul 2000
1294 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
1296 * \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE
1297 * \li Action: Displays list of layout choices.
1298 * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
1299 dropbox allowing for choice of layout.
1300 * \li Syntax: drop-layouts-choice
1303 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
1305 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
1306 * \li Action: Clears the module list.
1307 * \li Notion: Clears the list of included modules for the current buffer.
1308 * \li Syntax: layout-modules-clear
1309 * \li Origin: rgh, 25 August 2007
1312 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", Noop, Layout },
1314 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULE_ADD
1315 * \li Action: Adds a module.
1316 * \li Notion: Adds a module to the list of included modules for the current buffer.
1317 * \li Syntax: layout-module-add <MODULE>
1318 * \li Params: <MODULE>: the module to be added
1319 * \li Origin: rgh, 25 August 2007
1322 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", Noop, Layout },
1324 * \var lyx::FuncCode lyx::LFUN_LAYOUT_RELOAD
1325 * \li Action: Reloads layout information.
1326 * \li Notion: Reloads all layout information for the current buffer from disk, thus
1327 recognizing any changes that have been made to layout files on the fly.
1328 This is intended to be used only by layout developers and should not be
1329 used when one is trying to do actual work.
1330 * \li Syntax: layout-reload
1331 * \li Origin: rgh, 3 September 2007
1334 { LFUN_LAYOUT_RELOAD, "layout-reload", Noop, Layout },
1336 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
1337 * \li Action: Sets the text class for the current buffer.
1338 * \li Syntax: textclass-apply <TEXTCLASS>
1339 * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
1340 the filename, minus the ".layout" extension.
1343 { LFUN_TEXTCLASS_APPLY, "textclass-apply", Noop, Layout },
1345 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
1346 * \li Action: Loads information for a textclass from disk.
1347 * \li Syntax: textclass-load <TEXTCLASS>
1348 * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
1349 the filename, minus the ".layout" extension.
1352 { LFUN_TEXTCLASS_LOAD, "textclass-load", Noop, Layout },
1355 * \var lyx::FuncCode lyx::LFUN_MARK_OFF
1356 * \li Action: Disable selecting of text-region.
1357 * \li Syntax: mark-off
1360 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
1362 * \var lyx::FuncCode lyx::LFUN_MARK_ON
1363 * \li Action: Enable selecting of text-region.
1364 * \li Notion: After enabling you can simply move arrow keys to get selected region.
1365 * \li Syntax: mark-on
1368 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
1370 * \var lyx::FuncCode lyx::LFUN_MARK_TOGGLE
1371 * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
1372 * \li Syntax: mark-toggle
1373 * \li Origin: Andre, May 5 2006
1376 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
1379 * \var lyx::FuncCode lyx::LFUN_MATH_DELIM
1380 * \li Action: Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
1381 * \li Syntax: math-delim [<LEFT>] [<RIGHT>]
1382 * \li Params: <LEFT/RIGHT>: Delimiters to be used. Each delimiter can be specified by
1383 either a LaTeX name or a valid character.
1384 ( is the default letter.
1385 * \li Sample: math-delim { rangle
1386 * \li Origin: Alejandro, 18 Jun 1996
1389 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
1391 * \var lyx::FuncCode lyx::LFUN_MATH_BIGDELIM
1392 * \li Action: Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
1393 * \li Syntax: math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
1394 * \li Params: <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r \n
1395 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
1396 * \li Sample: math-bigdelim "Bigl" "\Downarrow" "Bigr" "\}"
1397 * \li Origin: Enrico & Georg, 7 May 2006
1400 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
1402 * \var lyx::FuncCode lyx::LFUN_MATH_DISPLAY
1403 * \li Action: Creates a new displayed equation in text mode.
1404 Toggles inlined/display formula in math mode.
1405 * \li Syntax: math-display [<ARG>]
1406 * \li Params: <ARG>: this argument will be passed to #LFUN_MATH_INSERT when creating
1407 new equation from the text mode.
1408 * \li Origin: Alejandro, 18 Jun 1996
1411 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
1413 * \var lyx::FuncCode lyx::LFUN_MATH_INSERT
1414 * \li Action: Inserts math objects and symbols.
1415 * \li Syntax: math-insert <ARG>
1416 * \li Params: <ARG>: Symbol or LaTeX code to be inserted.
1419 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
1421 * \var lyx::FuncCode lyx::LFUN_MATH_SUBSCRIPT
1422 * \li Action: Enters subscript expression in math expression.
1423 * \li Syntax: math-subscript
1424 * \li Origin: vermeer, 12 Dec 2001
1427 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
1429 * \var lyx::FuncCode lyx::LFUN_MATH_SUPERSCRIPT
1430 * \li Action: Enters subscript expression in math expression.
1431 * \li Syntax: math-superscript
1432 * \li Origin: vermeer, 12 Dec 2001
1435 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
1437 * \var lyx::FuncCode lyx::LFUN_MATH_LIMITS
1438 * \li Action: Toggles the position of the limits from above/below to the right
1439 side an vice versa in integral symbol, a limit, a summation, etc.
1440 * \li Notion: Put the cursor before the symbol with the limits and then invoke
1442 * \li Syntax: math-limits [<STATE>]
1443 * \li Params: <STATE>: limits|nolimits
1446 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
1448 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO
1449 * \li Action: Inserts a math macro definition at the cursor position in the text.
1450 * \li Syntax: math-macro <NAME> [<NARGS>] [def]
1451 * \li Params: <NAME>: The name of the macro, e.g. "mymacro".
1452 <NARGS>: The number of parameters of the macro. Default is 0.
1453 "def": Has no effect anymore, just for compatibility with former LyX versions.
1454 * \li Origin: ale, 10 May 1997; sts, 21 Dec 2007
1457 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
1459 * \var lyx::FuncCode lyx::LFUN_MATH_MUTATE
1460 * \li Action: Mutates the type of math inset to the newly selected one.
1461 * \li Syntax: math-mutate <TYPE>
1462 * \li Params: <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
1463 multline|gather|flalign
1464 * \li Origin: Andre, 23 May 2001
1467 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
1469 * \var lyx::FuncCode lyx::LFUN_MATH_SPACE
1470 * \li Action: Inserts space into math expression.
1471 * \li Notion: Use spacebar after entering this space to change type of space.
1472 * \li Syntax: math-space [<TYPE>]
1473 * \li Params: <TYPE>: negative spaces: !|negmedspace|negthickspace \n
1474 positive spaces: ,|:|;|quad|qquad \n
1475 "," used by default.
1476 * \li Origin: Andre, 25 Jul 2001; sanda, 16 Jun 2008
1479 { LFUN_MATH_SPACE, "math-space", Noop, Math },
1481 * \var lyx::FuncCode lyx::LFUN_MATH_MATRIX
1482 * \li Action: Inserts a matrix.
1483 * \li Syntax: math-matrix <COLS> <ROWS> [<ALIGN>]
1484 * \li Params: <ALIGN>: Alignment is a word composed of the vertical alignment
1485 (b, c or t) (i.e. 1 char) and the horizontal alignments
1486 (l, c or r) (i.e. <COL> chars).
1487 * \li Sample: math-matrix 3 3 bccc
1490 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
1492 * \var lyx::FuncCode lyx::LFUN_MATH_MODE
1493 * \li Action: In text mode enters math mode (i.e. puts math insets on the current
1494 cursor position), in math mode enters text mode inside math expression.
1495 * \li Notion: If there is some selected text, it puts the text inside created math box.
1496 * \li Syntax: math-mode [<ARG>]
1497 * \li Params: <ARG>: eventual argument (LaTeX code) is passed to #LFUN_MATH_INSERT .
1498 * \li Origin: Alejandro, 4 Jun 1996
1501 { LFUN_MATH_MODE, "math-mode", Noop, Math },
1503 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
1504 * \li Action: Toggles numbering of the current formula line.
1505 * \li Notion: Must be in display formula mode.
1506 * \li Syntax: math-number-line-toggle
1507 * \li Origin: Alejandro, 18 Jun 1996
1510 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
1512 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
1513 * \li Action: Toggles numbering/labeling of the current formula.
1514 * \li Notion: Must be in display formula mode.
1515 * \li Syntax: math-number-toggle
1516 * \li Origin: Alejandro, 4 Jun 1996
1519 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
1521 * \var lyx::FuncCode lyx::LFUN_MATH_EXTERN
1522 * \li Action: Calls external program and passes the current expression/equation
1523 as an argument for the calculation in the format appropriate to the
1525 * \li Notion: Selection can be used to determine the input for the external program.
1526 * \li Syntax: math-extern <LANG> [<COMMAND>]
1527 * \li Params: <LANG>: octave|maxima|maple|mathematica|script \n
1528 where "script" stands fot the external script (normalized
1529 expression will be passed)
1530 * \li Origin: Andre, 24 Apr 2001
1531 * \li Sample: math-extern maple simplify
1534 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
1536 * \var lyx::FuncCode lyx::LFUN_MATH_SIZE
1537 * \li Action: Changes arbitrarily the size used by math fonts inside a context.
1538 * \li Notion: Provides an interface to the LaTeX math mode font size commands.
1539 * \li Syntax: math-size <STYLE>
1540 * \li Params: <STYLE>: \displaystyle|\textstyle|\scriptstyle|\scriptscriptstyle
1541 * \li Origin: Alejandro, 15 Aug 1996; ps, 14 Jun 2008
1544 { LFUN_MATH_SIZE, "math-size", Noop, Math },
1546 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
1547 * \li Action: Unfold a Math Macro.
1548 * \li Notion: Unfold the Math Macro the cursor is in, i.e.
1550 * \li Syntax: math-macro-unfold
1551 * \li Origin: sts, 06 January 2008
1554 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
1556 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
1557 * \li Action: Fold a Math Macro.
1558 * \li Notion: Fold the Math Macro the cursor is in if it was
1559 unfolded, i.e. displayed as \foo before.
1560 * \li Syntax: math-macro-fold
1561 * \li Origin: sts, 06 January 2008
1564 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
1566 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
1567 * \li Action: Add a parameter.
1568 * \li Notion: Add a parameter to a Math Macro.
1569 * \li Params: <NUM>: The number of the parameter behind which the new one
1570 will be added (1 for the first, i.e. use 0 for add a
1571 parameter at the left), defaults to the last one.
1572 * \li Syntax: math-macro-add-param <NUM>
1573 * \li Origin: sts, 06 January 2008
1576 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
1578 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
1579 * \li Action: Remove the last parameter.
1580 * \li Notion: Remove the last parameter of a Math Macro and
1581 remove its value in all instances of the macro
1583 * \li Params: <NUM>: The number of the parameter to be deleted (1 for
1584 the first), defaults to the last one.
1585 * \li Syntax: math-macro-remove-param <NUM>
1586 * \li Origin: sts, 06 January 2008
1589 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
1591 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
1592 * \li Action: Append a greedy parameter.
1593 * \li Notion: Append a greedy parameter to a Math Macro which
1594 eats the following mathed cell in every instance of
1595 the macro in the buffer.
1596 * \li Syntax: math-macro-append-greedy-param
1597 * \li Origin: sts, 06 January 2008
1600 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
1602 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
1603 * \li Action: Remove a greedy parameter.
1604 * \li Notion: Remove a greedy parameter of a Math Macro and spit
1605 out the values of it in every instance of the macro
1606 in the buffer. If it is an optional parameter the [valud]
1608 * \li Syntax: math-macro-remove-greedy-param
1609 * \li Origin: sts, 06 January 2008
1612 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
1614 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
1615 * \li Action: Make a parameter optional.
1616 * \li Notion: Turn the first non-optional parameter of a Math Macro
1617 into an optional parameter with a default value.
1618 * \li Syntax: math-macro-make-optional
1619 * \li Origin: sts, 06 January 2008
1622 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
1624 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
1625 * \li Action: Make a parameter non-optional.
1626 * \li Notion: Turn the last optional parameter of a Math Macro
1627 into a non-optional parameter. The default value is
1628 remembered to be reused later if the user changes his mind.
1629 * \li Syntax: math-macro-make-nonoptional
1630 * \li Origin: sts, 06 January 2008
1633 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
1635 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
1636 * \li Action: Add an optional parameter.
1637 * \li Notion: Insert an optional parameter just behind the
1638 already existing optional parameters.
1639 * \li Syntax: math-macro-add-optional-param
1640 * \li Origin: sts, 06 January 2008
1643 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
1645 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
1646 * \li Action: Remove the last optional parameter.
1647 * \li Notion: Remove the last optional parameter of a Math Macro and
1648 remove it in all the instances of the macro in the buffer.
1649 * \li Syntax: math-macro-remove-optional-param
1650 * \li Origin: sts, 06 January 2008
1653 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
1655 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
1656 * \li Action: Add a greedy optional parameter.
1657 * \li Notion: Add a greedy optional parameter which eats the value
1658 from the following cells in mathed which are in the [value]
1660 * \li Syntax: math-macro-add-greedy-optional-param
1661 * \li Origin: sts, 06 January 2008
1664 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
1666 * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
1667 * \li Action: Only active in Math Macro definition.
1668 * \li Notion: Dummy function which is only active in a Math Macro definition.
1669 It's used to toggle the Math Macro toolbar if the cursor moves
1670 into a Math Macro definition.
1671 * \li Syntax: in-mathmacrotemplate
1672 * \li Origin: sts, 06 January 2008
1675 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
1678 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
1679 * \li Action: Moves the current paragraph downwards in the document.
1680 * \li Syntax: paragraph-move-down
1681 * \li Origin: Edwin, 8 Apr 2006
1684 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
1686 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
1687 * \li Action: Moves the current paragraph upwards in the document.
1688 * \li Syntax: paragraph-move-up
1689 * \li Origin: Edwin, 8 Apr 2006
1692 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
1695 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP
1696 * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1697 in upward direction.
1698 * \li Syntax: paragraph-up
1699 * \li Origin: Asger, 1 Oct 1996
1702 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
1704 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP_SELECT
1705 * \li Action: Move the cursor and select the text to the next paragraph (or
1706 begining of the current one) in upward direction.
1707 * \li Syntax: paragraph-up-select
1708 * \li Origin: Asger, 1 Oct 1996
1711 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
1713 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN
1714 * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1715 in downward direction.
1716 * \li Syntax: paragraph-down
1717 * \li Origin: Asger, 1 Oct 1996
1720 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
1722 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN_SELECT
1723 * \li Action: Move the cursor and select the text to the next paragraph (or
1724 begining of the current one) in downward direction.
1725 * \li Syntax: paragraph-down-select
1726 * \li Origin: Asger, 1 Oct 1996
1729 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
1731 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
1732 * \li Action: Jump to a paragraph given by its id number and optionally the
1733 desired position within the paragraph.
1734 * \li Notion: Note that id number of paragraph is not the sequential number of paragraph
1735 seen on the screen. Moreover the id is unique for all opened buffers (documents).
1736 * \li Syntax: paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
1737 * \li Params: <PAR_ID_NUMBER>: paragraph id \n
1738 <POSITION_IN_PAR>: desired position within the paragraph
1739 * \li Origin: Dekel, 26 Aug 2000
1742 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly, Edit },
1744 * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1745 * \li Action: Breaks the current paragraph at the current location.
1746 * \li Syntax: break-paragraph
1749 { LFUN_PARAGRAPH_SPACING, "paragraph-spacing", Noop, Edit },
1751 * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1752 * \li Action: Breaks the current paragraph at the current location.
1753 * \li Notion: Removes the selection.
1754 * \li Syntax: break-paragraph [<LAYOUT>]
1755 * \li Params: <LAYOUT>: "inverse" - decreases depth by one (or change layout
1756 to default layout) when the cursor is at the end of
1760 { LFUN_BREAK_PARAGRAPH, "break-paragraph", Noop, Edit },
1762 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
1763 * \li Action: Change paragraph settings.
1764 * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
1765 This function only modifies, and does not override, existing settings.
1766 Note that the "leftindent" indent setting is deprecated.
1767 * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
1768 * \li Params: <INDENT>: \\noindent|\\indent|\\indent-toggle|\\leftindent LENGTH\n
1769 <SPACING>: \\paragraph_spacing default|single|onehalf|double|other\n
1770 <ALIGN>: \\align block|left|right|center|default\n
1771 <OTHERS>: \\labelwidthstring WIDTH|\\start_of_appendix\n
1772 * \li Origin: rgh, Aug 15 2007
1775 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
1777 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
1778 * \li Action: Change paragraph settings.
1779 * \li Notion: Overwrite all nonspecified settings to the default ones.
1780 Use paragraph-params lfun if you don't want to overwrite others settings.
1781 * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
1782 * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
1783 * \li Origin: leeming, 30 Mar 2004
1786 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
1788 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UPDATE
1789 * \li Action: Updates the values inside the paragraph dialog from the paragraph.
1790 * \li Notion: This is internal LFUN, not to be used by users. Called internally
1791 by #LFUN_DIALOG_UPDATE.
1792 * \li Origin: leeming, 13 Mar 2003
1795 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
1798 * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
1799 * \li Action: Move the current group in the upward direction in the
1800 structure of the document.
1801 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1802 the whole substructure of the group.
1803 * \li Syntax: outline-up
1804 * \li Origin: Vermeer, 23 Mar 2006
1807 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
1809 * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
1810 * \li Action: Move the current group in the downward direction in the
1811 structure of the document.
1812 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1813 the whole substructure of the group.
1814 * \li Syntax: outline-down
1815 * \li Origin: Vermeer, 23 Mar 2006
1818 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
1820 * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
1821 * \li Action: Moves the current group in the downward direction in the
1822 hierarchy of the document structure.
1823 * \li Notion: Part -> Chapter -> Section -> etc.
1824 * \li Syntax: outline-in
1825 * \li Origin: Vermeer, 23 Mar 2006
1828 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
1830 * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
1831 * \li Action: Moves the current group in the upward direction in the
1832 hierarchy of the document structure.
1833 * \li Notion: Part <- Chapter <- Section <- etc.
1834 * \li Syntax: outline-out
1835 * \li Origin: Vermeer, 23 Mar 2006
1838 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
1840 * \var lyx::FuncCode lyx::LFUN_INSET_EDIT
1841 * \li Action: Edit the inset at cursor with an external application,
1842 * if one is attributed.
1843 * \li Syntax: inset-edit [<INSET_PARAMS>]
1844 * \li Params: <INSET_PARAMS>: Parameters for the inset. \n
1845 Currently only the filename will be considered.
1846 * \li Origin: JSpitzm, 27 Apr 2006
1849 { LFUN_INSET_EDIT, "inset-edit", Noop, Edit },
1852 * \var lyx::FuncCode lyx::LFUN_TABULAR_INSERT
1853 * \li Action: Inserts table into the document.
1854 * \li Syntax: tabular-insert [<ROWS> <COLUMNS>]
1855 * \li Params: In case no arguments are given show insert dialog.
1856 * \li Origin: Jug, 12 Apr 2000
1859 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
1861 * \var lyx::FuncCode lyx::LFUN_TABULAR_FEATURE
1862 * \li Action: Sets various features to the table/cell on the current cursor position.
1863 * \li Notion: Various math-environment features are handled here as well, e.g.
1864 add-vline-left/right for Grid/Cases environment
1865 * \li Syntax: tabular-feature <FEATURE> [<ARG>]
1866 * \li Params: <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|copy-column|
1867 toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
1868 align-left|align-right|align-center|align-block|valign-top|valign-bottom|
1869 valign-middle|m-align-left|m-align-right|m-align-center|m-valign-top|
1870 m-valign-bottom|m-valign-middle|multicolumn|set-all-lines|unset-all-lines|
1871 set-longtabular|unset-longtabular|set-pwidth|set-mpwidth|
1872 set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|
1873 set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|
1874 unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|
1875 set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
1876 set-special-column|set-special-multi|set-booktabs|unset-booktabs|
1877 set-top-space|set-bottom-space|set-interline-space|set-border-lines \n
1878 <ARG>: additional argument for some commands, use debug mode to explore its values.
1879 * \li Origin: Jug, 28 Jul 2000
1882 { LFUN_TABULAR_FEATURE, "tabular-feature", Noop, Edit },
1884 * \var lyx::FuncCode lyx::LFUN_CELL_BACKWARD
1885 * \li Action: Moves the cursor to the previous cell inside the table.
1886 * \li Syntax: cell-backward
1887 * \li Origin: Jug, 22 May 2000
1890 { LFUN_CELL_BACKWARD, "cell-backward", Noop, Edit },
1892 * \var lyx::FuncCode lyx::LFUN_CELL_FORWARD
1893 * \li Action: Moves the cursor to the next cell inside the table.
1894 * \li Syntax: cell-forward
1897 { LFUN_CELL_FORWARD, "cell-forward", Noop, Edit },
1899 * \var lyx::FuncCode lyx::LFUN_CELL_SPLIT
1900 * \li Action: Splits cell and shifts right part to the next cell (inside the math grid).
1901 * \li Syntax: cell-split
1902 * \li Origin: Ale, 15 May 1997
1905 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
1908 * \var lyx::FuncCode lyx::LFUN_VC_REGISTER
1909 * \li Action: Register the document as an file inside version control system (RCS, CVS).
1910 * \li Notion: File is registered inside cvs, svn or rcs repository acording to the existence
1911 of cvs/svn/rcs entries in the document's directory. \n
1912 See LyX Extended Manual (Version Control Chapter) for additional information.
1913 * \li Syntax: vc-register
1914 * \li Origin: Lgb, 1 Jul 1997
1917 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
1919 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_IN
1920 * \li Action: Checks-in/commits the changes of the registered file to the repository.
1921 * \li Notion: In RCS case this also unlocks the file.
1922 * \li Syntax: vc-check-in
1923 * \li Origin: Lgb, 1 Jul 1997
1926 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
1928 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_OUT
1929 * \li Action: Checks-out the document for edit (and locks it for RCS).
1930 * \li Notion: This is implemented only for RCS and SVN, not CVS.
1931 * \li Syntax: vc-check-out
1932 * \li Origin: Lgb, 1 Jul 1997
1935 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
1937 * \var lyx::FuncCode lyx::LFUN_VC_REVERT
1938 * \li Action: Reverts the document to the last check-in/commit in VCS.
1939 * \li Syntax: vc-revert
1940 * \li Origin: Lgb, 1 Jul 1997
1943 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
1945 * \var lyx::FuncCode lyx::LFUN_VC_UNDO_LAST
1946 * \li Action: Undo last check-in.
1947 * \li Notion: This is currently implemented only for RCS.
1948 * \li Syntax: vc-check-out
1949 * \li Origin: Lgb, 1 Jul 1997
1952 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
1955 * \var lyx::FuncCode lyx::LFUN_CHANGES_TRACK
1956 * \li Action: Toggles change tracking to on/off.
1957 * \li Syntax: changes-track
1958 * \li Origin: levon, 1 Oct 2002
1961 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
1963 * \var lyx::FuncCode lyx::LFUN_CHANGES_OUTPUT
1964 * \li Action: Toggles showing of change tracking in typesetted output.
1965 * \li Syntax: changes-output
1966 * \li Origin: jspitzm, 21 Jan 2005
1969 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
1971 * \var lyx::FuncCode lyx::LFUN_CHANGE_NEXT
1972 * \li Action: Moves the cursor to the position of the next change
1973 of the change tracking records.
1974 * \li Syntax: change-next
1975 * \li Origin: schmitt, 4 Oct 2006
1978 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
1980 * \var lyx::FuncCode lyx::LFUN_CHANGES_MERGE
1981 * \li Action: Open change tracking dialog for merging and moves the cursor
1982 to the position of the next change.
1983 * \li Syntax: changes-merge
1984 * \li Origin: Levon, 16 Oct 2002
1987 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
1989 * \var lyx::FuncCode lyx::LFUN_CHANGE_ACCEPT
1990 * \li Action: Accepts tracked change inside the selection.
1991 * \li Syntax: change-accept
1992 * \li Origin: Levon, 16 Oct 2002
1995 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
1997 * \var lyx::FuncCode lyx::LFUN_CHANGE_REJECT
1998 * \li Action: Rejects tracked change inside the selection.
1999 * \li Syntax: change-accept
2000 * \li Origin: Levon, 16 Oct 2002
2003 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
2005 * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_ACCEPT
2006 * \li Action: Accepts all tracked changes in the document.
2007 * \li Syntax: all-changes-accept
2008 * \li Origin: Levon, 16 Oct 2002
2011 { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
2013 * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_REJECT
2014 * \li Action: Rejects all tracked changes in the document.
2015 * \li Notion: Reject does not work recursively; the user may have to repeat the operation.
2016 * \li Syntax: all-changes-reject
2017 * \li Origin: Levon, 16 Oct 2002
2020 { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
2023 * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
2024 * \li Action: Apply data for an inset.
2025 * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
2026 be applied. This is either changed to #LFUN_INSET_MODIFY or
2027 #LFUN_INSET_INSERT depending on the context where it is called.
2028 * \li Syntax: inset-apply <ARGS>
2029 * \li Params: See #LFUN_INSET_INSERT .
2032 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
2034 * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE
2035 * \li Action: Dissolve the current inset into text.
2036 * \li Syntax: inset-dissolve [<INSET>]
2037 * \li Params: <INSET>: this can be used to make sure the right kind of inset
2038 is dissolved. For example "dissolve" entry in the charstyles
2039 sub-menu should only dissolve the charstyle inset, even if the
2040 cursor is inside several nested insets of different type.\n
2041 For values see #lyx::InsetLayout::lyxtype_ .
2042 * \li Origin: JSpitz, 7 Aug 2006
2045 { LFUN_INSET_DISSOLVE, "inset-dissolve", Noop, Edit },
2047 * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
2048 * \li Action: Insert new inset (type given by the parameters).
2049 * \li Syntax: inset-insert <INSET> <ARGS>
2050 * \li Params: <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics|
2051 hyperlink|include|index|label|nomencl|vspace|ref|toc>\n
2052 <ARGS>: depends on the given inset. Use "lyx -dbg action" to
2054 * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
2055 where <label name> is the name of the referenced label and
2056 <Format> is one of the following: \n
2057 ref -- <reference> \n
2058 eqref -- (<reference>) \n
2059 pageref -- <page> \n
2060 vpageref -- on <page> \n
2061 vref -- <reference> on <page> \n
2062 prettyref -- Formatted reference
2065 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
2067 * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
2068 * \li Action: Modify existing inset.
2069 * \li Notion: Used for label, floats, listings, box, branch, external, wrap
2070 bibtex, ert, command, graphics, note, space, vspace, tabular,
2071 bibitem, inlude, ref insets.
2072 * \li Syntax: inset-modify <INSET> <ARGS>
2073 * \li Params: See #LFUN_INSET_INSERT for further details.
2076 { LFUN_INSET_MODIFY, "", Noop, Hidden },
2078 * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_MODIFY
2079 * \li Action: Modify the inset at cursor position, if there is one.
2080 * \li Notion: Used for label, floats, listings, box, branch, external, wrap
2081 bibtex, ert, command, graphics, note, space, vspace, tabular,
2082 bibitem, inlude, ref insets.
2083 * \li Syntax: next-inset-modify <INSET> <ARGS>
2084 * \li Syntax: next-inset-modify changetype <TYPE>
2085 * \li Params: See #LFUN_INSET_INSERT for further details.
2086 * \li Origin: JSpitzm, 23 Mar 2008
2089 { LFUN_NEXT_INSET_MODIFY, "next-inset-modify", ReadOnly, Edit },
2091 * \var lyx::FuncCode lyx::LFUN_INSET_DIALOG_UPDATE
2092 * \li Action: Updates the values inside the dialog from the inset.
2093 * \li Notion: This is internal LFUN, not to be used by users. Called internally
2094 by #LFUN_DIALOG_UPDATE
2095 * \li Params: <DIALOG-NAME>
2096 * \li Origin: leeming, 25 Feb 2003
2099 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
2101 * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
2102 * \li Action: Open the inset's properties dialog.
2103 * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
2104 * \li Syntax: inset-settings <INSET>
2105 * \li Params: <INSET>: <box|branch|ert|float|listings|note|tabular|wrap>
2108 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly, Edit },
2110 * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_TOGGLE
2111 * \li Action: Toggles the inset at cursor position. For collapsables, this means it will
2112 be (un-)collapsed, in case of other insets, the editing widget (dialog) will
2113 be entered. Also cf. #LFUN_INSET_SETTINGS.
2114 * \li Notion: Used for label, floats, listings, box, branch, external, wrap
2115 bibtex, ert, command, graphics, note, space, vspace, tabular,
2116 bibitem, inlude, ref insets.
2117 * \li Syntax: next-inset-toggle <ARG>
2118 * \li Params: <ARG>: these are passed as arguments to #LFUN_INSET_TOGGLE .
2119 * \li Origin: leeming, 30 Mar 2004
2122 { LFUN_NEXT_INSET_TOGGLE, "next-inset-toggle", ReadOnly, Edit },
2124 * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
2125 * \li Action: Toggles the collapsable inset we are currently in.
2126 * \li Syntax: inset-toggle [<ARG>]
2127 * \li Params: <ARG>: <open|close|toggle|assign>. \n
2128 open/close/toggle are for collapsable insets. close can be currently used
2129 by #LFUN_NEXT_INSET_TOGGLE. toggle is used when no argument is given.\n
2130 assign is for branch inset.
2131 * \li Origin: lasgouttes, 19 Jul 2001
2134 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly, Hidden },
2136 * \var lyx::FuncCode lyx::LFUN_ALL_INSETS_TOGGLE
2137 * \li Action: Toggles (open/closes) all collapsable insets (of a given type) in the document.
2138 * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
2139 * \li Syntax: all-insets-toggle <STATE> <INSET>
2140 * \li Params: <STATE>: <toggle|open|close> default: toggle \n
2141 <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all insets
2142 * \li Origin: leeming, 30 Mar 2004
2145 { LFUN_ALL_INSETS_TOGGLE, "all-insets-toggle", ReadOnly, Edit },
2147 * \var lyx::FuncCode lyx::LFUN_SET_GRAPHICS_GROUP
2148 * \li Action: Set the group for the graphics inset on the cursor position.
2149 * \li Syntax: set-graphics-group [<GROUP>]
2150 * \li Params: <GROUP>: Id for an existing group. In case the Id is an empty string,
2151 the graphics inset is removed from the current group.
2152 * \li Origin: sanda, 6 May 2008
2155 { LFUN_SET_GRAPHICS_GROUP, "set-graphics-group", Noop, Edit },
2158 * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
2159 * \li Action: Moves the cursor out of the current slice, going forward.
2160 * \li Notion: Cursor movement within an inset may be different than cursor
2161 movement in the surrounding text. This action should be called
2162 automatically by the cursor movement within the inset, when
2163 movement within the inset has ceased (reached the end of the
2164 last paragraph, for example), in order to move correctly
2165 back into the surrounding text.
2168 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
2170 * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
2171 * \li Action: Moves the cursor out of the current slice, going backwards.
2172 * \li Notion: See also #LFUN_FINISHED_FORWARD.
2175 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
2177 * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
2178 * \li Action: Moves the cursor out of the current slice, going right.
2179 * \li Notion: See also #LFUN_FINISHED_FORWARD
2182 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
2184 * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
2185 * \li Action: Moves the cursor out of the current slice, going left.
2186 * \li Notion: See also #LFUN_FINISHED_FORWARD.
2189 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
2192 * \var lyx::FuncCode lyx::LFUN_LANGUAGE
2193 * \li Action: Set language from the current cursor position.
2194 * \li Syntax: language <LANG>
2195 * \li Params: <LANG>: Requested language. Look in lib/languages for
2197 * \li Origin: Dekel, 2 Mar 2000
2200 { LFUN_LANGUAGE, "language", Noop, Edit },
2203 * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
2204 * \li Action: Goto a label.
2205 * \li Syntax: label-goto [<LABEL>]
2206 * \li Params: <LABEL>: Requested label. If no label is given and refernce
2207 is on cursor position, Bookmark 0 is saved and
2208 cursor moves to the position of referenced label.
2209 * \li Origin: Ale, 6 Aug 1997
2212 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
2214 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT
2215 * \li Action: Inserts label to text or displayed formula.
2216 * \li Syntax: label-insert [<LABEL>]
2217 * \li Params: <LABEL>: Requested label. If no label is given dialog requesting
2218 name will be opened.
2221 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
2223 * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
2224 * \li Action: Go to the next label or cross-reference.
2225 * \li Syntax: reference-next
2226 * \li Origin: Dekel, 14 Jan 2001
2229 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
2232 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
2233 * \li Action: Goto a bookmark.
2234 * \li Notion: Moves the cursor to the numbered bookmark, opening the file
2235 if necessary. Note that bookmarsk are saved per-session, not
2237 * \li Syntax: bookmark-goto <NUMBER>
2238 * \li Params: <NUMBER>: the number of the bookmark to restore.
2239 * \li Origin: Dekel, 27 January 2001
2242 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
2244 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
2245 * \li Action: Save a bookmark.
2246 * \li Notion: Saves a numbered bookmark to the sessions file. The number
2247 must be between 1 and 9, inclusive. Note that bookmarks are
2248 saved per-session, not per file.
2249 * \li Syntax: bookmark-save <NUMBER>
2250 * \li Params: <NUMBER>: the number of the bookmark to save.
2251 * \li Origin: Dekel, 27 January 2001
2254 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
2256 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
2257 * \li Action: Clears the list of saved bookmarks.
2258 * \li Syntax: bookmark-clear
2259 * \li Origin: bpeng, 31 October 2006
2262 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
2265 * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
2266 * \li Action: Open the given help file according to the language setting.
2267 * \li Syntax: help-open <FILE>[.lyx]
2268 * \li Params: <FILE>: any document from (/usr/share/)doc directory.
2269 * \li Origin: Jug, 27 Jun 1999
2272 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
2274 * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
2275 * \li Action: Terminates the current LyX instance.
2276 * \li Notion: Terminates the current LyX instance, asking whether to save
2277 modified documents, etc.
2278 * \li Syntax: lyx-quit
2281 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
2283 * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
2284 * \li Action: Toggles visibility of a given toolbar between on/off/auto.
2285 * \li Notion: Skiping "auto" when allowauto is false.
2286 * \li Syntax: toolbar-toggle <NAME> [allowauto]
2287 * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|
2288 minibuffer|review|view/update|math_panels|vcs
2289 * \li Origin: Edwin, 21 May 2007
2292 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
2294 * \var lyx::FuncCode lyx::LFUN_MENU_OPEN
2295 * \li Action: Opens the menu given by its name.
2296 * \li Syntax: menu-open <NAME>
2297 * \li Params: <NAME>: menu name. See various .inc files in lib/ui for candidates.
2300 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
2302 * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
2303 * \li Action: Various UI visibility-toggling actions.
2304 * \li Syntax: ui-toggle <statusbar|menubar|frame|fullscreen>
2305 * \li Params: statusbar : Toggle visibility of the statusbar.\n
2306 menubar : Toggle visibility of the menubar.\n
2307 scrollbar : Toggle visibility of the scrollbar.\n
2308 frame : Toggle visibility of the frames around editing window.\n
2309 fullscreen : Toggle fullscreen mode. This also covers calling the
2310 previous functions. However #LFUN_TOOLBAR_TOGGLE for the
2311 custom tweaks of the toolbars should be used.
2312 * \li Origin: sanda, 9 Feb 2007
2315 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
2318 * \var lyx::FuncCode lyx::WINDOW_NEW
2319 * \li Action: Creates new empty LyX window.
2320 * \li Notion: Already opened documents from the previous window can be found under View menu.
2321 * \li Syntax: window-new [<GEOMETRY>]
2322 * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently
2323 accepted only on Windows platform.
2324 * \li Origin: Abdel, 21 Oct 2006
2327 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
2329 * \var lyx::FuncCode lyx::LFUN_WINDOW_CLOSE
2330 * \li Action: Closes the current LyX window.
2331 * \li Syntax: window-close
2332 * \li Origin: Abdel, 23 Oct 2006
2335 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
2338 * \var lyx::FuncCode lyx::LFUN_SPLIT_VIEW
2339 * \li Action: Creates another split view of current buffer.
2340 * \li Notion: All split views act in the same way indpendently.
2341 * \li Syntax: split-view <vertical|horizontal>
2342 * \li Params: horizontal : The work areas are laid out side by side.\n
2343 vertical : The work areas laid out vertically.
2344 * \li Origin: Abdel, 20 Feb 2008
2347 { LFUN_SPLIT_VIEW, "split-view", ReadOnly, Buffer },
2350 * \var lyx::FuncCode lyx::LFUN_CLOSE_TAB_GROUP
2351 * \li Action: Close the current tab group.
2352 * \li Notion: This only closes the work areas, not the buffer themselves.
2353 The still opened buffers can be visualized in another tab group.
2354 * \li Syntax: close-tab-group
2355 * \li Origin: Abdel, 21 Feb 2008
2358 { LFUN_CLOSE_TAB_GROUP, "close-tab-group", ReadOnly, Buffer },
2360 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW
2361 * \li Action: Shows hidden dialog or create new one for a given function/inset settings etc.
2362 * \li Syntax: dialog-show <NAME> [<DATA>]
2363 * \li Params: <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|\n
2364 document|errorlist|ert|external|file|findreplace|float|graphics|\n
2365 include|index|info|nomenclature|label|log|mathdelimiter|mathmatrix|\n
2366 note|paragraph|prefs|print|ref|sendto|space|spellchecker|symbols|\n
2367 tabular|tabularcreate|thesaurus|texinfo|toc|href|view-source|vspace\n
2368 wrap|listings|<SPECIAL> \n
2369 <SPECIAL>: latexlog|vclog \n
2370 <DATA>: data, usually settings for the given dialog. Use debug mode for the
2372 * \li Origin: leeming, 17 Jun 2003
2375 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
2377 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW_NEW_INSET
2378 * \li Action: Shows hidden dialog or create new one for a given inset settings etc.
2379 * \li Notion: Internally uses #LFUN_DIALOG_SHOW with processed data for a given inset.
2380 * \li Syntax: dialog-show-new-inset <NAME> [<DATA>]
2381 * \li Params: See #LFUN_DIALOG_SHOW .
2382 * \li Origin: leeming, 25 Feb 2003
2385 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
2387 * \var lyx::FuncCode lyx::LFUN_DIALOG_UPDATE
2388 * \li Action: Updates the dialog values from the inset/paragraph/document.
2389 * \li Syntax: dialog-update <NAME>
2390 * \li Params: <NAME>: paragraph|prefs|<INSET> \n
2392 * \li Origin: leeming, 25 Feb 2003
2395 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
2397 * \var lyx::FuncCode lyx::LFUN_DIALOG_HIDE
2398 * \li Action: Hides showed dialog. Counterpart to #LFUN_DIALOG_SHOW .
2399 * \li Syntax: dialog-hide <NAME>
2400 * \li Params: See #LFUN_DIALOG_SHOW .
2401 * \li Origin: leeming, 25 Feb 2003
2404 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
2406 * \var lyx::FuncCode lyx::LFUN_DIALOG_TOGGLE
2407 * \li Action: Toggles dialog between showed/hidden state.
2408 * \li Notion: Internally uses #LFUN_DIALOG_SHOW , #LFUN_DIALOG_HIDE .
2409 * \li Syntax: dialog-toggle <NAME> [<DATA>]
2410 * \li Params: See #LFUN_DIALOG_SHOW .
2411 * \li Origin: JSpitzm, 30 Apr 2007
2414 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
2416 * \var lyx::FuncCode lyx::LFUN_DIALOG_DISCONNECT_INSET
2417 * \li Action: Closes opened connection to opened inset.
2418 * \li Notion: Connection is used for apply functions.
2419 * \li Syntax: dialog-disconnect-inset <INSET-NAME>
2420 * \li Origin: leeming, 25 Feb 2003
2423 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
2426 * \var lyx::FuncCode lyx::LFUN_MOUSE_PRESS
2427 * \li Action: This function is called when mouse button is pressed (inside workarea).
2428 Action depends on the context.
2429 * \li Notion: This is internal LFUN, not to be used by users.
2430 * \li Origin: Andre, 9 Aug 2002
2433 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
2435 * \var lyx::FuncCode lyx::LFUN_MOUSE_DOUBLE
2436 * \li Action: This function is called when double click on mouse button is
2437 pressed (inside workarea). Action depends on the context.
2438 * \li Notion: This is internal LFUN, not to be used by users.
2439 * \li Origin: Andre, 9 Aug 2002
2442 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
2444 * \var lyx::FuncCode lyx::LFUN_MOUSE_TRIPLE
2445 * \li Action: This function is called when triple click on mouse button is
2446 pressed (inside workarea). Action depends on the context.
2447 * \li Notion: This is internal LFUN, not to be used by users.
2448 * \li Origin: Andre, 9 Aug 2002
2451 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
2453 * \var lyx::FuncCode lyx::LFUN_MOUSE_MOTION
2454 * \li Action: This function is called when mouse cursor is moving over the text.
2455 Action depends on the context.
2456 * \li Notion: This is internal LFUN, not to be used by users.
2457 * \li Origin: Andre, 9 Aug 2002
2460 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
2462 * \var lyx::FuncCode lyx::LFUN_MOUSE_RELEASE
2463 * \li Action: This function is called when mouse button is released (inside workarea).
2464 Action depends on the context.
2465 * \li Notion: This is internal LFUN, not to be used by users.
2466 * \li Origin: Andre, 9 Aug 2002
2469 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
2472 * \var lyx::FuncCode lyx::LFUN_KEYMAP_OFF
2473 * \li Action: Turn off the loaded keyboard map.
2474 * \li Syntax: keymap-off
2477 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
2479 * \var lyx::FuncCode lyx::LFUN_KEYMAP_PRIMARY
2480 * \li Action: Turn on the primary keyboard map.
2481 * \li Notion: Maps were widely used in past, when X-windows didn't have nowadays
2482 keyboard support. They can be still used to maintain uniform keyboard
2483 layout across the various plaforms.\n
2484 The language is to be set in the Preferences dialog.
2485 * \li Syntax: keymap-primary
2488 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
2490 * \var lyx::FuncCode lyx::LFUN_KEYMAP_SECONDARY
2491 * \li Action: Turn on the secondary keyboard map.
2492 * \li Syntax: keymap-secondary
2495 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
2497 * \var lyx::FuncCode lyx::LFUN_KEYMAP_TOGGLE
2498 * \li Action: Toggles keyboard maps (first/second/off).
2499 * \li Syntax: keymap-toggle
2500 * \li Origin: leeming, 30 Mar 2004
2503 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
2506 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_LAYOUT
2507 * \li Action: Returns the current layout (that is environment) name
2508 on the cursor position.
2509 * \li Syntax: server-get-layout
2512 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
2514 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_FILENAME
2515 * \li Action: Returns path and file name of the currently edited document.
2516 * \li Syntax: server-get-filename
2519 { LFUN_SERVER_GET_FILENAME, "server-get-filename", ReadOnly, System },
2521 * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
2522 * \li Action: Sets the cursor position based on the row number of generated TeX file.
2523 * \li Syntax: server-goto-file-row <LYX_FILE_NAME> <ROW_NUMBER>
2524 * \li Origin: Edmar, 23 Dec 1998
2527 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly, System },
2529 * \var lyx::FuncCode lyx::LFUN_SERVER_NOTIFY
2530 * \li Action: Sends notify message about the last key-sequence to client.
2531 * \li Notion: This can be used to grab last key-sequence used inside the LyX window.
2532 * \li Syntax: server-notify
2535 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
2537 * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
2538 * \li Action: Sets the cursor position based on the editing area coordinates
2539 (similar as clicking on that point with left mouse button).
2540 * \li Syntax: server-set-xy <X> <Y>
2543 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
2545 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
2546 * \li Action: Returns the coordinates of cursor position in the editing area.
2547 * \li Syntax: server-get-xy
2550 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
2553 * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
2554 * \li Action: Generates the code (literate programming).
2555 * \li Notion: Latex file with extension \literate_extension is generated.
2556 Then LyX invokes \build_command (with a default of``make'') to generate the code and
2557 \build_error_filter to process the compilation error messages. \n
2558 In case you want to process your literate file with a script, or some other program,
2559 just insert in your lyxrc file an entry with:\n
2560 \build_command "my_script my_arguments" \n
2561 The \build_error_filter differs from the \literate_error_filter only in that the
2562 former will identify error messages from your compiler.
2563 * \li Syntax: build-program
2566 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
2569 * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
2570 * \li Action: Saves the current buffer to a temporary file.
2571 * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
2572 is called automatically by LyX, to "autosave" the current buffer.
2573 * \li Syntax: buffer-auto-save
2576 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
2578 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHILD_OPEN
2579 * \li Action: Loads the given child document.
2580 * \li Notion: The current document is treated as a parent.
2581 * \li Syntax: buffer-child-open <FILE>
2582 * \li Params: <FILE>: Filename of the child. The directory of the parent is assumed by default.
2583 * \li Origin: Ale, 28 May 1997
2586 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
2588 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHKTEX
2589 * \li Action: Runs chktex for the current document.
2590 * \li Syntax: buffer-chktex
2591 * \li Origin: Asger, 30 Oct 1997
2594 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
2596 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
2597 * \li Action: Toggles compression of the current document on/off.
2598 * \li Syntax: buffer-toggle-compression
2599 * \li Origin: bpeng, 27 Apr 2006
2602 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
2604 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
2605 * \li Action: Closes the current buffer.
2606 * \li Notion: Closes the current buffer, asking whether to save it, etc,
2607 if the buffer has been modified.
2608 * \li Syntax: buffer-close
2611 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
2613 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
2614 * \li Action: Exports the current buffer (document) to the given format.
2615 * \li Syntax: buffer-export <FORMAT>
2616 * \li Params: <FORMAT> is either "custom" or one of the formats which you
2617 can find in Tools->Preferences->File formats->Format.
2618 Usual format you will enter is "pdf2" (pdflatex),
2619 "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
2620 In case of "custom" you will be asked for a format you
2621 want to start from and for the command that you want to
2622 apply to this format. Internally the control is then passed
2623 to #LFUN_BUFFER_EXPORT_CUSTOM.
2624 * \li Origin: Lgb, 29 Jul 1997
2627 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
2629 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
2630 * \li Action: Exports the current buffer (document) from the given format using
2631 the given command on it.
2632 * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
2633 * \li Params: <FORMAT> format to start from (LyX will care to produce such
2634 intermediate file).\n
2635 <COMMAND> this command will be launched on the file. Note that you can
2636 use "$$FName" string to qualify the intermediate file.
2637 * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
2638 * \li Origin: leeming, 27 Mar 2004
2641 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
2643 * \var lyx::FuncCode lyx::LFUN_BUFFER_PRINT
2644 * \li Action: Prints the current document.
2645 * \li Notion: Many settings can be given via the preferences dialog.
2646 * \li Syntax: buffer-print <TARGET> <TARGET-NAME> <COMMAND>
2647 * \li Params: <TARGET> is either "printer" or "file".\n
2648 <TARGER-NAME> is either "default" or file name or printer name.\n
2649 <COMMAND> command ensuring the printing job.
2650 * \li Sample: buffer-print file "/trash/newfile1.ps" "dvips"
2651 * \li Origin: leeming, 28 Mar 2004
2654 { LFUN_BUFFER_PRINT, "buffer-print", ReadOnly, Buffer },
2656 * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
2657 * \li Action: Import a given file as a lyx document.
2658 * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
2659 defined convertors in preferences. Look into File->Import menu to get
2660 an idea of the currently active import formats.
2661 * \li Syntax: buffer-import <FORMAT> [<FILE>]
2662 * \li Origin: Asger, 24 Jul 1998
2665 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
2667 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
2668 * \li Action: Creates a new buffer (that is, document).
2669 * \li Notion: Implicit path can be set in Preferences dialog.
2670 * \li Syntax: buffer-new [<FILE>]
2671 * \li Params: <FILE>: filename of created file with absolute path.
2674 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
2676 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
2677 * \li Action: Creates a new buffer (that is, document) from a template.
2678 * \li Notion: Path for new files and templates can be set in Preferences dialog.
2679 Template will be asked for via Open-dialog.
2680 * \li Syntax: buffer-new-template [<FILE>]
2681 * \li Params: <FILE>: filename of created file with absolute path.
2684 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
2686 * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
2687 * \li Action: Reverts opened document.
2688 * \li Syntax: buffer-reload
2689 * \li Origin: Asger, 2 Feb 1997
2692 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
2694 * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
2695 * \li Action: Switch to the given buffer.
2696 * \li Notion: This is useful also in case you need simultaneously more views of the edited
2697 document in different LyX windows.
2698 * \li Syntax: buffer-new-template <BUFFER>
2699 * \li Params: <BUFFER>: already opened document which is to be shown.
2702 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
2704 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
2705 * \li Action: Toggle editing mode of the current document between read/write and read-only.
2706 * \li Notion: In the ->Readonly mode checks-in/commits the data if the file is under version control.
2707 In the Readonly-> mode checkouts the data from repository. \n
2708 If these operations fail, buffer won't be toggled.
2709 * \li Syntax: buffer-toggle-read-only
2710 * \li Origin: Lgb, 27 May 1997
2713 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
2715 * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
2716 * \li Action: Displays current buffer in chosen format.
2717 * \li Notion: Displays the contents of the current buffer in the chosen
2718 format, for example, PDF or DVI. This runs the necessary
2719 converter, calls the defined viewer, and so forth.
2720 * \li Syntax: buffer-view <FORMAT>
2721 * \li Params: <FORMAT>: The format to display, where this is one of the
2722 formats defined (in the current GUI) in the
2723 Tools>Preferences>File Formats dialog.
2726 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
2728 * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
2729 * \li Action: Exports the current document and put the result into the
2730 temporary directory.
2731 * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
2732 the output will be rewriten - updated. This is useful in case your viewer
2733 is able to detect such changes (e.g. ghostview for postscript).
2734 * \li Syntax: buffer-update <FORMAT>
2735 * \li Params: <FORMAT>: The format to display, where this is one of the
2736 formats defined (in the current GUI) in the
2737 Tools>Preferences>File Formats dialog.
2738 * \li Origin: Dekel, 5 Aug 2000
2741 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
2744 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
2745 * \li Action: Saves the current buffer.
2746 * \li Notion: Saves the current buffer to disk, using the filename that
2747 is already associated with the buffer, asking for one if
2748 none is yet assigned.
2749 * \li Syntax: buffer-write
2752 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
2754 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
2755 * \li Action: Rename and save current buffer.
2756 * \li Syntax: buffer-write-as <FILENAME>
2757 * \li Params: <FILENAME>: New name of the buffer/file. A relative path
2758 is with respect to the original location of the buffer/file.
2761 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
2763 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
2764 * \li Action: Save all changed documents.
2765 * \li Syntax: buffer-write-all
2766 * \li Origin: rgh, gpothier 6 Aug 2007
2769 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
2771 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEXT
2772 * \li Action: Switch to the next opened document.
2773 * \li Notion: Note that this does not necessarily mean next in tabbar
2774 (for full list see View menu).
2775 * \li Syntax: buffer-next
2778 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
2780 * \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS
2781 * \li Action: Switch to the previous opened document.
2782 * \li Syntax: buffer-previous
2785 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
2787 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
2788 * \li Action: When run from a child document, this updates (exports) document built
2789 from the master buffer. If a master is not found, it updates the
2791 * \li Syntax: master-buffer-update
2792 * \li Origin: Tommaso, 20 Sep 2007
2795 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
2797 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
2798 * \li Action: When run from a child document, this command shows a preview built
2799 from the master buffer. If a master is not found, it previews the
2801 * \li Syntax: master-buffer-view
2802 * \li Origin: Tommaso, 20 Sep 2007
2805 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
2807 * \var lyx::FuncCode lyx::LFUN_BUFFER_LANGUAGE
2808 * \li Action: Set language of the current document.
2809 * \li Syntax: buffer-language <LANG>
2810 * \li Params: <LANG>: language name. See lib/languages for list.
2811 * \li Origin: leeming, 30 Mar 2004
2814 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
2816 * \var lyx::FuncCode lyx::LFUN_BUFFER_SAVE_AS_DEFAULT
2817 * \li Action: Save the current document settings as default.
2818 * \li Notion: The file will will be saved into ~/.lyx/templates/defaults.lyx .
2819 * \li Syntax: buffer-save-as-default [<ARGS>]
2820 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
2821 you can find in document header of usual .lyx file.
2822 * \li Origin: leeming, 30 Mar 2004
2825 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
2827 * \var lyx::FuncCode lyx::LFUN_BUFFER_PARAMS_APPLY
2828 * \li Action: Apply the given settings to the current document.
2829 * \li Syntax: buffer-params-apply [<ARGS>]
2830 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
2831 you can find in document header of usual .lyx file.
2832 * \li Origin: leeming, 30 Mar 2004
2835 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", Noop, Buffer },
2838 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
2839 * \li Action: Inserts another LyX file.
2840 * \li Syntax: file-insert [<FILE>]
2841 * \li Params: <FILE>: Filename to be inserted.
2844 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
2846 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
2847 * \li Action: Inserts plain text file.
2848 * \li Syntax: file-insert-plaintext [<FILE>]
2849 * \li Params: <FILE>: Filename to be inserted.
2850 * \li Origin: CFO-G, 19 Nov 1997
2853 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
2855 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
2856 * \li Action: Inserts plain text file as paragraph (i.e. join lines).
2857 * \li Syntax: file-insert-plaintext-para [<FILE>]
2858 * \li Params: <FILE>: Filename to be inserted.
2859 * \li Origin: Levon, 14 Feb 2001
2862 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
2864 * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
2865 * \li Action: Open LyX document.
2866 * \li Syntax: file-open [<FILE>]
2867 * \li Params: <FILE>: Filename to be opened.
2870 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
2873 * \var lyx::FuncCode lyx::LFUN_CALL
2874 * \li Action: Executes a command defined in a .def file.
2875 * \li Notion: The definitions are by default read from lib/commands/default.def.\n
2876 A .def file allows to define a command with \\define "<NAME>" "<LFUN>"
2877 where <NAME> is the name of the new command and <LFUN> is the lfun code
2878 to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
2879 \\def_file "FileName" allows to include another .def file. \n
2880 This is particularly useful in connection with toolbar buttons:
2881 Since the name of the button image for this lfun is
2882 lib/images/commands/<NAME>.png this is the way to assign an image
2883 to a complex command-sequence.
2884 * \li Syntax: call <NAME>
2885 * \li Params: <NAME>: Name of the command that must be called.
2886 * \li Origin: broider, 2 Oct 2007
2889 { LFUN_CALL, "call", NoBuffer, System },
2891 * \var lyx::FuncCode lyx::LFUN_META_PREFIX
2892 * \li Action: Simulate halting Meta key (Alt key on PCs).
2893 * \li Notion: Used for buffer editation not for GUI control.
2894 * \li Syntax: meta-prefix
2897 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
2899 * \var lyx::FuncCode lyx::LFUN_CANCEL
2900 * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
2901 * \li Syntax: cancel
2904 { LFUN_CANCEL, "cancel", NoBuffer, System },
2907 * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
2908 * \li Action: Opens the minibuffer toolbar so that the user can type in there.
2909 * \li Notion: Usually bound to M-x shortcut.
2910 * \li Syntax: command-execute
2913 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
2915 * \var lyx::FuncCode lyx::LFUN_COMMAND_PREFIX
2916 * \li Action: Return the current key sequence and available options as a string.
2917 * \li Notion: No options are added if no current map exists. \n
2918 This is probably usable only with connection to lyxserver.
2919 * \li Syntax: command-prefix
2922 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
2924 * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
2925 * \li Action: Run more commands (LFUN and its parameters) in a sequence.
2926 * \li Syntax: command-sequence <CMDS>
2927 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
2928 * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
2929 * \li Origin: Andre, 11 Nov 1999
2932 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
2934 * \var lyx::FuncCode lyx::LFUN_COMMAND_ALTERNATIVES
2935 * \li Action: Runs the first listed command that is enabled.
2936 * \li Notion: This can be used to bind multiple functions to a single key,
2937 and then which one is used will depend upon the context.
2938 * \li Syntax: command-alternatives <CMDS>
2939 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
2940 * \li Sample: command-alternatives completion-accept;cell-forward
2941 * \li Origin: rgh, 24 September 2008
2944 { LFUN_COMMAND_ALTERNATIVES, "command-alternatives", NoBuffer, System },
2946 * \var lyx::FuncCode lyx::LFUN_MESSAGE
2947 * \li Action: Shows message in statusbar (for script purposes).
2948 * \li Syntax: message <STRING>
2949 * \li Origin: Lgb, 8 Apr 2001
2952 { LFUN_MESSAGE, "message", NoBuffer, System },
2954 * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
2955 * \li Action: Save user preferences.
2956 * \li Syntax: preferences-save
2957 * \li Origin: Lgb, 27 Nov 1999
2960 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
2962 * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
2963 * \li Action: Reconfigure the automatic settings.
2964 * \li Syntax: reconfigure
2965 * \li Origin: Asger, 14 Feb 1997
2968 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
2970 * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
2971 * \li Action: Apply the given settings to user preferences.
2972 * \li Syntax: lyxrc-apply <SETTINGS>
2973 * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
2974 to get an idea which commands to use and their syntax.
2975 #lyx::LyXRC::LyXRCTags has the list of possible commands.
2978 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
2980 * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
2981 * \li Action: Determine whether keep cursor inside the editing window regardless
2982 the scrollbar movement.
2983 * \li Syntax: toggle-cursor-follows-scrollbar
2984 * \li Origin: ARRae, 2 Dec 1997
2987 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
2989 * \var lyx::FuncCode lyx::LFUN_SET_COLOR
2990 * \li Action: Set the given LyX color to the color defined by the X11 name given.
2991 * \li Notion: A new color entry is created if the color is unknown.
2992 Color names can be stored as a part of user settings.
2993 * \li Syntax: set-color <LYX_NAME> <X11_NAME>
2994 * \li Origin: SLior, 11 Jun 2000
2997 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
2999 * \var lyx::FuncCode lyx::LFUN_STATISTICS
3000 * \li Action: Count the statistics (number of words and characters)
3001 in the document or in the given selection.
3002 * \li Notion: Note that this function gives the number of words/chars written,
3003 not the number of characters which will be typeset.
3004 * \li Syntax: statistics
3005 * \li Origin: lasgouttes, Jan 27 2004; sanda, Jan 8 2008
3008 { LFUN_STATISTICS, "statistics", ReadOnly, System },
3010 * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
3011 * \li Action: Show the inline completion at the cursor position.
3012 * \li Syntax: completion-inline
3013 * \li Origin: sts, Feb 19 2008
3016 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
3018 * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
3019 * \li Action: Show the completion popup at the cursor position.
3020 * \li Syntax: completion-popup
3021 * \li Origin: sts, Feb 19 2008
3024 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
3026 * \var lyx::FuncCode lyx::LFUN_COMPLETION_COMPLETE
3027 * \li Action: Try to complete the word or command at the cursor position.
3028 * \li Syntax: complete
3029 * \li Origin: sts, Feb 19 2008
3032 { LFUN_COMPLETION_COMPLETE, "complete", SingleParUpdate, Edit },
3035 * \var lyx::FuncCode lyx::LFUN_COMPLETION_CANCEL
3036 * \li Action: Try to cancel completion, either the popup or the inline completion
3037 * \li Syntax: completion-cancel
3038 * \li Origin: sts, Sep 07 2008
3041 { LFUN_COMPLETION_CANCEL, "completion-cancel", SingleParUpdate, Edit },
3043 * \var lyx::FuncCode lyx::LFUN_COMPLETION_ACCEPT
3044 * \li Action: Accept suggested completion.
3045 * \li Syntax: completion-accept
3046 * \li Origin: sanda, Sep 08 2008
3049 { LFUN_COMPLETION_ACCEPT, "completion-accept", SingleParUpdate, Edit },
3053 * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
3054 * \li Action: Activate the branch
3055 * \li Syntax: branch-activate <BRANCH>
3056 * \li Params: <BRANCH>: The branch to activate
3057 * \li Sample: lyx -e pdf2 -x "branch-activate answers" finalexam.lyx \n
3058 could be used to export a pdf with the answers branch included
3059 without one's having to open LyX and activate the branch manually.
3060 * \li Origin: rgh, 27 May 2008
3063 { LFUN_BRANCH_ACTIVATE, "branch-activate", Argument, Buffer },
3065 * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
3066 * \li Action: De-activate the branch
3067 * \li Syntax: branch-deactivate <BRANCH>
3068 * \li Params: <BRANCH>: The branch to deactivate
3069 * \li Origin: rgh, 27 May 2008
3072 { LFUN_BRANCH_DEACTIVATE, "branch-deactivate", Argument, Buffer },
3074 { LFUN_NOACTION, "", Noop, Hidden }
3075 #ifndef DOXYGEN_SHOULD_SKIP_THIS
3078 for (int i = 0; items[i].action != LFUN_NOACTION; ++i) {
3079 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
3086 LyXAction::LyXAction()
3092 // Returns an action tag from a string.
3093 FuncRequest LyXAction::lookupFunc(string const & func) const
3095 string const func2 = trim(func);
3097 if (func2.empty()) {
3098 return FuncRequest(LFUN_NOACTION);
3102 string const arg = split(func2, cmd, ' ');
3104 func_map::const_iterator fit = lyx_func_map.find(cmd);
3106 return fit != lyx_func_map.end() ? FuncRequest(fit->second, arg) : FuncRequest(LFUN_UNKNOWN_ACTION);
3110 string const LyXAction::getActionName(FuncCode action) const
3112 info_map::const_iterator const it = lyx_info_map.find(action);
3113 return it != lyx_info_map.end() ? it->second.name : string();
3117 LyXAction::func_type const LyXAction::getActionType(FuncCode action) const
3119 info_map::const_iterator const it = lyx_info_map.find(action);
3120 return it != lyx_info_map.end() ? it->second.type : Hidden;
3124 bool LyXAction::funcHasFlag(FuncCode action,
3125 LyXAction::func_attrib flag) const
3127 info_map::const_iterator ici = lyx_info_map.find(action);
3129 if (ici == lyx_info_map.end()) {
3130 LYXERR0("action: " << action << " is not known.");
3131 LASSERT(false, /**/);
3134 return ici->second.attrib & flag;
3138 LyXAction::const_func_iterator LyXAction::func_begin() const
3140 return lyx_func_map.begin();
3144 LyXAction::const_func_iterator LyXAction::func_end() const
3146 return lyx_func_map.end();
3150 LyXErr & operator<<(LyXErr & l, FuncCode code)
3153 l.stream() << lyxaction.getActionName(code);