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_OPTIONAL_INSERT
321 * \li Action: Inserts an optional-argument (short title) inset.
322 * \li Syntax: optional-insert
323 * \li Origin: vermeer, 12 Aug 2002
326 { LFUN_OPTIONAL_INSERT, "optional-insert", Noop, Edit },
328 * \var lyx::FuncCode lyx::LFUN_LINE_INSERT
329 * \li Action: Inserts a horizontal line.
330 * \li Syntax: line-insert
331 * \li Origin: Andre, Oct 27 2003
334 { LFUN_LINE_INSERT, "line-insert", Noop, Edit },
336 * \var lyx::FuncCode lyx::LFUN_NEWPAGE_INSERT
337 * \li Action: Inserts a new page.
338 * \li Syntax: newpage-insert <ARG>
339 * \li Params: <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
340 * \li Origin: uwestoehr, 24 Nov 2007
343 { LFUN_NEWPAGE_INSERT, "newpage-insert", Noop, Edit },
345 * \var lyx::FuncCode lyx::LFUN_MARGINALNOTE_INSERT
346 * \li Action: Inserts a marginal note.
347 * \li Syntax: marginalnote-insert
348 * \li Origin: Lgb, 26 Jun 2000
351 { LFUN_MARGINALNOTE_INSERT, "marginalnote-insert", Noop, Edit },
353 * \var lyx::FuncCode lyx::LFUN_UNICODE_INSERT
354 * \li Action: Inserts a single unicode character.
355 * \li Syntax: unicode-insert <CHAR>
356 * \li Params: <CHAR>: The character to insert, given as its code
357 point, in hexadecimal.
358 * \li Sample: unicode-insert 0x0100
359 * \li Origin: Lgb, 22 Oct 2006
362 { LFUN_UNICODE_INSERT, "unicode-insert", Noop, Edit },
364 * \var lyx::FuncCode lyx::LFUN_LISTING_INSERT
365 * \li Action: Inserts a new listings inset.
366 * \li Syntax: listing-insert
367 * \li Origin: Herbert, 10 Nov 2001; bpeng, 2 May 2007
370 { LFUN_LISTING_INSERT, "listing-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|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 package: name of latex package (e.g. listings) \n
417 textclass: name of textclass (e.g. article) \n
418 menu: name of lfun used in menu \n
419 icon: name of lfun used in toolbar \n
420 buffer: "name"|"path"|"class"|"vcs-tree-revision"|
421 "vcs-revision"|"vcs-author"|"vcs-date"|"vcs-time"
422 * \li Sample: command-sequence info-insert buffer path; info-insert buffer name
423 * \li Origin: bpeng, 7 Oct 2007
426 { LFUN_INFO_INSERT, "info-insert", Noop, Edit },
428 * \var lyx::FuncCode lyx::LFUN_BRANCH_INSERT
429 * \li Action: Inserts branch inset.
430 * \li Syntax: branch-insert <BRANCH-NAME>
431 * \li Origin: vermeer, 17 Aug 2003
434 { LFUN_BRANCH_INSERT, "branch-insert", Noop, Edit },
436 * \var lyx::FuncCode lyx::LFUN_BOX_INSERT
437 * \li Action: Inserts Box inset.
438 * \li Syntax: box-insert [<TYPE>]
439 * \li Params: <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox \n
440 Framed is the default one.
441 * \li Origin: vermeer, 7 Oct 2003
444 { LFUN_BOX_INSERT, "box-insert", Noop, Edit },
446 * \var lyx::FuncCode lyx::LFUN_FLEX_INSERT
447 * \li Action: Inserts CharStyle, Custom inset or XML short element.
448 * \li Notion: Look into the Customization manual for more information about
450 To make this command enabled the layout file for the document
451 class you're using has to load the character styles. There are
452 a few contained in the Logical Markup module. You can also of
453 course create some yourself. \n
454 For dissolving the element see #LFUN_INSET_DISSOLVE.
455 * \li Syntax: flex-insert <TYPE:Name>
456 * \li Params: TYPE: CharStyle|Custom|Element|Standard \n
457 Identifies whether this is a Character Style, a
458 Custom Inset or an XML Element, and which dynamical
459 sub-menu this flex inset is in on the LyX menu tree.
460 If Standard (currently unused): none of these.\n
461 Name: This name must be defined either in your layout file
462 or imported by some module. The definition is
463 InsetLayout <TYPE:Name>
464 * \li Sample: flex-insert CharStyle:Code
467 { LFUN_FLEX_INSERT, "flex-insert", Noop, Edit },
469 * \var lyx::FuncCode lyx::LFUN_SELF_INSERT
470 * \li Action: Inserts the given string (accordingly to the correct keymap).
471 * \li Notion: Automatically replace the currently selected text. Depends on lyxrc
472 settings "auto_region_delete".
473 * \li Syntax: self-insert <STRING>
476 { LFUN_SELF_INSERT, "self-insert", SingleParUpdate, Hidden },
478 * \var lyx::FuncCode lyx::LFUN_SPACE_INSERT
479 * \li Action: Inserts one of horizontal space insets.
480 * \li Syntax: space-insert <NAME> [<LEN>]
481 * \li Params: <NAME>: normal, protected, thin, quad, qquad, enspace, enskip,
482 negthinspace, hfill, hfill*, dotfill, hrulefill, hspace,
484 <LEN>: length for custom spaces (hspace, hspace* for protected)
485 * \li Origin: JSpitzm, 20 May 2003, Mar 17 2008
488 { LFUN_SPACE_INSERT, "space-insert", Noop, Edit },
490 * \var lyx::FuncCode lyx::LFUN_HYPERLINK_INSERT
491 * \li Action: Inserts hyperlinks into the document (clickable in pdf output).
492 * \li Notion: Hyperlink target can be set via selection + hyperlink-insert function.
493 * \li Syntax: href-insert [<TARGET>]
494 * \li Origin: CFO-G, 21 Nov 1997
497 { LFUN_HYPERLINK_INSERT, "href-insert", Noop, Edit },
499 * \var lyx::FuncCode lyx::LFUN_SPECIALCHAR_INSERT
500 * \li Action: Inserts various characters into the document.
501 * \li Syntax: specialchar-insert <CHAR>
502 * \li Params: <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots,
503 end-of-sentence, menu-separator.
504 * \li Origin: JSpitzm, 6 Dec 2007
507 { LFUN_SPECIALCHAR_INSERT, "specialchar-insert", Noop, Edit },
509 * \var lyx::FuncCode lyx::LFUN_TOC_INSERT
510 * \li Action: Inserts table of contents.
511 * \li Syntax: toc-insert
512 * \li Origin: Lgb, 27 May 97
515 { LFUN_TOC_INSERT, "toc-insert", Noop, Edit },
517 * \var lyx::FuncCode lyx::LFUN_APPENDIX
518 * \li Action: Start (or remove) Appendix on the given cursor position.
519 * \li Syntax: appendix
520 * \li Origin: ettrich, 5 May 1998
523 { LFUN_APPENDIX, "appendix", Noop, Edit },
526 * \var lyx::FuncCode lyx::LFUN_INDEX_INSERT
527 * \li Action: Inserts Index entry.
528 * \li Notion: It automatically takes the word on the cursor position.
529 * \li Syntax: index-insert [<TYPE:Name>]
530 * \li Params: <TYPE:Name>: name of the index, if multiple indices are defined.
531 with an empty argument, the default index is selected.
532 * \li Origin: leeming, 3 Aug 2000
535 { LFUN_INDEX_INSERT, "index-insert", Noop, Edit },
537 * \var lyx::FuncCode lyx::LFUN_INDEX_PRINT
538 * \li Action: Inserts list of Index entries on a new page.
539 * \li Syntax: index-print [<TYPE:Name>]
540 * \li Params: <TYPE:Name>: name of the index, if multiple indices are defined.
541 with an empty argument, the default index is selected.
542 * \li Origin: Lgb, 27 Feb 1997
545 { LFUN_INDEX_PRINT, "index-print", Noop, Edit },
548 * \var lyx::FuncCode lyx::LFUN_NOMENCL_INSERT
549 * \li Action: Inserts Nomenclature entry.
550 * \li Notion: It automatically takes the word on the cursor position if no symbol is given.
551 * \li Syntax: nomencl-insert [<SYMBOL>]
552 * \li Origin: Ugras, 4 Nov 2006
555 { LFUN_NOMENCL_INSERT, "nomencl-insert", Noop, Edit },
557 * \var lyx::FuncCode lyx::LFUN_NOMENCLATURE_PRINT
558 * \li Action: Inserts list of Nomenclature entries.
559 * \li Syntax: nomenclature-print
560 * \li Origin: Ugras, 4 Nov 2006
563 { LFUN_NOMENCL_PRINT, "nomencl-print", Noop, Edit },
566 * \var lyx::FuncCode lyx::LFUN_NOTE_INSERT
567 * \li Action: Inserts Note on the current cursor postion,
568 move selection inside the inset.
569 * \li Syntax: note-insert [<TYPE>]
570 * \li Params: <TYPE>: <Note|Greyedout|Comment> default: Note
573 { LFUN_NOTE_INSERT, "note-insert", Noop, Edit },
575 * \var lyx::FuncCode lyx::LFUN_NOTE_NEXT
576 * \li Action: Moves the cursor to the begining of next Note inset.
577 * \li Syntax: note-next
580 { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
582 * \var lyx::FuncCode lyx::LFUN_PHANTOM_INSERT
583 * \li Action: Inserts phantom on the current cursor postion,
584 move selection inside the inset.
585 * \li Syntax: phantom-insert [<TYPE>]
586 * \li Params: <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
587 * \li Origin: uwestoehr, 30 Jan 2009
590 { LFUN_PHANTOM_INSERT, "phantom-insert", Noop, Edit },
592 * \var lyx::FuncCode lyx::LFUN_NEWLINE_INSERT
593 * \li Action: Inserts a line break or new line.
594 * \li Syntax: newline-insert [<ARG>]
595 * \li Params: <ARG>: <newline|linebreak> default: newline
596 * \li Origin: JSpitzm, 25 Mar 2008
599 { LFUN_NEWLINE_INSERT, "newline-insert", Noop, Edit },
601 * \var lyx::FuncCode lyx::LFUN_ESCAPE
602 * \li Action: Clears the selection. If no text is selected call #LFUN_FINISHED_FORWARD.
604 * \li Origin: Lgb, 17 May 2001
607 { LFUN_ESCAPE, "escape", ReadOnly, Edit },
609 * \var lyx::FuncCode lyx::LFUN_DOWN
610 * \li Action: Moves the cursor one line in downward direction.
614 { LFUN_DOWN, "down", ReadOnly | NoUpdate, Edit },
616 * \var lyx::FuncCode lyx::LFUN_UP
617 * \li Action: Moves the cursor one line in upward direction.
621 { LFUN_UP, "up", ReadOnly | NoUpdate, Edit },
623 * \var lyx::FuncCode lyx::LFUN_DOWN_SELECT
624 * \li Action: Moves the cursor one line in downward direction adding the current
625 position to the selection.
626 * \li Syntax: down-select
629 { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, Edit },
631 * \var lyx::FuncCode lyx::LFUN_UP_SELECT
632 * \li Action: Moves the cursor one line in upward direction adding the current
633 position to the selection.
634 * \li Syntax: up-select
637 { LFUN_UP_SELECT, "up-select", ReadOnly | SingleParUpdate, Edit },
639 * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN
640 * \li Action: Moves the cursor one page in downward direction.
641 * \li Syntax: screen-down
644 { LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit },
646 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP
647 * \li Action: Moves the cursor one page in upward direction.
648 * \li Syntax: screen-up
651 { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit },
653 * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN_SELECT
654 * \li Action: Moves the cursor one screen in downward direction adding the current
655 position to the selection.
656 * \li Syntax: screen-down-select
659 { LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit },
661 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP_SELECT
662 * \li Action: Moves the cursor one page in upward direction adding the current
663 position to the selection.
664 * \li Syntax: screen-up-select
667 { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit },
669 * \var lyx::FuncCode lyx::LFUN_SCROLL
670 * \li Action: Scroll the buffer view.
671 * \li Notion: Only scrolls the screen up or down; does not move the cursor.
672 * \li Syntax: scroll <TYPE> <QUANTITY>
673 * \li Params: <TYPE>: line|page\n
674 <QUANTITY>: up|down|<number>
675 * \li Origin: Abdel, Dec 27 2007
678 { LFUN_SCROLL, "scroll", ReadOnly, Edit },
680 * \var lyx::FuncCode lyx::LFUN_SCREEN_RECENTER
681 * \li Action: Recenters the screen on the current cursor position.
682 * \li Syntax: screen-recenter
685 { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit },
688 * \var lyx::FuncCode lyx::LFUN_SCREEN_SHOW_CURSOR
689 * \li Action: Repositions the screen such that the cursor is visible.
690 * \li Syntax: screen-show-cursor
691 * \li Origin: vfr, 25 Mar 2009
694 { LFUN_SCREEN_SHOW_CURSOR, "screen-show-cursor", ReadOnly, Edit },
697 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD
698 * \li Action: Moves the cursor one position logically backwards.
699 * \li Notion: This is not the action which should be bound to the arrow keys,
700 because backwards may be left or right, depending on the
701 language. The arrow keys should be bound to #LFUN_CHAR_LEFT or
702 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
703 * \li Syntax: char-backward
706 { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit },
708 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD_SELECT
709 * \li Action: Moves the cursor one position logically backwards, adding
710 traversed position to the selection.
711 * \li Notion: See also #LFUN_CHAR_BACKWARD.
712 * \li Syntax: char-backward-select
715 { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit },
717 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_BACKWARD
718 * \li Action: Deletes one character in the backward direction (usually the "BackSpace" key).
719 * \li Syntax: char-delete-backward
722 { LFUN_CHAR_DELETE_BACKWARD, "char-delete-backward", SingleParUpdate, Edit },
724 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_FORWARD
725 * \li Action: Deletes one character in the backward direction (usually the "Delete" key).
726 * \li Syntax: char-delete-forward
729 { LFUN_CHAR_DELETE_FORWARD, "char-delete-forward", SingleParUpdate, Edit },
731 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD
732 * \li Action: Moves the cursor one position logically forward.
733 * \li Notion: This is not the action which should be bound to the arrow keys,
734 because forward may be left or right, depending on the language.
735 The arrow keys should be bound to #LFUN_CHAR_LEFT or
736 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
737 * \li Syntax: char-forward
740 { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit },
742 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD_SELECT
743 * \li Action: Moves the cursor one position logically forward, adding
744 traversed position to the selection.
745 * \li Notion: See also #LFUN_CHAR_FORWARD.
746 * \li Syntax: char-forward-select
749 { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit },
751 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT
752 * \li Action: Moves the cursor one position "to the left".
753 * \li Notion: This is the action which should be taken when the "left" key
754 is pressed. Generally, it moves the cursor one position to the
755 left. However, in Bidi text this become slightly more
756 complicated, and there are different modes of cursor movement.
757 In "visual mode", this moves left, plain and simple. In "logical
758 mode", movement is logically forward in RTL paragraphs, and
759 logically backwards in LTR paragraphs.
760 * \li Syntax: char-left
763 { LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit },
765 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT_SELECT
766 * \li Action: Moves the cursor one position "to the left", adding
767 traversed position to the selection.
768 * \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement.
769 * \li Syntax: char-left-select
772 { LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit },
774 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT
775 * \li Action: Moves the cursor one position "to the right".
776 * \li Notion: This is the action which should be taken when the "right" key
777 is pressed. Generally, it moves the cursor one position to the
778 right. However, in Bidi text this become slightly more
779 complicated, and there are different modes of cursor movement.
780 In "visual mode", this moves right, plain and simple. In "logical
781 mode", movement is logically forward in LTR paragraphs, and
782 logically backwards in RTL paragraphs.
783 * \li Syntax: char-right
786 { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit },
788 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT_SELECT
789 * \li Action: Moves the cursor one position "to the right", adding
790 traversed position to the selection.
791 * \li Notion: See also #LFUN_CHAR_RIGHT for exact details of the movement.
792 * \li Syntax: char-right-select
795 { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit },
798 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD
799 * \li Action: Moves the cursor to the logically previous beginning of a word.
800 * \li Notion: This is not the action which should be bound to the arrow keys,
801 because backwards may be left or right, depending on the
802 language. The arrow keys should be bound to #LFUN_WORD_LEFT or
803 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
804 * \li Syntax: word-backward
807 { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit },
809 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD_SELECT
810 * \li Action: Moves the cursor to the logically previous beginning of a word,
811 adding the logically traversed text to the selection.
812 * \li Notion: See also #LFUN_WORD_BACKWARD.
813 * \li Syntax: word-backward-select
816 { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
818 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_BACKWARD
819 * \li Action: Deletes characters to the begining of the word (usually the "C+BackSpace" key).
820 * \li Syntax: word-delete-backward
823 { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
825 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_FORWARD
826 * \li Action: Deletes characters to the end of the word (usually the "C+Delete" key).
827 * \li Syntax: word-delete-forward
830 { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
832 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_FORWARD
833 * \li Action: Search for a given string in forward direction.
834 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
835 * \li Syntax: word-find-forward [<STRING>]
836 * \li Origin: Etienne, 16 Feb 1998
839 { LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit },
841 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_BACKWARD
842 * \li Action: Search for a given string in backward direction.
843 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
844 * \li Syntax: word-find-backward [<STRING>]
845 * \li Origin: Etienne, 20 Feb 1998
848 { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
850 * \var lyx::FuncCode lyx::LFUN_WORD_FIND
851 * \li Action: Search for next occurence of a string.
852 * \li Syntax: word-find [<DATA>]
853 * \li Params: <DATA>: data encoded from Find dialog (see #lyx::find2string()).
854 If no parameter is given, search with last find-dialog
855 data is used for search (i.e. find-next).
856 * \li Origin: Andre, Jan 7 2004
859 { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
861 * \var lyx::FuncCode lyx::LFUN_WORD_REPLACE
862 * \li Action: Replace a string in the document.
863 * \li Syntax: word-replace [<DATA>]
864 * \li Params: <DATA>: data is of the form
867 <casesensitive> <matchword> <all> <forward>"
868 * \li Origin: Andre, Jan 7 2004
871 { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
873 * \var lyx::FuncCode lyx::LFUN_WORD_FINDADV
874 * \li Action: Search for next occurence of a pattern.
875 * \li Syntax: word-findadv [<DATA>]
876 * \li Params: <DATA>: data encoded from FindAdv dialog (see #lyx::findadv2string()).
877 If no parameter is given, search with last find-dialog
878 data is used for search (i.e. find-next).
879 * \li Origin: Tommaso, Nov 15 2007
882 { LFUN_WORD_FINDADV, "word-findadv", ReadOnly | NoBuffer, Edit },
884 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD
885 * \li Action: Moves the cursor to the logically next beginning of a word.
886 * \li Notion: This is not the action which should be bound to the arrow keys,
887 because forward may be left or right, depending on the language.
888 The arrow keys should be bound to #LFUN_WORD_LEFT or
889 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
890 * \li Syntax: word-forward
893 { LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
895 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD_SELECT
896 * \li Action: Moves the cursor to the logically next beginning of a word,
897 adding the logically traversed text to the selection.
898 * \li Notion: See also #LFUN_WORD_FORWARD.
899 * \li Syntax: word-forward-select
902 { LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
904 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT
905 * \li Action: Moves the cursor to the next beginning of a word "on the left".
906 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
907 "left" key is pressed. Generally, it moves the cursor to the
908 next beginning of a word on the left. However, in Bidi text this
909 become slightly more complicated, and there are different modes
910 of cursor movement. In "visual mode", this moves left, plain and
911 simple. In "logical mode", movement is logically forward in RTL
912 paragraphs, and logically backwards in LTR paragraphs.
913 * \li Syntax: word-left
914 * \li Origin: dov, 28 Oct 2007
917 { LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
919 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT_SELECT
920 * \li Action: Moves the cursor to the next beginning of a word "on the left",
921 adding *logically* traversed text to the selection.
922 * \li Notion: See also #LFUN_WORD_LEFT for exact details of the movement.
923 * \li Syntax: word-left-select
924 * \li Origin: dov, 28 Oct 2007
927 { LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit },
929 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT
930 * \li Action: Moves the cursor to the next beginning of a word "on the right".
931 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
932 "right" key is pressed. Generally, it moves the cursor to the
933 next beginning of a word on the right. However, in Bidi text
934 this become slightly more complicated, and there are different
935 modes of cursor movement. In "visual mode", this moves right,
936 plain and simple. In "logical mode", movement is logically
937 forward in LTR paragraphs, and logically backwards in RTL
939 * \li Syntax: word-right
940 * \li Origin: dov, 28 Oct 2007
943 { LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit },
945 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT_SELECT
946 * \li Action: Moves the cursor to the next beginning of a word "on the right",
947 adding *logically* traversed text to the selection.
948 * \li Notion: See also #LFUN_WORD_RIGHT for exact details of the movement.
949 * \li Syntax: word-right-select
950 * \li Origin: dov, 28 Oct 2007
953 { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
955 * \var lyx::FuncCode lyx::LFUN_WORD_SELECT
956 * \li Action: Puts the word where the cursor stands into the selection.
957 * \li Syntax: word-select
958 * \li Origin: Andre, 11 Sep 2002
961 { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
963 * \var lyx::FuncCode lyx::LFUN_WORD_CAPITALIZE
964 * \li Action: Capitalizes the words in the selection (i.e. the first letters)
965 or the letter on the cursor position.
966 * \li Syntax: word-capitalize
969 { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
971 * \var lyx::FuncCode lyx::LFUN_WORD_UPCASE
972 * \li Action: Change the words in the selection or from the cursor position
973 to the end of word to the upper case.
974 * \li Syntax: word-upcase
977 { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
979 * \var lyx::FuncCode lyx::LFUN_WORD_LOWCASE
980 * \li Action: Change the words in the selection or from the cursor position
981 to the end of word to the lower case.
982 * \li Syntax: word-lowcase
985 { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
987 * \var lyx::FuncCode lyx::LFUN_SPELLING_ADD
988 * \li Action: Add the word under the cursor to the respective
989 * spell checker dictionary.
990 * \li Syntax: spelling-add [<STRING>] [<LANG>]
991 * \li Params: <WORD>: word to add
992 <LANG>: language name (see file languages)
993 * \li Origin: JSpitzm, 18 Jan 2010
996 { LFUN_SPELLING_ADD, "spelling-add", ReadOnly, Edit },
998 * \var lyx::FuncCode lyx::LFUN_SPELLING_IGNORE
999 * \li Action: Let the spell checker ignore the word under the cursor
1000 * in the current session for the given language.
1001 * \li Syntax: spelling-ignore [<WORD>] [<LANG>]
1002 * \li Params: <WORD>: word to ignore
1003 <LANG>: language name (see file languages)
1004 * \li Origin: JSpitzm, 18 Jan 2010
1007 { LFUN_SPELLING_IGNORE, "spelling-ignore", ReadOnly, Edit },
1009 * \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
1010 * \li Action: Look up thesaurus entries with respect to the word under the cursor.
1011 * \li Syntax: thesaurus-entry [<STRING>] [lang=<LANG>]
1012 * \li Params: <STRING>: word to look up
1013 <LANG>: language (see file languages)
1014 * \li Origin: Levon, 20 Jul 2001
1017 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
1019 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN
1020 * \li Action: Move the cursor to the beginning of the document.
1021 * \li Syntax: buffer-begin
1024 { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
1026 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN_SELECT
1027 * \li Action: Move the cursor to the beginning of the document adding the
1028 traversed text to the selection.
1029 * \li Syntax: buffer-begin-select
1032 { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
1034 * \var lyx::FuncCode lyx::LFUN_BUFFER_END
1035 * \li Action: Move the cursor to the end of the document.
1036 * \li Syntax: buffer-end
1039 { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
1041 * \var lyx::FuncCode lyx::LFUN_BUFFER_END_SELECT
1042 * \li Action: Move the cursor to the end of the document adding the
1043 traversed text to the selection.
1044 * \li Syntax: buffer-end-select
1047 { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
1050 * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN
1051 * \li Action: Move the cursor to the beginning of the current inset
1052 if it is not already there, or at the beginning of the
1053 enclosing inset otherwise
1054 * \li Syntax: inset-begin
1055 * \li Origin: lasgouttes, 16 Mar 2009
1058 { LFUN_INSET_BEGIN, "inset-begin", ReadOnly, Edit },
1060 * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN_SELECT
1061 * \li Action: Move the cursor to the beginning of the current inset
1062 if it is not already there, or at the beginning of the
1063 enclosing inset otherwise (adding the
1064 traversed text to the selection).
1065 * \li Syntax: inset-begin-select
1066 * \li Origin: lasgouttes, 16 Mar 2009
1069 { LFUN_INSET_BEGIN_SELECT, "inset-begin-select", ReadOnly, Edit },
1071 * \var lyx::FuncCode lyx::LFUN_INSET_END
1072 * \li Action: Move the cursor to the end of the current inset
1073 if it is not already there, or at the end of the
1074 enclosing inset otherwise
1075 * \li Syntax: inset-end
1076 * \li Origin: lasgouttes, 16 Mar 2009
1079 { LFUN_INSET_END, "inset-end", ReadOnly, Edit },
1081 * \var lyx::FuncCode lyx::LFUN_INSET_END_SELECT
1082 * \li Action: Move the cursor to the end of the current inset
1083 if it is not already there, or at the end of the
1084 enclosing inset otherwise (adding the
1085 traversed text to the selection).
1086 * \li Syntax: inset-end-select
1087 * \li Origin: lasgouttes, 16 Mar 2009
1090 { LFUN_INSET_END_SELECT, "inset-end-select", ReadOnly, Edit },
1093 * \var lyx::FuncCode lyx::LFUN_INSET_SELECT_ALL
1094 * \li Action: Selects all contents of an inset.
1095 * \li Syntax: inset-select-all
1096 * \li Origin: vfr, 22 Aug 2009
1099 { LFUN_INSET_SELECT_ALL, "inset-select-all", ReadOnly, Edit },
1102 * \var lyx::FuncCode lyx::LFUN_SECTION_SELECT
1103 * \li Action: Selects the whole section.
1104 * \li Notion: The cursor should be in a section heading
1105 before calling this lfun.
1106 * \li Syntax: section-select
1107 * \li Origin: vfr, 05 May 2009
1110 { LFUN_SECTION_SELECT, "section-select", ReadOnly, Edit },
1113 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN
1114 * \li Action: Move the cursor to the begining of the (screen) line.
1115 * \li Syntax: line-begin
1118 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
1120 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN_SELECT
1121 * \li Action: Move the cursor to the beginning of the (screen) line adding the
1122 traversed text to the selection.
1123 * \li Syntax: line-begin-select
1126 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
1128 * \var lyx::FuncCode lyx::LFUN_LINE_END
1129 * \li Action: Move the cursor to the end of the (screen) line.
1130 * \li Syntax: line-end
1133 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
1135 * \var lyx::FuncCode lyx::LFUN_LINE_END_SELECT
1136 * \li Action: Move the cursor to the end of the (screen) line adding the
1137 traversed text to the selection.
1138 * \li Syntax: line-end-select
1141 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
1143 * \var lyx::FuncCode lyx::LFUN_LINE_DELETE
1144 * \li Action: Deletes the letters to the end of the (screen) line or
1145 deletes the selection.
1146 * \li Syntax: line-delete-forward
1149 { LFUN_LINE_DELETE, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
1151 * \var lyx::FuncCode lyx::LFUN_COPY
1152 * \li Action: Copies to the clipboard the last edit.
1156 { LFUN_COPY, "copy", ReadOnly, Edit },
1158 * \var lyx::FuncCode lyx::LFUN_CUT
1159 * \li Action: Cuts to the clipboard.
1163 { LFUN_CUT, "cut", Noop, Edit },
1165 * \var lyx::FuncCode lyx::LFUN_PASTE
1166 * \li Action: Pastes material (text or picture) from the active clipboard.
1167 * \li Syntax: paste [<TYPE>|<NUM>]
1168 * \li Params: <TYPE>: emf|pdf|png|jpeg|linkback|wmf \n
1169 <NUM>: number of the selection in the internal clipboard stack to be pasted.
1172 { LFUN_PASTE, "paste", Noop, Edit },
1174 * \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE
1175 * \li Action: Pastes text from the active clipboard.
1176 * \li Syntax: clipboard-paste [<ARG>]
1177 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1178 * \li Origin: baum, 10 Jul 2006
1181 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
1183 * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
1184 * \li Action: Pastes the currently text selected text.
1185 * \li Notion: Primary selection mechanism is linux-only thing.
1186 * \li Syntax: primary-selection-paste [<ARG>]
1187 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1190 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
1192 * \var lyx::FuncCode lyx::LFUN_SELECTION_PASTE
1193 * \li Action: Pastes the text in permanent selection.
1194 * \li Syntax: selection-paste
1197 { LFUN_SELECTION_PASTE, "selection-paste", Noop, Edit },
1199 * \var lyx::FuncCode lyx::LFUN_UNDO
1200 * \li Action: Undoes the last edit.
1204 { LFUN_UNDO, "undo", Noop, Edit },
1206 * \var lyx::FuncCode lyx::LFUN_REDO
1207 * \li Action: Redoes the last thing undone.
1211 { LFUN_REDO, "redo", Noop, Edit },
1213 * \var lyx::FuncCode lyx::LFUN_REPEAT
1214 * \li Action: Repeat the given command.
1215 * \li Syntax: repeat <COUNT> <LFUN-COMMAND>
1216 * \li Origin: Andre, 27 Oct 2003
1219 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
1221 * \var lyx::FuncCode lyx::LFUN_CHARS_TRANSPOSE
1222 * \li Action: Transposes the character at the cursor with the one before it.
1223 * \li Syntax: chars-transpose
1224 * \li Origin: Lgb, 25 Apr 2001
1227 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
1230 * \var lyx::FuncCode lyx::LFUN_DEPTH_DECREMENT
1231 * \li Action: Decrease the nesting depth of the (selected) paragraph(s)
1233 * \li Syntax: depth-decrement
1236 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
1238 * \var lyx::FuncCode lyx::LFUN_DEPTH_INCREMENT
1239 * \li Action: Increase the nesting depth of the (selected) paragraph(s)
1241 * \li Syntax: depth-increment
1244 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
1247 * \var lyx::FuncCode lyx::LFUN_FONT_BOLD
1248 * \li Action: Toggles the bold font (selection-wise) using mathbf in math.
1249 * \li Syntax: font-bold
1252 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
1255 * \var lyx::FuncCode lyx::LFUN_FONT_BOLDSYMBOL
1256 * \li Action: Toggles the bold font (selection-wise) using boldsymbol in math.
1257 * \li Syntax: font-boldsymbol
1260 { LFUN_FONT_BOLDSYMBOL, "font-boldsymbol", Noop, Layout },
1262 * \var lyx::FuncCode lyx::LFUN_FONT_TYPEWRITER
1263 * \li Action: Toggles the typewriter family font (selection-wise).
1264 * \li Syntax: font-typewriter
1267 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
1269 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERLINE
1270 * \li Action: Toggles underline in the font (selection-wise).
1271 * \li Syntax: font-underline
1274 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
1276 * \var lyx::FuncCode lyx::LFUN_FONT_UULINE
1277 * \li Action: Toggles double underline in the font (selection-wise).
1278 * \li Syntax: font-underunderline
1279 * \li Origin: sanda, 5 May 2009
1282 { LFUN_FONT_UULINE, "font-underunderline", Noop, Layout },
1284 * \var lyx::FuncCode lyx::LFUN_FONT_UWAVE
1285 * \li Action: Toggles wavy underline in the font (selection-wise).
1286 * \li Syntax: font-underwave
1287 * \li Origin: sanda, 5 May 2009
1290 { LFUN_FONT_UWAVE, "font-underwave", Noop, Layout },
1292 * \var lyx::FuncCode lyx::LFUN_FONT_STRIKEOUT
1293 * \li Action: Toggles strikeout (strike-through) in the font (selection-wise).
1294 * \li Syntax: font-strikeout
1295 * \li Origin: sanda, 3 May 2009
1298 { LFUN_FONT_STRIKEOUT, "font-strikeout", Noop, Layout },
1300 * \var lyx::FuncCode lyx::LFUN_FONT_EMPH
1301 * \li Action: Toggles the emphasis font style (selection-wise).
1302 * \li Syntax: font-emph
1305 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
1307 * \var lyx::FuncCode lyx::LFUN_FONT_NOUN
1308 * \li Action: Toggles Noun text style font (selection-wise).
1309 * \li Syntax: font-noun
1312 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
1314 * \var lyx::FuncCode lyx::LFUN_FONT_ROMAN
1315 * \li Action: Toggles Roman family font (selection-wise).
1316 * \li Syntax: font-roman
1319 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
1321 * \var lyx::FuncCode lyx::LFUN_FONT_SANS
1322 * \li Action: Toggles Sans Serif family font (selection-wise).
1323 * \li Syntax: font-sans
1326 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
1328 * \var lyx::FuncCode lyx::LFUN_FONT_FRAK
1329 * \li Action: Toggles Fraktur family font (math-mode, selection-wise).
1330 * \li Syntax: font-frak
1331 * \li Origin: vermeer, 10 Jan 2002
1334 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
1336 * \var lyx::FuncCode lyx::LFUN_FONT_ITAL
1337 * \li Action: Toggles Italics font shape (math-mode, selection-wise).
1338 * \li Syntax: font-ital
1339 * \li Origin: vermeer, 10 Jan 2002
1342 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
1344 * \var lyx::FuncCode lyx::LFUN_FONT_DEFAULT
1345 * \li Action: Reverts the settings of the font to the default values (selection-wise).
1346 * \li Syntax: font-default
1349 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
1351 * \var lyx::FuncCode lyx::LFUN_FONT_SIZE
1352 * \li Action: Sets font size according to lyx format string.
1353 * \li Syntax: font-size <SIZE>
1354 * \li Params: <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|\n
1355 largest|huge|giant|increase|decrease|default
1358 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
1360 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_APPLY
1361 * \li Action: Toggle user-defined (=last-time used) text style.
1362 * \li Notion: This style is set via #LFUN_TEXTSTYLE_UPDATE, which is
1363 automatically trigerred when using Text Style dialog.
1364 * \li Syntax: textstyle-apply
1365 * \li Origin: leeming, 12 Mar 2003
1368 { LFUN_TEXTSTYLE_APPLY, "textstyle-apply", Noop, Layout },
1370 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_UPDATE
1371 * \li Action: Apply text style and update the settings to be used by #LFUN_TEXTSTYLE_APPLY.
1372 * \li Syntax: textstyle-update <FONT_INFO>
1373 * \li Params: <FONT_INFO>: specifies font atributes, e.g. family, series, shape,
1374 size, emph, noun, underbar, number, color, language,
1376 Use lyx -dbg action for exact syntax of text-style
1378 * \li Origin: leeming, 12 Mar 2003
1381 { LFUN_TEXTSTYLE_UPDATE, "textstyle-update", Noop, Layout },
1383 * \var lyx::FuncCode lyx::LFUN_SCREEN_FONT_UPDATE
1384 * \li Action: Update fonts and its metrics.
1385 * \li Notion: Automatically called after zoom, dpi, font names, or norm change.
1386 * \li Syntax: screen-font-update
1387 * \li Origin: ARRae, 13 Aug 2000
1390 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
1392 * \var lyx::FuncCode lyx::LFUN_FONT_STATE
1393 * \li Action: Returns the info about the current font.
1394 * \li Syntax: font-state
1397 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
1400 * \var lyx::FuncCode lyx::LFUN_CITATION_INSERT
1401 * \li Action: Inserts citation from loaded citation database.
1402 * \li Syntax: citation-insert [<KEY>[|<TEXT_BEFORE>]]
1403 * \li Params: <KEY>: Citation (shortcut listed in available citations). \n
1404 <TEXT_BEFORE>: text which should appear before citation.
1405 * \li Origin: AAS, 97-02-23
1408 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
1410 * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_ADD
1411 * \li Action: Adds database, which will be used for bibtex citations.
1412 * \li Notion: Databases are added to the first BibTeX inset
1413 (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
1414 * \li Syntax: bibtex-database-add <DATABASE-NAME>
1415 * \li Origin: Ale, 30 May 1997
1418 { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit },
1420 * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_DEL
1421 * \li Action: Adds database, which will be used for bibtex citations.
1422 * \li Notion: Databases are deleted from the first BibTeX inset
1423 (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
1424 * \li Syntax: bibtex-database-del <DATABASE-NAME>
1425 * \li Origin: Ale, 30 May 1997
1428 { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
1431 * \var lyx::FuncCode lyx::LFUN_LAYOUT
1432 * \li Action: Sets the layout (that is, environment) for the current paragraph.
1433 * \li Syntax: layout <LAYOUT>
1434 * \li Params: <LAYOUT>: the layout to use
1437 { LFUN_LAYOUT, "layout", Noop, Layout },
1439 * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH
1440 * \li Action: Launches the paragraph settings dialog.
1441 * \li Syntax: layout-paragraph
1444 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
1446 * \var lyx::FuncCode lyx::LFUN_LAYOUT_TABULAR
1447 * \li Action: Launches the tabular settings dialog.
1448 * \li Syntax: layout-tabular
1449 * \li Origin: Jug, 31 Jul 2000
1452 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
1454 * \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE
1455 * \li Action: Displays list of layout choices.
1456 * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
1457 dropbox allowing for choice of layout.
1458 * \li Syntax: drop-layouts-choice
1461 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
1463 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
1464 * \li Action: Clears the module list.
1465 * \li Notion: Clears the list of included modules for the current buffer.
1466 * \li Syntax: layout-modules-clear
1467 * \li Origin: rgh, 25 August 2007
1470 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", NoInternal, Layout },
1472 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULE_ADD
1473 * \li Action: Adds a module.
1474 * \li Notion: Adds a module to the list of included modules for the current buffer.
1475 * \li Syntax: layout-module-add <MODULE>
1476 * \li Params: <MODULE>: the module to be added
1477 * \li Origin: rgh, 25 August 2007
1480 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", NoInternal, Layout },
1482 * \var lyx::FuncCode lyx::LFUN_LAYOUT_RELOAD
1483 * \li Action: Reloads layout information.
1484 * \li Notion: Reloads all layout information for the current buffer from disk, thus
1485 recognizing any changes that have been made to layout files on the fly.
1486 This is intended to be used only by layout developers and should not be
1487 used when one is trying to do actual work.
1488 * \li Syntax: layout-reload
1489 * \li Origin: rgh, 3 September 2007
1492 { LFUN_LAYOUT_RELOAD, "layout-reload", NoInternal, Layout },
1494 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
1495 * \li Action: Sets the text class for the current buffer.
1496 * \li Syntax: textclass-apply <TEXTCLASS>
1497 * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
1498 the filename, minus the ".layout" extension.
1501 { LFUN_TEXTCLASS_APPLY, "textclass-apply", NoInternal, Layout },
1503 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
1504 * \li Action: Loads information for a textclass from disk.
1505 * \li Syntax: textclass-load <TEXTCLASS>
1506 * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
1507 the filename, minus the ".layout" extension.
1510 { LFUN_TEXTCLASS_LOAD, "textclass-load", NoInternal, Layout },
1513 * \var lyx::FuncCode lyx::LFUN_MARK_OFF
1514 * \li Action: Disable selecting of text-region.
1515 * \li Syntax: mark-off
1518 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
1520 * \var lyx::FuncCode lyx::LFUN_MARK_ON
1521 * \li Action: Enable selecting of text-region.
1522 * \li Notion: After enabling you can simply move arrow keys to get selected region.
1523 * \li Syntax: mark-on
1526 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
1528 * \var lyx::FuncCode lyx::LFUN_MARK_TOGGLE
1529 * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
1530 * \li Syntax: mark-toggle
1531 * \li Origin: Andre, May 5 2006
1534 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
1537 * \var lyx::FuncCode lyx::LFUN_MATH_DELIM
1538 * \li Action: Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
1539 * \li Syntax: math-delim [<LEFT>] [<RIGHT>]
1540 * \li Params: <LEFT/RIGHT>: Delimiters to be used. Each delimiter can be specified by
1541 either a LaTeX name or a valid character.
1542 ( is the default letter.
1543 * \li Sample: math-delim { rangle
1544 * \li Origin: Alejandro, 18 Jun 1996
1547 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
1549 * \var lyx::FuncCode lyx::LFUN_MATH_BIGDELIM
1550 * \li Action: Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
1551 * \li Syntax: math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
1552 * \li Params: <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r \n
1553 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
1554 * \li Sample: math-bigdelim "Bigl" "\Downarrow" "Bigr" "\}"
1555 * \li Origin: Enrico & Georg, 7 May 2006
1558 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
1560 * \var lyx::FuncCode lyx::LFUN_MATH_DISPLAY
1561 * \li Action: Creates a new displayed equation in text mode.
1562 Toggles inlined/display formula in math mode.
1563 * \li Syntax: math-display [<ARG>]
1564 * \li Params: <ARG>: this argument will be passed to #LFUN_MATH_INSERT when creating
1565 new equation from the text mode.
1566 * \li Origin: Alejandro, 18 Jun 1996
1569 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
1571 * \var lyx::FuncCode lyx::LFUN_MATH_INSERT
1572 * \li Action: Inserts math objects and symbols.
1573 * \li Syntax: math-insert <ARG>
1574 * \li Params: <ARG>: Symbol or LaTeX code to be inserted.
1575 * \li Notion: When <ARG> is a _single_ math inset with more than one cell
1576 (such as "x_y^z" or "\frac{x}{y}"), the content of cell(0) is
1577 replaced by the current selection (only works if the selection
1578 is in mathed). As an example, if "abc" is selected in mathed,
1579 "math-insert \frac{x}{y}" replaces "abc" with "\frac{abc}{y}",
1580 and "math-insert x_y^z" replaces "abc" with "abc_y^z".
1581 If nothing is selected (or the selection is not in mathed),
1582 math-insert works as expected.
1585 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
1587 * \var lyx::FuncCode lyx::LFUN_MATH_SUBSCRIPT
1588 * \li Action: Enters subscript expression in math expression.
1589 * \li Syntax: math-subscript
1590 * \li Origin: vermeer, 12 Dec 2001
1593 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
1595 * \var lyx::FuncCode lyx::LFUN_MATH_SUPERSCRIPT
1596 * \li Action: Enters subscript expression in math expression.
1597 * \li Syntax: math-superscript
1598 * \li Origin: vermeer, 12 Dec 2001
1601 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
1603 * \var lyx::FuncCode lyx::LFUN_MATH_LIMITS
1604 * \li Action: Toggles the position of the limits from above/below to the right
1605 side an vice versa in integral symbol, a limit, a summation, etc.
1606 * \li Notion: Put the cursor before the symbol with the limits and then invoke
1608 * \li Syntax: math-limits [<STATE>]
1609 * \li Params: <STATE>: limits|nolimits
1612 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
1614 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO
1615 * \li Action: Inserts a math macro definition at the cursor position in the text.
1616 * \li Syntax: math-macro <NAME> [<NARGS>] [def]
1617 * \li Params: <NAME>: The name of the macro, e.g. "mymacro".\n
1618 <NARGS>: The number of parameters of the macro. Default is 0.
1619 "def": Has no effect anymore, just for compatibility with former LyX versions.
1620 * \li Origin: ale, 10 May 1997; sts, 21 Dec 2007
1623 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
1625 * \var lyx::FuncCode lyx::LFUN_MATH_MUTATE
1626 * \li Action: Mutates the type of math inset to the newly selected one.
1627 * \li Syntax: math-mutate <TYPE>
1628 * \li Params: <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
1629 multline|gather|flalign
1630 * \li Origin: Andre, 23 May 2001
1633 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
1635 * \var lyx::FuncCode lyx::LFUN_MATH_SPACE
1636 * \li Action: Inserts space into math expression.
1637 * \li Notion: Use spacebar after entering this space to change type of space.
1638 * \li Syntax: math-space [<TYPE>] [<LEN>]
1639 * \li Params: <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace \n
1640 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad \n
1641 custom space: hspace \n
1642 "," used by default.\n
1643 Note that ! is equivalent to negthinspace, , = thinspace,
1644 : = medspace, and ; = thickspace.\n
1645 <LEN>: length for custom spaces (hspace)
1646 * \li Origin: Andre, 25 Jul 2001; sanda, 16 Jun 2008
1649 { LFUN_MATH_SPACE, "math-space", Noop, Math },
1651 * \var lyx::FuncCode lyx::LFUN_MATH_MATRIX
1652 * \li Action: Inserts a matrix.
1653 * \li Syntax: math-matrix <COLS> <ROWS> [<ALIGN>]
1654 * \li Params: <ALIGN>: Alignment is a word composed of the vertical alignment
1655 (b, c or t) (i.e. 1 char) and the horizontal alignments
1656 (l, c or r) (i.e. <COL> chars).
1657 * \li Sample: math-matrix 3 3 bccc
1660 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
1662 * \var lyx::FuncCode lyx::LFUN_MATH_AMS_MATRIX
1663 * \li Action: Inserts a matrix.
1664 * \li Syntax: math-matrix <COLS> <ROWS> [<DECORATION>]
1665 * \li Params: <DECORATION>: Decoration determines the LaTeX name of the matrix
1666 that should be created.
1667 * \li Sample: math-ams-matrix 3 3 bmatrix
1670 { LFUN_MATH_AMS_MATRIX, "math-ams-matrix", Noop, Math },
1672 * \var lyx::FuncCode lyx::LFUN_MATH_MODE
1673 * \li Action: In text mode enters math mode (i.e. puts math insets on the current
1674 cursor position), in math mode enters text mode inside math expression.
1675 * \li Notion: If there is some selected text, it puts the text inside created math box.
1676 * \li Syntax: math-mode [on|<ARG>]
1677 * \li Params: <ARG>: eventual argument (LaTeX code) is passed to #LFUN_MATH_INSERT .\n
1678 "on": allow only entering of math mode from text mode.
1679 * \li Origin: Alejandro, 4 Jun 1996
1682 { LFUN_MATH_MODE, "math-mode", Noop, Math },
1684 * \var lyx::FuncCode lyx::LFUN_REGEXP_MODE
1685 * \li Action: Enters regexp mode (i.e., puts regexp insets on the current
1686 cursor position). Used by the advanced search dialog.
1687 * \li Notion: If there is any selected text, then it is moved inside the created
1689 * \li Syntax: regexp-mode [<ARG>]
1690 * \li Params: <ARG>: eventual argument (regular expression).
1691 * \li Origin: Tommaso, 4 Oct 2008
1694 { LFUN_REGEXP_MODE, "regexp-mode", Noop, Math },
1696 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
1697 * \li Action: Toggles numbering of the current formula line.
1698 * \li Notion: Must be in display formula mode.
1699 * \li Syntax: math-number-line-toggle
1700 * \li Origin: Alejandro, 18 Jun 1996
1703 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
1705 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
1706 * \li Action: Toggles numbering/labeling of the current formula.
1707 * \li Notion: Must be in display formula mode.
1708 * \li Syntax: math-number-toggle
1709 * \li Origin: Alejandro, 4 Jun 1996
1712 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
1714 * \var lyx::FuncCode lyx::LFUN_MATH_EXTERN
1715 * \li Action: Calls external program and passes the current expression/equation
1716 as an argument for the calculation in the format appropriate to the
1718 * \li Notion: Selection can be used to determine the input for the external program.
1719 * \li Syntax: math-extern <LANG> [<COMMAND>]
1720 * \li Params: <LANG>: octave|maxima|maple|mathematica|script \n
1721 where "script" stands fot the external script (normalized
1722 expression will be passed)
1723 * \li Origin: Andre, 24 Apr 2001
1724 * \li Sample: math-extern maple simplify
1727 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
1729 * \var lyx::FuncCode lyx::LFUN_MATH_SIZE
1730 * \li Action: Changes arbitrarily the size used by math fonts inside a context.
1731 * \li Notion: Provides an interface to the LaTeX math mode font size commands.
1732 * \li Syntax: math-size <STYLE>
1733 * \li Params: <STYLE>: \displaystyle|\textstyle|\scriptstyle|\scriptscriptstyle
1734 * \li Origin: Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
1737 { LFUN_MATH_SIZE, "math-size", Noop, Math },
1739 * \var lyx::FuncCode lyx::LFUN_MATH_FONT_STYLE
1740 * \li Action: Changes the text style used in math.
1741 * \li Syntax: math-font-style <STYLE>
1742 * \li Params: <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf
1743 |textnormal|textrm|textsf|texttt|textbf|textmd|textit
1744 |textsc|textsl|textup
1745 * \li Origin: vfr, 9 jan 2009
1748 { LFUN_MATH_FONT_STYLE, "math-font-style", Noop, Math },
1750 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
1751 * \li Action: Unfold a Math Macro.
1752 * \li Notion: Unfold the Math Macro the cursor is in, i.e.
1754 * \li Syntax: math-macro-unfold
1755 * \li Origin: sts, 06 January 2008
1758 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
1760 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
1761 * \li Action: Fold a Math Macro.
1762 * \li Notion: Fold the Math Macro the cursor is in if it was
1763 unfolded, i.e. displayed as \foo before.
1764 * \li Syntax: math-macro-fold
1765 * \li Origin: sts, 06 January 2008
1768 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
1770 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
1771 * \li Action: Add a parameter.
1772 * \li Notion: Add a parameter to a Math Macro.
1773 * \li Params: <NUM>: The number of the parameter behind which the new one
1774 will be added (1 for the first, i.e. use 0 for add a
1775 parameter at the left), defaults to the last one.
1776 * \li Syntax: math-macro-add-param <NUM>
1777 * \li Origin: sts, 06 January 2008
1780 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
1782 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
1783 * \li Action: Remove the last parameter.
1784 * \li Notion: Remove the last parameter of a Math Macro and
1785 remove its value in all instances of the macro
1787 * \li Params: <NUM>: The number of the parameter to be deleted (1 for
1788 the first), defaults to the last one.
1789 * \li Syntax: math-macro-remove-param <NUM>
1790 * \li Origin: sts, 06 January 2008
1793 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
1795 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
1796 * \li Action: Append a greedy parameter.
1797 * \li Notion: Append a greedy parameter to a Math Macro which
1798 eats the following mathed cell in every instance of
1799 the macro in the buffer.
1800 * \li Syntax: math-macro-append-greedy-param
1801 * \li Origin: sts, 06 January 2008
1804 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
1806 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
1807 * \li Action: Remove a greedy parameter.
1808 * \li Notion: Remove a greedy parameter of a Math Macro and spit
1809 out the values of it in every instance of the macro
1810 in the buffer. If it is an optional parameter the [valud]
1812 * \li Syntax: math-macro-remove-greedy-param
1813 * \li Origin: sts, 06 January 2008
1816 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
1818 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
1819 * \li Action: Make a parameter optional.
1820 * \li Notion: Turn the first non-optional parameter of a Math Macro
1821 into an optional parameter with a default value.
1822 * \li Syntax: math-macro-make-optional
1823 * \li Origin: sts, 06 January 2008
1826 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
1828 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
1829 * \li Action: Make a parameter non-optional.
1830 * \li Notion: Turn the last optional parameter of a Math Macro
1831 into a non-optional parameter. The default value is
1832 remembered to be reused later if the user changes his mind.
1833 * \li Syntax: math-macro-make-nonoptional
1834 * \li Origin: sts, 06 January 2008
1837 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
1839 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
1840 * \li Action: Add an optional parameter.
1841 * \li Notion: Insert an optional parameter just behind the
1842 already existing optional parameters.
1843 * \li Syntax: math-macro-add-optional-param
1844 * \li Origin: sts, 06 January 2008
1847 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
1849 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
1850 * \li Action: Remove the last optional parameter.
1851 * \li Notion: Remove the last optional parameter of a Math Macro and
1852 remove it in all the instances of the macro in the buffer.
1853 * \li Syntax: math-macro-remove-optional-param
1854 * \li Origin: sts, 06 January 2008
1857 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
1859 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
1860 * \li Action: Add a greedy optional parameter.
1861 * \li Notion: Add a greedy optional parameter which eats the value
1862 from the following cells in mathed which are in the [value]
1864 * \li Syntax: math-macro-add-greedy-optional-param
1865 * \li Origin: sts, 06 January 2008
1868 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
1870 * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
1871 * \li Action: Only active in Math Macro definition.
1872 * \li Notion: Dummy function which is only active in a Math Macro definition.
1873 It's used to toggle the Math Macro toolbar if the cursor moves
1874 into a Math Macro definition.
1875 * \li Syntax: in-mathmacrotemplate
1876 * \li Origin: sts, 06 January 2008
1879 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
1882 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
1883 * \li Action: Moves the current paragraph downwards in the document.
1884 * \li Syntax: paragraph-move-down
1885 * \li Origin: Edwin, 8 Apr 2006
1888 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
1890 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
1891 * \li Action: Moves the current paragraph upwards in the document.
1892 * \li Syntax: paragraph-move-up
1893 * \li Origin: Edwin, 8 Apr 2006
1896 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
1899 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP
1900 * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1901 in upward direction.
1902 * \li Syntax: paragraph-up
1903 * \li Origin: Asger, 1 Oct 1996
1906 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
1908 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP_SELECT
1909 * \li Action: Move the cursor and select the text to the next paragraph (or
1910 begining of the current one) in upward direction.
1911 * \li Syntax: paragraph-up-select
1912 * \li Origin: Asger, 1 Oct 1996
1915 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
1917 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN
1918 * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1919 in downward direction.
1920 * \li Syntax: paragraph-down
1921 * \li Origin: Asger, 1 Oct 1996
1924 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
1926 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN_SELECT
1927 * \li Action: Move the cursor and select the text to the next paragraph (or
1928 begining of the current one) in downward direction.
1929 * \li Syntax: paragraph-down-select
1930 * \li Origin: Asger, 1 Oct 1996
1933 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
1935 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
1936 * \li Action: Jump to a paragraph given by its id number and optionally the
1937 desired position within the paragraph.
1938 * \li Notion: Note that id number of paragraph is not the sequential number of paragraph
1939 seen on the screen. Moreover the id is unique for all opened buffers (documents).
1940 * \li Syntax: paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
1941 * \li Params: <PAR_ID_NUMBER>: paragraph id \n
1942 <POSITION_IN_PAR>: desired position within the paragraph
1943 * \li Origin: Dekel, 26 Aug 2000
1946 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly | NoInternal, Edit },
1948 * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1949 * \li Action: Breaks the current paragraph at the current location.
1950 * \li Notion: Removes the selection.
1951 * \li Syntax: break-paragraph [<LAYOUT>]
1952 * \li Params: <LAYOUT>: "inverse" - decreases depth by one (or change layout
1953 to default layout) when the cursor is at the end of
1957 { LFUN_BREAK_PARAGRAPH, "break-paragraph", Noop, Edit },
1959 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
1960 * \li Action: Change paragraph settings.
1961 * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
1962 This function only modifies, and does not override, existing settings.
1963 Note that the "leftindent" indent setting is deprecated.
1964 * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
1965 * \li Params: <INDENT>: \noindent|\indent|\indent-toggle|\leftindent LENGTH\n
1966 <SPACING>: \paragraph_spacing default|single|onehalf|double|other SIZE \n
1967 <ALIGN>: \align block|left|right|center|default\n
1968 <OTHERS>: \labelwidthstring WIDTH|\start_of_appendix
1969 * \li Origin: rgh, Aug 15 2007
1972 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
1974 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
1975 * \li Action: Change paragraph settings.
1976 * \li Notion: Overwrite all nonspecified settings to the default ones.
1977 Use paragraph-params lfun if you don't want to overwrite others settings.
1978 * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
1979 * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
1980 * \li Origin: leeming, 30 Mar 2004
1983 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
1985 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UPDATE
1986 * \li Action: Updates the values inside the paragraph dialog from the paragraph.
1987 * \li Notion: This is internal LFUN, not to be used by users. Called internally
1988 by #LFUN_DIALOG_UPDATE.
1989 * \li Origin: leeming, 13 Mar 2003
1992 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
1995 * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
1996 * \li Action: Move the current group in the upward direction in the
1997 structure of the document.
1998 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1999 the whole substructure of the group.
2000 * \li Syntax: outline-up
2001 * \li Origin: Vermeer, 23 Mar 2006
2004 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
2006 * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
2007 * \li Action: Move the current group in the downward direction in the
2008 structure of the document.
2009 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
2010 the whole substructure of the group.
2011 * \li Syntax: outline-down
2012 * \li Origin: Vermeer, 23 Mar 2006
2015 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
2017 * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
2018 * \li Action: Moves the current group in the downward direction in the
2019 hierarchy of the document structure.
2020 * \li Notion: Part -> Chapter -> Section -> etc.
2021 * \li Syntax: outline-in
2022 * \li Origin: Vermeer, 23 Mar 2006
2025 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
2027 * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
2028 * \li Action: Moves the current group in the upward direction in the
2029 hierarchy of the document structure.
2030 * \li Notion: Part <- Chapter <- Section <- etc.
2031 * \li Syntax: outline-out
2032 * \li Origin: Vermeer, 23 Mar 2006
2035 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
2038 * \var lyx::FuncCode lyx::LFUN_INSET_EDIT
2039 * \li Action: Edit the inset at cursor with an external application,
2040 if one is attributed.
2041 * \li Syntax: inset-edit [<INSET_PARAMS>]
2042 * \li Params: <INSET_PARAMS>: Parameters for the inset. \n
2043 Currently only the filename will be considered.
2044 * \li Origin: JSpitzm, 27 Apr 2006
2047 { LFUN_INSET_EDIT, "inset-edit", ReadOnly, Edit },
2050 * \var lyx::FuncCode lyx::LFUN_TABULAR_INSERT
2051 * \li Action: Inserts table into the document.
2052 * \li Syntax: tabular-insert [<ROWS> <COLUMNS>]
2053 * \li Params: In case no arguments are given show insert dialog.
2054 * \li Origin: Jug, 12 Apr 2000
2057 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
2059 * \var lyx::FuncCode lyx::LFUN_TABULAR_FEATURE
2060 * \li Action: Sets various features to the table/cell on the current cursor position.
2061 * \li Notion: Various math-environment features are handled here as well, e.g.
2062 add-vline-left/right for the Grid/Array environment
2063 * \li Syntax: tabular-feature <FEATURE> [<ARG>]
2064 * \li Params: <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|copy-column|
2065 toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
2066 align-left|align-right|align-center|align-block|valign-top|valign-bottom|
2067 valign-middle|longtabular-align-left|longtabular-align-center|
2068 longtabular-align-right|m-align-left|m-align-right|m-align-center|
2069 m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|set-all-lines|
2070 unset-all-lines|set-longtabular|unset-longtabular|set-pwidth|set-mpwidth|
2071 set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|
2072 set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|
2073 unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|
2074 set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
2075 set-special-column|set-special-multicolumn|set-special-multirow|
2076 set-booktabs|unset-booktabs|set-top-space|set-bottom-space|
2077 set-interline-space|set-border-lines|tabular-valign-top|
2078 tabular-valign-middle|tabular-valign-bottom \n
2079 <ARG>: additional argument for some commands, use debug mode to explore its values.
2080 * \li Origin: Jug, 28 Jul 2000
2083 { LFUN_TABULAR_FEATURE, "tabular-feature", Noop, Edit },
2085 * \var lyx::FuncCode lyx::LFUN_CELL_BACKWARD
2086 * \li Action: Moves the cursor to the previous cell inside the table.
2087 * \li Syntax: cell-backward
2088 * \li Origin: Jug, 22 May 2000
2091 { LFUN_CELL_BACKWARD, "cell-backward", Noop, Edit },
2093 * \var lyx::FuncCode lyx::LFUN_CELL_FORWARD
2094 * \li Action: Moves the cursor to the next cell inside the table.
2095 * \li Syntax: cell-forward
2098 { LFUN_CELL_FORWARD, "cell-forward", Noop, Edit },
2100 * \var lyx::FuncCode lyx::LFUN_CELL_SPLIT
2101 * \li Action: Splits cell and shifts right part to the next cell (inside the math grid).
2102 * \li Syntax: cell-split
2103 * \li Origin: Ale, 15 May 1997
2106 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
2109 * \var lyx::FuncCode lyx::LFUN_VC_REGISTER
2110 * \li Action: Register the document as an file inside version control system (RCS, CVS).
2111 * \li Notion: File is registered inside cvs, svn or rcs repository acording to the existence
2112 of cvs/svn/rcs entries in the document's directory. \n
2113 See LyX Additional Features Manual (Version Control Chapter) for additional
2115 * \li Syntax: vc-register
2116 * \li Origin: Lgb, 1 Jul 1997
2119 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
2121 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_IN
2122 * \li Action: Checks-in/commits the changes of the registered file to the repository.
2123 * \li Notion: In RCS case this also unlocks the file.
2124 * \li Syntax: vc-check-in
2125 * \li Origin: Lgb, 1 Jul 1997
2128 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
2130 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_OUT
2131 * \li Action: Checks-out the document for edit (and locks it for RCS).
2132 * \li Notion: This is implemented only for RCS and SVN, not CVS.
2133 * \li Syntax: vc-check-out
2134 * \li Origin: Lgb, 1 Jul 1997
2137 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
2139 * \var lyx::FuncCode lyx::LFUN_VC_REVERT
2140 * \li Action: Reverts the document to the last check-in/commit in VCS.
2141 * \li Syntax: vc-revert
2142 * \li Origin: Lgb, 1 Jul 1997
2145 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
2147 * \var lyx::FuncCode lyx::LFUN_VC_UNDO_LAST
2148 * \li Action: Undo last check-in.
2149 * \li Notion: This is currently implemented only for RCS.
2150 * \li Syntax: vc-check-out
2151 * \li Origin: Lgb, 1 Jul 1997
2154 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
2156 * \var lyx::FuncCode lyx::LFUN_VC_COMMAND
2157 * \li Action: Executes external command. This command is intended to support
2158 additional VCS commands.
2159 * \li Syntax: vc-command <FLAG> <PATH> <COMMAND>
2160 * \li Params: <FLAG>: Flags for the command can be combined together.\n
2161 U - dUmmy - no flags \n
2162 D - Doc - need document loaded to proceed \n
2163 I - dIrty - mark document dirty \n
2164 R - Reload - ensure that the document is saved and reload it after command execution \n
2165 M - Message - ask for input string (commit message)\n
2166 <PATH>: path where to start. $$p will be replaced by the current document path.\n
2167 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current
2168 document(with absolute path)/path/message.
2169 * \li Sample: vc-command DR $$p "svn up"
2170 * \li Origin: sanda, 13 Jan 2009
2173 { LFUN_VC_COMMAND, "vc-command", NoBuffer | ReadOnly, System },
2175 * \var lyx::FuncCode lyx::LFUN_VC_LOCKING_TOGGLE
2176 * \li Action: Toggles the locking property of the edited file.
2177 * \li Notion: This is currently implemented only for SVN.
2178 * \li Syntax: vc-locking-toggle
2179 * \li Origin: sanda, 25 Jun 2009
2182 { LFUN_VC_LOCKING_TOGGLE, "vc-locking-toggle", ReadOnly, System },
2184 * \var lyx::FuncCode lyx::LFUN_VC_REPO_UPDATE
2185 * \li Action: Update the local archive directory in which resides
2186 the current document with the remote repository.
2187 * \li Notion: This is currently implemented only for SVN.
2188 * \li Syntax: vc-repo-update
2189 * \li Origin: sanda, 16 Oct 2009
2192 { LFUN_VC_REPO_UPDATE, "vc-repo-update", ReadOnly, System },
2194 * \var lyx::FuncCode lyx::LFUN_VC_COMPARE
2195 * \li Action: Compares two revisions of the same file under version control.
2196 * \li Notion: This is currently implemented only for SVN.
2197 * \li Syntax: vc-compare <REV1> [<REV2>]
2198 * \li Params: Revision number either points directly to commit in history
2199 or - if negative number -x - it points to last commit - x.
2200 Special case "0" is reserved for the last committed revision.\n
2201 <REV1>: Older file.\n
2202 <REV2>: Newer file. Used only if REV1 > 0.
2203 * \li Sample: Compare current document against last commit\n
2205 * \li Sample: Compare current document against current revision - 5 commits\n
2207 * \li Sample: Compare revisions 120 and 155\n
2209 * \li Origin: sanda, 12 Feb 2010
2212 { LFUN_VC_COMPARE, "vc-compare", ReadOnly, System },
2215 * \var lyx::FuncCode lyx::LFUN_CHANGES_TRACK
2216 * \li Action: Toggles change tracking to on/off.
2217 * \li Syntax: changes-track
2218 * \li Origin: levon, 1 Oct 2002
2221 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
2223 * \var lyx::FuncCode lyx::LFUN_CHANGES_OUTPUT
2224 * \li Action: Toggles showing of change tracking in typesetted output.
2225 * \li Syntax: changes-output
2226 * \li Origin: jspitzm, 21 Jan 2005
2229 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
2231 * \var lyx::FuncCode lyx::LFUN_CHANGE_NEXT
2232 * \li Action: Moves the cursor to the position of the next change
2233 of the change tracking records.
2234 * \li Syntax: change-next
2235 * \li Origin: schmitt, 4 Oct 2006
2238 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
2240 * \var lyx::FuncCode lyx::LFUN_CHANGE_PREVIOUS
2241 * \li Action: Moves the cursor to the position of the previous change
2242 of the change tracking records.
2243 * \li Syntax: change-previous
2244 * \li Origin: vfr, 4 Apr 2009
2247 { LFUN_CHANGE_PREVIOUS, "change-previous", ReadOnly, Edit },
2249 * \var lyx::FuncCode lyx::LFUN_CHANGES_MERGE
2250 * \li Action: Open change tracking dialog for merging and moves the cursor
2251 to the position of the next change.
2252 * \li Syntax: changes-merge
2253 * \li Origin: Levon, 16 Oct 2002
2256 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
2258 * \var lyx::FuncCode lyx::LFUN_CHANGE_ACCEPT
2259 * \li Action: Accepts tracked change inside the selection.
2260 * \li Syntax: change-accept
2261 * \li Origin: Levon, 16 Oct 2002
2264 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
2266 * \var lyx::FuncCode lyx::LFUN_CHANGE_REJECT
2267 * \li Action: Rejects tracked change inside the selection.
2268 * \li Syntax: change-accept
2269 * \li Origin: Levon, 16 Oct 2002
2272 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
2274 * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_ACCEPT
2275 * \li Action: Accepts all tracked changes in the document.
2276 * \li Syntax: all-changes-accept
2277 * \li Origin: Levon, 16 Oct 2002
2280 { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
2282 * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_REJECT
2283 * \li Action: Rejects all tracked changes in the document.
2284 * \li Notion: Reject does not work recursively; the user may have to repeat the operation.
2285 * \li Syntax: all-changes-reject
2286 * \li Origin: Levon, 16 Oct 2002
2289 { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
2292 * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
2293 * \li Action: Apply data for an inset.
2294 * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
2295 be applied. This is either changed to #LFUN_INSET_MODIFY or
2296 #LFUN_INSET_INSERT depending on the context where it is called.
2297 * \li Syntax: inset-apply <ARGS>
2298 * \li Params: See #LFUN_INSET_INSERT .
2301 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
2303 * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE
2304 * \li Action: Dissolve the current inset into text.
2305 * \li Syntax: inset-dissolve [<INSET>]
2306 * \li Params: <INSET>: this can be used to make sure the right kind of inset
2307 is dissolved. For example "dissolve" entry in the charstyles
2308 sub-menu should only dissolve the charstyle inset, even if the
2309 cursor is inside several nested insets of different type.\n
2310 For values see #lyx::InsetLayout::lyxtype_ .
2311 * \li Origin: JSpitz, 7 Aug 2006
2314 { LFUN_INSET_DISSOLVE, "inset-dissolve", AtPoint, Edit },
2316 * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
2317 * \li Action: Insert new inset (type given by the parameters).
2318 * \li Syntax: inset-insert <INSET> <ARGS>
2319 * \li Params: <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics|
2320 hyperlink|include|index|label|nomencl|vspace|ref|toc>\n
2321 <ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
2322 * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
2323 where <label name> is the name of the referenced label and
2324 <Format> is one of the following: \n
2325 ref -- <reference> \n
2326 eqref -- (<reference>) \n
2327 pageref -- <page> \n
2328 vpageref -- on <page> \n
2329 vref -- <reference> on <page> \n
2330 prettyref -- Formatted reference
2333 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
2335 * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
2336 * \li Action: Modify some properties of an inset.
2337 * \li Notion: Used for bibitem, bibtex, box, branch, command, ert, external,
2338 floats, graphics, include, index, info, label,
2339 listings, newline, newpage, nomencl, note, phantom,
2340 ref, space, tabular, vspace, wrap insets.
2341 * \li Syntax: inset-modify <INSET> <ARGS>
2342 * \li Syntax: inset-modify changetype <TYPE>
2343 * \li Sample: inset-modify note Note Comment
2344 * \li Sample: inset-modify changetype Ovalbox
2345 * \li Params: See #LFUN_INSET_INSERT for further details.
2348 { LFUN_INSET_MODIFY, "inset-modify", AtPoint, Edit },
2350 * \var lyx::FuncCode lyx::LFUN_INSET_DIALOG_UPDATE
2351 * \li Action: Updates the values inside the dialog from the inset.
2352 * \li Notion: This is internal LFUN, not to be used by users. Called internally
2353 by #LFUN_DIALOG_UPDATE
2354 * \li Params: <DIALOG-NAME>
2355 * \li Origin: leeming, 25 Feb 2003
2358 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
2360 * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
2361 * \li Action: Open the inset's properties dialog.
2362 * \li Notion: Used for bibitem, bibtex, box, branch, citation, ert, external,
2363 float, graphics, href, include, index, index_print, label, listings,
2364 note, phantom, ref, space, tabular, vspace, wrap insets.
2365 * \li Syntax: inset-settings <INSET>
2366 * \li Params: <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|
2367 graphics|href|include|index|index_print|label|listings|
2368 note|phantom|ref|space|tabular|vspace|wrap>.
2371 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly | AtPoint, Edit },
2373 * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
2374 * \li Action: Toggles the collapsable inset at cursor position,
2375 or the inset we are currently in.
2376 * \li Syntax: inset-toggle [<ARG>]
2377 * \li Params: <ARG>: <open|close|toggle|assign>. \n
2378 open/close/toggle are for collapsable insets. toggle is used when no argument is given.\n
2379 assign synchronize the branch-inset with activation status of the branch.
2380 Used for global toggling when changed activation.
2381 * \li Origin: lasgouttes, 19 Jul 2001
2384 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly | AtPoint, Edit },
2386 * \var lyx::FuncCode lyx::LFUN_ALL_INSETS_TOGGLE
2387 * \li Action: Toggles (open/closes) all collapsable insets (of a given type) in the document.
2388 * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
2389 * \li Syntax: all-insets-toggle [<STATE>] [<INSET>]
2390 * \li Params: <STATE>: <toggle|open|close|assign> default: toggle \n
2391 <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all insets
2392 * \li Origin: leeming, 30 Mar 2004
2395 { LFUN_ALL_INSETS_TOGGLE, "all-insets-toggle", ReadOnly, Edit },
2397 * \var lyx::FuncCode lyx::LFUN_INSET_FORALL
2398 * \li Action: Apply the given commands on insets of a given name.
2399 * \li Notion: WARNING: use at your own risks; this function gives
2400 you too many ways of shooting yourself in the foot.
2401 A typical example is
2402 inset-forall Note note-insert
2403 which starts an infinite loop. This is mitigated by the fact
2404 that the number of actions is arbitrarily limited to 10000.
2405 * \li Syntax: inset-forall <NAME> <LFUN-COMMAND> \n
2406 <NAME>: Type of Inset. If <NAME> is *, all insets are matched.
2407 The name is used like for InsetLayout in layout files: "Note"
2408 matches all note insets, while "Note:Note" only matches LyX
2410 * \li Sample: Remove all index insets: \n
2411 inset-forall Index delete-char-forward \n
2412 Close all Notes (also works for a particular branch, for example): \n
2413 inset-forall Note inset-toggle close \n
2414 Transform all yellow notes to comments \n
2415 inset-forall Note:Note inset-modify note Note Comment \n
2416 Try to put LyX in an infinite loop if there is at least a Note: \n
2417 inset-forall Note char-backward
2418 * \li Origin: lasgouttes, 27 Nov 2009
2421 { LFUN_INSET_FORALL, "inset-forall", ReadOnly, Edit },
2424 * \var lyx::FuncCode lyx::LFUN_GRAPHICS_RELOAD
2425 * \li Action: Reloads the image if necessary.
2426 * \li Syntax: graphics-reload
2427 * \li Origin: vfr, 10 Aug 2009
2430 { LFUN_GRAPHICS_RELOAD, "graphics-reload", ReadOnly | AtPoint, Edit },
2432 * \var lyx::FuncCode lyx::LFUN_SET_GRAPHICS_GROUP
2433 * \li Action: Set the group for the graphics inset on the cursor position.
2434 * \li Syntax: set-graphics-group [<GROUP>]
2435 * \li Params: <GROUP>: Id for an existing group. In case the Id is an empty string,
2436 the graphics inset is removed from the current group.
2437 * \li Origin: sanda, 6 May 2008
2440 { LFUN_SET_GRAPHICS_GROUP, "set-graphics-group", Noop, Edit },
2443 * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
2444 * \li Action: Moves the cursor out of the current slice, going forward.
2445 * \li Notion: Cursor movement within an inset may be different than cursor
2446 movement in the surrounding text. This action should be called
2447 automatically by the cursor movement within the inset, when
2448 movement within the inset has ceased (reached the end of the
2449 last paragraph, for example), in order to move correctly
2450 back into the surrounding text.
2453 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
2455 * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
2456 * \li Action: Moves the cursor out of the current slice, going backwards.
2457 * \li Notion: See also #LFUN_FINISHED_FORWARD.
2460 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
2462 * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
2463 * \li Action: Moves the cursor out of the current slice, going right.
2464 * \li Notion: See also #LFUN_FINISHED_FORWARD
2467 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
2469 * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
2470 * \li Action: Moves the cursor out of the current slice, going left.
2471 * \li Notion: See also #LFUN_FINISHED_FORWARD.
2474 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
2477 * \var lyx::FuncCode lyx::LFUN_LANGUAGE
2478 * \li Action: Set language from the current cursor position.
2479 * \li Syntax: language <LANG>
2480 * \li Params: <LANG>: Requested language. Look in lib/languages for
2482 * \li Origin: Dekel, 2 Mar 2000
2485 { LFUN_LANGUAGE, "language", Noop, Edit },
2488 * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
2489 * \li Action: Goto a label.
2490 * \li Syntax: label-goto [<LABEL>]
2491 * \li Params: <LABEL>: Requested label. If no label is given and reference
2492 is on cursor position, Bookmark 0 is saved and
2493 cursor moves to the position of referenced label.
2494 * \li Origin: Ale, 6 Aug 1997
2497 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
2499 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT
2500 * \li Action: Inserts label to text or displayed formula.
2501 * \li Syntax: label-insert [<LABEL>]
2502 * \li Params: <LABEL>: Requested label. If no label is given dialog requesting
2503 name will be opened.
2506 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
2508 * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
2509 * \li Action: Go to the next label or cross-reference.
2510 * \li Syntax: reference-next
2511 * \li Origin: Dekel, 14 Jan 2001
2514 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
2517 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
2518 * \li Action: Moves the cursor to the numbered bookmark, opening the file
2519 if necessary. Note that bookmarsk are saved per-session, not
2521 * \li Notion: Bookmark 0 has a special purpose. It is automatically set \n
2522 1. to the paragraph you are currently editing \n
2523 2. to the paragraph from where you are jumping to the last-edited
2524 position (jump-back feature) \n
2525 3. when jumping from crossreference to the requested label by
2527 * \li Syntax: bookmark-goto <NUMBER>
2528 * \li Params: <NUMBER>: the number of the bookmark to restore.
2529 * \li Origin: Dekel, 27 January 2001
2532 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
2534 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
2535 * \li Action: Save a bookmark.
2536 * \li Notion: Saves a numbered bookmark to the sessions file. The number
2537 must be between 1 and 9, inclusive. Note that bookmarks are
2538 saved per-session, not per file.
2539 * \li Syntax: bookmark-save <NUMBER>
2540 * \li Params: <NUMBER>: the number of the bookmark to save.
2541 * \li Origin: Dekel, 27 January 2001
2544 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
2546 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
2547 * \li Action: Clears the list of saved bookmarks.
2548 * \li Syntax: bookmark-clear
2549 * \li Origin: bpeng, 31 October 2006
2552 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
2555 * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
2556 * \li Action: Open the given help file according to the language setting.
2557 * \li Syntax: help-open <FILE>[.lyx]
2558 * \li Params: <FILE>: any document from (/usr/share/)doc directory.
2559 * \li Origin: Jug, 27 Jun 1999
2562 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
2564 * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
2565 * \li Action: Terminates the current LyX instance.
2566 * \li Notion: Terminates the current LyX instance, asking whether to save
2567 modified documents, etc.
2568 * \li Syntax: lyx-quit
2571 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
2573 * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
2574 * \li Action: Toggles visibility of a given toolbar between on/off/auto.
2575 * \li Notion: Skipping "auto" when allowauto is false.
2576 * \li Syntax: toolbar-toggle <NAME> [allowauto]
2577 * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|
2578 minibuffer|review|view/update|math_panels|vcs
2579 * \li Origin: Edwin, 21 May 2007
2582 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
2584 * \var lyx::FuncCode lyx::LFUN_MENU_OPEN
2585 * \li Action: Opens the menu given by its name.
2586 * \li Syntax: menu-open <NAME>
2587 * \li Params: <NAME>: menu name. See various .inc files in lib/ui for candidates.
2590 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
2592 * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
2593 * \li Action: Various UI visibility-toggling actions.
2594 * \li Syntax: ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
2595 * \li Params: statusbar : Toggle visibility of the statusbar.\n
2596 menubar : Toggle visibility of the menubar.\n
2597 scrollbar : Toggle visibility of the scrollbar.\n
2598 frame : Toggle visibility of the frames around editing window.\n
2599 fullscreen : Toggle fullscreen mode. This also covers calling the
2600 previous functions. However #LFUN_TOOLBAR_TOGGLE for the
2601 custom tweaks of the toolbars should be used.
2602 * \li Origin: sanda, 9 Feb 2007
2605 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
2608 * \var lyx::FuncCode lyx::LFUN_WINDOW_NEW
2609 * \li Action: Creates new empty LyX window.
2610 * \li Notion: Already opened documents from the previous window can be found under View menu.
2611 * \li Syntax: window-new [<GEOMETRY>]
2612 * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently
2613 accepted only on Windows platform.
2614 * \li Origin: Abdel, 21 Oct 2006
2617 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
2619 * \var lyx::FuncCode lyx::LFUN_WINDOW_CLOSE
2620 * \li Action: Closes the current LyX window.
2621 * \li Syntax: window-close
2622 * \li Origin: Abdel, 23 Oct 2006
2625 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
2628 * \var lyx::FuncCode lyx::LFUN_SPLIT_VIEW
2629 * \li Action: Creates another split view of current buffer.
2630 * \li Notion: All split views act in the same way indpendently.
2631 * \li Syntax: split-view <vertical|horizontal>
2632 * \li Params: horizontal : The work areas are laid out side by side.\n
2633 vertical : The work areas laid out vertically.
2634 * \li Origin: Abdel, 20 Feb 2008
2637 { LFUN_SPLIT_VIEW, "split-view", ReadOnly, Buffer },
2640 * \var lyx::FuncCode lyx::LFUN_CLOSE_TAB_GROUP
2641 * \li Action: Close the current tab group.
2642 * \li Notion: This only closes the work areas, not the buffer themselves.
2643 The still opened buffers can be visualized in another tab group.
2644 * \li Syntax: close-tab-group
2645 * \li Origin: Abdel, 21 Feb 2008
2648 { LFUN_CLOSE_TAB_GROUP, "close-tab-group", ReadOnly, Buffer },
2650 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW
2651 * \li Action: Shows hidden dialog or create new one for a given function/inset settings etc.
2652 * \li Syntax: dialog-show <NAME> [<DATA>]
2653 * \li Params: <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|\n
2654 compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|\n
2655 graphics|href|include|index|index_print|info|label|listings|log|mathdelimiter|\n
2656 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|\n
2657 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|\n
2658 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL> \n
2659 <SPECIAL>: latexlog|vclog \n
2660 <DATA>: data, usually settings for the given dialog. Use debug mode for the
2662 * \li Origin: leeming, 17 Jun 2003
2665 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
2667 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW_NEW_INSET
2668 * \li Action: Shows hidden dialog or create new one for a given inset settings etc.
2669 * \li Notion: Internally uses #LFUN_DIALOG_SHOW with processed data for a given inset.
2670 * \li Syntax: dialog-show-new-inset <NAME> [<DATA>]
2671 * \li Params: See #LFUN_DIALOG_SHOW .
2672 * \li Origin: leeming, 25 Feb 2003
2675 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
2677 * \var lyx::FuncCode lyx::LFUN_DIALOG_UPDATE
2678 * \li Action: Updates the dialog values from the inset/paragraph/document.
2679 * \li Syntax: dialog-update <NAME>
2680 * \li Params: <NAME>: paragraph|prefs|<INSET> \n
2682 * \li Origin: leeming, 25 Feb 2003
2685 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
2687 * \var lyx::FuncCode lyx::LFUN_DIALOG_HIDE
2688 * \li Action: Hides showed dialog. Counterpart to #LFUN_DIALOG_SHOW .
2689 * \li Syntax: dialog-hide <NAME>
2690 * \li Params: See #LFUN_DIALOG_SHOW .
2691 * \li Origin: leeming, 25 Feb 2003
2694 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
2696 * \var lyx::FuncCode lyx::LFUN_DIALOG_TOGGLE
2697 * \li Action: Toggles dialog between showed/hidden state.
2698 * \li Notion: Internally uses #LFUN_DIALOG_SHOW , #LFUN_DIALOG_HIDE .
2699 * \li Syntax: dialog-toggle <NAME> [<DATA>]
2700 * \li Params: See #LFUN_DIALOG_SHOW .
2701 * \li Origin: JSpitzm, 30 Apr 2007
2704 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
2706 * \var lyx::FuncCode lyx::LFUN_DIALOG_DISCONNECT_INSET
2707 * \li Action: Closes opened connection to opened inset.
2708 * \li Notion: Connection is used for apply functions.
2709 * \li Syntax: dialog-disconnect-inset <INSET-NAME>
2710 * \li Origin: leeming, 25 Feb 2003
2713 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
2716 * \var lyx::FuncCode lyx::LFUN_MOUSE_PRESS
2717 * \li Action: This function is called when mouse button is pressed (inside workarea).
2718 Action depends on the context.
2719 * \li Notion: This is internal LFUN, not to be used by users.
2720 * \li Origin: Andre, 9 Aug 2002
2723 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
2725 * \var lyx::FuncCode lyx::LFUN_MOUSE_DOUBLE
2726 * \li Action: This function is called when double click on mouse button is
2727 pressed (inside workarea). Action depends on the context.
2728 * \li Notion: This is internal LFUN, not to be used by users.
2729 * \li Origin: Andre, 9 Aug 2002
2732 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
2734 * \var lyx::FuncCode lyx::LFUN_MOUSE_TRIPLE
2735 * \li Action: This function is called when triple click on mouse button is
2736 pressed (inside workarea). Action depends on the context.
2737 * \li Notion: This is internal LFUN, not to be used by users.
2738 * \li Origin: Andre, 9 Aug 2002
2741 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
2743 * \var lyx::FuncCode lyx::LFUN_MOUSE_MOTION
2744 * \li Action: This function is called when mouse cursor is moving over the text.
2745 Action depends on the context.
2746 * \li Notion: This is internal LFUN, not to be used by users.
2747 * \li Origin: Andre, 9 Aug 2002
2750 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
2752 * \var lyx::FuncCode lyx::LFUN_MOUSE_RELEASE
2753 * \li Action: This function is called when mouse button is released (inside workarea).
2754 Action depends on the context.
2755 * \li Notion: This is internal LFUN, not to be used by users.
2756 * \li Origin: Andre, 9 Aug 2002
2759 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
2762 * \var lyx::FuncCode lyx::LFUN_KEYMAP_OFF
2763 * \li Action: Turn off the loaded keyboard map.
2764 * \li Syntax: keymap-off
2767 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
2769 * \var lyx::FuncCode lyx::LFUN_KEYMAP_PRIMARY
2770 * \li Action: Turn on the primary keyboard map.
2771 * \li Notion: Maps were widely used in past, when X-windows didn't have nowadays
2772 keyboard support. They can be still used to maintain uniform keyboard
2773 layout across the various plaforms.\n
2774 The language is to be set in the Preferences dialog.
2775 * \li Syntax: keymap-primary
2778 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
2780 * \var lyx::FuncCode lyx::LFUN_KEYMAP_SECONDARY
2781 * \li Action: Turn on the secondary keyboard map.
2782 * \li Syntax: keymap-secondary
2785 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
2787 * \var lyx::FuncCode lyx::LFUN_KEYMAP_TOGGLE
2788 * \li Action: Toggles keyboard maps (first/second/off).
2789 * \li Syntax: keymap-toggle
2790 * \li Origin: leeming, 30 Mar 2004
2793 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
2796 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_LAYOUT
2797 * \li Action: Returns the current layout (that is environment) name
2798 on the cursor position.
2799 * \li Syntax: server-get-layout
2802 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
2804 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_FILENAME
2805 * \li Action: Returns path and file name of the currently edited document.
2806 * \li Syntax: server-get-filename
2809 { LFUN_SERVER_GET_FILENAME, "server-get-filename", ReadOnly, System },
2811 * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
2812 * \li Action: Sets the cursor position based on the row number of generated TeX file.
2813 * \li Notion: This can be useful for DVI inverse-search or detection of the problematic
2814 line from LaTeX compilation. Note that before this function can be used
2815 export to LaTeX output must occur (in order to map the row numbers).
2816 * \li Syntax: server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
2817 * \li Params: <FILE>: the filename. Environment variables are expanded in the path.
2818 In case this LFUN does not work make sure you are giving correct
2820 If the file is located inside LyX temporary directory it will be
2821 mapped back into the appropriate opened buffer (e.g. for the case
2822 of generated .tex file).
2823 .ext: extensions will be automatically replaced by .lyx.
2824 <ROW_NUMBER> The row number of the LaTeX file to which to go.
2825 * \li Origin: Edmar, 23 Dec 1998
2828 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly | NoBuffer, System },
2830 * \var lyx::FuncCode lyx::LFUN_SERVER_NOTIFY
2831 * \li Action: Sends notify message about the last key-sequence to client.
2832 * \li Notion: This can be used to grab last key-sequence used inside the LyX window.
2833 See also Debug extensions section in Additional features manual.
2834 * \li Syntax: server-notify
2837 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
2839 * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
2840 * \li Action: Sets the cursor position based on the editing area coordinates
2841 (similar as clicking on that point with left mouse button).
2842 * \li Syntax: server-set-xy <X> <Y>
2845 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
2847 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
2848 * \li Action: Returns the coordinates of cursor position in the editing area.
2849 * \li Syntax: server-get-xy
2852 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
2855 * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
2856 * \li Action: Generates the code (literate programming).
2857 * \li Notion: Latex file with extension \literate_extension is generated.
2858 Then LyX invokes \build_command (with a default of``make'') to generate the code and
2859 \build_error_filter to process the compilation error messages. \n
2860 In case you want to process your literate file with a script, or some other program,
2861 just insert in your lyxrc file an entry with:\n
2862 \build_command "my_script my_arguments" \n
2863 The \build_error_filter differs from the \literate_error_filter only in that the
2864 former will identify error messages from your compiler.
2865 * \li Syntax: build-program
2868 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
2871 * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
2872 * \li Action: Saves the current buffer to a temporary file.
2873 * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
2874 is called automatically by LyX, to "autosave" the current buffer.
2875 * \li Syntax: buffer-auto-save
2878 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
2880 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHILD_OPEN
2881 * \li Action: Loads the given child document.
2882 * \li Notion: The current document is treated as a parent.
2883 * \li Syntax: buffer-child-open <FILE>
2884 * \li Params: <FILE>: Filename of the child. The directory of the parent is assumed by default.
2885 * \li Origin: Ale, 28 May 1997
2888 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
2890 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHKTEX
2891 * \li Action: Runs chktex for the current document.
2892 * \li Syntax: buffer-chktex
2893 * \li Origin: Asger, 30 Oct 1997
2896 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
2898 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
2899 * \li Action: Toggles compression of the current document on/off.
2900 * \li Syntax: buffer-toggle-compression
2901 * \li Origin: bpeng, 27 Apr 2006
2904 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
2906 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
2907 * \li Action: Closes the current buffer.
2908 * \li Notion: Closes the current buffer, asking whether to save it, etc,
2909 if the buffer has been modified.
2910 * \li Syntax: buffer-close
2913 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
2915 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE_ALL
2916 * \li Action: Closes all buffers.
2917 * \li Notion: Closes all buffers, asking whether to save it, etc,
2918 if a buffer has been modified.
2919 * \li Syntax: buffer-close-all
2922 { LFUN_BUFFER_CLOSE_ALL, "buffer-close-all", ReadOnly, Buffer },
2924 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
2925 * \li Action: Exports the current buffer (document) to the given format.
2926 * \li Syntax: buffer-export <FORMAT>
2927 * \li Params: <FORMAT> is either "custom" or one of the formats which you
2928 can find in Tools->Preferences->File formats->Format.
2929 Usual format you will enter is "pdf2" (pdflatex),
2930 "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
2931 In case of "custom" you will be asked for a format you
2932 want to start from and for the command that you want to
2933 apply to this format. Internally the control is then passed
2934 to #LFUN_BUFFER_EXPORT_CUSTOM.
2935 * \li Origin: Lgb, 29 Jul 1997
2938 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
2940 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
2941 * \li Action: Exports the current buffer (document) from the given format using
2942 the given command on it.
2943 * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
2944 * \li Params: <FORMAT> format to start from (LyX will care to produce such
2945 intermediate file).\n
2946 <COMMAND> this command will be launched on the file. Note that you can
2947 use "$$FName" string to qualify the intermediate file.
2948 * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
2949 * \li Origin: leeming, 27 Mar 2004
2952 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
2954 * \var lyx::FuncCode lyx::LFUN_BUFFER_PRINT
2955 * \li Action: Prints the current document.
2956 * \li Notion: Many settings can be given via the preferences dialog.
2957 * \li Syntax: buffer-print <TARGET> <TARGET-NAME> <COMMAND>
2958 * \li Params: <TARGET> is either "printer" or "file".\n
2959 <TARGER-NAME> is either "default" or file name or printer name.\n
2960 <COMMAND> command ensuring the printing job.
2961 * \li Sample: buffer-print file "/trash/newfile1.ps" "dvips"
2962 * \li Origin: leeming, 28 Mar 2004
2965 { LFUN_BUFFER_PRINT, "buffer-print", ReadOnly, Buffer },
2967 * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
2968 * \li Action: Import a given file as a lyx document.
2969 * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
2970 defined convertors in preferences. Look into File->Import menu to get
2971 an idea of the currently active import formats.
2972 * \li Syntax: buffer-import <FORMAT> [<FILE>]
2973 * \li Origin: Asger, 24 Jul 1998
2976 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
2978 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
2979 * \li Action: Creates a new buffer (that is, document).
2980 * \li Notion: Implicit path can be set in Preferences dialog.
2981 * \li Syntax: buffer-new [<FILE>]
2982 * \li Params: <FILE>: filename of created file with absolute path.
2985 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
2987 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
2988 * \li Action: Creates a new buffer (that is, document) from a template.
2989 * \li Notion: Path for new files and templates can be set in Preferences dialog.
2990 Template will be asked for via Open-dialog.
2991 * \li Syntax: buffer-new-template [<FILE>]
2992 * \li Params: <FILE>: filename of created file with absolute path.
2995 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
2997 * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
2998 * \li Action: Reverts opened document.
2999 * \li Syntax: buffer-reload
3000 * \li Origin: Asger, 2 Feb 1997
3003 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
3005 * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
3006 * \li Action: Display/switch to the given buffer.
3007 * \li Syntax: buffer-switch <BUFFER>
3008 * \li Params: <BUFFER>: path and filename of already opened (but possibly hidden)
3009 document which is to be shown.
3012 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
3014 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
3015 * \li Action: Toggle editing mode of the current document between read/write and read-only.
3016 * \li Notion: This function is not allowed if the file is under version control, since
3017 read-only flag is often used in version control file locking.
3018 * \li Syntax: buffer-toggle-read-only
3019 * \li Origin: Lgb, 27 May 1997
3022 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
3024 * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
3025 * \li Action: Displays current buffer in chosen format.
3026 * \li Notion: Displays the contents of the current buffer in the chosen
3027 format, for example, PDF or DVI. This runs the necessary
3028 converter, calls the defined viewer, and so forth.
3029 * \li Syntax: buffer-view [<FORMAT>]
3030 * \li Params: <FORMAT>: The format to display, where this is one of the
3031 formats defined (in the current GUI) in the
3032 Tools>Preferences>File Formats dialog.
3033 If no format is given, the default format as
3034 specified in the same dialog is used.
3037 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
3039 * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
3040 * \li Action: Exports the current document and put the result into the
3041 temporary directory.
3042 * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
3043 the output will be rewriten - updated. This is useful in case your viewer
3044 is able to detect such changes (e.g. ghostview for postscript).
3045 * \li Syntax: buffer-update [<FORMAT>]
3046 * \li Params: <FORMAT>: The format to display, where this is one of the
3047 formats defined (in the current GUI) in the
3048 Tools>Preferences>File Formats dialog.
3049 If no format is given, the default format as
3050 specified in the same dialog is used.
3051 * \li Origin: Dekel, 5 Aug 2000
3054 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
3057 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
3058 * \li Action: Saves the current buffer.
3059 * \li Notion: Saves the current buffer to disk, using the filename that
3060 is already associated with the buffer, asking for one if
3061 none is yet assigned.
3062 * \li Syntax: buffer-write
3065 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
3067 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
3068 * \li Action: Rename and save current buffer.
3069 * \li Syntax: buffer-write-as <FILENAME>
3070 * \li Params: <FILENAME>: New name of the buffer/file. A relative path
3071 is with respect to the original location of the buffer/file.
3074 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
3076 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
3077 * \li Action: Save all changed documents.
3078 * \li Syntax: buffer-write-all
3079 * \li Origin: rgh, gpothier 6 Aug 2007
3082 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
3084 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEXT
3085 * \li Action: Switch to the next opened document.
3086 * \li Notion: Note that this does not necessarily mean next in tabbar
3087 (for full list see View menu).
3088 * \li Syntax: buffer-next
3091 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
3093 * \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS
3094 * \li Action: Switch to the previous opened document.
3095 * \li Syntax: buffer-previous
3098 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
3100 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
3101 * \li Action: When run from a child document, this updates (exports) document built
3102 from the master buffer, if available.
3103 * \li Syntax: master-buffer-update [<FORMAT>]
3104 * \li Params: <FORMAT>: The format to display, where this is one of the
3105 formats defined (in the current GUI) in the
3106 Tools>Preferences>File Formats dialog.
3107 If no format is given, the default format as
3108 specified in the same dialog is used.
3109 * \li Origin: Tommaso, 20 Sep 2007
3112 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
3114 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
3115 * \li Action: When run from a child document, this command shows a preview built
3116 from the master buffer, if available.
3117 * \li Syntax: master-buffer-view [<FORMAT>]
3118 * \li Params: <FORMAT>: The format to display, where this is one of the
3119 formats defined (in the current GUI) in the
3120 Tools>Preferences>File Formats dialog.
3121 If no format is given, the default format as
3122 specified in the same dialog is used.
3123 * \li Origin: Tommaso, 20 Sep 2007
3126 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
3128 * \var lyx::FuncCode lyx::LFUN_BUFFER_LANGUAGE
3129 * \li Action: Set language of the current document.
3130 * \li Syntax: buffer-language <LANG>
3131 * \li Params: <LANG>: language name. See lib/languages for list.
3132 * \li Origin: leeming, 30 Mar 2004
3135 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
3137 * \var lyx::FuncCode lyx::LFUN_BUFFER_SAVE_AS_DEFAULT
3138 * \li Action: Save the current document settings as default.
3139 * \li Notion: The file will will be saved into ~/.lyx/templates/defaults.lyx .
3140 * \li Syntax: buffer-save-as-default [<ARGS>]
3141 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
3142 you can find in document header of usual .lyx file.
3143 * \li Origin: leeming, 30 Mar 2004
3146 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
3148 * \var lyx::FuncCode lyx::LFUN_BUFFER_PARAMS_APPLY
3149 * \li Action: Apply the given settings to the current document.
3150 * \li Syntax: buffer-params-apply [<ARGS>]
3151 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
3152 you can find in document header of usual .lyx file.
3153 * \li Origin: leeming, 30 Mar 2004
3156 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", NoInternal, Buffer },
3159 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
3160 * \li Action: Inserts another LyX file.
3161 * \li Syntax: file-insert [<FILE>]
3162 * \li Params: <FILE>: Filename to be inserted.
3165 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
3167 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
3168 * \li Action: Inserts plain text file.
3169 * \li Syntax: file-insert-plaintext [<FILE>]
3170 * \li Params: <FILE>: Filename to be inserted.
3171 * \li Origin: CFO-G, 19 Nov 1997
3174 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
3176 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
3177 * \li Action: Inserts plain text file as paragraph (i.e. join lines).
3178 * \li Syntax: file-insert-plaintext-para [<FILE>]
3179 * \li Params: <FILE>: Filename to be inserted.
3180 * \li Origin: Levon, 14 Feb 2001
3183 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
3185 * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
3186 * \li Action: Open LyX document.
3187 * \li Syntax: file-open [<FILE>]
3188 * \li Params: <FILE>: Filename to be opened.
3191 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
3194 * \var lyx::FuncCode lyx::LFUN_CALL
3195 * \li Action: Executes a command defined in a .def file.
3196 * \li Notion: The definitions are by default read from lib/commands/default.def.\n
3197 A .def file allows to define a command with \define "<NAME>" "<LFUN>"
3198 where <NAME> is the name of the new command and <LFUN> is the lfun code
3199 to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
3200 \def_file "FileName" allows to include another .def file. \n
3201 This is particularly useful in connection with toolbar buttons:
3202 Since the name of the button image for this lfun is
3203 lib/images/commands/<NAME>.png this is the way to assign an image
3204 to a complex command-sequence.
3205 * \li Syntax: call <NAME>
3206 * \li Params: <NAME>: Name of the command that must be called.
3207 * \li Origin: broider, 2 Oct 2007
3210 { LFUN_CALL, "call", NoBuffer, System },
3212 * \var lyx::FuncCode lyx::LFUN_META_PREFIX
3213 * \li Action: Simulate halting Meta key (Alt key on PCs).
3214 * \li Notion: Used for buffer editation not for GUI control.
3215 * \li Syntax: meta-prefix
3218 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
3220 * \var lyx::FuncCode lyx::LFUN_CANCEL
3221 * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
3222 * \li Syntax: cancel
3225 { LFUN_CANCEL, "cancel", NoBuffer, System },
3228 * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
3229 * \li Action: Switches the focus to the minibuffer so that the user can type
3230 in there. If necessary, it opens the minibuffer toolbar.
3231 * \li Notion: Usually bound to M-x shortcut.
3232 * \li Syntax: command-execute
3235 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
3238 * \var lyx::FuncCode lyx::LFUN_COMMAND_PREFIX
3239 * \li Action: Return the current key sequence and available options as a string.
3240 * \li Notion: No options are added if no current map exists. \n
3241 This is probably usable only with connection to lyxserver.
3242 * \li Syntax: command-prefix
3245 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
3247 * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
3248 * \li Action: Run more commands (LFUN and its parameters) in a sequence.
3249 * \li Syntax: command-sequence <CMDS>
3250 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
3251 * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
3252 * \li Origin: Andre, 11 Nov 1999
3255 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
3257 * \var lyx::FuncCode lyx::LFUN_COMMAND_ALTERNATIVES
3258 * \li Action: Runs the first listed command that is enabled.
3259 * \li Notion: This can be used to bind multiple functions to a single key,
3260 and then which one is used will depend upon the context.
3261 * \li Syntax: command-alternatives <CMDS>
3262 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
3263 * \li Sample: command-alternatives completion-accept;cell-forward
3264 * \li Origin: rgh, 24 September 2008
3267 { LFUN_COMMAND_ALTERNATIVES, "command-alternatives", NoBuffer, System },
3269 * \var lyx::FuncCode lyx::LFUN_MESSAGE
3270 * \li Action: Shows message in statusbar (for script purposes).
3271 * \li Syntax: message <STRING>
3272 * \li Origin: Lgb, 8 Apr 2001
3275 { LFUN_MESSAGE, "message", NoBuffer, System },
3277 * \var lyx::FuncCode lyx::LFUN_DEBUG_LEVEL_SET
3278 * \li Action: Set debug output level.
3279 * \li Syntax: debug-level-set <LEVEL>
3280 * \li Params: <LEVEL>: comma separated list of levels or the correspondent number
3281 of their combination. 0 is equivalent to disabling all debug
3282 events. See lyx -dbg for the current list of debug levels
3284 * \li Origin: sanda, 28 Dec 2009
3287 { LFUN_DEBUG_LEVEL_SET, "debug-level-set", NoBuffer, System },
3290 * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
3291 * \li Action: Save user preferences.
3292 * \li Syntax: preferences-save
3293 * \li Origin: Lgb, 27 Nov 1999
3296 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
3298 * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
3299 * \li Action: Reconfigure the automatic settings.
3300 * \li Syntax: reconfigure
3301 * \li Origin: Asger, 14 Feb 1997
3304 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
3306 * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
3307 * \li Action: Apply the given settings to user preferences.
3308 * \li Syntax: lyxrc-apply <SETTINGS>
3309 * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
3310 to get an idea which commands to use and their syntax.
3311 #lyx::LyXRC::LyXRCTags has the list of possible commands.
3314 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
3316 * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
3317 * \li Action: Determine whether keep cursor inside the editing window regardless
3318 the scrollbar movement.
3319 * \li Syntax: toggle-cursor-follows-scrollbar
3320 * \li Origin: ARRae, 2 Dec 1997
3323 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
3325 * \var lyx::FuncCode lyx::LFUN_SET_COLOR
3326 * \li Action: Set the given LyX color to the color defined by the X11 name given.
3327 * \li Notion: A new color entry is created if the color is unknown.
3328 Color names can be stored as a part of user settings.
3329 * \li Syntax: set-color <LYX_NAME> <X11_NAME>
3330 * \li Origin: SLior, 11 Jun 2000
3333 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
3335 * \var lyx::FuncCode lyx::LFUN_STATISTICS
3336 * \li Action: Count the statistics (number of words and characters)
3337 in the document or in the given selection.
3338 * \li Notion: Note that this function gives the number of words/chars written,
3339 not the number of characters which will be typeset.
3340 * \li Syntax: statistics
3341 * \li Origin: lasgouttes, Jan 27 2004; sanda, Jan 8 2008
3344 { LFUN_STATISTICS, "statistics", ReadOnly, System },
3346 * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
3347 * \li Action: Show the inline completion at the cursor position.
3348 * \li Syntax: completion-inline
3349 * \li Origin: sts, Feb 19 2008
3352 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
3354 * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
3355 * \li Action: Show the completion popup at the cursor position.
3356 * \li Syntax: completion-popup
3357 * \li Origin: sts, Feb 19 2008
3360 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
3362 * \var lyx::FuncCode lyx::LFUN_COMPLETION_COMPLETE
3363 * \li Action: Try to complete the word or command at the cursor position.
3364 * \li Syntax: complete
3365 * \li Origin: sts, Feb 19 2008
3368 { LFUN_COMPLETION_COMPLETE, "complete", SingleParUpdate, Edit },
3371 * \var lyx::FuncCode lyx::LFUN_COMPLETION_CANCEL
3372 * \li Action: Try to cancel completion, either the popup or the inline completion.
3373 * \li Syntax: completion-cancel
3374 * \li Origin: sts, Sep 07 2008
3377 { LFUN_COMPLETION_CANCEL, "completion-cancel", SingleParUpdate, Edit },
3379 * \var lyx::FuncCode lyx::LFUN_COMPLETION_ACCEPT
3380 * \li Action: Accept suggested completion.
3381 * \li Syntax: completion-accept
3382 * \li Origin: sanda, Sep 08 2008
3385 { LFUN_COMPLETION_ACCEPT, "completion-accept", SingleParUpdate, Edit },
3389 * \var lyx::FuncCode lyx::LFUN_BRANCH_ADD
3390 * \li Action: Add a branch to the buffer's BranchList.
3391 * \li Syntax: branch-add <BRANCH>
3392 * \li Params: <BRANCH>: Name of the branch to add
3393 * \li Origin: spitz, 7 Jul 2009
3396 { LFUN_BRANCH_ADD, "branch-add", Noop, Buffer },
3400 * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
3401 * \li Action: Activate the branch.
3402 * \li Syntax: branch-activate <BRANCH>
3403 * \li Params: <BRANCH>: The branch to activate
3404 * \li Sample: lyx -x "branch-activate answers" -e pdf2 finalexam.lyx \n
3405 could be used to export a pdf with the answers branch included
3406 without one's having to open LyX and activate the branch manually.
3407 * \li Origin: rgh, 27 May 2008
3410 { LFUN_BRANCH_ACTIVATE, "branch-activate", AtPoint, Buffer },
3412 * \var lyx::FuncCode lyx::LFUN_BRANCH_DEACTIVATE
3413 * \li Action: De-activate the branch.
3414 * \li Syntax: branch-deactivate <BRANCH>
3415 * \li Params: <BRANCH>: The branch to deactivate
3416 * \li Origin: rgh, 27 May 2008
3419 { LFUN_BRANCH_DEACTIVATE, "branch-deactivate", AtPoint, Buffer },
3422 * \var lyx::FuncCode lyx::LFUN_BRANCHES_RENAME
3423 * \li Action: Rename all branches of a given name in a document.
3424 * \li Syntax: branches-rename <OLDNAME> <NEWNAME>
3425 * \li Params: <OLDNAME>: Current name of the branch to be renamed
3426 * <NEWNAME>: New name of the branch
3427 * \li Origin: spitz, 9 Jul 2009
3430 { LFUN_BRANCHES_RENAME, "branches-rename", Noop, Buffer },
3432 * \var lyx::FuncCode lyx::LFUN_BRANCH_ADD_INSERT
3433 * \li Action: Create new branch and directly put the branch inset into
3435 * \li Syntax: branch-add-insert [<NAME>]
3436 * \li Params: <NAME>: Branch name. If it is not specified, you will be asked.
3437 * \li Origin: sanda, 10 Jul 2009
3440 { LFUN_BRANCH_ADD_INSERT, "branch-add-insert", Noop, Buffer },
3444 * \var lyx::FuncCode lyx::LFUN_LABEL_COPY_AS_REF
3445 * \li Action: Copies the label at the cursor as a cross-reference to be pasted elsewhere.
3446 * \li Syntax: copy-label-as-reference <LABEL>
3447 * \li Params: <LABEL>: The label to copy (for multi-line math)
3448 * \li Origin: sts, 16 Nov 2008
3451 { LFUN_LABEL_COPY_AS_REF, "copy-label-as-reference", ReadOnly | NoUpdate, Edit },
3454 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT_AS_REF
3455 * \li Action: Inserts the label as a cross-reference at the position of the cursor.
3456 * \li Syntax: label-insert-as-reference
3457 * \li Origin: vfr, 7 Apr 2009
3460 { LFUN_LABEL_INSERT_AS_REF, "label-insert-as-reference", Noop, Edit},
3463 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_IN
3464 * \li Action: Increases the zoom of the screen fonts.
3465 * \li Syntax: buffer-zoom-in [<ZOOM>]
3466 * \li Params: <ZOOM>: The zoom in %, the default is 20.
3467 * \li Origin: vfr, 30 Mar 2009
3470 { LFUN_BUFFER_ZOOM_IN, "buffer-zoom-in", ReadOnly, Buffer },
3473 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_OUT
3474 * \li Action: Decreases the zoom of the screen fonts.
3475 * \li Syntax: buffer-zoom-out [<ZOOM>]
3476 * \li Params: <ZOOM>: The zoom in %, the default is 20.
3477 * \li Origin: vfr, 30 Mar 2009
3480 { LFUN_BUFFER_ZOOM_OUT, "buffer-zoom-out", ReadOnly, Buffer },
3484 { LFUN_NOACTION, "", Noop, Hidden }
3485 #ifndef DOXYGEN_SHOULD_SKIP_THIS
3488 for (int i = 0; items[i].action != LFUN_NOACTION; ++i)
3489 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
3495 LyXAction::LyXAction()
3501 FuncRequest LyXAction::lookupFunc(string const & func) const
3503 string const func2 = trim(func);
3506 return FuncRequest(LFUN_NOACTION);
3509 string const arg = split(func2, cmd, ' ');
3511 FuncMap::const_iterator const fit = lyx_func_map.find(cmd);
3513 return fit != lyx_func_map.end()
3514 ? FuncRequest(fit->second, arg)
3515 : FuncRequest(LFUN_UNKNOWN_ACTION);
3519 string const LyXAction::getActionName(FuncCode action) const
3521 InfoMap::const_iterator const it = lyx_info_map.find(action);
3522 return it != lyx_info_map.end() ? it->second.name : string();
3526 LyXAction::FuncType LyXAction::getActionType(FuncCode action) const
3528 InfoMap::const_iterator const it = lyx_info_map.find(action);
3529 return it != lyx_info_map.end() ? it->second.type : Hidden;
3533 bool LyXAction::funcHasFlag(FuncCode action,
3534 LyXAction::FuncAttribs flag) const
3536 InfoMap::const_iterator ici = lyx_info_map.find(action);
3538 if (ici == lyx_info_map.end()) {
3539 LYXERR0("action: " << action << " is not known.");
3540 LASSERT(false, /**/);
3543 return ici->second.attrib & flag;
3547 LyXAction::const_iterator LyXAction::func_begin() const
3549 return lyx_func_map.begin();
3553 LyXAction::const_iterator LyXAction::func_end() const
3555 return lyx_func_map.end();
3559 LyXErr & operator<<(LyXErr & l, FuncCode code)
3562 l.stream() << lyxaction.getActionName(code);