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.
61 * Use spaces for indentation (doxy -> .lyx generator is tab-sensitive).
65 * \var lyx::FuncCode lyx::LFUN_
78 void LyXAction::newFunc(FuncCode action, string const & name,
79 unsigned int attrib, LyXAction::FuncType type)
81 lyx_func_map[name] = action;
84 tmpinfo.attrib = attrib;
86 lyx_info_map[action] = tmpinfo;
90 // Needed for LFUNs documentation to be accepted, since doxygen won't take
91 // \var inside functions.
92 #ifndef DOXYGEN_SHOULD_SKIP_THIS
93 void LyXAction::init()
95 // This function was changed to use the array below in initalization
96 // instead of calling newFunc numerous times because of compilation
97 // times. Since the array is not static we get back the memory it
98 // occupies after the init is completed. It compiles several
112 ev_item const items[] = {
115 * \var lyx::FuncCode lyx::LFUN_ACCENT_ACUTE
116 * \li Action: Adds an acute accent \htmlonly (á)\endhtmlonly
117 to the next character typed.
118 * \li Syntax: accent-acute
121 { LFUN_ACCENT_ACUTE, "accent-acute", Noop, Edit },
123 * \var lyx::FuncCode lyx::LFUN_ACCENT_BREVE
124 * \li Action: Adds a breve accent \htmlonly (ă)\endhtmlonly
125 to the next character typed.
126 * \li Syntax: accent-breve
129 { LFUN_ACCENT_BREVE, "accent-breve", Noop, Edit },
131 * \var lyx::FuncCode lyx::LFUN_ACCENT_CARON
132 * \li Action: Adds a caron \htmlonly (ǎ)\endhtmlonly
133 to the next character typed.
134 * \li Syntax: accent-caron
137 { LFUN_ACCENT_CARON, "accent-caron", Noop, Edit },
139 * \var lyx::FuncCode lyx::LFUN_ACCENT_CEDILLA
140 * \li Action: Adds a cedilla \htmlonly (ç)\endhtmlonly
141 to the next character typed.
142 * \li Syntax: accent-cedilla
145 { LFUN_ACCENT_CEDILLA, "accent-cedilla", Noop, Edit },
147 * \var lyx::FuncCode lyx::LFUN_ACCENT_CIRCLE
148 * \li Action: Adds a circle accent \htmlonly (å)\endhtmlonly
149 to the next character typed.
150 * \li Syntax: accent-circle
153 { LFUN_ACCENT_CIRCLE, "accent-circle", Noop, Edit },
155 * \var lyx::FuncCode lyx::LFUN_ACCENT_CIRCUMFLEX
156 * \li Action: Adds a circumflex \htmlonly (ê)\endhtmlonly
157 to the next character typed.
158 * \li Syntax: accent-circumflex
161 { LFUN_ACCENT_CIRCUMFLEX, "accent-circumflex", Noop, Edit },
163 * \var lyx::FuncCode lyx::LFUN_ACCENT_DOT
164 * \li Action: Adds a dot accent \htmlonly (ż)\endhtmlonly
165 to the next character typed.
166 * \li Syntax: accent-dot
169 { LFUN_ACCENT_DOT, "accent-dot", Noop, Edit },
171 * \var lyx::FuncCode lyx::LFUN_ACCENT_GRAVE
172 * \li Action: Adds a grave accent \htmlonly (è)\endhtmlonly
173 to the next character typed.
174 * \li Syntax: accent-grave
177 { LFUN_ACCENT_GRAVE, "accent-grave", Noop, Edit },
179 * \var lyx::FuncCode lyx::LFUN_ACCENT_HUNGARIAN_UMLAUT
180 * \li Action: Adds a Hungarian umlaut \htmlonly (ő)\endhtmlonly
181 to the next character typed.
182 * \li Syntax: accent-grave
185 { LFUN_ACCENT_HUNGARIAN_UMLAUT, "accent-hungarian-umlaut", Noop, Edit },
187 * \var lyx::FuncCode lyx::LFUN_ACCENT_MACRON
188 * \li Action: Adds a macron \htmlonly (ā)\endhtmlonly
189 to the next character typed.
190 * \li Syntax: accent-macron
193 { LFUN_ACCENT_MACRON, "accent-macron", Noop, Edit },
195 * \var lyx::FuncCode lyx::LFUN_ACCENT_OGONEK
196 * \li Action: Adds an ogonek accent \htmlonly (ą)\endhtmlonly
197 to the next character typed.
198 * \li Syntax: accent-ogonek
201 { LFUN_ACCENT_OGONEK, "accent-ogonek", Noop, Edit },
203 * \var lyx::FuncCode lyx::LFUN_ACCENT_TIE
204 * \li Action: Adds a tie \htmlonly (a͡)\endhtmlonly
205 over the next two character typed.
206 * \li Notion: The following char will finish the tie.
207 * \li Syntax: accent-tie
210 { LFUN_ACCENT_TIE, "accent-tie", Noop, Edit },
212 * \var lyx::FuncCode lyx::LFUN_ACCENT_TILDE
213 * \li Action: Adds a tilde \htmlonly (ã)\endhtmlonly
214 over the next character typed.
215 * \li Syntax: accent-tilde
218 { LFUN_ACCENT_TILDE, "accent-tilde", Noop, Edit },
220 * \var lyx::FuncCode lyx::LFUN_ACCENT_UMLAUT
221 * \li Action: Adds an umlaut \htmlonly (ä)\endhtmlonly
222 over the next character typed.
223 * \li Syntax: accent-umlaut
226 { LFUN_ACCENT_UMLAUT, "accent-umlaut", Noop, Edit },
228 * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERBAR
229 * \li Action: Adds a bar \htmlonly (a̠)\endhtmlonly
230 under the next character typed.
231 * \li Syntax: accent-underbar
234 { LFUN_ACCENT_UNDERBAR, "accent-underbar", Noop, Edit },
236 * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERDOT
237 * \li Action: Adds a dot \htmlonly (ạ)\endhtmlonly
238 under the next character typed.
239 * \li Syntax: accent-underdot
242 { LFUN_ACCENT_UNDERDOT, "accent-underdot", Noop, Edit },
245 * \var lyx::FuncCode lyx::LFUN_CAPTION_INSERT
246 * \li Action: Inserts a caption inset.
247 * \li Syntax: caption-insert
248 * \li Origin: Lgb, 18 Jul 2000
251 { LFUN_CAPTION_INSERT, "caption-insert", Noop, Edit },
253 * \var lyx::FuncCode lyx::LFUN_DATE_INSERT
254 * \li Action: Inserts the current date.
255 * \li Syntax: date-insert [<ARG>]
256 * \li Params: <ARG>: Format of date. The default value (%x) can be set
257 in Preferences->Date format. For possible formats
258 see manual page of strftime function.
259 * \li Origin: jdblair, 31 Jan 2000
262 { LFUN_DATE_INSERT, "date-insert", Noop, Edit },
264 * \var lyx::FuncCode lyx::LFUN_FOOTNOTE_INSERT
265 * \li Action: Inserts a footnote inset.
266 * \li Syntax: footnote-insert
267 * \li Origin: Jug, 7 Mar 2000
270 { LFUN_FOOTNOTE_INSERT, "footnote-insert", Noop, Edit },
272 * \var lyx::FuncCode lyx::LFUN_ERT_INSERT
273 * \li Action: Inserts an ERT inset.
274 * \li Syntax: ert-insert
275 * \li Origin: Jug, 18 Feb 2000
278 { LFUN_ERT_INSERT, "ert-insert", Noop, Edit },
280 * \var lyx::FuncCode lyx::LFUN_FLOAT_INSERT
281 * \li Action: Inserts a float inset.
282 * \li Syntax: float-insert <TYPE>
283 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
284 "algorithm", "table", "figure" parameters can be given.
285 * \li Origin: Lgb, 27 Jun 2000
288 { LFUN_FLOAT_INSERT, "float-insert", Noop, Edit },
290 * \var lyx::FuncCode lyx::LFUN_FLOAT_WIDE_INSERT
291 * \li Action: Inserts float insets as in #LFUN_FLOAT_INSERT but span multiple columns.
292 * \li Notion: Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
293 * \li Syntax: float-wide-insert <TYPE>
294 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
295 "algorithm", "table", "figure" parameters can be given.
296 * \li Origin: Lgb, 31 Oct 2001
299 { LFUN_FLOAT_WIDE_INSERT, "float-wide-insert", Noop, Edit },
301 * \var lyx::FuncCode lyx::LFUN_FLOAT_LIST_INSERT
302 * \li Action: Inserts the list of floats in the document.
303 * \li Syntax: float-list-insert <TYPE>
304 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
305 "algorithm", "table", "figure" parameters can be given.
306 * \li Origin: Lgb, 3 May 2001
309 { LFUN_FLOAT_LIST_INSERT, "float-list-insert", Noop, Edit },
311 * \var lyx::FuncCode lyx::LFUN_WRAP_INSERT
312 * \li Action: Inserts floats wrapped by the text around.
313 * \li Syntax: wrap-insert <TYPE>
314 * \li Params: <TYPE>: table|figure
315 * \li Origin: Dekel, 7 Apr 2002
318 { LFUN_WRAP_INSERT, "wrap-insert", Noop, Edit },
320 * \var lyx::FuncCode lyx::LFUN_ARGUMENT_INSERT
321 * \li Action: Inserts an argument (short title) inset.
322 * \li Syntax: argument-insert
323 * \li Origin: vermeer, 12 Aug 2002
326 { LFUN_ARGUMENT_INSERT, "argument-insert", Noop, Edit },
328 * \var lyx::FuncCode lyx::LFUN_NEWPAGE_INSERT
329 * \li Action: Inserts a new page.
330 * \li Syntax: newpage-insert <ARG>
331 * \li Params: <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
332 * \li Origin: uwestoehr, 24 Nov 2007
335 { LFUN_NEWPAGE_INSERT, "newpage-insert", Noop, Edit },
337 * \var lyx::FuncCode lyx::LFUN_MARGINALNOTE_INSERT
338 * \li Action: Inserts a marginal note.
339 * \li Syntax: marginalnote-insert
340 * \li Origin: Lgb, 26 Jun 2000
343 { LFUN_MARGINALNOTE_INSERT, "marginalnote-insert", Noop, Edit },
345 * \var lyx::FuncCode lyx::LFUN_UNICODE_INSERT
346 * \li Action: Inserts a single unicode character.
347 * \li Syntax: unicode-insert <CHAR>
348 * \li Params: <CHAR>: The character to insert, given as its code
349 point, in hexadecimal.
350 * \li Sample: unicode-insert 0x0100
351 * \li Origin: Lgb, 22 Oct 2006
354 { LFUN_UNICODE_INSERT, "unicode-insert", Noop, Edit },
356 * \var lyx::FuncCode lyx::LFUN_LISTING_INSERT
357 * \li Action: Inserts a new listings inset.
358 * \li Syntax: listing-insert
359 * \li Origin: Herbert, 10 Nov 2001; bpeng, 2 May 2007
362 { LFUN_LISTING_INSERT, "listing-insert", Noop, Edit },
364 * \var lyx::FuncCode lyx::LFUN_PREVIEW_INSERT
365 * \li Action: Inserts a new preview inset.
366 * \li Syntax: preview-insert
367 * \li Origin: vfr, 28 Mar 2010
370 { LFUN_PREVIEW_INSERT, "preview-insert", Noop, Edit },
372 * \var lyx::FuncCode lyx::LFUN_TAB_INSERT
373 * \li Action: Insert a tab into a listings inset.
374 * \li Notion: It also works on a selection.
375 * \li Syntax: tab-insert
376 * \li Origin: vfr, Sep 30 2008
379 { LFUN_TAB_INSERT, "tab-insert", SingleParUpdate, Edit },
381 * \var lyx::FuncCode lyx::LFUN_TAB_DELETE
382 * \li Action: Delete a tab or up to an equivalent amount of spaces from
384 * \li Notion: It also works on a selection - it removes a tab or spaces from the
385 beginning of each line spanned by the selection. This is useful if
386 you want to indent/unindent multiple lines in one action.
387 * \li Syntax: tab-delete
388 * \li Origin: vfr, Sep 30 2008
391 { LFUN_TAB_DELETE, "tab-delete", SingleParUpdate, Edit },
393 * \var lyx::FuncCode lyx::LFUN_QUOTE_INSERT
394 * \li Action: Inserts quotes according to the type and quote-language preference.
395 * \li Notion: Currently English, Swedish, German, Polish, French, Danish quotes
397 * \li Syntax: quote-insert [<TYPE>]
398 * \li Params: <TYPE>: 'single' for single quotes, otherwise double quotes will be used.
401 { LFUN_QUOTE_INSERT, "quote-insert", Noop, Edit },
403 * \var lyx::FuncCode lyx::LFUN_INFO_INSERT
404 * \li Action: Displays shortcuts, lyxrc, package and textclass availability and menu
405 information in a non-editable boxed InsetText.
406 * \li Notion: Apart from lfun arguments you can use the following method: \n
407 1. input the type and argument of this inset, e.g. "menu paste", in
409 2. select the text and run info-insert lfun.
410 * \li Syntax: info-insert <TYPE> <ARG>
411 * \li Params: <TYPE>: shortcut[s]|lyxrc|lyxinfo|package|textclass|menu|buffer \n
412 <ARG>: argument for a given type. Look into InsetInfo.h for detailed
414 shortcut[s]: name of lfun (e.g math-insert \alpha) \n
415 lyxrc: name of rc_entry (e.g. bind_file) \n
416 lyxinfo: "version" - used version of LyX \n
417 package: name of latex package (e.g. listings) \n
418 textclass: name of textclass (e.g. article) \n
419 menu: name of lfun used in menu \n
420 icon: name of lfun used in toolbar \n
421 buffer: "name"|"path"|"class"|"vcs-tree-revision"|
422 "vcs-revision"|"vcs-author"|"vcs-date"|"vcs-time"
423 * \li Sample: command-sequence info-insert buffer path; info-insert buffer name
424 * \li Origin: bpeng, 7 Oct 2007
427 { LFUN_INFO_INSERT, "info-insert", Noop, Edit },
429 * \var lyx::FuncCode lyx::LFUN_BRANCH_INSERT
430 * \li Action: Inserts branch inset.
431 * \li Syntax: branch-insert <BRANCH-NAME>
432 * \li Origin: vermeer, 17 Aug 2003
435 { LFUN_BRANCH_INSERT, "branch-insert", Noop, Edit },
437 * \var lyx::FuncCode lyx::LFUN_BOX_INSERT
438 * \li Action: Inserts Box inset.
439 * \li Syntax: box-insert [<TYPE>]
440 * \li Params: <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox \n
441 Framed is the default one.
442 * \li Origin: vermeer, 7 Oct 2003
445 { LFUN_BOX_INSERT, "box-insert", Noop, Edit },
447 * \var lyx::FuncCode lyx::LFUN_FLEX_INSERT
448 * \li Action: Inserts CharStyle, Custom inset or XML short element.
449 * \li Notion: Look into the Customization manual for more information about
451 To make this command enabled the layout file for the document
452 class you're using has to load the character styles. There are
453 a few contained in the Logical Markup module. You can also of
454 course create some yourself. \n
455 For dissolving the element see #LFUN_INSET_DISSOLVE.
456 * \li Syntax: flex-insert Name
457 * \li Params: Name: This name must be defined either in your layout file
458 or imported by some module. The definition is
459 InsetLayout Name or InsetLayout <Flex:Name>. The Flex:
461 * \li Sample: flex-insert Code
464 { LFUN_FLEX_INSERT, "flex-insert", Noop, Edit },
466 * \var lyx::FuncCode lyx::LFUN_SELF_INSERT
467 * \li Action: Inserts the given string (accordingly to the correct keymap).
468 * \li Notion: Automatically replace the currently selected text. Depends on lyxrc
469 settings "auto_region_delete".
470 * \li Syntax: self-insert <STRING>
473 { LFUN_SELF_INSERT, "self-insert", SingleParUpdate, Hidden },
475 * \var lyx::FuncCode lyx::LFUN_SPACE_INSERT
476 * \li Action: Inserts one of horizontal space insets.
477 * \li Syntax: space-insert <NAME> [<LEN>]
478 * \li Params: <NAME>: normal, protected, thin, quad, qquad, enspace, enskip,
479 negthinspace, hfill, hfill*, dotfill, hrulefill, hspace,
481 <LEN>: length for custom spaces (hspace, hspace* for protected)
482 * \li Origin: JSpitzm, 20 May 2003, Mar 17 2008
485 { LFUN_SPACE_INSERT, "space-insert", Noop, Edit },
487 * \var lyx::FuncCode lyx::LFUN_HYPERLINK_INSERT
488 * \li Action: Inserts hyperlinks into the document (clickable in pdf output).
489 * \li Notion: Hyperlink target can be set via selection + hyperlink-insert function.
490 * \li Syntax: href-insert [<TARGET>]
491 * \li Origin: CFO-G, 21 Nov 1997
494 { LFUN_HYPERLINK_INSERT, "href-insert", Noop, Edit },
496 * \var lyx::FuncCode lyx::LFUN_SPECIALCHAR_INSERT
497 * \li Action: Inserts various characters into the document.
498 * \li Syntax: specialchar-insert <CHAR>
499 * \li Params: <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots,
500 end-of-sentence, menu-separator.
501 * \li Origin: JSpitzm, 6 Dec 2007
504 { LFUN_SPECIALCHAR_INSERT, "specialchar-insert", Noop, Edit },
506 * \var lyx::FuncCode lyx::LFUN_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 [<TYPE:Name>]
519 * \li Params: <TYPE:Name>: name of the index, if multiple indices are defined.
520 with an empty argument, the default index is selected.
521 * \li Origin: leeming, 3 Aug 2000
524 { LFUN_INDEX_INSERT, "index-insert", Noop, Edit },
526 * \var lyx::FuncCode lyx::LFUN_INDEX_PRINT
527 * \li Action: Inserts list of Index entries on a new page.
528 * \li Syntax: index-print [<TYPE:Name>]
529 * \li Params: <TYPE:Name>: name of the index, if multiple indices are defined.
530 with an empty argument, the default index is selected.
531 * \li Origin: Lgb, 27 Feb 1997
534 { LFUN_INDEX_PRINT, "index-print", Noop, Edit },
537 * \var lyx::FuncCode lyx::LFUN_NOMENCL_INSERT
538 * \li Action: Inserts Nomenclature entry.
539 * \li Notion: It automatically takes the word on the cursor position if no symbol is given.
540 * \li Syntax: nomencl-insert [<SYMBOL>]
541 * \li Origin: Ugras, 4 Nov 2006
544 { LFUN_NOMENCL_INSERT, "nomencl-insert", Noop, Edit },
546 * \var lyx::FuncCode lyx::LFUN_NOMENCLATURE_PRINT
547 * \li Action: Inserts list of Nomenclature entries.
548 * \li Syntax: nomenclature-print
549 * \li Origin: Ugras, 4 Nov 2006
552 { LFUN_NOMENCL_PRINT, "nomencl-print", Noop, Edit },
555 * \var lyx::FuncCode lyx::LFUN_NOTE_INSERT
556 * \li Action: Inserts Note on the current cursor postion,
557 move selection inside the inset.
558 * \li Syntax: note-insert [<TYPE>]
559 * \li Params: <TYPE>: <Note|Greyedout|Comment> default: Note
562 { LFUN_NOTE_INSERT, "note-insert", Noop, Edit },
564 * \var lyx::FuncCode lyx::LFUN_NOTE_NEXT
565 * \li Action: Moves the cursor to the begining of next Note inset.
566 * \li Syntax: note-next
569 { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
571 * \var lyx::FuncCode lyx::LFUN_PHANTOM_INSERT
572 * \li Action: Inserts phantom on the current cursor postion,
573 move selection inside the inset.
574 * \li Syntax: phantom-insert [<TYPE>]
575 * \li Params: <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
576 * \li Origin: uwestoehr, 30 Jan 2009
579 { LFUN_PHANTOM_INSERT, "phantom-insert", Noop, Edit },
581 * \var lyx::FuncCode lyx::LFUN_NEWLINE_INSERT
582 * \li Action: Inserts a line break or new line.
583 * \li Syntax: newline-insert [<ARG>]
584 * \li Params: <ARG>: <newline|linebreak> default: newline
585 * \li Origin: JSpitzm, 25 Mar 2008
588 { LFUN_NEWLINE_INSERT, "newline-insert", Noop, Edit },
590 * \var lyx::FuncCode lyx::LFUN_ESCAPE
591 * \li Action: Clears the selection. If no text is selected call #LFUN_FINISHED_FORWARD.
592 Inside math mode jumps out of the math inset.
594 * \li Origin: Lgb, 17 May 2001
597 { LFUN_ESCAPE, "escape", ReadOnly, Edit },
599 * \var lyx::FuncCode lyx::LFUN_DOWN
600 * \li Action: Moves the cursor one line in downward direction.
604 { LFUN_DOWN, "down", ReadOnly | NoUpdate, Edit },
606 * \var lyx::FuncCode lyx::LFUN_UP
607 * \li Action: Moves the cursor one line in upward direction.
611 { LFUN_UP, "up", ReadOnly | NoUpdate, Edit },
613 * \var lyx::FuncCode lyx::LFUN_DOWN_SELECT
614 * \li Action: Moves the cursor one line in downward direction adding the current
615 position to the selection.
616 * \li Syntax: down-select
619 { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, Edit },
621 * \var lyx::FuncCode lyx::LFUN_UP_SELECT
622 * \li Action: Moves the cursor one line in upward direction adding the current
623 position to the selection.
624 * \li Syntax: up-select
627 { LFUN_UP_SELECT, "up-select", ReadOnly | SingleParUpdate, Edit },
629 * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN
630 * \li Action: Moves the cursor one page in downward direction.
631 * \li Syntax: screen-down
634 { LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit },
636 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP
637 * \li Action: Moves the cursor one page in upward direction.
638 * \li Syntax: screen-up
641 { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit },
643 * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN_SELECT
644 * \li Action: Moves the cursor one screen in downward direction adding the current
645 position to the selection.
646 * \li Syntax: screen-down-select
649 { LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit },
651 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP_SELECT
652 * \li Action: Moves the cursor one page in upward direction adding the current
653 position to the selection.
654 * \li Syntax: screen-up-select
657 { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit },
659 * \var lyx::FuncCode lyx::LFUN_SCROLL
660 * \li Action: Scroll the buffer view.
661 * \li Notion: Only scrolls the screen up or down; does not move the cursor.
662 * \li Syntax: scroll <TYPE> <QUANTITY>
663 * \li Params: <TYPE>: line|page\n
664 <QUANTITY>: up|down|<number>
665 * \li Origin: Abdel, Dec 27 2007
668 { LFUN_SCROLL, "scroll", ReadOnly, Edit },
670 * \var lyx::FuncCode lyx::LFUN_SCREEN_RECENTER
671 * \li Action: Recenters the screen on the current cursor position.
672 * \li Syntax: screen-recenter
675 { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit },
678 * \var lyx::FuncCode lyx::LFUN_SCREEN_SHOW_CURSOR
679 * \li Action: Repositions the screen such that the cursor is visible.
680 * \li Syntax: screen-show-cursor
681 * \li Origin: vfr, 25 Mar 2009
684 { LFUN_SCREEN_SHOW_CURSOR, "screen-show-cursor", ReadOnly, Edit },
687 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD
688 * \li Action: Moves the cursor one position logically backwards.
689 * \li Notion: This is not the action which should be bound to the arrow keys,
690 because backwards may be left or right, depending on the
691 language. The arrow keys should be bound to #LFUN_CHAR_LEFT or
692 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
693 * \li Syntax: char-backward
696 { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit },
698 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD_SELECT
699 * \li Action: Moves the cursor one position logically backwards, adding
700 traversed position to the selection.
701 * \li Notion: See also #LFUN_CHAR_BACKWARD.
702 * \li Syntax: char-backward-select
705 { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit },
707 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_BACKWARD
708 * \li Action: Deletes one character in the backward direction (usually the "BackSpace" key).
709 * \li Syntax: char-delete-backward
712 { LFUN_CHAR_DELETE_BACKWARD, "char-delete-backward", SingleParUpdate, Edit },
714 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_FORWARD
715 * \li Action: Deletes one character in the backward direction (usually the "Delete" key).
716 * \li Syntax: char-delete-forward
719 { LFUN_CHAR_DELETE_FORWARD, "char-delete-forward", SingleParUpdate, Edit },
721 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD
722 * \li Action: Moves the cursor one position logically forward.
723 * \li Notion: This is not the action which should be bound to the arrow keys,
724 because forward may be left or right, depending on the language.
725 The arrow keys should be bound to #LFUN_CHAR_LEFT or
726 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
727 * \li Syntax: char-forward
730 { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit },
732 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD_SELECT
733 * \li Action: Moves the cursor one position logically forward, adding
734 traversed position to the selection.
735 * \li Notion: See also #LFUN_CHAR_FORWARD.
736 * \li Syntax: char-forward-select
739 { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit },
741 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT
742 * \li Action: Moves the cursor one position "to the left".
743 * \li Notion: This is the action which should be taken when the "left" key
744 is pressed. Generally, it moves the cursor one position to the
745 left. However, in Bidi text this become slightly more
746 complicated, and there are different modes of cursor movement.
747 In "visual mode", this moves left, plain and simple. In "logical
748 mode", movement is logically forward in RTL paragraphs, and
749 logically backwards in LTR paragraphs.
750 * \li Syntax: char-left
753 { LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit },
755 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT_SELECT
756 * \li Action: Moves the cursor one position "to the left", adding
757 traversed position to the selection.
758 * \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement.
759 * \li Syntax: char-left-select
762 { LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit },
764 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT
765 * \li Action: Moves the cursor one position "to the right".
766 * \li Notion: This is the action which should be taken when the "right" key
767 is pressed. Generally, it moves the cursor one position to the
768 right. However, in Bidi text this become slightly more
769 complicated, and there are different modes of cursor movement.
770 In "visual mode", this moves right, plain and simple. In "logical
771 mode", movement is logically forward in LTR paragraphs, and
772 logically backwards in RTL paragraphs.
773 * \li Syntax: char-right
776 { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit },
778 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT_SELECT
779 * \li Action: Moves the cursor one position "to the right", adding
780 traversed position to the selection.
781 * \li Notion: See also #LFUN_CHAR_RIGHT for exact details of the movement.
782 * \li Syntax: char-right-select
785 { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit },
788 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD
789 * \li Action: Moves the cursor to the logically previous beginning of a word.
790 * \li Notion: This is not the action which should be bound to the arrow keys,
791 because backwards may be left or right, depending on the
792 language. The arrow keys should be bound to #LFUN_WORD_LEFT or
793 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
794 * \li Syntax: word-backward
797 { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit },
799 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD_SELECT
800 * \li Action: Moves the cursor to the logically previous beginning of a word,
801 adding the logically traversed text to the selection.
802 * \li Notion: See also #LFUN_WORD_BACKWARD.
803 * \li Syntax: word-backward-select
806 { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
808 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_BACKWARD
809 * \li Action: Deletes characters to the begining of the word (usually the "C+BackSpace" key).
810 * \li Syntax: word-delete-backward
813 { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
815 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_FORWARD
816 * \li Action: Deletes characters to the end of the word (usually the "C+Delete" key).
817 * \li Syntax: word-delete-forward
820 { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
822 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_FORWARD
823 * \li Action: Search for a given string in forward direction.
824 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
825 * \li Syntax: word-find-forward [<STRING>]
826 * \li Origin: Etienne, 16 Feb 1998
829 { LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit },
831 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_BACKWARD
832 * \li Action: Search for a given string in backward direction.
833 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
834 * \li Syntax: word-find-backward [<STRING>]
835 * \li Origin: Etienne, 20 Feb 1998
838 { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
840 * \var lyx::FuncCode lyx::LFUN_WORD_FIND
841 * \li Action: Search for next occurence of a string.
842 * \li Syntax: word-find [<DATA>]
843 * \li Params: <DATA>: data encoded from Find dialog (see #lyx::find2string()).
844 If no parameter is given, search with last find-dialog
845 data is used for search (i.e. find-next).
846 * \li Origin: Andre, Jan 7 2004
849 { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
851 * \var lyx::FuncCode lyx::LFUN_WORD_REPLACE
852 * \li Action: Replace a string in the document.
853 * \li Syntax: word-replace [<DATA>]
854 * \li Params: <DATA>: data is of the form
857 <casesensitive> <matchword> <all> <forward>"
858 * \li Origin: Andre, Jan 7 2004
861 { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
863 * \var lyx::FuncCode lyx::LFUN_WORD_FINDADV
864 * \li Action: Search for next occurence of a pattern.
865 * \li Syntax: word-findadv [<DATA>]
866 * \li Params: <DATA>: data encoded from FindAdv dialog (see #lyx::findadv2string()).
867 If no parameter is given, search with last find-dialog
868 data is used for search (i.e. find-next).
869 * \li Origin: Tommaso, Nov 15 2007
872 { LFUN_WORD_FINDADV, "word-findadv", ReadOnly | NoBuffer, Edit },
874 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD
875 * \li Action: Moves the cursor to the logically next beginning of a word.
876 * \li Notion: This is not the action which should be bound to the arrow keys,
877 because forward may be left or right, depending on the language.
878 The arrow keys should be bound to #LFUN_WORD_LEFT or
879 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
880 * \li Syntax: word-forward
883 { LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
885 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD_SELECT
886 * \li Action: Moves the cursor to the logically next beginning of a word,
887 adding the logically traversed text to the selection.
888 * \li Notion: See also #LFUN_WORD_FORWARD.
889 * \li Syntax: word-forward-select
892 { LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
894 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT
895 * \li Action: Moves the cursor to the next beginning of a word "on the left".
896 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
897 "left" key is pressed. Generally, it moves the cursor to the
898 next beginning of a word on the left. However, in Bidi text this
899 become slightly more complicated, and there are different modes
900 of cursor movement. In "visual mode", this moves left, plain and
901 simple. In "logical mode", movement is logically forward in RTL
902 paragraphs, and logically backwards in LTR paragraphs.
903 * \li Syntax: word-left
904 * \li Origin: dov, 28 Oct 2007
907 { LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
909 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT_SELECT
910 * \li Action: Moves the cursor to the next beginning of a word "on the left",
911 adding *logically* traversed text to the selection.
912 * \li Notion: See also #LFUN_WORD_LEFT for exact details of the movement.
913 * \li Syntax: word-left-select
914 * \li Origin: dov, 28 Oct 2007
917 { LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit },
919 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT
920 * \li Action: Moves the cursor to the next beginning of a word "on the right".
921 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
922 "right" key is pressed. Generally, it moves the cursor to the
923 next beginning of a word on the right. However, in Bidi text
924 this become slightly more complicated, and there are different
925 modes of cursor movement. In "visual mode", this moves right,
926 plain and simple. In "logical mode", movement is logically
927 forward in LTR paragraphs, and logically backwards in RTL
929 * \li Syntax: word-right
930 * \li Origin: dov, 28 Oct 2007
933 { LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit },
935 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT_SELECT
936 * \li Action: Moves the cursor to the next beginning of a word "on the right",
937 adding *logically* traversed text to the selection.
938 * \li Notion: See also #LFUN_WORD_RIGHT for exact details of the movement.
939 * \li Syntax: word-right-select
940 * \li Origin: dov, 28 Oct 2007
943 { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
945 * \var lyx::FuncCode lyx::LFUN_WORD_SELECT
946 * \li Action: Puts the word where the cursor stands into the selection.
947 * \li Syntax: word-select
948 * \li Origin: Andre, 11 Sep 2002
951 { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
953 * \var lyx::FuncCode lyx::LFUN_WORD_CAPITALIZE
954 * \li Action: Capitalizes the words in the selection (i.e. the first letters)
955 or the letter on the cursor position.
956 * \li Syntax: word-capitalize
959 { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
961 * \var lyx::FuncCode lyx::LFUN_WORD_UPCASE
962 * \li Action: Change the words in the selection or from the cursor position
963 to the end of word to the upper case.
964 * \li Syntax: word-upcase
967 { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
969 * \var lyx::FuncCode lyx::LFUN_WORD_LOWCASE
970 * \li Action: Change the words in the selection or from the cursor position
971 to the end of word to the lower case.
972 * \li Syntax: word-lowcase
975 { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
977 * \var lyx::FuncCode lyx::LFUN_SPELLING_ADD
978 * \li Action: Add the word under the cursor to the respective
979 * spell checker dictionary.
980 * \li Syntax: spelling-add [<STRING>] [<LANG>]
981 * \li Params: <WORD>: word to add
982 <LANG>: language name (see file languages)
983 * \li Origin: JSpitzm, 18 Jan 2010
986 { LFUN_SPELLING_ADD, "spelling-add", ReadOnly, Edit },
988 * \var lyx::FuncCode lyx::LFUN_SPELLING_IGNORE
989 * \li Action: Let the spell checker ignore the word under the cursor
990 * in the current session for the given language.
991 * \li Syntax: spelling-ignore [<WORD>] [<LANG>]
992 * \li Params: <WORD>: word to ignore
993 <LANG>: language name (see file languages)
994 * \li Origin: JSpitzm, 18 Jan 2010
997 { LFUN_SPELLING_IGNORE, "spelling-ignore", ReadOnly, Edit },
999 * \var lyx::FuncCode lyx::LFUN_SPELLING_REMOVE
1000 * \li Action: Remove the word under the cursor from the respective
1001 * spell checker dictionary.
1002 * \li Syntax: spelling-remove [<STRING>] [<LANG>]
1003 * \li Params: <WORD>: word to remove
1004 <LANG>: language name (see file languages)
1005 * \li Origin: SWitt, 28 July 2010
1008 { LFUN_SPELLING_REMOVE, "spelling-remove", ReadOnly, Edit },
1010 * \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
1011 * \li Action: Look up thesaurus entries with respect to the word under the cursor.
1012 * \li Syntax: thesaurus-entry [<STRING>] [lang=<LANG>]
1013 * \li Params: <STRING>: word to look up
1014 <LANG>: language (see file languages)
1015 * \li Origin: Levon, 20 Jul 2001
1018 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
1020 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN
1021 * \li Action: Move the cursor to the beginning of the document.
1022 * \li Syntax: buffer-begin
1025 { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
1027 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN_SELECT
1028 * \li Action: Move the cursor to the beginning of the document adding the
1029 traversed text to the selection.
1030 * \li Syntax: buffer-begin-select
1033 { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
1035 * \var lyx::FuncCode lyx::LFUN_BUFFER_END
1036 * \li Action: Move the cursor to the end of the document.
1037 * \li Syntax: buffer-end
1040 { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
1042 * \var lyx::FuncCode lyx::LFUN_BUFFER_END_SELECT
1043 * \li Action: Move the cursor to the end of the document adding the
1044 traversed text to the selection.
1045 * \li Syntax: buffer-end-select
1048 { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
1051 * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN
1052 * \li Action: Move the cursor to the beginning of the current inset
1053 if it is not already there, or at the beginning of the
1054 enclosing inset otherwise
1055 * \li Syntax: inset-begin
1056 * \li Origin: lasgouttes, 16 Mar 2009
1059 { LFUN_INSET_BEGIN, "inset-begin", ReadOnly, Edit },
1061 * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN_SELECT
1062 * \li Action: Move the cursor to the beginning of the current inset
1063 if it is not already there, or at the beginning of the
1064 enclosing inset otherwise (adding the
1065 traversed text to the selection).
1066 * \li Syntax: inset-begin-select
1067 * \li Origin: lasgouttes, 16 Mar 2009
1070 { LFUN_INSET_BEGIN_SELECT, "inset-begin-select", ReadOnly, Edit },
1072 * \var lyx::FuncCode lyx::LFUN_INSET_END
1073 * \li Action: Move the cursor to the end of the current inset
1074 if it is not already there, or at the end of the
1075 enclosing inset otherwise
1076 * \li Syntax: inset-end
1077 * \li Origin: lasgouttes, 16 Mar 2009
1080 { LFUN_INSET_END, "inset-end", ReadOnly, Edit },
1082 * \var lyx::FuncCode lyx::LFUN_INSET_END_SELECT
1083 * \li Action: Move the cursor to the end of the current inset
1084 if it is not already there, or at the end of the
1085 enclosing inset otherwise (adding the
1086 traversed text to the selection).
1087 * \li Syntax: inset-end-select
1088 * \li Origin: lasgouttes, 16 Mar 2009
1091 { LFUN_INSET_END_SELECT, "inset-end-select", ReadOnly, Edit },
1094 * \var lyx::FuncCode lyx::LFUN_INSET_SELECT_ALL
1095 * \li Action: Selects all contents of an inset.
1096 * \li Syntax: inset-select-all
1097 * \li Origin: vfr, 22 Aug 2009
1100 { LFUN_INSET_SELECT_ALL, "inset-select-all", ReadOnly, Edit },
1103 * \var lyx::FuncCode lyx::LFUN_SECTION_SELECT
1104 * \li Action: Selects the whole section.
1105 * \li Notion: The cursor should be in a section heading
1106 before calling this lfun.
1107 * \li Syntax: section-select
1108 * \li Origin: vfr, 05 May 2009
1111 { LFUN_SECTION_SELECT, "section-select", ReadOnly, Edit },
1114 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN
1115 * \li Action: Move the cursor to the begining of the (screen) line.
1116 * \li Syntax: line-begin
1119 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
1121 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN_SELECT
1122 * \li Action: Move the cursor to the beginning of the (screen) line adding the
1123 traversed text to the selection.
1124 * \li Syntax: line-begin-select
1127 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
1129 * \var lyx::FuncCode lyx::LFUN_LINE_END
1130 * \li Action: Move the cursor to the end of the (screen) line.
1131 * \li Syntax: line-end
1134 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
1136 * \var lyx::FuncCode lyx::LFUN_LINE_END_SELECT
1137 * \li Action: Move the cursor to the end of the (screen) line adding the
1138 traversed text to the selection.
1139 * \li Syntax: line-end-select
1142 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
1144 * \var lyx::FuncCode lyx::LFUN_LINE_DELETE
1145 * \li Action: Deletes the letters to the end of the (screen) line or
1146 deletes the selection.
1147 * \li Syntax: line-delete-forward
1150 { LFUN_LINE_DELETE, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
1152 * \var lyx::FuncCode lyx::LFUN_COPY
1153 * \li Action: Copies to the clipboard the last edit.
1157 { LFUN_COPY, "copy", ReadOnly, Edit },
1159 * \var lyx::FuncCode lyx::LFUN_CUT
1160 * \li Action: Cuts to the clipboard.
1164 { LFUN_CUT, "cut", Noop, Edit },
1166 * \var lyx::FuncCode lyx::LFUN_PASTE
1167 * \li Action: Pastes material (text or picture) from the active clipboard.
1168 * \li Syntax: paste [<TYPE>|<NUM>]
1169 * \li Params: <TYPE>: emf|pdf|png|jpeg|linkback|wmf \n
1170 <NUM>: number of the selection in the internal clipboard stack to be pasted.
1173 { LFUN_PASTE, "paste", Noop, Edit },
1175 * \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE
1176 * \li Action: Pastes text from the active clipboard.
1177 * \li Syntax: clipboard-paste [<ARG>]
1178 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1179 * \li Origin: baum, 10 Jul 2006
1182 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
1184 * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
1185 * \li Action: Pastes the currently text selected text.
1186 * \li Notion: Primary selection mechanism is linux-only thing.
1187 * \li Syntax: primary-selection-paste [<ARG>]
1188 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1191 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
1193 * \var lyx::FuncCode lyx::LFUN_SELECTION_PASTE
1194 * \li Action: Pastes the text in permanent selection.
1195 * \li Syntax: selection-paste
1198 { LFUN_SELECTION_PASTE, "selection-paste", Noop, Edit },
1200 * \var lyx::FuncCode lyx::LFUN_UNDO
1201 * \li Action: Undoes the last edit.
1205 { LFUN_UNDO, "undo", ReadOnly, Edit },
1207 * \var lyx::FuncCode lyx::LFUN_REDO
1208 * \li Action: Redoes the last thing undone.
1212 { LFUN_REDO, "redo", ReadOnly, Edit },
1214 * \var lyx::FuncCode lyx::LFUN_REPEAT
1215 * \li Action: Repeat the given command.
1216 * \li Syntax: repeat <COUNT> <LFUN-COMMAND>
1217 * \li Origin: Andre, 27 Oct 2003
1220 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
1222 * \var lyx::FuncCode lyx::LFUN_CHARS_TRANSPOSE
1223 * \li Action: Transposes the character at the cursor with the one before it.
1224 * \li Syntax: chars-transpose
1225 * \li Origin: Lgb, 25 Apr 2001
1228 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
1231 * \var lyx::FuncCode lyx::LFUN_DEPTH_DECREMENT
1232 * \li Action: Decrease the nesting depth of the (selected) paragraph(s)
1234 * \li Syntax: depth-decrement
1237 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
1239 * \var lyx::FuncCode lyx::LFUN_DEPTH_INCREMENT
1240 * \li Action: Increase the nesting depth of the (selected) paragraph(s)
1242 * \li Syntax: depth-increment
1245 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
1248 * \var lyx::FuncCode lyx::LFUN_FONT_BOLD
1249 * \li Action: Toggles the bold font (selection-wise) using mathbf in math.
1250 * \li Syntax: font-bold
1253 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
1256 * \var lyx::FuncCode lyx::LFUN_FONT_BOLDSYMBOL
1257 * \li Action: Toggles the bold font (selection-wise) using boldsymbol in math.
1258 * \li Syntax: font-boldsymbol
1261 { LFUN_FONT_BOLDSYMBOL, "font-boldsymbol", Noop, Layout },
1263 * \var lyx::FuncCode lyx::LFUN_FONT_TYPEWRITER
1264 * \li Action: Toggles the typewriter family font (selection-wise).
1265 * \li Syntax: font-typewriter
1268 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
1270 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERLINE
1271 * \li Action: Toggles underline in the font (selection-wise).
1272 * \li Syntax: font-underline
1275 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
1277 * \var lyx::FuncCode lyx::LFUN_FONT_UULINE
1278 * \li Action: Toggles double underline in the font (selection-wise).
1279 * \li Syntax: font-underunderline
1280 * \li Origin: sanda, 5 May 2009
1283 { LFUN_FONT_UULINE, "font-underunderline", Noop, Layout },
1285 * \var lyx::FuncCode lyx::LFUN_FONT_UWAVE
1286 * \li Action: Toggles wavy underline in the font (selection-wise).
1287 * \li Syntax: font-underwave
1288 * \li Origin: sanda, 5 May 2009
1291 { LFUN_FONT_UWAVE, "font-underwave", Noop, Layout },
1293 * \var lyx::FuncCode lyx::LFUN_FONT_STRIKEOUT
1294 * \li Action: Toggles strikeout (strike-through) in the font (selection-wise).
1295 * \li Syntax: font-strikeout
1296 * \li Origin: sanda, 3 May 2009
1299 { LFUN_FONT_STRIKEOUT, "font-strikeout", Noop, Layout },
1301 * \var lyx::FuncCode lyx::LFUN_FONT_EMPH
1302 * \li Action: Toggles the emphasis font style (selection-wise).
1303 * \li Syntax: font-emph
1306 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
1308 * \var lyx::FuncCode lyx::LFUN_FONT_NOUN
1309 * \li Action: Toggles Noun text style font (selection-wise).
1310 * \li Syntax: font-noun
1313 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
1315 * \var lyx::FuncCode lyx::LFUN_FONT_ROMAN
1316 * \li Action: Toggles Roman family font (selection-wise).
1317 * \li Syntax: font-roman
1320 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
1322 * \var lyx::FuncCode lyx::LFUN_FONT_SANS
1323 * \li Action: Toggles Sans Serif family font (selection-wise).
1324 * \li Syntax: font-sans
1327 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
1329 * \var lyx::FuncCode lyx::LFUN_FONT_FRAK
1330 * \li Action: Toggles Fraktur family font (math-mode, selection-wise).
1331 * \li Syntax: font-frak
1332 * \li Origin: vermeer, 10 Jan 2002
1335 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
1337 * \var lyx::FuncCode lyx::LFUN_FONT_ITAL
1338 * \li Action: Toggles Italics font shape (math-mode, selection-wise).
1339 * \li Syntax: font-ital
1340 * \li Origin: vermeer, 10 Jan 2002
1343 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
1345 * \var lyx::FuncCode lyx::LFUN_FONT_DEFAULT
1346 * \li Action: Reverts the settings of the font to the default values (selection-wise).
1347 * \li Syntax: font-default
1350 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
1352 * \var lyx::FuncCode lyx::LFUN_FONT_SIZE
1353 * \li Action: Sets font size according to lyx format string.
1354 * \li Syntax: font-size <SIZE>
1355 * \li Params: <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|\n
1356 largest|huge|giant|increase|decrease|default
1359 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
1361 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_APPLY
1362 * \li Action: Toggle user-defined (=last-time used) text style.
1363 * \li Notion: This style is set via #LFUN_TEXTSTYLE_UPDATE, which is
1364 automatically trigerred when using Text Style dialog.
1365 * \li Syntax: textstyle-apply
1366 * \li Origin: leeming, 12 Mar 2003
1369 { LFUN_TEXTSTYLE_APPLY, "textstyle-apply", Noop, Layout },
1371 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_UPDATE
1372 * \li Action: Apply text style and update the settings to be used by #LFUN_TEXTSTYLE_APPLY.
1373 * \li Syntax: textstyle-update <FONT_INFO>
1374 * \li Params: <FONT_INFO>: specifies font atributes, e.g. family, series, shape,
1375 size, emph, noun, underbar, number, color, language,
1377 Use lyx -dbg action for exact syntax of text-style
1379 * \li Origin: leeming, 12 Mar 2003
1382 { LFUN_TEXTSTYLE_UPDATE, "textstyle-update", Noop, Layout },
1384 * \var lyx::FuncCode lyx::LFUN_SCREEN_FONT_UPDATE
1385 * \li Action: Update fonts and its metrics.
1386 * \li Notion: Automatically called after zoom, dpi, font names, or norm change.
1387 * \li Syntax: screen-font-update
1388 * \li Origin: ARRae, 13 Aug 2000
1391 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
1393 * \var lyx::FuncCode lyx::LFUN_FONT_STATE
1394 * \li Action: Returns the info about the current font.
1395 * \li Syntax: font-state
1398 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
1401 * \var lyx::FuncCode lyx::LFUN_CITATION_INSERT
1402 * \li Action: Inserts citation from loaded citation database.
1403 * \li Syntax: citation-insert [<KEY>[|<TEXT_BEFORE>]]
1404 * \li Params: <KEY>: Citation (shortcut listed in available citations). \n
1405 <TEXT_BEFORE>: text which should appear before citation.
1406 * \li Origin: AAS, 97-02-23
1409 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
1411 * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_ADD
1412 * \li Action: Adds database, which will be used for bibtex citations.
1413 * \li Notion: Databases are added to the first BibTeX inset
1414 (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
1415 * \li Syntax: bibtex-database-add <DATABASE-NAME>
1416 * \li Origin: Ale, 30 May 1997
1419 { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit },
1421 * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_DEL
1422 * \li Action: Adds database, which will be used for bibtex citations.
1423 * \li Notion: Databases are deleted from the first BibTeX inset
1424 (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
1425 * \li Syntax: bibtex-database-del <DATABASE-NAME>
1426 * \li Origin: Ale, 30 May 1997
1429 { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
1432 * \var lyx::FuncCode lyx::LFUN_LAYOUT
1433 * \li Action: Sets the layout (that is, environment) for the current paragraph.
1434 * \li Syntax: layout <LAYOUT>
1435 * \li Params: <LAYOUT>: the layout to use
1438 { LFUN_LAYOUT, "layout", Noop, Layout },
1440 * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH
1441 * \li Action: Launches the paragraph settings dialog.
1442 * \li Syntax: layout-paragraph
1445 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
1447 * \var lyx::FuncCode lyx::LFUN_LAYOUT_TABULAR
1448 * \li Action: Launches the tabular settings dialog.
1449 * \li Syntax: layout-tabular
1450 * \li Origin: Jug, 31 Jul 2000
1453 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
1455 * \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE
1456 * \li Action: Displays list of layout choices.
1457 * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
1458 dropbox allowing for choice of layout.
1459 * \li Syntax: drop-layouts-choice
1462 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
1464 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
1465 * \li Action: Clears the module list.
1466 * \li Notion: Clears the list of included modules for the current buffer.
1467 * \li Syntax: layout-modules-clear
1468 * \li Origin: rgh, 25 August 2007
1471 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", NoInternal, Layout },
1473 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULE_ADD
1474 * \li Action: Adds a module.
1475 * \li Notion: Adds a module to the list of included modules for the current buffer.
1476 * \li Syntax: layout-module-add <MODULE>
1477 * \li Params: <MODULE>: the module to be added
1478 * \li Origin: rgh, 25 August 2007
1481 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", NoInternal, Layout },
1483 * \var lyx::FuncCode lyx::LFUN_LAYOUT_RELOAD
1484 * \li Action: Reloads layout information.
1485 * \li Notion: Reloads all layout information for the current buffer from disk, thus
1486 recognizing any changes that have been made to layout files on the fly.
1487 This is intended to be used only by layout developers and should not be
1488 used when one is trying to do actual work.
1489 * \li Syntax: layout-reload
1490 * \li Origin: rgh, 3 September 2007
1493 { LFUN_LAYOUT_RELOAD, "layout-reload", NoInternal, Layout },
1495 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
1496 * \li Action: Sets the text class for the current buffer.
1497 * \li Syntax: textclass-apply <TEXTCLASS>
1498 * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
1499 the filename, minus the ".layout" extension.
1502 { LFUN_TEXTCLASS_APPLY, "textclass-apply", NoInternal, Layout },
1504 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
1505 * \li Action: Loads information for a textclass from disk.
1506 * \li Syntax: textclass-load <TEXTCLASS>
1507 * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
1508 the filename, minus the ".layout" extension.
1511 { LFUN_TEXTCLASS_LOAD, "textclass-load", NoInternal, Layout },
1514 * \var lyx::FuncCode lyx::LFUN_MARK_OFF
1515 * \li Action: Disable selecting of text-region.
1516 * \li Syntax: mark-off
1519 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
1521 * \var lyx::FuncCode lyx::LFUN_MARK_ON
1522 * \li Action: Enable selecting of text-region.
1523 * \li Notion: After enabling you can simply move arrow keys to get selected region.
1524 * \li Syntax: mark-on
1527 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
1529 * \var lyx::FuncCode lyx::LFUN_MARK_TOGGLE
1530 * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
1531 * \li Syntax: mark-toggle
1532 * \li Origin: Andre, May 5 2006
1535 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
1538 * \var lyx::FuncCode lyx::LFUN_MATH_DELIM
1539 * \li Action: Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
1540 * \li Syntax: math-delim [<LEFT>] [<RIGHT>]
1541 * \li Params: <LEFT/RIGHT>: Delimiters to be used. Each delimiter can be specified by
1542 either a LaTeX name or a valid character.
1543 ( is the default letter.
1544 * \li Sample: math-delim { rangle
1545 * \li Origin: Alejandro, 18 Jun 1996
1548 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
1550 * \var lyx::FuncCode lyx::LFUN_MATH_BIGDELIM
1551 * \li Action: Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
1552 * \li Syntax: math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
1553 * \li Params: <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r \n
1554 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
1555 * \li Sample: math-bigdelim "Bigl" "\Downarrow" "Bigr" "\}"
1556 * \li Origin: Enrico & Georg, 7 May 2006
1559 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
1561 * \var lyx::FuncCode lyx::LFUN_MATH_DISPLAY
1562 * \li Action: Creates a new displayed equation in text mode.
1563 Toggles inlined/display formula in math mode.
1564 * \li Syntax: math-display [<ARG>]
1565 * \li Params: <ARG>: this argument will be passed to #LFUN_MATH_INSERT when creating
1566 new equation from the text mode.
1567 * \li Origin: Alejandro, 18 Jun 1996
1570 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
1572 * \var lyx::FuncCode lyx::LFUN_MATH_INSERT
1573 * \li Action: Inserts math objects and symbols.
1574 * \li Syntax: math-insert <ARG>
1575 * \li Params: <ARG>: Symbol or LaTeX code to be inserted.
1576 * \li Notion: When <ARG> is a _single_ math inset with more than one cell
1577 (such as "x_y^z" or "\frac{x}{y}"), the content of cell(0) is
1578 replaced by the current selection (only works if the selection
1579 is in mathed). As an example, if "abc" is selected in mathed,
1580 "math-insert \frac{x}{y}" replaces "abc" with "\frac{abc}{y}",
1581 and "math-insert x_y^z" replaces "abc" with "abc_y^z".
1582 If nothing is selected (or the selection is not in mathed),
1583 math-insert works as expected.
1586 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
1588 * \var lyx::FuncCode lyx::LFUN_MATH_SUBSCRIPT
1589 * \li Action: Enters subscript expression in math expression.
1590 * \li Syntax: math-subscript
1591 * \li Origin: vermeer, 12 Dec 2001
1594 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
1596 * \var lyx::FuncCode lyx::LFUN_MATH_SUPERSCRIPT
1597 * \li Action: Enters subscript expression in math expression.
1598 * \li Syntax: math-superscript
1599 * \li Origin: vermeer, 12 Dec 2001
1602 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
1604 * \var lyx::FuncCode lyx::LFUN_MATH_LIMITS
1605 * \li Action: Toggles the position of the limits from above/below to the right
1606 side an vice versa in integral symbol, a limit, a summation, etc.
1607 * \li Notion: Put the cursor before the symbol with the limits and then invoke
1609 * \li Syntax: math-limits [<STATE>]
1610 * \li Params: <STATE>: limits|nolimits
1613 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
1615 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO
1616 * \li Action: Inserts a math macro definition at the cursor position in the text.
1617 * \li Syntax: math-macro <NAME> [<NARGS>] [def]
1618 * \li Params: <NAME>: The name of the macro, e.g. "mymacro".\n
1619 <NARGS>: The number of parameters of the macro. Default is 0.
1620 "def": Has no effect anymore, just for compatibility with former LyX versions.
1621 * \li Origin: ale, 10 May 1997; sts, 21 Dec 2007
1624 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
1626 * \var lyx::FuncCode lyx::LFUN_MATH_MUTATE
1627 * \li Action: Mutates the type of math inset to the newly selected one.
1628 * \li Syntax: math-mutate <TYPE>
1629 * \li Params: <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
1630 multline|gather|flalign
1631 * \li Origin: Andre, 23 May 2001
1634 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
1636 * \var lyx::FuncCode lyx::LFUN_MATH_SPACE
1637 * \li Action: Inserts space into math expression.
1638 * \li Notion: Use spacebar after entering this space to change type of space.
1639 * \li Syntax: math-space [<TYPE>] [<LEN>]
1640 * \li Params: <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace \n
1641 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad \n
1642 custom space: hspace \n
1643 "," used by default.\n
1644 Note that ! is equivalent to negthinspace, , = thinspace,
1645 : = medspace, and ; = thickspace.\n
1646 <LEN>: length for custom spaces (hspace)
1647 * \li Origin: Andre, 25 Jul 2001; sanda, 16 Jun 2008
1650 { LFUN_MATH_SPACE, "math-space", Noop, Math },
1652 * \var lyx::FuncCode lyx::LFUN_MATH_MATRIX
1653 * \li Action: Inserts a matrix.
1654 * \li Syntax: math-matrix <COLS> <ROWS> [<ALIGN>]
1655 * \li Params: <ALIGN>: Alignment is a word composed of the vertical alignment
1656 (b, c or t) (i.e. 1 char) and the horizontal alignments
1657 (l, c or r) (i.e. <COL> chars).
1658 * \li Sample: math-matrix 3 3 bccc
1661 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
1663 * \var lyx::FuncCode lyx::LFUN_MATH_AMS_MATRIX
1664 * \li Action: Inserts a matrix.
1665 * \li Syntax: math-matrix <COLS> <ROWS> [<DECORATION>]
1666 * \li Params: <DECORATION>: Decoration determines the LaTeX name of the matrix
1667 that should be created.
1668 * \li Sample: math-ams-matrix 3 3 bmatrix
1671 { LFUN_MATH_AMS_MATRIX, "math-ams-matrix", Noop, Math },
1673 * \var lyx::FuncCode lyx::LFUN_MATH_MODE
1674 * \li Action: In text mode enters math mode (i.e. puts math insets on the current
1675 cursor position), in math mode enters text mode inside math expression.
1676 * \li Notion: If there is some selected text, it puts the text inside created math box.
1677 * \li Syntax: math-mode [on|<ARG>]
1678 * \li Params: <ARG>: eventual argument (LaTeX code) is passed to #LFUN_MATH_INSERT .\n
1679 "on": allow only entering of math mode from text mode.
1680 * \li Origin: Alejandro, 4 Jun 1996
1683 { LFUN_MATH_MODE, "math-mode", Noop, Math },
1685 * \var lyx::FuncCode lyx::LFUN_REGEXP_MODE
1686 * \li Action: Enters regexp mode (i.e., puts regexp insets on the current
1687 cursor position). Used by the advanced search dialog.
1688 * \li Notion: If there is any selected text, then it is moved inside the created
1690 * \li Syntax: regexp-mode [<ARG>]
1691 * \li Params: <ARG>: eventual argument (regular expression).
1692 * \li Origin: Tommaso, 4 Oct 2008
1695 { LFUN_REGEXP_MODE, "regexp-mode", Noop, Math },
1697 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
1698 * \li Action: Toggles numbering of the current formula line.
1699 * \li Notion: Must be in display formula mode.
1700 * \li Syntax: math-number-line-toggle
1701 * \li Origin: Alejandro, 18 Jun 1996
1704 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
1706 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
1707 * \li Action: Toggles numbering/labeling of the current formula.
1708 * \li Notion: Must be in display formula mode.
1709 * \li Syntax: math-number-toggle
1710 * \li Origin: Alejandro, 4 Jun 1996
1713 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
1715 * \var lyx::FuncCode lyx::LFUN_MATH_EXTERN
1716 * \li Action: Calls external program and passes the current expression/equation
1717 as an argument for the calculation in the format appropriate to the
1719 * \li Notion: Selection can be used to determine the input for the external program.
1720 * \li Syntax: math-extern <LANG> [<COMMAND>]
1721 * \li Params: <LANG>: octave|maxima|maple|mathematica|script \n
1722 where "script" stands fot the external script (normalized
1723 expression will be passed)
1724 * \li Origin: Andre, 24 Apr 2001
1725 * \li Sample: math-extern maple simplify
1728 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
1730 * \var lyx::FuncCode lyx::LFUN_MATH_SIZE
1731 * \li Action: Changes arbitrarily the size used by math fonts inside a context.
1732 * \li Notion: Provides an interface to the LaTeX math mode font size commands.
1733 * \li Syntax: math-size <STYLE>
1734 * \li Params: <STYLE>: \displaystyle|\textstyle|\scriptstyle|\scriptscriptstyle
1735 * \li Origin: Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
1738 { LFUN_MATH_SIZE, "math-size", Noop, Math },
1740 * \var lyx::FuncCode lyx::LFUN_MATH_FONT_STYLE
1741 * \li Action: Changes the text style used in math.
1742 * \li Syntax: math-font-style <STYLE>
1743 * \li Params: <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf
1744 |textnormal|textrm|textsf|texttt|textbf|textmd|textit
1745 |textsc|textsl|textup
1746 * \li Origin: vfr, 9 jan 2009
1749 { LFUN_MATH_FONT_STYLE, "math-font-style", Noop, Math },
1751 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
1752 * \li Action: Unfold a Math Macro.
1753 * \li Notion: Unfold the Math Macro the cursor is in, i.e.
1755 * \li Syntax: math-macro-unfold
1756 * \li Origin: sts, 06 January 2008
1759 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
1761 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
1762 * \li Action: Fold a Math Macro.
1763 * \li Notion: Fold the Math Macro the cursor is in if it was
1764 unfolded, i.e. displayed as \foo before.
1765 * \li Syntax: math-macro-fold
1766 * \li Origin: sts, 06 January 2008
1769 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
1771 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
1772 * \li Action: Add a parameter.
1773 * \li Notion: Add a parameter to a Math Macro.
1774 * \li Params: <NUM>: The number of the parameter behind which the new one
1775 will be added (1 for the first, i.e. use 0 for add a
1776 parameter at the left), defaults to the last one.
1777 * \li Syntax: math-macro-add-param <NUM>
1778 * \li Origin: sts, 06 January 2008
1781 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
1783 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
1784 * \li Action: Remove the last parameter.
1785 * \li Notion: Remove the last parameter of a Math Macro and
1786 remove its value in all instances of the macro
1788 * \li Params: <NUM>: The number of the parameter to be deleted (1 for
1789 the first), defaults to the last one.
1790 * \li Syntax: math-macro-remove-param <NUM>
1791 * \li Origin: sts, 06 January 2008
1794 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
1796 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
1797 * \li Action: Append a greedy parameter.
1798 * \li Notion: Append a greedy parameter to a Math Macro which
1799 eats the following mathed cell in every instance of
1800 the macro in the buffer.
1801 * \li Syntax: math-macro-append-greedy-param
1802 * \li Origin: sts, 06 January 2008
1805 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
1807 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
1808 * \li Action: Remove a greedy parameter.
1809 * \li Notion: Remove a greedy parameter of a Math Macro and spit
1810 out the values of it in every instance of the macro
1811 in the buffer. If it is an optional parameter the [valud]
1813 * \li Syntax: math-macro-remove-greedy-param
1814 * \li Origin: sts, 06 January 2008
1817 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
1819 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
1820 * \li Action: Make a parameter optional.
1821 * \li Notion: Turn the first non-optional parameter of a Math Macro
1822 into an optional parameter with a default value.
1823 * \li Syntax: math-macro-make-optional
1824 * \li Origin: sts, 06 January 2008
1827 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
1829 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
1830 * \li Action: Make a parameter non-optional.
1831 * \li Notion: Turn the last optional parameter of a Math Macro
1832 into a non-optional parameter. The default value is
1833 remembered to be reused later if the user changes his mind.
1834 * \li Syntax: math-macro-make-nonoptional
1835 * \li Origin: sts, 06 January 2008
1838 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
1840 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
1841 * \li Action: Add an optional parameter.
1842 * \li Notion: Insert an optional parameter just behind the
1843 already existing optional parameters.
1844 * \li Syntax: math-macro-add-optional-param
1845 * \li Origin: sts, 06 January 2008
1848 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
1850 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
1851 * \li Action: Remove the last optional parameter.
1852 * \li Notion: Remove the last optional parameter of a Math Macro and
1853 remove it in all the instances of the macro in the buffer.
1854 * \li Syntax: math-macro-remove-optional-param
1855 * \li Origin: sts, 06 January 2008
1858 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
1860 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
1861 * \li Action: Add a greedy optional parameter.
1862 * \li Notion: Add a greedy optional parameter which eats the value
1863 from the following cells in mathed which are in the [value]
1865 * \li Syntax: math-macro-add-greedy-optional-param
1866 * \li Origin: sts, 06 January 2008
1869 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
1871 * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
1872 * \li Action: Only active in Math Macro definition.
1873 * \li Notion: Dummy function which is only active in a Math Macro definition.
1874 It's used to toggle the Math Macro toolbar if the cursor moves
1875 into a Math Macro definition.
1876 * \li Syntax: in-mathmacrotemplate
1877 * \li Origin: sts, 06 January 2008
1880 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
1883 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
1884 * \li Action: Moves the current paragraph downwards in the document.
1885 * \li Syntax: paragraph-move-down
1886 * \li Origin: Edwin, 8 Apr 2006
1889 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
1891 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
1892 * \li Action: Moves the current paragraph upwards in the document.
1893 * \li Syntax: paragraph-move-up
1894 * \li Origin: Edwin, 8 Apr 2006
1897 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
1900 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP
1901 * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1902 in upward direction.
1903 * \li Syntax: paragraph-up
1904 * \li Origin: Asger, 1 Oct 1996
1907 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
1909 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP_SELECT
1910 * \li Action: Move the cursor and select the text to the next paragraph (or
1911 begining of the current one) in upward direction.
1912 * \li Syntax: paragraph-up-select
1913 * \li Origin: Asger, 1 Oct 1996
1916 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
1918 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN
1919 * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1920 in downward direction.
1921 * \li Syntax: paragraph-down
1922 * \li Origin: Asger, 1 Oct 1996
1925 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
1927 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN_SELECT
1928 * \li Action: Move the cursor and select the text to the next paragraph (or
1929 begining of the current one) in downward direction.
1930 * \li Syntax: paragraph-down-select
1931 * \li Origin: Asger, 1 Oct 1996
1934 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
1936 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
1937 * \li Action: Jump to a paragraph given by its id number and optionally the
1938 desired position within the paragraph.
1939 * \li Notion: Note that id number of paragraph is not the sequential number of paragraph
1940 seen on the screen. Moreover the id is unique for all opened buffers (documents).
1941 * \li Syntax: paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
1942 * \li Params: <PAR_ID_NUMBER>: paragraph id \n
1943 <POSITION_IN_PAR>: desired position within the paragraph
1944 * \li Origin: Dekel, 26 Aug 2000
1947 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly | NoInternal, Edit },
1949 * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1950 * \li Action: Breaks the current paragraph at the current location.
1951 * \li Notion: Removes the selection.
1952 * \li Syntax: break-paragraph [<LAYOUT>]
1953 * \li Params: <LAYOUT>: "inverse" - decreases depth by one (or change layout
1954 to default layout) when the cursor is at the end of
1958 { LFUN_BREAK_PARAGRAPH, "break-paragraph", Noop, Edit },
1960 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
1961 * \li Action: Change paragraph settings.
1962 * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
1963 This function only modifies, and does not override, existing settings.
1964 Note that the "leftindent" indent setting is deprecated.
1965 * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
1966 * \li Params: <INDENT>: \noindent|\indent|\indent-toggle|\leftindent LENGTH\n
1967 <SPACING>: \paragraph_spacing default|single|onehalf|double|other SIZE \n
1968 <ALIGN>: \align block|left|right|center|default\n
1969 <OTHERS>: \labelwidthstring WIDTH|\start_of_appendix
1970 * \li Origin: rgh, Aug 15 2007
1973 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
1975 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
1976 * \li Action: Change paragraph settings.
1977 * \li Notion: Overwrite all nonspecified settings to the default ones.
1978 Use paragraph-params lfun if you don't want to overwrite others settings.
1979 * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
1980 * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
1981 * \li Origin: leeming, 30 Mar 2004
1984 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
1986 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UPDATE
1987 * \li Action: Updates the values inside the paragraph dialog from the paragraph.
1988 * \li Notion: This is internal LFUN, not to be used by users. Called internally
1989 by #LFUN_DIALOG_UPDATE.
1990 * \li Origin: leeming, 13 Mar 2003
1993 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
1996 * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
1997 * \li Action: Move the current group in the upward direction in the
1998 structure of the document.
1999 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
2000 the whole substructure of the group.
2001 * \li Syntax: outline-up
2002 * \li Origin: Vermeer, 23 Mar 2006
2005 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
2007 * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
2008 * \li Action: Move the current group in the downward direction in the
2009 structure of the document.
2010 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
2011 the whole substructure of the group.
2012 * \li Syntax: outline-down
2013 * \li Origin: Vermeer, 23 Mar 2006
2016 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
2018 * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
2019 * \li Action: Moves the current group in the downward direction in the
2020 hierarchy of the document structure.
2021 * \li Notion: Part -> Chapter -> Section -> etc.
2022 * \li Syntax: outline-in
2023 * \li Origin: Vermeer, 23 Mar 2006
2026 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
2028 * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
2029 * \li Action: Moves the current group in the upward direction in the
2030 hierarchy of the document structure.
2031 * \li Notion: Part <- Chapter <- Section <- etc.
2032 * \li Syntax: outline-out
2033 * \li Origin: Vermeer, 23 Mar 2006
2036 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
2039 * \var lyx::FuncCode lyx::LFUN_INSET_EDIT
2040 * \li Action: Edit the inset at cursor with an external application,
2041 if one is attributed.
2042 * \li Syntax: inset-edit [<INSET_PARAMS>]
2043 * \li Params: <INSET_PARAMS>: Parameters for the inset. \n
2044 Currently only the filename will be considered.
2045 * \li Origin: JSpitzm, 27 Apr 2006
2048 { LFUN_INSET_EDIT, "inset-edit", ReadOnly | AtPoint, Edit },
2051 * \var lyx::FuncCode lyx::LFUN_TABULAR_INSERT
2052 * \li Action: Inserts table into the document.
2053 * \li Notion: See #LFUN_INSET_MODIFY for some more details
2054 about tabular modifications.
2055 * \li Syntax: tabular-insert [<ROWS> <COLUMNS>]
2056 * \li Params: In case no arguments are given show insert dialog.
2057 * \li Origin: Jug, 12 Apr 2000
2060 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
2063 * \var lyx::FuncCode lyx::LFUN_CELL_BACKWARD
2064 * \li Action: Moves the cursor to the previous cell inside the table.
2065 * \li Syntax: cell-backward
2066 * \li Origin: Jug, 22 May 2000
2069 { LFUN_CELL_BACKWARD, "cell-backward", ReadOnly | NoUpdate, Edit },
2071 * \var lyx::FuncCode lyx::LFUN_CELL_FORWARD
2072 * \li Action: Moves the cursor to the next cell inside the table.
2073 * \li Syntax: cell-forward
2076 { LFUN_CELL_FORWARD, "cell-forward", ReadOnly | NoUpdate, Edit },
2078 * \var lyx::FuncCode lyx::LFUN_CELL_SPLIT
2079 * \li Action: Splits cell and shifts right part to the next cell (inside the math grid).
2080 * \li Syntax: cell-split
2081 * \li Origin: Ale, 15 May 1997
2084 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
2087 * \var lyx::FuncCode lyx::LFUN_VC_REGISTER
2088 * \li Action: Register the document as an file inside version control system (RCS, CVS).
2089 * \li Notion: File is registered inside cvs, svn or rcs repository acording to the existence
2090 of cvs/svn/rcs entries in the document's directory. \n
2091 See LyX Additional Features Manual (Version Control Chapter) for additional
2093 * \li Syntax: vc-register
2094 * \li Origin: Lgb, 1 Jul 1997
2097 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
2099 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_IN
2100 * \li Action: Checks-in/commits the changes of the registered file to the repository.
2101 * \li Notion: In RCS case this also unlocks the file.
2102 * \li Syntax: vc-check-in
2103 * \li Origin: Lgb, 1 Jul 1997
2106 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
2108 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_OUT
2109 * \li Action: Checks-out the document for edit (and locks it for RCS).
2110 * \li Notion: This is implemented only for RCS and SVN, not CVS.
2111 * \li Syntax: vc-check-out
2112 * \li Origin: Lgb, 1 Jul 1997
2115 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
2117 * \var lyx::FuncCode lyx::LFUN_VC_REVERT
2118 * \li Action: Reverts the document to the last check-in/commit in VCS.
2119 * \li Syntax: vc-revert
2120 * \li Origin: Lgb, 1 Jul 1997
2123 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
2125 * \var lyx::FuncCode lyx::LFUN_VC_UNDO_LAST
2126 * \li Action: Undo last check-in.
2127 * \li Notion: This is currently implemented only for RCS.
2128 * \li Syntax: vc-check-out
2129 * \li Origin: Lgb, 1 Jul 1997
2132 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
2134 * \var lyx::FuncCode lyx::LFUN_VC_COMMAND
2135 * \li Action: Executes external command. This command is intended to support
2136 additional VCS commands.
2137 * \li Syntax: vc-command <FLAG> <PATH> <COMMAND>
2138 * \li Params: <FLAG>: Flags for the command can be combined together.\n
2139 U - dUmmy - no flags \n
2140 D - Doc - need document loaded to proceed \n
2141 I - dIrty - mark document dirty \n
2142 R - Reload - ensure that the document is saved and reload it after command execution \n
2143 M - Message - ask for input string (commit message)\n
2144 <PATH>: path where to start. $$p will be replaced by the current document path.\n
2145 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current
2146 document(with absolute path)/path/message.
2147 * \li Sample: vc-command DR $$p "svn up"
2148 * \li Origin: sanda, 13 Jan 2009
2151 { LFUN_VC_COMMAND, "vc-command", NoBuffer | ReadOnly, System },
2153 * \var lyx::FuncCode lyx::LFUN_VC_LOCKING_TOGGLE
2154 * \li Action: Toggles the locking property of the edited file.
2155 * \li Notion: This is currently implemented only for SVN.
2156 * \li Syntax: vc-locking-toggle
2157 * \li Origin: sanda, 25 Jun 2009
2160 { LFUN_VC_LOCKING_TOGGLE, "vc-locking-toggle", ReadOnly, System },
2162 * \var lyx::FuncCode lyx::LFUN_VC_REPO_UPDATE
2163 * \li Action: Update the local archive directory in which resides
2164 the current document with the remote repository.
2165 * \li Notion: This is currently implemented only for SVN.
2166 * \li Syntax: vc-repo-update
2167 * \li Origin: sanda, 16 Oct 2009
2170 { LFUN_VC_REPO_UPDATE, "vc-repo-update", ReadOnly, System },
2172 * \var lyx::FuncCode lyx::LFUN_VC_COMPARE
2173 * \li Action: Compares two revisions of the same file under version control.
2174 * \li Notion: This is currently implemented only for SVN and RCS.
2175 * \li Syntax: vc-compare [<REV1>] [<REV2>]
2176 * \li Params: Revision number either points directly to commit in history
2177 or if negative number -x it points to (last commit - x).\n
2178 In RCS we subtract only in the last number of revision specification.
2179 Special case "0" is reserved for the last committed revision.\n
2180 <REV1>: Older file.\n
2181 <REV2>: Newer file. Used only if REV1 > 0.\n
2182 If no parameter is given, interactive dialog will be shown.
2183 * \li Sample: Compare current document against last commit\n
2185 * \li Sample: Compare current document against current revision - 5 commits\n
2187 * \li Sample: Compare revisions 120 and 155\n
2189 * \li Origin: sanda, 12 Feb 2010
2192 { LFUN_VC_COMPARE, "vc-compare", ReadOnly, System },
2195 * \var lyx::FuncCode lyx::LFUN_CHANGES_TRACK
2196 * \li Action: Toggles change tracking to on/off.
2197 * \li Syntax: changes-track
2198 * \li Origin: levon, 1 Oct 2002
2201 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
2203 * \var lyx::FuncCode lyx::LFUN_CHANGES_OUTPUT
2204 * \li Action: Toggles showing of change tracking in typesetted output.
2205 * \li Syntax: changes-output
2206 * \li Origin: jspitzm, 21 Jan 2005
2209 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
2211 * \var lyx::FuncCode lyx::LFUN_CHANGE_NEXT
2212 * \li Action: Moves the cursor to the position of the next change
2213 of the change tracking records.
2214 * \li Syntax: change-next
2215 * \li Origin: schmitt, 4 Oct 2006
2218 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
2220 * \var lyx::FuncCode lyx::LFUN_CHANGE_PREVIOUS
2221 * \li Action: Moves the cursor to the position of the previous change
2222 of the change tracking records.
2223 * \li Syntax: change-previous
2224 * \li Origin: vfr, 4 Apr 2009
2227 { LFUN_CHANGE_PREVIOUS, "change-previous", ReadOnly, Edit },
2229 * \var lyx::FuncCode lyx::LFUN_CHANGES_MERGE
2230 * \li Action: Open change tracking dialog for merging and moves the cursor
2231 to the position of the next change.
2232 * \li Syntax: changes-merge
2233 * \li Origin: Levon, 16 Oct 2002
2236 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
2238 * \var lyx::FuncCode lyx::LFUN_CHANGE_ACCEPT
2239 * \li Action: Accepts tracked change inside the selection.
2240 * \li Syntax: change-accept
2241 * \li Origin: Levon, 16 Oct 2002
2244 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
2246 * \var lyx::FuncCode lyx::LFUN_CHANGE_REJECT
2247 * \li Action: Rejects tracked change inside the selection.
2248 * \li Syntax: change-accept
2249 * \li Origin: Levon, 16 Oct 2002
2252 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
2254 * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_ACCEPT
2255 * \li Action: Accepts all tracked changes in the document.
2256 * \li Syntax: all-changes-accept
2257 * \li Origin: Levon, 16 Oct 2002
2260 { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
2262 * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_REJECT
2263 * \li Action: Rejects all tracked changes in the document.
2264 * \li Notion: Reject does not work recursively; the user may have to repeat the operation.
2265 * \li Syntax: all-changes-reject
2266 * \li Origin: Levon, 16 Oct 2002
2269 { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
2272 * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
2273 * \li Action: Apply data for an inset.
2274 * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
2275 be applied. This is either changed to #LFUN_INSET_MODIFY or
2276 #LFUN_INSET_INSERT depending on the context where it is called.
2277 * \li Syntax: inset-apply <ARGS>
2278 * \li Params: See #LFUN_INSET_INSERT .
2281 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
2283 * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE
2284 * \li Action: Dissolve the current inset into text.
2285 * \li Syntax: inset-dissolve [<INSET>]
2286 * \li Params: <INSET>: this can be used to make sure the right kind of inset
2287 is dissolved. For example "dissolve" entry in the charstyles
2288 sub-menu should only dissolve the charstyle inset, even if the
2289 cursor is inside several nested insets of different type.\n
2290 For values see #lyx::InsetLayout::lyxtype_ .
2291 * \li Origin: JSpitz, 7 Aug 2006
2294 { LFUN_INSET_DISSOLVE, "inset-dissolve", AtPoint, Edit },
2296 * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
2297 * \li Action: Insert new inset (type given by the parameters).
2298 * \li Syntax: inset-insert <INSET> <ARGS>
2299 * \li Params: <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics|tabular
2300 hyperlink|include|index|label|line|nomencl|vspace|ref|toc>\n
2301 <ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
2302 * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
2303 where <label name> is the name of the referenced label and
2304 <Format> is one of the following: \n
2305 ref -- <reference> \n
2306 eqref -- (<reference>) \n
2307 pageref -- <page> \n
2308 vpageref -- on <page> \n
2309 vref -- <reference> on <page> \n
2310 formatted -- Formatted reference
2313 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
2315 * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
2316 * \li Action: Modify some properties of an inset.
2317 * \li Notion: Used for bibitem, bibtex, box, branch, command, ert, external,
2318 floats, graphics, include, index, info, label,
2319 listings, newline, newpage, nomencl, note, phantom,
2320 ref, space, tabular, vspace, wrap insets.
2321 * \li Syntax: inset-modify <INSET> <ARGS>
2322 * \li Syntax: inset-modify changetype <TYPE>
2323 * \li Syntax: inset-modify tabular <FEATURE> [<ARG>]
2324 * \li Params: Generally see #LFUN_INSET_INSERT for further details.\n
2325 In case that <INSET> is "tabular" various math-environment features
2326 are handled as well, e.g. add-vline-left/right for the Grid/Array environment.\n
2327 <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|copy-column|
2328 toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
2329 align-left|align-right|align-center|align-block|align-decimal|set-decimal-point|
2330 valign-top|valign-bottom|valign-middle|longtabular-align-left|
2331 longtabular-align-center|longtabular-align-right|m-align-left|m-align-right|
2332 m-align-center|m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|
2333 set-all-lines|unset-all-lines|set-longtabular|unset-longtabular|set-pwidth|
2334 set-mpwidth|set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|
2335 set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|
2336 unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|
2337 set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
2338 set-special-column|set-special-multicolumn|set-special-multirow|
2339 set-booktabs|unset-booktabs|set-top-space|set-bottom-space|
2340 set-interline-space|set-border-lines|tabular-valign-top|
2341 tabular-valign-middle|tabular-valign-bottom \n
2342 <ARG>: additional argument for some commands, use debug mode to explore its values.
2343 * \li Sample: inset-modify note Note Comment
2344 * \li Sample: inset-modify changetype Ovalbox
2347 { LFUN_INSET_MODIFY, "inset-modify", AtPoint, Edit },
2349 * \var lyx::FuncCode lyx::LFUN_INSET_DIALOG_UPDATE
2350 * \li Action: Updates the values inside the dialog from the inset.
2351 * \li Notion: This is internal LFUN, not to be used by users. Called internally
2352 by #LFUN_DIALOG_UPDATE
2353 * \li Params: <DIALOG-NAME>
2354 * \li Origin: leeming, 25 Feb 2003
2357 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
2359 * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
2360 * \li Action: Open the inset's properties dialog.
2361 * \li Notion: Used for bibitem, bibtex, box, branch, citation, ert, external,
2362 float, graphics, href, include, index, index_print, label, line,
2363 listings, note, phantom, ref, space, tabular, vspace, wrap insets.
2364 * \li Syntax: inset-settings <INSET>
2365 * \li Params: <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|
2366 graphics|href|include|index|index_print|label|line|
2367 listings|note|phantom|ref|space|tabular|vspace|wrap>.
2370 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly | AtPoint, Edit },
2372 * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
2373 * \li Action: Toggles the collapsable inset at cursor position,
2374 or the inset we are currently in.
2375 * \li Syntax: inset-toggle [<ARG>]
2376 * \li Params: <ARG>: <open|close|toggle|assign>. \n
2377 open/close/toggle are for collapsable insets. toggle is used when no argument is given.\n
2378 assign synchronize the branch-inset with activation status of the branch.
2379 Used for global toggling when changed activation.
2380 * \li Origin: lasgouttes, 19 Jul 2001
2383 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly | AtPoint, Edit },
2385 * \var lyx::FuncCode lyx::LFUN_INSET_FORALL
2386 * \li Action: Apply the given commands on insets of a given name.
2387 * \li Notion: WARNING: use at your own risks; this function gives
2388 you too many ways of shooting yourself in the foot.
2389 A typical example is
2390 inset-forall Note note-insert
2391 which starts an infinite loop. This is mitigated by the fact
2392 that the number of actions is arbitrarily limited to 10000.
2393 Note also that inset-forall does not update metrics between
2394 iterations, which can lead to bugs. This has to be eventually
2396 * \li Syntax: inset-forall <NAME> <LFUN-COMMAND> \n
2397 <NAME>: Type of Inset. If <NAME> is *, all insets are matched.
2398 The name is used like for InsetLayout in layout files: "Note"
2399 matches all note insets, while "Note:Note" only matches LyX
2401 * \li Sample: Remove all index insets: \n
2402 inset-forall Index delete-char-forward \n
2403 Close all Notes (also works for a particular branch, for example): \n
2404 inset-forall Note inset-toggle close \n
2405 Transform all yellow notes to comments \n
2406 inset-forall Note:Note inset-modify note Note Comment \n
2407 Try to put LyX in an infinite loop if there is at least a Note: \n
2408 inset-forall Note char-backward
2409 * \li Origin: lasgouttes, 27 Nov 2009
2412 { LFUN_INSET_FORALL, "inset-forall", ReadOnly, Edit },
2415 * \var lyx::FuncCode lyx::LFUN_GRAPHICS_RELOAD
2416 * \li Action: Reloads the image if necessary.
2417 * \li Syntax: graphics-reload
2418 * \li Origin: vfr, 10 Aug 2009
2421 { LFUN_GRAPHICS_RELOAD, "graphics-reload", ReadOnly | AtPoint, Edit },
2423 * \var lyx::FuncCode lyx::LFUN_SET_GRAPHICS_GROUP
2424 * \li Action: Set the group for the graphics inset on the cursor position.
2425 * \li Syntax: set-graphics-group [<GROUP>]
2426 * \li Params: <GROUP>: Id for an existing group. In case the Id is an empty string,
2427 the graphics inset is removed from the current group.
2428 * \li Origin: sanda, 6 May 2008
2431 { LFUN_SET_GRAPHICS_GROUP, "set-graphics-group", Noop, Edit },
2434 * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
2435 * \li Action: Moves the cursor out of the current slice, going forward.
2436 * \li Notion: Cursor movement within an inset may be different than cursor
2437 movement in the surrounding text. This action should be called
2438 automatically by the cursor movement within the inset, when
2439 movement within the inset has ceased (reached the end of the
2440 last paragraph, for example), in order to move correctly
2441 back into the surrounding text.
2444 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
2446 * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
2447 * \li Action: Moves the cursor out of the current slice, going backwards.
2448 * \li Notion: See also #LFUN_FINISHED_FORWARD.
2451 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
2453 * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
2454 * \li Action: Moves the cursor out of the current slice, going right.
2455 * \li Notion: See also #LFUN_FINISHED_FORWARD
2458 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
2460 * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
2461 * \li Action: Moves the cursor out of the current slice, going left.
2462 * \li Notion: See also #LFUN_FINISHED_FORWARD.
2465 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
2468 * \var lyx::FuncCode lyx::LFUN_LANGUAGE
2469 * \li Action: Set language from the current cursor position.
2470 * \li Syntax: language <LANG>
2471 * \li Params: <LANG>: Requested language. Look in lib/languages for
2473 * \li Origin: Dekel, 2 Mar 2000
2476 { LFUN_LANGUAGE, "language", Noop, Edit },
2479 * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
2480 * \li Action: Goto a label.
2481 * \li Syntax: label-goto [<LABEL>]
2482 * \li Params: <LABEL>: Requested label. If no label is given and reference
2483 is on cursor position, Bookmark 0 is saved and
2484 cursor moves to the position of referenced label.
2485 * \li Origin: Ale, 6 Aug 1997
2488 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
2490 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT
2491 * \li Action: Inserts label to text or displayed formula.
2492 * \li Syntax: label-insert [<LABEL>]
2493 * \li Params: <LABEL>: Requested label. If no label is given dialog requesting
2494 name will be opened.
2497 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
2499 * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
2500 * \li Action: Go to the next label or cross-reference.
2501 * \li Syntax: reference-next
2502 * \li Origin: Dekel, 14 Jan 2001
2505 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
2508 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
2509 * \li Action: Moves the cursor to the numbered bookmark, opening the file
2510 if necessary. Note that bookmarsk are saved per-session, not
2512 * \li Notion: Bookmark 0 has a special purpose. It is automatically set \n
2513 1. to the paragraph you are currently editing \n
2514 2. to the paragraph from where you are jumping to the last-edited
2515 position (jump-back feature) \n
2516 3. when jumping from crossreference to the requested label by
2518 * \li Syntax: bookmark-goto <NUMBER>
2519 * \li Params: <NUMBER>: the number of the bookmark to restore.
2520 * \li Origin: Dekel, 27 January 2001
2523 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
2525 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
2526 * \li Action: Save a bookmark.
2527 * \li Notion: Saves a numbered bookmark to the sessions file. The number
2528 must be between 1 and 9, inclusive. Note that bookmarks are
2529 saved per-session, not per file.
2530 * \li Syntax: bookmark-save <NUMBER>
2531 * \li Params: <NUMBER>: the number of the bookmark to save.
2532 * \li Origin: Dekel, 27 January 2001
2535 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
2537 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
2538 * \li Action: Clears the list of saved bookmarks.
2539 * \li Syntax: bookmark-clear
2540 * \li Origin: bpeng, 31 October 2006
2543 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
2546 * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
2547 * \li Action: Open the given help file according to the language setting.
2548 * \li Syntax: help-open <FILE>[.lyx]
2549 * \li Params: <FILE>: any document from (/usr/share/)doc directory.
2550 * \li Origin: Jug, 27 Jun 1999
2553 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
2555 * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
2556 * \li Action: Terminates the current LyX instance.
2557 * \li Notion: Terminates the current LyX instance, asking whether to save
2558 modified documents, etc.
2559 * \li Syntax: lyx-quit
2562 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
2564 * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
2565 * \li Action: Toggles visibility of a given toolbar between on/off/auto.
2566 * \li Notion: Skipping "auto" when allowauto is false.
2567 * \li Syntax: toolbar-toggle <NAME> [allowauto]
2568 * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|
2569 minibuffer|review|view/update|math_panels|vcs|
2570 view-others|update-others
2571 * \li Origin: Edwin, 21 May 2007
2574 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
2576 * \var lyx::FuncCode lyx::LFUN_MENU_OPEN
2577 * \li Action: Opens the menu given by its name.
2578 * \li Syntax: menu-open <NAME>
2579 * \li Params: <NAME>: menu name. See various .inc files in lib/ui for candidates.
2582 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
2584 * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
2585 * \li Action: Various UI visibility-toggling actions.
2586 * \li Syntax: ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
2587 * \li Params: statusbar : Toggle visibility of the statusbar.\n
2588 menubar : Toggle visibility of the menubar.\n
2589 scrollbar : Toggle visibility of the scrollbar.\n
2590 frame : Toggle visibility of the frames around editing window.\n
2591 fullscreen : Toggle fullscreen mode. This also covers calling the
2592 previous functions. However #LFUN_TOOLBAR_TOGGLE for the
2593 custom tweaks of the toolbars should be used.
2594 * \li Origin: sanda, 9 Feb 2007
2597 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
2600 * \var lyx::FuncCode lyx::LFUN_WINDOW_NEW
2601 * \li Action: Creates new empty LyX window.
2602 * \li Notion: Already opened documents from the previous window can be found under View menu.
2603 * \li Syntax: window-new [<GEOMETRY>]
2604 * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently
2605 accepted only on Windows platform.
2606 * \li Origin: Abdel, 21 Oct 2006
2609 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
2611 * \var lyx::FuncCode lyx::LFUN_WINDOW_CLOSE
2612 * \li Action: Closes the current LyX window.
2613 * \li Syntax: window-close
2614 * \li Origin: Abdel, 23 Oct 2006
2617 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
2620 * \var lyx::FuncCode lyx::LFUN_SPLIT_VIEW
2621 * \li Action: Creates another split view of current buffer.
2622 * \li Notion: All split views act in the same way indpendently.
2623 * \li Syntax: split-view <vertical|horizontal>
2624 * \li Params: horizontal : The work areas are laid out side by side.\n
2625 vertical : The work areas laid out vertically.
2626 * \li Origin: Abdel, 20 Feb 2008
2629 { LFUN_SPLIT_VIEW, "split-view", ReadOnly, Buffer },
2632 * \var lyx::FuncCode lyx::LFUN_CLOSE_TAB_GROUP
2633 * \li Action: Close the current tab group.
2634 * \li Notion: This only closes the work areas, not the buffer themselves.
2635 The still opened buffers can be visualized in another tab group.
2636 * \li Syntax: close-tab-group
2637 * \li Origin: Abdel, 21 Feb 2008
2640 { LFUN_CLOSE_TAB_GROUP, "close-tab-group", ReadOnly, Buffer },
2642 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW
2643 * \li Action: Shows hidden dialog or create new one for a given function/inset settings etc.
2644 * \li Syntax: dialog-show <NAME> [<DATA>]
2645 * \li Params: <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|\n
2646 compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|\n
2647 graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimiter|\n
2648 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|\n
2649 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|\n
2650 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL> \n
2651 <SPECIAL>: latexlog|vclog \n
2652 <DATA>: data, usually settings for the given dialog. Use debug mode for the
2654 * \li Origin: leeming, 17 Jun 2003
2657 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
2659 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW_NEW_INSET
2660 * \li Action: Shows hidden dialog or create new one for a given inset settings etc.
2661 * \li Notion: Internally uses #LFUN_DIALOG_SHOW with processed data for a given inset.
2662 * \li Syntax: dialog-show-new-inset <NAME> [<DATA>]
2663 * \li Params: See #LFUN_DIALOG_SHOW .
2664 * \li Origin: leeming, 25 Feb 2003
2667 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
2669 * \var lyx::FuncCode lyx::LFUN_DIALOG_UPDATE
2670 * \li Action: Updates the dialog values from the inset/paragraph/document.
2671 * \li Syntax: dialog-update <NAME>
2672 * \li Params: <NAME>: paragraph|prefs|<INSET> \n
2674 * \li Origin: leeming, 25 Feb 2003
2677 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
2679 * \var lyx::FuncCode lyx::LFUN_DIALOG_HIDE
2680 * \li Action: Hides showed dialog. Counterpart to #LFUN_DIALOG_SHOW .
2681 * \li Syntax: dialog-hide <NAME>
2682 * \li Params: See #LFUN_DIALOG_SHOW .
2683 * \li Origin: leeming, 25 Feb 2003
2686 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
2688 * \var lyx::FuncCode lyx::LFUN_DIALOG_TOGGLE
2689 * \li Action: Toggles dialog between showed/hidden state.
2690 * \li Notion: Internally uses #LFUN_DIALOG_SHOW , #LFUN_DIALOG_HIDE .
2691 * \li Syntax: dialog-toggle <NAME> [<DATA>]
2692 * \li Params: See #LFUN_DIALOG_SHOW .
2693 * \li Origin: JSpitzm, 30 Apr 2007
2696 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
2698 * \var lyx::FuncCode lyx::LFUN_DIALOG_DISCONNECT_INSET
2699 * \li Action: Closes opened connection to opened inset.
2700 * \li Notion: Connection is used for apply functions.
2701 * \li Syntax: dialog-disconnect-inset <INSET-NAME>
2702 * \li Origin: leeming, 25 Feb 2003
2705 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
2708 * \var lyx::FuncCode lyx::LFUN_MOUSE_PRESS
2709 * \li Action: This function is called when mouse button is pressed (inside workarea).
2710 Action depends on the context.
2711 * \li Notion: This is internal LFUN, not to be used by users.
2712 * \li Origin: Andre, 9 Aug 2002
2715 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
2717 * \var lyx::FuncCode lyx::LFUN_MOUSE_DOUBLE
2718 * \li Action: This function is called when double click on mouse button is
2719 pressed (inside workarea). Action depends on the context.
2720 * \li Notion: This is internal LFUN, not to be used by users.
2721 * \li Origin: Andre, 9 Aug 2002
2724 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
2726 * \var lyx::FuncCode lyx::LFUN_MOUSE_TRIPLE
2727 * \li Action: This function is called when triple click on mouse button is
2728 pressed (inside workarea). Action depends on the context.
2729 * \li Notion: This is internal LFUN, not to be used by users.
2730 * \li Origin: Andre, 9 Aug 2002
2733 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
2735 * \var lyx::FuncCode lyx::LFUN_MOUSE_MOTION
2736 * \li Action: This function is called when mouse cursor is moving over the text.
2737 Action depends on the context.
2738 * \li Notion: This is internal LFUN, not to be used by users.
2739 * \li Origin: Andre, 9 Aug 2002
2742 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
2744 * \var lyx::FuncCode lyx::LFUN_MOUSE_RELEASE
2745 * \li Action: This function is called when mouse button is released (inside workarea).
2746 Action depends on the context.
2747 * \li Notion: This is internal LFUN, not to be used by users.
2748 * \li Origin: Andre, 9 Aug 2002
2751 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
2754 * \var lyx::FuncCode lyx::LFUN_KEYMAP_OFF
2755 * \li Action: Turn off the loaded keyboard map.
2756 * \li Syntax: keymap-off
2759 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
2761 * \var lyx::FuncCode lyx::LFUN_KEYMAP_PRIMARY
2762 * \li Action: Turn on the primary keyboard map.
2763 * \li Notion: Maps were widely used in past, when X-windows didn't have nowadays
2764 keyboard support. They can be still used to maintain uniform keyboard
2765 layout across the various plaforms.\n
2766 The language is to be set in the Preferences dialog.
2767 * \li Syntax: keymap-primary
2770 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
2772 * \var lyx::FuncCode lyx::LFUN_KEYMAP_SECONDARY
2773 * \li Action: Turn on the secondary keyboard map.
2774 * \li Syntax: keymap-secondary
2777 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
2779 * \var lyx::FuncCode lyx::LFUN_KEYMAP_TOGGLE
2780 * \li Action: Toggles keyboard maps (first/second/off).
2781 * \li Syntax: keymap-toggle
2782 * \li Origin: leeming, 30 Mar 2004
2785 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
2788 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_LAYOUT
2789 * \li Action: Returns the current layout (that is environment) name
2790 on the cursor position.
2791 * \li Syntax: server-get-layout
2794 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
2796 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_FILENAME
2797 * \li Action: Returns path and file name of the currently edited document.
2798 * \li Syntax: server-get-filename
2801 { LFUN_SERVER_GET_FILENAME, "server-get-filename", ReadOnly, System },
2803 * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
2804 * \li Action: Sets the cursor position based on the row number of generated TeX file.
2805 * \li Notion: This can be useful for DVI inverse-search or detection of the problematic
2806 line from LaTeX compilation. Note that before this function can be used
2807 export to LaTeX output must occur (in order to map the row numbers).
2808 * \li Syntax: server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
2809 * \li Params: <FILE>: the filename. Environment variables are expanded in the path.
2810 In case this LFUN does not work make sure you are giving correct
2812 If the file is located inside LyX temporary directory it will be
2813 mapped back into the appropriate opened buffer (e.g. for the case
2814 of generated .tex file).
2815 .ext: extensions will be automatically replaced by .lyx.
2816 <ROW_NUMBER> The row number of the LaTeX file to which to go.
2817 * \li Origin: Edmar, 23 Dec 1998
2820 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly | NoBuffer, System },
2822 * \var lyx::FuncCode lyx::LFUN_FORWARD_SEARCH
2823 * \li Action: Sets the cursor position in the previewed (e.g. dvi) file based on the row
2824 number in LyX window.
2825 * \li Notion: The external program used for forward search call can be specified in
2826 \forward_search_dvi and \forward_search_pdf RC settings.
2827 By default, the value for pdf is empty, while for dvi it is\n
2828 "xdvi -sourceposition $$n:$$t $$o"\n
2829 The values replaced in the call: $$n for row number, $$t for
2830 exported temporary .tex file, $$o exported output file, either
2831 dvi or pdf, depending on which one exists in the temp dir
2833 * \li Syntax: forward-search
2834 * \li Origin: sanda, 14 Apr 2010
2837 { LFUN_FORWARD_SEARCH, "forward-search", ReadOnly, System },
2839 * \var lyx::FuncCode lyx::LFUN_SERVER_NOTIFY
2840 * \li Action: Sends notify message about the last key-sequence to client.
2841 * \li Notion: This can be used to grab last key-sequence used inside the LyX window.
2842 See also Debug extensions section in Additional features manual.
2843 * \li Syntax: server-notify
2846 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
2848 * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
2849 * \li Action: Sets the cursor position based on the editing area coordinates
2850 (similar as clicking on that point with left mouse button).
2851 * \li Syntax: server-set-xy <X> <Y>
2854 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
2856 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
2857 * \li Action: Returns the coordinates of cursor position in the editing area.
2858 * \li Syntax: server-get-xy
2861 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
2864 * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
2865 * \li Action: Generates the code (literate programming).
2866 * \li Notion: Latex file with extension \literate_extension is generated.
2867 Then LyX invokes \build_command (with a default of``make'') to generate the code and
2868 \build_error_filter to process the compilation error messages. \n
2869 In case you want to process your literate file with a script, or some other program,
2870 just insert in your lyxrc file an entry with:\n
2871 \build_command "my_script my_arguments" \n
2872 The \build_error_filter differs from the \literate_error_filter only in that the
2873 former will identify error messages from your compiler.
2874 * \li Syntax: build-program
2877 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
2880 * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
2881 * \li Action: Saves the current buffer to a temporary file.
2882 * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
2883 is called automatically by LyX, to "autosave" the current buffer.
2884 * \li Syntax: buffer-auto-save
2887 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
2889 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHILD_OPEN
2890 * \li Action: Loads the given child document.
2891 * \li Notion: The current document is treated as a parent.
2892 * \li Syntax: buffer-child-open <FILE>
2893 * \li Params: <FILE>: Filename of the child. The directory of the parent is assumed by default.
2894 * \li Origin: Ale, 28 May 1997
2897 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
2899 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHKTEX
2900 * \li Action: Runs chktex for the current document.
2901 * \li Syntax: buffer-chktex
2902 * \li Origin: Asger, 30 Oct 1997
2905 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
2907 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
2908 * \li Action: Toggles compression of the current document on/off.
2909 * \li Syntax: buffer-toggle-compression
2910 * \li Origin: bpeng, 27 Apr 2006
2913 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
2915 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_OUTPUT_SYNC
2916 * \li Action: Toggles including of resources for forward/reverse search of the given document.
2917 * \li Notion: When toggled on, SyncTeX is invoked for PDF, while srcltx package
2918 is used for DVI. Custom LaTeX macro can be defined in preferences.
2919 * \li Syntax: buffer-toggle-output-sync
2920 * \li Origin: sanda, 25 May 2010
2923 { LFUN_BUFFER_TOGGLE_OUTPUT_SYNC, "buffer-toggle-output-sync", Noop, System },
2925 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
2926 * \li Action: Closes the current buffer.
2927 * \li Notion: Closes the current buffer, asking whether to save it, etc,
2928 if the buffer has been modified.
2929 * \li Syntax: buffer-close
2932 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
2934 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE_ALL
2935 * \li Action: Closes all buffers.
2936 * \li Notion: Closes all buffers, asking whether to save it, etc,
2937 if a buffer has been modified.
2938 * \li Syntax: buffer-close-all
2941 { LFUN_BUFFER_CLOSE_ALL, "buffer-close-all", ReadOnly, Buffer },
2943 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
2944 * \li Action: Exports the current buffer (document) to the given format.
2945 * \li Syntax: buffer-export <FORMAT>
2946 * \li Params: <FORMAT> is either "custom" or one of the formats which you
2947 can find in Tools->Preferences->File formats->Format.
2948 Usual format you will enter is "pdf2" (pdflatex),
2949 "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
2950 In case of "custom" you will be asked for a format you
2951 want to start from and for the command that you want to
2952 apply to this format. Internally the control is then passed
2953 to #LFUN_BUFFER_EXPORT_CUSTOM.
2954 * \li Origin: Lgb, 29 Jul 1997
2957 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
2959 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
2960 * \li Action: Exports the current buffer (document) from the given format using
2961 the given command on it.
2962 * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
2963 * \li Params: <FORMAT> format to start from (LyX will care to produce such
2964 intermediate file).\n
2965 <COMMAND> this command will be launched on the file. Note that you can
2966 use "$$FName" string to qualify the intermediate file.
2967 * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
2968 * \li Origin: leeming, 27 Mar 2004
2971 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
2973 * \var lyx::FuncCode lyx::LFUN_BUFFER_PRINT
2974 * \li Action: Prints the current document.
2975 * \li Notion: Many settings can be given via the preferences dialog.
2976 * \li Syntax: buffer-print <TARGET> <TARGET-NAME> <COMMAND>
2977 * \li Params: <TARGET> is either "printer" or "file".\n
2978 <TARGER-NAME> is either "default" or file name or printer name.\n
2979 <COMMAND> command ensuring the printing job.
2980 * \li Sample: buffer-print file "/trash/newfile1.ps" "dvips"
2981 * \li Origin: leeming, 28 Mar 2004
2984 { LFUN_BUFFER_PRINT, "buffer-print", ReadOnly, Buffer },
2986 * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
2987 * \li Action: Import a given file as a lyx document.
2988 * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
2989 defined convertors in preferences. Look into File->Import menu to get
2990 an idea of the currently active import formats.
2991 * \li Syntax: buffer-import <FORMAT> [<FILE>]
2992 * \li Origin: Asger, 24 Jul 1998
2995 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
2997 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
2998 * \li Action: Creates a new buffer (that is, document).
2999 * \li Notion: Implicit path can be set in Preferences dialog.
3000 * \li Syntax: buffer-new [<FILE>]
3001 * \li Params: <FILE>: filename of created file with absolute path.
3004 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
3006 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
3007 * \li Action: Creates a new buffer (that is, document) from a template.
3008 * \li Notion: Path for new files and templates can be set in Preferences dialog.
3009 Template will be asked for via Open-dialog.
3010 * \li Syntax: buffer-new-template [<FILE>]
3011 * \li Params: <FILE>: filename of created file with absolute path.
3014 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
3016 * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
3017 * \li Action: Reverts opened document.
3018 * \li Syntax: buffer-reload
3019 * \li Origin: Asger, 2 Feb 1997
3022 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
3024 * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
3025 * \li Action: Display/switch to the given buffer.
3026 * \li Syntax: buffer-switch <BUFFER>
3027 * \li Params: <BUFFER>: path and filename of already opened (but possibly hidden)
3028 document which is to be shown.
3031 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
3033 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
3034 * \li Action: Toggle editing mode of the current document between read/write and read-only.
3035 * \li Notion: This function is not allowed if the file is under version control, since
3036 read-only flag is often used in version control file locking.
3037 * \li Syntax: buffer-toggle-read-only
3038 * \li Origin: Lgb, 27 May 1997
3041 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
3043 * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
3044 * \li Action: Displays current buffer in chosen format.
3045 * \li Notion: Displays the contents of the current buffer in the chosen
3046 format, for example, PDF or DVI. This runs the necessary
3047 converter, calls the defined viewer, and so forth.
3048 * \li Syntax: buffer-view [<FORMAT>]
3049 * \li Params: <FORMAT>: The format to display, where this is one of the
3050 formats defined (in the current GUI) in the
3051 Tools>Preferences>File Formats dialog.
3052 If no format is given, the default format as
3053 specified in the same dialog is used.
3056 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
3058 * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
3059 * \li Action: Exports the current document and put the result into the
3060 temporary directory.
3061 * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
3062 the output will be rewriten - updated. This is useful in case your viewer
3063 is able to detect such changes (e.g. ghostview for postscript).
3064 * \li Syntax: buffer-update [<FORMAT>]
3065 * \li Params: <FORMAT>: The format to display, where this is one of the
3066 formats defined (in the current GUI) in the
3067 Tools>Preferences>File Formats dialog.
3068 If no format is given, the default format as
3069 specified in the same dialog is used.
3070 * \li Origin: Dekel, 5 Aug 2000
3073 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
3076 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
3077 * \li Action: Saves the current buffer.
3078 * \li Notion: Saves the current buffer to disk, using the filename that
3079 is already associated with the buffer, asking for one if
3080 none is yet assigned.
3081 * \li Syntax: buffer-write
3084 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
3086 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
3087 * \li Action: Rename and save current buffer.
3088 * \li Syntax: buffer-write-as <FILENAME>
3089 * \li Params: <FILENAME>: New name of the buffer/file. A relative path
3090 is with respect to the original location of the buffer/file.
3093 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
3095 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
3096 * \li Action: Save all changed documents.
3097 * \li Syntax: buffer-write-all
3098 * \li Origin: rgh, gpothier 6 Aug 2007
3101 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
3103 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEXT
3104 * \li Action: Switch to the next opened document.
3105 * \li Notion: Note that this does not necessarily mean next in tabbar
3106 (for full list see View menu).
3107 * \li Syntax: buffer-next
3110 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
3112 * \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS
3113 * \li Action: Switch to the previous opened document.
3114 * \li Syntax: buffer-previous
3117 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
3119 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
3120 * \li Action: When run from a child document, this updates (exports) document built
3121 from the master buffer, if available.
3122 * \li Syntax: master-buffer-update [<FORMAT>]
3123 * \li Params: <FORMAT>: The format to display, where this is one of the
3124 formats defined (in the current GUI) in the
3125 Tools>Preferences>File Formats dialog.
3126 If no format is given, the default format as
3127 specified in the same dialog is used.
3128 * \li Origin: Tommaso, 20 Sep 2007
3131 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
3133 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
3134 * \li Action: When run from a child document, this command shows a preview built
3135 from the master buffer, if available.
3136 * \li Syntax: master-buffer-view [<FORMAT>]
3137 * \li Params: <FORMAT>: The format to display, where this is one of the
3138 formats defined (in the current GUI) in the
3139 Tools>Preferences>File Formats dialog.
3140 If no format is given, the default format as
3141 specified in the same dialog is used.
3142 * \li Origin: Tommaso, 20 Sep 2007
3145 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
3147 * \var lyx::FuncCode lyx::LFUN_BUFFER_LANGUAGE
3148 * \li Action: Set language of the current document.
3149 * \li Syntax: buffer-language <LANG>
3150 * \li Params: <LANG>: language name. See lib/languages for list.
3151 * \li Origin: leeming, 30 Mar 2004
3154 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
3156 * \var lyx::FuncCode lyx::LFUN_BUFFER_SAVE_AS_DEFAULT
3157 * \li Action: Save the current document settings as default.
3158 * \li Notion: The file will will be saved into ~/.lyx/templates/defaults.lyx .
3159 * \li Syntax: buffer-save-as-default [<ARGS>]
3160 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
3161 you can find in document header of usual .lyx file.
3162 * \li Origin: leeming, 30 Mar 2004
3165 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
3167 * \var lyx::FuncCode lyx::LFUN_BUFFER_PARAMS_APPLY
3168 * \li Action: Apply the given settings to the current document.
3169 * \li Syntax: buffer-params-apply [<ARGS>]
3170 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
3171 you can find in document header of usual .lyx file.
3172 * \li Origin: leeming, 30 Mar 2004
3175 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", NoInternal, Buffer },
3178 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
3179 * \li Action: Inserts another LyX file.
3180 * \li Syntax: file-insert [<FILE>]
3181 * \li Params: <FILE>: Filename to be inserted.
3184 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
3186 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
3187 * \li Action: Inserts plain text file.
3188 * \li Syntax: file-insert-plaintext [<FILE>]
3189 * \li Params: <FILE>: Filename to be inserted.
3190 * \li Origin: CFO-G, 19 Nov 1997
3193 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
3195 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
3196 * \li Action: Inserts plain text file as paragraph (i.e. join lines).
3197 * \li Syntax: file-insert-plaintext-para [<FILE>]
3198 * \li Params: <FILE>: Filename to be inserted.
3199 * \li Origin: Levon, 14 Feb 2001
3202 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
3204 * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
3205 * \li Action: Open LyX document.
3206 * \li Syntax: file-open [<FILE>]
3207 * \li Params: <FILE>: Filename to be opened.
3210 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
3213 * \var lyx::FuncCode lyx::LFUN_CALL
3214 * \li Action: Executes a command defined in a .def file.
3215 * \li Notion: The definitions are by default read from lib/commands/default.def.\n
3216 A .def file allows to define a command with \define "<NAME>" "<LFUN>"
3217 where <NAME> is the name of the new command and <LFUN> is the lfun code
3218 to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
3219 \def_file "FileName" allows to include another .def file. \n
3220 This is particularly useful in connection with toolbar buttons:
3221 Since the name of the button image for this lfun is
3222 lib/images/commands/<NAME>.png this is the way to assign an image
3223 to a complex command-sequence.
3224 * \li Syntax: call <NAME>
3225 * \li Params: <NAME>: Name of the command that must be called.
3226 * \li Origin: broider, 2 Oct 2007
3229 { LFUN_CALL, "call", NoBuffer, System },
3231 * \var lyx::FuncCode lyx::LFUN_META_PREFIX
3232 * \li Action: Simulate halting Meta key (Alt key on PCs).
3233 * \li Notion: Used for buffer editation not for GUI control.
3234 * \li Syntax: meta-prefix
3237 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
3239 * \var lyx::FuncCode lyx::LFUN_CANCEL
3240 * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
3241 * \li Syntax: cancel
3244 { LFUN_CANCEL, "cancel", NoBuffer, System },
3247 * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
3248 * \li Action: Switches the focus to the minibuffer so that the user can type
3249 in there. If necessary, it opens the minibuffer toolbar.
3250 * \li Notion: Usually bound to M-x shortcut.
3251 * \li Syntax: command-execute
3254 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
3257 * \var lyx::FuncCode lyx::LFUN_COMMAND_PREFIX
3258 * \li Action: Return the current key sequence and available options as a string.
3259 * \li Notion: No options are added if no current map exists. \n
3260 This is probably usable only with connection to lyxserver.
3261 * \li Syntax: command-prefix
3264 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
3266 * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
3267 * \li Action: Run more commands (LFUN and its parameters) in a sequence.
3268 * \li Syntax: command-sequence <CMDS>
3269 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
3270 * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
3271 * \li Origin: Andre, 11 Nov 1999
3274 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
3276 * \var lyx::FuncCode lyx::LFUN_COMMAND_ALTERNATIVES
3277 * \li Action: Runs the first listed command that is enabled.
3278 * \li Notion: This can be used to bind multiple functions to a single key,
3279 and then which one is used will depend upon the context.
3280 * \li Syntax: command-alternatives <CMDS>
3281 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
3282 * \li Sample: command-alternatives completion-accept;cell-forward
3283 * \li Origin: rgh, 24 September 2008
3286 { LFUN_COMMAND_ALTERNATIVES, "command-alternatives", NoBuffer, System },
3288 * \var lyx::FuncCode lyx::LFUN_MESSAGE
3289 * \li Action: Shows message in statusbar (for script purposes).
3290 * \li Syntax: message <STRING>
3291 * \li Origin: Lgb, 8 Apr 2001
3294 { LFUN_MESSAGE, "message", NoBuffer, System },
3296 * \var lyx::FuncCode lyx::LFUN_DEBUG_LEVEL_SET
3297 * \li Action: Set debug output level.
3298 * \li Syntax: debug-level-set <LEVEL>
3299 * \li Params: <LEVEL>: comma separated list of levels or the correspondent number
3300 of their combination. 0 is equivalent to disabling all debug
3301 events. See lyx -dbg for the current list of debug levels
3303 * \li Origin: sanda, 28 Dec 2009
3306 { LFUN_DEBUG_LEVEL_SET, "debug-level-set", NoBuffer, System },
3309 * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
3310 * \li Action: Save user preferences.
3311 * \li Syntax: preferences-save
3312 * \li Origin: Lgb, 27 Nov 1999
3315 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
3317 * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
3318 * \li Action: Reconfigure the automatic settings.
3319 * \li Syntax: reconfigure
3320 * \li Origin: Asger, 14 Feb 1997
3323 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
3325 * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
3326 * \li Action: Apply the given settings to user preferences.
3327 * \li Syntax: lyxrc-apply <SETTINGS>
3328 * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
3329 to get an idea which commands to use and their syntax.
3330 #lyx::LyXRC::LyXRCTags has the list of possible commands.
3333 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
3335 * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
3336 * \li Action: Determine whether keep cursor inside the editing window regardless
3337 the scrollbar movement.
3338 * \li Syntax: toggle-cursor-follows-scrollbar
3339 * \li Origin: ARRae, 2 Dec 1997
3342 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
3344 * \var lyx::FuncCode lyx::LFUN_SET_COLOR
3345 * \li Action: Set the given LyX color to the color defined by the X11 name given.
3346 * \li Notion: A new color entry is created if the color is unknown.
3347 Color names can be stored as a part of user settings.
3348 * \li Syntax: set-color <LYX_NAME> <X11_NAME>
3349 * \li Origin: SLior, 11 Jun 2000
3352 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
3354 * \var lyx::FuncCode lyx::LFUN_STATISTICS
3355 * \li Action: Count the statistics (number of words and characters)
3356 in the document or in the given selection.
3357 * \li Notion: Note that this function gives the number of words/chars written,
3358 not the number of characters which will be typeset.
3359 * \li Syntax: statistics
3360 * \li Origin: lasgouttes, Jan 27 2004; sanda, Jan 8 2008
3363 { LFUN_STATISTICS, "statistics", ReadOnly, System },
3365 * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
3366 * \li Action: Show the inline completion at the cursor position.
3367 * \li Syntax: completion-inline
3368 * \li Origin: sts, Feb 19 2008
3371 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
3373 * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
3374 * \li Action: Show the completion popup at the cursor position.
3375 * \li Syntax: completion-popup
3376 * \li Origin: sts, Feb 19 2008
3379 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
3381 * \var lyx::FuncCode lyx::LFUN_COMPLETION_COMPLETE
3382 * \li Action: Try to complete the word or command at the cursor position.
3383 * \li Syntax: complete
3384 * \li Origin: sts, Feb 19 2008
3387 { LFUN_COMPLETION_COMPLETE, "complete", SingleParUpdate, Edit },
3390 * \var lyx::FuncCode lyx::LFUN_COMPLETION_CANCEL
3391 * \li Action: Try to cancel completion, either the popup or the inline completion.
3392 * \li Syntax: completion-cancel
3393 * \li Origin: sts, Sep 07 2008
3396 { LFUN_COMPLETION_CANCEL, "completion-cancel", SingleParUpdate, Edit },
3398 * \var lyx::FuncCode lyx::LFUN_COMPLETION_ACCEPT
3399 * \li Action: Accept suggested completion.
3400 * \li Syntax: completion-accept
3401 * \li Origin: sanda, Sep 08 2008
3404 { LFUN_COMPLETION_ACCEPT, "completion-accept", SingleParUpdate, Edit },
3408 * \var lyx::FuncCode lyx::LFUN_BRANCH_ADD
3409 * \li Action: Add a branch to the buffer's BranchList.
3410 * \li Syntax: branch-add <BRANCH>
3411 * \li Params: <BRANCH>: Name of the branch to add
3412 * \li Origin: spitz, 7 Jul 2009
3415 { LFUN_BRANCH_ADD, "branch-add", Noop, Buffer },
3419 * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
3420 * \li Action: Activate the branch.
3421 * \li Syntax: branch-activate <BRANCH>
3422 * \li Params: <BRANCH>: The branch to activate
3423 * \li Sample: lyx -x "branch-activate answers" -e pdf2 finalexam.lyx \n
3424 could be used to export a pdf with the answers branch included
3425 without one's having to open LyX and activate the branch manually.
3426 * \li Origin: rgh, 27 May 2008
3429 { LFUN_BRANCH_ACTIVATE, "branch-activate", AtPoint, Buffer },
3431 * \var lyx::FuncCode lyx::LFUN_BRANCH_DEACTIVATE
3432 * \li Action: De-activate the branch.
3433 * \li Syntax: branch-deactivate <BRANCH>
3434 * \li Params: <BRANCH>: The branch to deactivate
3435 * \li Origin: rgh, 27 May 2008
3438 { LFUN_BRANCH_DEACTIVATE, "branch-deactivate", AtPoint, Buffer },
3441 * \var lyx::FuncCode lyx::LFUN_BRANCHES_RENAME
3442 * \li Action: Rename all branches of a given name in a document.
3443 * \li Syntax: branches-rename <OLDNAME> <NEWNAME>
3444 * \li Params: <OLDNAME>: Current name of the branch to be renamed
3445 * <NEWNAME>: New name of the branch
3446 * \li Origin: spitz, 9 Jul 2009
3449 { LFUN_BRANCHES_RENAME, "branches-rename", Noop, Buffer },
3451 * \var lyx::FuncCode lyx::LFUN_BRANCH_ADD_INSERT
3452 * \li Action: Create new branch and directly put the branch inset into
3454 * \li Syntax: branch-add-insert [<NAME>]
3455 * \li Params: <NAME>: Branch name. If it is not specified, you will be asked.
3456 * \li Origin: sanda, 10 Jul 2009
3459 { LFUN_BRANCH_ADD_INSERT, "branch-add-insert", Noop, Buffer },
3463 * \var lyx::FuncCode lyx::LFUN_LABEL_COPY_AS_REF
3464 * \li Action: Copies the label at the cursor as a cross-reference to be pasted elsewhere.
3465 * \li Syntax: copy-label-as-reference <LABEL>
3466 * \li Params: <LABEL>: The label to copy (for multi-line math)
3467 * \li Origin: sts, 16 Nov 2008
3470 { LFUN_LABEL_COPY_AS_REF, "copy-label-as-reference",
3471 ReadOnly | NoUpdate | AtPoint, Edit },
3474 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT_AS_REF
3475 * \li Action: Inserts the label as a cross-reference at the position of the cursor.
3476 * \li Syntax: label-insert-as-reference
3477 * \li Origin: vfr, 7 Apr 2009
3480 { LFUN_LABEL_INSERT_AS_REF, "label-insert-as-reference", Noop, Edit},
3483 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_IN
3484 * \li Action: Increases the zoom of the screen fonts.
3485 * \li Syntax: buffer-zoom-in [<ZOOM>]
3486 * \li Params: <ZOOM>: The zoom in %, the default is 20.
3487 * \li Origin: vfr, 30 Mar 2009
3490 { LFUN_BUFFER_ZOOM_IN, "buffer-zoom-in", ReadOnly, Buffer },
3493 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_OUT
3494 * \li Action: Decreases the zoom of the screen fonts.
3495 * \li Syntax: buffer-zoom-out [<ZOOM>]
3496 * \li Params: <ZOOM>: The zoom in %, the default is 20.
3497 * \li Origin: vfr, 30 Mar 2009
3500 { LFUN_BUFFER_ZOOM_OUT, "buffer-zoom-out", ReadOnly, Buffer },
3503 * \var lyx::FuncCode lyx::LFUN_INSET_COPY_AS
3504 * \li Action: Copies the inset to the clipboard as a certain type
3505 * \li Syntax: inset-copy-as [<TYPE>]
3506 * \li Params: <TYPE>: The type as which the inset is copied. This
3507 can vary from inset to inset.
3508 * \li Sample: InsetInfo is copied as text
3509 * \li Origin: vfr, 18 Apr 2010
3512 { LFUN_INSET_COPY_AS, "inset-copy-as", ReadOnly | NoUpdate | AtPoint, Edit },
3514 { LFUN_NOACTION, "", Noop, Hidden }
3515 #ifndef DOXYGEN_SHOULD_SKIP_THIS
3518 for (int i = 0; items[i].action != LFUN_NOACTION; ++i)
3519 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
3525 LyXAction::LyXAction()
3531 FuncRequest LyXAction::lookupFunc(string const & func) const
3533 string const func2 = trim(func);
3536 return FuncRequest(LFUN_NOACTION);
3539 string const arg = split(func2, cmd, ' ');
3541 FuncMap::const_iterator const fit = lyx_func_map.find(cmd);
3543 return fit != lyx_func_map.end()
3544 ? FuncRequest(fit->second, arg)
3545 : FuncRequest(LFUN_UNKNOWN_ACTION);
3549 string const LyXAction::getActionName(FuncCode action) const
3551 InfoMap::const_iterator const it = lyx_info_map.find(action);
3552 return it != lyx_info_map.end() ? it->second.name : string();
3556 LyXAction::FuncType LyXAction::getActionType(FuncCode action) const
3558 InfoMap::const_iterator const it = lyx_info_map.find(action);
3559 return it != lyx_info_map.end() ? it->second.type : Hidden;
3563 bool LyXAction::funcHasFlag(FuncCode action,
3564 LyXAction::FuncAttribs flag) const
3566 InfoMap::const_iterator ici = lyx_info_map.find(action);
3568 if (ici == lyx_info_map.end()) {
3569 LYXERR0("action: " << action << " is not known.");
3570 LASSERT(false, /**/);
3573 return ici->second.attrib & flag;
3577 LyXAction::const_iterator LyXAction::func_begin() const
3579 return lyx_func_map.begin();
3583 LyXAction::const_iterator LyXAction::func_end() const
3585 return lyx_func_map.end();
3589 LyXErr & operator<<(LyXErr & l, FuncCode code)
3592 l.stream() << lyxaction.getActionName(code);