3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Lars Gullik Bjønnes
7 * \author Jean-Marc Lasgouttes
12 * Full author contact details are available in file CREDITS.
17 #include "LyXAction.h"
19 #include "FuncRequest.h"
21 #include "support/debug.h"
22 #include "support/lstrings.h"
24 #include "support/lassert.h"
29 using namespace lyx::support;
34 NAMING RULES FOR USER-COMMANDS
35 Here's the set of rules to apply when a new command name is introduced:
37 1) Use the object.event order. That is, use `word-forward'
38 instead of `forward-word'.
39 2) Don't introduce an alias for an already named object. Same for events.
40 3) Forward movement or focus is called `forward' (not `right').
41 4) Backward movement or focus is called `backward' (not `left').
42 5) Upward movement of focus is called `up'.
43 6) Downward movement is called `down'.
44 7) The begin of an object is called `begin' (not `start').
45 8) The end of an object is called `end'.
47 (May 19 1996, 12:04, RvdK)
52 * The documentation below is primarily description of purpose and syntax
53 * relating to the different LFUNs.
55 * Try to find an appropriate (thematical) place when adding the new LFUN
56 * and don't forget to add doxygen commentary.
58 * Doxygen template below. Some notes: Parameters should be set in uppercase
59 * and put in <BRACKETS>, [<PARAM>] means optional one.
63 * \var lyx::FuncCode lyx::LFUN_
76 void LyXAction::newFunc(FuncCode action, string const & name,
77 unsigned int attrib, LyXAction::FuncType type)
79 lyx_func_map[name] = action;
82 tmpinfo.attrib = attrib;
84 lyx_info_map[action] = tmpinfo;
88 // Needed for LFUNs documentation to be accepted, since doxygen won't take
89 // \var inside functions.
90 #ifndef DOXYGEN_SHOULD_SKIP_THIS
91 void LyXAction::init()
93 // This function was changed to use the array below in initalization
94 // instead of calling newFunc numerous times because of compilation
95 // times. Since the array is not static we get back the memory it
96 // occupies after the init is completed. It compiles several
110 ev_item const items[] = {
113 * \var lyx::FuncCode lyx::LFUN_ACCENT_ACUTE
114 * \li Action: Adds an acute accent \htmlonly (á)\endhtmlonly
115 to the next character typed.
116 * \li Syntax: accent-acute
119 { LFUN_ACCENT_ACUTE, "accent-acute", Noop, Edit },
121 * \var lyx::FuncCode lyx::LFUN_ACCENT_BREVE
122 * \li Action: Adds a breve accent \htmlonly (ă)\endhtmlonly
123 to the next character typed.
124 * \li Syntax: accent-breve
127 { LFUN_ACCENT_BREVE, "accent-breve", Noop, Edit },
129 * \var lyx::FuncCode lyx::LFUN_ACCENT_CARON
130 * \li Action: Adds a caron \htmlonly (ǎ)\endhtmlonly
131 to the next character typed.
132 * \li Syntax: accent-caron
135 { LFUN_ACCENT_CARON, "accent-caron", Noop, Edit },
137 * \var lyx::FuncCode lyx::LFUN_ACCENT_CEDILLA
138 * \li Action: Adds a cedilla \htmlonly (ç)\endhtmlonly
139 to the next character typed.
140 * \li Syntax: accent-cedilla
143 { LFUN_ACCENT_CEDILLA, "accent-cedilla", Noop, Edit },
145 * \var lyx::FuncCode lyx::LFUN_ACCENT_CIRCLE
146 * \li Action: Adds a circle accent \htmlonly (å)\endhtmlonly
147 to the next character typed.
148 * \li Syntax: accent-circle
151 { LFUN_ACCENT_CIRCLE, "accent-circle", Noop, Edit },
153 * \var lyx::FuncCode lyx::LFUN_ACCENT_CIRCUMFLEX
154 * \li Action: Adds a circumflex \htmlonly (ê)\endhtmlonly
155 to the next character typed.
156 * \li Syntax: accent-circumflex
159 { LFUN_ACCENT_CIRCUMFLEX, "accent-circumflex", Noop, Edit },
161 * \var lyx::FuncCode lyx::LFUN_ACCENT_DOT
162 * \li Action: Adds a dot accent \htmlonly (ż)\endhtmlonly
163 to the next character typed.
164 * \li Syntax: accent-dot
167 { LFUN_ACCENT_DOT, "accent-dot", Noop, Edit },
169 * \var lyx::FuncCode lyx::LFUN_ACCENT_GRAVE
170 * \li Action: Adds a grave accent \htmlonly (è)\endhtmlonly
171 to the next character typed.
172 * \li Syntax: accent-grave
175 { LFUN_ACCENT_GRAVE, "accent-grave", Noop, Edit },
177 * \var lyx::FuncCode lyx::LFUN_ACCENT_HUNGARIAN_UMLAUT
178 * \li Action: Adds a Hungarian umlaut \htmlonly (ő)\endhtmlonly
179 to the next character typed.
180 * \li Syntax: accent-grave
183 { LFUN_ACCENT_HUNGARIAN_UMLAUT, "accent-hungarian-umlaut", Noop, Edit },
185 * \var lyx::FuncCode lyx::LFUN_ACCENT_MACRON
186 * \li Action: Adds a macron \htmlonly (ā)\endhtmlonly
187 to the next character typed.
188 * \li Syntax: accent-macron
191 { LFUN_ACCENT_MACRON, "accent-macron", Noop, Edit },
193 * \var lyx::FuncCode lyx::LFUN_ACCENT_OGONEK
194 * \li Action: Adds an ogonek accent \htmlonly (ą)\endhtmlonly
195 to the next character typed.
196 * \li Syntax: accent-ogonek
199 { LFUN_ACCENT_OGONEK, "accent-ogonek", Noop, Edit },
201 * \var lyx::FuncCode lyx::LFUN_ACCENT_TIE
202 * \li Action: Adds a tie \htmlonly (a͡)\endhtmlonly
203 over the next two character typed.
204 * \li Notion: The following char will finish the tie.
205 * \li Syntax: accent-tie
208 { LFUN_ACCENT_TIE, "accent-tie", Noop, Edit },
210 * \var lyx::FuncCode lyx::LFUN_ACCENT_TILDE
211 * \li Action: Adds a tilde \htmlonly (ã)\endhtmlonly
212 over the next character typed.
213 * \li Syntax: accent-tilde
216 { LFUN_ACCENT_TILDE, "accent-tilde", Noop, Edit },
218 * \var lyx::FuncCode lyx::LFUN_ACCENT_UMLAUT
219 * \li Action: Adds an umlaut \htmlonly (ä)\endhtmlonly
220 over the next character typed.
221 * \li Syntax: accent-umlaut
224 { LFUN_ACCENT_UMLAUT, "accent-umlaut", Noop, Edit },
226 * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERBAR
227 * \li Action: Adds a bar \htmlonly (a̠)\endhtmlonly
228 under the next character typed.
229 * \li Syntax: accent-underbar
232 { LFUN_ACCENT_UNDERBAR, "accent-underbar", Noop, Edit },
234 * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERDOT
235 * \li Action: Adds a dot \htmlonly (ạ)\endhtmlonly
236 under the next character typed.
237 * \li Syntax: accent-underdot
240 { LFUN_ACCENT_UNDERDOT, "accent-underdot", Noop, Edit },
243 * \var lyx::FuncCode lyx::LFUN_CAPTION_INSERT
244 * \li Action: Inserts a caption inset.
245 * \li Syntax: caption-insert
246 * \li Origin: Lgb, 18 Jul 2000
249 { LFUN_CAPTION_INSERT, "caption-insert", Noop, Edit },
251 * \var lyx::FuncCode lyx::LFUN_DATE_INSERT
252 * \li Action: Inserts the current date.
253 * \li Syntax: date-insert [<ARG>]
254 * \li Params: <ARG>: Format of date. The default value (%x) can be set
255 in Preferences->Date format. For possible formats
256 see manual page of strftime function.
257 * \li Origin: jdblair, 31 Jan 2000
260 { LFUN_DATE_INSERT, "date-insert", Noop, Edit },
262 * \var lyx::FuncCode lyx::LFUN_FOOTNOTE_INSERT
263 * \li Action: Inserts a footnote inset.
264 * \li Syntax: footnote-insert
265 * \li Origin: Jug, 7 Mar 2000
268 { LFUN_FOOTNOTE_INSERT, "footnote-insert", Noop, Edit },
270 * \var lyx::FuncCode lyx::LFUN_ERT_INSERT
271 * \li Action: Inserts an ERT inset.
272 * \li Syntax: ert-insert
273 * \li Origin: Jug, 18 Feb 2000
276 { LFUN_ERT_INSERT, "ert-insert", Noop, Edit },
278 * \var lyx::FuncCode lyx::LFUN_FLOAT_INSERT
279 * \li Action: Inserts a float inset.
280 * \li Syntax: float-insert <TYPE>
281 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
282 "algorithm", "table", "figure" parameters can be given.
283 * \li Origin: Lgb, 27 Jun 2000
286 { LFUN_FLOAT_INSERT, "float-insert", Noop, Edit },
288 * \var lyx::FuncCode lyx::LFUN_FLOAT_WIDE_INSERT
289 * \li Action: Inserts float insets as in #LFUN_FLOAT_INSERT but span multiple columns.
290 * \li Notion: Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
291 * \li Syntax: float-wide-insert <TYPE>
292 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
293 "algorithm", "table", "figure" parameters can be given.
294 * \li Origin: Lgb, 31 Oct 2001
297 { LFUN_FLOAT_WIDE_INSERT, "float-wide-insert", Noop, Edit },
299 * \var lyx::FuncCode lyx::LFUN_FLOAT_LIST_INSERT
300 * \li Action: Inserts the list of floats in the document.
301 * \li Syntax: float-list-insert <TYPE>
302 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
303 "algorithm", "table", "figure" parameters can be given.
304 * \li Origin: Lgb, 3 May 2001
307 { LFUN_FLOAT_LIST_INSERT, "float-list-insert", Noop, Edit },
309 * \var lyx::FuncCode lyx::LFUN_WRAP_INSERT
310 * \li Action: Inserts floats wrapped by the text around.
311 * \li Syntax: wrap-insert <TYPE>
312 * \li Params: <TYPE>: table|figure
313 * \li Origin: Dekel, 7 Apr 2002
316 { LFUN_WRAP_INSERT, "wrap-insert", Noop, Edit },
318 * \var lyx::FuncCode lyx::LFUN_OPTIONAL_INSERT
319 * \li Action: Inserts an optional-argument (short title) inset.
320 * \li Syntax: optional-insert
321 * \li Origin: vermeer, 12 Aug 2002
324 { LFUN_OPTIONAL_INSERT, "optional-insert", Noop, Edit },
326 * \var lyx::FuncCode lyx::LFUN_LINE_INSERT
327 * \li Action: Inserts a horizontal line.
328 * \li Syntax: line-insert
329 * \li Origin: Andre, Oct 27 2003
332 { LFUN_LINE_INSERT, "line-insert", Noop, Edit },
334 * \var lyx::FuncCode lyx::LFUN_NEWPAGE_INSERT
335 * \li Action: Inserts a new page.
336 * \li Syntax: newpage-insert <ARG>
337 * \li Params: <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
338 * \li Origin: uwestoehr, 24 Nov 2007
341 { LFUN_NEWPAGE_INSERT, "newpage-insert", Noop, Edit },
343 * \var lyx::FuncCode lyx::LFUN_MARGINALNOTE_INSERT
344 * \li Action: Inserts a marginal note.
345 * \li Syntax: marginalnote-insert
346 * \li Origin: Lgb, 26 Jun 2000
349 { LFUN_MARGINALNOTE_INSERT, "marginalnote-insert", Noop, Edit },
351 * \var lyx::FuncCode lyx::LFUN_UNICODE_INSERT
352 * \li Action: Inserts a single unicode character.
353 * \li Syntax: unicode-insert <CHAR>
354 * \li Params: <CHAR>: The character to insert, given as its code
355 point, in hexadecimal.
356 * \li Sample: unicode-insert 0x0100
357 * \li Origin: Lgb, 22 Oct 2006
360 { LFUN_UNICODE_INSERT, "unicode-insert", Noop, Edit },
362 * \var lyx::FuncCode lyx::LFUN_LISTING_INSERT
363 * \li Action: Inserts a new listings inset.
364 * \li Syntax: listing-insert
365 * \li Origin: Herbert, 10 Nov 2001; bpeng, 2 May 2007
368 { LFUN_LISTING_INSERT, "listing-insert", Noop, Edit },
370 * \var lyx::FuncCode lyx::LFUN_TAB_INSERT
371 * \li Action: Insert a tab into a listings inset.
372 * \li Notion: It also works on a selection.
373 * \li Syntax: tab-insert
374 * \li Origin: vfr, Sep 30 2008
377 { LFUN_TAB_INSERT, "tab-insert", SingleParUpdate, Edit },
379 * \var lyx::FuncCode lyx::LFUN_TAB_DELETE
380 * \li Action: Delete a tab or up to an equivalent amount of spaces from
382 * \li Notion: It also works on a selection - it removes a tab or spaces from the
383 beginning of each line spanned by the selection. This is useful if
384 you want to indent/unindent multiple lines in one action.
385 * \li Syntax: tab-delete
386 * \li Origin: vfr, Sep 30 2008
389 { LFUN_TAB_DELETE, "tab-delete", SingleParUpdate, Edit },
391 * \var lyx::FuncCode lyx::LFUN_QUOTE_INSERT
392 * \li Action: Inserts quotes according to the type and quote-language preference.
393 * \li Notion: Currently English, Swedish, German, Polish, French, Danish quotes
395 * \li Syntax: quote-insert [<TYPE>]
396 * \li Params: <TYPE>: 'single' for single quotes, otherwise double quotes will be used.
399 { LFUN_QUOTE_INSERT, "quote-insert", Noop, Edit },
401 * \var lyx::FuncCode lyx::LFUN_INFO_INSERT
402 * \li Action: Displays shortcuts, lyxrc, package and textclass availability and menu
403 information in a non-editable boxed InsetText.
404 * \li Notion: Apart from lfun arguments you can use the following method: \n
405 1. input the type and argument of this inset, e.g. "menu paste", in
407 2. select the text and run info-insert lfun.
408 * \li Syntax: info-insert <TYPE> <ARG>
409 * \li Params: <TYPE>: shortcut[s]|lyxrc|package|textclass|menu|buffer \n
410 <ARG>: argument for a given type. Look into InsetInfo.h for detailed
412 shortcut[s]: name of lfun (e.g math-insert \alpha) \n
413 lyxrc: name of rc_entry (e.g. bind_file) \n
414 package: name of latex package (e.g. listings) \n
415 textclass: name of textclass (e.g. article) \n
416 menu: name of lfun used in menu \n
417 icon: name of lfun used in toolbar \n
418 buffer: "name"|"path"|"class"
419 * \li Sample: command-sequence info-insert buffer path; info-insert buffer name
420 * \li Origin: bpeng, 7 Oct 2007
423 { LFUN_INFO_INSERT, "info-insert", Noop, Edit },
425 * \var lyx::FuncCode lyx::LFUN_BRANCH_INSERT
426 * \li Action: Inserts branch inset.
427 * \li Syntax: branch-insert <BRANCH-NAME>
428 * \li Origin: vermeer, 17 Aug 2003
431 { LFUN_BRANCH_INSERT, "branch-insert", Noop, Edit },
433 * \var lyx::FuncCode lyx::LFUN_BOX_INSERT
434 * \li Action: Inserts Box inset.
435 * \li Syntax: box-insert [<TYPE>]
436 * \li Params: <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox \n
437 Framed is the default one.
438 * \li Origin: vermeer, 7 Oct 2003
441 { LFUN_BOX_INSERT, "box-insert", Noop, Edit },
443 * \var lyx::FuncCode lyx::LFUN_FLEX_INSERT
444 * \li Action: Inserts CharStyle, Custom inset or XML short element.
445 * \li Notion: Look into the Customization manual for more information about
447 To make this command enabled the layout file for the document
448 class you're using has to load the character styles. There are
449 a few contained in the Logical Markup module. You can also of
450 course create some yourself. \n
451 For dissolving the element see #LFUN_INSET_DISSOLVE.
452 * \li Syntax: flex-insert <TYPE:Name>
453 * \li Params: TYPE: CharStyle|Custom|Element|Standard \n
454 Identifies whether this is a Character Style, a
455 Custom Inset or an XML Element, and which dynamical
456 sub-menu this flex inset is in on the LyX menu tree.
457 If Standard (currently unused): none of these.\n
458 Name: This name must be defined either in your layout file
459 or imported by some module. The definition is
460 InsetLayout <TYPE:Name>
461 * \li Sample: flex-insert CharStyle:Code
464 { LFUN_FLEX_INSERT, "flex-insert", Noop, Edit },
466 * \var lyx::FuncCode lyx::LFUN_SELF_INSERT
467 * \li Action: Inserts the given string (accordingly to the correct keymap).
468 * \li Notion: Automatically replace the currently selected text. Depends on lyxrc
469 settings "auto_region_delete".
470 * \li Syntax: self-insert <STRING>
473 { LFUN_SELF_INSERT, "self-insert", SingleParUpdate, Hidden },
475 * \var lyx::FuncCode lyx::LFUN_SPACE_INSERT
476 * \li Action: Inserts one of horizontal space insets.
477 * \li Syntax: space-insert <NAME> [<LEN>]
478 * \li Params: <NAME>: normal, protected, thin, quad, qquad, enspace, enskip,
479 negthinspace, hfill, hfill*, dotfill, hrulefill, hspace,
481 <LEN>: length for custom spaces (hspace, hspace* for protected)
482 * \li Origin: JSpitzm, 20 May 2003, Mar 17 2008
485 { LFUN_SPACE_INSERT, "space-insert", Noop, Edit },
487 * \var lyx::FuncCode lyx::LFUN_HYPERLINK_INSERT
488 * \li Action: Inserts hyperlinks into the document (clickable in pdf output).
489 * \li Notion: Hyperlink target can be set via selection + hyperlink-insert function.
490 * \li Syntax: href-insert [<TARGET>]
491 * \li Origin: CFO-G, 21 Nov 1997
494 { LFUN_HYPERLINK_INSERT, "href-insert", Noop, Edit },
496 * \var lyx::FuncCode lyx::LFUN_SPECIALCHAR_INSERT
497 * \li Action: Inserts various characters into the document.
498 * \li Syntax: specialchar-insert <CHAR>
499 * \li Params: <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots,
500 end-of-sentence, menu-separator.
501 * \li Origin: JSpitzm, 6 Dec 2007
504 { LFUN_SPECIALCHAR_INSERT, "specialchar-insert", Noop, Edit },
506 * \var lyx::FuncCode lyx::LFUN_TOC_INSERT
507 * \li Action: Inserts table of contents.
508 * \li Syntax: toc-insert
509 * \li Origin: Lgb, 27 May 97
512 { LFUN_TOC_INSERT, "toc-insert", Noop, Edit },
514 * \var lyx::FuncCode lyx::LFUN_APPENDIX
515 * \li Action: Start (or remove) Appendix on the given cursor position.
516 * \li Syntax: appendix
517 * \li Origin: ettrich, 5 May 1998
520 { LFUN_APPENDIX, "appendix", Noop, Edit },
523 * \var lyx::FuncCode lyx::LFUN_INDEX_INSERT
524 * \li Action: Inserts Index entry.
525 * \li Notion: It automatically takes the word on the cursor position.
526 * \li Syntax: index-insert [<TYPE:Name>]
527 * \li Params: <TYPE:Name>: name of the index, if multiple indices are defined.
528 with an empty argument, the default index is selected.
529 * \li Origin: leeming, 3 Aug 2000
532 { LFUN_INDEX_INSERT, "index-insert", Noop, Edit },
534 * \var lyx::FuncCode lyx::LFUN_INDEX_PRINT
535 * \li Action: Inserts list of Index entries on a new page.
536 * \li Syntax: index-print [<TYPE:Name>]
537 * \li Params: <TYPE:Name>: name of the index, if multiple indices are defined.
538 with an empty argument, the default index is selected.
539 * \li Origin: Lgb, 27 Feb 1997
542 { LFUN_INDEX_PRINT, "index-print", Noop, Edit },
545 * \var lyx::FuncCode lyx::LFUN_NOMENCL_INSERT
546 * \li Action: Inserts Nomenclature entry.
547 * \li Notion: It automatically takes the word on the cursor position if no symbol is given.
548 * \li Syntax: nomencl-insert [<SYMBOL>]
549 * \li Origin: Ugras, 4 Nov 2006
552 { LFUN_NOMENCL_INSERT, "nomencl-insert", Noop, Edit },
554 * \var lyx::FuncCode lyx::LFUN_NOMENCLATURE_PRINT
555 * \li Action: Inserts list of Nomenclature entries.
556 * \li Syntax: nomenclature-print
557 * \li Origin: Ugras, 4 Nov 2006
560 { LFUN_NOMENCL_PRINT, "nomencl-print", Noop, Edit },
563 * \var lyx::FuncCode lyx::LFUN_NOTE_INSERT
564 * \li Action: Inserts Note on the current cursor postion,
565 move selection inside the inset.
566 * \li Syntax: note-insert [<TYPE>]
567 * \li Params: <TYPE>: <Note|Greyedout|Comment> default: Note
570 { LFUN_NOTE_INSERT, "note-insert", Noop, Edit },
572 * \var lyx::FuncCode lyx::LFUN_NOTE_NEXT
573 * \li Action: Moves the cursor to the begining of next Note inset.
574 * \li Syntax: note-next
577 { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
579 * \var lyx::FuncCode lyx::LFUN_NOTES_MUTATE
580 * \li Action: Changes all Note insets of a particular type (source)
581 to a different type (target) fot the current document.
582 * \li Syntax: notes-mutate <SOURCE> <TARGET>
583 * \li Params: <SOURCE/TARGET>: Note|Comment|Greyedout
584 * \li Origin: sanda, 18 Jun 2008
587 { LFUN_NOTES_MUTATE, "notes-mutate", Argument, Edit },
589 * \var lyx::FuncCode lyx::LFUN_PHANTOM_INSERT
590 * \li Action: Inserts phantom on the current cursor postion,
591 move selection inside the inset.
592 * \li Syntax: phantom-insert [<TYPE>]
593 * \li Params: <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
594 * \li Origin: uwestoehr, 30 Jan 2009
597 { LFUN_PHANTOM_INSERT, "phantom-insert", Noop, Edit },
599 * \var lyx::FuncCode lyx::LFUN_NEWLINE_INSERT
600 * \li Action: Inserts a line break or new line.
601 * \li Syntax: newline-insert [<ARG>]
602 * \li Params: <ARG>: <newline|linebreak> default: newline
603 * \li Origin: JSpitzm, 25 Mar 2008
606 { LFUN_NEWLINE_INSERT, "newline-insert", Noop, Edit },
608 * \var lyx::FuncCode lyx::LFUN_ESCAPE
609 * \li Action: Clears the selection. If no text is selected call #LFUN_FINISHED_FORWARD.
611 * \li Origin: Lgb, 17 May 2001
614 { LFUN_ESCAPE, "escape", ReadOnly, Edit },
616 * \var lyx::FuncCode lyx::LFUN_DOWN
617 * \li Action: Moves the cursor one line in downward direction.
621 { LFUN_DOWN, "down", ReadOnly | NoUpdate, Edit },
623 * \var lyx::FuncCode lyx::LFUN_UP
624 * \li Action: Moves the cursor one line in upward direction.
628 { LFUN_UP, "up", ReadOnly | NoUpdate, Edit },
630 * \var lyx::FuncCode lyx::LFUN_DOWN_SELECT
631 * \li Action: Moves the cursor one line in downward direction adding the current
632 position to the selection.
633 * \li Syntax: down-select
636 { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, Edit },
638 * \var lyx::FuncCode lyx::LFUN_UP_SELECT
639 * \li Action: Moves the cursor one line in upward direction adding the current
640 position to the selection.
641 * \li Syntax: up-select
644 { LFUN_UP_SELECT, "up-select", ReadOnly | SingleParUpdate, Edit },
646 * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN
647 * \li Action: Moves the cursor one page in downward direction.
648 * \li Syntax: screen-down
651 { LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit },
653 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP
654 * \li Action: Moves the cursor one page in upward direction.
655 * \li Syntax: screen-up
658 { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit },
660 * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN_SELECT
661 * \li Action: Moves the cursor one screen in downward direction adding the current
662 position to the selection.
663 * \li Syntax: screen-down-select
666 { LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit },
668 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP_SELECT
669 * \li Action: Moves the cursor one page in upward direction adding the current
670 position to the selection.
671 * \li Syntax: screen-up-select
674 { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit },
676 * \var lyx::FuncCode lyx::LFUN_SCROLL
677 * \li Action: Scroll the buffer view.
678 * \li Notion: Only scrolls the screen up or down; does not move the cursor.
679 * \li Syntax: scroll <TYPE> <QUANTITY>
680 * \li Params: <TYPE>: line|page\n
681 <QUANTITY>: up|down|<number>
682 * \li Origin: Abdel, Dec 27 2007
685 { LFUN_SCROLL, "scroll", ReadOnly, Edit },
687 * \var lyx::FuncCode lyx::LFUN_SCREEN_RECENTER
688 * \li Action: Recenters the screen on the current cursor position.
689 * \li Syntax: screen-recenter
692 { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit },
695 * \var lyx::FuncCode lyx::LFUN_SCREEN_SHOW_CURSOR
696 * \li Action: Repositions the screen such that the cursor is visible.
697 * \li Syntax: screen-show-cursor
698 * \li Origin: vfr, 25 Mar 2009
701 { LFUN_SCREEN_SHOW_CURSOR, "screen-show-cursor", ReadOnly, Edit },
704 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD
705 * \li Action: Moves the cursor one position logically backwards.
706 * \li Notion: This is not the action which should be bound to the arrow keys,
707 because backwards may be left or right, depending on the
708 language. The arrow keys should be bound to #LFUN_CHAR_LEFT or
709 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
710 * \li Syntax: char-backward
713 { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit },
715 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD_SELECT
716 * \li Action: Moves the cursor one position logically backwards, adding
717 traversed position to the selection.
718 * \li Notion: See also #LFUN_CHAR_BACKWARD.
719 * \li Syntax: char-backward-select
722 { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit },
724 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_BACKWARD
725 * \li Action: Deletes one character in the backward direction (usually the "BackSpace" key).
726 * \li Syntax: char-delete-backward
729 { LFUN_CHAR_DELETE_BACKWARD, "char-delete-backward", SingleParUpdate, Edit },
731 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_FORWARD
732 * \li Action: Deletes one character in the backward direction (usually the "Delete" key).
733 * \li Syntax: char-delete-forward
736 { LFUN_CHAR_DELETE_FORWARD, "char-delete-forward", SingleParUpdate, Edit },
738 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD
739 * \li Action: Moves the cursor one position logically forward.
740 * \li Notion: This is not the action which should be bound to the arrow keys,
741 because forward may be left or right, depending on the language.
742 The arrow keys should be bound to #LFUN_CHAR_LEFT or
743 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
744 * \li Syntax: char-forward
747 { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit },
749 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD_SELECT
750 * \li Action: Moves the cursor one position logically forward, adding
751 traversed position to the selection.
752 * \li Notion: See also #LFUN_CHAR_FORWARD.
753 * \li Syntax: char-forward-select
756 { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit },
758 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT
759 * \li Action: Moves the cursor one position "to the left".
760 * \li Notion: This is the action which should be taken when the "left" key
761 is pressed. Generally, it moves the cursor one position to the
762 left. However, in Bidi text this become slightly more
763 complicated, and there are different modes of cursor movement.
764 In "visual mode", this moves left, plain and simple. In "logical
765 mode", movement is logically forward in RTL paragraphs, and
766 logically backwards in LTR paragraphs.
767 * \li Syntax: char-left
770 { LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit },
772 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT_SELECT
773 * \li Action: Moves the cursor one position "to the left", adding
774 traversed position to the selection.
775 * \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement.
776 * \li Syntax: char-left-select
779 { LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit },
781 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT
782 * \li Action: Moves the cursor one position "to the right".
783 * \li Notion: This is the action which should be taken when the "right" key
784 is pressed. Generally, it moves the cursor one position to the
785 right. However, in Bidi text this become slightly more
786 complicated, and there are different modes of cursor movement.
787 In "visual mode", this moves right, plain and simple. In "logical
788 mode", movement is logically forward in LTR paragraphs, and
789 logically backwards in RTL paragraphs.
790 * \li Syntax: char-right
793 { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit },
795 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT_SELECT
796 * \li Action: Moves the cursor one position "to the right", adding
797 traversed position to the selection.
798 * \li Notion: See also #LFUN_CHAR_RIGHT for exact details of the movement.
799 * \li Syntax: char-right-select
802 { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit },
805 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD
806 * \li Action: Moves the cursor to the logically previous beginning of a word.
807 * \li Notion: This is not the action which should be bound to the arrow keys,
808 because backwards may be left or right, depending on the
809 language. The arrow keys should be bound to #LFUN_WORD_LEFT or
810 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
811 * \li Syntax: word-backward
814 { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit },
816 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD_SELECT
817 * \li Action: Moves the cursor to the logically previous beginning of a word,
818 adding the logically traversed text to the selection.
819 * \li Notion: See also #LFUN_WORD_BACKWARD.
820 * \li Syntax: word-backward-select
823 { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
825 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_BACKWARD
826 * \li Action: Deletes characters to the begining of the word (usually the "C+BackSpace" key).
827 * \li Syntax: word-delete-backward
830 { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
832 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_FORWARD
833 * \li Action: Deletes characters to the end of the word (usually the "C+Delete" key).
834 * \li Syntax: word-delete-forward
837 { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
839 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_FORWARD
840 * \li Action: Search for a given string in forward direction.
841 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
842 * \li Syntax: word-find-forward [<STRING>]
843 * \li Origin: Etienne, 16 Feb 1998
846 { LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit },
848 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_BACKWARD
849 * \li Action: Search for a given string in backward direction.
850 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
851 * \li Syntax: word-find-backward [<STRING>]
852 * \li Origin: Etienne, 20 Feb 1998
855 { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
857 * \var lyx::FuncCode lyx::LFUN_WORD_FIND
858 * \li Action: Search for next occurence of a string.
859 * \li Syntax: word-find [<DATA>]
860 * \li Params: <DATA>: data encoded from Find dialog (see #lyx::find2string()).
861 If no parameter is given, search with last find-dialog
862 data is used for search (i.e. find-next).
863 * \li Origin: Andre, Jan 7 2004
866 { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
868 * \var lyx::FuncCode lyx::LFUN_WORD_REPLACE
869 * \li Action: Replace a string in the document.
870 * \li Syntax: word-replace [<DATA>]
871 * \li Params: <DATA>: data is of the form
874 <casesensitive> <matchword> <all> <forward>"
875 * \li Origin: Andre, Jan 7 2004
878 { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
880 * \var lyx::FuncCode lyx::LFUN_WORD_FINDADV
881 * \li Action: Search for next occurence of a pattern.
882 * \li Syntax: word-findadv [<DATA>]
883 * \li Params: <DATA>: data encoded from FindAdv dialog (see #lyx::findadv2string()).
884 If no parameter is given, search with last find-dialog
885 data is used for search (i.e. find-next).
886 * \li Origin: Tommaso, Nov 15 2007
889 { LFUN_WORD_FINDADV, "word-findadv", ReadOnly | NoBuffer, Edit },
891 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD
892 * \li Action: Moves the cursor to the logically next beginning of a word.
893 * \li Notion: This is not the action which should be bound to the arrow keys,
894 because forward may be left or right, depending on the language.
895 The arrow keys should be bound to #LFUN_WORD_LEFT or
896 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
897 * \li Syntax: word-forward
900 { LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
902 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD_SELECT
903 * \li Action: Moves the cursor to the logically next beginning of a word,
904 adding the logically traversed text to the selection.
905 * \li Notion: See also #LFUN_WORD_FORWARD.
906 * \li Syntax: word-forward-select
909 { LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
911 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT
912 * \li Action: Moves the cursor to the next beginning of a word "on the left".
913 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
914 "left" key is pressed. Generally, it moves the cursor to the
915 next beginning of a word on the left. However, in Bidi text this
916 become slightly more complicated, and there are different modes
917 of cursor movement. In "visual mode", this moves left, plain and
918 simple. In "logical mode", movement is logically forward in RTL
919 paragraphs, and logically backwards in LTR paragraphs.
920 * \li Syntax: word-left
921 * \li Origin: dov, 28 Oct 2007
924 { LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
926 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT_SELECT
927 * \li Action: Moves the cursor to the next beginning of a word "on the left",
928 adding *logically* traversed text to the selection.
929 * \li Notion: See also #LFUN_WORD_LEFT for exact details of the movement.
930 * \li Syntax: word-left-select
931 * \li Origin: dov, 28 Oct 2007
934 { LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit },
936 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT
937 * \li Action: Moves the cursor to the next beginning of a word "on the right".
938 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
939 "right" key is pressed. Generally, it moves the cursor to the
940 next beginning of a word on the right. However, in Bidi text
941 this become slightly more complicated, and there are different
942 modes of cursor movement. In "visual mode", this moves right,
943 plain and simple. In "logical mode", movement is logically
944 forward in LTR paragraphs, and logically backwards in RTL
946 * \li Syntax: word-right
947 * \li Origin: dov, 28 Oct 2007
950 { LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit },
952 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT_SELECT
953 * \li Action: Moves the cursor to the next beginning of a word "on the right",
954 adding *logically* traversed text to the selection.
955 * \li Notion: See also #LFUN_WORD_RIGHT for exact details of the movement.
956 * \li Syntax: word-right-select
957 * \li Origin: dov, 28 Oct 2007
960 { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
962 * \var lyx::FuncCode lyx::LFUN_WORD_SELECT
963 * \li Action: Puts the word where the cursor stands into the selection.
964 * \li Syntax: word-select
965 * \li Origin: Andre, 11 Sep 2002
968 { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
970 * \var lyx::FuncCode lyx::LFUN_WORD_CAPITALIZE
971 * \li Action: Capitalizes the words in the selection (i.e. the first letters)
972 or the letter on the cursor position.
973 * \li Syntax: word-capitalize
976 { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
978 * \var lyx::FuncCode lyx::LFUN_WORD_UPCASE
979 * \li Action: Change the words in the selection or from the cursor position
980 to the end of word to the upper case.
981 * \li Syntax: word-upcase
984 { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
986 * \var lyx::FuncCode lyx::LFUN_WORD_LOWCASE
987 * \li Action: Change the words in the selection or from the cursor position
988 to the end of word to the lower case.
989 * \li Syntax: word-lowcase
992 { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
994 * \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
995 * \li Action: Look up thesaurus entries with respect to the word under the cursor.
996 * \li Syntax: thesaurus-entry [<STRING>] [lang=<LANG>]
997 * \li Params: <STRING>: word to look up
998 <LANG>: language (see file languages)
999 * \li Origin: Levon, 20 Jul 2001
1002 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
1004 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN
1005 * \li Action: Move the cursor to the beginning of the document.
1006 * \li Syntax: buffer-begin
1009 { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
1011 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN_SELECT
1012 * \li Action: Move the cursor to the beginning of the document adding the
1013 traversed text to the selection.
1014 * \li Syntax: buffer-begin-select
1017 { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
1019 * \var lyx::FuncCode lyx::LFUN_BUFFER_END
1020 * \li Action: Move the cursor to the end of the document.
1021 * \li Syntax: buffer-end
1024 { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
1026 * \var lyx::FuncCode lyx::LFUN_BUFFER_END_SELECT
1027 * \li Action: Move the cursor to the end of the document adding the
1028 traversed text to the selection.
1029 * \li Syntax: buffer-end-select
1032 { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
1035 * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN
1036 * \li Action: Move the cursor to the beginning of the current inset
1037 if it is not already there, or at the beginning of the
1038 enclosing inset otherwise
1039 * \li Syntax: inset-begin
1040 * \li Origin: lasgouttes, 16 Mar 2009
1043 { LFUN_INSET_BEGIN, "inset-begin", ReadOnly, Edit },
1045 * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN_SELECT
1046 * \li Action: Move the cursor to the beginning of the current inset
1047 if it is not already there, or at the beginning of the
1048 enclosing inset otherwise (adding the
1049 traversed text to the selection).
1050 * \li Syntax: inset-begin-select
1051 * \li Origin: lasgouttes, 16 Mar 2009
1054 { LFUN_INSET_BEGIN_SELECT, "inset-begin-select", ReadOnly, Edit },
1056 * \var lyx::FuncCode lyx::LFUN_INSET_END
1057 * \li Action: Move the cursor to the end of the current inset
1058 if it is not already there, or at the end of the
1059 enclosing inset otherwise
1060 * \li Syntax: inset-end
1061 * \li Origin: lasgouttes, 16 Mar 2009
1064 { LFUN_INSET_END, "inset-end", ReadOnly, Edit },
1066 * \var lyx::FuncCode lyx::LFUN_INSET_END_SELECT
1067 * \li Action: Move the cursor to the end of the current inset
1068 if it is not already there, or at the end of the
1069 enclosing inset otherwise (adding the
1070 traversed text to the selection).
1071 * \li Syntax: inset-end-select
1072 * \li Origin: lasgouttes, 16 Mar 2009
1075 { LFUN_INSET_END_SELECT, "inset-end-select", ReadOnly, Edit },
1078 * \var lyx::FuncCode lyx::LFUN_INSET_SELECT_ALL
1079 * \li Action: Selects all contents of an inset.
1080 * \li Syntax: inset-select-all
1081 * \li Origin: vfr, 22 Aug 2009
1084 { LFUN_INSET_SELECT_ALL, "inset-select-all", ReadOnly, Edit },
1087 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN
1088 * \li Action: Move the cursor to the begining of the (screen) line.
1089 * \li Syntax: line-begin
1092 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
1094 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN_SELECT
1095 * \li Action: Move the cursor to the beginning of the (screen) line adding the
1096 traversed text to the selection.
1097 * \li Syntax: line-begin-select
1100 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
1102 * \var lyx::FuncCode lyx::LFUN_LINE_END
1103 * \li Action: Move the cursor to the end of the (screen) line.
1104 * \li Syntax: line-end
1107 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
1109 * \var lyx::FuncCode lyx::LFUN_LINE_END_SELECT
1110 * \li Action: Move the cursor to the end of the (screen) line adding the
1111 traversed text to the selection.
1112 * \li Syntax: line-end-select
1115 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
1117 * \var lyx::FuncCode lyx::LFUN_LINE_DELETE
1118 * \li Action: Deletes the letters to the end of the (screen) line or
1119 deletes the selection.
1120 * \li Syntax: line-delete-forward
1123 { LFUN_LINE_DELETE, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
1125 * \var lyx::FuncCode lyx::LFUN_COPY
1126 * \li Action: Copies to the clipboard the last edit.
1130 { LFUN_COPY, "copy", ReadOnly, Edit },
1132 * \var lyx::FuncCode lyx::LFUN_CUT
1133 * \li Action: Cuts to the clipboard.
1137 { LFUN_CUT, "cut", Noop, Edit },
1139 * \var lyx::FuncCode lyx::LFUN_PASTE
1140 * \li Action: Pastes material (text or picture) from the active clipboard.
1141 * \li Syntax: paste [<TYPE>|<NUM>]
1142 * \li Params: <TYPE>: emf|pdf|png|jpeg|linkback|wmf \n
1143 <NUM>: number of the selection in the internal clipboard stack to be pasted.
1146 { LFUN_PASTE, "paste", Noop, Edit },
1148 * \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE
1149 * \li Action: Pastes text from the active clipboard.
1150 * \li Syntax: clipboard-paste [<ARG>]
1151 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1152 * \li Origin: baum, 10 Jul 2006
1155 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
1157 * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
1158 * \li Action: Pastes the currently text selected text.
1159 * \li Notion: Primary selection mechanism is linux-only thing.
1160 * \li Syntax: primary-selection-paste [<ARG>]
1161 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1164 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
1166 * \var lyx::FuncCode lyx::LFUN_SELECTION_PASTE
1167 * \li Action: Pastes the text in permanent selection.
1168 * \li Syntax: selection-paste
1171 { LFUN_SELECTION_PASTE, "selection-paste", Noop, Edit },
1173 * \var lyx::FuncCode lyx::LFUN_UNDO
1174 * \li Action: Undoes the last edit.
1178 { LFUN_UNDO, "undo", Noop, Edit },
1180 * \var lyx::FuncCode lyx::LFUN_REDO
1181 * \li Action: Redoes the last thing undone.
1185 { LFUN_REDO, "redo", Noop, Edit },
1187 * \var lyx::FuncCode lyx::LFUN_REPEAT
1188 * \li Action: Repeat the given command.
1189 * \li Syntax: repeat <COUNT> <LFUN-COMMAND>
1190 * \li Origin: Andre, 27 Oct 2003
1193 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
1195 * \var lyx::FuncCode lyx::LFUN_CHARS_TRANSPOSE
1196 * \li Action: Transposes the character at the cursor with the one before it.
1197 * \li Syntax: chars-transpose
1198 * \li Origin: Lgb, 25 Apr 2001
1201 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
1204 * \var lyx::FuncCode lyx::LFUN_DEPTH_DECREMENT
1205 * \li Action: Decrease the nesting depth of the (selected) paragraph(s)
1207 * \li Syntax: depth-decrement
1210 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
1212 * \var lyx::FuncCode lyx::LFUN_DEPTH_INCREMENT
1213 * \li Action: Increase the nesting depth of the (selected) paragraph(s)
1215 * \li Syntax: depth-increment
1218 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
1221 * \var lyx::FuncCode lyx::LFUN_FONT_BOLD
1222 * \li Action: Toggles the bold font (selection-wise) using mathbf in math.
1223 * \li Syntax: font-bold
1226 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
1229 * \var lyx::FuncCode lyx::LFUN_FONT_BOLDSYMBOL
1230 * \li Action: Toggles the bold font (selection-wise) using boldsymbol in math.
1231 * \li Syntax: font-boldsymbol
1234 { LFUN_FONT_BOLDSYMBOL, "font-boldsymbol", Noop, Layout },
1236 * \var lyx::FuncCode lyx::LFUN_FONT_TYPEWRITER
1237 * \li Action: Toggles the typewriter family font (selection-wise).
1238 * \li Syntax: font-typewriter
1241 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
1243 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERLINE
1244 * \li Action: Toggles underline in the font (selection-wise).
1245 * \li Syntax: font-underline
1248 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
1250 * \var lyx::FuncCode lyx::LFUN_FONT_UULINE
1251 * \li Action: Toggles double underline in the font (selection-wise).
1252 * \li Syntax: font-underunderline
1253 * \li Origin: sanda, 5 May 2009
1256 { LFUN_FONT_UULINE, "font-underunderline", Noop, Layout },
1258 * \var lyx::FuncCode lyx::LFUN_FONT_UWAVE
1259 * \li Action: Toggles wavy underline in the font (selection-wise).
1260 * \li Syntax: font-underwave
1261 * \li Origin: sanda, 5 May 2009
1264 { LFUN_FONT_UWAVE, "font-underwave", Noop, Layout },
1266 * \var lyx::FuncCode lyx::LFUN_FONT_STRIKEOUT
1267 * \li Action: Toggles strikeout (strike-through) in the font (selection-wise).
1268 * \li Syntax: font-strikeout
1269 * \li Origin: sanda, 3 May 2009
1272 { LFUN_FONT_STRIKEOUT, "font-strikeout", Noop, Layout },
1274 * \var lyx::FuncCode lyx::LFUN_FONT_EMPH
1275 * \li Action: Toggles the emphasis font style (selection-wise).
1276 * \li Syntax: font-emph
1279 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
1281 * \var lyx::FuncCode lyx::LFUN_FONT_NOUN
1282 * \li Action: Toggles Noun text style font (selection-wise).
1283 * \li Syntax: font-noun
1286 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
1288 * \var lyx::FuncCode lyx::LFUN_FONT_ROMAN
1289 * \li Action: Toggles Roman family font (selection-wise).
1290 * \li Syntax: font-roman
1293 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
1295 * \var lyx::FuncCode lyx::LFUN_FONT_SANS
1296 * \li Action: Toggles Sans Serif family font (selection-wise).
1297 * \li Syntax: font-sans
1300 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
1302 * \var lyx::FuncCode lyx::LFUN_FONT_FRAK
1303 * \li Action: Toggles Fraktur family font (math-mode, selection-wise).
1304 * \li Syntax: font-frak
1305 * \li Origin: vermeer, 10 Jan 2002
1308 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
1310 * \var lyx::FuncCode lyx::LFUN_FONT_ITAL
1311 * \li Action: Toggles Italics font shape (math-mode, selection-wise).
1312 * \li Syntax: font-ital
1313 * \li Origin: vermeer, 10 Jan 2002
1316 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
1318 * \var lyx::FuncCode lyx::LFUN_FONT_DEFAULT
1319 * \li Action: Reverts the settings of the font to the default values (selection-wise).
1320 * \li Syntax: font-default
1323 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
1325 * \var lyx::FuncCode lyx::LFUN_FONT_SIZE
1326 * \li Action: Sets font size according to lyx format string.
1327 * \li Syntax: font-size <SIZE>
1328 * \li Params: <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|\n
1329 largest|huge|giant|increase|decrease|default
1332 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
1334 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_APPLY
1335 * \li Action: Toggle user-defined (=last-time used) text style.
1336 * \li Notion: This style is set via #LFUN_TEXTSTYLE_UPDATE, which is
1337 automatically trigerred when using Text Style dialog.
1338 * \li Syntax: textstyle-apply
1339 * \li Origin: leeming, 12 Mar 2003
1342 { LFUN_TEXTSTYLE_APPLY, "textstyle-apply", Noop, Layout },
1344 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_UPDATE
1345 * \li Action: Apply text style and update the settings to be used by #LFUN_TEXTSTYLE_APPLY.
1346 * \li Syntax: textstyle-update <FONT_INFO>
1347 * \li Params: <FONT_INFO>: specifies font atributes, e.g. family, series, shape,
1348 size, emph, noun, underbar, number, color, language,
1350 Use lyx -dbg action for exact syntax of text-style
1352 * \li Origin: leeming, 12 Mar 2003
1355 { LFUN_TEXTSTYLE_UPDATE, "textstyle-update", Noop, Layout },
1357 * \var lyx::FuncCode lyx::LFUN_SCREEN_FONT_UPDATE
1358 * \li Action: Update fonts and its metrics.
1359 * \li Notion: Automatically called after zoom, dpi, font names, or norm change.
1360 * \li Syntax: screen-font-update
1361 * \li Origin: ARRae, 13 Aug 2000
1364 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
1366 * \var lyx::FuncCode lyx::LFUN_FONT_STATE
1367 * \li Action: Returns the info about the current font.
1368 * \li Syntax: font-state
1371 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
1374 * \var lyx::FuncCode lyx::LFUN_CITATION_INSERT
1375 * \li Action: Inserts citation from loaded citation database.
1376 * \li Syntax: citation-insert [<KEY>[|<TEXT_BEFORE>]]
1377 * \li Params: <KEY>: Citation (shortcut listed in available citations). \n
1378 <TEXT_BEFORE>: text which should appear before citation.
1379 * \li Origin: AAS, 97-02-23
1382 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
1384 * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_ADD
1385 * \li Action: Adds database, which will be used for bibtex citations.
1386 * \li Notion: Databases are added to the first BibTeX inset
1387 (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
1388 * \li Syntax: bibtex-database-add <DATABASE-NAME>
1389 * \li Origin: Ale, 30 May 1997
1392 { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit },
1394 * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_DEL
1395 * \li Action: Adds database, which will be used for bibtex citations.
1396 * \li Notion: Databases are deleted from the first BibTeX inset
1397 (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
1398 * \li Syntax: bibtex-database-del <DATABASE-NAME>
1399 * \li Origin: Ale, 30 May 1997
1402 { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
1405 * \var lyx::FuncCode lyx::LFUN_LAYOUT
1406 * \li Action: Sets the layout (that is, environment) for the current paragraph.
1407 * \li Syntax: layout <LAYOUT>
1408 * \li Params: <LAYOUT>: the layout to use
1411 { LFUN_LAYOUT, "layout", Noop, Layout },
1413 * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH
1414 * \li Action: Launches the paragraph settings dialog.
1415 * \li Syntax: layout-paragraph
1418 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
1420 * \var lyx::FuncCode lyx::LFUN_LAYOUT_TABULAR
1421 * \li Action: Launches the tabular settings dialog.
1422 * \li Syntax: layout-tabular
1423 * \li Origin: Jug, 31 Jul 2000
1426 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
1428 * \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE
1429 * \li Action: Displays list of layout choices.
1430 * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
1431 dropbox allowing for choice of layout.
1432 * \li Syntax: drop-layouts-choice
1435 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
1437 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
1438 * \li Action: Clears the module list.
1439 * \li Notion: Clears the list of included modules for the current buffer.
1440 * \li Syntax: layout-modules-clear
1441 * \li Origin: rgh, 25 August 2007
1444 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", NoInternal, Layout },
1446 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULE_ADD
1447 * \li Action: Adds a module.
1448 * \li Notion: Adds a module to the list of included modules for the current buffer.
1449 * \li Syntax: layout-module-add <MODULE>
1450 * \li Params: <MODULE>: the module to be added
1451 * \li Origin: rgh, 25 August 2007
1454 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", NoInternal, Layout },
1456 * \var lyx::FuncCode lyx::LFUN_LAYOUT_RELOAD
1457 * \li Action: Reloads layout information.
1458 * \li Notion: Reloads all layout information for the current buffer from disk, thus
1459 recognizing any changes that have been made to layout files on the fly.
1460 This is intended to be used only by layout developers and should not be
1461 used when one is trying to do actual work.
1462 * \li Syntax: layout-reload
1463 * \li Origin: rgh, 3 September 2007
1466 { LFUN_LAYOUT_RELOAD, "layout-reload", NoInternal, Layout },
1468 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
1469 * \li Action: Sets the text class for the current buffer.
1470 * \li Syntax: textclass-apply <TEXTCLASS>
1471 * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
1472 the filename, minus the ".layout" extension.
1475 { LFUN_TEXTCLASS_APPLY, "textclass-apply", NoInternal, Layout },
1477 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
1478 * \li Action: Loads information for a textclass from disk.
1479 * \li Syntax: textclass-load <TEXTCLASS>
1480 * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
1481 the filename, minus the ".layout" extension.
1484 { LFUN_TEXTCLASS_LOAD, "textclass-load", NoInternal, Layout },
1487 * \var lyx::FuncCode lyx::LFUN_MARK_OFF
1488 * \li Action: Disable selecting of text-region.
1489 * \li Syntax: mark-off
1492 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
1494 * \var lyx::FuncCode lyx::LFUN_MARK_ON
1495 * \li Action: Enable selecting of text-region.
1496 * \li Notion: After enabling you can simply move arrow keys to get selected region.
1497 * \li Syntax: mark-on
1500 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
1502 * \var lyx::FuncCode lyx::LFUN_MARK_TOGGLE
1503 * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
1504 * \li Syntax: mark-toggle
1505 * \li Origin: Andre, May 5 2006
1508 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
1511 * \var lyx::FuncCode lyx::LFUN_MATH_DELIM
1512 * \li Action: Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
1513 * \li Syntax: math-delim [<LEFT>] [<RIGHT>]
1514 * \li Params: <LEFT/RIGHT>: Delimiters to be used. Each delimiter can be specified by
1515 either a LaTeX name or a valid character.
1516 ( is the default letter.
1517 * \li Sample: math-delim { rangle
1518 * \li Origin: Alejandro, 18 Jun 1996
1521 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
1523 * \var lyx::FuncCode lyx::LFUN_MATH_BIGDELIM
1524 * \li Action: Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
1525 * \li Syntax: math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
1526 * \li Params: <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r \n
1527 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
1528 * \li Sample: math-bigdelim "Bigl" "\Downarrow" "Bigr" "\}"
1529 * \li Origin: Enrico & Georg, 7 May 2006
1532 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
1534 * \var lyx::FuncCode lyx::LFUN_MATH_DISPLAY
1535 * \li Action: Creates a new displayed equation in text mode.
1536 Toggles inlined/display formula in math mode.
1537 * \li Syntax: math-display [<ARG>]
1538 * \li Params: <ARG>: this argument will be passed to #LFUN_MATH_INSERT when creating
1539 new equation from the text mode.
1540 * \li Origin: Alejandro, 18 Jun 1996
1543 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
1545 * \var lyx::FuncCode lyx::LFUN_MATH_INSERT
1546 * \li Action: Inserts math objects and symbols.
1547 * \li Syntax: math-insert <ARG>
1548 * \li Params: <ARG>: Symbol or LaTeX code to be inserted.
1549 * \li Notion: When <ARG> is a _single_ math inset with more than one cell
1550 (such as "x_y^z" or "\frac{x}{y}"), the content of cell(0) is
1551 replaced by the current selection (only works if the selection
1552 is in mathed). As an example, if "abc" is selected in mathed,
1553 "math-insert \frac{x}{y}" replaces "abc" with "\frac{abc}{y}",
1554 and "math-insert x_y^z" replaces "abc" with "abc_y^z".
1555 If nothing is selected (or the selection is not in mathed),
1556 math-insert works as expected.
1559 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
1561 * \var lyx::FuncCode lyx::LFUN_MATH_SUBSCRIPT
1562 * \li Action: Enters subscript expression in math expression.
1563 * \li Syntax: math-subscript
1564 * \li Origin: vermeer, 12 Dec 2001
1567 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
1569 * \var lyx::FuncCode lyx::LFUN_MATH_SUPERSCRIPT
1570 * \li Action: Enters subscript expression in math expression.
1571 * \li Syntax: math-superscript
1572 * \li Origin: vermeer, 12 Dec 2001
1575 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
1577 * \var lyx::FuncCode lyx::LFUN_MATH_LIMITS
1578 * \li Action: Toggles the position of the limits from above/below to the right
1579 side an vice versa in integral symbol, a limit, a summation, etc.
1580 * \li Notion: Put the cursor before the symbol with the limits and then invoke
1582 * \li Syntax: math-limits [<STATE>]
1583 * \li Params: <STATE>: limits|nolimits
1586 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
1588 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO
1589 * \li Action: Inserts a math macro definition at the cursor position in the text.
1590 * \li Syntax: math-macro <NAME> [<NARGS>] [def]
1591 * \li Params: <NAME>: The name of the macro, e.g. "mymacro".\n
1592 <NARGS>: The number of parameters of the macro. Default is 0.
1593 "def": Has no effect anymore, just for compatibility with former LyX versions.
1594 * \li Origin: ale, 10 May 1997; sts, 21 Dec 2007
1597 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
1599 * \var lyx::FuncCode lyx::LFUN_MATH_MUTATE
1600 * \li Action: Mutates the type of math inset to the newly selected one.
1601 * \li Syntax: math-mutate <TYPE>
1602 * \li Params: <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
1603 multline|gather|flalign
1604 * \li Origin: Andre, 23 May 2001
1607 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
1609 * \var lyx::FuncCode lyx::LFUN_MATH_SPACE
1610 * \li Action: Inserts space into math expression.
1611 * \li Notion: Use spacebar after entering this space to change type of space.
1612 * \li Syntax: math-space [<TYPE>] [<LEN>]
1613 * \li Params: <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace \n
1614 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad \n
1615 custom space: hspace \n
1616 "," used by default.\n
1617 Note that ! is equivalent to negthinspace, , = thinspace,
1618 : = medspace, and ; = thickspace.\n
1619 <LEN>: length for custom spaces (hspace)
1620 * \li Origin: Andre, 25 Jul 2001; sanda, 16 Jun 2008
1623 { LFUN_MATH_SPACE, "math-space", Noop, Math },
1625 * \var lyx::FuncCode lyx::LFUN_MATH_MATRIX
1626 * \li Action: Inserts a matrix.
1627 * \li Syntax: math-matrix <COLS> <ROWS> [<ALIGN>]
1628 * \li Params: <ALIGN>: Alignment is a word composed of the vertical alignment
1629 (b, c or t) (i.e. 1 char) and the horizontal alignments
1630 (l, c or r) (i.e. <COL> chars).
1631 * \li Sample: math-matrix 3 3 bccc
1634 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
1636 * \var lyx::FuncCode lyx::LFUN_MATH_AMS_MATRIX
1637 * \li Action: Inserts a matrix.
1638 * \li Syntax: math-matrix <COLS> <ROWS> [<DECORATION>]
1639 * \li Params: <DECORATION>: Decoration determines the LaTeX name of the matrix
1640 that should be created.
1641 * \li Sample: math-ams-matrix 3 3 bmatrix
1644 { LFUN_MATH_AMS_MATRIX, "math-ams-matrix", Noop, Math },
1646 * \var lyx::FuncCode lyx::LFUN_MATH_MODE
1647 * \li Action: In text mode enters math mode (i.e. puts math insets on the current
1648 cursor position), in math mode enters text mode inside math expression.
1649 * \li Notion: If there is some selected text, it puts the text inside created math box.
1650 * \li Syntax: math-mode [on|<ARG>]
1651 * \li Params: <ARG>: eventual argument (LaTeX code) is passed to #LFUN_MATH_INSERT .\n
1652 "on": allow only entering of math mode from text mode.
1653 * \li Origin: Alejandro, 4 Jun 1996
1656 { LFUN_MATH_MODE, "math-mode", Noop, Math },
1658 * \var lyx::FuncCode lyx::LFUN_REGEXP_MODE
1659 * \li Action: Enters regexp mode (i.e., puts regexp insets on the current
1660 cursor position). Used by the advanced search dialog.
1661 * \li Notion: If there is any selected text, then it is moved inside the created
1663 * \li Syntax: regexp-mode [<ARG>]
1664 * \li Params: <ARG>: eventual argument (regular expression).
1665 * \li Origin: Tommaso, 4 Oct 2008
1668 { LFUN_REGEXP_MODE, "regexp-mode", Noop, Math },
1670 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
1671 * \li Action: Toggles numbering of the current formula line.
1672 * \li Notion: Must be in display formula mode.
1673 * \li Syntax: math-number-line-toggle
1674 * \li Origin: Alejandro, 18 Jun 1996
1677 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
1679 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
1680 * \li Action: Toggles numbering/labeling of the current formula.
1681 * \li Notion: Must be in display formula mode.
1682 * \li Syntax: math-number-toggle
1683 * \li Origin: Alejandro, 4 Jun 1996
1686 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
1688 * \var lyx::FuncCode lyx::LFUN_MATH_EXTERN
1689 * \li Action: Calls external program and passes the current expression/equation
1690 as an argument for the calculation in the format appropriate to the
1692 * \li Notion: Selection can be used to determine the input for the external program.
1693 * \li Syntax: math-extern <LANG> [<COMMAND>]
1694 * \li Params: <LANG>: octave|maxima|maple|mathematica|script \n
1695 where "script" stands fot the external script (normalized
1696 expression will be passed)
1697 * \li Origin: Andre, 24 Apr 2001
1698 * \li Sample: math-extern maple simplify
1701 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
1703 * \var lyx::FuncCode lyx::LFUN_MATH_SIZE
1704 * \li Action: Changes arbitrarily the size used by math fonts inside a context.
1705 * \li Notion: Provides an interface to the LaTeX math mode font size commands.
1706 * \li Syntax: math-size <STYLE>
1707 * \li Params: <STYLE>: \displaystyle|\textstyle|\scriptstyle|\scriptscriptstyle
1708 * \li Origin: Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
1711 { LFUN_MATH_SIZE, "math-size", Noop, Math },
1713 * \var lyx::FuncCode lyx::LFUN_MATH_FONT_STYLE
1714 * \li Action: Changes the text style used in math.
1715 * \li Syntax: math-font-style <STYLE>
1716 * \li Params: <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf
1717 |textnormal|textrm|textsf|texttt|textbf|textmd|textit
1718 |textsc|textsl|textup
1719 * \li Origin: vfr, 9 jan 2009
1722 { LFUN_MATH_FONT_STYLE, "math-font-style", Noop, Math },
1724 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
1725 * \li Action: Unfold a Math Macro.
1726 * \li Notion: Unfold the Math Macro the cursor is in, i.e.
1728 * \li Syntax: math-macro-unfold
1729 * \li Origin: sts, 06 January 2008
1732 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
1734 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
1735 * \li Action: Fold a Math Macro.
1736 * \li Notion: Fold the Math Macro the cursor is in if it was
1737 unfolded, i.e. displayed as \foo before.
1738 * \li Syntax: math-macro-fold
1739 * \li Origin: sts, 06 January 2008
1742 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
1744 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
1745 * \li Action: Add a parameter.
1746 * \li Notion: Add a parameter to a Math Macro.
1747 * \li Params: <NUM>: The number of the parameter behind which the new one
1748 will be added (1 for the first, i.e. use 0 for add a
1749 parameter at the left), defaults to the last one.
1750 * \li Syntax: math-macro-add-param <NUM>
1751 * \li Origin: sts, 06 January 2008
1754 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
1756 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
1757 * \li Action: Remove the last parameter.
1758 * \li Notion: Remove the last parameter of a Math Macro and
1759 remove its value in all instances of the macro
1761 * \li Params: <NUM>: The number of the parameter to be deleted (1 for
1762 the first), defaults to the last one.
1763 * \li Syntax: math-macro-remove-param <NUM>
1764 * \li Origin: sts, 06 January 2008
1767 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
1769 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
1770 * \li Action: Append a greedy parameter.
1771 * \li Notion: Append a greedy parameter to a Math Macro which
1772 eats the following mathed cell in every instance of
1773 the macro in the buffer.
1774 * \li Syntax: math-macro-append-greedy-param
1775 * \li Origin: sts, 06 January 2008
1778 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
1780 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
1781 * \li Action: Remove a greedy parameter.
1782 * \li Notion: Remove a greedy parameter of a Math Macro and spit
1783 out the values of it in every instance of the macro
1784 in the buffer. If it is an optional parameter the [valud]
1786 * \li Syntax: math-macro-remove-greedy-param
1787 * \li Origin: sts, 06 January 2008
1790 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
1792 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
1793 * \li Action: Make a parameter optional.
1794 * \li Notion: Turn the first non-optional parameter of a Math Macro
1795 into an optional parameter with a default value.
1796 * \li Syntax: math-macro-make-optional
1797 * \li Origin: sts, 06 January 2008
1800 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
1802 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
1803 * \li Action: Make a parameter non-optional.
1804 * \li Notion: Turn the last optional parameter of a Math Macro
1805 into a non-optional parameter. The default value is
1806 remembered to be reused later if the user changes his mind.
1807 * \li Syntax: math-macro-make-nonoptional
1808 * \li Origin: sts, 06 January 2008
1811 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
1813 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
1814 * \li Action: Add an optional parameter.
1815 * \li Notion: Insert an optional parameter just behind the
1816 already existing optional parameters.
1817 * \li Syntax: math-macro-add-optional-param
1818 * \li Origin: sts, 06 January 2008
1821 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
1823 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
1824 * \li Action: Remove the last optional parameter.
1825 * \li Notion: Remove the last optional parameter of a Math Macro and
1826 remove it in all the instances of the macro in the buffer.
1827 * \li Syntax: math-macro-remove-optional-param
1828 * \li Origin: sts, 06 January 2008
1831 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
1833 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
1834 * \li Action: Add a greedy optional parameter.
1835 * \li Notion: Add a greedy optional parameter which eats the value
1836 from the following cells in mathed which are in the [value]
1838 * \li Syntax: math-macro-add-greedy-optional-param
1839 * \li Origin: sts, 06 January 2008
1842 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
1844 * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
1845 * \li Action: Only active in Math Macro definition.
1846 * \li Notion: Dummy function which is only active in a Math Macro definition.
1847 It's used to toggle the Math Macro toolbar if the cursor moves
1848 into a Math Macro definition.
1849 * \li Syntax: in-mathmacrotemplate
1850 * \li Origin: sts, 06 January 2008
1853 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
1856 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
1857 * \li Action: Moves the current paragraph downwards in the document.
1858 * \li Syntax: paragraph-move-down
1859 * \li Origin: Edwin, 8 Apr 2006
1862 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
1864 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
1865 * \li Action: Moves the current paragraph upwards in the document.
1866 * \li Syntax: paragraph-move-up
1867 * \li Origin: Edwin, 8 Apr 2006
1870 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
1873 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP
1874 * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1875 in upward direction.
1876 * \li Syntax: paragraph-up
1877 * \li Origin: Asger, 1 Oct 1996
1880 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
1882 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP_SELECT
1883 * \li Action: Move the cursor and select the text to the next paragraph (or
1884 begining of the current one) in upward direction.
1885 * \li Syntax: paragraph-up-select
1886 * \li Origin: Asger, 1 Oct 1996
1889 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
1891 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN
1892 * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1893 in downward direction.
1894 * \li Syntax: paragraph-down
1895 * \li Origin: Asger, 1 Oct 1996
1898 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
1900 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN_SELECT
1901 * \li Action: Move the cursor and select the text to the next paragraph (or
1902 begining of the current one) in downward direction.
1903 * \li Syntax: paragraph-down-select
1904 * \li Origin: Asger, 1 Oct 1996
1907 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
1909 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
1910 * \li Action: Jump to a paragraph given by its id number and optionally the
1911 desired position within the paragraph.
1912 * \li Notion: Note that id number of paragraph is not the sequential number of paragraph
1913 seen on the screen. Moreover the id is unique for all opened buffers (documents).
1914 * \li Syntax: paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
1915 * \li Params: <PAR_ID_NUMBER>: paragraph id \n
1916 <POSITION_IN_PAR>: desired position within the paragraph
1917 * \li Origin: Dekel, 26 Aug 2000
1920 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly | NoInternal, Edit },
1922 * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1923 * \li Action: Breaks the current paragraph at the current location.
1924 * \li Notion: Removes the selection.
1925 * \li Syntax: break-paragraph [<LAYOUT>]
1926 * \li Params: <LAYOUT>: "inverse" - decreases depth by one (or change layout
1927 to default layout) when the cursor is at the end of
1931 { LFUN_BREAK_PARAGRAPH, "break-paragraph", Noop, Edit },
1933 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
1934 * \li Action: Change paragraph settings.
1935 * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
1936 This function only modifies, and does not override, existing settings.
1937 Note that the "leftindent" indent setting is deprecated.
1938 * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
1939 * \li Params: <INDENT>: \noindent|\indent|\indent-toggle|\leftindent LENGTH\n
1940 <SPACING>: \paragraph_spacing default|single|onehalf|double|other SIZE \n
1941 <ALIGN>: \align block|left|right|center|default\n
1942 <OTHERS>: \labelwidthstring WIDTH|\start_of_appendix
1943 * \li Origin: rgh, Aug 15 2007
1946 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
1948 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
1949 * \li Action: Change paragraph settings.
1950 * \li Notion: Overwrite all nonspecified settings to the default ones.
1951 Use paragraph-params lfun if you don't want to overwrite others settings.
1952 * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
1953 * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
1954 * \li Origin: leeming, 30 Mar 2004
1957 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
1959 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UPDATE
1960 * \li Action: Updates the values inside the paragraph dialog from the paragraph.
1961 * \li Notion: This is internal LFUN, not to be used by users. Called internally
1962 by #LFUN_DIALOG_UPDATE.
1963 * \li Origin: leeming, 13 Mar 2003
1966 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
1969 * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
1970 * \li Action: Move the current group in the upward direction in the
1971 structure of the document.
1972 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1973 the whole substructure of the group.
1974 * \li Syntax: outline-up
1975 * \li Origin: Vermeer, 23 Mar 2006
1978 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
1980 * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
1981 * \li Action: Move the current group in the downward direction in the
1982 structure of the document.
1983 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1984 the whole substructure of the group.
1985 * \li Syntax: outline-down
1986 * \li Origin: Vermeer, 23 Mar 2006
1989 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
1991 * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
1992 * \li Action: Moves the current group in the downward direction in the
1993 hierarchy of the document structure.
1994 * \li Notion: Part -> Chapter -> Section -> etc.
1995 * \li Syntax: outline-in
1996 * \li Origin: Vermeer, 23 Mar 2006
1999 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
2001 * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
2002 * \li Action: Moves the current group in the upward direction in the
2003 hierarchy of the document structure.
2004 * \li Notion: Part <- Chapter <- Section <- etc.
2005 * \li Syntax: outline-out
2006 * \li Origin: Vermeer, 23 Mar 2006
2009 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
2012 * \var lyx::FuncCode lyx::LFUN_OUTLINE_DRAGMOVE
2013 * \li Action: Moves the document section associated with the specified
2014 heading to a specified location. Both the heading and the
2015 target paragraph are specified by the paragraph ID numbers.
2016 * \li Notion: The heading is a paragraph with style Part/Chapter/Section/
2017 etc. Id number of the paragraph is not the sequential number
2018 seen on the screen, but an internal number that is unique
2019 for all opened buffers (documents).
2020 * \li Syntax: outline-dragmove <PAR_ID_SECTION> <PAR_ID_DROP_POSITION>
2021 * \li Params: <PAR_ID_SECTION>: paragraph id of the section heading which
2023 <PAR_ID_DROP_POSITION>: the paragraph id where the section
2025 * \li Origin: Rob Oakes, 22 June 2009
2028 { LFUN_OUTLINE_DRAGMOVE, "outline-dragmove", Noop, Edit },
2031 * \var lyx::FuncCode lyx::LFUN_INSET_EDIT
2032 * \li Action: Edit the inset at cursor with an external application,
2033 if one is attributed.
2034 * \li Syntax: inset-edit [<INSET_PARAMS>]
2035 * \li Params: <INSET_PARAMS>: Parameters for the inset. \n
2036 Currently only the filename will be considered.
2037 * \li Origin: JSpitzm, 27 Apr 2006
2041 { LFUN_INSET_EDIT, "inset-edit", ReadOnly, Edit },
2044 * \var lyx::FuncCode lyx::LFUN_TABULAR_INSERT
2045 * \li Action: Inserts table into the document.
2046 * \li Syntax: tabular-insert [<ROWS> <COLUMNS>]
2047 * \li Params: In case no arguments are given show insert dialog.
2048 * \li Origin: Jug, 12 Apr 2000
2051 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
2053 * \var lyx::FuncCode lyx::LFUN_TABULAR_FEATURE
2054 * \li Action: Sets various features to the table/cell on the current cursor position.
2055 * \li Notion: Various math-environment features are handled here as well, e.g.
2056 add-vline-left/right for the Grid/Array environment
2057 * \li Syntax: tabular-feature <FEATURE> [<ARG>]
2058 * \li Params: <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|copy-column|
2059 toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
2060 align-left|align-right|align-center|align-block|valign-top|valign-bottom|
2061 valign-middle|longtabular-align-left|longtabular-align-center|
2062 longtabular-align-right|m-align-left|m-align-right|m-align-center|
2063 m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|set-all-lines|
2064 unset-all-lines|set-longtabular|unset-longtabular|set-pwidth|set-mpwidth|
2065 set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|
2066 set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|
2067 unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|
2068 set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
2069 set-special-column|set-special-multi|set-booktabs|unset-booktabs|
2070 set-top-space|set-bottom-space|set-interline-space|set-border-lines|
2071 tabular-valign-top|tabular-valign-middle|tabular-valign-bottom \n
2072 <ARG>: additional argument for some commands, use debug mode to explore its values.
2073 * \li Origin: Jug, 28 Jul 2000
2076 { LFUN_TABULAR_FEATURE, "tabular-feature", Noop, Edit },
2078 * \var lyx::FuncCode lyx::LFUN_CELL_BACKWARD
2079 * \li Action: Moves the cursor to the previous cell inside the table.
2080 * \li Syntax: cell-backward
2081 * \li Origin: Jug, 22 May 2000
2084 { LFUN_CELL_BACKWARD, "cell-backward", Noop, Edit },
2086 * \var lyx::FuncCode lyx::LFUN_CELL_FORWARD
2087 * \li Action: Moves the cursor to the next cell inside the table.
2088 * \li Syntax: cell-forward
2091 { LFUN_CELL_FORWARD, "cell-forward", Noop, Edit },
2093 * \var lyx::FuncCode lyx::LFUN_CELL_SPLIT
2094 * \li Action: Splits cell and shifts right part to the next cell (inside the math grid).
2095 * \li Syntax: cell-split
2096 * \li Origin: Ale, 15 May 1997
2099 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
2102 * \var lyx::FuncCode lyx::LFUN_VC_REGISTER
2103 * \li Action: Register the document as an file inside version control system (RCS, CVS).
2104 * \li Notion: File is registered inside cvs, svn or rcs repository acording to the existence
2105 of cvs/svn/rcs entries in the document's directory. \n
2106 See LyX Additional Features Manual (Version Control Chapter) for additional
2108 * \li Syntax: vc-register
2109 * \li Origin: Lgb, 1 Jul 1997
2112 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
2114 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_IN
2115 * \li Action: Checks-in/commits the changes of the registered file to the repository.
2116 * \li Notion: In RCS case this also unlocks the file.
2117 * \li Syntax: vc-check-in
2118 * \li Origin: Lgb, 1 Jul 1997
2121 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
2123 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_OUT
2124 * \li Action: Checks-out the document for edit (and locks it for RCS).
2125 * \li Notion: This is implemented only for RCS and SVN, not CVS.
2126 * \li Syntax: vc-check-out
2127 * \li Origin: Lgb, 1 Jul 1997
2130 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
2132 * \var lyx::FuncCode lyx::LFUN_VC_REVERT
2133 * \li Action: Reverts the document to the last check-in/commit in VCS.
2134 * \li Syntax: vc-revert
2135 * \li Origin: Lgb, 1 Jul 1997
2138 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
2140 * \var lyx::FuncCode lyx::LFUN_VC_UNDO_LAST
2141 * \li Action: Undo last check-in.
2142 * \li Notion: This is currently implemented only for RCS.
2143 * \li Syntax: vc-check-out
2144 * \li Origin: Lgb, 1 Jul 1997
2147 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
2149 * \var lyx::FuncCode lyx::LFUN_VC_COMMAND
2150 * \li Action: Executes external command. This command is intended to support
2151 additional VCS commands.
2152 * \li Syntax: vc-command <FLAG> <PATH> <COMMAND>
2153 * \li Params: <FLAG>: Flags for the command can be combined together.\n
2154 U - dUmmy - no flags \n
2155 D - Doc - need document loaded to proceed \n
2156 I - dIrty - mark document dirty \n
2157 R - Reload - ensure that the document is saved and reload it after command execution \n
2158 M - Message - ask for input string (commit message)\n
2159 <PATH>: path where to start. $$p will be replaced by the current document path.\n
2160 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current document/path/message.
2161 * \li Sample: vc-command DR $$p "svn up"
2162 * \li Origin: sanda, 13 Jan 2009
2165 { LFUN_VC_COMMAND, "vc-command", NoBuffer | ReadOnly, System },
2167 * \var lyx::FuncCode lyx::LFUN_VC_LOCKING_TOGGLE
2168 * \li Action: Toggles the locking property of the edited file.
2169 * \li Notion: This is currently implemented only for SVN.
2170 * \li Syntax: vc-locking-toggle
2171 * \li Origin: sanda, 25 Jun 2009
2174 { LFUN_VC_LOCKING_TOGGLE, "vc-locking-toggle", ReadOnly, System },
2176 * \var lyx::FuncCode lyx::LFUN_VC_REPO_UPDATE
2177 * \li Action: Update the local archive directory in which resides
2178 the current document with the remote repository.
2179 * \li Notion: This is currently implemented only for SVN.
2180 * \li Syntax: vc-repo-update
2181 * \li Origin: sanda, 16 Oct 2009
2184 { LFUN_VC_REPO_UPDATE, "vc-repo-update", ReadOnly, System },
2187 * \var lyx::FuncCode lyx::LFUN_CHANGES_TRACK
2188 * \li Action: Toggles change tracking to on/off.
2189 * \li Syntax: changes-track
2190 * \li Origin: levon, 1 Oct 2002
2193 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
2195 * \var lyx::FuncCode lyx::LFUN_CHANGES_OUTPUT
2196 * \li Action: Toggles showing of change tracking in typesetted output.
2197 * \li Syntax: changes-output
2198 * \li Origin: jspitzm, 21 Jan 2005
2201 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
2203 * \var lyx::FuncCode lyx::LFUN_CHANGE_NEXT
2204 * \li Action: Moves the cursor to the position of the next change
2205 of the change tracking records.
2206 * \li Syntax: change-next
2207 * \li Origin: schmitt, 4 Oct 2006
2210 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
2212 * \var lyx::FuncCode lyx::LFUN_CHANGE_PREVIOUS
2213 * \li Action: Moves the cursor to the position of the previous change
2214 of the change tracking records.
2215 * \li Syntax: change-previous
2216 * \li Origin: vfr, 4 Apr 2009
2219 { LFUN_CHANGE_PREVIOUS, "change-previous", ReadOnly, Edit },
2221 * \var lyx::FuncCode lyx::LFUN_CHANGES_MERGE
2222 * \li Action: Open change tracking dialog for merging and moves the cursor
2223 to the position of the next change.
2224 * \li Syntax: changes-merge
2225 * \li Origin: Levon, 16 Oct 2002
2228 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
2230 * \var lyx::FuncCode lyx::LFUN_CHANGE_ACCEPT
2231 * \li Action: Accepts tracked change inside the selection.
2232 * \li Syntax: change-accept
2233 * \li Origin: Levon, 16 Oct 2002
2236 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
2238 * \var lyx::FuncCode lyx::LFUN_CHANGE_REJECT
2239 * \li Action: Rejects tracked change inside the selection.
2240 * \li Syntax: change-accept
2241 * \li Origin: Levon, 16 Oct 2002
2244 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
2246 * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_ACCEPT
2247 * \li Action: Accepts all tracked changes in the document.
2248 * \li Syntax: all-changes-accept
2249 * \li Origin: Levon, 16 Oct 2002
2252 { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
2254 * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_REJECT
2255 * \li Action: Rejects all tracked changes in the document.
2256 * \li Notion: Reject does not work recursively; the user may have to repeat the operation.
2257 * \li Syntax: all-changes-reject
2258 * \li Origin: Levon, 16 Oct 2002
2261 { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
2264 * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
2265 * \li Action: Apply data for an inset.
2266 * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
2267 be applied. This is either changed to #LFUN_INSET_MODIFY or
2268 #LFUN_INSET_INSERT depending on the context where it is called.
2269 * \li Syntax: inset-apply <ARGS>
2270 * \li Params: See #LFUN_INSET_INSERT .
2273 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
2275 * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE
2276 * \li Action: Dissolve the current inset into text.
2277 * \li Syntax: inset-dissolve [<INSET>]
2278 * \li Params: <INSET>: this can be used to make sure the right kind of inset
2279 is dissolved. For example "dissolve" entry in the charstyles
2280 sub-menu should only dissolve the charstyle inset, even if the
2281 cursor is inside several nested insets of different type.\n
2282 For values see #lyx::InsetLayout::lyxtype_ .
2283 * \li Origin: JSpitz, 7 Aug 2006
2286 { LFUN_INSET_DISSOLVE, "inset-dissolve", AtPoint, Edit },
2288 * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
2289 * \li Action: Insert new inset (type given by the parameters).
2290 * \li Syntax: inset-insert <INSET> <ARGS>
2291 * \li Params: <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics|
2292 hyperlink|include|index|label|nomencl|vspace|ref|toc>\n
2293 <ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
2294 * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
2295 where <label name> is the name of the referenced label and
2296 <Format> is one of the following: \n
2297 ref -- <reference> \n
2298 eqref -- (<reference>) \n
2299 pageref -- <page> \n
2300 vpageref -- on <page> \n
2301 vref -- <reference> on <page> \n
2302 prettyref -- Formatted reference
2305 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
2307 * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
2308 * \li Action: Modify existing inset.
2309 * \li Notion: Used for bibitem, bibtex, box, branch, command, ert, external,
2310 floats, graphics, include, label, listings, note,
2311 phantom, ref, space, tabular, vspace, wrap insets.
2312 * \li Syntax: inset-modify <INSET> <ARGS>
2313 * \li Params: See #LFUN_INSET_INSERT for further details.
2316 { LFUN_INSET_MODIFY, "", Noop, Hidden },
2318 * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_MODIFY
2319 * \li Action: Modify the inset at cursor position, if there is one.
2320 * \li Notion: Used for bibitem, bibtex, box, branch, command, ert, external,
2321 floats, graphics, include, label, listings, note,
2322 phantom, ref, space, tabular, vspace, wrap insets.
2323 * \li Syntax: next-inset-modify <INSET> <ARGS>
2324 * \li Syntax: next-inset-modify changetype <TYPE>
2325 * \li Params: See #LFUN_INSET_INSERT for further details.
2326 * \li Origin: JSpitzm, 23 Mar 2008
2329 { LFUN_NEXT_INSET_MODIFY, "next-inset-modify", Noop, Edit },
2331 * \var lyx::FuncCode lyx::LFUN_INSET_DIALOG_UPDATE
2332 * \li Action: Updates the values inside the dialog from the inset.
2333 * \li Notion: This is internal LFUN, not to be used by users. Called internally
2334 by #LFUN_DIALOG_UPDATE
2335 * \li Params: <DIALOG-NAME>
2336 * \li Origin: leeming, 25 Feb 2003
2339 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
2341 * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
2342 * \li Action: Open the inset's properties dialog.
2343 * \li Notion: Used for bibitem, bibtex, box, branch, citation, ert, external,
2344 float, graphics, href, include, index, index_print, label, listings,
2345 note, phantom, ref, space, tabular, vspace, wrap insets.
2346 * \li Syntax: inset-settings <INSET>
2347 * \li Params: <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|
2348 graphics|href|include|index|index_print|label|listings|
2349 note|phantom|ref|space|tabular|vspace|wrap>.
2352 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly | AtPoint, Edit },
2354 * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
2355 * \li Action: Toggles the collapsable inset at cursor position,
2356 or the inset we are currently in.
2357 * \li Syntax: inset-toggle [<ARG>]
2358 * \li Params: <ARG>: <open|close|toggle|assign>. \n
2359 open/close/toggle are for collapsable insets. toggle is used when no argument is given.\n
2360 assign synchronize the branch-inset with activation status of the branch.
2361 Used for global toggling when changed activation.
2362 * \li Origin: lasgouttes, 19 Jul 2001
2365 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly | AtPoint, Edit },
2367 * \var lyx::FuncCode lyx::LFUN_ALL_INSETS_TOGGLE
2368 * \li Action: Toggles (open/closes) all collapsable insets (of a given type) in the document.
2369 * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
2370 * \li Syntax: all-insets-toggle [<STATE>] [<INSET>]
2371 * \li Params: <STATE>: <toggle|open|close|assign> default: toggle \n
2372 <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all insets
2373 * \li Origin: leeming, 30 Mar 2004
2376 { LFUN_ALL_INSETS_TOGGLE, "all-insets-toggle", ReadOnly, Edit },
2378 * \var lyx::FuncCode lyx::LFUN_GRAPHICS_RELOAD
2379 * \li Action: Reloads the image if necessary.
2380 * \li Syntax: graphics-reload
2381 * \li Origin: vfr, 10 Aug 2009
2384 { LFUN_GRAPHICS_RELOAD, "graphics-reload", ReadOnly | AtPoint, Edit },
2386 * \var lyx::FuncCode lyx::LFUN_SET_GRAPHICS_GROUP
2387 * \li Action: Set the group for the graphics inset on the cursor position.
2388 * \li Syntax: set-graphics-group [<GROUP>]
2389 * \li Params: <GROUP>: Id for an existing group. In case the Id is an empty string,
2390 the graphics inset is removed from the current group.
2391 * \li Origin: sanda, 6 May 2008
2394 { LFUN_SET_GRAPHICS_GROUP, "set-graphics-group", Noop, Edit },
2397 * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
2398 * \li Action: Moves the cursor out of the current slice, going forward.
2399 * \li Notion: Cursor movement within an inset may be different than cursor
2400 movement in the surrounding text. This action should be called
2401 automatically by the cursor movement within the inset, when
2402 movement within the inset has ceased (reached the end of the
2403 last paragraph, for example), in order to move correctly
2404 back into the surrounding text.
2407 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
2409 * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
2410 * \li Action: Moves the cursor out of the current slice, going backwards.
2411 * \li Notion: See also #LFUN_FINISHED_FORWARD.
2414 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
2416 * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
2417 * \li Action: Moves the cursor out of the current slice, going right.
2418 * \li Notion: See also #LFUN_FINISHED_FORWARD
2421 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
2423 * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
2424 * \li Action: Moves the cursor out of the current slice, going left.
2425 * \li Notion: See also #LFUN_FINISHED_FORWARD.
2428 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
2431 * \var lyx::FuncCode lyx::LFUN_LANGUAGE
2432 * \li Action: Set language from the current cursor position.
2433 * \li Syntax: language <LANG>
2434 * \li Params: <LANG>: Requested language. Look in lib/languages for
2436 * \li Origin: Dekel, 2 Mar 2000
2439 { LFUN_LANGUAGE, "language", Noop, Edit },
2442 * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
2443 * \li Action: Goto a label.
2444 * \li Syntax: label-goto [<LABEL>]
2445 * \li Params: <LABEL>: Requested label. If no label is given and reference
2446 is on cursor position, Bookmark 0 is saved and
2447 cursor moves to the position of referenced label.
2448 * \li Origin: Ale, 6 Aug 1997
2451 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
2453 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT
2454 * \li Action: Inserts label to text or displayed formula.
2455 * \li Syntax: label-insert [<LABEL>]
2456 * \li Params: <LABEL>: Requested label. If no label is given dialog requesting
2457 name will be opened.
2460 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
2462 * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
2463 * \li Action: Go to the next label or cross-reference.
2464 * \li Syntax: reference-next
2465 * \li Origin: Dekel, 14 Jan 2001
2468 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
2471 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
2472 * \li Action: Moves the cursor to the numbered bookmark, opening the file
2473 if necessary. Note that bookmarsk are saved per-session, not
2475 * \li Notion: Bookmark 0 has a special purpose. It is automatically set \n
2476 1. to the paragraph you are currently editing \n
2477 2. to the paragraph from where you are jumping to the last-edited
2478 position (jump-back feature) \n
2479 3. when jumping from crossreference to the requested label by
2481 * \li Syntax: bookmark-goto <NUMBER>
2482 * \li Params: <NUMBER>: the number of the bookmark to restore.
2483 * \li Origin: Dekel, 27 January 2001
2486 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
2488 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
2489 * \li Action: Save a bookmark.
2490 * \li Notion: Saves a numbered bookmark to the sessions file. The number
2491 must be between 1 and 9, inclusive. Note that bookmarks are
2492 saved per-session, not per file.
2493 * \li Syntax: bookmark-save <NUMBER>
2494 * \li Params: <NUMBER>: the number of the bookmark to save.
2495 * \li Origin: Dekel, 27 January 2001
2498 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
2500 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
2501 * \li Action: Clears the list of saved bookmarks.
2502 * \li Syntax: bookmark-clear
2503 * \li Origin: bpeng, 31 October 2006
2506 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
2509 * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
2510 * \li Action: Open the given help file according to the language setting.
2511 * \li Syntax: help-open <FILE>[.lyx]
2512 * \li Params: <FILE>: any document from (/usr/share/)doc directory.
2513 * \li Origin: Jug, 27 Jun 1999
2516 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
2518 * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
2519 * \li Action: Terminates the current LyX instance.
2520 * \li Notion: Terminates the current LyX instance, asking whether to save
2521 modified documents, etc.
2522 * \li Syntax: lyx-quit
2525 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
2527 * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
2528 * \li Action: Toggles visibility of a given toolbar between on/off/auto.
2529 * \li Notion: Skipping "auto" when allowauto is false.
2530 * \li Syntax: toolbar-toggle <NAME> [allowauto]
2531 * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|
2532 minibuffer|review|view/update|math_panels|vcs
2533 * \li Origin: Edwin, 21 May 2007
2536 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
2538 * \var lyx::FuncCode lyx::LFUN_MENU_OPEN
2539 * \li Action: Opens the menu given by its name.
2540 * \li Syntax: menu-open <NAME>
2541 * \li Params: <NAME>: menu name. See various .inc files in lib/ui for candidates.
2544 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
2546 * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
2547 * \li Action: Various UI visibility-toggling actions.
2548 * \li Syntax: ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
2549 * \li Params: statusbar : Toggle visibility of the statusbar.\n
2550 menubar : Toggle visibility of the menubar.\n
2551 scrollbar : Toggle visibility of the scrollbar.\n
2552 frame : Toggle visibility of the frames around editing window.\n
2553 fullscreen : Toggle fullscreen mode. This also covers calling the
2554 previous functions. However #LFUN_TOOLBAR_TOGGLE for the
2555 custom tweaks of the toolbars should be used.
2556 * \li Origin: sanda, 9 Feb 2007
2559 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
2562 * \var lyx::FuncCode lyx::LFUN_WINDOW_NEW
2563 * \li Action: Creates new empty LyX window.
2564 * \li Notion: Already opened documents from the previous window can be found under View menu.
2565 * \li Syntax: window-new [<GEOMETRY>]
2566 * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently
2567 accepted only on Windows platform.
2568 * \li Origin: Abdel, 21 Oct 2006
2571 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
2573 * \var lyx::FuncCode lyx::LFUN_WINDOW_CLOSE
2574 * \li Action: Closes the current LyX window.
2575 * \li Syntax: window-close
2576 * \li Origin: Abdel, 23 Oct 2006
2579 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
2582 * \var lyx::FuncCode lyx::LFUN_SPLIT_VIEW
2583 * \li Action: Creates another split view of current buffer.
2584 * \li Notion: All split views act in the same way indpendently.
2585 * \li Syntax: split-view <vertical|horizontal>
2586 * \li Params: horizontal : The work areas are laid out side by side.\n
2587 vertical : The work areas laid out vertically.
2588 * \li Origin: Abdel, 20 Feb 2008
2591 { LFUN_SPLIT_VIEW, "split-view", ReadOnly, Buffer },
2594 * \var lyx::FuncCode lyx::LFUN_CLOSE_TAB_GROUP
2595 * \li Action: Close the current tab group.
2596 * \li Notion: This only closes the work areas, not the buffer themselves.
2597 The still opened buffers can be visualized in another tab group.
2598 * \li Syntax: close-tab-group
2599 * \li Origin: Abdel, 21 Feb 2008
2602 { LFUN_CLOSE_TAB_GROUP, "close-tab-group", ReadOnly, Buffer },
2604 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW
2605 * \li Action: Shows hidden dialog or create new one for a given function/inset settings etc.
2606 * \li Syntax: dialog-show <NAME> [<DATA>]
2607 * \li Params: <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|\n
2608 compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|\n
2609 graphics|href|include|index|index_print|info|label|listings|log|mathdelimiter|\n
2610 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|\n
2611 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|\n
2612 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL> \n
2613 <SPECIAL>: latexlog|vclog \n
2614 <DATA>: data, usually settings for the given dialog. Use debug mode for the
2616 * \li Origin: leeming, 17 Jun 2003
2619 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
2621 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW_NEW_INSET
2622 * \li Action: Shows hidden dialog or create new one for a given inset settings etc.
2623 * \li Notion: Internally uses #LFUN_DIALOG_SHOW with processed data for a given inset.
2624 * \li Syntax: dialog-show-new-inset <NAME> [<DATA>]
2625 * \li Params: See #LFUN_DIALOG_SHOW .
2626 * \li Origin: leeming, 25 Feb 2003
2629 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
2631 * \var lyx::FuncCode lyx::LFUN_DIALOG_UPDATE
2632 * \li Action: Updates the dialog values from the inset/paragraph/document.
2633 * \li Syntax: dialog-update <NAME>
2634 * \li Params: <NAME>: paragraph|prefs|<INSET> \n
2636 * \li Origin: leeming, 25 Feb 2003
2639 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
2641 * \var lyx::FuncCode lyx::LFUN_DIALOG_HIDE
2642 * \li Action: Hides showed dialog. Counterpart to #LFUN_DIALOG_SHOW .
2643 * \li Syntax: dialog-hide <NAME>
2644 * \li Params: See #LFUN_DIALOG_SHOW .
2645 * \li Origin: leeming, 25 Feb 2003
2648 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
2650 * \var lyx::FuncCode lyx::LFUN_DIALOG_TOGGLE
2651 * \li Action: Toggles dialog between showed/hidden state.
2652 * \li Notion: Internally uses #LFUN_DIALOG_SHOW , #LFUN_DIALOG_HIDE .
2653 * \li Syntax: dialog-toggle <NAME> [<DATA>]
2654 * \li Params: See #LFUN_DIALOG_SHOW .
2655 * \li Origin: JSpitzm, 30 Apr 2007
2658 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
2660 * \var lyx::FuncCode lyx::LFUN_DIALOG_DISCONNECT_INSET
2661 * \li Action: Closes opened connection to opened inset.
2662 * \li Notion: Connection is used for apply functions.
2663 * \li Syntax: dialog-disconnect-inset <INSET-NAME>
2664 * \li Origin: leeming, 25 Feb 2003
2667 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
2670 * \var lyx::FuncCode lyx::LFUN_MOUSE_PRESS
2671 * \li Action: This function is called when mouse button is pressed (inside workarea).
2672 Action depends on the context.
2673 * \li Notion: This is internal LFUN, not to be used by users.
2674 * \li Origin: Andre, 9 Aug 2002
2677 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
2679 * \var lyx::FuncCode lyx::LFUN_MOUSE_DOUBLE
2680 * \li Action: This function is called when double click on mouse button is
2681 pressed (inside workarea). Action depends on the context.
2682 * \li Notion: This is internal LFUN, not to be used by users.
2683 * \li Origin: Andre, 9 Aug 2002
2686 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
2688 * \var lyx::FuncCode lyx::LFUN_MOUSE_TRIPLE
2689 * \li Action: This function is called when triple click on mouse button is
2690 pressed (inside workarea). Action depends on the context.
2691 * \li Notion: This is internal LFUN, not to be used by users.
2692 * \li Origin: Andre, 9 Aug 2002
2695 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
2697 * \var lyx::FuncCode lyx::LFUN_MOUSE_MOTION
2698 * \li Action: This function is called when mouse cursor is moving over the text.
2699 Action depends on the context.
2700 * \li Notion: This is internal LFUN, not to be used by users.
2701 * \li Origin: Andre, 9 Aug 2002
2704 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
2706 * \var lyx::FuncCode lyx::LFUN_MOUSE_RELEASE
2707 * \li Action: This function is called when mouse button is released (inside workarea).
2708 Action depends on the context.
2709 * \li Notion: This is internal LFUN, not to be used by users.
2710 * \li Origin: Andre, 9 Aug 2002
2713 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
2716 * \var lyx::FuncCode lyx::LFUN_KEYMAP_OFF
2717 * \li Action: Turn off the loaded keyboard map.
2718 * \li Syntax: keymap-off
2721 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
2723 * \var lyx::FuncCode lyx::LFUN_KEYMAP_PRIMARY
2724 * \li Action: Turn on the primary keyboard map.
2725 * \li Notion: Maps were widely used in past, when X-windows didn't have nowadays
2726 keyboard support. They can be still used to maintain uniform keyboard
2727 layout across the various plaforms.\n
2728 The language is to be set in the Preferences dialog.
2729 * \li Syntax: keymap-primary
2732 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
2734 * \var lyx::FuncCode lyx::LFUN_KEYMAP_SECONDARY
2735 * \li Action: Turn on the secondary keyboard map.
2736 * \li Syntax: keymap-secondary
2739 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
2741 * \var lyx::FuncCode lyx::LFUN_KEYMAP_TOGGLE
2742 * \li Action: Toggles keyboard maps (first/second/off).
2743 * \li Syntax: keymap-toggle
2744 * \li Origin: leeming, 30 Mar 2004
2747 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
2750 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_LAYOUT
2751 * \li Action: Returns the current layout (that is environment) name
2752 on the cursor position.
2753 * \li Syntax: server-get-layout
2756 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
2758 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_FILENAME
2759 * \li Action: Returns path and file name of the currently edited document.
2760 * \li Syntax: server-get-filename
2763 { LFUN_SERVER_GET_FILENAME, "server-get-filename", ReadOnly, System },
2765 * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
2766 * \li Action: Sets the cursor position based on the row number of generated TeX file.
2767 * \li Notion: This can be useful for DVI inverse-search or detection of the problematic
2768 line from LaTeX compilation. Note that before this function can be used
2769 export to LaTeX output must occur (in order to map the row numbers).
2770 * \li Syntax: server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
2771 * \li Params: <FILE>: the filename. Environment variables are expanded in the path.
2772 In case this LFUN does not work make sure you are giving correct
2774 If the file is located inside LyX temporary directory it will be
2775 mapped back into the appropriate opened buffer (e.g. for the case
2776 of generated .tex file).
2777 .ext: extensions will be automatically replaced by .lyx.
2778 <ROW_NUMBER> The row number of the LaTeX file to which to go.
2779 * \li Origin: Edmar, 23 Dec 1998
2782 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly, System },
2784 * \var lyx::FuncCode lyx::LFUN_SERVER_NOTIFY
2785 * \li Action: Sends notify message about the last key-sequence to client.
2786 * \li Notion: This can be used to grab last key-sequence used inside the LyX window.
2787 See also Debug extensions section in Additional features manual.
2788 * \li Syntax: server-notify
2791 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
2793 * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
2794 * \li Action: Sets the cursor position based on the editing area coordinates
2795 (similar as clicking on that point with left mouse button).
2796 * \li Syntax: server-set-xy <X> <Y>
2799 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
2801 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
2802 * \li Action: Returns the coordinates of cursor position in the editing area.
2803 * \li Syntax: server-get-xy
2806 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
2809 * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
2810 * \li Action: Generates the code (literate programming).
2811 * \li Notion: Latex file with extension \literate_extension is generated.
2812 Then LyX invokes \build_command (with a default of``make'') to generate the code and
2813 \build_error_filter to process the compilation error messages. \n
2814 In case you want to process your literate file with a script, or some other program,
2815 just insert in your lyxrc file an entry with:\n
2816 \build_command "my_script my_arguments" \n
2817 The \build_error_filter differs from the \literate_error_filter only in that the
2818 former will identify error messages from your compiler.
2819 * \li Syntax: build-program
2822 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
2825 * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
2826 * \li Action: Saves the current buffer to a temporary file.
2827 * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
2828 is called automatically by LyX, to "autosave" the current buffer.
2829 * \li Syntax: buffer-auto-save
2832 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
2834 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHILD_OPEN
2835 * \li Action: Loads the given child document.
2836 * \li Notion: The current document is treated as a parent.
2837 * \li Syntax: buffer-child-open <FILE>
2838 * \li Params: <FILE>: Filename of the child. The directory of the parent is assumed by default.
2839 * \li Origin: Ale, 28 May 1997
2842 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
2844 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHKTEX
2845 * \li Action: Runs chktex for the current document.
2846 * \li Syntax: buffer-chktex
2847 * \li Origin: Asger, 30 Oct 1997
2850 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
2852 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
2853 * \li Action: Toggles compression of the current document on/off.
2854 * \li Syntax: buffer-toggle-compression
2855 * \li Origin: bpeng, 27 Apr 2006
2858 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
2860 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
2861 * \li Action: Closes the current buffer.
2862 * \li Notion: Closes the current buffer, asking whether to save it, etc,
2863 if the buffer has been modified.
2864 * \li Syntax: buffer-close
2867 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
2869 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE_ALL
2870 * \li Action: Closes all buffers.
2871 * \li Notion: Closes all buffers, asking whether to save it, etc,
2872 if a buffer has been modified.
2873 * \li Syntax: buffer-close-all
2876 { LFUN_BUFFER_CLOSE_ALL, "buffer-close-all", ReadOnly, Buffer },
2878 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
2879 * \li Action: Exports the current buffer (document) to the given format.
2880 * \li Syntax: buffer-export <FORMAT>
2881 * \li Params: <FORMAT> is either "custom" or one of the formats which you
2882 can find in Tools->Preferences->File formats->Format.
2883 Usual format you will enter is "pdf2" (pdflatex),
2884 "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
2885 In case of "custom" you will be asked for a format you
2886 want to start from and for the command that you want to
2887 apply to this format. Internally the control is then passed
2888 to #LFUN_BUFFER_EXPORT_CUSTOM.
2889 * \li Origin: Lgb, 29 Jul 1997
2892 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
2894 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
2895 * \li Action: Exports the current buffer (document) from the given format using
2896 the given command on it.
2897 * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
2898 * \li Params: <FORMAT> format to start from (LyX will care to produce such
2899 intermediate file).\n
2900 <COMMAND> this command will be launched on the file. Note that you can
2901 use "$$FName" string to qualify the intermediate file.
2902 * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
2903 * \li Origin: leeming, 27 Mar 2004
2906 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
2908 * \var lyx::FuncCode lyx::LFUN_BUFFER_PRINT
2909 * \li Action: Prints the current document.
2910 * \li Notion: Many settings can be given via the preferences dialog.
2911 * \li Syntax: buffer-print <TARGET> <TARGET-NAME> <COMMAND>
2912 * \li Params: <TARGET> is either "printer" or "file".\n
2913 <TARGER-NAME> is either "default" or file name or printer name.\n
2914 <COMMAND> command ensuring the printing job.
2915 * \li Sample: buffer-print file "/trash/newfile1.ps" "dvips"
2916 * \li Origin: leeming, 28 Mar 2004
2919 { LFUN_BUFFER_PRINT, "buffer-print", ReadOnly, Buffer },
2921 * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
2922 * \li Action: Import a given file as a lyx document.
2923 * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
2924 defined convertors in preferences. Look into File->Import menu to get
2925 an idea of the currently active import formats.
2926 * \li Syntax: buffer-import <FORMAT> [<FILE>]
2927 * \li Origin: Asger, 24 Jul 1998
2930 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
2932 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
2933 * \li Action: Creates a new buffer (that is, document).
2934 * \li Notion: Implicit path can be set in Preferences dialog.
2935 * \li Syntax: buffer-new [<FILE>]
2936 * \li Params: <FILE>: filename of created file with absolute path.
2939 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
2941 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
2942 * \li Action: Creates a new buffer (that is, document) from a template.
2943 * \li Notion: Path for new files and templates can be set in Preferences dialog.
2944 Template will be asked for via Open-dialog.
2945 * \li Syntax: buffer-new-template [<FILE>]
2946 * \li Params: <FILE>: filename of created file with absolute path.
2949 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
2951 * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
2952 * \li Action: Reverts opened document.
2953 * \li Syntax: buffer-reload
2954 * \li Origin: Asger, 2 Feb 1997
2957 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
2959 * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
2960 * \li Action: Switch to the given buffer.
2961 * \li Notion: This is useful also in case you need simultaneously more views of the edited
2962 document in different LyX windows.
2963 * \li Syntax: buffer-new-template <BUFFER>
2964 * \li Params: <BUFFER>: already opened document which is to be shown.
2967 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
2969 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
2970 * \li Action: Toggle editing mode of the current document between read/write and read-only.
2971 * \li Notion: This function is not allowed if the file is under version control, since
2972 read-only flag is often used in version control file locking.
2973 * \li Syntax: buffer-toggle-read-only
2974 * \li Origin: Lgb, 27 May 1997
2977 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
2979 * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
2980 * \li Action: Displays current buffer in chosen format.
2981 * \li Notion: Displays the contents of the current buffer in the chosen
2982 format, for example, PDF or DVI. This runs the necessary
2983 converter, calls the defined viewer, and so forth.
2984 * \li Syntax: buffer-view [<FORMAT>]
2985 * \li Params: <FORMAT>: The format to display, where this is one of the
2986 formats defined (in the current GUI) in the
2987 Tools>Preferences>File Formats dialog.
2988 If no format is given, the default format as
2989 specified in the same dialog is used.
2992 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
2994 * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
2995 * \li Action: Exports the current document and put the result into the
2996 temporary directory.
2997 * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
2998 the output will be rewriten - updated. This is useful in case your viewer
2999 is able to detect such changes (e.g. ghostview for postscript).
3000 * \li Syntax: buffer-update [<FORMAT>]
3001 * \li Params: <FORMAT>: The format to display, where this is one of the
3002 formats defined (in the current GUI) in the
3003 Tools>Preferences>File Formats dialog.
3004 If no format is given, the default format as
3005 specified in the same dialog is used.
3006 * \li Origin: Dekel, 5 Aug 2000
3009 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
3012 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
3013 * \li Action: Saves the current buffer.
3014 * \li Notion: Saves the current buffer to disk, using the filename that
3015 is already associated with the buffer, asking for one if
3016 none is yet assigned.
3017 * \li Syntax: buffer-write
3020 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
3022 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
3023 * \li Action: Rename and save current buffer.
3024 * \li Syntax: buffer-write-as <FILENAME>
3025 * \li Params: <FILENAME>: New name of the buffer/file. A relative path
3026 is with respect to the original location of the buffer/file.
3029 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
3031 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
3032 * \li Action: Save all changed documents.
3033 * \li Syntax: buffer-write-all
3034 * \li Origin: rgh, gpothier 6 Aug 2007
3037 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
3039 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEXT
3040 * \li Action: Switch to the next opened document.
3041 * \li Notion: Note that this does not necessarily mean next in tabbar
3042 (for full list see View menu).
3043 * \li Syntax: buffer-next
3046 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
3048 * \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS
3049 * \li Action: Switch to the previous opened document.
3050 * \li Syntax: buffer-previous
3053 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
3055 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
3056 * \li Action: When run from a child document, this updates (exports) document built
3057 from the master buffer, if available.
3058 * \li Syntax: master-buffer-update [<FORMAT>]
3059 * \li Params: <FORMAT>: The format to display, where this is one of the
3060 formats defined (in the current GUI) in the
3061 Tools>Preferences>File Formats dialog.
3062 If no format is given, the default format as
3063 specified in the same dialog is used.
3064 * \li Origin: Tommaso, 20 Sep 2007
3067 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
3069 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
3070 * \li Action: When run from a child document, this command shows a preview built
3071 from the master buffer, if available.
3072 * \li Syntax: master-buffer-view [<FORMAT>]
3073 * \li Params: <FORMAT>: The format to display, where this is one of the
3074 formats defined (in the current GUI) in the
3075 Tools>Preferences>File Formats dialog.
3076 If no format is given, the default format as
3077 specified in the same dialog is used.
3078 * \li Origin: Tommaso, 20 Sep 2007
3081 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
3083 * \var lyx::FuncCode lyx::LFUN_BUFFER_LANGUAGE
3084 * \li Action: Set language of the current document.
3085 * \li Syntax: buffer-language <LANG>
3086 * \li Params: <LANG>: language name. See lib/languages for list.
3087 * \li Origin: leeming, 30 Mar 2004
3090 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
3092 * \var lyx::FuncCode lyx::LFUN_BUFFER_SAVE_AS_DEFAULT
3093 * \li Action: Save the current document settings as default.
3094 * \li Notion: The file will will be saved into ~/.lyx/templates/defaults.lyx .
3095 * \li Syntax: buffer-save-as-default [<ARGS>]
3096 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
3097 you can find in document header of usual .lyx file.
3098 * \li Origin: leeming, 30 Mar 2004
3101 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
3103 * \var lyx::FuncCode lyx::LFUN_BUFFER_PARAMS_APPLY
3104 * \li Action: Apply the given settings to the current document.
3105 * \li Syntax: buffer-params-apply [<ARGS>]
3106 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
3107 you can find in document header of usual .lyx file.
3108 * \li Origin: leeming, 30 Mar 2004
3111 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", NoInternal, Buffer },
3114 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
3115 * \li Action: Inserts another LyX file.
3116 * \li Syntax: file-insert [<FILE>]
3117 * \li Params: <FILE>: Filename to be inserted.
3120 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
3122 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
3123 * \li Action: Inserts plain text file.
3124 * \li Syntax: file-insert-plaintext [<FILE>]
3125 * \li Params: <FILE>: Filename to be inserted.
3126 * \li Origin: CFO-G, 19 Nov 1997
3129 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
3131 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
3132 * \li Action: Inserts plain text file as paragraph (i.e. join lines).
3133 * \li Syntax: file-insert-plaintext-para [<FILE>]
3134 * \li Params: <FILE>: Filename to be inserted.
3135 * \li Origin: Levon, 14 Feb 2001
3138 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
3140 * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
3141 * \li Action: Open LyX document.
3142 * \li Syntax: file-open [<FILE>]
3143 * \li Params: <FILE>: Filename to be opened.
3146 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
3149 * \var lyx::FuncCode lyx::LFUN_CALL
3150 * \li Action: Executes a command defined in a .def file.
3151 * \li Notion: The definitions are by default read from lib/commands/default.def.\n
3152 A .def file allows to define a command with \define "<NAME>" "<LFUN>"
3153 where <NAME> is the name of the new command and <LFUN> is the lfun code
3154 to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
3155 \def_file "FileName" allows to include another .def file. \n
3156 This is particularly useful in connection with toolbar buttons:
3157 Since the name of the button image for this lfun is
3158 lib/images/commands/<NAME>.png this is the way to assign an image
3159 to a complex command-sequence.
3160 * \li Syntax: call <NAME>
3161 * \li Params: <NAME>: Name of the command that must be called.
3162 * \li Origin: broider, 2 Oct 2007
3165 { LFUN_CALL, "call", NoBuffer, System },
3167 * \var lyx::FuncCode lyx::LFUN_META_PREFIX
3168 * \li Action: Simulate halting Meta key (Alt key on PCs).
3169 * \li Notion: Used for buffer editation not for GUI control.
3170 * \li Syntax: meta-prefix
3173 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
3175 * \var lyx::FuncCode lyx::LFUN_CANCEL
3176 * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
3177 * \li Syntax: cancel
3180 { LFUN_CANCEL, "cancel", NoBuffer, System },
3183 * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
3184 * \li Action: Switches the focus to the minibuffer so that the user can type
3185 in there. If necessary, it opens the minibuffer toolbar.
3186 * \li Notion: Usually bound to M-x shortcut.
3187 * \li Syntax: command-execute
3190 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
3193 * \var lyx::FuncCode lyx::LFUN_COMMAND_PREFIX
3194 * \li Action: Return the current key sequence and available options as a string.
3195 * \li Notion: No options are added if no current map exists. \n
3196 This is probably usable only with connection to lyxserver.
3197 * \li Syntax: command-prefix
3200 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
3202 * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
3203 * \li Action: Run more commands (LFUN and its parameters) in a sequence.
3204 * \li Syntax: command-sequence <CMDS>
3205 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
3206 * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
3207 * \li Origin: Andre, 11 Nov 1999
3210 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
3212 * \var lyx::FuncCode lyx::LFUN_COMMAND_ALTERNATIVES
3213 * \li Action: Runs the first listed command that is enabled.
3214 * \li Notion: This can be used to bind multiple functions to a single key,
3215 and then which one is used will depend upon the context.
3216 * \li Syntax: command-alternatives <CMDS>
3217 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
3218 * \li Sample: command-alternatives completion-accept;cell-forward
3219 * \li Origin: rgh, 24 September 2008
3222 { LFUN_COMMAND_ALTERNATIVES, "command-alternatives", NoBuffer, System },
3224 * \var lyx::FuncCode lyx::LFUN_MESSAGE
3225 * \li Action: Shows message in statusbar (for script purposes).
3226 * \li Syntax: message <STRING>
3227 * \li Origin: Lgb, 8 Apr 2001
3230 { LFUN_MESSAGE, "message", NoBuffer, System },
3232 * \var lyx::FuncCode lyx::LFUN_DEBUG_LEVEL_SET
3233 * \li Action: Set debug output level.
3234 * \li Syntax: debug-level-set <LEVEL>
3235 * \li Params: <LEVEL>: comma separated list of levels or the correspondent number
3236 of their combination. 0 is equivalent to disabling all debug
3237 events. See lyx -dbg for the current list of debug levels
3239 * \li Origin: sanda, 28 Dec 2009
3242 { LFUN_DEBUG_LEVEL_SET, "debug-level-set", NoBuffer, System },
3245 * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
3246 * \li Action: Save user preferences.
3247 * \li Syntax: preferences-save
3248 * \li Origin: Lgb, 27 Nov 1999
3251 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
3253 * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
3254 * \li Action: Reconfigure the automatic settings.
3255 * \li Syntax: reconfigure
3256 * \li Origin: Asger, 14 Feb 1997
3259 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
3261 * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
3262 * \li Action: Apply the given settings to user preferences.
3263 * \li Syntax: lyxrc-apply <SETTINGS>
3264 * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
3265 to get an idea which commands to use and their syntax.
3266 #lyx::LyXRC::LyXRCTags has the list of possible commands.
3269 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
3271 * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
3272 * \li Action: Determine whether keep cursor inside the editing window regardless
3273 the scrollbar movement.
3274 * \li Syntax: toggle-cursor-follows-scrollbar
3275 * \li Origin: ARRae, 2 Dec 1997
3278 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
3280 * \var lyx::FuncCode lyx::LFUN_SET_COLOR
3281 * \li Action: Set the given LyX color to the color defined by the X11 name given.
3282 * \li Notion: A new color entry is created if the color is unknown.
3283 Color names can be stored as a part of user settings.
3284 * \li Syntax: set-color <LYX_NAME> <X11_NAME>
3285 * \li Origin: SLior, 11 Jun 2000
3288 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
3290 * \var lyx::FuncCode lyx::LFUN_STATISTICS
3291 * \li Action: Count the statistics (number of words and characters)
3292 in the document or in the given selection.
3293 * \li Notion: Note that this function gives the number of words/chars written,
3294 not the number of characters which will be typeset.
3295 * \li Syntax: statistics
3296 * \li Origin: lasgouttes, Jan 27 2004; sanda, Jan 8 2008
3299 { LFUN_STATISTICS, "statistics", ReadOnly, System },
3301 * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
3302 * \li Action: Show the inline completion at the cursor position.
3303 * \li Syntax: completion-inline
3304 * \li Origin: sts, Feb 19 2008
3307 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
3309 * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
3310 * \li Action: Show the completion popup at the cursor position.
3311 * \li Syntax: completion-popup
3312 * \li Origin: sts, Feb 19 2008
3315 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
3317 * \var lyx::FuncCode lyx::LFUN_COMPLETION_COMPLETE
3318 * \li Action: Try to complete the word or command at the cursor position.
3319 * \li Syntax: complete
3320 * \li Origin: sts, Feb 19 2008
3323 { LFUN_COMPLETION_COMPLETE, "complete", SingleParUpdate, Edit },
3326 * \var lyx::FuncCode lyx::LFUN_COMPLETION_CANCEL
3327 * \li Action: Try to cancel completion, either the popup or the inline completion.
3328 * \li Syntax: completion-cancel
3329 * \li Origin: sts, Sep 07 2008
3332 { LFUN_COMPLETION_CANCEL, "completion-cancel", SingleParUpdate, Edit },
3334 * \var lyx::FuncCode lyx::LFUN_COMPLETION_ACCEPT
3335 * \li Action: Accept suggested completion.
3336 * \li Syntax: completion-accept
3337 * \li Origin: sanda, Sep 08 2008
3340 { LFUN_COMPLETION_ACCEPT, "completion-accept", SingleParUpdate, Edit },
3344 * \var lyx::FuncCode lyx::LFUN_BRANCH_ADD
3345 * \li Action: Add a branch to the buffer's BranchList.
3346 * \li Syntax: branch-add <BRANCH>
3347 * \li Params: <BRANCH>: Name of the branch to add
3348 * \li Origin: spitz, 7 Jul 2009
3351 { LFUN_BRANCH_ADD, "branch-add", Noop, Buffer },
3355 * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
3356 * \li Action: Activate the branch.
3357 * \li Syntax: branch-activate <BRANCH>
3358 * \li Params: <BRANCH>: The branch to activate
3359 * \li Sample: lyx -x "branch-activate answers" -e pdf2 finalexam.lyx \n
3360 could be used to export a pdf with the answers branch included
3361 without one's having to open LyX and activate the branch manually.
3362 * \li Origin: rgh, 27 May 2008
3365 { LFUN_BRANCH_ACTIVATE, "branch-activate", AtPoint, Buffer },
3367 * \var lyx::FuncCode lyx::LFUN_BRANCH_DEACTIVATE
3368 * \li Action: De-activate the branch.
3369 * \li Syntax: branch-deactivate <BRANCH>
3370 * \li Params: <BRANCH>: The branch to deactivate
3371 * \li Origin: rgh, 27 May 2008
3374 { LFUN_BRANCH_DEACTIVATE, "branch-deactivate", AtPoint, Buffer },
3377 * \var lyx::FuncCode lyx::LFUN_BRANCHES_RENAME
3378 * \li Action: Rename all branches of a given name in a document.
3379 * \li Syntax: branches-rename <OLDNAME> <NEWNAME>
3380 * \li Params: <OLDNAME>: Current name of the branch to be renamed
3381 * <NEWNAME>: New name of the branch
3382 * \li Origin: spitz, 9 Jul 2009
3385 { LFUN_BRANCHES_RENAME, "branches-rename", Noop, Buffer },
3387 * \var lyx::FuncCode lyx::LFUN_BRANCH_ADD_INSERT
3388 * \li Action: Create new branch and directly put the branch inset into
3390 * \li Syntax: branch-add-insert [<NAME>]
3391 * \li Params: <NAME>: Branch name. If it is not specified, you will be asked.
3392 * \li Origin: sanda, 10 Jul 2009
3395 { LFUN_BRANCH_ADD_INSERT, "branch-add-insert", Noop, Buffer },
3399 * \var lyx::FuncCode lyx::LFUN_LABEL_COPY_AS_REF
3400 * \li Action: Copies the label at the cursor as a cross-reference to be pasted elsewhere.
3401 * \li Syntax: copy-label-as-reference <LABEL>
3402 * \li Params: <LABEL>: The label to copy (for multi-line math)
3403 * \li Origin: sts, 16 Nov 2008
3406 { LFUN_LABEL_COPY_AS_REF, "copy-label-as-reference", ReadOnly | NoUpdate, Edit },
3409 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT_AS_REF
3410 * \li Action: Inserts the label as a cross-reference at the position of the cursor.
3411 * \li Syntax: label-insert-as-reference
3412 * \li Origin: vfr, 7 Apr 2009
3415 { LFUN_LABEL_INSERT_AS_REF, "label-insert-as-reference", Noop, Edit},
3418 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_IN
3419 * \li Action: Increases the zoom of the screen fonts.
3420 * \li Syntax: buffer-zoom-in [<ZOOM>]
3421 * \li Params: <ZOOM>: The zoom in %, the default is 20.
3422 * \li Origin: vfr, 30 Mar 2009
3425 { LFUN_BUFFER_ZOOM_IN, "buffer-zoom-in", ReadOnly, Buffer },
3428 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_OUT
3429 * \li Action: Decreases the zoom of the screen fonts.
3430 * \li Syntax: buffer-zoom-out [<ZOOM>]
3431 * \li Params: <ZOOM>: The zoom in %, the default is 20.
3432 * \li Origin: vfr, 30 Mar 2009
3435 { LFUN_BUFFER_ZOOM_OUT, "buffer-zoom-out", ReadOnly, Buffer },
3438 * \var lyx::FuncCode lyx::LFUN_SECTION_SELECT
3439 * \li Action: Selects the whole section.
3440 * \li Notion: The cursor should be in a section heading
3441 before calling this lfun.
3442 * \li Syntax: section-select
3443 * \li Origin: vfr, 05 May 2009
3446 { LFUN_SECTION_SELECT, "section-select", ReadOnly, Edit },
3449 { LFUN_NOACTION, "", Noop, Hidden }
3450 #ifndef DOXYGEN_SHOULD_SKIP_THIS
3453 for (int i = 0; items[i].action != LFUN_NOACTION; ++i)
3454 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
3460 LyXAction::LyXAction()
3466 FuncRequest LyXAction::lookupFunc(string const & func) const
3468 string const func2 = trim(func);
3471 return FuncRequest(LFUN_NOACTION);
3474 string const arg = split(func2, cmd, ' ');
3476 FuncMap::const_iterator const fit = lyx_func_map.find(cmd);
3478 return fit != lyx_func_map.end()
3479 ? FuncRequest(fit->second, arg)
3480 : FuncRequest(LFUN_UNKNOWN_ACTION);
3484 string const LyXAction::getActionName(FuncCode action) const
3486 InfoMap::const_iterator const it = lyx_info_map.find(action);
3487 return it != lyx_info_map.end() ? it->second.name : string();
3491 LyXAction::FuncType LyXAction::getActionType(FuncCode action) const
3493 InfoMap::const_iterator const it = lyx_info_map.find(action);
3494 return it != lyx_info_map.end() ? it->second.type : Hidden;
3498 bool LyXAction::funcHasFlag(FuncCode action,
3499 LyXAction::FuncAttribs flag) const
3501 InfoMap::const_iterator ici = lyx_info_map.find(action);
3503 if (ici == lyx_info_map.end()) {
3504 LYXERR0("action: " << action << " is not known.");
3505 LASSERT(false, /**/);
3508 return ici->second.attrib & flag;
3512 LyXAction::const_iterator LyXAction::func_begin() const
3514 return lyx_func_map.begin();
3518 LyXAction::const_iterator LyXAction::func_end() const
3520 return lyx_func_map.end();
3524 LyXErr & operator<<(LyXErr & l, FuncCode code)
3527 l.stream() << lyxaction.getActionName(code);