3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Lars Gullik Bjønnes
7 * \author Jean-Marc Lasgouttes
12 * Full author contact details are available in file CREDITS.
17 #include "LyXAction.h"
19 #include "FuncRequest.h"
21 #include "support/debug.h"
22 #include "support/lstrings.h"
24 #include "support/lassert.h"
29 using namespace lyx::support;
34 NAMING RULES FOR USER-COMMANDS
35 Here's the set of rules to apply when a new command name is introduced:
37 1) Use the object.event order. That is, use `word-forward'
38 instead of `forward-word'.
39 2) Don't introduce an alias for an already named object. Same for events.
40 3) Forward movement or focus is called `forward' (not `right').
41 4) Backward movement or focus is called `backward' (not `left').
42 5) Upward movement of focus is called `up'.
43 6) Downward movement is called `down'.
44 7) The begin of an object is called `begin' (not `start').
45 8) The end of an object is called `end'.
47 (May 19 1996, 12:04, RvdK)
52 * The documentation below is primarily description of purpose and syntax
53 * relating to the different LFUNs.
55 * Try to find an appropriate (thematical) place when adding the new LFUN
56 * and don't forget to add doxygen commentary.
58 * Doxygen template below. Some notes: Parameters should be set in uppercase
59 * and put in <BRACKETS>, [<PARAM>] means optional one.
63 * \var lyx::FuncCode lyx::LFUN_
76 void LyXAction::newFunc(FuncCode action, string const & name,
77 unsigned int attrib, LyXAction::func_type type)
79 lyx_func_map[name] = action;
82 tmpinfo.attrib = attrib;
84 lyx_info_map[action] = tmpinfo;
88 // Needed for LFUNs documentation to be accepted, since doxygen won't take
89 // \var inside functions.
90 #ifndef DOXYGEN_SHOULD_SKIP_THIS
91 void LyXAction::init()
93 // This function was changed to use the array below in initalization
94 // instead of calling newFunc numerous times because of compilation
95 // times. Since the array is not static we get back the memory it
96 // occupies after the init is completed. It compiles several
109 ev_item const items[] = {
112 * \var lyx::FuncCode lyx::LFUN_ACCENT_ACUTE
113 * \li Action: Adds an acute accent \htmlonly (á)\endhtmlonly
114 to the next character typed.
115 * \li Syntax: accent-acute
118 { LFUN_ACCENT_ACUTE, "accent-acute", Noop, Edit },
120 * \var lyx::FuncCode lyx::LFUN_ACCENT_BREVE
121 * \li Action: Adds a breve accent \htmlonly (ă)\endhtmlonly
122 to the next character typed.
123 * \li Syntax: accent-breve
126 { LFUN_ACCENT_BREVE, "accent-breve", Noop, Edit },
128 * \var lyx::FuncCode lyx::LFUN_ACCENT_CARON
129 * \li Action: Adds a caron \htmlonly (ǎ)\endhtmlonly
130 to the next character typed.
131 * \li Syntax: accent-caron
134 { LFUN_ACCENT_CARON, "accent-caron", Noop, Edit },
136 * \var lyx::FuncCode lyx::LFUN_ACCENT_CEDILLA
137 * \li Action: Adds a cedilla \htmlonly (ç)\endhtmlonly
138 to the next character typed.
139 * \li Syntax: accent-cedilla
142 { LFUN_ACCENT_CEDILLA, "accent-cedilla", Noop, Edit },
144 * \var lyx::FuncCode lyx::LFUN_ACCENT_CIRCLE
145 * \li Action: Adds a circle accent \htmlonly (å)\endhtmlonly
146 to the next character typed.
147 * \li Syntax: accent-circle
150 { LFUN_ACCENT_CIRCLE, "accent-circle", Noop, Edit },
152 * \var lyx::FuncCode lyx::LFUN_ACCENT_CIRCUMFLEX
153 * \li Action: Adds a circumflex \htmlonly (ê)\endhtmlonly
154 to the next character typed.
155 * \li Syntax: accent-circumflex
158 { LFUN_ACCENT_CIRCUMFLEX, "accent-circumflex", Noop, Edit },
160 * \var lyx::FuncCode lyx::LFUN_ACCENT_DOT
161 * \li Action: Adds a dot accent \htmlonly (ż)\endhtmlonly
162 to the next character typed.
163 * \li Syntax: accent-dot
166 { LFUN_ACCENT_DOT, "accent-dot", Noop, Edit },
168 * \var lyx::FuncCode lyx::LFUN_ACCENT_GRAVE
169 * \li Action: Adds a grave accent \htmlonly (è)\endhtmlonly
170 to the next character typed.
171 * \li Syntax: accent-grave
174 { LFUN_ACCENT_GRAVE, "accent-grave", Noop, Edit },
176 * \var lyx::FuncCode lyx::LFUN_ACCENT_HUNGARIAN_UMLAUT
177 * \li Action: Adds a Hungarian umlaut \htmlonly (ő)\endhtmlonly
178 to the next character typed.
179 * \li Syntax: accent-grave
182 { LFUN_ACCENT_HUNGARIAN_UMLAUT, "accent-hungarian-umlaut", Noop, Edit },
184 * \var lyx::FuncCode lyx::LFUN_ACCENT_MACRON
185 * \li Action: Adds a macron \htmlonly (ā)\endhtmlonly
186 to the next character typed.
187 * \li Syntax: accent-macron
190 { LFUN_ACCENT_MACRON, "accent-macron", Noop, Edit },
192 * \var lyx::FuncCode lyx::LFUN_ACCENT_OGONEK
193 * \li Action: Adds an ogonek accent \htmlonly (ą)\endhtmlonly
194 to the next character typed.
195 * \li Syntax: accent-ogonek
198 { LFUN_ACCENT_OGONEK, "accent-ogonek", Noop, Edit },
200 * \var lyx::FuncCode lyx::LFUN_ACCENT_TIE
201 * \li Action: Adds a tie \htmlonly (a͡)\endhtmlonly
202 over the next two character typed.
203 * \li Notion: The following char will finish the tie.
204 * \li Syntax: accent-tie
207 { LFUN_ACCENT_TIE, "accent-tie", Noop, Edit },
209 * \var lyx::FuncCode lyx::LFUN_ACCENT_TILDE
210 * \li Action: Adds a tilde \htmlonly (ã)\endhtmlonly
211 over the next character typed.
212 * \li Syntax: accent-tilde
215 { LFUN_ACCENT_TILDE, "accent-tilde", Noop, Edit },
217 * \var lyx::FuncCode lyx::LFUN_ACCENT_UMLAUT
218 * \li Action: Adds an umlaut \htmlonly (ä)\endhtmlonly
219 over the next character typed.
220 * \li Syntax: accent-umlaut
223 { LFUN_ACCENT_UMLAUT, "accent-umlaut", Noop, Edit },
225 * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERBAR
226 * \li Action: Adds a bar \htmlonly (a̠)\endhtmlonly
227 under the next character typed.
228 * \li Syntax: accent-underbar
231 { LFUN_ACCENT_UNDERBAR, "accent-underbar", Noop, Edit },
233 * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERDOT
234 * \li Action: Adds a dot \htmlonly (ạ)\endhtmlonly
235 under the next character typed.
236 * \li Syntax: accent-underdot
239 { LFUN_ACCENT_UNDERDOT, "accent-underdot", Noop, Edit },
242 * \var lyx::FuncCode lyx::LFUN_CAPTION_INSERT
243 * \li Action: Inserts a caption inset.
244 * \li Syntax: caption-insert
245 * \li Origin: Lgb, 18 Jul 2000
248 { LFUN_CAPTION_INSERT, "caption-insert", Noop, Edit },
250 * \var lyx::FuncCode lyx::LFUN_DATE_INSERT
251 * \li Action: Inserts the current date.
252 * \li Syntax: date-insert [<ARG>]
253 * \li Params: <ARG>: Format of date. The default value (%x) can be set
254 in Preferences->Date format. For possible formats
255 see manual page of strftime function.
256 * \li Origin: jdblair, 31 Jan 2000
259 { LFUN_DATE_INSERT, "date-insert", Noop, Edit },
261 * \var lyx::FuncCode lyx::LFUN_FOOTNOTE_INSERT
262 * \li Action: Inserts a footnote inset.
263 * \li Syntax: footnote-insert
264 * \li Origin: Jug, 7 Mar 2000
267 { LFUN_FOOTNOTE_INSERT, "footnote-insert", Noop, Edit },
269 * \var lyx::FuncCode lyx::LFUN_ERT_INSERT
270 * \li Action: Inserts an ERT inset.
271 * \li Syntax: ert-insert
272 * \li Origin: Jug, 18 Feb 2000
275 { LFUN_ERT_INSERT, "ert-insert", Noop, Edit },
277 * \var lyx::FuncCode lyx::LFUN_FLOAT_INSERT
278 * \li Action: Inserts a float inset.
279 * \li Syntax: float-insert <TYPE>
280 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
281 "algorithm", "table", "figure" parameters can be given.
282 * \li Origin: Lgb, 27 Jun 2000
285 { LFUN_FLOAT_INSERT, "float-insert", Noop, Edit },
287 * \var lyx::FuncCode lyx::LFUN_FLOAT_WIDE_INSERT
288 * \li Action: Inserts float insets as in #LFUN_FLOAT_INSERT but span multiple columns.
289 * \li Notion: Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
290 * \li Syntax: float-wide-insert <TYPE>
291 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
292 "algorithm", "table", "figure" parameters can be given.
293 * \li Origin: Lgb, 31 Oct 2001
296 { LFUN_FLOAT_WIDE_INSERT, "float-wide-insert", Noop, Edit },
298 * \var lyx::FuncCode lyx::LFUN_FLOAT_LIST_INSERT
299 * \li Action: Inserts the list of floats in the document.
300 * \li Syntax: float-list-insert <TYPE>
301 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
302 "algorithm", "table", "figure" parameters can be given.
303 * \li Origin: Lgb, 3 May 2001
306 { LFUN_FLOAT_LIST_INSERT, "float-list-insert", Noop, Edit },
308 * \var lyx::FuncCode lyx::LFUN_WRAP_INSERT
309 * \li Action: Inserts floats wrapped by the text around.
310 * \li Syntax: wrap-insert <TYPE>
311 * \li Params: <TYPE>: table|figure
312 * \li Origin: Dekel, 7 Apr 2002
315 { LFUN_WRAP_INSERT, "wrap-insert", Noop, Edit },
317 * \var lyx::FuncCode lyx::LFUN_OPTIONAL_INSERT
318 * \li Action: Inserts an optional-argument (short title) inset.
319 * \li Syntax: optional-insert
320 * \li Origin: vermeer, 12 Aug 2002
323 { LFUN_OPTIONAL_INSERT, "optional-insert", Noop, Edit },
325 * \var lyx::FuncCode lyx::LFUN_LINE_INSERT
326 * \li Action: Inserts a horizontal line.
327 * \li Syntax: line-insert
328 * \li Origin: Andre, Oct 27 2003
331 { LFUN_LINE_INSERT, "line-insert", Noop, Edit },
333 * \var lyx::FuncCode lyx::LFUN_NEWPAGE_INSERT
334 * \li Action: Inserts a new page.
335 * \li Syntax: newpage-insert <ARG>
336 * \li Params: <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
337 * \li Origin: uwestoehr, 24 Nov 2007
340 { LFUN_NEWPAGE_INSERT, "newpage-insert", Noop, Edit },
342 * \var lyx::FuncCode lyx::LFUN_MARGINALNOTE_INSERT
343 * \li Action: Inserts a marginal note.
344 * \li Syntax: marginalnote-insert
345 * \li Origin: Lgb, 26 Jun 2000
348 { LFUN_MARGINALNOTE_INSERT, "marginalnote-insert", Noop, Edit },
350 * \var lyx::FuncCode lyx::LFUN_UNICODE_INSERT
351 * \li Action: Inserts a single unicode character.
352 * \li Syntax: unicode-insert <CHAR>
353 * \li Params: <CHAR>: The character to insert, given as its code
354 point, in hexadecimal.
355 * \li Sample: unicode-insert 0x0100
356 * \li Origin: Lgb, 22 Oct 2006
359 { LFUN_UNICODE_INSERT, "unicode-insert", Noop, Edit },
361 * \var lyx::FuncCode lyx::LFUN_LISTING_INSERT
362 * \li Action: Inserts a new listings inset.
363 * \li Syntax: listing-insert
364 * \li Origin: Herbert, 10 Nov 2001; bpeng, 2 May 2007
367 { LFUN_LISTING_INSERT, "listing-insert", Noop, Edit },
369 * \var lyx::FuncCode lyx::LFUN_TAB_INSERT
370 * \li Action: Insert a tab into a listings inset.
371 * \li Notion: It also works on a selection.
372 * \li Syntax: tab-insert
373 * \li Origin: vfvanravesteijn, Sep 30 2008
376 { LFUN_TAB_INSERT, "tab-insert", SingleParUpdate, Edit },
378 * \var lyx::FuncCode lyx::LFUN_TAB_DELETE
379 * \li Action: Delete a tab or up to an equivalent amount of spaces from
381 * \li Notion: It also works on a selection - it removes a tab or spaces from the
382 beginning of each line spanned by the selection. This is useful if
383 you want to indent/unindent multiple lines in one action.
384 * \li Syntax: tab-delete
385 * \li Origin: vfvanravesteijn, Sep 30 2008
388 { LFUN_TAB_DELETE, "tab-delete", SingleParUpdate, Edit },
390 * \var lyx::FuncCode lyx::LFUN_QUOTE_INSERT
391 * \li Action: Inserts quotes according to the type and quote-language preference.
392 * \li Action: Currently English, Swedish, German, Polish, French, Danish quotes
394 * \li Syntax: quote-insert [<TYPE>]
395 * \li Params: <TYPE>: 'single' for single quotes, otherwise double quotes will be used.
398 { LFUN_QUOTE_INSERT, "quote-insert", Noop, Edit },
400 * \var lyx::FuncCode lyx::LFUN_INFO_INSERT
401 * \li Action: Displays shortcuts, lyxrc, package and textclass availability and menu
402 information in a non-editable boxed InsetText.
403 * \li Notion: Apart from lfun arguments you can use the following method: \n
404 1. input the type and argument of this inset, e.g. "menu paste", in
406 2. select the text and run info-insert lfun.
407 * \li Syntax: info-insert <TYPE> <ARG>
408 * \li Params: <TYPE>: shortcut|lyxrc|package|textclass|menu|buffer \n
409 <ARG>: argument for a given type. Look into InsetInfo.h for detailed
411 * \li Sample: command-sequence info-insert buffer path; info-insert buffer name
412 * \li Origin: bpeng, 7 Oct 2007
415 { LFUN_INFO_INSERT, "info-insert", Noop, Edit },
417 * \var lyx::FuncCode lyx::LFUN_BRANCH_INSERT
418 * \li Action: Inserts branch inset.
419 * \li Syntax: branch-insert <BRANCH-NAME>
420 * \li Origin: vermeer, 17 Aug 2003
423 { LFUN_BRANCH_INSERT, "branch-insert", Noop, Edit },
425 * \var lyx::FuncCode lyx::LFUN_BOX_INSERT
426 * \li Action: Inserts Box inset.
427 * \li Syntax: box-insert [<TYPE>]
428 * \li Params: <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox \n
429 Framed is the default one.
430 * \li Origin: vermeer, 7 Oct 2003
433 { LFUN_BOX_INSERT, "box-insert", Noop, Edit },
435 * \var lyx::FuncCode lyx::LFUN_FLEX_INSERT
436 * \li Action: Inserts CharStyle, Custom inset or XML short element.
437 * \li Notion: Look into the Customization manual for more information about
439 To make this command enabled the layout file for the document
440 class you're using has to load the character styles. There are
441 a few contained in the Logical Markup module. You can also of
442 course create some yourself. \n
443 For dissolving the element see #LFUN_INSET_DISSOLVE.
444 * \li Syntax: flex-insert <TYPE:Name>
445 * \li Params: TYPE: CharStyle|Custom|Element|Standard \n
446 Identifies whether this is a Character Style, a
447 Custom Inset or an XML Element, and which dynamical
448 sub-menu this flex inset is in on the LyX menu tree.
449 If Standard (currently unused): none of these.
450 Name: This name must be defined either in your layout file
451 or imported by some module. The definition is \n
452 InsetLayout <TYPE:Name>
453 * \li Sample: flex-insert CharStyle:Code
456 { LFUN_FLEX_INSERT, "flex-insert", Noop, Edit },
458 * \var lyx::FuncCode lyx::LFUN_SELF_INSERT
459 * \li Action: Inserts the given string (accordingly to the correct keymap).
460 * \li Notion: Automatically replace the currently selected text. Depends on lyxrc
461 settings "auto_region_delete".
462 * \li Syntax: self-insert <STRING>
465 { LFUN_SELF_INSERT, "self-insert", SingleParUpdate, Hidden },
467 * \var lyx::FuncCode lyx::LFUN_SPACE_INSERT
468 * \li Action: Inserts one of horizontal space insets.
469 * \li Syntax: space-insert <NAME> [<LEN>]
470 * \li Params: <NAME>: normal, protected, thin, quad, qquad, enspace, enskip,
471 negthinspace, hfill, hfill*, dotfill, hrulefill, hspace,
473 <LEN>: length for custom spaces (hspace, hspace* for protected)
474 * \li Origin: JSpitzm, 20 May 2003, Mar 17 2008
477 { LFUN_SPACE_INSERT, "space-insert", Noop, Edit },
479 * \var lyx::FuncCode lyx::LFUN_HYPERLINK_INSERT
480 * \li Action: Inserts hyperlinks into the document (clickable in pdf output).
481 * \li Notion: Hyperlink target can be set via selection + hyperlink-insert function.
482 * \li Syntax: href-insert [<TARGET>]
483 * \li Origin: CFO-G, 21 Nov 1997
486 { LFUN_HYPERLINK_INSERT, "href-insert", Noop, Edit },
488 * \var lyx::FuncCode lyx::LFUN_SPECIALCHAR_INSERT
489 * \li Action: Inserts various characters into the document.
490 * \li Syntax: specialchar-insert <CHAR>
491 * \li Params: <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots,
492 end-of-sentence, menu-separator.
493 * \li Origin: JSpitzm, 6 Dec 2007
496 { LFUN_SPECIALCHAR_INSERT, "specialchar-insert", Noop, Edit },
498 * \var lyx::FuncCode lyx::LFUN_TOC_INSERT
499 * \li Action: Inserts table of contents.
500 * \li Syntax: toc-insert
501 * \li Origin: Lgb, 27 May 97
504 { LFUN_TOC_INSERT, "toc-insert", Noop, Edit },
506 * \var lyx::FuncCode lyx::LFUN_APPENDIX
507 * \li Action: Start (or remove) Appendix on the given cursor position.
508 * \li Syntax: appendix
509 * \li Origin: ettrich, 5 May 1998
512 { LFUN_APPENDIX, "appendix", Noop, Edit },
515 * \var lyx::FuncCode lyx::LFUN_INDEX_INSERT
516 * \li Action: Inserts Index entry.
517 * \li Notion: It automatically takes the word on the cursor position.
518 * \li Syntax: index-insert
519 * \li Origin: leeming, 3 Aug 2000
522 { LFUN_INDEX_INSERT, "index-insert", Noop, Edit },
524 * \var lyx::FuncCode lyx::LFUN_INDEX_PRINT
525 * \li Action: Inserts list of Index entries on a new page.
526 * \li Syntax: index-print
527 * \li Origin: Lgb, 27 Feb 1997
530 { LFUN_INDEX_PRINT, "index-print", Noop, Edit },
533 * \var lyx::FuncCode lyx::LFUN_NOMENCL_INSERT
534 * \li Action: Inserts Nomenclature entry.
535 * \li Notion: It automatically takes the word on the cursor position if no symbol is given.
536 * \li Syntax: nomencl-insert [<SYMBOL>]
537 * \li Origin: Ugras, 4 Nov 2006
540 { LFUN_NOMENCL_INSERT, "nomencl-insert", Noop, Edit },
542 * \var lyx::FuncCode lyx::LFUN_NOMENCLATURE_PRINT
543 * \li Action: Inserts list of Nomenclature entries.
544 * \li Syntax: nomenclature-print
545 * \li Origin: Ugras, 4 Nov 2006
548 { LFUN_NOMENCL_PRINT, "nomencl-print", Noop, Edit },
551 * \var lyx::FuncCode lyx::LFUN_NOTE_INSERT
552 * \li Action: Inserts Note on the current cursor postion,
553 move selection inside the inset.
554 * \li Syntax: note-insert [<TYPE>]
555 * \li Params: <TYPE>: <Note|Greyedout|Comment> default: Note
558 { LFUN_NOTE_INSERT, "note-insert", Noop, Edit },
560 * \var lyx::FuncCode lyx::LFUN_NOTE_NEXT
561 * \li Action: Moves the cursor to the begining of next Note inset.
562 * \li Syntax: note-next
565 { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
567 * \var lyx::FuncCode lyx::LFUN_NOTES_MUTATE
568 * \li Action: Changes all Note insets of a particular type (source)
569 to a different type (target) fot the current document.
570 * \li Syntax: notes-mutate <SOURCE> <TARGET>
571 * \li Params: <SOURCE/TARGET>: Note|Comment|Greyedout
572 * \li Origin: sanda, 18 Jun 2008
575 { LFUN_NOTES_MUTATE, "notes-mutate", Argument, Edit },
577 * \var lyx::FuncCode lyx::LFUN_PHANTOM_INSERT
578 * \li Action: Inserts phantom on the current cursor postion,
579 move selection inside the inset.
580 * \li Syntax: phantom-insert [<TYPE>]
581 * \li Params: <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
582 * \li Origin: uwestoehr, 30 Jan 2009
585 { LFUN_PHANTOM_INSERT, "phantom-insert", Noop, Edit },
587 * \var lyx::FuncCode lyx::LFUN_NEWLINE_INSERT
588 * \li Action: Inserts a line break or new line.
589 * \li Syntax: newline-insert [<ARG>]
590 * \li Params: <ARG>: <newline|linebreak> default: newline
591 * \li Origin: JSpitzm, 25 Mar 2008
594 { LFUN_NEWLINE_INSERT, "newline-insert", Noop, Edit },
596 * \var lyx::FuncCode lyx::LFUN_ESCAPE
597 * \li Action: Clears the selection. If no text is selected call #LFUN_FINISHED_FORWARD.
599 * \li Origin: Lgb, 17 May 2001
602 { LFUN_ESCAPE, "escape", ReadOnly, Edit },
604 * \var lyx::FuncCode lyx::LFUN_DOWN
605 * \li Action: Moves the cursor one line in downward direction.
609 { LFUN_DOWN, "down", ReadOnly | NoUpdate, Edit },
611 * \var lyx::FuncCode lyx::LFUN_UP
612 * \li Action: Moves the cursor one line in upward direction.
616 { LFUN_UP, "up", ReadOnly | NoUpdate, Edit },
618 * \var lyx::FuncCode lyx::LFUN_DOWN_SELECT
619 * \li Action: Moves the cursor one line in downward direction adding the current
620 position to the selection.
621 * \li Syntax: down-select
624 { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, Edit },
626 * \var lyx::FuncCode lyx::LFUN_UP_SELECT
627 * \li Action: Moves the cursor one line in upward direction adding the current
628 position to the selection.
629 * \li Syntax: up-select
632 { LFUN_UP_SELECT, "up-select", ReadOnly | SingleParUpdate, Edit },
634 * \var lyx::FuncCode lyx::SCREEN_DOWN
635 * \li Action: Moves the cursor one page in downward direction.
636 * \li Syntax: screen-down
639 { LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit },
641 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP
642 * \li Action: Moves the cursor one page in upward direction.
643 * \li Syntax: screen-up
646 { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit },
648 * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN_SELECT
649 * \li Action: Moves the cursor one screen in downward direction adding the current
650 position to the selection.
651 * \li Syntax: screen-down-select
654 { LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit },
656 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP_SELECT
657 * \li Action: Moves the cursor one page in upward direction adding the current
658 position to the selection.
659 * \li Syntax: screen-up-select
662 { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit },
664 * \var lyx::FuncCode lyx::LFUN_SCROLL
665 * \li Action: Scroll the buffer view.
666 * \li Notion: Only scrolls the screen up or down; does not move the cursor.
667 * \li Syntax: scroll <TYPE> <QUANTITY>
668 * \li Params: <TYPE>: line|page\n
669 <QUANTITY>: up|down|<number>
670 * \li Origin: Abdel, Dec 27 2007
673 { LFUN_SCROLL, "scroll", ReadOnly, Edit },
675 * \var lyx::FuncCode lyx::LFUN_SCREEN_RECENTER
676 * \li Action: Recenters the screen on the current cursor position.
677 * \li Syntax: screen-recenter
680 { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit },
683 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD
684 * \li Action: Moves the cursor one position logically backwards.
685 * \li Notion: This is not the action which should be bound to the arrow keys,
686 because backwards may be left or right, depending on the
687 language. 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-backward
692 { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit },
694 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD_SELECT
695 * \li Action: Moves the cursor one position logically backwards, adding
696 traversed position to the selection.
697 * \li Notion: See also #LFUN_CHAR_BACKWARD.
698 * \li Syntax: char-backward-select
701 { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit },
703 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_BACKWARD
704 * \li Action: Deletes one character in the backward direction (usually the "BackSpace" key).
705 * \li Syntax: char-delete-backward
708 { LFUN_CHAR_DELETE_BACKWARD, "char-delete-backward", SingleParUpdate, Edit },
710 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_FORWARD
711 * \li Action: Deletes one character in the backward direction (usually the "Delete" key).
712 * \li Syntax: char-delete-forward
715 { LFUN_CHAR_DELETE_FORWARD, "char-delete-forward", SingleParUpdate, Edit },
717 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD
718 * \li Action: Moves the cursor one position logically forward.
719 * \li Notion: This is not the action which should be bound to the arrow keys,
720 because forward may be left or right, depending on the language.
721 The arrow keys should be bound to #LFUN_CHAR_LEFT or
722 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
723 * \li Syntax: char-forward
726 { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit },
728 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD_SELECT
729 * \li Action: Moves the cursor one position logically forward, adding
730 traversed position to the selection.
731 * \li Notion: See also #LFUN_CHAR_FORWARD.
732 * \li Syntax: char-forward-select
735 { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit },
737 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT
738 * \li Action: Moves the cursor one position "to the left".
739 * \li Notion: This is the action which should be taken when the "left" key
740 is pressed. Generally, it moves the cursor one position to the
741 left. However, in Bidi text this become slightly more
742 complicated, and there are different modes of cursor movement.
743 In "visual mode", this moves left, plain and simple. In "logical
744 mode", movement is logically forward in RTL paragraphs, and
745 logically backwards in LTR paragraphs.
746 * \li Syntax: char-left
749 { LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit },
751 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT_SELECT
752 * \li Action: Moves the cursor one position "to the left", adding
753 traversed position to the selection.
754 * \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement.
755 * \li Syntax: char-left-select
758 { LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit },
760 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT
761 * \li Action: Moves the cursor one position "to the right".
762 * \li Notion: This is the action which should be taken when the "right" key
763 is pressed. Generally, it moves the cursor one position to the
764 right. However, in Bidi text this become slightly more
765 complicated, and there are different modes of cursor movement.
766 In "visual mode", this moves right, plain and simple. In "logical
767 mode", movement is logically forward in LTR paragraphs, and
768 logically backwards in RTL paragraphs.
769 * \li Syntax: char-right
772 { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit },
774 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT_SELECT
775 * \li Action: Moves the cursor one position "to the right", adding
776 traversed position to the selection.
777 * \li Notion: See also #LFUN_CHAR_RIGHT for exact details of the movement.
778 * \li Syntax: char-right-select
781 { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit },
784 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD
785 * \li Action: Moves the cursor to the logically previous beginning of a word.
786 * \li Notion: This is not the action which should be bound to the arrow keys,
787 because backwards may be left or right, depending on the
788 language. The arrow keys should be bound to #LFUN_WORD_LEFT or
789 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
790 * \li Syntax: word-backward
793 { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit },
795 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD_SELECT
796 * \li Action: Moves the cursor to the logically previous beginning of a word,
797 adding the logically traversed text to the selection.
798 * \li Notion: See also #LFUN_WORD_BACKWARD.
799 * \li Syntax: word-backward-select
802 { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
804 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_BACKWARD
805 * \li Action: Deletes characters to the begining of the word (usually the "C+BackSpace" key).
806 * \li Syntax: word-delete-backward
809 { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
811 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_FORWARD
812 * \li Action: Deletes characters to the end of the word (usually the "C+Delete" key).
813 * \li Syntax: word-delete-forward
816 { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
818 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_FORWARD
819 * \li Action: Search for a given string in forward direction.
820 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
821 * \li Syntax: word-find-forward [<STRING>]
822 * \li Origin: Etienne, 16 Feb 1998
825 { LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit },
827 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_BACKWARD
828 * \li Action: Search for a given string in backward direction.
829 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
830 * \li Syntax: word-find-backward [<STRING>]
831 * \li Origin: Etienne, 20 Feb 1998
834 { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
836 * \var lyx::FuncCode lyx::LFUN_WORD_FIND
837 * \li Action: Search for next occurence of a string.
838 * \li Syntax: word-find [<DATA>]
839 * \li Params: <DATA>: data encoded from Find dialog (see #lyx::find2string()).
840 If no parameter is given, search with last find-dialog
841 data is used for search (i.e. find-next).
842 * \li Origin: Andre, Jan 7 2004
845 { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
847 * \var lyx::FuncCode lyx::LFUN_WORD_REPLACE
848 * \li Action: Replace a string in the document.
849 * \li Syntax: word-replace [<DATA>]
850 * \li Params: <DATA>: data is of the form
853 <casesensitive> <matchword> <all> <forward>"
854 * \li Origin: Andre, Jan 7 2004
857 { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
859 * \var lyx::FuncCode lyx::LFUN_WORD_FINDADV
860 * \li Action: Search for next occurence of a pattern.
861 * \li Syntax: word-findadv [<DATA>]
862 * \li Params: <DATA>: data encoded from FindAdv dialog (see #lyx::findadv2string()).
863 If no parameter is given, search with last find-dialog
864 data is used for search (i.e. find-next).
865 * \li Origin: Tommaso, Nov 15 2007
868 { LFUN_WORD_FINDADV, "word-findadv", ReadOnly, Edit },
869 /*! \var lyx::FuncCode lyx::LFUN_WORD_FORWARD
870 * \li Action: Moves the cursor to the logically next beginning of a word.
871 * \li Notion: This is not the action which should be bound to the arrow keys,
872 because forward may be left or right, depending on the language.
873 The arrow keys should be bound to #LFUN_WORD_LEFT or
874 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
875 * \li Syntax: word-forward
878 { LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
880 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD_SELECT
881 * \li Action: Moves the cursor to the logically next beginning of a word,
882 adding the logically traversed text to the selection.
883 * \li Notion: See also #LFUN_WORD_FORWARD.
884 * \li Syntax: word-forward-select
887 { LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
889 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT
890 * \li Action: Moves the cursor to the next beginning of a word "on the left".
891 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
892 "left" key is pressed. Generally, it moves the cursor to the
893 next beginning of a word on the left. However, in Bidi text this
894 become slightly more complicated, and there are different modes
895 of cursor movement. In "visual mode", this moves left, plain and
896 simple. In "logical mode", movement is logically forward in RTL
897 paragraphs, and logically backwards in LTR paragraphs.
898 * \li Syntax: word-left
899 * \li Origin: dov, 28 Oct 2007
902 { LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
904 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT_SELECT
905 * \li Action: Moves the cursor to the next beginning of a word "on the left",
906 adding *logically* traversed text to the selection.
907 * \li Notion: See also #LFUN_WORD_LEFT for exact details of the movement.
908 * \li Syntax: word-left-select
909 * \li Origin: dov, 28 Oct 2007
912 { LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit },
914 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT
915 * \li Action: Moves the cursor to the next beginning of a word "on the right".
916 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
917 "right" key is pressed. Generally, it moves the cursor to the
918 next beginning of a word on the right. However, in Bidi text
919 this become slightly more complicated, and there are different
920 modes of cursor movement. In "visual mode", this moves right,
921 plain and simple. In "logical mode", movement is logically
922 forward in LTR paragraphs, and logically backwards in RTL
924 * \li Syntax: word-right
925 * \li Origin: dov, 28 Oct 2007
928 { LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit },
930 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT_SELECT
931 * \li Action: Moves the cursor to the next beginning of a word "on the right",
932 adding *logically* traversed text to the selection.
933 * \li Notion: See also #LFUN_WORD_RIGHT for exact details of the movement.
934 * \li Syntax: word-right-select
935 * \li Origin: dov, 28 Oct 2007
938 { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
940 * \var lyx::FuncCode lyx::LFUN_WORD_SELECT
941 * \li Action: Puts the word where the cursor stands into the selection.
942 * \li Syntax: word-select
943 * \li Origin: Andre, 11 Sep 2002
946 { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
948 * \var lyx::FuncCode lyx::LFUN_WORD_CAPITALIZE
949 * \li Action: Capitalizes the words in the selection (i.e. the first letters)
950 or the letter on the cursor position.
951 * \li Syntax: word-capitalize
954 { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
956 * \var lyx::FuncCode lyx::LFUN_WORD_UPCASE
957 * \li Action: Change the words in the selection or from the cursor position
958 to the end of word to the upper case.
959 * \li Syntax: word-upcase
962 { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
964 * \var lyx::FuncCode lyx::LFUN_WORD_LOWCASE
965 * \li Action: Change the words in the selection or from the cursor position
966 to the end of word to the lower case.
967 * \li Syntax: word-lowcase
970 { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
972 * \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
973 * \li Action: Look up thesaurus entries with respect to the word under the cursor.
974 * \li Syntax: thesaurus-entry [<STRING>] [lang=<LANG>]
975 * \li Params: <STRING>: word to look up
976 <LANG>: language (see file languages)
977 * \li Origin: Levon, 20 Jul 2001
980 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
982 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN
983 * \li Action: Move the cursor to the beginning of the document.
984 * \li Syntax: buffer-begin
987 { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
989 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN_SELECT
990 * \li Action: Move the cursor to the beginning of the document adding the
991 traversed text to the selection.
992 * \li Syntax: buffer-begin-select
995 { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
997 * \var lyx::FuncCode lyx::LFUN_BUFFER_END
998 * \li Action: Move the cursor to the end of the document.
999 * \li Syntax: buffer-end
1002 { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
1004 * \var lyx::FuncCode lyx::LFUN_BUFFER_END_SELECT
1005 * \li Action: Move the cursor to the end of the document adding the
1006 traversed text to the selection.
1007 * \li Syntax: buffer-end-select
1010 { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
1013 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN
1014 * \li Action: Move the cursor to the begining of the (screen) line.
1015 * \li Syntax: line-begin
1018 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
1020 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN_SELECT
1021 * \li Action: Move the cursor to the beginning of the (screen) line adding the
1022 traversed text to the selection.
1023 * \li Syntax: line-begin-select
1026 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
1028 * \var lyx::FuncCode lyx::LFUN_LINE_END
1029 * \li Action: Move the cursor to the end of the (screen) line.
1030 * \li Syntax: line-end
1033 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
1035 * \var lyx::FuncCode lyx::LFUN_LINE_END_SELECT
1036 * \li Action: Move the cursor to the end of the (screen) line adding the
1037 traversed text to the selection.
1038 * \li Syntax: line-end-select
1041 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
1043 * \var lyx::FuncCode lyx::LFUN_LINE_DELETE
1044 * \li Action: Deletes the letters to the end of the (screen) line or
1045 deletes the selection.
1046 * \li Syntax: line-delete-forward
1049 { LFUN_LINE_DELETE, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
1051 * \var lyx::FuncCode lyx::LFUN_COPY
1052 * \li Action: Copies to the clipboard the last edit.
1056 { LFUN_COPY, "copy", ReadOnly, Edit },
1058 * \var lyx::FuncCode lyx::LFUN_CUT
1059 * \li Action: Cuts to the clipboard.
1063 { LFUN_CUT, "cut", Noop, Edit },
1065 * \var lyx::FuncCode lyx::LFUN_PASTE
1066 * \li Action: Pastes material from the active clipboard.
1067 * \li Syntax: paste [<TYPE>]
1068 * \li Params: <TYPE>: pdf|png|jpeg|linkback
1071 { LFUN_PASTE, "paste", Noop, Edit },
1073 * \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE
1074 * \li Action: Pastes text from the active clipboard.
1075 * \li Syntax: clipboard-paste [<ARG>]
1076 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1077 * \li Origin: baum, 10 Jul 2006
1080 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
1082 * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
1083 * \li Action: Pastes the currently text selected text.
1084 * \li Notion: Primary selection mechanism is linux-only thing.
1085 * \li Syntax: primary-selection-paste [<ARG>]
1086 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1089 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
1091 * \var lyx::FuncCode lyx::LFUN_SELECTION_PASTE
1092 * \li Action: Pastes the text in permanent selection.
1093 * \li Syntax: selection-paste
1096 { LFUN_SELECTION_PASTE, "selection-paste", Noop, Edit },
1098 * \var lyx::FuncCode lyx::LFUN_UNDO
1099 * \li Action: Undoes the last edit.
1103 { LFUN_UNDO, "undo", Noop, Edit },
1105 * \var lyx::FuncCode lyx::LFUN_REDO
1106 * \li Action: Redoes the last thing undone.
1110 { LFUN_REDO, "redo", Noop, Edit },
1112 * \var lyx::FuncCode lyx::LFUN_REPEAT
1113 * \li Action: Repeat the given command.
1114 * \li Syntax: repeat <COUNT> <LFUN-COMMAND>
1115 * \li Origin: Andre, , 27 Oct 2003
1118 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
1120 * \var lyx::FuncCode lyx::LFUN_CHARS_TRANSPOSE
1121 * \li Action: Transposes the character at the cursor with the one before it.
1122 * \li Syntax: chars-transpose
1123 * \li Origin: Lgb, 25 Apr 2001
1126 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
1129 * \var lyx::FuncCode lyx::LFUN_DEPTH_DECREMENT
1130 * \li Action: Decrease the nesting depth of the (selected) paragraph(s)
1132 * \li Syntax: depth-decrement
1135 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
1137 * \var lyx::FuncCode lyx::LFUN_DEPTH_INCREMENT
1138 * \li Action: Increase the nesting depth of the (selected) paragraph(s)
1140 * \li Syntax: depth-increment
1143 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
1146 * \var lyx::FuncCode lyx::LFUN_FONT_BOLD
1147 * \li Action: Toggles the bold font (selection-wise) using mathbf in math.
1148 * \li Syntax: font-bold
1151 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
1154 * \var lyx::FuncCode lyx::LFUN_FONT_BOLDSYMBOL
1155 * \li Action: Toggles the bold font (selection-wise) using boldsymbol in math.
1156 * \li Syntax: font-boldsymbol
1159 { LFUN_FONT_BOLDSYMBOL, "font-boldsymbol", Noop, Layout },
1161 * \var lyx::FuncCode lyx::LFUN_FONT_TYPEWRITER
1162 * \li Action: Toggles the typewriter family font (selection-wise).
1163 * \li Syntax: font-typewriter
1166 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
1168 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERLINE
1169 * \li Action: Toggles underline in the font (selection-wise).
1170 * \li Syntax: font-underline
1173 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
1175 * \var lyx::FuncCode lyx::LFUN_FONT_EMPH
1176 * \li Action: Toggles the emphasis font style (selection-wise).
1177 * \li Syntax: font-emph
1180 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
1182 * \var lyx::FuncCode lyx::LFUN_FONT_NOUN
1183 * \li Action: Toggles Noun text style font (selection-wise).
1184 * \li Syntax: font-noun
1187 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
1189 * \var lyx::FuncCode lyx::LFUN_FONT_ROMAN
1190 * \li Action: Toggles Roman family font (selection-wise).
1191 * \li Syntax: font-roman
1194 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
1196 * \var lyx::FuncCode lyx::LFUN_FONT_SANS
1197 * \li Action: Toggles Sans Serif family font (selection-wise).
1198 * \li Syntax: font-sans
1201 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
1203 * \var lyx::FuncCode lyx::LFUN_FONT_FRAK
1204 * \li Action: Toggles Fraktur family font (math-mode, selection-wise).
1205 * \li Syntax: font-frak
1206 * \li Origin: vermeer, 10 Jan 2002
1209 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
1211 * \var lyx::FuncCode lyx::LFUN_FONT_ITAL
1212 * \li Action: Toggles Italics font shape (math-mode, selection-wise).
1213 * \li Syntax: font-ital
1214 * \li Origin: vermeer, 10 Jan 2002
1217 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
1219 * \var lyx::FuncCode lyx::LFUN_FONT_DEFAULT
1220 * \li Action: Reverts the settings of the font to the default values (selection-wise).
1221 * \li Syntax: font-default
1224 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
1226 * \var lyx::FuncCode lyx::LFUN_FONT_SIZE
1227 * \li Action: Sets font size according to lyx format string.
1228 * \li Syntax: font-size <SIZE>
1229 * \li Params: <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|\n
1230 largest|huge|giant|increase|decrease|default
1233 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
1235 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_APPLY
1236 * \li Action: Toggle user-defined (=last-time used) text style.
1237 * \li Notion: This style is set via #LFUN_TEXTSTYLE_UPDATE, which is
1238 automatically trigerred when using Text Style dialog.
1239 * \li Syntax: textstyle-apply
1240 * \li Origin: leeming, 12 Mar 2003
1243 { LFUN_TEXTSTYLE_APPLY, "textstyle-apply", Noop, Layout },
1245 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_UPDATE
1246 * \li Action: Apply text style and update the settings to be used by #LFUN_TEXTSTYLE_APPLY.
1247 * \li Syntax: textstyle-update <FONT_INFO>
1248 * \li Params: <FONT_INFO>: specifies font atributes, e.g. family, series, shape,
1249 size, emph, noun, underbar, number, color, language,
1251 Use lyx -dbg action for exact syntax of text-style
1253 * \li Origin: leeming, 12 Mar 2003
1256 { LFUN_TEXTSTYLE_UPDATE, "textstyle-update", Noop, Layout },
1258 * \var lyx::FuncCode lyx::LFUN_SCREEN_FONT_UPDATE
1259 * \li Action: Update fonts and its metrics.
1260 * \li Notion: Automatically called after zoom, dpi, font names, or norm change.
1261 * \li Syntax: screen-font-update
1262 * \li Origin: ARRae, 13 Aug 2000
1265 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
1267 * \var lyx::FuncCode lyx::LFUN_FONT_STATE
1268 * \li Action: Returns the info about the current font.
1269 * \li Syntax: font-state
1272 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
1275 * \var lyx::FuncCode lyx::LFUN_CITATION_INSERT
1276 * \li Action: Inserts citation from loaded citation database.
1277 * \li Syntax: citation-insert [<KEY>[|<TEXT_BEFORE>]]
1278 * \li Params: <KEY>: Citation (shortcut listed in available citations). \n
1279 <TEXT_BEFORE>: text which should appear before citation.
1280 * \li Origin: AAS, 97-02-23
1283 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
1285 * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_ADD
1286 * \li Action: Adds database, which will be used for bibtex citations.
1287 * \li Notion: Databases are added to the first BibTeX inset
1288 (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
1289 * \li Syntax: bibtex-database-add <DATABASE-NAME>
1290 * \li Origin: Ale, 30 May 1997
1293 { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit },
1295 * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_DEL
1296 * \li Action: Adds database, which will be used for bibtex citations.
1297 * \li Notion: Databases are deleted from the first BibTeX inset
1298 (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
1299 * \li Syntax: bibtex-database-del <DATABASE-NAME>
1300 * \li Origin: Ale, 30 May 1997
1303 { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
1306 * \var lyx::FuncCode lyx::LFUN_LAYOUT
1307 * \li Action: Sets the layout (that is, environment) for the current paragraph.
1308 * \li Syntax: layout <LAYOUT>
1309 * \li Params: <LAYOUT>: the layout to use
1312 { LFUN_LAYOUT, "layout", Noop, Layout },
1314 * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH
1315 * \li Action: Launches the paragraph settings dialog.
1316 * \li Syntax: layout-paragraph
1319 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
1321 * \var lyx::FuncCode lyx::LFUN_LAYOUT_TABULAR
1322 * \li Action: Launches the tabular settings dialog.
1323 * \li Syntax: layout-tabular
1324 * \li Origin: Jug, 31 Jul 2000
1327 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
1329 * \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE
1330 * \li Action: Displays list of layout choices.
1331 * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
1332 dropbox allowing for choice of layout.
1333 * \li Syntax: drop-layouts-choice
1336 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
1338 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
1339 * \li Action: Clears the module list.
1340 * \li Notion: Clears the list of included modules for the current buffer.
1341 * \li Syntax: layout-modules-clear
1342 * \li Origin: rgh, 25 August 2007
1345 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", Noop, Layout },
1347 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULE_ADD
1348 * \li Action: Adds a module.
1349 * \li Notion: Adds a module to the list of included modules for the current buffer.
1350 * \li Syntax: layout-module-add <MODULE>
1351 * \li Params: <MODULE>: the module to be added
1352 * \li Origin: rgh, 25 August 2007
1355 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", Noop, Layout },
1357 * \var lyx::FuncCode lyx::LFUN_LAYOUT_RELOAD
1358 * \li Action: Reloads layout information.
1359 * \li Notion: Reloads all layout information for the current buffer from disk, thus
1360 recognizing any changes that have been made to layout files on the fly.
1361 This is intended to be used only by layout developers and should not be
1362 used when one is trying to do actual work.
1363 * \li Syntax: layout-reload
1364 * \li Origin: rgh, 3 September 2007
1367 { LFUN_LAYOUT_RELOAD, "layout-reload", Noop, Layout },
1369 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
1370 * \li Action: Sets the text class for the current buffer.
1371 * \li Syntax: textclass-apply <TEXTCLASS>
1372 * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
1373 the filename, minus the ".layout" extension.
1376 { LFUN_TEXTCLASS_APPLY, "textclass-apply", Noop, Layout },
1378 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
1379 * \li Action: Loads information for a textclass from disk.
1380 * \li Syntax: textclass-load <TEXTCLASS>
1381 * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
1382 the filename, minus the ".layout" extension.
1385 { LFUN_TEXTCLASS_LOAD, "textclass-load", Noop, Layout },
1388 * \var lyx::FuncCode lyx::LFUN_MARK_OFF
1389 * \li Action: Disable selecting of text-region.
1390 * \li Syntax: mark-off
1393 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
1395 * \var lyx::FuncCode lyx::LFUN_MARK_ON
1396 * \li Action: Enable selecting of text-region.
1397 * \li Notion: After enabling you can simply move arrow keys to get selected region.
1398 * \li Syntax: mark-on
1401 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
1403 * \var lyx::FuncCode lyx::LFUN_MARK_TOGGLE
1404 * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
1405 * \li Syntax: mark-toggle
1406 * \li Origin: Andre, May 5 2006
1409 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
1412 * \var lyx::FuncCode lyx::LFUN_MATH_DELIM
1413 * \li Action: Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
1414 * \li Syntax: math-delim [<LEFT>] [<RIGHT>]
1415 * \li Params: <LEFT/RIGHT>: Delimiters to be used. Each delimiter can be specified by
1416 either a LaTeX name or a valid character.
1417 ( is the default letter.
1418 * \li Sample: math-delim { rangle
1419 * \li Origin: Alejandro, 18 Jun 1996
1422 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
1424 * \var lyx::FuncCode lyx::LFUN_MATH_BIGDELIM
1425 * \li Action: Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
1426 * \li Syntax: math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
1427 * \li Params: <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r \n
1428 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
1429 * \li Sample: math-bigdelim "Bigl" "\Downarrow" "Bigr" "\}"
1430 * \li Origin: Enrico & Georg, 7 May 2006
1433 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
1435 * \var lyx::FuncCode lyx::LFUN_MATH_DISPLAY
1436 * \li Action: Creates a new displayed equation in text mode.
1437 Toggles inlined/display formula in math mode.
1438 * \li Syntax: math-display [<ARG>]
1439 * \li Params: <ARG>: this argument will be passed to #LFUN_MATH_INSERT when creating
1440 new equation from the text mode.
1441 * \li Origin: Alejandro, 18 Jun 1996
1444 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
1446 * \var lyx::FuncCode lyx::LFUN_MATH_INSERT
1447 * \li Action: Inserts math objects and symbols.
1448 * \li Syntax: math-insert <ARG>
1449 * \li Params: <ARG>: Symbol or LaTeX code to be inserted.
1452 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
1454 * \var lyx::FuncCode lyx::LFUN_MATH_SUBSCRIPT
1455 * \li Action: Enters subscript expression in math expression.
1456 * \li Syntax: math-subscript
1457 * \li Origin: vermeer, 12 Dec 2001
1460 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
1462 * \var lyx::FuncCode lyx::LFUN_MATH_SUPERSCRIPT
1463 * \li Action: Enters subscript expression in math expression.
1464 * \li Syntax: math-superscript
1465 * \li Origin: vermeer, 12 Dec 2001
1468 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
1470 * \var lyx::FuncCode lyx::LFUN_MATH_LIMITS
1471 * \li Action: Toggles the position of the limits from above/below to the right
1472 side an vice versa in integral symbol, a limit, a summation, etc.
1473 * \li Notion: Put the cursor before the symbol with the limits and then invoke
1475 * \li Syntax: math-limits [<STATE>]
1476 * \li Params: <STATE>: limits|nolimits
1479 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
1481 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO
1482 * \li Action: Inserts a math macro definition at the cursor position in the text.
1483 * \li Syntax: math-macro <NAME> [<NARGS>] [def]
1484 * \li Params: <NAME>: The name of the macro, e.g. "mymacro".
1485 <NARGS>: The number of parameters of the macro. Default is 0.
1486 "def": Has no effect anymore, just for compatibility with former LyX versions.
1487 * \li Origin: ale, 10 May 1997; sts, 21 Dec 2007
1490 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
1492 * \var lyx::FuncCode lyx::LFUN_MATH_MUTATE
1493 * \li Action: Mutates the type of math inset to the newly selected one.
1494 * \li Syntax: math-mutate <TYPE>
1495 * \li Params: <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
1496 multline|gather|flalign
1497 * \li Origin: Andre, 23 May 2001
1500 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
1502 * \var lyx::FuncCode lyx::LFUN_MATH_SPACE
1503 * \li Action: Inserts space into math expression.
1504 * \li Notion: Use spacebar after entering this space to change type of space.
1505 * \li Syntax: math-space [<TYPE>] [<LEN>]
1506 * \li Params: <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace \n
1507 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad \n
1508 custom space: hspace \n
1509 "," used by default.
1510 Note that ! is equivalent to negthinspace, , = thinspace,
1511 : = medspace, and ; = thickspace.
1512 <LEN>: length for custom spaces (hspace)
1513 * \li Origin: Andre, 25 Jul 2001; sanda, 16 Jun 2008
1516 { LFUN_MATH_SPACE, "math-space", Noop, Math },
1518 * \var lyx::FuncCode lyx::LFUN_MATH_MATRIX
1519 * \li Action: Inserts a matrix.
1520 * \li Syntax: math-matrix <COLS> <ROWS> [<ALIGN>]
1521 * \li Params: <ALIGN>: Alignment is a word composed of the vertical alignment
1522 (b, c or t) (i.e. 1 char) and the horizontal alignments
1523 (l, c or r) (i.e. <COL> chars).
1524 * \li Sample: math-matrix 3 3 bccc
1527 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
1529 * \var lyx::FuncCode lyx::LFUN_MATH_MODE
1530 * \li Action: In text mode enters math mode (i.e. puts math insets on the current
1531 cursor position), in math mode enters text mode inside math expression.
1532 * \li Notion: If there is some selected text, it puts the text inside created math box.
1533 * \li Syntax: math-mode [<ARG>]
1534 * \li Params: <ARG>: eventual argument (LaTeX code) is passed to #LFUN_MATH_INSERT .
1535 * \li Origin: Alejandro, 4 Jun 1996
1538 { LFUN_MATH_MODE, "math-mode", Noop, Math },
1540 * \var lyx::FuncCode lyx::LFUN_REGEXP_MODE
1541 * \li Action: Enters regexp mode (i.e., puts regexp insets on the current
1542 cursor position). Used by the advanced search dialog.
1543 * \li Notion: If there is any selected text, then it is moved inside the created
1545 * \li Syntax: regexp-mode [<ARG>]
1546 * \li Params: <ARG>: eventual argument (regular expression).
1547 * \li Origin: Tommaso, 4 Oct 2008
1550 { LFUN_REGEXP_MODE, "regexp-mode", Noop, Math },
1552 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
1553 * \li Action: Toggles numbering of the current formula line.
1554 * \li Notion: Must be in display formula mode.
1555 * \li Syntax: math-number-line-toggle
1556 * \li Origin: Alejandro, 18 Jun 1996
1559 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
1561 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
1562 * \li Action: Toggles numbering/labeling of the current formula.
1563 * \li Notion: Must be in display formula mode.
1564 * \li Syntax: math-number-toggle
1565 * \li Origin: Alejandro, 4 Jun 1996
1568 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
1570 * \var lyx::FuncCode lyx::LFUN_MATH_EXTERN
1571 * \li Action: Calls external program and passes the current expression/equation
1572 as an argument for the calculation in the format appropriate to the
1574 * \li Notion: Selection can be used to determine the input for the external program.
1575 * \li Syntax: math-extern <LANG> [<COMMAND>]
1576 * \li Params: <LANG>: octave|maxima|maple|mathematica|script \n
1577 where "script" stands fot the external script (normalized
1578 expression will be passed)
1579 * \li Origin: Andre, 24 Apr 2001
1580 * \li Sample: math-extern maple simplify
1583 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
1585 * \var lyx::FuncCode lyx::LFUN_MATH_SIZE
1586 * \li Action: Changes arbitrarily the size used by math fonts inside a context.
1587 * \li Notion: Provides an interface to the LaTeX math mode font size commands.
1588 * \li Syntax: math-size <STYLE>
1589 * \li Params: <STYLE>: \displaystyle|\textstyle|\scriptstyle|\scriptscriptstyle
1590 * \li Origin: Alejandro, 15 Aug 1996; ps, 14 Jun 2008
1593 { LFUN_MATH_SIZE, "math-size", Noop, Math },
1595 * \var lyx::FuncCode lyx::LFUN_MATH_FONT_STYLE
1596 * \li Action: Changes the text style used in math.
1597 * \li Syntax: math-font-style <STYLE>
1598 * \li Params: <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf
1599 |textnormal|textrm|textsf|texttt|textbf|textmd|textit
1600 |textsc|textsl|textup
1601 * \li Origin: vfr, 9 jan 2009
1604 { LFUN_MATH_FONT_STYLE, "math-font-style", Noop, Math },
1606 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
1607 * \li Action: Unfold a Math Macro.
1608 * \li Notion: Unfold the Math Macro the cursor is in, i.e.
1610 * \li Syntax: math-macro-unfold
1611 * \li Origin: sts, 06 January 2008
1614 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
1616 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
1617 * \li Action: Fold a Math Macro.
1618 * \li Notion: Fold the Math Macro the cursor is in if it was
1619 unfolded, i.e. displayed as \foo before.
1620 * \li Syntax: math-macro-fold
1621 * \li Origin: sts, 06 January 2008
1624 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
1626 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
1627 * \li Action: Add a parameter.
1628 * \li Notion: Add a parameter to a Math Macro.
1629 * \li Params: <NUM>: The number of the parameter behind which the new one
1630 will be added (1 for the first, i.e. use 0 for add a
1631 parameter at the left), defaults to the last one.
1632 * \li Syntax: math-macro-add-param <NUM>
1633 * \li Origin: sts, 06 January 2008
1636 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
1638 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
1639 * \li Action: Remove the last parameter.
1640 * \li Notion: Remove the last parameter of a Math Macro and
1641 remove its value in all instances of the macro
1643 * \li Params: <NUM>: The number of the parameter to be deleted (1 for
1644 the first), defaults to the last one.
1645 * \li Syntax: math-macro-remove-param <NUM>
1646 * \li Origin: sts, 06 January 2008
1649 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
1651 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
1652 * \li Action: Append a greedy parameter.
1653 * \li Notion: Append a greedy parameter to a Math Macro which
1654 eats the following mathed cell in every instance of
1655 the macro in the buffer.
1656 * \li Syntax: math-macro-append-greedy-param
1657 * \li Origin: sts, 06 January 2008
1660 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
1662 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
1663 * \li Action: Remove a greedy parameter.
1664 * \li Notion: Remove a greedy parameter of a Math Macro and spit
1665 out the values of it in every instance of the macro
1666 in the buffer. If it is an optional parameter the [valud]
1668 * \li Syntax: math-macro-remove-greedy-param
1669 * \li Origin: sts, 06 January 2008
1672 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
1674 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
1675 * \li Action: Make a parameter optional.
1676 * \li Notion: Turn the first non-optional parameter of a Math Macro
1677 into an optional parameter with a default value.
1678 * \li Syntax: math-macro-make-optional
1679 * \li Origin: sts, 06 January 2008
1682 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
1684 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
1685 * \li Action: Make a parameter non-optional.
1686 * \li Notion: Turn the last optional parameter of a Math Macro
1687 into a non-optional parameter. The default value is
1688 remembered to be reused later if the user changes his mind.
1689 * \li Syntax: math-macro-make-nonoptional
1690 * \li Origin: sts, 06 January 2008
1693 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
1695 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
1696 * \li Action: Add an optional parameter.
1697 * \li Notion: Insert an optional parameter just behind the
1698 already existing optional parameters.
1699 * \li Syntax: math-macro-add-optional-param
1700 * \li Origin: sts, 06 January 2008
1703 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
1705 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
1706 * \li Action: Remove the last optional parameter.
1707 * \li Notion: Remove the last optional parameter of a Math Macro and
1708 remove it in all the instances of the macro in the buffer.
1709 * \li Syntax: math-macro-remove-optional-param
1710 * \li Origin: sts, 06 January 2008
1713 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
1715 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
1716 * \li Action: Add a greedy optional parameter.
1717 * \li Notion: Add a greedy optional parameter which eats the value
1718 from the following cells in mathed which are in the [value]
1720 * \li Syntax: math-macro-add-greedy-optional-param
1721 * \li Origin: sts, 06 January 2008
1724 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
1726 * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
1727 * \li Action: Only active in Math Macro definition.
1728 * \li Notion: Dummy function which is only active in a Math Macro definition.
1729 It's used to toggle the Math Macro toolbar if the cursor moves
1730 into a Math Macro definition.
1731 * \li Syntax: in-mathmacrotemplate
1732 * \li Origin: sts, 06 January 2008
1735 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
1738 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
1739 * \li Action: Moves the current paragraph downwards in the document.
1740 * \li Syntax: paragraph-move-down
1741 * \li Origin: Edwin, 8 Apr 2006
1744 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
1746 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
1747 * \li Action: Moves the current paragraph upwards in the document.
1748 * \li Syntax: paragraph-move-up
1749 * \li Origin: Edwin, 8 Apr 2006
1752 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
1755 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP
1756 * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1757 in upward direction.
1758 * \li Syntax: paragraph-up
1759 * \li Origin: Asger, 1 Oct 1996
1762 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
1764 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP_SELECT
1765 * \li Action: Move the cursor and select the text to the next paragraph (or
1766 begining of the current one) in upward direction.
1767 * \li Syntax: paragraph-up-select
1768 * \li Origin: Asger, 1 Oct 1996
1771 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
1773 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN
1774 * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1775 in downward direction.
1776 * \li Syntax: paragraph-down
1777 * \li Origin: Asger, 1 Oct 1996
1780 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
1782 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN_SELECT
1783 * \li Action: Move the cursor and select the text to the next paragraph (or
1784 begining of the current one) in downward direction.
1785 * \li Syntax: paragraph-down-select
1786 * \li Origin: Asger, 1 Oct 1996
1789 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
1791 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
1792 * \li Action: Jump to a paragraph given by its id number and optionally the
1793 desired position within the paragraph.
1794 * \li Notion: Note that id number of paragraph is not the sequential number of paragraph
1795 seen on the screen. Moreover the id is unique for all opened buffers (documents).
1796 * \li Syntax: paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
1797 * \li Params: <PAR_ID_NUMBER>: paragraph id \n
1798 <POSITION_IN_PAR>: desired position within the paragraph
1799 * \li Origin: Dekel, 26 Aug 2000
1802 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly, Edit },
1804 * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1805 * \li Action: Breaks the current paragraph at the current location.
1806 * \li Syntax: break-paragraph
1809 { LFUN_PARAGRAPH_SPACING, "paragraph-spacing", Noop, Edit },
1811 * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1812 * \li Action: Breaks the current paragraph at the current location.
1813 * \li Notion: Removes the selection.
1814 * \li Syntax: break-paragraph [<LAYOUT>]
1815 * \li Params: <LAYOUT>: "inverse" - decreases depth by one (or change layout
1816 to default layout) when the cursor is at the end of
1820 { LFUN_BREAK_PARAGRAPH, "break-paragraph", Noop, Edit },
1822 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
1823 * \li Action: Change paragraph settings.
1824 * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
1825 This function only modifies, and does not override, existing settings.
1826 Note that the "leftindent" indent setting is deprecated.
1827 * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
1828 * \li Params: <INDENT>: \\noindent|\\indent|\\indent-toggle|\\leftindent LENGTH\n
1829 <SPACING>: \\paragraph_spacing default|single|onehalf|double|other\n
1830 <ALIGN>: \\align block|left|right|center|default\n
1831 <OTHERS>: \\labelwidthstring WIDTH|\\start_of_appendix\n
1832 * \li Origin: rgh, Aug 15 2007
1835 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
1837 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
1838 * \li Action: Change paragraph settings.
1839 * \li Notion: Overwrite all nonspecified settings to the default ones.
1840 Use paragraph-params lfun if you don't want to overwrite others settings.
1841 * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
1842 * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
1843 * \li Origin: leeming, 30 Mar 2004
1846 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
1848 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UPDATE
1849 * \li Action: Updates the values inside the paragraph dialog from the paragraph.
1850 * \li Notion: This is internal LFUN, not to be used by users. Called internally
1851 by #LFUN_DIALOG_UPDATE.
1852 * \li Origin: leeming, 13 Mar 2003
1855 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
1858 * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
1859 * \li Action: Move the current group in the upward direction in the
1860 structure of the document.
1861 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1862 the whole substructure of the group.
1863 * \li Syntax: outline-up
1864 * \li Origin: Vermeer, 23 Mar 2006
1867 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
1869 * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
1870 * \li Action: Move the current group in the downward direction in the
1871 structure of the document.
1872 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1873 the whole substructure of the group.
1874 * \li Syntax: outline-down
1875 * \li Origin: Vermeer, 23 Mar 2006
1878 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
1880 * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
1881 * \li Action: Moves the current group in the downward direction in the
1882 hierarchy of the document structure.
1883 * \li Notion: Part -> Chapter -> Section -> etc.
1884 * \li Syntax: outline-in
1885 * \li Origin: Vermeer, 23 Mar 2006
1888 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
1890 * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
1891 * \li Action: Moves the current group in the upward direction in the
1892 hierarchy of the document structure.
1893 * \li Notion: Part <- Chapter <- Section <- etc.
1894 * \li Syntax: outline-out
1895 * \li Origin: Vermeer, 23 Mar 2006
1898 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
1900 * \var lyx::FuncCode lyx::LFUN_INSET_EDIT
1901 * \li Action: Edit the inset at cursor with an external application,
1902 * if one is attributed.
1903 * \li Syntax: inset-edit [<INSET_PARAMS>]
1904 * \li Params: <INSET_PARAMS>: Parameters for the inset. \n
1905 Currently only the filename will be considered.
1906 * \li Origin: JSpitzm, 27 Apr 2006
1909 { LFUN_INSET_EDIT, "inset-edit", ReadOnly, Edit },
1912 * \var lyx::FuncCode lyx::LFUN_TABULAR_INSERT
1913 * \li Action: Inserts table into the document.
1914 * \li Syntax: tabular-insert [<ROWS> <COLUMNS>]
1915 * \li Params: In case no arguments are given show insert dialog.
1916 * \li Origin: Jug, 12 Apr 2000
1919 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
1921 * \var lyx::FuncCode lyx::LFUN_TABULAR_FEATURE
1922 * \li Action: Sets various features to the table/cell on the current cursor position.
1923 * \li Notion: Various math-environment features are handled here as well, e.g.
1924 add-vline-left/right for Grid/Cases environment
1925 * \li Syntax: tabular-feature <FEATURE> [<ARG>]
1926 * \li Params: <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|copy-column|
1927 toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
1928 align-left|align-right|align-center|align-block|valign-top|valign-bottom|
1929 valign-middle|m-align-left|m-align-right|m-align-center|m-valign-top|
1930 m-valign-bottom|m-valign-middle|multicolumn|set-all-lines|unset-all-lines|
1931 set-longtabular|unset-longtabular|set-pwidth|set-mpwidth|
1932 set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|
1933 set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|
1934 unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|
1935 set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
1936 set-special-column|set-special-multi|set-booktabs|unset-booktabs|
1937 set-top-space|set-bottom-space|set-interline-space|set-border-lines|
1938 tabular-valign-top|tabular-valign-middle|tabular-valign-bottom \n
1939 <ARG>: additional argument for some commands, use debug mode to explore its values.
1940 * \li Origin: Jug, 28 Jul 2000
1943 { LFUN_TABULAR_FEATURE, "tabular-feature", Noop, Edit },
1945 * \var lyx::FuncCode lyx::LFUN_CELL_BACKWARD
1946 * \li Action: Moves the cursor to the previous cell inside the table.
1947 * \li Syntax: cell-backward
1948 * \li Origin: Jug, 22 May 2000
1951 { LFUN_CELL_BACKWARD, "cell-backward", Noop, Edit },
1953 * \var lyx::FuncCode lyx::LFUN_CELL_FORWARD
1954 * \li Action: Moves the cursor to the next cell inside the table.
1955 * \li Syntax: cell-forward
1958 { LFUN_CELL_FORWARD, "cell-forward", Noop, Edit },
1960 * \var lyx::FuncCode lyx::LFUN_CELL_SPLIT
1961 * \li Action: Splits cell and shifts right part to the next cell (inside the math grid).
1962 * \li Syntax: cell-split
1963 * \li Origin: Ale, 15 May 1997
1966 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
1969 * \var lyx::FuncCode lyx::LFUN_VC_REGISTER
1970 * \li Action: Register the document as an file inside version control system (RCS, CVS).
1971 * \li Notion: File is registered inside cvs, svn or rcs repository acording to the existence
1972 of cvs/svn/rcs entries in the document's directory. \n
1973 See LyX Additional Features Manual (Version Control Chapter) for additional
1975 * \li Syntax: vc-register
1976 * \li Origin: Lgb, 1 Jul 1997
1979 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
1981 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_IN
1982 * \li Action: Checks-in/commits the changes of the registered file to the repository.
1983 * \li Notion: In RCS case this also unlocks the file.
1984 * \li Syntax: vc-check-in
1985 * \li Origin: Lgb, 1 Jul 1997
1988 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
1990 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_OUT
1991 * \li Action: Checks-out the document for edit (and locks it for RCS).
1992 * \li Notion: This is implemented only for RCS and SVN, not CVS.
1993 * \li Syntax: vc-check-out
1994 * \li Origin: Lgb, 1 Jul 1997
1997 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
1999 * \var lyx::FuncCode lyx::LFUN_VC_REVERT
2000 * \li Action: Reverts the document to the last check-in/commit in VCS.
2001 * \li Syntax: vc-revert
2002 * \li Origin: Lgb, 1 Jul 1997
2005 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
2007 * \var lyx::FuncCode lyx::LFUN_VC_UNDO_LAST
2008 * \li Action: Undo last check-in.
2009 * \li Notion: This is currently implemented only for RCS.
2010 * \li Syntax: vc-check-out
2011 * \li Origin: Lgb, 1 Jul 1997
2014 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
2016 * \var lyx::FuncCode lyx::LFUN_VC_COMMAND
2017 * \li Action: Executes external command. This command is intended to support
2018 additional VCS commands.
2019 * \li Syntax: vc-command <FLAG> <PATH> <COMMAND>
2020 * \li Params: <FLAG>: Flags for the command can be combined together.\n
2021 U - dUmmy - no flags \n
2022 D - Doc - need document loaded to proceed \n
2023 I - dIrty - mark document dirty \n
2024 R - Reload - ensure that the document is saved and reload it after command execution \n
2025 M - Message - ask for input string (commit message)\n
2026 <PATH>: path where to start. $$p will be replaced by the current document path.\n
2027 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current document/path/message.
2028 * \li Sample: vc-command DR $$p "svn up"
2029 * \li Origin: sanda, 13 Jan 2009
2032 { LFUN_VC_COMMAND, "vc-command", NoBuffer | ReadOnly, System },
2035 * \var lyx::FuncCode lyx::LFUN_CHANGES_TRACK
2036 * \li Action: Toggles change tracking to on/off.
2037 * \li Syntax: changes-track
2038 * \li Origin: levon, 1 Oct 2002
2041 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
2043 * \var lyx::FuncCode lyx::LFUN_CHANGES_OUTPUT
2044 * \li Action: Toggles showing of change tracking in typesetted output.
2045 * \li Syntax: changes-output
2046 * \li Origin: jspitzm, 21 Jan 2005
2049 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
2051 * \var lyx::FuncCode lyx::LFUN_CHANGE_NEXT
2052 * \li Action: Moves the cursor to the position of the next change
2053 of the change tracking records.
2054 * \li Syntax: change-next
2055 * \li Origin: schmitt, 4 Oct 2006
2058 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
2060 * \var lyx::FuncCode lyx::LFUN_CHANGES_MERGE
2061 * \li Action: Open change tracking dialog for merging and moves the cursor
2062 to the position of the next change.
2063 * \li Syntax: changes-merge
2064 * \li Origin: Levon, 16 Oct 2002
2067 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
2069 * \var lyx::FuncCode lyx::LFUN_CHANGE_ACCEPT
2070 * \li Action: Accepts tracked change inside the selection.
2071 * \li Syntax: change-accept
2072 * \li Origin: Levon, 16 Oct 2002
2075 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
2077 * \var lyx::FuncCode lyx::LFUN_CHANGE_REJECT
2078 * \li Action: Rejects tracked change inside the selection.
2079 * \li Syntax: change-accept
2080 * \li Origin: Levon, 16 Oct 2002
2083 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
2085 * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_ACCEPT
2086 * \li Action: Accepts all tracked changes in the document.
2087 * \li Syntax: all-changes-accept
2088 * \li Origin: Levon, 16 Oct 2002
2091 { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
2093 * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_REJECT
2094 * \li Action: Rejects all tracked changes in the document.
2095 * \li Notion: Reject does not work recursively; the user may have to repeat the operation.
2096 * \li Syntax: all-changes-reject
2097 * \li Origin: Levon, 16 Oct 2002
2100 { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
2103 * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
2104 * \li Action: Apply data for an inset.
2105 * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
2106 be applied. This is either changed to #LFUN_INSET_MODIFY or
2107 #LFUN_INSET_INSERT depending on the context where it is called.
2108 * \li Syntax: inset-apply <ARGS>
2109 * \li Params: See #LFUN_INSET_INSERT .
2112 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
2114 * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE
2115 * \li Action: Dissolve the current inset into text.
2116 * \li Syntax: inset-dissolve [<INSET>]
2117 * \li Params: <INSET>: this can be used to make sure the right kind of inset
2118 is dissolved. For example "dissolve" entry in the charstyles
2119 sub-menu should only dissolve the charstyle inset, even if the
2120 cursor is inside several nested insets of different type.\n
2121 For values see #lyx::InsetLayout::lyxtype_ .
2122 * \li Origin: JSpitz, 7 Aug 2006
2125 { LFUN_INSET_DISSOLVE, "inset-dissolve", Noop, Edit },
2127 * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
2128 * \li Action: Insert new inset (type given by the parameters).
2129 * \li Syntax: inset-insert <INSET> <ARGS>
2130 * \li Params: <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics|
2131 hyperlink|include|index|label|nomencl|vspace|ref|toc>\n
2132 <ARGS>: depends on the given inset. Use "lyx -dbg action" to
2134 * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
2135 where <label name> is the name of the referenced label and
2136 <Format> is one of the following: \n
2137 ref -- <reference> \n
2138 eqref -- (<reference>) \n
2139 pageref -- <page> \n
2140 vpageref -- on <page> \n
2141 vref -- <reference> on <page> \n
2142 prettyref -- Formatted reference
2145 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
2147 * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
2148 * \li Action: Modify existing inset.
2149 * \li Notion: Used for bibitem, bibtex, box, branch, command, ert, external,
2150 floats, graphics, include, label, listings, note,
2151 phantom, ref, space, tabular, vspace, wrap insets.
2152 * \li Syntax: inset-modify <INSET> <ARGS>
2153 * \li Params: See #LFUN_INSET_INSERT for further details.
2156 { LFUN_INSET_MODIFY, "", Noop, Hidden },
2158 * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_MODIFY
2159 * \li Action: Modify the inset at cursor position, if there is one.
2160 * \li Notion: Used for bibitem, bibtex, box, branch, command, ert, external,
2161 floats, graphics, include, label, listings, note,
2162 phantom, ref, space, tabular, vspace, wrap insets.
2163 * \li Syntax: next-inset-modify <INSET> <ARGS>
2164 * \li Syntax: next-inset-modify changetype <TYPE>
2165 * \li Params: See #LFUN_INSET_INSERT for further details.
2166 * \li Origin: JSpitzm, 23 Mar 2008
2169 { LFUN_NEXT_INSET_MODIFY, "next-inset-modify", Noop, Edit },
2171 * \var lyx::FuncCode lyx::LFUN_INSET_DIALOG_UPDATE
2172 * \li Action: Updates the values inside the dialog from the inset.
2173 * \li Notion: This is internal LFUN, not to be used by users. Called internally
2174 by #LFUN_DIALOG_UPDATE
2175 * \li Params: <DIALOG-NAME>
2176 * \li Origin: leeming, 25 Feb 2003
2179 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
2181 * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
2182 * \li Action: Open the inset's properties dialog.
2183 * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
2184 * \li Syntax: inset-settings <INSET>
2185 * \li Params: <INSET>: <box|branch|ert|float|listings|note|phantom|tabular|wrap>
2188 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly, Edit },
2190 * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_TOGGLE
2191 * \li Action: Toggles the inset at cursor position. For collapsables, this means it will
2192 be (un-)collapsed, in case of other insets, the editing widget (dialog) will
2193 be entered. Also cf. #LFUN_INSET_SETTINGS.
2194 * \li Notion: Used for bibitem, bibtex, box, branch, command, ert, external,
2195 floats, graphics, include, label, listings, note,
2196 phantom, ref, space, tabular, vspace, wrap insets.
2197 * \li Syntax: next-inset-toggle <ARG>
2198 * \li Params: <ARG>: these are passed as arguments to #LFUN_INSET_TOGGLE .
2199 * \li Origin: leeming, 30 Mar 2004
2202 { LFUN_NEXT_INSET_TOGGLE, "next-inset-toggle", ReadOnly, Edit },
2204 * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
2205 * \li Action: Toggles the collapsable inset we are currently in.
2206 * \li Syntax: inset-toggle [<ARG>]
2207 * \li Params: <ARG>: <open|close|toggle|assign>. \n
2208 open/close/toggle are for collapsable insets. close can be currently used
2209 by #LFUN_NEXT_INSET_TOGGLE. toggle is used when no argument is given.\n
2210 assign is for branch inset.
2211 * \li Origin: lasgouttes, 19 Jul 2001
2214 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly, Hidden },
2216 * \var lyx::FuncCode lyx::LFUN_ALL_INSETS_TOGGLE
2217 * \li Action: Toggles (open/closes) all collapsable insets (of a given type) in the document.
2218 * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
2219 * \li Syntax: all-insets-toggle <STATE> <INSET>
2220 * \li Params: <STATE>: <toggle|open|close> default: toggle \n
2221 <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all insets
2222 * \li Origin: leeming, 30 Mar 2004
2225 { LFUN_ALL_INSETS_TOGGLE, "all-insets-toggle", ReadOnly, Edit },
2227 * \var lyx::FuncCode lyx::LFUN_SET_GRAPHICS_GROUP
2228 * \li Action: Set the group for the graphics inset on the cursor position.
2229 * \li Syntax: set-graphics-group [<GROUP>]
2230 * \li Params: <GROUP>: Id for an existing group. In case the Id is an empty string,
2231 the graphics inset is removed from the current group.
2232 * \li Origin: sanda, 6 May 2008
2235 { LFUN_SET_GRAPHICS_GROUP, "set-graphics-group", Noop, Edit },
2238 * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
2239 * \li Action: Moves the cursor out of the current slice, going forward.
2240 * \li Notion: Cursor movement within an inset may be different than cursor
2241 movement in the surrounding text. This action should be called
2242 automatically by the cursor movement within the inset, when
2243 movement within the inset has ceased (reached the end of the
2244 last paragraph, for example), in order to move correctly
2245 back into the surrounding text.
2248 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
2250 * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
2251 * \li Action: Moves the cursor out of the current slice, going backwards.
2252 * \li Notion: See also #LFUN_FINISHED_FORWARD.
2255 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
2257 * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
2258 * \li Action: Moves the cursor out of the current slice, going right.
2259 * \li Notion: See also #LFUN_FINISHED_FORWARD
2262 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
2264 * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
2265 * \li Action: Moves the cursor out of the current slice, going left.
2266 * \li Notion: See also #LFUN_FINISHED_FORWARD.
2269 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
2272 * \var lyx::FuncCode lyx::LFUN_LANGUAGE
2273 * \li Action: Set language from the current cursor position.
2274 * \li Syntax: language <LANG>
2275 * \li Params: <LANG>: Requested language. Look in lib/languages for
2277 * \li Origin: Dekel, 2 Mar 2000
2280 { LFUN_LANGUAGE, "language", Noop, Edit },
2283 * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
2284 * \li Action: Goto a label.
2285 * \li Syntax: label-goto [<LABEL>]
2286 * \li Params: <LABEL>: Requested label. If no label is given and refernce
2287 is on cursor position, Bookmark 0 is saved and
2288 cursor moves to the position of referenced label.
2289 * \li Origin: Ale, 6 Aug 1997
2292 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
2294 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT
2295 * \li Action: Inserts label to text or displayed formula.
2296 * \li Syntax: label-insert [<LABEL>]
2297 * \li Params: <LABEL>: Requested label. If no label is given dialog requesting
2298 name will be opened.
2301 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
2303 * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
2304 * \li Action: Go to the next label or cross-reference.
2305 * \li Syntax: reference-next
2306 * \li Origin: Dekel, 14 Jan 2001
2309 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
2312 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
2313 * \li Action: Moves the cursor to the numbered bookmark, opening the file
2314 if necessary. Note that bookmarsk are saved per-session, not
2316 * \li Notion: Bookmark 0 has a special purpose. It is automatically set \n
2317 1. to the paragraph you are currently editing \n
2318 2. to the paragraph from where you are jumping to the last-edited
2319 position (jump-back feature) \n
2320 3. when jumping from crossreference to the requested label by
2322 * \li Syntax: bookmark-goto <NUMBER>
2323 * \li Params: <NUMBER>: the number of the bookmark to restore.
2324 * \li Origin: Dekel, 27 January 2001
2327 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
2329 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
2330 * \li Action: Save a bookmark.
2331 * \li Notion: Saves a numbered bookmark to the sessions file. The number
2332 must be between 1 and 9, inclusive. Note that bookmarks are
2333 saved per-session, not per file.
2334 * \li Syntax: bookmark-save <NUMBER>
2335 * \li Params: <NUMBER>: the number of the bookmark to save.
2336 * \li Origin: Dekel, 27 January 2001
2339 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
2341 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
2342 * \li Action: Clears the list of saved bookmarks.
2343 * \li Syntax: bookmark-clear
2344 * \li Origin: bpeng, 31 October 2006
2347 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
2350 * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
2351 * \li Action: Open the given help file according to the language setting.
2352 * \li Syntax: help-open <FILE>[.lyx]
2353 * \li Params: <FILE>: any document from (/usr/share/)doc directory.
2354 * \li Origin: Jug, 27 Jun 1999
2357 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
2359 * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
2360 * \li Action: Terminates the current LyX instance.
2361 * \li Notion: Terminates the current LyX instance, asking whether to save
2362 modified documents, etc.
2363 * \li Syntax: lyx-quit
2366 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
2368 * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
2369 * \li Action: Toggles visibility of a given toolbar between on/off/auto.
2370 * \li Notion: Skiping "auto" when allowauto is false.
2371 * \li Syntax: toolbar-toggle <NAME> [allowauto]
2372 * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|
2373 minibuffer|review|view/update|math_panels|vcs
2374 * \li Origin: Edwin, 21 May 2007
2377 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
2379 * \var lyx::FuncCode lyx::LFUN_MENU_OPEN
2380 * \li Action: Opens the menu given by its name.
2381 * \li Syntax: menu-open <NAME>
2382 * \li Params: <NAME>: menu name. See various .inc files in lib/ui for candidates.
2385 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
2387 * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
2388 * \li Action: Various UI visibility-toggling actions.
2389 * \li Syntax: ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
2390 * \li Params: statusbar : Toggle visibility of the statusbar.\n
2391 menubar : Toggle visibility of the menubar.\n
2392 scrollbar : Toggle visibility of the scrollbar.\n
2393 frame : Toggle visibility of the frames around editing window.\n
2394 fullscreen : Toggle fullscreen mode. This also covers calling the
2395 previous functions. However #LFUN_TOOLBAR_TOGGLE for the
2396 custom tweaks of the toolbars should be used.
2397 * \li Origin: sanda, 9 Feb 2007
2400 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
2403 * \var lyx::FuncCode lyx::WINDOW_NEW
2404 * \li Action: Creates new empty LyX window.
2405 * \li Notion: Already opened documents from the previous window can be found under View menu.
2406 * \li Syntax: window-new [<GEOMETRY>]
2407 * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently
2408 accepted only on Windows platform.
2409 * \li Origin: Abdel, 21 Oct 2006
2412 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
2414 * \var lyx::FuncCode lyx::LFUN_WINDOW_CLOSE
2415 * \li Action: Closes the current LyX window.
2416 * \li Syntax: window-close
2417 * \li Origin: Abdel, 23 Oct 2006
2420 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
2423 * \var lyx::FuncCode lyx::LFUN_SPLIT_VIEW
2424 * \li Action: Creates another split view of current buffer.
2425 * \li Notion: All split views act in the same way indpendently.
2426 * \li Syntax: split-view <vertical|horizontal>
2427 * \li Params: horizontal : The work areas are laid out side by side.\n
2428 vertical : The work areas laid out vertically.
2429 * \li Origin: Abdel, 20 Feb 2008
2432 { LFUN_SPLIT_VIEW, "split-view", ReadOnly, Buffer },
2435 * \var lyx::FuncCode lyx::LFUN_CLOSE_TAB_GROUP
2436 * \li Action: Close the current tab group.
2437 * \li Notion: This only closes the work areas, not the buffer themselves.
2438 The still opened buffers can be visualized in another tab group.
2439 * \li Syntax: close-tab-group
2440 * \li Origin: Abdel, 21 Feb 2008
2443 { LFUN_CLOSE_TAB_GROUP, "close-tab-group", ReadOnly, Buffer },
2445 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW
2446 * \li Action: Shows hidden dialog or create new one for a given function/inset settings etc.
2447 * \li Syntax: dialog-show <NAME> [<DATA>]
2448 * \li Params: <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|\n
2449 document|errorlist|ert|external|file|findreplace|float|graphics|\n
2450 include|index|info|nomenclature|label|listings|log|mathdelimiter|\n
2451 mathmatrix|note|paragraph|phantom|prefs|print|ref|sendto|space|\n
2452 spellchecker|symbols|tabular|tabularcreate|thesaurus|texinfo|toc|href|\n
2453 view-source|vspace|wrap|<SPECIAL> \n
2454 <SPECIAL>: latexlog|vclog \n
2455 <DATA>: data, usually settings for the given dialog. Use debug mode for the
2457 * \li Origin: leeming, 17 Jun 2003
2460 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
2462 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW_NEW_INSET
2463 * \li Action: Shows hidden dialog or create new one for a given inset settings etc.
2464 * \li Notion: Internally uses #LFUN_DIALOG_SHOW with processed data for a given inset.
2465 * \li Syntax: dialog-show-new-inset <NAME> [<DATA>]
2466 * \li Params: See #LFUN_DIALOG_SHOW .
2467 * \li Origin: leeming, 25 Feb 2003
2470 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
2472 * \var lyx::FuncCode lyx::LFUN_DIALOG_UPDATE
2473 * \li Action: Updates the dialog values from the inset/paragraph/document.
2474 * \li Syntax: dialog-update <NAME>
2475 * \li Params: <NAME>: paragraph|prefs|<INSET> \n
2477 * \li Origin: leeming, 25 Feb 2003
2480 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
2482 * \var lyx::FuncCode lyx::LFUN_DIALOG_HIDE
2483 * \li Action: Hides showed dialog. Counterpart to #LFUN_DIALOG_SHOW .
2484 * \li Syntax: dialog-hide <NAME>
2485 * \li Params: See #LFUN_DIALOG_SHOW .
2486 * \li Origin: leeming, 25 Feb 2003
2489 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
2491 * \var lyx::FuncCode lyx::LFUN_DIALOG_TOGGLE
2492 * \li Action: Toggles dialog between showed/hidden state.
2493 * \li Notion: Internally uses #LFUN_DIALOG_SHOW , #LFUN_DIALOG_HIDE .
2494 * \li Syntax: dialog-toggle <NAME> [<DATA>]
2495 * \li Params: See #LFUN_DIALOG_SHOW .
2496 * \li Origin: JSpitzm, 30 Apr 2007
2499 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
2501 * \var lyx::FuncCode lyx::LFUN_DIALOG_DISCONNECT_INSET
2502 * \li Action: Closes opened connection to opened inset.
2503 * \li Notion: Connection is used for apply functions.
2504 * \li Syntax: dialog-disconnect-inset <INSET-NAME>
2505 * \li Origin: leeming, 25 Feb 2003
2508 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
2511 * \var lyx::FuncCode lyx::LFUN_MOUSE_PRESS
2512 * \li Action: This function is called when mouse button is pressed (inside workarea).
2513 Action depends on the context.
2514 * \li Notion: This is internal LFUN, not to be used by users.
2515 * \li Origin: Andre, 9 Aug 2002
2518 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
2520 * \var lyx::FuncCode lyx::LFUN_MOUSE_DOUBLE
2521 * \li Action: This function is called when double click on mouse button is
2522 pressed (inside workarea). Action depends on the context.
2523 * \li Notion: This is internal LFUN, not to be used by users.
2524 * \li Origin: Andre, 9 Aug 2002
2527 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
2529 * \var lyx::FuncCode lyx::LFUN_MOUSE_TRIPLE
2530 * \li Action: This function is called when triple click on mouse button is
2531 pressed (inside workarea). Action depends on the context.
2532 * \li Notion: This is internal LFUN, not to be used by users.
2533 * \li Origin: Andre, 9 Aug 2002
2536 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
2538 * \var lyx::FuncCode lyx::LFUN_MOUSE_MOTION
2539 * \li Action: This function is called when mouse cursor is moving over the text.
2540 Action depends on the context.
2541 * \li Notion: This is internal LFUN, not to be used by users.
2542 * \li Origin: Andre, 9 Aug 2002
2545 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
2547 * \var lyx::FuncCode lyx::LFUN_MOUSE_RELEASE
2548 * \li Action: This function is called when mouse button is released (inside workarea).
2549 Action depends on the context.
2550 * \li Notion: This is internal LFUN, not to be used by users.
2551 * \li Origin: Andre, 9 Aug 2002
2554 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
2557 * \var lyx::FuncCode lyx::LFUN_KEYMAP_OFF
2558 * \li Action: Turn off the loaded keyboard map.
2559 * \li Syntax: keymap-off
2562 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
2564 * \var lyx::FuncCode lyx::LFUN_KEYMAP_PRIMARY
2565 * \li Action: Turn on the primary keyboard map.
2566 * \li Notion: Maps were widely used in past, when X-windows didn't have nowadays
2567 keyboard support. They can be still used to maintain uniform keyboard
2568 layout across the various plaforms.\n
2569 The language is to be set in the Preferences dialog.
2570 * \li Syntax: keymap-primary
2573 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
2575 * \var lyx::FuncCode lyx::LFUN_KEYMAP_SECONDARY
2576 * \li Action: Turn on the secondary keyboard map.
2577 * \li Syntax: keymap-secondary
2580 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
2582 * \var lyx::FuncCode lyx::LFUN_KEYMAP_TOGGLE
2583 * \li Action: Toggles keyboard maps (first/second/off).
2584 * \li Syntax: keymap-toggle
2585 * \li Origin: leeming, 30 Mar 2004
2588 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
2591 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_LAYOUT
2592 * \li Action: Returns the current layout (that is environment) name
2593 on the cursor position.
2594 * \li Syntax: server-get-layout
2597 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
2599 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_FILENAME
2600 * \li Action: Returns path and file name of the currently edited document.
2601 * \li Syntax: server-get-filename
2604 { LFUN_SERVER_GET_FILENAME, "server-get-filename", ReadOnly, System },
2606 * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
2607 * \li Action: Sets the cursor position based on the row number of generated TeX file.
2608 * \li Syntax: server-goto-file-row <LYX_FILE_NAME> <ROW_NUMBER>
2609 * \li Origin: Edmar, 23 Dec 1998
2612 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly, System },
2614 * \var lyx::FuncCode lyx::LFUN_SERVER_NOTIFY
2615 * \li Action: Sends notify message about the last key-sequence to client.
2616 * \li Notion: This can be used to grab last key-sequence used inside the LyX window.
2617 See also Debug extensions section in Additional features manual.
2618 * \li Syntax: server-notify
2621 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
2623 * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
2624 * \li Action: Sets the cursor position based on the editing area coordinates
2625 (similar as clicking on that point with left mouse button).
2626 * \li Syntax: server-set-xy <X> <Y>
2629 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
2631 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
2632 * \li Action: Returns the coordinates of cursor position in the editing area.
2633 * \li Syntax: server-get-xy
2636 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
2639 * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
2640 * \li Action: Generates the code (literate programming).
2641 * \li Notion: Latex file with extension \literate_extension is generated.
2642 Then LyX invokes \build_command (with a default of``make'') to generate the code and
2643 \build_error_filter to process the compilation error messages. \n
2644 In case you want to process your literate file with a script, or some other program,
2645 just insert in your lyxrc file an entry with:\n
2646 \build_command "my_script my_arguments" \n
2647 The \build_error_filter differs from the \literate_error_filter only in that the
2648 former will identify error messages from your compiler.
2649 * \li Syntax: build-program
2652 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
2655 * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
2656 * \li Action: Saves the current buffer to a temporary file.
2657 * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
2658 is called automatically by LyX, to "autosave" the current buffer.
2659 * \li Syntax: buffer-auto-save
2662 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
2664 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHILD_OPEN
2665 * \li Action: Loads the given child document.
2666 * \li Notion: The current document is treated as a parent.
2667 * \li Syntax: buffer-child-open <FILE>
2668 * \li Params: <FILE>: Filename of the child. The directory of the parent is assumed by default.
2669 * \li Origin: Ale, 28 May 1997
2672 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
2674 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHKTEX
2675 * \li Action: Runs chktex for the current document.
2676 * \li Syntax: buffer-chktex
2677 * \li Origin: Asger, 30 Oct 1997
2680 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
2682 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
2683 * \li Action: Toggles compression of the current document on/off.
2684 * \li Syntax: buffer-toggle-compression
2685 * \li Origin: bpeng, 27 Apr 2006
2688 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
2690 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
2691 * \li Action: Closes the current buffer.
2692 * \li Notion: Closes the current buffer, asking whether to save it, etc,
2693 if the buffer has been modified.
2694 * \li Syntax: buffer-close
2697 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
2699 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
2700 * \li Action: Exports the current buffer (document) to the given format.
2701 * \li Syntax: buffer-export <FORMAT>
2702 * \li Params: <FORMAT> is either "custom" or one of the formats which you
2703 can find in Tools->Preferences->File formats->Format.
2704 Usual format you will enter is "pdf2" (pdflatex),
2705 "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
2706 In case of "custom" you will be asked for a format you
2707 want to start from and for the command that you want to
2708 apply to this format. Internally the control is then passed
2709 to #LFUN_BUFFER_EXPORT_CUSTOM.
2710 * \li Origin: Lgb, 29 Jul 1997
2713 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
2715 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
2716 * \li Action: Exports the current buffer (document) from the given format using
2717 the given command on it.
2718 * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
2719 * \li Params: <FORMAT> format to start from (LyX will care to produce such
2720 intermediate file).\n
2721 <COMMAND> this command will be launched on the file. Note that you can
2722 use "$$FName" string to qualify the intermediate file.
2723 * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
2724 * \li Origin: leeming, 27 Mar 2004
2727 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
2729 * \var lyx::FuncCode lyx::LFUN_BUFFER_PRINT
2730 * \li Action: Prints the current document.
2731 * \li Notion: Many settings can be given via the preferences dialog.
2732 * \li Syntax: buffer-print <TARGET> <TARGET-NAME> <COMMAND>
2733 * \li Params: <TARGET> is either "printer" or "file".\n
2734 <TARGER-NAME> is either "default" or file name or printer name.\n
2735 <COMMAND> command ensuring the printing job.
2736 * \li Sample: buffer-print file "/trash/newfile1.ps" "dvips"
2737 * \li Origin: leeming, 28 Mar 2004
2740 { LFUN_BUFFER_PRINT, "buffer-print", ReadOnly, Buffer },
2742 * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
2743 * \li Action: Import a given file as a lyx document.
2744 * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
2745 defined convertors in preferences. Look into File->Import menu to get
2746 an idea of the currently active import formats.
2747 * \li Syntax: buffer-import <FORMAT> [<FILE>]
2748 * \li Origin: Asger, 24 Jul 1998
2751 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
2753 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
2754 * \li Action: Creates a new buffer (that is, document).
2755 * \li Notion: Implicit path can be set in Preferences dialog.
2756 * \li Syntax: buffer-new [<FILE>]
2757 * \li Params: <FILE>: filename of created file with absolute path.
2760 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
2762 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
2763 * \li Action: Creates a new buffer (that is, document) from a template.
2764 * \li Notion: Path for new files and templates can be set in Preferences dialog.
2765 Template will be asked for via Open-dialog.
2766 * \li Syntax: buffer-new-template [<FILE>]
2767 * \li Params: <FILE>: filename of created file with absolute path.
2770 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
2772 * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
2773 * \li Action: Reverts opened document.
2774 * \li Syntax: buffer-reload
2775 * \li Origin: Asger, 2 Feb 1997
2778 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
2780 * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
2781 * \li Action: Switch to the given buffer.
2782 * \li Notion: This is useful also in case you need simultaneously more views of the edited
2783 document in different LyX windows.
2784 * \li Syntax: buffer-new-template <BUFFER>
2785 * \li Params: <BUFFER>: already opened document which is to be shown.
2788 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
2790 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
2791 * \li Action: Toggle editing mode of the current document between read/write and read-only.
2792 * \li Notion: In the ->Readonly mode checks-in/commits the data if the file is under version control.
2793 In the Readonly-> mode checkouts the data from repository. \n
2794 If these operations fail, buffer won't be toggled.
2795 * \li Syntax: buffer-toggle-read-only
2796 * \li Origin: Lgb, 27 May 1997
2799 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
2801 * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
2802 * \li Action: Displays current buffer in chosen format.
2803 * \li Notion: Displays the contents of the current buffer in the chosen
2804 format, for example, PDF or DVI. This runs the necessary
2805 converter, calls the defined viewer, and so forth.
2806 * \li Syntax: buffer-view <FORMAT>
2807 * \li Params: <FORMAT>: The format to display, where this is one of the
2808 formats defined (in the current GUI) in the
2809 Tools>Preferences>File Formats dialog.
2812 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
2814 * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
2815 * \li Action: Exports the current document and put the result into the
2816 temporary directory.
2817 * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
2818 the output will be rewriten - updated. This is useful in case your viewer
2819 is able to detect such changes (e.g. ghostview for postscript).
2820 * \li Syntax: buffer-update <FORMAT>
2821 * \li Params: <FORMAT>: The format to display, where this is one of the
2822 formats defined (in the current GUI) in the
2823 Tools>Preferences>File Formats dialog.
2824 * \li Origin: Dekel, 5 Aug 2000
2827 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
2830 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
2831 * \li Action: Saves the current buffer.
2832 * \li Notion: Saves the current buffer to disk, using the filename that
2833 is already associated with the buffer, asking for one if
2834 none is yet assigned.
2835 * \li Syntax: buffer-write
2838 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
2840 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
2841 * \li Action: Rename and save current buffer.
2842 * \li Syntax: buffer-write-as <FILENAME>
2843 * \li Params: <FILENAME>: New name of the buffer/file. A relative path
2844 is with respect to the original location of the buffer/file.
2847 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
2849 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
2850 * \li Action: Save all changed documents.
2851 * \li Syntax: buffer-write-all
2852 * \li Origin: rgh, gpothier 6 Aug 2007
2855 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
2857 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEXT
2858 * \li Action: Switch to the next opened document.
2859 * \li Notion: Note that this does not necessarily mean next in tabbar
2860 (for full list see View menu).
2861 * \li Syntax: buffer-next
2864 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
2866 * \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS
2867 * \li Action: Switch to the previous opened document.
2868 * \li Syntax: buffer-previous
2871 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
2873 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
2874 * \li Action: When run from a child document, this updates (exports) document built
2875 from the master buffer. If a master is not found, it updates the
2877 * \li Syntax: master-buffer-update
2878 * \li Origin: Tommaso, 20 Sep 2007
2881 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
2883 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
2884 * \li Action: When run from a child document, this command shows a preview built
2885 from the master buffer. If a master is not found, it previews the
2887 * \li Syntax: master-buffer-view
2888 * \li Origin: Tommaso, 20 Sep 2007
2891 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
2893 * \var lyx::FuncCode lyx::LFUN_BUFFER_LANGUAGE
2894 * \li Action: Set language of the current document.
2895 * \li Syntax: buffer-language <LANG>
2896 * \li Params: <LANG>: language name. See lib/languages for list.
2897 * \li Origin: leeming, 30 Mar 2004
2900 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
2902 * \var lyx::FuncCode lyx::LFUN_BUFFER_SAVE_AS_DEFAULT
2903 * \li Action: Save the current document settings as default.
2904 * \li Notion: The file will will be saved into ~/.lyx/templates/defaults.lyx .
2905 * \li Syntax: buffer-save-as-default [<ARGS>]
2906 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
2907 you can find in document header of usual .lyx file.
2908 * \li Origin: leeming, 30 Mar 2004
2911 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
2913 * \var lyx::FuncCode lyx::LFUN_BUFFER_PARAMS_APPLY
2914 * \li Action: Apply the given settings to the current document.
2915 * \li Syntax: buffer-params-apply [<ARGS>]
2916 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
2917 you can find in document header of usual .lyx file.
2918 * \li Origin: leeming, 30 Mar 2004
2921 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", Noop, Buffer },
2924 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
2925 * \li Action: Inserts another LyX file.
2926 * \li Syntax: file-insert [<FILE>]
2927 * \li Params: <FILE>: Filename to be inserted.
2930 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
2932 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
2933 * \li Action: Inserts plain text file.
2934 * \li Syntax: file-insert-plaintext [<FILE>]
2935 * \li Params: <FILE>: Filename to be inserted.
2936 * \li Origin: CFO-G, 19 Nov 1997
2939 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
2941 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
2942 * \li Action: Inserts plain text file as paragraph (i.e. join lines).
2943 * \li Syntax: file-insert-plaintext-para [<FILE>]
2944 * \li Params: <FILE>: Filename to be inserted.
2945 * \li Origin: Levon, 14 Feb 2001
2948 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
2950 * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
2951 * \li Action: Open LyX document.
2952 * \li Syntax: file-open [<FILE>]
2953 * \li Params: <FILE>: Filename to be opened.
2956 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
2959 * \var lyx::FuncCode lyx::LFUN_CALL
2960 * \li Action: Executes a command defined in a .def file.
2961 * \li Notion: The definitions are by default read from lib/commands/default.def.\n
2962 A .def file allows to define a command with \\define "<NAME>" "<LFUN>"
2963 where <NAME> is the name of the new command and <LFUN> is the lfun code
2964 to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
2965 \\def_file "FileName" allows to include another .def file. \n
2966 This is particularly useful in connection with toolbar buttons:
2967 Since the name of the button image for this lfun is
2968 lib/images/commands/<NAME>.png this is the way to assign an image
2969 to a complex command-sequence.
2970 * \li Syntax: call <NAME>
2971 * \li Params: <NAME>: Name of the command that must be called.
2972 * \li Origin: broider, 2 Oct 2007
2975 { LFUN_CALL, "call", NoBuffer, System },
2977 * \var lyx::FuncCode lyx::LFUN_META_PREFIX
2978 * \li Action: Simulate halting Meta key (Alt key on PCs).
2979 * \li Notion: Used for buffer editation not for GUI control.
2980 * \li Syntax: meta-prefix
2983 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
2985 * \var lyx::FuncCode lyx::LFUN_CANCEL
2986 * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
2987 * \li Syntax: cancel
2990 { LFUN_CANCEL, "cancel", NoBuffer, System },
2993 * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
2994 * \li Action: Opens the minibuffer toolbar so that the user can type in there.
2995 * \li Notion: Usually bound to M-x shortcut.
2996 * \li Syntax: command-execute
2999 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
3001 * \var lyx::FuncCode lyx::LFUN_COMMAND_PREFIX
3002 * \li Action: Return the current key sequence and available options as a string.
3003 * \li Notion: No options are added if no current map exists. \n
3004 This is probably usable only with connection to lyxserver.
3005 * \li Syntax: command-prefix
3008 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
3010 * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
3011 * \li Action: Run more commands (LFUN and its parameters) in a sequence.
3012 * \li Syntax: command-sequence <CMDS>
3013 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
3014 * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
3015 * \li Origin: Andre, 11 Nov 1999
3018 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
3020 * \var lyx::FuncCode lyx::LFUN_COMMAND_ALTERNATIVES
3021 * \li Action: Runs the first listed command that is enabled.
3022 * \li Notion: This can be used to bind multiple functions to a single key,
3023 and then which one is used will depend upon the context.
3024 * \li Syntax: command-alternatives <CMDS>
3025 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
3026 * \li Sample: command-alternatives completion-accept;cell-forward
3027 * \li Origin: rgh, 24 September 2008
3030 { LFUN_COMMAND_ALTERNATIVES, "command-alternatives", NoBuffer, System },
3032 * \var lyx::FuncCode lyx::LFUN_MESSAGE
3033 * \li Action: Shows message in statusbar (for script purposes).
3034 * \li Syntax: message <STRING>
3035 * \li Origin: Lgb, 8 Apr 2001
3038 { LFUN_MESSAGE, "message", NoBuffer, System },
3040 * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
3041 * \li Action: Save user preferences.
3042 * \li Syntax: preferences-save
3043 * \li Origin: Lgb, 27 Nov 1999
3046 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
3048 * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
3049 * \li Action: Reconfigure the automatic settings.
3050 * \li Syntax: reconfigure
3051 * \li Origin: Asger, 14 Feb 1997
3054 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
3056 * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
3057 * \li Action: Apply the given settings to user preferences.
3058 * \li Syntax: lyxrc-apply <SETTINGS>
3059 * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
3060 to get an idea which commands to use and their syntax.
3061 #lyx::LyXRC::LyXRCTags has the list of possible commands.
3064 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
3066 * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
3067 * \li Action: Determine whether keep cursor inside the editing window regardless
3068 the scrollbar movement.
3069 * \li Syntax: toggle-cursor-follows-scrollbar
3070 * \li Origin: ARRae, 2 Dec 1997
3073 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
3075 * \var lyx::FuncCode lyx::LFUN_SET_COLOR
3076 * \li Action: Set the given LyX color to the color defined by the X11 name given.
3077 * \li Notion: A new color entry is created if the color is unknown.
3078 Color names can be stored as a part of user settings.
3079 * \li Syntax: set-color <LYX_NAME> <X11_NAME>
3080 * \li Origin: SLior, 11 Jun 2000
3083 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
3085 * \var lyx::FuncCode lyx::LFUN_STATISTICS
3086 * \li Action: Count the statistics (number of words and characters)
3087 in the document or in the given selection.
3088 * \li Notion: Note that this function gives the number of words/chars written,
3089 not the number of characters which will be typeset.
3090 * \li Syntax: statistics
3091 * \li Origin: lasgouttes, Jan 27 2004; sanda, Jan 8 2008
3094 { LFUN_STATISTICS, "statistics", ReadOnly, System },
3096 * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
3097 * \li Action: Show the inline completion at the cursor position.
3098 * \li Syntax: completion-inline
3099 * \li Origin: sts, Feb 19 2008
3102 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
3104 * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
3105 * \li Action: Show the completion popup at the cursor position.
3106 * \li Syntax: completion-popup
3107 * \li Origin: sts, Feb 19 2008
3110 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
3112 * \var lyx::FuncCode lyx::LFUN_COMPLETION_COMPLETE
3113 * \li Action: Try to complete the word or command at the cursor position.
3114 * \li Syntax: complete
3115 * \li Origin: sts, Feb 19 2008
3118 { LFUN_COMPLETION_COMPLETE, "complete", SingleParUpdate, Edit },
3121 * \var lyx::FuncCode lyx::LFUN_COMPLETION_CANCEL
3122 * \li Action: Try to cancel completion, either the popup or the inline completion
3123 * \li Syntax: completion-cancel
3124 * \li Origin: sts, Sep 07 2008
3127 { LFUN_COMPLETION_CANCEL, "completion-cancel", SingleParUpdate, Edit },
3129 * \var lyx::FuncCode lyx::LFUN_COMPLETION_ACCEPT
3130 * \li Action: Accept suggested completion.
3131 * \li Syntax: completion-accept
3132 * \li Origin: sanda, Sep 08 2008
3135 { LFUN_COMPLETION_ACCEPT, "completion-accept", SingleParUpdate, Edit },
3139 * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
3140 * \li Action: Activate the branch
3141 * \li Syntax: branch-activate <BRANCH>
3142 * \li Params: <BRANCH>: The branch to activate
3143 * \li Sample: lyx -e pdf2 -x "branch-activate answers" finalexam.lyx \n
3144 could be used to export a pdf with the answers branch included
3145 without one's having to open LyX and activate the branch manually.
3146 * \li Origin: rgh, 27 May 2008
3149 { LFUN_BRANCH_ACTIVATE, "branch-activate", Argument, Buffer },
3151 * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
3152 * \li Action: De-activate the branch
3153 * \li Syntax: branch-deactivate <BRANCH>
3154 * \li Params: <BRANCH>: The branch to deactivate
3155 * \li Origin: rgh, 27 May 2008
3158 { LFUN_BRANCH_DEACTIVATE, "branch-deactivate", Argument, Buffer },
3161 * \var lyx::FuncCode lyx::LFUN_COPY_LABEL_AS_REF
3162 * \li Action: Copies the label at the cursor as a cross-reference to be pasted elsewhere.
3163 * \li Syntax: copy-label-as-reference
3164 * \li Origin: sts, 16 Nov 2008
3167 { LFUN_COPY_LABEL_AS_REF, "copy-label-as-reference", ReadOnly | NoUpdate, Edit },
3169 { LFUN_NOACTION, "", Noop, Hidden }
3170 #ifndef DOXYGEN_SHOULD_SKIP_THIS
3173 for (int i = 0; items[i].action != LFUN_NOACTION; ++i) {
3174 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
3181 LyXAction::LyXAction()
3187 // Returns an action tag from a string.
3188 FuncRequest LyXAction::lookupFunc(string const & func) const
3190 string const func2 = trim(func);
3192 if (func2.empty()) {
3193 return FuncRequest(LFUN_NOACTION);
3197 string const arg = split(func2, cmd, ' ');
3199 func_map::const_iterator fit = lyx_func_map.find(cmd);
3201 return fit != lyx_func_map.end() ? FuncRequest(fit->second, arg) : FuncRequest(LFUN_UNKNOWN_ACTION);
3205 string const LyXAction::getActionName(FuncCode action) const
3207 info_map::const_iterator const it = lyx_info_map.find(action);
3208 return it != lyx_info_map.end() ? it->second.name : string();
3212 LyXAction::func_type LyXAction::getActionType(FuncCode action) const
3214 info_map::const_iterator const it = lyx_info_map.find(action);
3215 return it != lyx_info_map.end() ? it->second.type : Hidden;
3219 bool LyXAction::funcHasFlag(FuncCode action,
3220 LyXAction::func_attrib flag) const
3222 info_map::const_iterator ici = lyx_info_map.find(action);
3224 if (ici == lyx_info_map.end()) {
3225 LYXERR0("action: " << action << " is not known.");
3226 LASSERT(false, /**/);
3229 return ici->second.attrib & flag;
3233 LyXAction::const_func_iterator LyXAction::func_begin() const
3235 return lyx_func_map.begin();
3239 LyXAction::const_func_iterator LyXAction::func_end() const
3241 return lyx_func_map.end();
3245 LyXErr & operator<<(LyXErr & l, FuncCode code)
3248 l.stream() << lyxaction.getActionName(code);