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"
27 using namespace lyx::support;
32 NAMING RULES FOR USER-COMMANDS
33 Here's the set of rules to apply when a new command name is introduced:
35 1) Use the object.event order. That is, use `word-forward'
36 instead of `forward-word'.
37 2) Don't introduce an alias for an already named object. Same for events.
38 3) Forward movement or focus is called `forward' (not `right').
39 4) Backward movement or focus is called `backward' (not `left').
40 5) Upward movement of focus is called `up'.
41 6) Downward movement is called `down'.
42 7) The begin of an object is called `begin' (not `start').
43 8) The end of an object is called `end'.
45 (May 19 1996, 12:04, RvdK)
50 * The documentation below is primarily description of purpose and syntax
51 * relating to the different LFUNs.
53 * Try to find an appropriate (thematical) place when adding the new LFUN
54 * and don't forget to add doxygen commentary.
56 * Doxygen template below. Some notes: Parameters should be set in uppercase
57 * and put in <BRACKETS>, [<PARAM>] means optional one.
61 * \var lyx::FuncCode lyx::LFUN_
74 void LyXAction::newFunc(FuncCode action, string const & name,
75 unsigned int attrib, LyXAction::func_type type)
77 lyx_func_map[name] = action;
80 tmpinfo.attrib = attrib;
82 lyx_info_map[action] = tmpinfo;
86 // Needed for LFUNs documentation to be accepted, since doxygen won't take
87 // \var inside functions.
88 #ifndef DOXYGEN_SHOULD_SKIP_THIS
89 void LyXAction::init()
91 // This function was changed to use the array below in initalization
92 // instead of calling newFunc numerous times because of compilation
93 // times. Since the array is not static we get back the memory it
94 // occupies after the init is completed. It compiles several
107 ev_item const items[] = {
110 * \var lyx::FuncCode lyx::LFUN_ACCENT_ACUTE
111 * \li Action: Adds an acute accent \htmlonly (á)\endhtmlonly
112 to the next character typed.
113 * \li Syntax: accent-acute
116 { LFUN_ACCENT_ACUTE, "accent-acute", Noop, Edit },
118 * \var lyx::FuncCode lyx::LFUN_ACCENT_BREVE
119 * \li Action: Adds a breve accent \htmlonly (ă)\endhtmlonly
120 to the next character typed.
121 * \li Syntax: accent-breve
124 { LFUN_ACCENT_BREVE, "accent-breve", Noop, Edit },
126 * \var lyx::FuncCode lyx::LFUN_ACCENT_CARON
127 * \li Action: Adds a caron \htmlonly (ǎ)\endhtmlonly
128 to the next character typed.
129 * \li Syntax: accent-caron
132 { LFUN_ACCENT_CARON, "accent-caron", Noop, Edit },
134 * \var lyx::FuncCode lyx::LFUN_ACCENT_CEDILLA
135 * \li Action: Adds a cedilla \htmlonly (ç)\endhtmlonly
136 to the next character typed.
137 * \li Syntax: accent-cedilla
140 { LFUN_ACCENT_CEDILLA, "accent-cedilla", Noop, Edit },
142 * \var lyx::FuncCode lyx::LFUN_ACCENT_CIRCLE
143 * \li Action: Adds a circle accent \htmlonly (å)\endhtmlonly
144 to the next character typed.
145 * \li Syntax: accent-circle
148 { LFUN_ACCENT_CIRCLE, "accent-circle", Noop, Edit },
150 * \var lyx::FuncCode lyx::LFUN_ACCENT_CIRCUMFLEX
151 * \li Action: Adds a circumflex \htmlonly (ê)\endhtmlonly
152 to the next character typed.
153 * \li Syntax: accent-circumflex
156 { LFUN_ACCENT_CIRCUMFLEX, "accent-circumflex", Noop, Edit },
158 * \var lyx::FuncCode lyx::LFUN_ACCENT_DOT
159 * \li Action: Adds a dot accent \htmlonly (ż)\endhtmlonly
160 to the next character typed.
161 * \li Syntax: accent-dot
164 { LFUN_ACCENT_DOT, "accent-dot", Noop, Edit },
166 * \var lyx::FuncCode lyx::LFUN_ACCENT_GRAVE
167 * \li Action: Adds a grave accent \htmlonly (è)\endhtmlonly
168 to the next character typed.
169 * \li Syntax: accent-grave
172 { LFUN_ACCENT_GRAVE, "accent-grave", Noop, Edit },
174 * \var lyx::FuncCode lyx::LFUN_ACCENT_HUNGARIAN_UMLAUT
175 * \li Action: Adds a Hungarian umlaut \htmlonly (ő)\endhtmlonly
176 to the next character typed.
177 * \li Syntax: accent-grave
180 { LFUN_ACCENT_HUNGARIAN_UMLAUT, "accent-hungarian-umlaut", Noop, Edit },
182 * \var lyx::FuncCode lyx::LFUN_ACCENT_MACRON
183 * \li Action: Adds a macron \htmlonly (ā)\endhtmlonly
184 to the next character typed.
185 * \li Syntax: accent-macron
188 { LFUN_ACCENT_MACRON, "accent-macron", Noop, Edit },
190 * \var lyx::FuncCode lyx::LFUN_ACCENT_OGONEK
191 * \li Action: Adds an ogonek accent \htmlonly (ą)\endhtmlonly
192 to the next character typed.
193 * \li Syntax: accent-ogonek
196 { LFUN_ACCENT_OGONEK, "accent-ogonek", Noop, Edit },
198 * \var lyx::FuncCode lyx::LFUN_ACCENT_TIE
199 * \li Action: Adds a tie \htmlonly (a͡)\endhtmlonly
200 over the next two character typed.
201 * \li Notion: the following char will finish the tie.
202 * \li Syntax: accent-tie
205 { LFUN_ACCENT_TIE, "accent-tie", Noop, Edit },
207 * \var lyx::FuncCode lyx::LFUN_ACCENT_TILDE
208 * \li Action: Adds a tilde \htmlonly (ã)\endhtmlonly
209 over the next character typed.
210 * \li Syntax: accent-tilde
213 { LFUN_ACCENT_TILDE, "accent-tilde", Noop, Edit },
215 * \var lyx::FuncCode lyx::LFUN_ACCENT_UMLAUT
216 * \li Action: Adds an umlaut \htmlonly (ä)\endhtmlonly
217 over the next character typed.
218 * \li Syntax: accent-umlaut
221 { LFUN_ACCENT_UMLAUT, "accent-umlaut", Noop, Edit },
223 * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERBAR
224 * \li Action: Adds a bar \htmlonly (a̠)\endhtmlonly
225 under the next character typed.
226 * \li Syntax: accent-underbar
229 { LFUN_ACCENT_UNDERBAR, "accent-underbar", Noop, Edit },
231 * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERDOT
232 * \li Action: Adds a dot \htmlonly (ạ)\endhtmlonly
233 under the next character typed.
234 * \li Syntax: accent-underdot
237 { LFUN_ACCENT_UNDERDOT, "accent-underdot", Noop, Edit },
240 * \var lyx::FuncCode lyx::LFUN_CAPTION_INSERT
241 * \li Action: Inserts a caption inset.
242 * \li Syntax: caption-insert
243 * \li Origin: Lgb, 18 Jul 2000
246 { LFUN_CAPTION_INSERT, "caption-insert", Noop, Edit },
248 * \var lyx::FuncCode lyx::LFUN_DATE_INSERT
249 * \li Action: Inserts the current date.
250 * \li Syntax: date-insert [<ARG>]
251 * \li Params: <ARG>: Format of date. The default value (%x) can be set
252 in Preferences->Date format. For possible formats
253 see manual page of strftime function.
254 * \li Origin: jdblair, 31 Jan 2000
257 { LFUN_DATE_INSERT, "date-insert", Noop, Edit },
259 * \var lyx::FuncCode lyx::LFUN_FOOTNOTE_INSERT
260 * \li Action: Inserts a footnote inset.
261 * \li Syntax: footnote-insert
262 * \li Origin: Jug, 7 Mar 2000
265 { LFUN_FOOTNOTE_INSERT, "footnote-insert", Noop, Edit },
267 * \var lyx::FuncCode lyx::LFUN_ERT_INSERT
268 * \li Action: Inserts an ERT inset.
269 * \li Syntax: ert-insert
270 * \li Origin: Jug, 18 Feb 2000
273 { LFUN_ERT_INSERT, "ert-insert", Noop, Edit },
275 * \var lyx::FuncCode lyx::LFUN_FLOAT_INSERT
276 * \li Action: Inserts a float inset.
277 * \li Syntax: float-insert <TYPE>
278 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
279 "algorithm", "table", "figure" parameters can be given.
280 * \li Origin: Lgb, 27 Jun 2000
283 { LFUN_FLOAT_INSERT, "float-insert", Noop, Edit },
285 * \var lyx::FuncCode lyx::LFUN_FLOAT_WIDE_INSERT
286 * \li Action: Inserts float insets as in #LFUN_FLOAT_INSERT but span multiple columns.
287 * \li Notion: Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
288 * \li Syntax: float-wide-insert <TYPE>
289 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
290 "algorithm", "table", "figure" parameters can be given.
291 * \li Origin: Lgb, 31 Oct 2001
294 { LFUN_FLOAT_WIDE_INSERT, "float-wide-insert", Noop, Edit },
296 * \var lyx::FuncCode lyx::LFUN_FLOAT_LIST_INSERT
297 * \li Action: Inserts the list of floats in the document.
298 * \li Syntax: float-list-insert <TYPE>
299 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
300 "algorithm", "table", "figure" parameters can be given.
301 * \li Origin: Lgb, 3 May 2001
304 { LFUN_FLOAT_LIST_INSERT, "float-list-insert", Noop, Edit },
306 * \var lyx::FuncCode lyx::LFUN_WRAP_INSERT
307 * \li Action: Inserts floats wrapped by the text around.
308 * \li Syntax: wrap-insert <TYPE>
309 * \li Params: <TYPE>: table|figure
310 * \li Origin: Dekel, 7 Apr 2002
313 { LFUN_WRAP_INSERT, "wrap-insert", Noop, Edit },
315 * \var lyx::FuncCode lyx::LFUN_OPTIONAL_INSERT
316 * \li Action: Inserts an optional-argument (short title) inset.
317 * \li Syntax: optional-insert
318 * \li Origin: Martin, 12 Aug 2002
321 { LFUN_OPTIONAL_INSERT, "optional-insert", Noop, Edit },
323 * \var lyx::FuncCode lyx::LFUN_LINE_INSERT
324 * \li Action: Inserts a horizontal line.
325 * \li Syntax: line-insert
326 * \li Origin: poenitz, Oct 27 2003
329 { LFUN_LINE_INSERT, "line-insert", Noop, Edit },
331 * \var lyx::FuncCode lyx::LFUN_NEWPAGE_INSERT
332 * \li Action: Inserts a new page.
333 * \li Syntax: newpage-insert<ARG>
334 * \li Params: <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
335 * \li Origin: uwestoehr, 24 Nov 2007
338 { LFUN_NEWPAGE_INSERT, "newpage-insert", Noop, Edit },
340 * \var lyx::FuncCode lyx::LFUN_MARGINALNOTE_INSERT
341 * \li Action: Inserts a marginal note.
342 * \li Syntax: marginalnote-insert
343 * \li Origin: Lgb, 26 Jun 2000
346 { LFUN_MARGINALNOTE_INSERT, "marginalnote-insert", Noop, Edit },
348 * \var lyx::FuncCode lyx::LFUN_UNICODE_INSERT
349 * \li Action: Inserts a single unicode character.
350 * \li Syntax: unicode-insert <CHAR>
351 * \li Params: <CHAR>: The character to insert, given as its code
352 point, in hexadecimal, e.g.: unicode-insert 0x0100.
353 * \li Origin: Lgb, 22 Oct 2006
356 { LFUN_UNICODE_INSERT, "unicode-insert", Noop, Edit },
358 * \var lyx::FuncCode lyx::LFUN_LISTING_INSERT
359 * \li Action: Inserts a new listings inset.
360 * \li Syntax: listing-insert
361 * \li Origin: Herbert, 10 Nov 2001; bpeng, 2 May 2007
364 { LFUN_LISTING_INSERT, "listing-insert", Noop, Edit },
366 * \var lyx::FuncCode lyx::LFUN_QUOTE_INSERT
367 * \li Action: Inserts quotes according to the type and quote-language preference.
368 * \li Action: Currently English, Swedish, German, Polish, French, Danish quotes
370 * \li Syntax: quote-insert [<TYPE>]
371 * \li Params: TYPE: 'single' for single quotes, otherwise double quotes will be used.
374 { LFUN_QUOTE_INSERT, "quote-insert", Noop, Edit },
376 * \var lyx::FuncCode lyx::LFUN_INFO_INSERT
377 * \li Action: Displays shortcuts, lyxrc, package and textclass availability and menu
378 information in a non-editable boxed InsetText.
379 * \li Notion: Apart from lfun arguments you can use the following method: \n
380 1. input the type and argument of this inset, e.g. "menu paste", in
382 2. select the text and run info-insert lfun.\n
383 * \li Syntax: info-insert <TYPE> <ARG>
384 * \li Params: <TYPE>: shortcut|lyxrc|package|textclass|menu|buffer \n
385 <ARG>: argument for a given type. Look into InsetInfo.h for detailed
387 * \li Origin: bpeng, 7 Oct 2007
390 { LFUN_INFO_INSERT, "info-insert", Noop, Edit },
392 * \var lyx::FuncCode lyx::LFUN_BRANCH_INSERT
393 * \li Action: Inserts branch inset.
394 * \li Syntax: branch-insert <BRANCH-NAME>
395 * \li Origin: vermeer, 17 Aug 2003
398 { LFUN_BRANCH_INSERT, "branch-insert", Noop, Edit },
400 * \var lyx::FuncCode lyx::LFUN_BOX_INSERT
401 * \li Action: Inserts Box inset.
402 * \li Syntax: box-insert [<TYPE>]
403 * \li Params: <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox \n
404 Framed is the default one.
405 * \li Origin: vermeer, 7 Oct 2003
408 { LFUN_BOX_INSERT, "box-insert", Noop, Edit },
410 * \var lyx::FuncCode lyx::LFUN_FLEX_INSERT
411 * \li Action: Inserts CharStyle, Custom inset or XML short element.
412 * \li Notion: Look into the Customization manual for more information about
414 To make this command enabled the layout file for the document
415 class you're using has to load the character styles. There are
416 a few contained in the Logical Markup module. You can also of
417 course create some yourself. \n
418 For dissolving the element see #LFUN_INSET_DISSOLVE.
419 * \li Syntax: flex-insert <TYPE:Name>
420 * \li Params: TYPE: CharStyle|Custom|Element|Standard
421 Identifies whether this is a Character Style, a
422 Custom Inset or an XML Element, and which dynamical
423 sub-menu this flex inset is in on the LyX menu tree.
424 If Standard (currently unused): none of these.
425 Name: This name must be defined either in your layout file
426 or imported by some module. The definition is \n
427 InsetLayout <TYPE:Name>
428 * \li Sample: flex-insert CharStyle:Code
431 { LFUN_FLEX_INSERT, "flex-insert", Noop, Edit },
433 * \var lyx::FuncCode lyx::LFUN_SELF_INSERT
434 * \li Action: Inserts the given string (accordingly to the correct keymap).
435 * \li Notion: Automatically replace the currently selected text. Depends on lyxrc
436 settings "auto_region_delete".
437 * \li Syntax: self-insert <STRING>
440 { LFUN_SELF_INSERT, "self-insert", SingleParUpdate, Hidden },
442 * \var lyx::FuncCode lyx::LFUN_SPACE_INSERT
443 * \li Action: Inserts one of horizontal space insets.
444 * \li Syntax: space-insert <NAME> [<LEN>]
445 * \li Params: <NAME>: normal, protected, thin, quad, qquad, enspace, enskip,
446 negthinspace, hfill, hfill*, dotfill, hrulefill, hspace,
448 <LEN>: length for custom spaces (hspace, hspace* for protected)
449 * \li Origin: JSpitzm, 20 May 2003, Mar 17 2008
452 { LFUN_SPACE_INSERT, "space-insert", Noop, Edit },
454 * \var lyx::FuncCode lyx::LFUN_HYPERLINK_INSERT
455 * \li Action: Inserts hyperlinks into the document (clickable in pdf output).
456 * \li Notion: Hyperlink target can be set via selection + hyperlink-insert function.
457 * \li Syntax: href-insert [<TARGET>]
458 * \li Origin: CFO-G, 21 Nov 1997
461 { LFUN_HYPERLINK_INSERT, "href-insert", Noop, Edit },
463 * \var lyx::FuncCode lyx::LFUN_SPECIALCHAR_INSERT
464 * \li Action: Inserts various characters into the document.
465 * \li Syntax: specialchar-insert <CHAR>
466 * \li Params: <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots,
467 end-of-sentence, menu-separator.
468 * \li Origin: JSpitzm, 6 Dec 2007
471 { LFUN_SPECIALCHAR_INSERT, "specialchar-insert", Noop, Edit },
473 * \var lyx::FuncCode lyx::LFUN_TOC_INSERT
474 * \li Action: Inserts table of contents.
475 * \li Syntax: toc-insert
476 * \li Origin: Lgb, 27 May 97
479 { LFUN_TOC_INSERT, "toc-insert", Noop, Edit },
481 * \var lyx::FuncCode lyx::LFUN_APPENDIX
482 * \li Action: Start (or remove) Appendix on the given cursor position.
483 * \li Syntax: appendix
484 * \li Origin: ettrich, 5 May 1998
487 { LFUN_APPENDIX, "appendix", Noop, Edit },
490 * \var lyx::FuncCode lyx::LFUN_INDEX_INSERT
491 * \li Action: Inserts Index entry.
492 * \li Notion: It automatically takes the word on the cursor position.
493 * \li Syntax: index-insert
494 * \li Origin: Angus, 3 Aug 2000
497 { LFUN_INDEX_INSERT, "index-insert", Noop, Edit },
499 * \var lyx::FuncCode lyx::LFUN_INDEX_PRINT
500 * \li Action: Inserts list of Index entries on a new page.
501 * \li Syntax: index-print
502 * \li Origin: Lgb, 27 Feb 1997
505 { LFUN_INDEX_PRINT, "index-print", Noop, Edit },
508 * \var lyx::FuncCode lyx::LFUN_NOMENCL_INSERT
509 * \li Action: Inserts Nomenclature entry.
510 * \li Notion: It automatically takes the word on the cursor position if no symbol is given.
511 * \li Syntax: nomencl-insert [<SYMBOL>]
512 * \li Origin: Ugras, 4 Nov 2006
515 { LFUN_NOMENCL_INSERT, "nomencl-insert", Noop, Edit },
517 * \var lyx::FuncCode lyx::LFUN_NOMENCLATURE_PRINT
518 * \li Action: Inserts list of Nomenclature entries.
519 * \li Syntax: nomenclature-print
520 * \li Origin: Ugras, 4 Nov 2006
523 { LFUN_NOMENCL_PRINT, "nomencl-print", Noop, Edit },
526 * \var lyx::FuncCode lyx::LFUN_NOTE_INSERT
527 * \li Action: Inserts Note on the current cursor postion,
528 move selection inside the inset.
529 * \li Syntax: note-insert [<TYPE>]
530 * \li Params: <TYPE>: <Note|Greyedout|Comment> default: Note
533 { LFUN_NOTE_INSERT, "note-insert", Noop, Edit },
535 * \var lyx::FuncCode lyx::LFUN_NOTE_NEXT
536 * \li Action: Moves the cursor to the begining of next Note inset.
537 * \li Syntax: note-next
540 { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
542 * \var lyx::FuncCode lyx::LFUN_NOTES_MUTATE
543 * \li Action: Changes all Note insets of a particular type (source)
544 to a different type (target) fot the current document.
545 * \li Syntax: notes-mutate <SOURCE> <TARGET>
546 * \li Params: <SOURCE/TARGET>: Note|Comment|Greyedout
547 * \li Origin: ps, 18 Jun 2008
550 { LFUN_NOTES_MUTATE, "notes-mutate", Argument, Edit },
552 * \var lyx::FuncCode lyx::LFUN_NEWLINE_INSERT
553 * \li Action: Inserts a line break or new line.
554 * \li Syntax: newline-insert [<ARG>]
555 * \li Params: <ARG>: <newline|linebreak> default: newline
556 * \li Origin: JSpitzm, 25 Mar 2008
559 { LFUN_NEWLINE_INSERT, "newline-insert", Noop, Edit },
562 * \var lyx::FuncCode lyx::LFUN_ESCAPE
563 * \li Action: Clears the selection. If no text is selected call #LFUN_FINISHED_FORWARD.
565 * \li Origin: Lgb, 17 May 2001
568 { LFUN_ESCAPE, "escape", ReadOnly, Edit },
570 * \var lyx::FuncCode lyx::LFUN_DOWN
571 * \li Action: Moves the cursor one line in downward direction.
575 { LFUN_DOWN, "down", ReadOnly | NoUpdate, Edit },
577 * \var lyx::FuncCode lyx::LFUN_UP
578 * \li Action: Moves the cursor one line in upward direction.
582 { LFUN_UP, "up", ReadOnly | NoUpdate, Edit },
584 * \var lyx::FuncCode lyx::LFUN_DOWN_SELECT
585 * \li Action: Moves the cursor one line in downward direction adding the current
586 position to the selection.
587 * \li Syntax: down-select
590 { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, Edit },
592 * \var lyx::FuncCode lyx::LFUN_UP_SELECT
593 * \li Action: Moves the cursor one line in upward direction adding the current
594 position to the selection.
595 * \li Syntax: up-select
598 { LFUN_UP_SELECT, "up-select", ReadOnly | SingleParUpdate, Edit },
600 * \var lyx::FuncCode lyx::SCREEN_DOWN
601 * \li Action: Moves the cursor one page in downward direction.
602 * \li Syntax: screen-down
605 { LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit },
607 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP
608 * \li Action: Moves the cursor one page in upward direction.
609 * \li Syntax: screen-up
612 { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit },
614 * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN_SELECT
615 * \li Action: Moves the cursor one screen in downward direction adding the current
616 position to the selection.
617 * \li Syntax: screen-down-select
620 { LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit },
622 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP_SELECT
623 * \li Action: Moves the cursor one page in upward direction adding the current
624 position to the selection.
625 * \li Syntax: screen-up-select
628 { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit },
630 * \var lyx::FuncCode lyx::LFUN_SCROLL
631 * \li Action: Scroll the buffer view.
632 * \li Notion: Only scrolls the screen up or down; does not move the cursor.
633 * \li Syntax: scroll <TYPE> <QUANTITY>
634 * \li Params: <TYPE>: line|page\n
635 <QUANTITY>: up|down|<number>
636 * \li Origin: Abdelrazak Younes, Dec 27 2007
639 { LFUN_SCROLL, "scroll", ReadOnly, Edit },
641 * \var lyx::FuncCode lyx::LFUN_SCREEN_RECENTER
642 * \li Action: Recenters the screen on the current cursor position.
643 * \li Syntax: screen-recenter
646 { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit },
649 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD
650 * \li Action: Moves the cursor one position logically backwards.
651 * \li Notion: This is not the action which should be bound to the arrow keys,
652 because backwards may be left or right, depending on the
653 language. The arrow keys should be bound to #LFUN_CHAR_LEFT or
654 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
655 * \li Syntax: char-backward
658 { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit },
660 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD_SELECT
661 * \li Action: Moves the cursor one position logically backwards, adding
662 traversed position to the selection.
663 * \li Notion: See also #LFUN_CHAR_BACKWARD.
664 * \li Syntax: char-backward-select
667 { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit },
669 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_BACKWARD
670 * \li Action: Deletes one character in the backward direction (usually the "BackSpace" key).
671 * \li Syntax: char-delete-backward
674 { LFUN_CHAR_DELETE_BACKWARD, "char-delete-backward", SingleParUpdate, Edit },
676 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_FORWARD
677 * \li Action: Deletes one character in the backward direction (usually the "Delete" key).
678 * \li Syntax: char-delete-forward
681 { LFUN_CHAR_DELETE_FORWARD, "char-delete-forward", SingleParUpdate, Edit },
683 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD
684 * \li Action: Moves the cursor one position logically forward.
685 * \li Notion: This is not the action which should be bound to the arrow keys,
686 because forward may be left or right, depending on the language.
687 The arrow keys should be bound to #LFUN_CHAR_LEFT or
688 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
689 * \li Syntax: char-forward
692 { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit },
694 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD_SELECT
695 * \li Action: Moves the cursor one position logically forward, adding
696 traversed position to the selection.
697 * \li Notion: See also #LFUN_CHAR_FORWARD.
698 * \li Syntax: char-forward-select
701 { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit },
703 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT
704 * \li Action: Moves the cursor one position "to the left".
705 * \li Notion: This is the action which should be taken when the "left" key
706 is pressed. Generally, it moves the cursor one position to the
707 left. However, in Bidi text this become slightly more
708 complicated, and there are different modes of cursor movement.
709 In "visual mode", this moves left, plain and simple. In "logical
710 mode", movement is logically forward in RTL paragraphs, and
711 logically backwards in LTR paragraphs.
712 * \li Syntax: char-left
715 { LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit },
717 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT_SELECT
718 * \li Action: Moves the cursor one position "to the left", adding
719 traversed position to the selection.
720 * \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement.
721 * \li Syntax: char-left-select
724 { LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit },
726 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT
727 * \li Action: Moves the cursor one position "to the right".
728 * \li Notion: This is the action which should be taken when the "right" key
729 is pressed. Generally, it moves the cursor one position to the
730 right. However, in Bidi text this become slightly more
731 complicated, and there are different modes of cursor movement.
732 In "visual mode", this moves right, plain and simple. In "logical
733 mode", movement is logically forward in LTR paragraphs, and
734 logically backwards in RTL paragraphs.
735 * \li Syntax: char-right
738 { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit },
740 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT_SELECT
741 * \li Action: Moves the cursor one position "to the right", adding
742 traversed position to the selection.
743 * \li Notion: See also #LFUN_CHAR_RIGHT for exact details of the movement.
744 * \li Syntax: char-right-select
747 { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit },
750 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD
751 * \li Action: Moves the cursor to the logically previous beginning of a word.
752 * \li Notion: This is not the action which should be bound to the arrow keys,
753 because backwards may be left or right, depending on the
754 language. The arrow keys should be bound to #LFUN_WORD_LEFT or
755 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
756 * \li Syntax: word-backward
759 { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit },
761 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD_SELECT
762 * \li Action: Moves the cursor to the logically previous beginning of a word,
763 adding the logically traversed text to the selection.
764 * \li Notion: See also #LFUN_WORD_BACKWARD.
765 * \li Syntax: word-backward-select
768 { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
770 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_BACKWARD
771 * \li Action: Deletes characters to the begining of the word (usually the "C+BackSpace" key).
772 * \li Syntax: word-delete-backward
775 { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
777 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_FORWARD
778 * \li Action: Deletes characters to the end of the word (usually the "C+Delete" key).
779 * \li Syntax: word-delete-forward
782 { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
784 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_FORWARD
785 * \li Action: Search for a given string in forward direction.
786 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
787 * \li Syntax: word-find-forward [<STRING>]
788 * \li Origin: Etienne, 16 Feb 1998
791 { LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit },
793 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_BACKWARD
794 * \li Action: Search for a given string in backward direction.
795 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
796 * \li Syntax: word-find-backward [<STRING>]
797 * \li Origin: Etienne, 20 Feb 1998
800 { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
802 * \var lyx::FuncCode lyx::LFUN_WORD_FIND
803 * \li Action: Search for next occurence of a string.
804 * \li Syntax: word-find [<DATA>]
805 * \li Params: <DATA>: data encoded from Find dialog (see #lyx::find2string()).
806 If no parameter is given, search with last find-dialog
807 data is used for search (i.e. find-next).
808 * \li Origin: poenitz, Jan 7 2004
811 { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
813 * \var lyx::FuncCode lyx::LFUN_WORD_FIND
814 * \li Action: Replace a string in the document.
815 * \li Syntax: word-replace [<DATA>]
816 * \li Params: <DATA>: data is of the form
819 <casesensitive> <matchword> <all> <forward>"
820 * \li Origin: poenitz, Jan 7 2004
823 { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
825 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD
826 * \li Action: Moves the cursor to the logically next beginning of a word.
827 * \li Notion: This is not the action which should be bound to the arrow keys,
828 because forward may be left or right, depending on the language.
829 The arrow keys should be bound to #LFUN_WORD_LEFT or
830 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
831 * \li Syntax: word-forward
834 { LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
836 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD_SELECT
837 * \li Action: Moves the cursor to the logically next beginning of a word,
838 adding the logically traversed text to the selection.
839 * \li Notion: See also #LFUN_WORD_FORWARD.
840 * \li Syntax: word-forward-select
843 { LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
845 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT
846 * \li Action: Moves the cursor to the next beginning of a word "on the left".
847 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
848 "left" key is pressed. Generally, it moves the cursor to the
849 next beginning of a word on the left. However, in Bidi text this
850 become slightly more complicated, and there are different modes
851 of cursor movement. In "visual mode", this moves left, plain and
852 simple. In "logical mode", movement is logically forward in RTL
853 paragraphs, and logically backwards in LTR paragraphs.
854 * \li Syntax: word-left
855 * \li Origin: dov, 28 Oct 2007
858 { LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
860 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT_SELECT
861 * \li Action: Moves the cursor to the next beginning of a word "on the left",
862 adding *logically* traversed text to the selection.
863 * \li Notion: See also #LFUN_WORD_LEFT for exact details of the movement.
864 * \li Syntax: word-left-select
865 * \li Origin: dov, 28 Oct 2007
868 { LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit },
870 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT
871 * \li Action: Moves the cursor to the next beginning of a word "on the right".
872 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
873 "right" key is pressed. Generally, it moves the cursor to the
874 next beginning of a word on the right. However, in Bidi text
875 this become slightly more complicated, and there are different
876 modes of cursor movement. In "visual mode", this moves right,
877 plain and simple. In "logical mode", movement is logically
878 forward in LTR paragraphs, and logically backwards in RTL
880 * \li Syntax: word-right
881 * \li Origin: dov, 28 Oct 2007
884 { LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit },
886 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT_SELECT
887 * \li Action: Moves the cursor to the next beginning of a word "on the right",
888 adding *logically* traversed text to the selection.
889 * \li Notion: See also #LFUN_WORD_RIGHT for exact details of the movement.
890 * \li Syntax: word-right-select
891 * \li Origin: dov, 28 Oct 2007
894 { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
896 * \var lyx::FuncCode lyx::LFUN_WORD_SELECT
897 * \li Action: Puts the word where the cursor stands into the selection.
898 * \li Syntax: word-select
899 * \li Author: Andre, 11 Sep 2002
902 { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
904 * \var lyx::FuncCode lyx::LFUN_WORD_CAPITALIZE
905 * \li Action: Capitalizes the words in the selection (i.e. the first letters)
906 or the letter on the cursor position.
907 * \li Syntax: word-capitalize
910 { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
912 * \var lyx::FuncCode lyx::LFUN_WORD_UPCASE
913 * \li Action: Change the words in the selection or from the cursor position
914 to the end of word to the upper case.
915 * \li Syntax: word-upcase
918 { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
920 * \var lyx::FuncCode lyx::LFUN_WORD_LOWCASE
921 * \li Action: Change the words in the selection or from the cursor position
922 to the end of word to the lower case.
923 * \li Syntax: word-lowcase
926 { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
928 * \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
929 * \li Action: Look up thesaurus entries with respect to the word under the cursor.
930 * \li Syntax: thesaurus-entry
931 * \li Origin: Levon, 20 Jul 2001
934 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
936 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN
937 * \li Action: Move the cursor to the beginning of the document.
938 * \li Syntax: buffer-begin
941 { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
943 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN_SELECT
944 * \li Action: Move the cursor to the beginning of the document adding the
945 traversed text to the selection.
946 * \li Syntax: buffer-begin-select
949 { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
951 * \var lyx::FuncCode lyx::LFUN_BUFFER_END
952 * \li Action: Move the cursor to the end of the document.
953 * \li Syntax: buffer-end
956 { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
958 * \var lyx::FuncCode lyx::LFUN_BUFFER_END_SELECT
959 * \li Action: Move the cursor to the end of the document adding the
960 traversed text to the selection.
961 * \li Syntax: buffer-end-select
964 { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
967 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN
968 * \li Action: Move the cursor to the begining of the (screen) line.
969 * \li Syntax: line-begin
972 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
974 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN_SELECT
975 * \li Action: Move the cursor to the beginning of the (screen) line adding the
976 traversed text to the selection.
977 * \li Syntax: line-begin-select
980 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
982 * \var lyx::FuncCode lyx::LFUN_LINE_END
983 * \li Action: Move the cursor to the end of the (screen) line.
984 * \li Syntax: line-end
987 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
989 * \var lyx::FuncCode lyx::LFUN_LINE_END_SELECT
990 * \li Action: Move the cursor to the end of the (screen) line adding the
991 traversed text to the selection.
992 * \li Syntax: line-end-select
995 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
997 * \var lyx::FuncCode lyx::LFUN_LINE_DELETE
998 * \li Action: Deletes the letters to the end of the (screen) line or
999 deletes the selection.
1000 * \li Syntax: line-delete-forward
1003 { LFUN_LINE_DELETE, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
1005 * \var lyx::FuncCode lyx::LFUN_COPY
1006 * \li Action: Copies to the clipboard the last edit.
1010 { LFUN_COPY, "copy", ReadOnly, Edit },
1012 * \var lyx::FuncCode lyx::LFUN_CUT
1013 * \li Action: Cuts to the clipboard.
1017 { LFUN_CUT, "cut", Noop, Edit },
1019 * \var lyx::FuncCode lyx::LFUN_PASTE
1020 * \li Action: Pastes material from the active clipboard.
1021 * \li Syntax: paste [<TYPE>]
1022 * \li Params: <TYPE>: pdf|png|jpeg|linkback
1025 { LFUN_PASTE, "paste", Noop, Edit },
1027 * \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE
1028 * \li Action: Pastes text from the active clipboard.
1029 * \li Syntax: clipboard-paste [<ARG>]
1030 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1031 * \li Origin: baum, 10 Jul 2006
1034 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
1036 * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
1037 * \li Action: Pastes the currently text selected text.
1038 * \li Notion: Primary selection mechanism is linux-only thing.
1039 * \li Syntax: primary-selection-paste [<ARG>]
1040 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1043 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
1045 * \var lyx::FuncCode lyx::LFUN_UNDO
1046 * \li Action: Undoes the last edit.
1050 { LFUN_UNDO, "undo", Noop, Edit },
1052 * \var lyx::FuncCode lyx::LFUN_REDO
1053 * \li Action: Redoes the last thing undone.
1057 { LFUN_REDO, "redo", Noop, Edit },
1059 * \var lyx::FuncCode lyx::LFUN_REPEAT
1060 * \li Action: Repeat the given command.
1061 * \li Syntax: repeat <COUNT> <LFUN-COMMAND>
1062 * \li Author: poenitz, 27 Oct 2003
1065 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
1067 * \var lyx::FuncCode lyx::LFUN_CHARS_TRANSPOSE
1068 * \li Action: Transposes the character at the cursor with the one before it.
1069 * \li Syntax: chars-transpose
1070 * \li Author: Lgb, 25 Apr 2001
1073 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
1076 * \var lyx::FuncCode lyx::LFUN_DEPTH_DECREMENT
1077 * \li Action: Decrease the nesting depth of the (selected) paragraph(s)
1079 * \li Syntax: depth-decrement
1082 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
1084 * \var lyx::FuncCode lyx::LFUN_DEPTH_INCREMENT
1085 * \li Action: Increase the nesting depth of the (selected) paragraph(s)
1087 * \li Syntax: depth-increment
1090 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
1093 * \var lyx::FuncCode lyx::LFUN_FONT_BOLD
1094 * \li Action: Toggles the bold font (selection-wise).
1095 * \li Syntax: font-bold
1098 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
1100 * \var lyx::FuncCode lyx::LFUN_FONT_TYPEWRITER
1101 * \li Action: Toggles the typewriter family font (selection-wise).
1102 * \li Syntax: font-typewriter
1105 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
1107 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERLINE
1108 * \li Action: Toggles underline in the font (selection-wise).
1109 * \li Syntax: font-underline
1112 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
1114 * \var lyx::FuncCode lyx::LFUN_FONT_EMPH
1115 * \li Action: Toggles the emphasis font style (selection-wise).
1116 * \li Syntax: font-emph
1119 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
1121 * \var lyx::FuncCode lyx::LFUN_FONT_NOUN
1122 * \li Action: Toggles Noun text style font (selection-wise).
1123 * \li Syntax: font-noun
1126 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
1128 * \var lyx::FuncCode lyx::LFUN_FONT_ROMAN
1129 * \li Action: Toggles Roman family font (selection-wise).
1130 * \li Syntax: font-roman
1133 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
1135 * \var lyx::FuncCode lyx::LFUN_FONT_SANS
1136 * \li Action: Toggles Sans Serif family font (selection-wise).
1137 * \li Syntax: font-sans
1140 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
1142 * \var lyx::FuncCode lyx::LFUN_FONT_FRAK
1143 * \li Action: Toggles Fraktur family font (math-mode, selection-wise).
1144 * \li Syntax: font-frak
1145 * \li Origin: vermeer, 10 Jan 2002
1148 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
1150 * \var lyx::FuncCode lyx::LFUN_FONT_ITAL
1151 * \li Action: Toggles Italics font shape (math-mode, selection-wise).
1152 * \li Syntax: font-ital
1153 * \li Origin: vermeer, 10 Jan 2002
1156 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
1158 * \var lyx::FuncCode lyx::LFUN_FONT_DEFAULT
1159 * \li Action: Reverts the settings of the font to the default values (selection-wise).
1160 * \li Syntax: font-default
1163 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
1165 * \var lyx::FuncCode lyx::LFUN_FONT_SIZE
1166 * \li Action: Sets font size according to lyx format string.
1167 * \li Syntax: font-size <SIZE>
1168 * \li Params: <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|
1169 largest|huge|giant|increase|decrease|default
1172 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
1174 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_APPLY
1175 * \li Action: Toggle user-defined (=last-time used) text style.
1176 * \li Notion: This style is set via #LFUN_TEXTSTYLE_UPDATE, which is
1177 automatically trigerred when using Text Style dialog.
1178 * \li Syntax: textstyle-apply
1179 * \li Origin: leeming, 12 Mar 2003
1182 { LFUN_TEXTSTYLE_APPLY, "textstyle-apply", Noop, Layout },
1184 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_UPDATE
1185 * \li Action: Apply text style and update the settings to be used by #LFUN_TEXTSTYLE_APPLY.
1186 * \li Syntax: textstyle-update <FONT_INFO>
1187 * \li Params: <FONT_INFO>: specifies font atributes, e.g. family, series, shape,
1188 size, emph, noun, underbar, number, color, language,
1190 Use lyx -dbg action for exact syntax of text-style
1192 * \li Origin: leeming, 12 Mar 2003
1195 { LFUN_TEXTSTYLE_UPDATE, "textstyle-update", Noop, Layout },
1197 * \var lyx::FuncCode lyx::LFUN_SCREEN_FONT_UPDATE
1198 * \li Action: Update fonts and its metrics.
1199 * \li Notion: Automatically called after zoom, dpi, font names, or norm change.
1200 * \li Syntax: screen-font-update
1201 * \li Origin: ARRae, 13 Aug 2000
1204 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
1206 * \var lyx::FuncCode lyx::LFUN_FONT_STATE
1207 * \li Action: Returns the info about the current font.
1208 * \li Syntax: font-state
1211 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
1214 * \var lyx::FuncCode lyx::LFUN_CITATION_INSERT
1215 * \li Action: Inserts citation from loaded citation database.
1216 * \li Syntax: citation-insert [<KEY>[|<TEXT_BEFORE>]]
1217 * \li Params: <KEY>: Citation (shortcut listed in available citations). \n
1218 <TEXT_BEFORE>: text which should appear before citation.
1219 * \li Origin: AAS, 97-02-23
1222 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
1224 * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_ADD
1225 * \li Action: Adds database, which will be used for bibtex citations.
1226 * \li Notion: Databases are added to the first BibTeX inset
1227 (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
1228 * \li Syntax: bibtex-database-add <DATABASE-NAME>
1229 * \li Origin: Ale, 30 May 1997
1232 { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit },
1234 * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_DEL
1235 * \li Action: Adds database, which will be used for bibtex citations.
1236 * \li Notion: Databases are deleted from the first BibTeX inset
1237 (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
1238 * \li Syntax: bibtex-database-del <DATABASE-NAME>
1239 * \li Origin: Ale, 30 May 1997
1242 { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
1245 * \var lyx::FuncCode lyx::LFUN_LAYOUT
1246 * \li Action: Sets the layout (that is, environment) for the current paragraph.
1247 * \li Syntax: layout <LAYOUT>
1248 * \li Params: <LAYOUT>: the layout to use
1251 { LFUN_LAYOUT, "layout", Noop, Layout },
1253 * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH
1254 * \li Action: Launches the paragraph settings dialog.
1255 * \li Syntax: layout-paragraph
1258 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
1260 * \var lyx::FuncCode lyx::LFUN_LAYOUT_TABULAR
1261 * \li Action: Launches the tabular settings dialog.
1262 * \li Syntax: layout-tabular
1263 * \li Origin: Jug, 31 Jul 2000
1266 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
1268 * \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE
1269 * \li Action: Displays list of layout choices.
1270 * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
1271 dropbox allowing for choice of layout.
1272 * \li Syntax: drop-layouts-choice
1275 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
1277 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
1278 * \li Action: Clears the module list.
1279 * \li Notion: Clears the list of included modules for the current buffer.
1280 * \li Syntax: layout-modules-clear
1281 * \li Origin: rgh, 25 August 2007
1284 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", Noop, Layout },
1286 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULE_ADD
1287 * \li Action: Adds a module.
1288 * \li Notion: Adds a module to the list of included modules for the current buffer.
1289 * \li Syntax: layout-module-add <MODULE>
1290 * \li Params: <MODULE>: the module to be added
1291 * \li Origin: rgh, 25 August 2007
1294 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", Noop, Layout },
1296 * \var lyx::FuncCode lyx::LFUN_LAYOUT_RELOAD
1297 * \li Action: Reloads layout information.
1298 * \li Notion: Reloads all layout information for the current buffer from disk, thus
1299 recognizing any changes that have been made to layout files on the fly.
1300 This is intended to be used only by layout developers and should not be
1301 used when one is trying to do actual work.
1302 * \li Syntax: layout-reload
1303 * \li Origin: rgh, 3 September 2007
1306 { LFUN_LAYOUT_RELOAD, "layout-reload", Noop, Layout },
1308 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
1309 * \li Action: Sets the text class for the current buffer.
1310 * \li Syntax: textclass-apply <TEXTCLASS>
1311 * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
1312 the filename, minus the ".layout" extension.
1315 { LFUN_TEXTCLASS_APPLY, "textclass-apply", Noop, Layout },
1317 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
1318 * \li Action: Loads information for a textclass from disk.
1319 * \li Syntax: textclass-load <TEXTCLASS>
1320 * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
1321 the filename, minus the ".layout" extension.
1324 { LFUN_TEXTCLASS_LOAD, "textclass-load", Noop, Layout },
1327 * \var lyx::FuncCode lyx::LFUN_MARK_OFF
1328 * \li Action: Disable selecting of text-region.
1329 * \li Syntax: mark-off
1332 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
1334 * \var lyx::FuncCode lyx::LFUN_MARK_ON
1335 * \li Action: Enable selecting of text-region.
1336 * \li Notion: After enabling you can simply move arrow keys to get selected region.
1337 * \li Syntax: mark-on
1340 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
1342 * \var lyx::FuncCode lyx::LFUN_MARK_TOGGLE
1343 * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
1344 * \li Syntax: mark-toggle
1345 * \li Origin: poenitz, May 5 2006
1348 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
1351 * \var lyx::FuncCode lyx::LFUN_MATH_DELIM
1352 * \li Action: Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
1353 * \li Syntax: math-delim [<LEFT>] [<RIGHT>]
1354 * \li Params: <LEFT/RIGHT>: Delimiters to be used. Each delimiter can be specified by
1355 either a LaTeX name or a valid character.
1356 ( is the default letter.
1357 * \li Sample: math-delim { rangle
1358 * \li Origin: Alejandro, 18 Jun 1996
1361 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
1363 * \var lyx::FuncCode lyx::LFUN_MATH_BIGDELIM
1364 * \li Action: Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
1365 * \li Syntax: math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
1366 * \li Params: <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r \n
1367 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
1368 * \li Sample: math-bigdelim "Bigl" "\Downarrow" "Bigr" "\}"
1369 * \li Origin: Enrico & Georg, 7 May 2006
1372 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
1374 * \var lyx::FuncCode lyx::LFUN_MATH_DISPLAY
1375 * \li Action: Creates a new displayed equation in text mode.
1376 Toggles inlined/display formula in math mode.
1377 * \li Syntax: math-display [<ARG>]
1378 * \li Params: <ARG>: this argument will be passed to #LFUN_MATH_INSERT when creating
1379 new equation from the text mode.
1380 * \li Origin: Alejandro, 18 Jun 1996
1383 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
1385 * \var lyx::FuncCode lyx::LFUN_MATH_INSERT
1386 * \li Action: Inserts math objects and symbols.
1387 * \li Syntax: math-insert <ARG>
1388 * \li Params: <ARG>: Symbol or LaTeX code to be inserted.
1391 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
1393 * \var lyx::FuncCode lyx::LFUN_MATH_SUBSCRIPT
1394 * \li Action: Enters subscript expression in math expression.
1395 * \li Syntax: math-subscript
1396 * \li Origin: vermeer, 12 Dec 2001
1399 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
1401 * \var lyx::FuncCode lyx::LFUN_MATH_SUPERSCRIPT
1402 * \li Action: Enters subscript expression in math expression.
1403 * \li Syntax: math-superscript
1404 * \li Origin: vermeer, 12 Dec 2001
1407 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
1409 * \var lyx::FuncCode lyx::LFUN_MATH_LIMITS
1410 * \li Action: Toggles the position of the limits from above/below to the right
1411 side an vice versa in integral symbol, a limit, a summation, etc.
1412 * \li Notion: Put the cursor before the symbol with the limits and then invoke
1414 * \li Syntax: math-limits [<STATE>]
1415 * \li Params: <STATE>: limits|nolimits
1418 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
1420 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO
1421 * \li Action: Inserts a math macro definition at the cursor position in the text.
1422 * \li Syntax: math-macro <NAME> [<NARGS>] [def]
1423 * \li Params: <NAME>: The name of the macro, e.g. "mymacro".
1424 <NARGS>: The number of parameters of the macro. Default is 0.
1425 "def": Has no effect anymore, just for compatibility with former LyX versions.
1426 * \li Origin: ale, 10 May 1997; sts, 21 Dec 2007
1429 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
1431 * \var lyx::FuncCode lyx::LFUN_MATH_MUTATE
1432 * \li Action: Mutates the type of math inset to the newly selected one.
1433 * \li Syntax: math-mutate <TYPE>
1434 * \li Params: <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
1435 multline|gather|flalign
1436 * \li Origin: Andre', 23 May 2001
1439 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
1441 * \var lyx::FuncCode lyx::LFUN_MATH_SPACE
1442 * \li Action: Inserts space into math expression.
1443 * \li Notion: Use spacebar after entering this space to change type of space.
1444 * \li Syntax: math-space [<TYPE>]
1445 * \li Params: <TYPE>: negative spaces: !|negmedspace|negthickspace \n
1446 positive spaces: ,|:|;|quad|qquad \n
1447 "," used by default.
1448 * \li Origin: Andre', 25 Jul 2001; ps, 16 Jun 2008
1451 { LFUN_MATH_SPACE, "math-space", Noop, Math },
1453 * \var lyx::FuncCode lyx::LFUN_MATH_MATRIX
1454 * \li Action: Inserts a matrix.
1455 * \li Syntax: math-matrix <COLS> <ROWS> [<ALIGN>]
1456 * \li Params: <ALIGN>: Alignment is a word composed of the vertical alignment
1457 (b, c or t) (i.e. 1 char) and the horizontal alignments
1458 (l, c or r) (i.e. <COL> chars).
1459 * \li Sample: math-matrix 3 3 bccc
1462 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
1464 * \var lyx::FuncCode lyx::LFUN_MATH_MODE
1465 * \li Action: In text mode enters math mode (i.e. puts math insets on the current
1466 cursor position), in math mode enters text mode inside math expression.
1467 * \li Notion: If there is some selected text, it puts the text inside created math box.
1468 * \li Syntax: math-mode [<ARG>]
1469 * \li Params: <ARG>: eventual argument (LaTeX code) is passed to #LFUN_MATH_INSERT .
1470 * \li Origin: Alejandro, 4 Jun 1996
1473 { LFUN_MATH_MODE, "math-mode", Noop, Math },
1475 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
1476 * \li Action: Toggles numbering of the current formula line.
1477 * \li Notion: Must be in display formula mode.
1478 * \li Syntax: math-number-line-toggle
1479 * \li Origin: Alejandro, 18 Jun 1996
1482 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
1484 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
1485 * \li Action: Toggles numbering/labeling of the current formula.
1486 * \li Notion: Must be in display formula mode.
1487 * \li Syntax: math-number-toggle
1488 * \li Origin: Alejandro, 4 Jun 1996
1491 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
1493 * \var lyx::FuncCode lyx::LFUN_MATH_EXTERN
1494 * \li Action: Calls external program and passes the current expression/equation
1495 as an argument for the calculation in the format appropriate to the
1497 * \li Notion: Selection can be used to determine the input for the external program.
1498 * \li Syntax: math-extern <LANG> [<COMMAND>]
1499 * \li Params: <LANG>: octave|maxima|maple|mathematica|script \n
1500 where "script" stands fot the external script (normalized
1501 expression will be passed)
1502 * \li Origin: Andre', 24 Apr 2001
1503 * \li Sample: math-extern maple simplify
1506 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
1508 * \var lyx::FuncCode lyx::LFUN_MATH_SIZE
1509 * \li Action: Changes arbitrarily the size used by math fonts inside a context.
1510 * \li Notion: Provides an interface to the LaTeX math mode font size commands.
1511 * \li Syntax: math-size <STYLE>
1512 *\ li Params: <STYLE>: \displaystyle|\textstyle|\scriptstyle|\scriptscriptstyle
1513 * \li Origin: Alejandro, 15 Aug 1996; ps, 14 Jun 2008
1516 { LFUN_MATH_SIZE, "math-size", Noop, Math },
1518 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
1519 * \li Action: Unfold a Math Macro.
1520 * \li Notion: Unfold the Math Macro the cursor is in, i.e.
1522 * \li Syntax: math-macro-unfold
1523 * \li Origin: sts, 06 January 2008
1526 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
1528 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
1529 * \li Action: Fold a Math Macro.
1530 * \li Notion: Fold the Math Macro the cursor is in if it was
1531 unfolded, i.e. displayed as \foo before.
1532 * \li Syntax: math-macro-fold
1533 * \li Origin: sts, 06 January 2008
1536 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
1538 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
1539 * \li Action: Add a parameter.
1540 * \li Notion: Add a parameter to a Math Macro.
1541 * \li Params: <NUM>: The number of the parameter behind which the new one
1542 will be added (1 for the first, i.e. use 0 for add a
1543 parameter at the left), defaults to the last one.
1544 * \li Syntax: math-macro-add-param <NUM>
1545 * \li Origin: sts, 06 January 2008
1548 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
1550 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
1551 * \li Action: Remove the last parameter.
1552 * \li Notion: Remove the last parameter of a Math Macro and
1553 remove its value in all instances of the macro
1555 * \li Params: <NUM>: The number of the parameter to be deleted (1 for
1556 the first), defaults to the last one.
1557 * \li Syntax: math-macro-remove-param <NUM>
1558 * \li Origin: sts, 06 January 2008
1561 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
1563 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
1564 * \li Action: Append a greedy parameter.
1565 * \li Notion: Append a greedy parameter to a Math Macro which
1566 eats the following mathed cell in every instance of
1567 the macro in the buffer.
1568 * \li Syntax: math-macro-append-greedy-param
1569 * \li Origin: sts, 06 January 2008
1572 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
1574 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
1575 * \li Action: Remove a greedy parameter.
1576 * \li Notion: Remove a greedy parameter of a Math Macro and spit
1577 out the values of it in every instance of the macro
1578 in the buffer. If it is an optional parameter the [valud]
1580 * \li Syntax: math-macro-remove-greedy-param
1581 * \li Origin: sts, 06 January 2008
1584 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
1586 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
1587 * \li Action: Make a parameter optional.
1588 * \li Notion: Turn the first non-optional parameter of a Math Macro
1589 into an optional parameter with a default value.
1590 * \li Syntax: math-macro-make-optional
1591 * \li Origin: sts, 06 January 2008
1594 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
1596 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
1597 * \li Action: Make a parameter non-optional.
1598 * \li Notion: Turn the last optional parameter of a Math Macro
1599 into a non-optional parameter. The default value is
1600 remembered to be reused later if the user changes his mind.
1601 * \li Syntax: math-macro-make-nonoptional
1602 * \li Origin: sts, 06 January 2008
1605 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
1607 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
1608 * \li Action: Add an optional parameter.
1609 * \li Notion: Insert an optional parameter just behind the
1610 already existing optional parameters.
1611 * \li Syntax: math-macro-add-optional-param
1612 * \li Origin: sts, 06 January 2008
1615 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
1617 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
1618 * \li Action: Remove the last optional parameter.
1619 * \li Notion: Remove the last optional parameter of a Math Macro and
1620 remove it in all the instances of the macro in the buffer.
1621 * \li Syntax: math-macro-remove-optional-param
1622 * \li Origin: sts, 06 January 2008
1625 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
1627 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
1628 * \li Action: Add a greedy optional parameter.
1629 * \li Notion: Add a greedy optional parameter which eats the value
1630 from the following cells in mathed which are in the [value]
1632 * \li Syntax: math-macro-add-greedy-optional-param
1633 * \li Origin: sts, 06 January 2008
1636 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
1638 * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
1639 * \li Action: Only active in Math Macro definition.
1640 * \li Notion: Dummy function which is only active in a Math Macro definition.
1641 It's used to toggle the Math Macro toolbar if the cursor moves
1642 into a Math Macro definition.
1643 * \li Syntax: in-mathmacrotemplate
1644 * \li Origin: sts, 06 January 2008
1647 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
1650 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
1651 * \li Action: Moves the current paragraph downwards in the document.
1652 * \li Syntax: paragraph-move-down
1653 * \li Origin: Edwin, 8 Apr 2006
1656 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
1658 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
1659 * \li Action: Moves the current paragraph upwards in the document.
1660 * \li Syntax: paragraph-move-up
1661 * \li Origin: Edwin, 8 Apr 2006
1664 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
1667 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP
1668 * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1669 in upward direction.
1670 * \li Syntax: paragraph-up
1671 * \li Origin: Asger, 1 Oct 1996
1674 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
1676 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP_SELECT
1677 * \li Action: Move the cursor and select the text to the next paragraph (or
1678 begining of the current one) in upward direction.
1679 * \li Syntax: paragraph-up-select
1680 * \li Origin: Asger, 1 Oct 1996
1683 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
1685 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN
1686 * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1687 in downward direction.
1688 * \li Syntax: paragraph-down
1689 * \li Origin: Asger, 1 Oct 1996
1692 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
1694 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN_SELECT
1695 * \li Action: Move the cursor and select the text to the next paragraph (or
1696 begining of the current one) in downward direction.
1697 * \li Syntax: paragraph-down-select
1698 * \li Origin: Asger, 1 Oct 1996
1701 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
1703 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
1704 * \li Action: Jump to a paragraph given by its id number and optionally the
1705 desired position within the paragraph.
1706 * \li Notion: Note that id number of paragraph is not the sequential number of paragraph
1707 seen on the screen. Moreover the id is unique for all opened buffers (documents).
1708 * \li Syntax: paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
1709 * \li Params: <PAR_ID_NUMBER>: paragraph id
1710 <POSITION_IN_PAR>: desired position within the paragraph
1711 * \li Origin: Dekel, 26 Aug 2000
1714 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly, Edit },
1716 * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1717 * \li Action: Breaks the current paragraph at the current location.
1718 * \li Syntax: break-paragraph
1721 { LFUN_PARAGRAPH_SPACING, "paragraph-spacing", Noop, Edit },
1723 * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1724 * \li Action: Breaks the current paragraph at the current location.
1725 * \li Notion: Removes the selection.
1726 * \li Syntax: break-paragraph [<LAYOUT>]
1727 * \li Params: <LAYOUT>: "inverse" - decreases depth by one (or change layout
1728 to default layout) when the cursor is at the end of
1732 { LFUN_BREAK_PARAGRAPH, "break-paragraph", Noop, Edit },
1734 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
1735 * \li Action: Change paragraph settings.
1736 * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
1737 This function only modifies, and does not override, existing settings.
1738 Note that the "leftindent" indent setting is deprecated.
1739 * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
1740 * \li Params: <INDENT>: \\noindent|\\indent|\\indent-toggle|\\leftindent LENGTH\n
1741 <SPACING>: \\paragraph_spacing default|single|onehalf|double|other\n
1742 <ALIGN>: \\align block|left|right|center|default\n
1743 <OTHERS>: \\labelwidthstring WIDTH|\\start_of_appendix\n
1744 * \li Origin: rgh, Aug 15 2007
1747 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
1749 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
1750 * \li Action: Change paragraph settings.
1751 * \li Notion: Overwrite all nonspecified settings to the default ones.
1752 Use paragraph-params lfun if you don't want to overwrite others settings.
1753 * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
1754 * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
1755 * \li Origin: leeming, 30 Mar 2004
1758 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
1760 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UPDATE
1761 * \li Action: Updates the values inside the paragraph dialog from the paragraph.
1762 * \li Notion: This is internal LFUN, not to be used by users. Called internally
1763 by #LFUN_DIALOG_UPDATE.
1764 * \li Origin: leeming, 13 Mar 2003
1767 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
1770 * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
1771 * \li Action: Move the current group in the upward direction in the
1772 structure of the document.
1773 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1774 the whole substructure of the group.
1775 * \li Syntax: outline-up
1776 * \li Origin: Vermeer, 23 Mar 2006
1779 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
1781 * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
1782 * \li Action: Move the current group in the downward direction in the
1783 structure of the document.
1784 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1785 the whole substructure of the group.
1786 * \li Syntax: outline-down
1787 * \li Origin: Vermeer, 23 Mar 2006
1790 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
1792 * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
1793 * \li Action: Moves the current group in the downward direction in the
1794 hierarchy of the document structure.
1795 * \li Notion: Part -> Chapter -> Section -> etc.
1796 * \li Syntax: outline-in
1797 * \li Origin: Vermeer, 23 Mar 2006
1800 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
1802 * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
1803 * \li Action: Moves the current group in the upward direction in the
1804 hierarchy of the document structure.
1805 * \li Notion: Part <- Chapter <- Section <- etc.
1806 * \li Syntax: outline-out
1807 * \li Origin: Vermeer, 23 Mar 2006
1810 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
1812 * \var lyx::FuncCode lyx::LFUN_INSET_EDIT
1813 * \li Action: Edit the inset at cursor with an external application,
1814 * if one is attributed.
1815 * \li Syntax: inset-edit [<INSET_PARAMS>]
1816 * \li Params: <INSET_PARAMS>: Parameters for the inset.
1817 Currently only the filename will be considered.
1818 * \li Origin: JSpitzm, 27 Apr 2006
1821 { LFUN_INSET_EDIT, "inset-edit", Noop, Edit },
1824 * \var lyx::FuncCode lyx::LFUN_TABULAR_INSERT
1825 * \li Action: Inserts table into the document.
1826 * \li Syntax: tabular-insert [<ROWS> <COLUMNS>]
1827 * \li Params: In case no arguments are given show insert dialog.
1828 * \li Origin: Jug, 12 Apr 2000
1831 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
1833 * \var lyx::FuncCode lyx::LFUN_TABULAR_FEATURE
1834 * \li Action: Sets various features to the table/cell on the current cursor position.
1835 * \li Notion: Various math-environment features are handled here as well, e.g.
1836 add-vline-left/right for Grid/Cases environment
1837 * \li Syntax: tabular-feature <FEATURE> [<ARG>]
1838 * \li Params: <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|copy-column|
1839 toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
1840 align-left|align-right|align-center|align-block|valign-top|valign-bottom|
1841 valign-middle|m-align-left|m-align-right|m-align-center|m-valign-top|
1842 m-valign-bottom|m-valign-middle|multicolumn|set-all-lines|unset-all-lines|
1843 set-longtabular|unset-longtabular|set-pwidth|set-mpwidth|
1844 set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|
1845 set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|
1846 unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|
1847 set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
1848 set-special-column|set-special-multi|set-booktabs|unset-booktabs|
1849 set-top-space|set-bottom-space|set-interline-space|set-border-lines \n
1850 <ARG>: additional argument for some commands, use debug mode to explore its values.
1851 * \li Origin: Jug, 28 Jul 2000
1854 { LFUN_TABULAR_FEATURE, "tabular-feature", Noop, Edit },
1856 * \var lyx::FuncCode lyx::LFUN_CELL_BACKWARD
1857 * \li Action: Moves the cursor to the previous cell inside the table.
1858 * \li Syntax: cell-backward
1859 * \li Origin: Jug, 22 May 2000
1862 { LFUN_CELL_BACKWARD, "cell-backward", Noop, Edit },
1864 * \var lyx::FuncCode lyx::LFUN_CELL_FORWARD
1865 * \li Action: Moves the cursor to the next cell inside the table.
1866 * \li Syntax: cell-forward
1869 { LFUN_CELL_FORWARD, "cell-forward", Noop, Edit },
1871 * \var lyx::FuncCode lyx::LFUN_CELL_SPLIT
1872 * \li Action: Splits cell and shifts right part to the next cell (inside the math grid).
1873 * \li Syntax: cell-split
1874 * \li Origin: Ale, 15 May 1997
1877 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
1880 * \var lyx::FuncCode lyx::LFUN_VC_REGISTER
1881 * \li Action: Register the document as an file inside version control system (RCS, CVS).
1882 * \li Notion: File is registered inside cvs, svn or rcs repository acording to the existence
1883 of cvs/svn/rcs entries in the document's directory.
1884 See LyX Extended Manual (Version Control Chapter) for additional information. \n
1885 * \li Syntax: vc-register
1886 * \li Origin: Lgb, 1 Jul 1997
1889 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
1891 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_IN
1892 * \li Action: Checks-in/commits the changes of the registered file to the repository.
1893 * \li Notion: In RCS case this also unlocks the file.
1894 * \li Syntax: vc-check-in
1895 * \li Origin: Lgb, 1 Jul 1997
1898 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
1900 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_OUT
1901 * \li Action: Checks-out the document for edit (and locks it for RCS).
1902 * \li Notion: This is implemented only for RCS and SVN, not CVS.
1903 * \li Syntax: vc-check-out
1904 * \li Origin: Lgb, 1 Jul 1997
1907 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
1909 * \var lyx::FuncCode lyx::LFUN_VC_REVERT
1910 * \li Action: Reverts the document to the last check-in/commit in VCS.
1911 * \li Syntax: vc-revert
1912 * \li Origin: Lgb, 1 Jul 1997
1915 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
1917 * \var lyx::FuncCode lyx::LFUN_VC_UNDO_LAST
1918 * \li Action: Undo last check-in.
1919 * \li Notion: This is currently implemented only for RCS.
1920 * \li Syntax: vc-check-out
1921 * \li Origin: Lgb, 1 Jul 1997
1924 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
1927 * \var lyx::FuncCode lyx::LFUN_CHANGES_TRACK
1928 * \li Action: Toggles change tracking to on/off.
1929 * \li Syntax: changes-track
1930 * \li Origin: levon, 1 Oct 2002
1933 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
1935 * \var lyx::FuncCode lyx::LFUN_CHANGES_OUTPUT
1936 * \li Action: Toggles showing of change tracking in typesetted output.
1937 * \li Syntax: changes-output
1938 * \li Origin: jspitzm, 21 Jan 2005
1941 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
1943 * \var lyx::FuncCode lyx::LFUN_CHANGE_NEXT
1944 * \li Action: Moves the cursor to the position of the next change
1945 of the change tracking records.
1946 * \li Syntax: change-next
1947 * \li Origin: schmitt, 4 Oct 2006
1950 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
1952 * \var lyx::FuncCode lyx::LFUN_CHANGES_MERGE
1953 * \li Action: Open change tracking dialog for merging and moves the cursor
1954 to the position of the next change.
1955 * \li Syntax: changes-merge
1956 * \li Origin: Levon, 16 Oct 2002
1959 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
1961 * \var lyx::FuncCode lyx::LFUN_CHANGE_ACCEPT
1962 * \li Action: Accepts tracked change inside the selection.
1963 * \li Syntax: change-accept
1964 * \li Origin: Levon, 16 Oct 2002
1967 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
1969 * \var lyx::FuncCode lyx::LFUN_CHANGE_REJECT
1970 * \li Action: Rejects tracked change inside the selection.
1971 * \li Syntax: change-accept
1972 * \li Origin: Levon, 16 Oct 2002
1975 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
1977 * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_ACCEPT
1978 * \li Action: Accepts all tracked changes in the document.
1979 * \li Syntax: all-changes-accept
1980 * \li Origin: Levon, 16 Oct 2002
1983 { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
1985 * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_REJECT
1986 * \li Action: Rejects all tracked changes in the document.
1987 * \li Notion: Reject does not work recursively; the user may have to repeat the operation.
1988 * \li Syntax: all-changes-reject
1989 * \li Origin: Levon, 16 Oct 2002
1992 { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
1995 * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
1996 * \li Action: Apply data for an inset.
1997 * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
1998 be applied. This is either changed to #LFUN_INSET_MODIFY or
1999 #LFUN_INSET_INSERT depending on the context where it is called.
2000 * \li Syntax: inset-apply <ARGS>
2001 * \li Params: See #LFUN_INSET_INSERT .
2004 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
2006 * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE
2007 * \li Action: Dissolve the current inset into text.
2008 * \li Syntax: inset-dissolve [<INSET>]
2009 * \li Params: <INSET>: this can be used to make sure the right kind of inset
2010 is dissolved. For example "dissolve" entry in the charstyles
2011 sub-menu should only dissolve the charstyle inset, even if the
2012 cursor is inside several nested insets of different type.\n
2013 For values see #lyx::InsetLayout::lyxtype_ .
2014 * \li Author: JSpitz, 7 Aug 2006
2017 { LFUN_INSET_DISSOLVE, "inset-dissolve", Noop, Edit },
2019 * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
2020 * \li Action: Insert new inset (type given by the parameters).
2021 * \li Syntax: inset-insert <INSET> <ARGS>
2022 * \li Params: <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics|
2023 hyperlink|include|index|label|nomencl|vspace|ref|toc>\n
2024 <ARGS>: depends on the given inset. Use "lyx -dbg action" to
2026 * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
2027 where <label name> is the name of the referenced label and
2028 <Format> is one of the following: \n
2029 ref -- <reference> \n
2030 eqref -- (<reference>) \n
2031 pageref -- <page> \n
2032 vpageref -- on <page> \n
2033 vref -- <reference> on <page> \n
2034 prettyref -- Formatted reference
2037 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
2039 * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
2040 * \li Action: Modify existing inset.
2041 * \li Notion: Used for label, floats, listings, box, branch, external, wrap
2042 bibtex, ert, command, graphics, note, space, vspace, tabular,
2043 bibitem, inlude, ref insets.
2044 * \li Syntax: inset-modify <INSET> <ARGS>
2045 * \li Params: See #LFUN_INSET_INSERT for further details.
2048 { LFUN_INSET_MODIFY, "", Noop, Hidden },
2050 * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_MODIFY
2051 * \li Action: Modify the inset at cursor position, if there is one.
2052 * \li Notion: Used for label, floats, listings, box, branch, external, wrap
2053 bibtex, ert, command, graphics, note, space, vspace, tabular,
2054 bibitem, inlude, ref insets.
2055 * \li Syntax: next-inset-modify <INSET> <ARGS> or next-inset-modify changetype <TYPE>
2056 * \li Params: See #LFUN_INSET_INSERT for further details.
2057 * \li Origin: JSpitzm, 23 Mar 2008
2060 { LFUN_NEXT_INSET_MODIFY, "next-inset-modify", ReadOnly, Edit },
2062 * \var lyx::FuncCode lyx::LFUN_INSET_DIALOG_UPDATE
2063 * \li Action: Updates the values inside the dialog from the inset.
2064 * \li Notion: This is internal LFUN, not to be used by users. Called internally
2065 by #LFUN_DIALOG_UPDATE
2066 * \li Params: <DIALOG-NAME>
2067 * \li Origin: leeming, 25 Feb 2003
2070 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
2072 * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
2073 * \li Action: Open the inset's properties dialog.
2074 * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
2075 * \li Syntax: inset-settings <INSET>
2076 * \li Params: <INSET>: <box|branch|ert|float|listings|note|tabular|wrap>
2079 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly, Edit },
2081 * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_TOGGLE
2082 * \li Action: Toggles the inset at cursor position. For collapsables, this means it will
2083 be (un-)collapsed, in case of other insets, the editing widget (dialog) will
2084 be entered. Also cf. #LFUN_INSET_SETTINGS.
2085 * \li Notion: Used for label, floats, listings, box, branch, external, wrap
2086 bibtex, ert, command, graphics, note, space, vspace, tabular,
2087 bibitem, inlude, ref insets.
2088 * \li Syntax: next-inset-toggle <ARG>
2089 * \li Params: <ARG>: these are passed as arguments to #LFUN_INSET_TOGGLE .
2090 * \li Origin: leeming, 30 Mar 2004
2093 { LFUN_NEXT_INSET_TOGGLE, "next-inset-toggle", ReadOnly, Edit },
2095 * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
2096 * \li Action: Toggles the collapsable inset we are currently in.
2097 * \li Syntax: inset-toggle [<ARG>]
2098 * \li Params: <ARG>: <open|close|toggle|assign>. \n
2099 open/close/toggle are for collapsable insets. close can be currently used
2100 by #LFUN_NEXT_INSET_TOGGLE. toggle is used when no argument is given.\n
2101 assign is for branch inset.
2102 * \li Origin: lasgouttes, 19 Jul 2001
2105 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly, Hidden },
2107 * \var lyx::FuncCode lyx::LFUN_ALL_INSETS_TOGGLE
2108 * \li Action: Toggles (open/closes) all collapsable insets (of a given type) in the document.
2109 * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
2110 * \li Syntax: all-insets-toggle <STATE> <INSET>
2111 * \li Params: <STATE>: <toggle|open|close> default: toggle \n
2112 <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all insets \n
2113 * \li Origin: leeming, 30 Mar 2004
2116 { LFUN_ALL_INSETS_TOGGLE, "all-insets-toggle", ReadOnly, Edit },
2118 * \var lyx::FuncCode lyx::LFUN_GRAPHICS_GROUPS_UNIFY
2119 * \li Action: Unify all graphics insets with the one given as an parameter.
2120 * \li Notion: This is internally used for synchronize certain group of graphics insets.
2121 * \li Syntax: graphics-groups-unigfy <GRAPHICS_PARAMS>
2122 * \li Params: <GRAPHICS_PARAMS>: Parameters for graphics inset
2123 (syntax can be seen in .lyx files).
2124 * \li Origin: sanda, 6 May 2008
2127 { LFUN_GRAPHICS_GROUPS_UNIFY, "graphics-groups-unify", Argument, Edit },
2129 * \var lyx::FuncCode lyx::LFUN_SET_GRAPHICS_GROUP
2130 * \li Action: Set the group for the graphics inset on the cursor position.
2131 * \li Syntax: set-graphics-group [<GROUP>]
2132 * \li Params: <GROUP>: Id for an existing group. In case tthe Id is an empty string,
2133 the graphics inset is removed from the current group.
2134 * \li Origin: sanda, 6 May 2008
2137 { LFUN_SET_GRAPHICS_GROUP, "set-graphics-group", Noop, Edit },
2140 * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
2141 * \li Action: Moves the cursor out of the current slice, going forward.
2142 * \li Notion: Cursor movement within an inset may be different than cursor
2143 movement in the surrounding text. This action should be called
2144 automatically by the cursor movement within the inset, when
2145 movement within the inset has ceased (reached the end of the
2146 last paragraph, for example), in order to move correctly
2147 back into the surrounding text.
2150 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
2152 * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
2153 * \li Action: Moves the cursor out of the current slice, going backwards.
2154 * \li Notion: See also #LFUN_FINISHED_FORWARD.
2157 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
2159 * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
2160 * \li Action: Moves the cursor out of the current slice, going right.
2161 * \li Notion: See also #LFUN_FINISHED_FORWARD
2164 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
2166 * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
2167 * \li Action: Moves the cursor out of the current slice, going left.
2168 * \li Notion: See also #LFUN_FINISHED_FORWARD.
2171 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
2174 * \var lyx::FuncCode lyx::LFUN_LANGUAGE
2175 * \li Action: Set language from the current cursor position.
2176 * \li Syntax: language <LANG>
2177 * \li Params: <LANG>: Requested language. Look in lib/languages for
2179 * \li Origin: Dekel, 2 Mar 2000
2182 { LFUN_LANGUAGE, "language", Noop, Edit },
2185 * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
2186 * \li Action: Goto a label.
2187 * \li Syntax: label-goto [<LABEL>]
2188 * \li Params: <LABEL>: Requested label. If no label is given and refernce
2189 is on cursor position, Bookmark 0 is saved and
2190 cursor moves to the position of referenced label.
2191 * \li Origin: Ale, 6 Aug 1997
2194 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
2196 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT
2197 * \li Action: Inserts label to text or displayed formula.
2198 * \li Syntax: label-insert [<LABEL>]
2199 * \li Params: <LABEL>: Requested label. If no label is given dialog requesting
2200 name will be opened.
2203 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
2205 * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
2206 * \li Action: Go to the next label or cross-reference.
2207 * \li Syntax: reference-next
2208 * \li Origin: Dekel, 14 Jan 2001
2211 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
2214 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
2215 * \li Action: Goto a bookmark.
2216 * \li Notion: Moves the cursor to the numbered bookmark, opening the file
2217 if necessary. Note that bookmarsk are saved per-session, not
2219 * \li Syntax: bookmark-goto <NUMBER>
2220 * \li Params: <NUMBER>: the number of the bookmark to restore.
2221 * \li Origin: Dekel, 27 January 2001
2224 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
2226 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
2227 * \li Action: Save a bookmark.
2228 * \li Notion: Saves a numbered bookmark to the sessions file. The number
2229 must be between 1 and 9, inclusive. Note that bookmarks are
2230 saved per-session, not per file.
2231 * \li Syntax: bookmark-save <NUMBER>
2232 * \li Params: <NUMBER>: the number of the bookmark to save.
2233 * \li Origin: Dekel, 27 January 2001
2236 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
2238 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
2239 * \li Action: Clears the list of saved bookmarks.
2240 * \li Syntax: bookmark-clear
2241 * \li Origin: bpeng, 31 October 2006
2244 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
2247 * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
2248 * \li Action: Open the given help file according to the language setting.
2249 * \li Syntax: help-open <FILE>[.lyx]
2250 * \li Params: <FILE>: any document from (/usr/share/)doc directory.
2251 * \li Author: Jug, 27 Jun 1999
2254 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
2256 * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
2257 * \li Action: Terminates the current LyX instance.
2258 * \li Notion: Terminates the current LyX instance, asking whether to save
2259 modified documents, etc.
2260 * \li Syntax: lyx-quit
2263 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
2265 * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
2266 * \li Action: Toggles visibility of a given toolbar between on/off/auto.
2267 * \li Notion: Skiping "auto" when allowauto is false.
2268 * \li Syntax: toolbar-toggle <NAME> [allowauto]
2269 * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|
2270 minibuffer|review|view/update|math_panels
2271 * \li Origin: Edwin, 21 May 2007
2274 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
2276 * \var lyx::FuncCode lyx::LFUN_MENU_OPEN
2277 * \li Action: Opens the menu given by its name.
2278 * \li Syntax: menu-open <NAME>
2279 * \li Params: <NAME>: menu name. See various .inc files in lib/ui for candidates.
2282 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
2284 * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
2285 * \li Action: Various UI visibility-toggling actions.
2286 * \li Syntax: ui-toggle <statusbar|menubar|frame|fullscreen>
2287 * \li Params: statusbar : Toggle visibility of the statusbar.\n
2288 menubar : Toggle visibility of the menubar.\n
2289 scrollbar : Toggle visibility of the scrollbar.\n
2290 frame : Toggle visibility of the frames around editing window.\n
2291 fullscreen : Toggle fullscreen mode. This also covers calling the
2292 previous functions. However #LFUN_TOOLBAR_TOGGLE for the
2293 custom tweaks of the toolbars should be used.
2294 * \li Origin: ps, 9 Feb 2007
2297 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
2300 * \var lyx::FuncCode lyx::WINDOW_NEW
2301 * \li Action: Creates new empty LyX window.
2302 * \li Notion: Already opened documents from the previous window can be found under View menu.
2303 * \li Syntax: window-new [<GEOMETRY>]
2304 * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently
2305 accepted only on Windows platform.
2306 * \li Origin: Abdel, 21 Oct 2006
2309 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
2311 * \var lyx::FuncCode lyx::LFUN_WINDOW_CLOSE
2312 * \li Action: Closes the current LyX window.
2313 * \li Syntax: window-close
2314 * \li Origin: Abdel, 23 Oct 2006
2317 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
2320 * \var lyx::FuncCode lyx::LFUN_SPLIT_VIEW
2321 * \li Action: Creates another split view of current buffer.
2322 * \li Notion: All split views act in the same way indpendently.
2323 * \li Syntax: split-view <vertical|horizontal>
2324 * \li Params: horizontal : The work areas are laid out side by side.\n
2325 vertical : The work areas laid out vertically.\n
2326 * \li Origin: abdel, 20 Feb 2008
2329 { LFUN_SPLIT_VIEW, "split-view", ReadOnly, Buffer },
2332 * \var lyx::FuncCode lyx::LFUN_CLOSE_TAB_GROUP
2333 * \li Action: Close the current tab group.
2334 * \li Notion: This only closes the work areas, not the buffer themselves.
2335 The still opened buffers can be visualized in another tab group.
2336 * \li Syntax: close-tab-group
2337 * \li Origin: abdel, 21 Feb 2008
2340 { LFUN_CLOSE_TAB_GROUP, "close-tab-group", ReadOnly, Buffer },
2342 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW
2343 * \li Action: Shows hidden dialog or create new one for a given function/inset settings etc.
2344 * \li Syntax: dialog-show <NAME> [<DATA>]
2345 * \li Params: <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
2346 document|errorlist|ert|external|file|findreplace|float|graphics|
2347 include|index|info|nomenclature|label|log|mathdelimiter|mathmatrix|
2348 note|paragraph|prefs|print|ref|sendto|space|spellchecker|symbols|
2349 tabular|tabularcreate|thesaurus|texinfo|toc|href|view-source|vspace|
2350 wrap|listings|<SPECIAL> \n
2351 <SPECIAL>: latexlog|vclog \n
2352 <DATA>: data, usually settings for the given dialog. Use debug mode for the
2354 * \li Origin: leeming, 17 Jun 2003
2357 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
2359 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW_NEW_INSET
2360 * \li Action: Shows hidden dialog or create new one for a given inset settings etc.
2361 * \li Notion: Internally uses #LFUN_DIALOG_SHOW with processed data for a given inset.
2362 * \li Syntax: dialog-show-new-inset <NAME> [<DATA>]
2363 * \li Params: See #LFUN_DIALOG_SHOW .
2364 * \li Origin: leeming, 25 Feb 2003
2367 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
2369 * \var lyx::FuncCode lyx::LFUN_DIALOG_UPDATE
2370 * \li Action: Updates the dialog values from the inset/paragraph/document.
2371 * \li Syntax: dialog-update <NAME>
2372 * \li Params: <NAME>: paragraph|prefs|<INSET> \n
2374 * \li Origin: leeming, 25 Feb 2003
2377 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
2379 * \var lyx::FuncCode lyx::LFUN_DIALOG_HIDE
2380 * \li Action: Hides showed dialog. Counterpart to #LFUN_DIALOG_SHOW .
2381 * \li Syntax: dialog-hide <NAME>
2382 * \li Params: See #LFUN_DIALOG_SHOW .
2383 * \li Origin: leeming, 25 Feb 2003
2386 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
2388 * \var lyx::FuncCode lyx::LFUN_DIALOG_TOGGLE
2389 * \li Action: Toggles dialog between showed/hidden state.
2390 * \li Notion: Internally uses #LFUN_DIALOG_SHOW , #LFUN_DIALOG_HIDE .
2391 * \li Syntax: dialog-toggle <NAME> [<DATA>]
2392 * \li Params: See #LFUN_DIALOG_SHOW .
2393 * \li Origin: JSpitzm, 30 Apr 2007
2396 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
2398 * \var lyx::FuncCode lyx::LFUN_DIALOG_DISCONNECT_INSET
2399 * \li Action: Closes opened connection to opened inset.
2400 * \li Notion: Connection is used for apply functions.
2401 * \li Syntax: dialog-disconnect-inset <INSET-NAME>
2402 * \li Origin: leeming, 25 Feb 2003
2405 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
2408 * \var lyx::FuncCode lyx::LFUN_MOUSE_PRESS
2409 * \li Action: This function is called when mouse button is pressed (inside workarea).
2410 Action depends on the context.
2411 * \li Notion: This is internal LFUN, not to be used by users.
2412 * \li Origin: André, 9 Aug 2002
2415 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
2417 * \var lyx::FuncCode lyx::LFUN_MOUSE_DOUBLE
2418 * \li Action: This function is called when double click on mouse button is
2419 pressed (inside workarea). Action depends on the context.
2420 * \li Notion: This is internal LFUN, not to be used by users.
2421 * \li Origin: André, 9 Aug 2002
2424 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
2426 * \var lyx::FuncCode lyx::LFUN_MOUSE_TRIPLE
2427 * \li Action: This function is called when triple click on mouse button is
2428 pressed (inside workarea). Action depends on the context.
2429 * \li Notion: This is internal LFUN, not to be used by users.
2430 * \li Origin: André, 9 Aug 2002
2433 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
2435 * \var lyx::FuncCode lyx::LFUN_MOUSE_MOTION
2436 * \li Action: This function is called when mouse cursor is moving over the text.
2437 Action depends on the context.
2438 * \li Notion: This is internal LFUN, not to be used by users.
2439 * \li Origin: André, 9 Aug 2002
2442 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
2444 * \var lyx::FuncCode lyx::LFUN_MOUSE_RELEASE
2445 * \li Action: This function is called when mouse button is released (inside workarea).
2446 Action depends on the context.
2447 * \li Notion: This is internal LFUN, not to be used by users.
2448 * \li Origin: André, 9 Aug 2002
2451 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
2454 * \var lyx::FuncCode lyx::LFUN_KEYMAP_OFF
2455 * \li Action: Turn off the loaded keyboard map.
2456 * \li Syntax: keymap-off
2459 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
2461 * \var lyx::FuncCode lyx::LFUN_KEYMAP_PRIMARY
2462 * \li Action: Turn on the primary keyboard map.
2463 * \li Notion: Maps were widely used in past, when X-windows didn't have nowadays
2464 keyboard support. They can be still used to maintain uniform keyboard
2465 layout across the various plaforms.\n
2466 The language is to be set in the Preferences dialog.
2467 * \li Syntax: keymap-primary
2470 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
2472 * \var lyx::FuncCode lyx::LFUN_KEYMAP_SECONDARY
2473 * \li Action: Turn on the secondary keyboard map.
2474 * \li Syntax: keymap-secondary
2477 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
2479 * \var lyx::FuncCode lyx::LFUN_KEYMAP_TOGGLE
2480 * \li Action: Toggles keyboard maps (first/second/off).
2481 * \li Syntax: keymap-toggle
2482 * \li Origin: leeming, 30 Mar 2004
2485 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
2488 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_LAYOUT
2489 * \li Action: Returns the current layout (that is environment) name
2490 on the cursor position.
2491 * \li Syntax: server-get-layout
2494 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
2496 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_FILENAME
2497 * \li Action: Returns path and file name of the currently edited document.
2498 * \li Syntax: server-get-filename
2501 { LFUN_SERVER_GET_FILENAME, "server-get-filename", ReadOnly, System },
2503 * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
2504 * \li Action: Sets the cursor position based on the row number of generated TeX file.
2505 * \li Syntax: server-goto-file-row <LYX_FILE_NAME> <ROW_NUMBER>
2506 * \li Origin: Edmar, 23 Dec 1998
2509 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly, System },
2511 * \var lyx::FuncCode lyx::LFUN_SERVER_NOTIFY
2512 * \li Action: Sends notify message about the last key-sequence to client.
2513 * \li Notion: This can be used to grab last key-sequence used inside the LyX window.
2514 * \li Syntax: server-notify
2517 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
2519 * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
2520 * \li Action: Sets the cursor position based on the editing area coordinates
2521 (similar as clicking on that point with left mouse button).
2522 * \li Syntax: server-set-xy <X> <Y>
2525 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
2527 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
2528 * \li Action: Returns the coordinates of cursor position in the editing area.
2529 * \li Syntax: server-get-xy
2532 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
2535 * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
2536 * \li Action: Generates the code (literate programming).
2537 * \li Notion: Latex file with extension \literate_extension is generated.
2538 Then LyX invokes \build_command (with a default of``make'') to generate the code and
2539 \build_error_filter to process the compilation error messages. \n
2540 In case you want to process your literate file with a script, or some other program,
2541 just insert in your lyxrc file an entry with:\n
2542 \build_command "my_script my_arguments" \n
2543 The \build_error_filter differs from the \literate_error_filter only in that the
2544 former will identify error messages from your compiler.
2545 * \li Syntax: build-program
2548 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
2551 * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
2552 * \li Action: Saves the current buffer to a temporary file.
2553 * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
2554 is called automatically by LyX, to "autosave" the current buffer.
2555 * \li Syntax: buffer-auto-save
2558 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
2560 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHILD_OPEN
2561 * \li Action: Loads the given child document.
2562 * \li Notion: The current document is treated as a parent.
2563 * \li Syntax: buffer-child-open <FILE>
2564 * \li Params: <FILE>: Filename of the child. The directory of the parent is assumed by default.
2565 * \li Origin: Ale, 28 May 1997
2568 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
2570 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHKTEX
2571 * \li Action: Runs chktex for the current document.
2572 * \li Syntax: buffer-chktex
2573 * \li Origin: Asger, 30 Oct 1997
2576 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
2578 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
2579 * \li Action: Toggles compression of the current document on/off.
2580 * \li Syntax: buffer-toggle-compression
2581 * \li Origin: bpeng, 27 Apr 2006
2584 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
2586 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
2587 * \li Action: Closes the current buffer.
2588 * \li Notion: Closes the current buffer, asking whether to save it, etc,
2589 if the buffer has been modified.
2590 * \li Syntax: buffer-close
2593 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
2595 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
2596 * \li Action: Exports the current buffer (document) to the given format.
2597 * \li Syntax: buffer-export <FORMAT>
2598 * \li Params: <FORMAT> is either "custom" or one of the formats which you
2599 can find in Tools->Preferences->File formats->Format.
2600 Usual format you will enter is "pdf2" (pdflatex),
2601 "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
2602 In case of "custom" you will be asked for a format you
2603 want to start from and for the command that you want to
2604 apply to this format. Internally the control is then passed
2605 to #LFUN_BUFFER_EXPORT_CUSTOM.
2606 * \li Origin: Lgb, 29 Jul 1997
2609 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
2611 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
2612 * \li Action: Exports the current buffer (document) from the given format using
2613 the given command on it.
2614 * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
2615 * \li Params: <FORMAT> format to start from (LyX will care to produce such
2616 intermediate file).\n
2617 <COMMAND> this command will be launched on the file. Note that you can
2618 use "$$FName" string to qualify the intermediate file.
2619 * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
2620 * \li Origin: leeming, 27 Mar 2004
2623 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
2625 * \var lyx::FuncCode lyx::LFUN_BUFFER_PRINT
2626 * \li Action: Prints the current document.
2627 * \li Notion: Many settings can be given via the preferences dialog.
2628 * \li Syntax: buffer-print <TARGET> <TARGET-NAME> <COMMAND>
2629 * \li Params: <TARGET> is either "printer" or "file".\n
2630 <TARGER-NAME> is either "default" or file name or printer name.\n
2631 <COMMAND> command ensuring the printing job.
2632 * \li Sample: buffer-print file "/trash/newfile1.ps" "dvips"
2633 * \li Origin: leeming, 28 Mar 2004
2636 { LFUN_BUFFER_PRINT, "buffer-print", ReadOnly, Buffer },
2638 * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
2639 * \li Action: Import a given file as a lyx document.
2640 * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
2641 defined convertors in preferences. Look into File->Import menu to get
2642 an idea of the currently active import formats.
2643 * \li Syntax: buffer-import <FORMAT> [<FILE>]
2644 * \li Origin: Asger, 24 Jul 1998
2647 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
2649 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
2650 * \li Action: Creates a new buffer (that is, document).
2651 * \li Notion: Implicit path can be set in Preferences dialog.
2652 * \li Syntax: buffer-new [<FILE>]
2653 * \li Params: <FILE>: filename of created file with absolute path.
2656 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
2658 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
2659 * \li Action: Creates a new buffer (that is, document) from a template.
2660 * \li Notion: Path for new files and templates can be set in Preferences dialog.
2661 Template will be asked for via Open-dialog.
2662 * \li Syntax: buffer-new-template [<FILE>]
2663 * \li Params: <FILE>: filename of created file with absolute path.
2666 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
2668 * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
2669 * \li Action: Reverts opened document.
2670 * \li Syntax: buffer-reload
2671 * \li Origin: Asger, 2 Feb 1997
2674 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
2676 * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
2677 * \li Action: Switch to the given buffer.
2678 * \li Notion: This is useful also in case you need simultaneously more views of the edited
2679 document in different LyX windows.
2680 * \li Syntax: buffer-new-template <BUFFER>
2681 * \li Params: <BUFFER>: already opened document which is to be shown.
2684 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
2686 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
2687 * \li Action: Toggle editing mode of the current document between read/write and read-only.
2688 * \li Notion: In the ->Readonly mode checks-in/commits the data if the file is under version control.
2689 In the Readonly-> mode checkouts the data from repository. \n
2690 If these operations fail, buffer won't be toggled.
2691 * \li Syntax: buffer-toggle-read-only
2692 * \li Origin: Lgb, 27 May 1997
2695 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
2697 * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
2698 * \li Action: Displays current buffer in chosen format.
2699 * \li Notion: Displays the contents of the current buffer in the chosen
2700 format, for example, PDF or DVI. This runs the necessary
2701 converter, calls the defined viewer, and so forth.
2702 * \li Syntax: buffer-view <FORMAT>
2703 * \li Params: <FORMAT>: The format to display, where this is one of the
2704 formats defined (in the current GUI) in the
2705 Tools>Preferences>File Formats dialog.
2708 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
2710 * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
2711 * \li Action: Exports the current document and put the result into the
2712 temporary directory.
2713 * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
2714 the output will be rewriten - updated. This is useful in case your viewer
2715 is able to detect such changes (e.g. ghostview for postscript).
2716 * \li Syntax: buffer-update <FORMAT>
2717 * \li Params: <FORMAT>: The format to display, where this is one of the
2718 formats defined (in the current GUI) in the
2719 Tools>Preferences>File Formats dialog.
2720 * \li Origin: Dekel, 5 Aug 2000
2723 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
2726 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
2727 * \li Action: Saves the current buffer.
2728 * \li Notion: Saves the current buffer to disk, using the filename that
2729 is already associated with the buffer, asking for one if
2730 none is yet assigned.
2731 * \li Syntax: buffer-write
2734 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
2736 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
2737 * \li Action: Rename and save current buffer.
2738 * \li Syntax: buffer-write-as <FILENAME>
2739 * \li Params: <FILENAME>: New name of the buffer/file. A relative path
2740 is with respect to the original location of the buffer/file.
2743 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
2745 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
2746 * \li Action: Save all changed documents.
2747 * \li Syntax: buffer-write-all
2748 * \li Origin: rgh, gpothier 6 Aug 2007
2751 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
2753 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEXT
2754 * \li Action: Switch to the next opened document.
2755 * \li Notion: Note that this does not necessarily mean next in tabbar
2756 (for full list see View menu).
2757 * \li Syntax: buffer-next
2760 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
2762 * \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS
2763 * \li Action: Switch to the previous opened document.
2764 * \li Syntax: buffer-previous
2767 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
2769 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
2770 * \li Action: When run from a child document, this updates (exports) document built
2771 from the master buffer. If a master is not found, it updates the
2773 * \li Syntax: master-buffer-update
2774 * \li Author: Tommaso, 20 Sep 2007
2777 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
2779 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
2780 * \li Action: When run from a child document, this command shows a preview built
2781 from the master buffer. If a master is not found, it previews the
2783 * \li Syntax: master-buffer-view
2784 * \li Author: Tommaso, 20 Sep 2007
2787 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
2789 * \var lyx::FuncCode lyx::LFUN_BUFFER_LANGUAGE
2790 * \li Action: Set language of the current document.
2791 * \li Syntax: buffer-language <LANG>
2792 * \li Params: <LANG>: language name. See lib/languages for list.
2793 * \li Author: leeming, 30 Mar 2004
2796 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
2798 * \var lyx::FuncCode lyx::LFUN_BUFFER_SAVE_AS_DEFAULT
2799 * \li Action: Save the current document settings as default.
2800 * \li Notion: The file will will be saved into ~/.lyx/templates/defaults.lyx .
2801 * \li Syntax: buffer-save-as-default [<ARGS>]
2802 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
2803 you can find in document header of usual .lyx file.
2804 * \li Author: leeming, 30 Mar 2004
2807 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
2809 * \var lyx::FuncCode lyx::LFUN_BUFFER_PARAMS_APPLY
2810 * \li Action: Apply the given settings to the current document.
2811 * \li Syntax: buffer-params-apply [<ARGS>]
2812 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
2813 you can find in document header of usual .lyx file.
2814 * \li Author: leeming, 30 Mar 2004
2817 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", Noop, Buffer },
2820 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
2821 * \li Action: Inserts another LyX file.
2822 * \li Syntax: file-insert [<FILE>]
2823 * \li Params: <FILE>: Filename to be inserted.
2826 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
2828 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
2829 * \li Action: Inserts plain text file.
2830 * \li Syntax: file-insert-plaintext [<FILE>]
2831 * \li Params: <FILE>: Filename to be inserted.
2832 * \li Origin: CFO-G, 19 Nov 1997
2835 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
2837 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
2838 * \li Action: Inserts plain text file as paragraph (i.e. join lines).
2839 * \li Syntax: file-insert-plaintext-para [<FILE>]
2840 * \li Params: <FILE>: Filename to be inserted.
2841 * \li Origin: Levon, 14 Feb 2001
2844 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
2846 * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
2847 * \li Action: Open LyX document.
2848 * \li Syntax: file-open [<FILE>]
2849 * \li Params: <FILE>: Filename to be opened.
2852 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
2855 * \var lyx::FuncCode lyx::LFUN_CALL
2856 * \li Action: Executes a command defined in a .def file.
2857 * \li Notion: The definitions are by default read from lib/commands/default.def.\n
2858 A .def file allows to define a command with \\define "<NAME>" "<LFUN>"
2859 where <NAME> is the name of the new command and <LFUN> is the lfun code
2860 to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
2861 \\def_file "FileName" allows to include another .def file. \n
2862 This is particularly useful in connection with toolbar buttons:
2863 Since the name of the button image for this lfun is
2864 lib/images/commands/<NAME>.png this is the way to assign an image
2865 to a complex command-sequence.
2866 * \li Syntax: call <NAME>
2867 * \li Params: <NAME>: Name of the command that must be called.
2868 * \li Origin: broider, 2 Oct 2007
2871 { LFUN_CALL, "call", NoBuffer, System },
2873 * \var lyx::FuncCode lyx::LFUN_META_PREFIX
2874 * \li Action: Simulate halting Meta key (Alt key on PCs).
2875 * \li Notion: Used for buffer editation not for GUI control.
2876 * \li Syntax: meta-prefix
2879 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
2881 * \var lyx::FuncCode lyx::LFUN_CANCEL
2882 * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
2883 * \li Syntax: cancel
2886 { LFUN_CANCEL, "cancel", NoBuffer, System },
2889 * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
2890 * \li Action: Opens the minibuffer toolbar so that the user can type in there.
2891 * \li Notion: Usually bound to M-x shortcut.
2892 * \li Syntax: command-execute
2895 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
2897 * \var lyx::FuncCode lyx::LFUN_COMMAND_PREFIX
2898 * \li Action: Return the current key sequence and available options as a string.
2899 * \li Notion: No options are added if no curmap kb map exists. \n
2900 This is probably usable only with connection to lyxserver.
2901 * \li Syntax: command-prefix
2904 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
2906 * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
2907 * \li Action: Run more commands (LFUN and its parameters) in a sequence.
2908 * \li Syntax: command-sequence <CMDS>
2909 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
2910 * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
2911 * \li Origin: Andre', 11 Nov 1999
2914 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
2916 * \var lyx::FuncCode lyx::LFUN_MESSAGE
2917 * \li Action: Shows message in statusbar (for script purposes).
2918 * \li Syntax: message <STRING>
2919 * \li Origin: Lgb, 8 Apr 2001
2922 { LFUN_MESSAGE, "message", NoBuffer, System },
2924 * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
2925 * \li Action: Save user preferences.
2926 * \li Syntax: preferences-save
2927 * \li Origin: Lgb, 27 Nov 1999
2930 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
2932 * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
2933 * \li Action: Reconfigure the automatic settings.
2934 * \li Syntax: reconfigure
2935 * \li Origin: Asger, 14 Feb 1997
2938 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
2940 * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
2941 * \li Action: Apply the given settings to user preferences.
2942 * \li Syntax: lyxrc-apply <SETTINGS>
2943 * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
2944 to get an idea which commands to use and their syntax.
2945 #lyx::LyXRC::LyXRCTags has the list of possible commands.
2948 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
2950 * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
2951 * \li Action: Determine whether keep cursor inside the editing window regardless
2952 the scrollbar movement.
2953 * \li Syntax: toggle-cursor-follows-scrollbar
2954 * \li Origin: ARRae, 2 Dec 1997
2957 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
2959 * \var lyx::FuncCode lyx::LFUN_SET_COLOR
2960 * \li Action: Set the given LyX color to the color defined by the X11 name given.
2961 * \li Notion: A new color entry is created if the color is unknown.
2962 Color names can be stored as a part of user settings.
2963 * \li Syntax: set-color <LYX_NAME> <X11_NAME>
2964 * \li Origin: SLior, 11 Jun 2000
2967 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
2969 * \var lyx::FuncCode lyx::LFUN_STATISTICS
2970 * \li Action: Count the statistics (number of words and characters)
2971 in the document or in the given selection.
2972 * \li Notion: Note that this function gives the number of words/chars written,
2973 not the number of characters which will be typeset.
2974 * \li Syntax: statistics
2975 * \li Origin: lasgouttes, Jan 27 2004; ps, Jan 8 2008
2978 { LFUN_STATISTICS, "statistics", ReadOnly, System },
2980 * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
2981 * \li Action: Show the inline completion at the cursor position.
2982 * \li Syntax: completion-inline
2983 * \li Origin: sts, Feb 19 2008
2986 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
2988 * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
2989 * \li Action: Show the completion popup at the cursor position.
2990 * \li Syntax: completion-popup
2991 * \li Origin: sts, Feb 19 2008
2994 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
2996 * \var lyx::FuncCode lyx::LFUN_COMPLETION_COMPLETE
2997 * \li Action: Try to complete the word or command at the cursor position.
2998 * \li Syntax: completion-complete
2999 * \li Origin: sts, Feb 19 2008
3002 { LFUN_COMPLETION_COMPLETE, "complete", SingleParUpdate, Edit },
3004 * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
3005 * \li Action: Activate the branch
3006 * \li Syntax: branch-activate <BRANCH>
3007 * \li Params: <BRANCH>: The branch to activate
3008 * \li Sample: lyx -e pdf2 -x "branch-activate answers" finalexam.lyx \n
3009 could be used to export a pdf with the answers branch included
3010 without one's having to open LyX and activate the branch manually.
3011 * \li Origin: rgh, 27 May 2008
3014 { LFUN_BRANCH_ACTIVATE, "branch-activate", Argument, Buffer },
3016 * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
3017 * \li Action: De-activate the branch
3018 * \li Syntax: branch-deactivate <BRANCH>
3019 * \li Params: <BRANCH>: The branch to deactivate
3020 * \li Origin: rgh, 27 May 2008
3023 { LFUN_BRANCH_DEACTIVATE, "branch-deactivate", Argument, Buffer },
3025 { LFUN_NOACTION, "", Noop, Hidden }
3026 #ifndef DOXYGEN_SHOULD_SKIP_THIS
3029 for (int i = 0; items[i].action != LFUN_NOACTION; ++i) {
3030 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
3037 LyXAction::LyXAction()
3043 // Returns an action tag from a string.
3044 FuncRequest LyXAction::lookupFunc(string const & func) const
3046 string const func2 = trim(func);
3048 if (func2.empty()) {
3049 return FuncRequest(LFUN_NOACTION);
3053 string const arg = split(func2, cmd, ' ');
3055 func_map::const_iterator fit = lyx_func_map.find(cmd);
3057 return fit != lyx_func_map.end() ? FuncRequest(fit->second, arg) : FuncRequest(LFUN_UNKNOWN_ACTION);
3061 string const LyXAction::getActionName(FuncCode action) const
3063 info_map::const_iterator const it = lyx_info_map.find(action);
3064 return it != lyx_info_map.end() ? it->second.name : string();
3068 LyXAction::func_type const LyXAction::getActionType(FuncCode action) const
3070 info_map::const_iterator const it = lyx_info_map.find(action);
3071 return it != lyx_info_map.end() ? it->second.type : Hidden;
3075 bool LyXAction::funcHasFlag(FuncCode action,
3076 LyXAction::func_attrib flag) const
3078 info_map::const_iterator ici = lyx_info_map.find(action);
3080 if (ici == lyx_info_map.end()) {
3081 LYXERR0("action: " << action << " is not known.");
3082 LASSERT(false, /**/);
3085 return ici->second.attrib & flag;
3089 LyXAction::const_func_iterator LyXAction::func_begin() const
3091 return lyx_func_map.begin();
3095 LyXAction::const_func_iterator LyXAction::func_end() const
3097 return lyx_func_map.end();