3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Lars Gullik Bjønnes
7 * \author Jean-Marc Lasgouttes
12 * Full author contact details are available in file CREDITS.
17 #include "LyXAction.h"
19 #include "FuncRequest.h"
21 #include "support/debug.h"
22 #include "support/lstrings.h"
24 #include "support/lassert.h"
29 using namespace lyx::support;
34 NAMING RULES FOR USER-COMMANDS
35 Here's the set of rules to apply when a new command name is introduced:
37 1) Use the object.event order. That is, use `word-forward'
38 instead of `forward-word'.
39 2) Don't introduce an alias for an already named object. Same for events.
40 3) Forward movement or focus is called `forward' (not `right').
41 4) Backward movement or focus is called `backward' (not `left').
42 5) Upward movement of focus is called `up'.
43 6) Downward movement is called `down'.
44 7) The begin of an object is called `begin' (not `start').
45 8) The end of an object is called `end'.
47 (May 19 1996, 12:04, RvdK)
52 * The documentation below is primarily description of purpose and syntax
53 * relating to the different LFUNs.
55 * Try to find an appropriate (thematical) place when adding the new LFUN
56 * and don't forget to add doxygen commentary.
58 * Doxygen template below. Some notes: Parameters should be set in uppercase
59 * and put in <BRACKETS>, [<PARAM>] means optional one.
61 * Use spaces for indentation (doxy -> .lyx generator is tab-sensitive).
65 * \var lyx::FuncCode lyx::LFUN_
78 void LyXAction::newFunc(FuncCode action, string const & name,
79 unsigned int attrib, LyXAction::FuncType type)
81 lyx_func_map[name] = action;
84 tmpinfo.attrib = attrib;
86 lyx_info_map[action] = tmpinfo;
90 // Needed for LFUNs documentation to be accepted, since doxygen won't take
91 // \var inside functions.
92 #ifndef DOXYGEN_SHOULD_SKIP_THIS
93 void LyXAction::init()
95 // This function was changed to use the array below in initalization
96 // instead of calling newFunc numerous times because of compilation
97 // times. Since the array is not static we get back the memory it
98 // occupies after the init is completed. It compiles several
112 ev_item const items[] = {
115 * \var lyx::FuncCode lyx::LFUN_ACCENT_ACUTE
116 * \li Action: Adds an acute accent \htmlonly (á)\endhtmlonly
117 to the next character typed.
118 * \li Syntax: accent-acute
121 { LFUN_ACCENT_ACUTE, "accent-acute", Noop, Edit },
123 * \var lyx::FuncCode lyx::LFUN_ACCENT_BREVE
124 * \li Action: Adds a breve accent \htmlonly (ă)\endhtmlonly
125 to the next character typed.
126 * \li Syntax: accent-breve
129 { LFUN_ACCENT_BREVE, "accent-breve", Noop, Edit },
131 * \var lyx::FuncCode lyx::LFUN_ACCENT_CARON
132 * \li Action: Adds a caron \htmlonly (ǎ)\endhtmlonly
133 to the next character typed.
134 * \li Syntax: accent-caron
137 { LFUN_ACCENT_CARON, "accent-caron", Noop, Edit },
139 * \var lyx::FuncCode lyx::LFUN_ACCENT_CEDILLA
140 * \li Action: Adds a cedilla \htmlonly (ç)\endhtmlonly
141 to the next character typed.
142 * \li Syntax: accent-cedilla
145 { LFUN_ACCENT_CEDILLA, "accent-cedilla", Noop, Edit },
147 * \var lyx::FuncCode lyx::LFUN_ACCENT_CIRCLE
148 * \li Action: Adds a circle accent \htmlonly (å)\endhtmlonly
149 to the next character typed.
150 * \li Syntax: accent-circle
153 { LFUN_ACCENT_CIRCLE, "accent-circle", Noop, Edit },
155 * \var lyx::FuncCode lyx::LFUN_ACCENT_CIRCUMFLEX
156 * \li Action: Adds a circumflex \htmlonly (ê)\endhtmlonly
157 to the next character typed.
158 * \li Syntax: accent-circumflex
161 { LFUN_ACCENT_CIRCUMFLEX, "accent-circumflex", Noop, Edit },
163 * \var lyx::FuncCode lyx::LFUN_ACCENT_DOT
164 * \li Action: Adds a dot accent \htmlonly (ż)\endhtmlonly
165 to the next character typed.
166 * \li Syntax: accent-dot
169 { LFUN_ACCENT_DOT, "accent-dot", Noop, Edit },
171 * \var lyx::FuncCode lyx::LFUN_ACCENT_GRAVE
172 * \li Action: Adds a grave accent \htmlonly (è)\endhtmlonly
173 to the next character typed.
174 * \li Syntax: accent-grave
177 { LFUN_ACCENT_GRAVE, "accent-grave", Noop, Edit },
179 * \var lyx::FuncCode lyx::LFUN_ACCENT_HUNGARIAN_UMLAUT
180 * \li Action: Adds a Hungarian umlaut \htmlonly (ő)\endhtmlonly
181 to the next character typed.
182 * \li Syntax: accent-grave
185 { LFUN_ACCENT_HUNGARIAN_UMLAUT, "accent-hungarian-umlaut", Noop, Edit },
187 * \var lyx::FuncCode lyx::LFUN_ACCENT_MACRON
188 * \li Action: Adds a macron \htmlonly (ā)\endhtmlonly
189 to the next character typed.
190 * \li Syntax: accent-macron
193 { LFUN_ACCENT_MACRON, "accent-macron", Noop, Edit },
195 * \var lyx::FuncCode lyx::LFUN_ACCENT_OGONEK
196 * \li Action: Adds an ogonek accent \htmlonly (ą)\endhtmlonly
197 to the next character typed.
198 * \li Syntax: accent-ogonek
201 { LFUN_ACCENT_OGONEK, "accent-ogonek", Noop, Edit },
203 * \var lyx::FuncCode lyx::LFUN_ACCENT_TIE
204 * \li Action: Adds a tie \htmlonly (a͡)\endhtmlonly
205 over the next two character typed.
206 * \li Notion: The following char will finish the tie.
207 * \li Syntax: accent-tie
210 { LFUN_ACCENT_TIE, "accent-tie", Noop, Edit },
212 * \var lyx::FuncCode lyx::LFUN_ACCENT_TILDE
213 * \li Action: Adds a tilde \htmlonly (ã)\endhtmlonly
214 over the next character typed.
215 * \li Syntax: accent-tilde
218 { LFUN_ACCENT_TILDE, "accent-tilde", Noop, Edit },
220 * \var lyx::FuncCode lyx::LFUN_ACCENT_UMLAUT
221 * \li Action: Adds an umlaut \htmlonly (ä)\endhtmlonly
222 over the next character typed.
223 * \li Syntax: accent-umlaut
226 { LFUN_ACCENT_UMLAUT, "accent-umlaut", Noop, Edit },
228 * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERBAR
229 * \li Action: Adds a bar \htmlonly (a̠)\endhtmlonly
230 under the next character typed.
231 * \li Syntax: accent-underbar
234 { LFUN_ACCENT_UNDERBAR, "accent-underbar", Noop, Edit },
236 * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERDOT
237 * \li Action: Adds a dot \htmlonly (ạ)\endhtmlonly
238 under the next character typed.
239 * \li Syntax: accent-underdot
242 { LFUN_ACCENT_UNDERDOT, "accent-underdot", Noop, Edit },
245 * \var lyx::FuncCode lyx::LFUN_CAPTION_INSERT
246 * \li Action: Inserts a caption inset.
247 * \li Syntax: caption-insert
248 * \li Origin: Lgb, 18 Jul 2000
251 { LFUN_CAPTION_INSERT, "caption-insert", Noop, Edit },
253 * \var lyx::FuncCode lyx::LFUN_DATE_INSERT
254 * \li Action: Inserts the current date.
255 * \li Syntax: date-insert [<ARG>]
256 * \li Params: <ARG>: Format of date. The default value (%x) can be set
257 in Preferences->Date format. For possible formats
258 see manual page of strftime function.
259 * \li Origin: jdblair, 31 Jan 2000
262 { LFUN_DATE_INSERT, "date-insert", Noop, Edit },
264 * \var lyx::FuncCode lyx::LFUN_FOOTNOTE_INSERT
265 * \li Action: Inserts a footnote inset.
266 * \li Syntax: footnote-insert
267 * \li Origin: Jug, 7 Mar 2000
270 { LFUN_FOOTNOTE_INSERT, "footnote-insert", Noop, Edit },
272 * \var lyx::FuncCode lyx::LFUN_ERT_INSERT
273 * \li Action: Inserts an ERT inset.
274 * \li Syntax: ert-insert
275 * \li Origin: Jug, 18 Feb 2000
278 { LFUN_ERT_INSERT, "ert-insert", Noop, Edit },
280 * \var lyx::FuncCode lyx::LFUN_FLOAT_INSERT
281 * \li Action: Inserts a float inset.
282 * \li Syntax: float-insert <TYPE>
283 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
284 "algorithm", "table", "figure" parameters can be given.
285 * \li Origin: Lgb, 27 Jun 2000
288 { LFUN_FLOAT_INSERT, "float-insert", Noop, Edit },
290 * \var lyx::FuncCode lyx::LFUN_FLOAT_WIDE_INSERT
291 * \li Action: Inserts float insets as in #LFUN_FLOAT_INSERT but span multiple columns.
292 * \li Notion: Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
293 * \li Syntax: float-wide-insert <TYPE>
294 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
295 "algorithm", "table", "figure" parameters can be given.
296 * \li Origin: Lgb, 31 Oct 2001
299 { LFUN_FLOAT_WIDE_INSERT, "float-wide-insert", Noop, Edit },
301 * \var lyx::FuncCode lyx::LFUN_FLOAT_LIST_INSERT
302 * \li Action: Inserts the list of floats in the document.
303 * \li Syntax: float-list-insert <TYPE>
304 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
305 "algorithm", "table", "figure" parameters can be given.
306 * \li Origin: Lgb, 3 May 2001
309 { LFUN_FLOAT_LIST_INSERT, "float-list-insert", Noop, Edit },
311 * \var lyx::FuncCode lyx::LFUN_WRAP_INSERT
312 * \li Action: Inserts floats wrapped by the text around.
313 * \li Syntax: wrap-insert <TYPE>
314 * \li Params: <TYPE>: table|figure
315 * \li Origin: Dekel, 7 Apr 2002
318 { LFUN_WRAP_INSERT, "wrap-insert", Noop, Edit },
320 * \var lyx::FuncCode lyx::LFUN_OPTIONAL_INSERT
321 * \li Action: Inserts an optional-argument (short title) inset.
322 * \li Syntax: optional-insert
323 * \li Origin: vermeer, 12 Aug 2002
326 { LFUN_OPTIONAL_INSERT, "optional-insert", Noop, Edit },
328 * \var lyx::FuncCode lyx::LFUN_LINE_INSERT
329 * \li Action: Inserts a horizontal line.
330 * \li Syntax: line-insert
331 * \li Origin: Andre, Oct 27 2003
334 { LFUN_LINE_INSERT, "line-insert", Noop, Edit },
336 * \var lyx::FuncCode lyx::LFUN_NEWPAGE_INSERT
337 * \li Action: Inserts a new page.
338 * \li Syntax: newpage-insert <ARG>
339 * \li Params: <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
340 * \li Origin: uwestoehr, 24 Nov 2007
343 { LFUN_NEWPAGE_INSERT, "newpage-insert", Noop, Edit },
345 * \var lyx::FuncCode lyx::LFUN_MARGINALNOTE_INSERT
346 * \li Action: Inserts a marginal note.
347 * \li Syntax: marginalnote-insert
348 * \li Origin: Lgb, 26 Jun 2000
351 { LFUN_MARGINALNOTE_INSERT, "marginalnote-insert", Noop, Edit },
353 * \var lyx::FuncCode lyx::LFUN_UNICODE_INSERT
354 * \li Action: Inserts a single unicode character.
355 * \li Syntax: unicode-insert <CHAR>
356 * \li Params: <CHAR>: The character to insert, given as its code
357 point, in hexadecimal.
358 * \li Sample: unicode-insert 0x0100
359 * \li Origin: Lgb, 22 Oct 2006
362 { LFUN_UNICODE_INSERT, "unicode-insert", Noop, Edit },
364 * \var lyx::FuncCode lyx::LFUN_LISTING_INSERT
365 * \li Action: Inserts a new listings inset.
366 * \li Syntax: listing-insert
367 * \li Origin: Herbert, 10 Nov 2001; bpeng, 2 May 2007
370 { LFUN_LISTING_INSERT, "listing-insert", Noop, Edit },
372 * \var lyx::FuncCode lyx::LFUN_PREVIEW_INSERT
373 * \li Action: Inserts a new preview inset.
374 * \li Syntax: preview-insert
375 * \li Origin: vfr, 28 Mar 2010
378 { LFUN_PREVIEW_INSERT, "preview-insert", Noop, Edit },
380 * \var lyx::FuncCode lyx::LFUN_TAB_INSERT
381 * \li Action: Insert a tab into a listings inset.
382 * \li Notion: It also works on a selection.
383 * \li Syntax: tab-insert
384 * \li Origin: vfr, Sep 30 2008
387 { LFUN_TAB_INSERT, "tab-insert", SingleParUpdate, Edit },
389 * \var lyx::FuncCode lyx::LFUN_TAB_DELETE
390 * \li Action: Delete a tab or up to an equivalent amount of spaces from
392 * \li Notion: It also works on a selection - it removes a tab or spaces from the
393 beginning of each line spanned by the selection. This is useful if
394 you want to indent/unindent multiple lines in one action.
395 * \li Syntax: tab-delete
396 * \li Origin: vfr, Sep 30 2008
399 { LFUN_TAB_DELETE, "tab-delete", SingleParUpdate, Edit },
401 * \var lyx::FuncCode lyx::LFUN_QUOTE_INSERT
402 * \li Action: Inserts quotes according to the type and quote-language preference.
403 * \li Notion: Currently English, Swedish, German, Polish, French, Danish quotes
405 * \li Syntax: quote-insert [<TYPE>]
406 * \li Params: <TYPE>: 'single' for single quotes, otherwise double quotes will be used.
409 { LFUN_QUOTE_INSERT, "quote-insert", Noop, Edit },
411 * \var lyx::FuncCode lyx::LFUN_INFO_INSERT
412 * \li Action: Displays shortcuts, lyxrc, package and textclass availability and menu
413 information in a non-editable boxed InsetText.
414 * \li Notion: Apart from lfun arguments you can use the following method: \n
415 1. input the type and argument of this inset, e.g. "menu paste", in
417 2. select the text and run info-insert lfun.
418 * \li Syntax: info-insert <TYPE> <ARG>
419 * \li Params: <TYPE>: shortcut[s]|lyxrc|package|textclass|menu|buffer \n
420 <ARG>: argument for a given type. Look into InsetInfo.h for detailed
422 shortcut[s]: name of lfun (e.g math-insert \alpha) \n
423 lyxrc: name of rc_entry (e.g. bind_file) \n
424 package: name of latex package (e.g. listings) \n
425 textclass: name of textclass (e.g. article) \n
426 menu: name of lfun used in menu \n
427 icon: name of lfun used in toolbar \n
428 buffer: "name"|"path"|"class"|"vcs-tree-revision"|
429 "vcs-revision"|"vcs-author"|"vcs-date"|"vcs-time"
430 * \li Sample: command-sequence info-insert buffer path; info-insert buffer name
431 * \li Origin: bpeng, 7 Oct 2007
434 { LFUN_INFO_INSERT, "info-insert", Noop, Edit },
436 * \var lyx::FuncCode lyx::LFUN_BRANCH_INSERT
437 * \li Action: Inserts branch inset.
438 * \li Syntax: branch-insert <BRANCH-NAME>
439 * \li Origin: vermeer, 17 Aug 2003
442 { LFUN_BRANCH_INSERT, "branch-insert", Noop, Edit },
444 * \var lyx::FuncCode lyx::LFUN_BOX_INSERT
445 * \li Action: Inserts Box inset.
446 * \li Syntax: box-insert [<TYPE>]
447 * \li Params: <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox \n
448 Framed is the default one.
449 * \li Origin: vermeer, 7 Oct 2003
452 { LFUN_BOX_INSERT, "box-insert", Noop, Edit },
454 * \var lyx::FuncCode lyx::LFUN_FLEX_INSERT
455 * \li Action: Inserts CharStyle, Custom inset or XML short element.
456 * \li Notion: Look into the Customization manual for more information about
458 To make this command enabled the layout file for the document
459 class you're using has to load the character styles. There are
460 a few contained in the Logical Markup module. You can also of
461 course create some yourself. \n
462 For dissolving the element see #LFUN_INSET_DISSOLVE.
463 * \li Syntax: flex-insert <TYPE:Name>
464 * \li Params: TYPE: CharStyle|Custom|Element|Standard \n
465 Identifies whether this is a Character Style, a
466 Custom Inset or an XML Element, and which dynamical
467 sub-menu this flex inset is in on the LyX menu tree.
468 If Standard (currently unused): none of these.\n
469 Name: This name must be defined either in your layout file
470 or imported by some module. The definition is
471 InsetLayout <TYPE:Name>
472 * \li Sample: flex-insert CharStyle:Code
475 { LFUN_FLEX_INSERT, "flex-insert", Noop, Edit },
477 * \var lyx::FuncCode lyx::LFUN_SELF_INSERT
478 * \li Action: Inserts the given string (accordingly to the correct keymap).
479 * \li Notion: Automatically replace the currently selected text. Depends on lyxrc
480 settings "auto_region_delete".
481 * \li Syntax: self-insert <STRING>
484 { LFUN_SELF_INSERT, "self-insert", SingleParUpdate, Hidden },
486 * \var lyx::FuncCode lyx::LFUN_SPACE_INSERT
487 * \li Action: Inserts one of horizontal space insets.
488 * \li Syntax: space-insert <NAME> [<LEN>]
489 * \li Params: <NAME>: normal, protected, thin, quad, qquad, enspace, enskip,
490 negthinspace, hfill, hfill*, dotfill, hrulefill, hspace,
492 <LEN>: length for custom spaces (hspace, hspace* for protected)
493 * \li Origin: JSpitzm, 20 May 2003, Mar 17 2008
496 { LFUN_SPACE_INSERT, "space-insert", Noop, Edit },
498 * \var lyx::FuncCode lyx::LFUN_HYPERLINK_INSERT
499 * \li Action: Inserts hyperlinks into the document (clickable in pdf output).
500 * \li Notion: Hyperlink target can be set via selection + hyperlink-insert function.
501 * \li Syntax: href-insert [<TARGET>]
502 * \li Origin: CFO-G, 21 Nov 1997
505 { LFUN_HYPERLINK_INSERT, "href-insert", Noop, Edit },
507 * \var lyx::FuncCode lyx::LFUN_SPECIALCHAR_INSERT
508 * \li Action: Inserts various characters into the document.
509 * \li Syntax: specialchar-insert <CHAR>
510 * \li Params: <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots,
511 end-of-sentence, menu-separator.
512 * \li Origin: JSpitzm, 6 Dec 2007
515 { LFUN_SPECIALCHAR_INSERT, "specialchar-insert", Noop, Edit },
517 * \var lyx::FuncCode lyx::LFUN_TOC_INSERT
518 * \li Action: Inserts table of contents.
519 * \li Syntax: toc-insert
520 * \li Origin: Lgb, 27 May 97
523 { LFUN_TOC_INSERT, "toc-insert", Noop, Edit },
525 * \var lyx::FuncCode lyx::LFUN_APPENDIX
526 * \li Action: Start (or remove) Appendix on the given cursor position.
527 * \li Syntax: appendix
528 * \li Origin: ettrich, 5 May 1998
531 { LFUN_APPENDIX, "appendix", Noop, Edit },
534 * \var lyx::FuncCode lyx::LFUN_INDEX_INSERT
535 * \li Action: Inserts Index entry.
536 * \li Notion: It automatically takes the word on the cursor position.
537 * \li Syntax: index-insert [<TYPE:Name>]
538 * \li Params: <TYPE:Name>: name of the index, if multiple indices are defined.
539 with an empty argument, the default index is selected.
540 * \li Origin: leeming, 3 Aug 2000
543 { LFUN_INDEX_INSERT, "index-insert", Noop, Edit },
545 * \var lyx::FuncCode lyx::LFUN_INDEX_PRINT
546 * \li Action: Inserts list of Index entries on a new page.
547 * \li Syntax: index-print [<TYPE:Name>]
548 * \li Params: <TYPE:Name>: name of the index, if multiple indices are defined.
549 with an empty argument, the default index is selected.
550 * \li Origin: Lgb, 27 Feb 1997
553 { LFUN_INDEX_PRINT, "index-print", Noop, Edit },
556 * \var lyx::FuncCode lyx::LFUN_NOMENCL_INSERT
557 * \li Action: Inserts Nomenclature entry.
558 * \li Notion: It automatically takes the word on the cursor position if no symbol is given.
559 * \li Syntax: nomencl-insert [<SYMBOL>]
560 * \li Origin: Ugras, 4 Nov 2006
563 { LFUN_NOMENCL_INSERT, "nomencl-insert", Noop, Edit },
565 * \var lyx::FuncCode lyx::LFUN_NOMENCLATURE_PRINT
566 * \li Action: Inserts list of Nomenclature entries.
567 * \li Syntax: nomenclature-print
568 * \li Origin: Ugras, 4 Nov 2006
571 { LFUN_NOMENCL_PRINT, "nomencl-print", Noop, Edit },
574 * \var lyx::FuncCode lyx::LFUN_NOTE_INSERT
575 * \li Action: Inserts Note on the current cursor postion,
576 move selection inside the inset.
577 * \li Syntax: note-insert [<TYPE>]
578 * \li Params: <TYPE>: <Note|Greyedout|Comment> default: Note
581 { LFUN_NOTE_INSERT, "note-insert", Noop, Edit },
583 * \var lyx::FuncCode lyx::LFUN_NOTE_NEXT
584 * \li Action: Moves the cursor to the begining of next Note inset.
585 * \li Syntax: note-next
588 { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
590 * \var lyx::FuncCode lyx::LFUN_PHANTOM_INSERT
591 * \li Action: Inserts phantom on the current cursor postion,
592 move selection inside the inset.
593 * \li Syntax: phantom-insert [<TYPE>]
594 * \li Params: <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
595 * \li Origin: uwestoehr, 30 Jan 2009
598 { LFUN_PHANTOM_INSERT, "phantom-insert", Noop, Edit },
600 * \var lyx::FuncCode lyx::LFUN_NEWLINE_INSERT
601 * \li Action: Inserts a line break or new line.
602 * \li Syntax: newline-insert [<ARG>]
603 * \li Params: <ARG>: <newline|linebreak> default: newline
604 * \li Origin: JSpitzm, 25 Mar 2008
607 { LFUN_NEWLINE_INSERT, "newline-insert", Noop, Edit },
609 * \var lyx::FuncCode lyx::LFUN_ESCAPE
610 * \li Action: Clears the selection. If no text is selected call #LFUN_FINISHED_FORWARD.
611 Inside math mode jumps out of the math inset.
613 * \li Origin: Lgb, 17 May 2001
616 { LFUN_ESCAPE, "escape", ReadOnly, Edit },
618 * \var lyx::FuncCode lyx::LFUN_DOWN
619 * \li Action: Moves the cursor one line in downward direction.
623 { LFUN_DOWN, "down", ReadOnly | NoUpdate, Edit },
625 * \var lyx::FuncCode lyx::LFUN_UP
626 * \li Action: Moves the cursor one line in upward direction.
630 { LFUN_UP, "up", ReadOnly | NoUpdate, Edit },
632 * \var lyx::FuncCode lyx::LFUN_DOWN_SELECT
633 * \li Action: Moves the cursor one line in downward direction adding the current
634 position to the selection.
635 * \li Syntax: down-select
638 { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, Edit },
640 * \var lyx::FuncCode lyx::LFUN_UP_SELECT
641 * \li Action: Moves the cursor one line in upward direction adding the current
642 position to the selection.
643 * \li Syntax: up-select
646 { LFUN_UP_SELECT, "up-select", ReadOnly | SingleParUpdate, Edit },
648 * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN
649 * \li Action: Moves the cursor one page in downward direction.
650 * \li Syntax: screen-down
653 { LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit },
655 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP
656 * \li Action: Moves the cursor one page in upward direction.
657 * \li Syntax: screen-up
660 { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit },
662 * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN_SELECT
663 * \li Action: Moves the cursor one screen in downward direction adding the current
664 position to the selection.
665 * \li Syntax: screen-down-select
668 { LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit },
670 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP_SELECT
671 * \li Action: Moves the cursor one page in upward direction adding the current
672 position to the selection.
673 * \li Syntax: screen-up-select
676 { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit },
678 * \var lyx::FuncCode lyx::LFUN_SCROLL
679 * \li Action: Scroll the buffer view.
680 * \li Notion: Only scrolls the screen up or down; does not move the cursor.
681 * \li Syntax: scroll <TYPE> <QUANTITY>
682 * \li Params: <TYPE>: line|page\n
683 <QUANTITY>: up|down|<number>
684 * \li Origin: Abdel, Dec 27 2007
687 { LFUN_SCROLL, "scroll", ReadOnly, Edit },
689 * \var lyx::FuncCode lyx::LFUN_SCREEN_RECENTER
690 * \li Action: Recenters the screen on the current cursor position.
691 * \li Syntax: screen-recenter
694 { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit },
697 * \var lyx::FuncCode lyx::LFUN_SCREEN_SHOW_CURSOR
698 * \li Action: Repositions the screen such that the cursor is visible.
699 * \li Syntax: screen-show-cursor
700 * \li Origin: vfr, 25 Mar 2009
703 { LFUN_SCREEN_SHOW_CURSOR, "screen-show-cursor", ReadOnly, Edit },
706 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD
707 * \li Action: Moves the cursor one position logically backwards.
708 * \li Notion: This is not the action which should be bound to the arrow keys,
709 because backwards may be left or right, depending on the
710 language. The arrow keys should be bound to #LFUN_CHAR_LEFT or
711 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
712 * \li Syntax: char-backward
715 { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit },
717 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD_SELECT
718 * \li Action: Moves the cursor one position logically backwards, adding
719 traversed position to the selection.
720 * \li Notion: See also #LFUN_CHAR_BACKWARD.
721 * \li Syntax: char-backward-select
724 { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit },
726 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_BACKWARD
727 * \li Action: Deletes one character in the backward direction (usually the "BackSpace" key).
728 * \li Syntax: char-delete-backward
731 { LFUN_CHAR_DELETE_BACKWARD, "char-delete-backward", SingleParUpdate, Edit },
733 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_FORWARD
734 * \li Action: Deletes one character in the backward direction (usually the "Delete" key).
735 * \li Syntax: char-delete-forward
738 { LFUN_CHAR_DELETE_FORWARD, "char-delete-forward", SingleParUpdate, Edit },
740 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD
741 * \li Action: Moves the cursor one position logically forward.
742 * \li Notion: This is not the action which should be bound to the arrow keys,
743 because forward may be left or right, depending on the language.
744 The arrow keys should be bound to #LFUN_CHAR_LEFT or
745 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
746 * \li Syntax: char-forward
749 { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit },
751 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD_SELECT
752 * \li Action: Moves the cursor one position logically forward, adding
753 traversed position to the selection.
754 * \li Notion: See also #LFUN_CHAR_FORWARD.
755 * \li Syntax: char-forward-select
758 { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit },
760 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT
761 * \li Action: Moves the cursor one position "to the left".
762 * \li Notion: This is the action which should be taken when the "left" key
763 is pressed. Generally, it moves the cursor one position to the
764 left. However, in Bidi text this become slightly more
765 complicated, and there are different modes of cursor movement.
766 In "visual mode", this moves left, plain and simple. In "logical
767 mode", movement is logically forward in RTL paragraphs, and
768 logically backwards in LTR paragraphs.
769 * \li Syntax: char-left
772 { LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit },
774 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT_SELECT
775 * \li Action: Moves the cursor one position "to the left", adding
776 traversed position to the selection.
777 * \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement.
778 * \li Syntax: char-left-select
781 { LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit },
783 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT
784 * \li Action: Moves the cursor one position "to the right".
785 * \li Notion: This is the action which should be taken when the "right" key
786 is pressed. Generally, it moves the cursor one position to the
787 right. However, in Bidi text this become slightly more
788 complicated, and there are different modes of cursor movement.
789 In "visual mode", this moves right, plain and simple. In "logical
790 mode", movement is logically forward in LTR paragraphs, and
791 logically backwards in RTL paragraphs.
792 * \li Syntax: char-right
795 { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit },
797 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT_SELECT
798 * \li Action: Moves the cursor one position "to the right", adding
799 traversed position to the selection.
800 * \li Notion: See also #LFUN_CHAR_RIGHT for exact details of the movement.
801 * \li Syntax: char-right-select
804 { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit },
807 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD
808 * \li Action: Moves the cursor to the logically previous beginning of a word.
809 * \li Notion: This is not the action which should be bound to the arrow keys,
810 because backwards may be left or right, depending on the
811 language. The arrow keys should be bound to #LFUN_WORD_LEFT or
812 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
813 * \li Syntax: word-backward
816 { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit },
818 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD_SELECT
819 * \li Action: Moves the cursor to the logically previous beginning of a word,
820 adding the logically traversed text to the selection.
821 * \li Notion: See also #LFUN_WORD_BACKWARD.
822 * \li Syntax: word-backward-select
825 { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
827 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_BACKWARD
828 * \li Action: Deletes characters to the begining of the word (usually the "C+BackSpace" key).
829 * \li Syntax: word-delete-backward
832 { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
834 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_FORWARD
835 * \li Action: Deletes characters to the end of the word (usually the "C+Delete" key).
836 * \li Syntax: word-delete-forward
839 { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
841 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_FORWARD
842 * \li Action: Search for a given string in forward direction.
843 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
844 * \li Syntax: word-find-forward [<STRING>]
845 * \li Origin: Etienne, 16 Feb 1998
848 { LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit },
850 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_BACKWARD
851 * \li Action: Search for a given string in backward direction.
852 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
853 * \li Syntax: word-find-backward [<STRING>]
854 * \li Origin: Etienne, 20 Feb 1998
857 { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
859 * \var lyx::FuncCode lyx::LFUN_WORD_FIND
860 * \li Action: Search for next occurence of a string.
861 * \li Syntax: word-find [<DATA>]
862 * \li Params: <DATA>: data encoded from Find dialog (see #lyx::find2string()).
863 If no parameter is given, search with last find-dialog
864 data is used for search (i.e. find-next).
865 * \li Origin: Andre, Jan 7 2004
868 { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
870 * \var lyx::FuncCode lyx::LFUN_WORD_REPLACE
871 * \li Action: Replace a string in the document.
872 * \li Syntax: word-replace [<DATA>]
873 * \li Params: <DATA>: data is of the form
876 <casesensitive> <matchword> <all> <forward>"
877 * \li Origin: Andre, Jan 7 2004
880 { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
882 * \var lyx::FuncCode lyx::LFUN_WORD_FINDADV
883 * \li Action: Search for next occurence of a pattern.
884 * \li Syntax: word-findadv [<DATA>]
885 * \li Params: <DATA>: data encoded from FindAdv dialog (see #lyx::findadv2string()).
886 If no parameter is given, search with last find-dialog
887 data is used for search (i.e. find-next).
888 * \li Origin: Tommaso, Nov 15 2007
891 { LFUN_WORD_FINDADV, "word-findadv", ReadOnly | NoBuffer, Edit },
893 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD
894 * \li Action: Moves the cursor to the logically next beginning of a word.
895 * \li Notion: This is not the action which should be bound to the arrow keys,
896 because forward may be left or right, depending on the language.
897 The arrow keys should be bound to #LFUN_WORD_LEFT or
898 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
899 * \li Syntax: word-forward
902 { LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
904 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD_SELECT
905 * \li Action: Moves the cursor to the logically next beginning of a word,
906 adding the logically traversed text to the selection.
907 * \li Notion: See also #LFUN_WORD_FORWARD.
908 * \li Syntax: word-forward-select
911 { LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
913 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT
914 * \li Action: Moves the cursor to the next beginning of a word "on the left".
915 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
916 "left" key is pressed. Generally, it moves the cursor to the
917 next beginning of a word on the left. However, in Bidi text this
918 become slightly more complicated, and there are different modes
919 of cursor movement. In "visual mode", this moves left, plain and
920 simple. In "logical mode", movement is logically forward in RTL
921 paragraphs, and logically backwards in LTR paragraphs.
922 * \li Syntax: word-left
923 * \li Origin: dov, 28 Oct 2007
926 { LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
928 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT_SELECT
929 * \li Action: Moves the cursor to the next beginning of a word "on the left",
930 adding *logically* traversed text to the selection.
931 * \li Notion: See also #LFUN_WORD_LEFT for exact details of the movement.
932 * \li Syntax: word-left-select
933 * \li Origin: dov, 28 Oct 2007
936 { LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit },
938 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT
939 * \li Action: Moves the cursor to the next beginning of a word "on the right".
940 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
941 "right" key is pressed. Generally, it moves the cursor to the
942 next beginning of a word on the right. However, in Bidi text
943 this become slightly more complicated, and there are different
944 modes of cursor movement. In "visual mode", this moves right,
945 plain and simple. In "logical mode", movement is logically
946 forward in LTR paragraphs, and logically backwards in RTL
948 * \li Syntax: word-right
949 * \li Origin: dov, 28 Oct 2007
952 { LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit },
954 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT_SELECT
955 * \li Action: Moves the cursor to the next beginning of a word "on the right",
956 adding *logically* traversed text to the selection.
957 * \li Notion: See also #LFUN_WORD_RIGHT for exact details of the movement.
958 * \li Syntax: word-right-select
959 * \li Origin: dov, 28 Oct 2007
962 { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
964 * \var lyx::FuncCode lyx::LFUN_WORD_SELECT
965 * \li Action: Puts the word where the cursor stands into the selection.
966 * \li Syntax: word-select
967 * \li Origin: Andre, 11 Sep 2002
970 { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
972 * \var lyx::FuncCode lyx::LFUN_WORD_CAPITALIZE
973 * \li Action: Capitalizes the words in the selection (i.e. the first letters)
974 or the letter on the cursor position.
975 * \li Syntax: word-capitalize
978 { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
980 * \var lyx::FuncCode lyx::LFUN_WORD_UPCASE
981 * \li Action: Change the words in the selection or from the cursor position
982 to the end of word to the upper case.
983 * \li Syntax: word-upcase
986 { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
988 * \var lyx::FuncCode lyx::LFUN_WORD_LOWCASE
989 * \li Action: Change the words in the selection or from the cursor position
990 to the end of word to the lower case.
991 * \li Syntax: word-lowcase
994 { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
996 * \var lyx::FuncCode lyx::LFUN_SPELLING_ADD
997 * \li Action: Add the word under the cursor to the respective
998 * spell checker dictionary.
999 * \li Syntax: spelling-add [<STRING>] [<LANG>]
1000 * \li Params: <WORD>: word to add
1001 <LANG>: language name (see file languages)
1002 * \li Origin: JSpitzm, 18 Jan 2010
1005 { LFUN_SPELLING_ADD, "spelling-add", ReadOnly, Edit },
1007 * \var lyx::FuncCode lyx::LFUN_SPELLING_IGNORE
1008 * \li Action: Let the spell checker ignore the word under the cursor
1009 * in the current session for the given language.
1010 * \li Syntax: spelling-ignore [<WORD>] [<LANG>]
1011 * \li Params: <WORD>: word to ignore
1012 <LANG>: language name (see file languages)
1013 * \li Origin: JSpitzm, 18 Jan 2010
1016 { LFUN_SPELLING_IGNORE, "spelling-ignore", ReadOnly, Edit },
1018 * \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
1019 * \li Action: Look up thesaurus entries with respect to the word under the cursor.
1020 * \li Syntax: thesaurus-entry [<STRING>] [lang=<LANG>]
1021 * \li Params: <STRING>: word to look up
1022 <LANG>: language (see file languages)
1023 * \li Origin: Levon, 20 Jul 2001
1026 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
1028 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN
1029 * \li Action: Move the cursor to the beginning of the document.
1030 * \li Syntax: buffer-begin
1033 { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
1035 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN_SELECT
1036 * \li Action: Move the cursor to the beginning of the document adding the
1037 traversed text to the selection.
1038 * \li Syntax: buffer-begin-select
1041 { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
1043 * \var lyx::FuncCode lyx::LFUN_BUFFER_END
1044 * \li Action: Move the cursor to the end of the document.
1045 * \li Syntax: buffer-end
1048 { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
1050 * \var lyx::FuncCode lyx::LFUN_BUFFER_END_SELECT
1051 * \li Action: Move the cursor to the end of the document adding the
1052 traversed text to the selection.
1053 * \li Syntax: buffer-end-select
1056 { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
1059 * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN
1060 * \li Action: Move the cursor to the beginning of the current inset
1061 if it is not already there, or at the beginning of the
1062 enclosing inset otherwise
1063 * \li Syntax: inset-begin
1064 * \li Origin: lasgouttes, 16 Mar 2009
1067 { LFUN_INSET_BEGIN, "inset-begin", ReadOnly, Edit },
1069 * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN_SELECT
1070 * \li Action: Move the cursor to the beginning of the current inset
1071 if it is not already there, or at the beginning of the
1072 enclosing inset otherwise (adding the
1073 traversed text to the selection).
1074 * \li Syntax: inset-begin-select
1075 * \li Origin: lasgouttes, 16 Mar 2009
1078 { LFUN_INSET_BEGIN_SELECT, "inset-begin-select", ReadOnly, Edit },
1080 * \var lyx::FuncCode lyx::LFUN_INSET_END
1081 * \li Action: Move the cursor to the end of the current inset
1082 if it is not already there, or at the end of the
1083 enclosing inset otherwise
1084 * \li Syntax: inset-end
1085 * \li Origin: lasgouttes, 16 Mar 2009
1088 { LFUN_INSET_END, "inset-end", ReadOnly, Edit },
1090 * \var lyx::FuncCode lyx::LFUN_INSET_END_SELECT
1091 * \li Action: Move the cursor to the end of the current inset
1092 if it is not already there, or at the end of the
1093 enclosing inset otherwise (adding the
1094 traversed text to the selection).
1095 * \li Syntax: inset-end-select
1096 * \li Origin: lasgouttes, 16 Mar 2009
1099 { LFUN_INSET_END_SELECT, "inset-end-select", ReadOnly, Edit },
1102 * \var lyx::FuncCode lyx::LFUN_INSET_SELECT_ALL
1103 * \li Action: Selects all contents of an inset.
1104 * \li Syntax: inset-select-all
1105 * \li Origin: vfr, 22 Aug 2009
1108 { LFUN_INSET_SELECT_ALL, "inset-select-all", ReadOnly, Edit },
1111 * \var lyx::FuncCode lyx::LFUN_SECTION_SELECT
1112 * \li Action: Selects the whole section.
1113 * \li Notion: The cursor should be in a section heading
1114 before calling this lfun.
1115 * \li Syntax: section-select
1116 * \li Origin: vfr, 05 May 2009
1119 { LFUN_SECTION_SELECT, "section-select", ReadOnly, Edit },
1122 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN
1123 * \li Action: Move the cursor to the begining of the (screen) line.
1124 * \li Syntax: line-begin
1127 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
1129 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN_SELECT
1130 * \li Action: Move the cursor to the beginning of the (screen) line adding the
1131 traversed text to the selection.
1132 * \li Syntax: line-begin-select
1135 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
1137 * \var lyx::FuncCode lyx::LFUN_LINE_END
1138 * \li Action: Move the cursor to the end of the (screen) line.
1139 * \li Syntax: line-end
1142 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
1144 * \var lyx::FuncCode lyx::LFUN_LINE_END_SELECT
1145 * \li Action: Move the cursor to the end of the (screen) line adding the
1146 traversed text to the selection.
1147 * \li Syntax: line-end-select
1150 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
1152 * \var lyx::FuncCode lyx::LFUN_LINE_DELETE
1153 * \li Action: Deletes the letters to the end of the (screen) line or
1154 deletes the selection.
1155 * \li Syntax: line-delete-forward
1158 { LFUN_LINE_DELETE, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
1160 * \var lyx::FuncCode lyx::LFUN_COPY
1161 * \li Action: Copies to the clipboard the last edit.
1165 { LFUN_COPY, "copy", ReadOnly, Edit },
1167 * \var lyx::FuncCode lyx::LFUN_CUT
1168 * \li Action: Cuts to the clipboard.
1172 { LFUN_CUT, "cut", Noop, Edit },
1174 * \var lyx::FuncCode lyx::LFUN_PASTE
1175 * \li Action: Pastes material (text or picture) from the active clipboard.
1176 * \li Syntax: paste [<TYPE>|<NUM>]
1177 * \li Params: <TYPE>: emf|pdf|png|jpeg|linkback|wmf \n
1178 <NUM>: number of the selection in the internal clipboard stack to be pasted.
1181 { LFUN_PASTE, "paste", Noop, Edit },
1183 * \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE
1184 * \li Action: Pastes text from the active clipboard.
1185 * \li Syntax: clipboard-paste [<ARG>]
1186 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1187 * \li Origin: baum, 10 Jul 2006
1190 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
1192 * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
1193 * \li Action: Pastes the currently text selected text.
1194 * \li Notion: Primary selection mechanism is linux-only thing.
1195 * \li Syntax: primary-selection-paste [<ARG>]
1196 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1199 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
1201 * \var lyx::FuncCode lyx::LFUN_SELECTION_PASTE
1202 * \li Action: Pastes the text in permanent selection.
1203 * \li Syntax: selection-paste
1206 { LFUN_SELECTION_PASTE, "selection-paste", Noop, Edit },
1208 * \var lyx::FuncCode lyx::LFUN_UNDO
1209 * \li Action: Undoes the last edit.
1213 { LFUN_UNDO, "undo", Noop, Edit },
1215 * \var lyx::FuncCode lyx::LFUN_REDO
1216 * \li Action: Redoes the last thing undone.
1220 { LFUN_REDO, "redo", Noop, Edit },
1222 * \var lyx::FuncCode lyx::LFUN_REPEAT
1223 * \li Action: Repeat the given command.
1224 * \li Syntax: repeat <COUNT> <LFUN-COMMAND>
1225 * \li Origin: Andre, 27 Oct 2003
1228 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
1230 * \var lyx::FuncCode lyx::LFUN_CHARS_TRANSPOSE
1231 * \li Action: Transposes the character at the cursor with the one before it.
1232 * \li Syntax: chars-transpose
1233 * \li Origin: Lgb, 25 Apr 2001
1236 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
1239 * \var lyx::FuncCode lyx::LFUN_DEPTH_DECREMENT
1240 * \li Action: Decrease the nesting depth of the (selected) paragraph(s)
1242 * \li Syntax: depth-decrement
1245 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
1247 * \var lyx::FuncCode lyx::LFUN_DEPTH_INCREMENT
1248 * \li Action: Increase the nesting depth of the (selected) paragraph(s)
1250 * \li Syntax: depth-increment
1253 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
1256 * \var lyx::FuncCode lyx::LFUN_FONT_BOLD
1257 * \li Action: Toggles the bold font (selection-wise) using mathbf in math.
1258 * \li Syntax: font-bold
1261 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
1264 * \var lyx::FuncCode lyx::LFUN_FONT_BOLDSYMBOL
1265 * \li Action: Toggles the bold font (selection-wise) using boldsymbol in math.
1266 * \li Syntax: font-boldsymbol
1269 { LFUN_FONT_BOLDSYMBOL, "font-boldsymbol", Noop, Layout },
1271 * \var lyx::FuncCode lyx::LFUN_FONT_TYPEWRITER
1272 * \li Action: Toggles the typewriter family font (selection-wise).
1273 * \li Syntax: font-typewriter
1276 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
1278 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERLINE
1279 * \li Action: Toggles underline in the font (selection-wise).
1280 * \li Syntax: font-underline
1283 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
1285 * \var lyx::FuncCode lyx::LFUN_FONT_UULINE
1286 * \li Action: Toggles double underline in the font (selection-wise).
1287 * \li Syntax: font-underunderline
1288 * \li Origin: sanda, 5 May 2009
1291 { LFUN_FONT_UULINE, "font-underunderline", Noop, Layout },
1293 * \var lyx::FuncCode lyx::LFUN_FONT_UWAVE
1294 * \li Action: Toggles wavy underline in the font (selection-wise).
1295 * \li Syntax: font-underwave
1296 * \li Origin: sanda, 5 May 2009
1299 { LFUN_FONT_UWAVE, "font-underwave", Noop, Layout },
1301 * \var lyx::FuncCode lyx::LFUN_FONT_STRIKEOUT
1302 * \li Action: Toggles strikeout (strike-through) in the font (selection-wise).
1303 * \li Syntax: font-strikeout
1304 * \li Origin: sanda, 3 May 2009
1307 { LFUN_FONT_STRIKEOUT, "font-strikeout", Noop, Layout },
1309 * \var lyx::FuncCode lyx::LFUN_FONT_EMPH
1310 * \li Action: Toggles the emphasis font style (selection-wise).
1311 * \li Syntax: font-emph
1314 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
1316 * \var lyx::FuncCode lyx::LFUN_FONT_NOUN
1317 * \li Action: Toggles Noun text style font (selection-wise).
1318 * \li Syntax: font-noun
1321 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
1323 * \var lyx::FuncCode lyx::LFUN_FONT_ROMAN
1324 * \li Action: Toggles Roman family font (selection-wise).
1325 * \li Syntax: font-roman
1328 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
1330 * \var lyx::FuncCode lyx::LFUN_FONT_SANS
1331 * \li Action: Toggles Sans Serif family font (selection-wise).
1332 * \li Syntax: font-sans
1335 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
1337 * \var lyx::FuncCode lyx::LFUN_FONT_FRAK
1338 * \li Action: Toggles Fraktur family font (math-mode, selection-wise).
1339 * \li Syntax: font-frak
1340 * \li Origin: vermeer, 10 Jan 2002
1343 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
1345 * \var lyx::FuncCode lyx::LFUN_FONT_ITAL
1346 * \li Action: Toggles Italics font shape (math-mode, selection-wise).
1347 * \li Syntax: font-ital
1348 * \li Origin: vermeer, 10 Jan 2002
1351 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
1353 * \var lyx::FuncCode lyx::LFUN_FONT_DEFAULT
1354 * \li Action: Reverts the settings of the font to the default values (selection-wise).
1355 * \li Syntax: font-default
1358 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
1360 * \var lyx::FuncCode lyx::LFUN_FONT_SIZE
1361 * \li Action: Sets font size according to lyx format string.
1362 * \li Syntax: font-size <SIZE>
1363 * \li Params: <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|\n
1364 largest|huge|giant|increase|decrease|default
1367 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
1369 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_APPLY
1370 * \li Action: Toggle user-defined (=last-time used) text style.
1371 * \li Notion: This style is set via #LFUN_TEXTSTYLE_UPDATE, which is
1372 automatically trigerred when using Text Style dialog.
1373 * \li Syntax: textstyle-apply
1374 * \li Origin: leeming, 12 Mar 2003
1377 { LFUN_TEXTSTYLE_APPLY, "textstyle-apply", Noop, Layout },
1379 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_UPDATE
1380 * \li Action: Apply text style and update the settings to be used by #LFUN_TEXTSTYLE_APPLY.
1381 * \li Syntax: textstyle-update <FONT_INFO>
1382 * \li Params: <FONT_INFO>: specifies font atributes, e.g. family, series, shape,
1383 size, emph, noun, underbar, number, color, language,
1385 Use lyx -dbg action for exact syntax of text-style
1387 * \li Origin: leeming, 12 Mar 2003
1390 { LFUN_TEXTSTYLE_UPDATE, "textstyle-update", Noop, Layout },
1392 * \var lyx::FuncCode lyx::LFUN_SCREEN_FONT_UPDATE
1393 * \li Action: Update fonts and its metrics.
1394 * \li Notion: Automatically called after zoom, dpi, font names, or norm change.
1395 * \li Syntax: screen-font-update
1396 * \li Origin: ARRae, 13 Aug 2000
1399 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
1401 * \var lyx::FuncCode lyx::LFUN_FONT_STATE
1402 * \li Action: Returns the info about the current font.
1403 * \li Syntax: font-state
1406 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
1409 * \var lyx::FuncCode lyx::LFUN_CITATION_INSERT
1410 * \li Action: Inserts citation from loaded citation database.
1411 * \li Syntax: citation-insert [<KEY>[|<TEXT_BEFORE>]]
1412 * \li Params: <KEY>: Citation (shortcut listed in available citations). \n
1413 <TEXT_BEFORE>: text which should appear before citation.
1414 * \li Origin: AAS, 97-02-23
1417 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
1419 * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_ADD
1420 * \li Action: Adds database, which will be used for bibtex citations.
1421 * \li Notion: Databases are added to the first BibTeX inset
1422 (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
1423 * \li Syntax: bibtex-database-add <DATABASE-NAME>
1424 * \li Origin: Ale, 30 May 1997
1427 { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit },
1429 * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_DEL
1430 * \li Action: Adds database, which will be used for bibtex citations.
1431 * \li Notion: Databases are deleted from the first BibTeX inset
1432 (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
1433 * \li Syntax: bibtex-database-del <DATABASE-NAME>
1434 * \li Origin: Ale, 30 May 1997
1437 { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
1440 * \var lyx::FuncCode lyx::LFUN_LAYOUT
1441 * \li Action: Sets the layout (that is, environment) for the current paragraph.
1442 * \li Syntax: layout <LAYOUT>
1443 * \li Params: <LAYOUT>: the layout to use
1446 { LFUN_LAYOUT, "layout", Noop, Layout },
1448 * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH
1449 * \li Action: Launches the paragraph settings dialog.
1450 * \li Syntax: layout-paragraph
1453 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
1455 * \var lyx::FuncCode lyx::LFUN_LAYOUT_TABULAR
1456 * \li Action: Launches the tabular settings dialog.
1457 * \li Syntax: layout-tabular
1458 * \li Origin: Jug, 31 Jul 2000
1461 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
1463 * \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE
1464 * \li Action: Displays list of layout choices.
1465 * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
1466 dropbox allowing for choice of layout.
1467 * \li Syntax: drop-layouts-choice
1470 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
1472 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
1473 * \li Action: Clears the module list.
1474 * \li Notion: Clears the list of included modules for the current buffer.
1475 * \li Syntax: layout-modules-clear
1476 * \li Origin: rgh, 25 August 2007
1479 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", NoInternal, Layout },
1481 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULE_ADD
1482 * \li Action: Adds a module.
1483 * \li Notion: Adds a module to the list of included modules for the current buffer.
1484 * \li Syntax: layout-module-add <MODULE>
1485 * \li Params: <MODULE>: the module to be added
1486 * \li Origin: rgh, 25 August 2007
1489 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", NoInternal, Layout },
1491 * \var lyx::FuncCode lyx::LFUN_LAYOUT_RELOAD
1492 * \li Action: Reloads layout information.
1493 * \li Notion: Reloads all layout information for the current buffer from disk, thus
1494 recognizing any changes that have been made to layout files on the fly.
1495 This is intended to be used only by layout developers and should not be
1496 used when one is trying to do actual work.
1497 * \li Syntax: layout-reload
1498 * \li Origin: rgh, 3 September 2007
1501 { LFUN_LAYOUT_RELOAD, "layout-reload", NoInternal, Layout },
1503 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
1504 * \li Action: Sets the text class for the current buffer.
1505 * \li Syntax: textclass-apply <TEXTCLASS>
1506 * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
1507 the filename, minus the ".layout" extension.
1510 { LFUN_TEXTCLASS_APPLY, "textclass-apply", NoInternal, Layout },
1512 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
1513 * \li Action: Loads information for a textclass from disk.
1514 * \li Syntax: textclass-load <TEXTCLASS>
1515 * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
1516 the filename, minus the ".layout" extension.
1519 { LFUN_TEXTCLASS_LOAD, "textclass-load", NoInternal, Layout },
1522 * \var lyx::FuncCode lyx::LFUN_MARK_OFF
1523 * \li Action: Disable selecting of text-region.
1524 * \li Syntax: mark-off
1527 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
1529 * \var lyx::FuncCode lyx::LFUN_MARK_ON
1530 * \li Action: Enable selecting of text-region.
1531 * \li Notion: After enabling you can simply move arrow keys to get selected region.
1532 * \li Syntax: mark-on
1535 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
1537 * \var lyx::FuncCode lyx::LFUN_MARK_TOGGLE
1538 * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
1539 * \li Syntax: mark-toggle
1540 * \li Origin: Andre, May 5 2006
1543 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
1546 * \var lyx::FuncCode lyx::LFUN_MATH_DELIM
1547 * \li Action: Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
1548 * \li Syntax: math-delim [<LEFT>] [<RIGHT>]
1549 * \li Params: <LEFT/RIGHT>: Delimiters to be used. Each delimiter can be specified by
1550 either a LaTeX name or a valid character.
1551 ( is the default letter.
1552 * \li Sample: math-delim { rangle
1553 * \li Origin: Alejandro, 18 Jun 1996
1556 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
1558 * \var lyx::FuncCode lyx::LFUN_MATH_BIGDELIM
1559 * \li Action: Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
1560 * \li Syntax: math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
1561 * \li Params: <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r \n
1562 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
1563 * \li Sample: math-bigdelim "Bigl" "\Downarrow" "Bigr" "\}"
1564 * \li Origin: Enrico & Georg, 7 May 2006
1567 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
1569 * \var lyx::FuncCode lyx::LFUN_MATH_DISPLAY
1570 * \li Action: Creates a new displayed equation in text mode.
1571 Toggles inlined/display formula in math mode.
1572 * \li Syntax: math-display [<ARG>]
1573 * \li Params: <ARG>: this argument will be passed to #LFUN_MATH_INSERT when creating
1574 new equation from the text mode.
1575 * \li Origin: Alejandro, 18 Jun 1996
1578 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
1580 * \var lyx::FuncCode lyx::LFUN_MATH_INSERT
1581 * \li Action: Inserts math objects and symbols.
1582 * \li Syntax: math-insert <ARG>
1583 * \li Params: <ARG>: Symbol or LaTeX code to be inserted.
1584 * \li Notion: When <ARG> is a _single_ math inset with more than one cell
1585 (such as "x_y^z" or "\frac{x}{y}"), the content of cell(0) is
1586 replaced by the current selection (only works if the selection
1587 is in mathed). As an example, if "abc" is selected in mathed,
1588 "math-insert \frac{x}{y}" replaces "abc" with "\frac{abc}{y}",
1589 and "math-insert x_y^z" replaces "abc" with "abc_y^z".
1590 If nothing is selected (or the selection is not in mathed),
1591 math-insert works as expected.
1594 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
1596 * \var lyx::FuncCode lyx::LFUN_MATH_SUBSCRIPT
1597 * \li Action: Enters subscript expression in math expression.
1598 * \li Syntax: math-subscript
1599 * \li Origin: vermeer, 12 Dec 2001
1602 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
1604 * \var lyx::FuncCode lyx::LFUN_MATH_SUPERSCRIPT
1605 * \li Action: Enters subscript expression in math expression.
1606 * \li Syntax: math-superscript
1607 * \li Origin: vermeer, 12 Dec 2001
1610 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
1612 * \var lyx::FuncCode lyx::LFUN_MATH_LIMITS
1613 * \li Action: Toggles the position of the limits from above/below to the right
1614 side an vice versa in integral symbol, a limit, a summation, etc.
1615 * \li Notion: Put the cursor before the symbol with the limits and then invoke
1617 * \li Syntax: math-limits [<STATE>]
1618 * \li Params: <STATE>: limits|nolimits
1621 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
1623 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO
1624 * \li Action: Inserts a math macro definition at the cursor position in the text.
1625 * \li Syntax: math-macro <NAME> [<NARGS>] [def]
1626 * \li Params: <NAME>: The name of the macro, e.g. "mymacro".\n
1627 <NARGS>: The number of parameters of the macro. Default is 0.
1628 "def": Has no effect anymore, just for compatibility with former LyX versions.
1629 * \li Origin: ale, 10 May 1997; sts, 21 Dec 2007
1632 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
1634 * \var lyx::FuncCode lyx::LFUN_MATH_MUTATE
1635 * \li Action: Mutates the type of math inset to the newly selected one.
1636 * \li Syntax: math-mutate <TYPE>
1637 * \li Params: <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
1638 multline|gather|flalign
1639 * \li Origin: Andre, 23 May 2001
1642 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
1644 * \var lyx::FuncCode lyx::LFUN_MATH_SPACE
1645 * \li Action: Inserts space into math expression.
1646 * \li Notion: Use spacebar after entering this space to change type of space.
1647 * \li Syntax: math-space [<TYPE>] [<LEN>]
1648 * \li Params: <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace \n
1649 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad \n
1650 custom space: hspace \n
1651 "," used by default.\n
1652 Note that ! is equivalent to negthinspace, , = thinspace,
1653 : = medspace, and ; = thickspace.\n
1654 <LEN>: length for custom spaces (hspace)
1655 * \li Origin: Andre, 25 Jul 2001; sanda, 16 Jun 2008
1658 { LFUN_MATH_SPACE, "math-space", Noop, Math },
1660 * \var lyx::FuncCode lyx::LFUN_MATH_MATRIX
1661 * \li Action: Inserts a matrix.
1662 * \li Syntax: math-matrix <COLS> <ROWS> [<ALIGN>]
1663 * \li Params: <ALIGN>: Alignment is a word composed of the vertical alignment
1664 (b, c or t) (i.e. 1 char) and the horizontal alignments
1665 (l, c or r) (i.e. <COL> chars).
1666 * \li Sample: math-matrix 3 3 bccc
1669 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
1671 * \var lyx::FuncCode lyx::LFUN_MATH_AMS_MATRIX
1672 * \li Action: Inserts a matrix.
1673 * \li Syntax: math-matrix <COLS> <ROWS> [<DECORATION>]
1674 * \li Params: <DECORATION>: Decoration determines the LaTeX name of the matrix
1675 that should be created.
1676 * \li Sample: math-ams-matrix 3 3 bmatrix
1679 { LFUN_MATH_AMS_MATRIX, "math-ams-matrix", Noop, Math },
1681 * \var lyx::FuncCode lyx::LFUN_MATH_MODE
1682 * \li Action: In text mode enters math mode (i.e. puts math insets on the current
1683 cursor position), in math mode enters text mode inside math expression.
1684 * \li Notion: If there is some selected text, it puts the text inside created math box.
1685 * \li Syntax: math-mode [on|<ARG>]
1686 * \li Params: <ARG>: eventual argument (LaTeX code) is passed to #LFUN_MATH_INSERT .\n
1687 "on": allow only entering of math mode from text mode.
1688 * \li Origin: Alejandro, 4 Jun 1996
1691 { LFUN_MATH_MODE, "math-mode", Noop, Math },
1693 * \var lyx::FuncCode lyx::LFUN_REGEXP_MODE
1694 * \li Action: Enters regexp mode (i.e., puts regexp insets on the current
1695 cursor position). Used by the advanced search dialog.
1696 * \li Notion: If there is any selected text, then it is moved inside the created
1698 * \li Syntax: regexp-mode [<ARG>]
1699 * \li Params: <ARG>: eventual argument (regular expression).
1700 * \li Origin: Tommaso, 4 Oct 2008
1703 { LFUN_REGEXP_MODE, "regexp-mode", Noop, Math },
1705 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
1706 * \li Action: Toggles numbering of the current formula line.
1707 * \li Notion: Must be in display formula mode.
1708 * \li Syntax: math-number-line-toggle
1709 * \li Origin: Alejandro, 18 Jun 1996
1712 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
1714 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
1715 * \li Action: Toggles numbering/labeling of the current formula.
1716 * \li Notion: Must be in display formula mode.
1717 * \li Syntax: math-number-toggle
1718 * \li Origin: Alejandro, 4 Jun 1996
1721 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
1723 * \var lyx::FuncCode lyx::LFUN_MATH_EXTERN
1724 * \li Action: Calls external program and passes the current expression/equation
1725 as an argument for the calculation in the format appropriate to the
1727 * \li Notion: Selection can be used to determine the input for the external program.
1728 * \li Syntax: math-extern <LANG> [<COMMAND>]
1729 * \li Params: <LANG>: octave|maxima|maple|mathematica|script \n
1730 where "script" stands fot the external script (normalized
1731 expression will be passed)
1732 * \li Origin: Andre, 24 Apr 2001
1733 * \li Sample: math-extern maple simplify
1736 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
1738 * \var lyx::FuncCode lyx::LFUN_MATH_SIZE
1739 * \li Action: Changes arbitrarily the size used by math fonts inside a context.
1740 * \li Notion: Provides an interface to the LaTeX math mode font size commands.
1741 * \li Syntax: math-size <STYLE>
1742 * \li Params: <STYLE>: \displaystyle|\textstyle|\scriptstyle|\scriptscriptstyle
1743 * \li Origin: Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
1746 { LFUN_MATH_SIZE, "math-size", Noop, Math },
1748 * \var lyx::FuncCode lyx::LFUN_MATH_FONT_STYLE
1749 * \li Action: Changes the text style used in math.
1750 * \li Syntax: math-font-style <STYLE>
1751 * \li Params: <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf
1752 |textnormal|textrm|textsf|texttt|textbf|textmd|textit
1753 |textsc|textsl|textup
1754 * \li Origin: vfr, 9 jan 2009
1757 { LFUN_MATH_FONT_STYLE, "math-font-style", Noop, Math },
1759 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
1760 * \li Action: Unfold a Math Macro.
1761 * \li Notion: Unfold the Math Macro the cursor is in, i.e.
1763 * \li Syntax: math-macro-unfold
1764 * \li Origin: sts, 06 January 2008
1767 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
1769 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
1770 * \li Action: Fold a Math Macro.
1771 * \li Notion: Fold the Math Macro the cursor is in if it was
1772 unfolded, i.e. displayed as \foo before.
1773 * \li Syntax: math-macro-fold
1774 * \li Origin: sts, 06 January 2008
1777 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
1779 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
1780 * \li Action: Add a parameter.
1781 * \li Notion: Add a parameter to a Math Macro.
1782 * \li Params: <NUM>: The number of the parameter behind which the new one
1783 will be added (1 for the first, i.e. use 0 for add a
1784 parameter at the left), defaults to the last one.
1785 * \li Syntax: math-macro-add-param <NUM>
1786 * \li Origin: sts, 06 January 2008
1789 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
1791 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
1792 * \li Action: Remove the last parameter.
1793 * \li Notion: Remove the last parameter of a Math Macro and
1794 remove its value in all instances of the macro
1796 * \li Params: <NUM>: The number of the parameter to be deleted (1 for
1797 the first), defaults to the last one.
1798 * \li Syntax: math-macro-remove-param <NUM>
1799 * \li Origin: sts, 06 January 2008
1802 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
1804 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
1805 * \li Action: Append a greedy parameter.
1806 * \li Notion: Append a greedy parameter to a Math Macro which
1807 eats the following mathed cell in every instance of
1808 the macro in the buffer.
1809 * \li Syntax: math-macro-append-greedy-param
1810 * \li Origin: sts, 06 January 2008
1813 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
1815 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
1816 * \li Action: Remove a greedy parameter.
1817 * \li Notion: Remove a greedy parameter of a Math Macro and spit
1818 out the values of it in every instance of the macro
1819 in the buffer. If it is an optional parameter the [valud]
1821 * \li Syntax: math-macro-remove-greedy-param
1822 * \li Origin: sts, 06 January 2008
1825 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
1827 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
1828 * \li Action: Make a parameter optional.
1829 * \li Notion: Turn the first non-optional parameter of a Math Macro
1830 into an optional parameter with a default value.
1831 * \li Syntax: math-macro-make-optional
1832 * \li Origin: sts, 06 January 2008
1835 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
1837 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
1838 * \li Action: Make a parameter non-optional.
1839 * \li Notion: Turn the last optional parameter of a Math Macro
1840 into a non-optional parameter. The default value is
1841 remembered to be reused later if the user changes his mind.
1842 * \li Syntax: math-macro-make-nonoptional
1843 * \li Origin: sts, 06 January 2008
1846 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
1848 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
1849 * \li Action: Add an optional parameter.
1850 * \li Notion: Insert an optional parameter just behind the
1851 already existing optional parameters.
1852 * \li Syntax: math-macro-add-optional-param
1853 * \li Origin: sts, 06 January 2008
1856 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
1858 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
1859 * \li Action: Remove the last optional parameter.
1860 * \li Notion: Remove the last optional parameter of a Math Macro and
1861 remove it in all the instances of the macro in the buffer.
1862 * \li Syntax: math-macro-remove-optional-param
1863 * \li Origin: sts, 06 January 2008
1866 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
1868 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
1869 * \li Action: Add a greedy optional parameter.
1870 * \li Notion: Add a greedy optional parameter which eats the value
1871 from the following cells in mathed which are in the [value]
1873 * \li Syntax: math-macro-add-greedy-optional-param
1874 * \li Origin: sts, 06 January 2008
1877 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
1879 * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
1880 * \li Action: Only active in Math Macro definition.
1881 * \li Notion: Dummy function which is only active in a Math Macro definition.
1882 It's used to toggle the Math Macro toolbar if the cursor moves
1883 into a Math Macro definition.
1884 * \li Syntax: in-mathmacrotemplate
1885 * \li Origin: sts, 06 January 2008
1888 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
1891 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
1892 * \li Action: Moves the current paragraph downwards in the document.
1893 * \li Syntax: paragraph-move-down
1894 * \li Origin: Edwin, 8 Apr 2006
1897 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
1899 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
1900 * \li Action: Moves the current paragraph upwards in the document.
1901 * \li Syntax: paragraph-move-up
1902 * \li Origin: Edwin, 8 Apr 2006
1905 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
1908 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP
1909 * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1910 in upward direction.
1911 * \li Syntax: paragraph-up
1912 * \li Origin: Asger, 1 Oct 1996
1915 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
1917 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP_SELECT
1918 * \li Action: Move the cursor and select the text to the next paragraph (or
1919 begining of the current one) in upward direction.
1920 * \li Syntax: paragraph-up-select
1921 * \li Origin: Asger, 1 Oct 1996
1924 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
1926 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN
1927 * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1928 in downward direction.
1929 * \li Syntax: paragraph-down
1930 * \li Origin: Asger, 1 Oct 1996
1933 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
1935 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN_SELECT
1936 * \li Action: Move the cursor and select the text to the next paragraph (or
1937 begining of the current one) in downward direction.
1938 * \li Syntax: paragraph-down-select
1939 * \li Origin: Asger, 1 Oct 1996
1942 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
1944 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
1945 * \li Action: Jump to a paragraph given by its id number and optionally the
1946 desired position within the paragraph.
1947 * \li Notion: Note that id number of paragraph is not the sequential number of paragraph
1948 seen on the screen. Moreover the id is unique for all opened buffers (documents).
1949 * \li Syntax: paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
1950 * \li Params: <PAR_ID_NUMBER>: paragraph id \n
1951 <POSITION_IN_PAR>: desired position within the paragraph
1952 * \li Origin: Dekel, 26 Aug 2000
1955 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly | NoInternal, Edit },
1957 * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1958 * \li Action: Breaks the current paragraph at the current location.
1959 * \li Notion: Removes the selection.
1960 * \li Syntax: break-paragraph [<LAYOUT>]
1961 * \li Params: <LAYOUT>: "inverse" - decreases depth by one (or change layout
1962 to default layout) when the cursor is at the end of
1966 { LFUN_BREAK_PARAGRAPH, "break-paragraph", Noop, Edit },
1968 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
1969 * \li Action: Change paragraph settings.
1970 * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
1971 This function only modifies, and does not override, existing settings.
1972 Note that the "leftindent" indent setting is deprecated.
1973 * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
1974 * \li Params: <INDENT>: \noindent|\indent|\indent-toggle|\leftindent LENGTH\n
1975 <SPACING>: \paragraph_spacing default|single|onehalf|double|other SIZE \n
1976 <ALIGN>: \align block|left|right|center|default\n
1977 <OTHERS>: \labelwidthstring WIDTH|\start_of_appendix
1978 * \li Origin: rgh, Aug 15 2007
1981 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
1983 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
1984 * \li Action: Change paragraph settings.
1985 * \li Notion: Overwrite all nonspecified settings to the default ones.
1986 Use paragraph-params lfun if you don't want to overwrite others settings.
1987 * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
1988 * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
1989 * \li Origin: leeming, 30 Mar 2004
1992 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
1994 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UPDATE
1995 * \li Action: Updates the values inside the paragraph dialog from the paragraph.
1996 * \li Notion: This is internal LFUN, not to be used by users. Called internally
1997 by #LFUN_DIALOG_UPDATE.
1998 * \li Origin: leeming, 13 Mar 2003
2001 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
2004 * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
2005 * \li Action: Move the current group in the upward direction in the
2006 structure of the document.
2007 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
2008 the whole substructure of the group.
2009 * \li Syntax: outline-up
2010 * \li Origin: Vermeer, 23 Mar 2006
2013 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
2015 * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
2016 * \li Action: Move the current group in the downward direction in the
2017 structure of the document.
2018 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
2019 the whole substructure of the group.
2020 * \li Syntax: outline-down
2021 * \li Origin: Vermeer, 23 Mar 2006
2024 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
2026 * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
2027 * \li Action: Moves the current group in the downward direction in the
2028 hierarchy of the document structure.
2029 * \li Notion: Part -> Chapter -> Section -> etc.
2030 * \li Syntax: outline-in
2031 * \li Origin: Vermeer, 23 Mar 2006
2034 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
2036 * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
2037 * \li Action: Moves the current group in the upward direction in the
2038 hierarchy of the document structure.
2039 * \li Notion: Part <- Chapter <- Section <- etc.
2040 * \li Syntax: outline-out
2041 * \li Origin: Vermeer, 23 Mar 2006
2044 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
2047 * \var lyx::FuncCode lyx::LFUN_INSET_EDIT
2048 * \li Action: Edit the inset at cursor with an external application,
2049 if one is attributed.
2050 * \li Syntax: inset-edit [<INSET_PARAMS>]
2051 * \li Params: <INSET_PARAMS>: Parameters for the inset. \n
2052 Currently only the filename will be considered.
2053 * \li Origin: JSpitzm, 27 Apr 2006
2056 { LFUN_INSET_EDIT, "inset-edit", ReadOnly, Edit },
2059 * \var lyx::FuncCode lyx::LFUN_TABULAR_INSERT
2060 * \li Action: Inserts table into the document.
2061 * \li Notion: See #LFUN_INSET_MODIFY for some more details
2062 about tabular modifications.
2063 * \li Syntax: tabular-insert [<ROWS> <COLUMNS>]
2064 * \li Params: In case no arguments are given show insert dialog.
2065 * \li Origin: Jug, 12 Apr 2000
2068 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
2071 * \var lyx::FuncCode lyx::LFUN_CELL_BACKWARD
2072 * \li Action: Moves the cursor to the previous cell inside the table.
2073 * \li Syntax: cell-backward
2074 * \li Origin: Jug, 22 May 2000
2077 { LFUN_CELL_BACKWARD, "cell-backward", Noop, Edit },
2079 * \var lyx::FuncCode lyx::LFUN_CELL_FORWARD
2080 * \li Action: Moves the cursor to the next cell inside the table.
2081 * \li Syntax: cell-forward
2084 { LFUN_CELL_FORWARD, "cell-forward", Noop, Edit },
2086 * \var lyx::FuncCode lyx::LFUN_CELL_SPLIT
2087 * \li Action: Splits cell and shifts right part to the next cell (inside the math grid).
2088 * \li Syntax: cell-split
2089 * \li Origin: Ale, 15 May 1997
2092 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
2095 * \var lyx::FuncCode lyx::LFUN_VC_REGISTER
2096 * \li Action: Register the document as an file inside version control system (RCS, CVS).
2097 * \li Notion: File is registered inside cvs, svn or rcs repository acording to the existence
2098 of cvs/svn/rcs entries in the document's directory. \n
2099 See LyX Additional Features Manual (Version Control Chapter) for additional
2101 * \li Syntax: vc-register
2102 * \li Origin: Lgb, 1 Jul 1997
2105 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
2107 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_IN
2108 * \li Action: Checks-in/commits the changes of the registered file to the repository.
2109 * \li Notion: In RCS case this also unlocks the file.
2110 * \li Syntax: vc-check-in
2111 * \li Origin: Lgb, 1 Jul 1997
2114 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
2116 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_OUT
2117 * \li Action: Checks-out the document for edit (and locks it for RCS).
2118 * \li Notion: This is implemented only for RCS and SVN, not CVS.
2119 * \li Syntax: vc-check-out
2120 * \li Origin: Lgb, 1 Jul 1997
2123 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
2125 * \var lyx::FuncCode lyx::LFUN_VC_REVERT
2126 * \li Action: Reverts the document to the last check-in/commit in VCS.
2127 * \li Syntax: vc-revert
2128 * \li Origin: Lgb, 1 Jul 1997
2131 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
2133 * \var lyx::FuncCode lyx::LFUN_VC_UNDO_LAST
2134 * \li Action: Undo last check-in.
2135 * \li Notion: This is currently implemented only for RCS.
2136 * \li Syntax: vc-check-out
2137 * \li Origin: Lgb, 1 Jul 1997
2140 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
2142 * \var lyx::FuncCode lyx::LFUN_VC_COMMAND
2143 * \li Action: Executes external command. This command is intended to support
2144 additional VCS commands.
2145 * \li Syntax: vc-command <FLAG> <PATH> <COMMAND>
2146 * \li Params: <FLAG>: Flags for the command can be combined together.\n
2147 U - dUmmy - no flags \n
2148 D - Doc - need document loaded to proceed \n
2149 I - dIrty - mark document dirty \n
2150 R - Reload - ensure that the document is saved and reload it after command execution \n
2151 M - Message - ask for input string (commit message)\n
2152 <PATH>: path where to start. $$p will be replaced by the current document path.\n
2153 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current
2154 document(with absolute path)/path/message.
2155 * \li Sample: vc-command DR $$p "svn up"
2156 * \li Origin: sanda, 13 Jan 2009
2159 { LFUN_VC_COMMAND, "vc-command", NoBuffer | ReadOnly, System },
2161 * \var lyx::FuncCode lyx::LFUN_VC_LOCKING_TOGGLE
2162 * \li Action: Toggles the locking property of the edited file.
2163 * \li Notion: This is currently implemented only for SVN.
2164 * \li Syntax: vc-locking-toggle
2165 * \li Origin: sanda, 25 Jun 2009
2168 { LFUN_VC_LOCKING_TOGGLE, "vc-locking-toggle", ReadOnly, System },
2170 * \var lyx::FuncCode lyx::LFUN_VC_REPO_UPDATE
2171 * \li Action: Update the local archive directory in which resides
2172 the current document with the remote repository.
2173 * \li Notion: This is currently implemented only for SVN.
2174 * \li Syntax: vc-repo-update
2175 * \li Origin: sanda, 16 Oct 2009
2178 { LFUN_VC_REPO_UPDATE, "vc-repo-update", ReadOnly, System },
2180 * \var lyx::FuncCode lyx::LFUN_VC_COMPARE
2181 * \li Action: Compares two revisions of the same file under version control.
2182 * \li Notion: This is currently implemented only for SVN and RCS.
2183 * \li Syntax: vc-compare <REV1> [<REV2>]
2184 * \li Params: Revision number either points directly to commit in history
2185 or if negative number -x it points to last commit - x.\n
2186 In RCS we subtract only in the last number of revision specification.
2187 Special case "0" is reserved for the last committed revision.\n
2188 <REV1>: Older file.\n
2189 <REV2>: Newer file. Used only if REV1 > 0.
2190 * \li Sample: Compare current document against last commit\n
2192 * \li Sample: Compare current document against current revision - 5 commits\n
2194 * \li Sample: Compare revisions 120 and 155\n
2196 * \li Origin: sanda, 12 Feb 2010
2199 { LFUN_VC_COMPARE, "vc-compare", ReadOnly, System },
2202 * \var lyx::FuncCode lyx::LFUN_CHANGES_TRACK
2203 * \li Action: Toggles change tracking to on/off.
2204 * \li Syntax: changes-track
2205 * \li Origin: levon, 1 Oct 2002
2208 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
2210 * \var lyx::FuncCode lyx::LFUN_CHANGES_OUTPUT
2211 * \li Action: Toggles showing of change tracking in typesetted output.
2212 * \li Syntax: changes-output
2213 * \li Origin: jspitzm, 21 Jan 2005
2216 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
2218 * \var lyx::FuncCode lyx::LFUN_CHANGE_NEXT
2219 * \li Action: Moves the cursor to the position of the next change
2220 of the change tracking records.
2221 * \li Syntax: change-next
2222 * \li Origin: schmitt, 4 Oct 2006
2225 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
2227 * \var lyx::FuncCode lyx::LFUN_CHANGE_PREVIOUS
2228 * \li Action: Moves the cursor to the position of the previous change
2229 of the change tracking records.
2230 * \li Syntax: change-previous
2231 * \li Origin: vfr, 4 Apr 2009
2234 { LFUN_CHANGE_PREVIOUS, "change-previous", ReadOnly, Edit },
2236 * \var lyx::FuncCode lyx::LFUN_CHANGES_MERGE
2237 * \li Action: Open change tracking dialog for merging and moves the cursor
2238 to the position of the next change.
2239 * \li Syntax: changes-merge
2240 * \li Origin: Levon, 16 Oct 2002
2243 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
2245 * \var lyx::FuncCode lyx::LFUN_CHANGE_ACCEPT
2246 * \li Action: Accepts tracked change inside the selection.
2247 * \li Syntax: change-accept
2248 * \li Origin: Levon, 16 Oct 2002
2251 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
2253 * \var lyx::FuncCode lyx::LFUN_CHANGE_REJECT
2254 * \li Action: Rejects tracked change inside the selection.
2255 * \li Syntax: change-accept
2256 * \li Origin: Levon, 16 Oct 2002
2259 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
2261 * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_ACCEPT
2262 * \li Action: Accepts all tracked changes in the document.
2263 * \li Syntax: all-changes-accept
2264 * \li Origin: Levon, 16 Oct 2002
2267 { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
2269 * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_REJECT
2270 * \li Action: Rejects all tracked changes in the document.
2271 * \li Notion: Reject does not work recursively; the user may have to repeat the operation.
2272 * \li Syntax: all-changes-reject
2273 * \li Origin: Levon, 16 Oct 2002
2276 { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
2279 * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
2280 * \li Action: Apply data for an inset.
2281 * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
2282 be applied. This is either changed to #LFUN_INSET_MODIFY or
2283 #LFUN_INSET_INSERT depending on the context where it is called.
2284 * \li Syntax: inset-apply <ARGS>
2285 * \li Params: See #LFUN_INSET_INSERT .
2288 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
2290 * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE
2291 * \li Action: Dissolve the current inset into text.
2292 * \li Syntax: inset-dissolve [<INSET>]
2293 * \li Params: <INSET>: this can be used to make sure the right kind of inset
2294 is dissolved. For example "dissolve" entry in the charstyles
2295 sub-menu should only dissolve the charstyle inset, even if the
2296 cursor is inside several nested insets of different type.\n
2297 For values see #lyx::InsetLayout::lyxtype_ .
2298 * \li Origin: JSpitz, 7 Aug 2006
2301 { LFUN_INSET_DISSOLVE, "inset-dissolve", AtPoint, Edit },
2303 * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
2304 * \li Action: Insert new inset (type given by the parameters).
2305 * \li Syntax: inset-insert <INSET> <ARGS>
2306 * \li Params: <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics|tabular
2307 hyperlink|include|index|label|nomencl|vspace|ref|toc>\n
2308 <ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
2309 * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
2310 where <label name> is the name of the referenced label and
2311 <Format> is one of the following: \n
2312 ref -- <reference> \n
2313 eqref -- (<reference>) \n
2314 pageref -- <page> \n
2315 vpageref -- on <page> \n
2316 vref -- <reference> on <page> \n
2317 prettyref -- Formatted reference
2320 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
2322 * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
2323 * \li Action: Modify some properties of an inset.
2324 * \li Notion: Used for bibitem, bibtex, box, branch, command, ert, external,
2325 floats, graphics, include, index, info, label,
2326 listings, newline, newpage, nomencl, note, phantom,
2327 ref, space, tabular, vspace, wrap insets.
2328 * \li Syntax: inset-modify <INSET> <ARGS>
2329 * \li Syntax: inset-modify changetype <TYPE>
2330 * \li Syntax: inset-modify tabular <FEATURE> [<ARG>]
2331 * \li Params: Generally see #LFUN_INSET_INSERT for further details.\n
2332 In case that <INSET> is "tabular" various math-environment features
2333 are handled as well, e.g. add-vline-left/right for the Grid/Array environment.\n
2334 <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|copy-column|
2335 toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
2336 align-left|align-right|align-center|align-block|valign-top|valign-bottom|
2337 valign-middle|longtabular-align-left|longtabular-align-center|
2338 longtabular-align-right|m-align-left|m-align-right|m-align-center|
2339 m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|set-all-lines|
2340 unset-all-lines|set-longtabular|unset-longtabular|set-pwidth|set-mpwidth|
2341 set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|
2342 set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|
2343 unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|
2344 set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
2345 set-special-column|set-special-multicolumn|set-special-multirow|
2346 set-booktabs|unset-booktabs|set-top-space|set-bottom-space|
2347 set-interline-space|set-border-lines|tabular-valign-top|
2348 tabular-valign-middle|tabular-valign-bottom \n
2349 <ARG>: additional argument for some commands, use debug mode to explore its values.
2350 * \li Sample: inset-modify note Note Comment
2351 * \li Sample: inset-modify changetype Ovalbox
2354 { LFUN_INSET_MODIFY, "inset-modify", AtPoint, Edit },
2356 * \var lyx::FuncCode lyx::LFUN_INSET_DIALOG_UPDATE
2357 * \li Action: Updates the values inside the dialog from the inset.
2358 * \li Notion: This is internal LFUN, not to be used by users. Called internally
2359 by #LFUN_DIALOG_UPDATE
2360 * \li Params: <DIALOG-NAME>
2361 * \li Origin: leeming, 25 Feb 2003
2364 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
2366 * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
2367 * \li Action: Open the inset's properties dialog.
2368 * \li Notion: Used for bibitem, bibtex, box, branch, citation, ert, external,
2369 float, graphics, href, include, index, index_print, label, listings,
2370 note, phantom, ref, space, tabular, vspace, wrap insets.
2371 * \li Syntax: inset-settings <INSET>
2372 * \li Params: <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|
2373 graphics|href|include|index|index_print|label|listings|
2374 note|phantom|ref|space|tabular|vspace|wrap>.
2377 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly | AtPoint, Edit },
2379 * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
2380 * \li Action: Toggles the collapsable inset at cursor position,
2381 or the inset we are currently in.
2382 * \li Syntax: inset-toggle [<ARG>]
2383 * \li Params: <ARG>: <open|close|toggle|assign>. \n
2384 open/close/toggle are for collapsable insets. toggle is used when no argument is given.\n
2385 assign synchronize the branch-inset with activation status of the branch.
2386 Used for global toggling when changed activation.
2387 * \li Origin: lasgouttes, 19 Jul 2001
2390 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly | AtPoint, Edit },
2392 * \var lyx::FuncCode lyx::LFUN_INSET_FORALL
2393 * \li Action: Apply the given commands on insets of a given name.
2394 * \li Notion: WARNING: use at your own risks; this function gives
2395 you too many ways of shooting yourself in the foot.
2396 A typical example is
2397 inset-forall Note note-insert
2398 which starts an infinite loop. This is mitigated by the fact
2399 that the number of actions is arbitrarily limited to 10000.
2400 Note also that inset-forall does not update metrics between
2401 iterations, which can lead to bugs. This has to be eventually
2403 * \li Syntax: inset-forall <NAME> <LFUN-COMMAND> \n
2404 <NAME>: Type of Inset. If <NAME> is *, all insets are matched.
2405 The name is used like for InsetLayout in layout files: "Note"
2406 matches all note insets, while "Note:Note" only matches LyX
2408 * \li Sample: Remove all index insets: \n
2409 inset-forall Index delete-char-forward \n
2410 Close all Notes (also works for a particular branch, for example): \n
2411 inset-forall Note inset-toggle close \n
2412 Transform all yellow notes to comments \n
2413 inset-forall Note:Note inset-modify note Note Comment \n
2414 Try to put LyX in an infinite loop if there is at least a Note: \n
2415 inset-forall Note char-backward
2416 * \li Origin: lasgouttes, 27 Nov 2009
2419 { LFUN_INSET_FORALL, "inset-forall", ReadOnly, Edit },
2422 * \var lyx::FuncCode lyx::LFUN_GRAPHICS_RELOAD
2423 * \li Action: Reloads the image if necessary.
2424 * \li Syntax: graphics-reload
2425 * \li Origin: vfr, 10 Aug 2009
2428 { LFUN_GRAPHICS_RELOAD, "graphics-reload", ReadOnly | AtPoint, Edit },
2430 * \var lyx::FuncCode lyx::LFUN_SET_GRAPHICS_GROUP
2431 * \li Action: Set the group for the graphics inset on the cursor position.
2432 * \li Syntax: set-graphics-group [<GROUP>]
2433 * \li Params: <GROUP>: Id for an existing group. In case the Id is an empty string,
2434 the graphics inset is removed from the current group.
2435 * \li Origin: sanda, 6 May 2008
2438 { LFUN_SET_GRAPHICS_GROUP, "set-graphics-group", Noop, Edit },
2441 * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
2442 * \li Action: Moves the cursor out of the current slice, going forward.
2443 * \li Notion: Cursor movement within an inset may be different than cursor
2444 movement in the surrounding text. This action should be called
2445 automatically by the cursor movement within the inset, when
2446 movement within the inset has ceased (reached the end of the
2447 last paragraph, for example), in order to move correctly
2448 back into the surrounding text.
2451 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
2453 * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
2454 * \li Action: Moves the cursor out of the current slice, going backwards.
2455 * \li Notion: See also #LFUN_FINISHED_FORWARD.
2458 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
2460 * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
2461 * \li Action: Moves the cursor out of the current slice, going right.
2462 * \li Notion: See also #LFUN_FINISHED_FORWARD
2465 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
2467 * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
2468 * \li Action: Moves the cursor out of the current slice, going left.
2469 * \li Notion: See also #LFUN_FINISHED_FORWARD.
2472 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
2475 * \var lyx::FuncCode lyx::LFUN_LANGUAGE
2476 * \li Action: Set language from the current cursor position.
2477 * \li Syntax: language <LANG>
2478 * \li Params: <LANG>: Requested language. Look in lib/languages for
2480 * \li Origin: Dekel, 2 Mar 2000
2483 { LFUN_LANGUAGE, "language", Noop, Edit },
2486 * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
2487 * \li Action: Goto a label.
2488 * \li Syntax: label-goto [<LABEL>]
2489 * \li Params: <LABEL>: Requested label. If no label is given and reference
2490 is on cursor position, Bookmark 0 is saved and
2491 cursor moves to the position of referenced label.
2492 * \li Origin: Ale, 6 Aug 1997
2495 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
2497 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT
2498 * \li Action: Inserts label to text or displayed formula.
2499 * \li Syntax: label-insert [<LABEL>]
2500 * \li Params: <LABEL>: Requested label. If no label is given dialog requesting
2501 name will be opened.
2504 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
2506 * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
2507 * \li Action: Go to the next label or cross-reference.
2508 * \li Syntax: reference-next
2509 * \li Origin: Dekel, 14 Jan 2001
2512 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
2515 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
2516 * \li Action: Moves the cursor to the numbered bookmark, opening the file
2517 if necessary. Note that bookmarsk are saved per-session, not
2519 * \li Notion: Bookmark 0 has a special purpose. It is automatically set \n
2520 1. to the paragraph you are currently editing \n
2521 2. to the paragraph from where you are jumping to the last-edited
2522 position (jump-back feature) \n
2523 3. when jumping from crossreference to the requested label by
2525 * \li Syntax: bookmark-goto <NUMBER>
2526 * \li Params: <NUMBER>: the number of the bookmark to restore.
2527 * \li Origin: Dekel, 27 January 2001
2530 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
2532 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
2533 * \li Action: Save a bookmark.
2534 * \li Notion: Saves a numbered bookmark to the sessions file. The number
2535 must be between 1 and 9, inclusive. Note that bookmarks are
2536 saved per-session, not per file.
2537 * \li Syntax: bookmark-save <NUMBER>
2538 * \li Params: <NUMBER>: the number of the bookmark to save.
2539 * \li Origin: Dekel, 27 January 2001
2542 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
2544 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
2545 * \li Action: Clears the list of saved bookmarks.
2546 * \li Syntax: bookmark-clear
2547 * \li Origin: bpeng, 31 October 2006
2550 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
2553 * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
2554 * \li Action: Open the given help file according to the language setting.
2555 * \li Syntax: help-open <FILE>[.lyx]
2556 * \li Params: <FILE>: any document from (/usr/share/)doc directory.
2557 * \li Origin: Jug, 27 Jun 1999
2560 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
2562 * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
2563 * \li Action: Terminates the current LyX instance.
2564 * \li Notion: Terminates the current LyX instance, asking whether to save
2565 modified documents, etc.
2566 * \li Syntax: lyx-quit
2569 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
2571 * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
2572 * \li Action: Toggles visibility of a given toolbar between on/off/auto.
2573 * \li Notion: Skipping "auto" when allowauto is false.
2574 * \li Syntax: toolbar-toggle <NAME> [allowauto]
2575 * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|
2576 minibuffer|review|view/update|math_panels|vcs
2577 * \li Origin: Edwin, 21 May 2007
2580 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
2582 * \var lyx::FuncCode lyx::LFUN_MENU_OPEN
2583 * \li Action: Opens the menu given by its name.
2584 * \li Syntax: menu-open <NAME>
2585 * \li Params: <NAME>: menu name. See various .inc files in lib/ui for candidates.
2588 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
2590 * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
2591 * \li Action: Various UI visibility-toggling actions.
2592 * \li Syntax: ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
2593 * \li Params: statusbar : Toggle visibility of the statusbar.\n
2594 menubar : Toggle visibility of the menubar.\n
2595 scrollbar : Toggle visibility of the scrollbar.\n
2596 frame : Toggle visibility of the frames around editing window.\n
2597 fullscreen : Toggle fullscreen mode. This also covers calling the
2598 previous functions. However #LFUN_TOOLBAR_TOGGLE for the
2599 custom tweaks of the toolbars should be used.
2600 * \li Origin: sanda, 9 Feb 2007
2603 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
2606 * \var lyx::FuncCode lyx::LFUN_WINDOW_NEW
2607 * \li Action: Creates new empty LyX window.
2608 * \li Notion: Already opened documents from the previous window can be found under View menu.
2609 * \li Syntax: window-new [<GEOMETRY>]
2610 * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently
2611 accepted only on Windows platform.
2612 * \li Origin: Abdel, 21 Oct 2006
2615 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
2617 * \var lyx::FuncCode lyx::LFUN_WINDOW_CLOSE
2618 * \li Action: Closes the current LyX window.
2619 * \li Syntax: window-close
2620 * \li Origin: Abdel, 23 Oct 2006
2623 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
2626 * \var lyx::FuncCode lyx::LFUN_SPLIT_VIEW
2627 * \li Action: Creates another split view of current buffer.
2628 * \li Notion: All split views act in the same way indpendently.
2629 * \li Syntax: split-view <vertical|horizontal>
2630 * \li Params: horizontal : The work areas are laid out side by side.\n
2631 vertical : The work areas laid out vertically.
2632 * \li Origin: Abdel, 20 Feb 2008
2635 { LFUN_SPLIT_VIEW, "split-view", ReadOnly, Buffer },
2638 * \var lyx::FuncCode lyx::LFUN_CLOSE_TAB_GROUP
2639 * \li Action: Close the current tab group.
2640 * \li Notion: This only closes the work areas, not the buffer themselves.
2641 The still opened buffers can be visualized in another tab group.
2642 * \li Syntax: close-tab-group
2643 * \li Origin: Abdel, 21 Feb 2008
2646 { LFUN_CLOSE_TAB_GROUP, "close-tab-group", ReadOnly, Buffer },
2648 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW
2649 * \li Action: Shows hidden dialog or create new one for a given function/inset settings etc.
2650 * \li Syntax: dialog-show <NAME> [<DATA>]
2651 * \li Params: <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|\n
2652 compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|\n
2653 graphics|href|include|index|index_print|info|label|listings|log|mathdelimiter|\n
2654 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|\n
2655 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|\n
2656 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL> \n
2657 <SPECIAL>: latexlog|vclog \n
2658 <DATA>: data, usually settings for the given dialog. Use debug mode for the
2660 * \li Origin: leeming, 17 Jun 2003
2663 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
2665 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW_NEW_INSET
2666 * \li Action: Shows hidden dialog or create new one for a given inset settings etc.
2667 * \li Notion: Internally uses #LFUN_DIALOG_SHOW with processed data for a given inset.
2668 * \li Syntax: dialog-show-new-inset <NAME> [<DATA>]
2669 * \li Params: See #LFUN_DIALOG_SHOW .
2670 * \li Origin: leeming, 25 Feb 2003
2673 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
2675 * \var lyx::FuncCode lyx::LFUN_DIALOG_UPDATE
2676 * \li Action: Updates the dialog values from the inset/paragraph/document.
2677 * \li Syntax: dialog-update <NAME>
2678 * \li Params: <NAME>: paragraph|prefs|<INSET> \n
2680 * \li Origin: leeming, 25 Feb 2003
2683 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
2685 * \var lyx::FuncCode lyx::LFUN_DIALOG_HIDE
2686 * \li Action: Hides showed dialog. Counterpart to #LFUN_DIALOG_SHOW .
2687 * \li Syntax: dialog-hide <NAME>
2688 * \li Params: See #LFUN_DIALOG_SHOW .
2689 * \li Origin: leeming, 25 Feb 2003
2692 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
2694 * \var lyx::FuncCode lyx::LFUN_DIALOG_TOGGLE
2695 * \li Action: Toggles dialog between showed/hidden state.
2696 * \li Notion: Internally uses #LFUN_DIALOG_SHOW , #LFUN_DIALOG_HIDE .
2697 * \li Syntax: dialog-toggle <NAME> [<DATA>]
2698 * \li Params: See #LFUN_DIALOG_SHOW .
2699 * \li Origin: JSpitzm, 30 Apr 2007
2702 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
2704 * \var lyx::FuncCode lyx::LFUN_DIALOG_DISCONNECT_INSET
2705 * \li Action: Closes opened connection to opened inset.
2706 * \li Notion: Connection is used for apply functions.
2707 * \li Syntax: dialog-disconnect-inset <INSET-NAME>
2708 * \li Origin: leeming, 25 Feb 2003
2711 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
2714 * \var lyx::FuncCode lyx::LFUN_MOUSE_PRESS
2715 * \li Action: This function is called when mouse button is pressed (inside workarea).
2716 Action depends on the context.
2717 * \li Notion: This is internal LFUN, not to be used by users.
2718 * \li Origin: Andre, 9 Aug 2002
2721 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
2723 * \var lyx::FuncCode lyx::LFUN_MOUSE_DOUBLE
2724 * \li Action: This function is called when double click on mouse button is
2725 pressed (inside workarea). Action depends on the context.
2726 * \li Notion: This is internal LFUN, not to be used by users.
2727 * \li Origin: Andre, 9 Aug 2002
2730 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
2732 * \var lyx::FuncCode lyx::LFUN_MOUSE_TRIPLE
2733 * \li Action: This function is called when triple click on mouse button is
2734 pressed (inside workarea). Action depends on the context.
2735 * \li Notion: This is internal LFUN, not to be used by users.
2736 * \li Origin: Andre, 9 Aug 2002
2739 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
2741 * \var lyx::FuncCode lyx::LFUN_MOUSE_MOTION
2742 * \li Action: This function is called when mouse cursor is moving over the text.
2743 Action depends on the context.
2744 * \li Notion: This is internal LFUN, not to be used by users.
2745 * \li Origin: Andre, 9 Aug 2002
2748 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
2750 * \var lyx::FuncCode lyx::LFUN_MOUSE_RELEASE
2751 * \li Action: This function is called when mouse button is released (inside workarea).
2752 Action depends on the context.
2753 * \li Notion: This is internal LFUN, not to be used by users.
2754 * \li Origin: Andre, 9 Aug 2002
2757 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
2760 * \var lyx::FuncCode lyx::LFUN_KEYMAP_OFF
2761 * \li Action: Turn off the loaded keyboard map.
2762 * \li Syntax: keymap-off
2765 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
2767 * \var lyx::FuncCode lyx::LFUN_KEYMAP_PRIMARY
2768 * \li Action: Turn on the primary keyboard map.
2769 * \li Notion: Maps were widely used in past, when X-windows didn't have nowadays
2770 keyboard support. They can be still used to maintain uniform keyboard
2771 layout across the various plaforms.\n
2772 The language is to be set in the Preferences dialog.
2773 * \li Syntax: keymap-primary
2776 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
2778 * \var lyx::FuncCode lyx::LFUN_KEYMAP_SECONDARY
2779 * \li Action: Turn on the secondary keyboard map.
2780 * \li Syntax: keymap-secondary
2783 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
2785 * \var lyx::FuncCode lyx::LFUN_KEYMAP_TOGGLE
2786 * \li Action: Toggles keyboard maps (first/second/off).
2787 * \li Syntax: keymap-toggle
2788 * \li Origin: leeming, 30 Mar 2004
2791 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
2794 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_LAYOUT
2795 * \li Action: Returns the current layout (that is environment) name
2796 on the cursor position.
2797 * \li Syntax: server-get-layout
2800 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
2802 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_FILENAME
2803 * \li Action: Returns path and file name of the currently edited document.
2804 * \li Syntax: server-get-filename
2807 { LFUN_SERVER_GET_FILENAME, "server-get-filename", ReadOnly, System },
2809 * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
2810 * \li Action: Sets the cursor position based on the row number of generated TeX file.
2811 * \li Notion: This can be useful for DVI inverse-search or detection of the problematic
2812 line from LaTeX compilation. Note that before this function can be used
2813 export to LaTeX output must occur (in order to map the row numbers).
2814 * \li Syntax: server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
2815 * \li Params: <FILE>: the filename. Environment variables are expanded in the path.
2816 In case this LFUN does not work make sure you are giving correct
2818 If the file is located inside LyX temporary directory it will be
2819 mapped back into the appropriate opened buffer (e.g. for the case
2820 of generated .tex file).
2821 .ext: extensions will be automatically replaced by .lyx.
2822 <ROW_NUMBER> The row number of the LaTeX file to which to go.
2823 * \li Origin: Edmar, 23 Dec 1998
2826 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly | NoBuffer, System },
2828 * \var lyx::FuncCode lyx::LFUN_FORWARD_SEARCH
2829 * \li Action: Sets the cursor position in the previewed (e.g. dvi) file based on the row
2830 number in LyX window.
2831 * \li Notion: The external program used for forward search call can be specified in
2832 \\forward_search_dvi and \\forward_search_pdf RC settings.
2833 By default, the value for pdf is empty, while for dvi it is\n
2834 "xdvi -sourceposition $$n:$$t $$o"\n
2835 The values replaced in the call: $$n for row number, $$t for
2836 exported temporary .tex file, $$o exported output file, either
2837 dvi or pdf, depending on which one exists in the temp dir
2839 * \li Syntax: forward-search
2840 * \li Origin: sanda, 14 Apr 2010
2843 { LFUN_FORWARD_SEARCH, "forward-search", ReadOnly, System },
2846 * \var lyx::FuncCode lyx::LFUN_SERVER_NOTIFY
2847 * \li Action: Sends notify message about the last key-sequence to client.
2848 * \li Notion: This can be used to grab last key-sequence used inside the LyX window.
2849 See also Debug extensions section in Additional features manual.
2850 * \li Syntax: server-notify
2853 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
2855 * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
2856 * \li Action: Sets the cursor position based on the editing area coordinates
2857 (similar as clicking on that point with left mouse button).
2858 * \li Syntax: server-set-xy <X> <Y>
2861 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
2863 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
2864 * \li Action: Returns the coordinates of cursor position in the editing area.
2865 * \li Syntax: server-get-xy
2868 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
2871 * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
2872 * \li Action: Generates the code (literate programming).
2873 * \li Notion: Latex file with extension \literate_extension is generated.
2874 Then LyX invokes \build_command (with a default of``make'') to generate the code and
2875 \build_error_filter to process the compilation error messages. \n
2876 In case you want to process your literate file with a script, or some other program,
2877 just insert in your lyxrc file an entry with:\n
2878 \build_command "my_script my_arguments" \n
2879 The \build_error_filter differs from the \literate_error_filter only in that the
2880 former will identify error messages from your compiler.
2881 * \li Syntax: build-program
2884 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
2887 * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
2888 * \li Action: Saves the current buffer to a temporary file.
2889 * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
2890 is called automatically by LyX, to "autosave" the current buffer.
2891 * \li Syntax: buffer-auto-save
2894 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
2896 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHILD_OPEN
2897 * \li Action: Loads the given child document.
2898 * \li Notion: The current document is treated as a parent.
2899 * \li Syntax: buffer-child-open <FILE>
2900 * \li Params: <FILE>: Filename of the child. The directory of the parent is assumed by default.
2901 * \li Origin: Ale, 28 May 1997
2904 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
2906 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHKTEX
2907 * \li Action: Runs chktex for the current document.
2908 * \li Syntax: buffer-chktex
2909 * \li Origin: Asger, 30 Oct 1997
2912 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
2914 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
2915 * \li Action: Toggles compression of the current document on/off.
2916 * \li Syntax: buffer-toggle-compression
2917 * \li Origin: bpeng, 27 Apr 2006
2920 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
2922 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
2923 * \li Action: Closes the current buffer.
2924 * \li Notion: Closes the current buffer, asking whether to save it, etc,
2925 if the buffer has been modified.
2926 * \li Syntax: buffer-close
2929 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
2931 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE_ALL
2932 * \li Action: Closes all buffers.
2933 * \li Notion: Closes all buffers, asking whether to save it, etc,
2934 if a buffer has been modified.
2935 * \li Syntax: buffer-close-all
2938 { LFUN_BUFFER_CLOSE_ALL, "buffer-close-all", ReadOnly, Buffer },
2940 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
2941 * \li Action: Exports the current buffer (document) to the given format.
2942 * \li Syntax: buffer-export <FORMAT>
2943 * \li Params: <FORMAT> is either "custom" or one of the formats which you
2944 can find in Tools->Preferences->File formats->Format.
2945 Usual format you will enter is "pdf2" (pdflatex),
2946 "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
2947 In case of "custom" you will be asked for a format you
2948 want to start from and for the command that you want to
2949 apply to this format. Internally the control is then passed
2950 to #LFUN_BUFFER_EXPORT_CUSTOM.
2951 * \li Origin: Lgb, 29 Jul 1997
2954 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
2956 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
2957 * \li Action: Exports the current buffer (document) from the given format using
2958 the given command on it.
2959 * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
2960 * \li Params: <FORMAT> format to start from (LyX will care to produce such
2961 intermediate file).\n
2962 <COMMAND> this command will be launched on the file. Note that you can
2963 use "$$FName" string to qualify the intermediate file.
2964 * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
2965 * \li Origin: leeming, 27 Mar 2004
2968 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
2970 * \var lyx::FuncCode lyx::LFUN_BUFFER_PRINT
2971 * \li Action: Prints the current document.
2972 * \li Notion: Many settings can be given via the preferences dialog.
2973 * \li Syntax: buffer-print <TARGET> <TARGET-NAME> <COMMAND>
2974 * \li Params: <TARGET> is either "printer" or "file".\n
2975 <TARGER-NAME> is either "default" or file name or printer name.\n
2976 <COMMAND> command ensuring the printing job.
2977 * \li Sample: buffer-print file "/trash/newfile1.ps" "dvips"
2978 * \li Origin: leeming, 28 Mar 2004
2981 { LFUN_BUFFER_PRINT, "buffer-print", ReadOnly, Buffer },
2983 * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
2984 * \li Action: Import a given file as a lyx document.
2985 * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
2986 defined convertors in preferences. Look into File->Import menu to get
2987 an idea of the currently active import formats.
2988 * \li Syntax: buffer-import <FORMAT> [<FILE>]
2989 * \li Origin: Asger, 24 Jul 1998
2992 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
2994 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
2995 * \li Action: Creates a new buffer (that is, document).
2996 * \li Notion: Implicit path can be set in Preferences dialog.
2997 * \li Syntax: buffer-new [<FILE>]
2998 * \li Params: <FILE>: filename of created file with absolute path.
3001 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
3003 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
3004 * \li Action: Creates a new buffer (that is, document) from a template.
3005 * \li Notion: Path for new files and templates can be set in Preferences dialog.
3006 Template will be asked for via Open-dialog.
3007 * \li Syntax: buffer-new-template [<FILE>]
3008 * \li Params: <FILE>: filename of created file with absolute path.
3011 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
3013 * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
3014 * \li Action: Reverts opened document.
3015 * \li Syntax: buffer-reload
3016 * \li Origin: Asger, 2 Feb 1997
3019 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
3021 * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
3022 * \li Action: Display/switch to the given buffer.
3023 * \li Syntax: buffer-switch <BUFFER>
3024 * \li Params: <BUFFER>: path and filename of already opened (but possibly hidden)
3025 document which is to be shown.
3028 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
3030 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
3031 * \li Action: Toggle editing mode of the current document between read/write and read-only.
3032 * \li Notion: This function is not allowed if the file is under version control, since
3033 read-only flag is often used in version control file locking.
3034 * \li Syntax: buffer-toggle-read-only
3035 * \li Origin: Lgb, 27 May 1997
3038 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
3040 * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
3041 * \li Action: Displays current buffer in chosen format.
3042 * \li Notion: Displays the contents of the current buffer in the chosen
3043 format, for example, PDF or DVI. This runs the necessary
3044 converter, calls the defined viewer, and so forth.
3045 * \li Syntax: buffer-view [<FORMAT>]
3046 * \li Params: <FORMAT>: The format to display, where this is one of the
3047 formats defined (in the current GUI) in the
3048 Tools>Preferences>File Formats dialog.
3049 If no format is given, the default format as
3050 specified in the same dialog is used.
3053 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
3055 * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
3056 * \li Action: Exports the current document and put the result into the
3057 temporary directory.
3058 * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
3059 the output will be rewriten - updated. This is useful in case your viewer
3060 is able to detect such changes (e.g. ghostview for postscript).
3061 * \li Syntax: buffer-update [<FORMAT>]
3062 * \li Params: <FORMAT>: The format to display, where this is one of the
3063 formats defined (in the current GUI) in the
3064 Tools>Preferences>File Formats dialog.
3065 If no format is given, the default format as
3066 specified in the same dialog is used.
3067 * \li Origin: Dekel, 5 Aug 2000
3070 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
3073 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
3074 * \li Action: Saves the current buffer.
3075 * \li Notion: Saves the current buffer to disk, using the filename that
3076 is already associated with the buffer, asking for one if
3077 none is yet assigned.
3078 * \li Syntax: buffer-write
3081 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
3083 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
3084 * \li Action: Rename and save current buffer.
3085 * \li Syntax: buffer-write-as <FILENAME>
3086 * \li Params: <FILENAME>: New name of the buffer/file. A relative path
3087 is with respect to the original location of the buffer/file.
3090 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
3092 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
3093 * \li Action: Save all changed documents.
3094 * \li Syntax: buffer-write-all
3095 * \li Origin: rgh, gpothier 6 Aug 2007
3098 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
3100 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEXT
3101 * \li Action: Switch to the next opened document.
3102 * \li Notion: Note that this does not necessarily mean next in tabbar
3103 (for full list see View menu).
3104 * \li Syntax: buffer-next
3107 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
3109 * \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS
3110 * \li Action: Switch to the previous opened document.
3111 * \li Syntax: buffer-previous
3114 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
3116 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
3117 * \li Action: When run from a child document, this updates (exports) document built
3118 from the master buffer, if available.
3119 * \li Syntax: master-buffer-update [<FORMAT>]
3120 * \li Params: <FORMAT>: The format to display, where this is one of the
3121 formats defined (in the current GUI) in the
3122 Tools>Preferences>File Formats dialog.
3123 If no format is given, the default format as
3124 specified in the same dialog is used.
3125 * \li Origin: Tommaso, 20 Sep 2007
3128 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
3130 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
3131 * \li Action: When run from a child document, this command shows a preview built
3132 from the master buffer, if available.
3133 * \li Syntax: master-buffer-view [<FORMAT>]
3134 * \li Params: <FORMAT>: The format to display, where this is one of the
3135 formats defined (in the current GUI) in the
3136 Tools>Preferences>File Formats dialog.
3137 If no format is given, the default format as
3138 specified in the same dialog is used.
3139 * \li Origin: Tommaso, 20 Sep 2007
3142 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
3144 * \var lyx::FuncCode lyx::LFUN_BUFFER_LANGUAGE
3145 * \li Action: Set language of the current document.
3146 * \li Syntax: buffer-language <LANG>
3147 * \li Params: <LANG>: language name. See lib/languages for list.
3148 * \li Origin: leeming, 30 Mar 2004
3151 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
3153 * \var lyx::FuncCode lyx::LFUN_BUFFER_SAVE_AS_DEFAULT
3154 * \li Action: Save the current document settings as default.
3155 * \li Notion: The file will will be saved into ~/.lyx/templates/defaults.lyx .
3156 * \li Syntax: buffer-save-as-default [<ARGS>]
3157 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
3158 you can find in document header of usual .lyx file.
3159 * \li Origin: leeming, 30 Mar 2004
3162 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
3164 * \var lyx::FuncCode lyx::LFUN_BUFFER_PARAMS_APPLY
3165 * \li Action: Apply the given settings to the current document.
3166 * \li Syntax: buffer-params-apply [<ARGS>]
3167 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
3168 you can find in document header of usual .lyx file.
3169 * \li Origin: leeming, 30 Mar 2004
3172 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", NoInternal, Buffer },
3175 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
3176 * \li Action: Inserts another LyX file.
3177 * \li Syntax: file-insert [<FILE>]
3178 * \li Params: <FILE>: Filename to be inserted.
3181 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
3183 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
3184 * \li Action: Inserts plain text file.
3185 * \li Syntax: file-insert-plaintext [<FILE>]
3186 * \li Params: <FILE>: Filename to be inserted.
3187 * \li Origin: CFO-G, 19 Nov 1997
3190 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
3192 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
3193 * \li Action: Inserts plain text file as paragraph (i.e. join lines).
3194 * \li Syntax: file-insert-plaintext-para [<FILE>]
3195 * \li Params: <FILE>: Filename to be inserted.
3196 * \li Origin: Levon, 14 Feb 2001
3199 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
3201 * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
3202 * \li Action: Open LyX document.
3203 * \li Syntax: file-open [<FILE>]
3204 * \li Params: <FILE>: Filename to be opened.
3207 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
3210 * \var lyx::FuncCode lyx::LFUN_CALL
3211 * \li Action: Executes a command defined in a .def file.
3212 * \li Notion: The definitions are by default read from lib/commands/default.def.\n
3213 A .def file allows to define a command with \define "<NAME>" "<LFUN>"
3214 where <NAME> is the name of the new command and <LFUN> is the lfun code
3215 to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
3216 \def_file "FileName" allows to include another .def file. \n
3217 This is particularly useful in connection with toolbar buttons:
3218 Since the name of the button image for this lfun is
3219 lib/images/commands/<NAME>.png this is the way to assign an image
3220 to a complex command-sequence.
3221 * \li Syntax: call <NAME>
3222 * \li Params: <NAME>: Name of the command that must be called.
3223 * \li Origin: broider, 2 Oct 2007
3226 { LFUN_CALL, "call", NoBuffer, System },
3228 * \var lyx::FuncCode lyx::LFUN_META_PREFIX
3229 * \li Action: Simulate halting Meta key (Alt key on PCs).
3230 * \li Notion: Used for buffer editation not for GUI control.
3231 * \li Syntax: meta-prefix
3234 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
3236 * \var lyx::FuncCode lyx::LFUN_CANCEL
3237 * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
3238 * \li Syntax: cancel
3241 { LFUN_CANCEL, "cancel", NoBuffer, System },
3244 * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
3245 * \li Action: Switches the focus to the minibuffer so that the user can type
3246 in there. If necessary, it opens the minibuffer toolbar.
3247 * \li Notion: Usually bound to M-x shortcut.
3248 * \li Syntax: command-execute
3251 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
3254 * \var lyx::FuncCode lyx::LFUN_COMMAND_PREFIX
3255 * \li Action: Return the current key sequence and available options as a string.
3256 * \li Notion: No options are added if no current map exists. \n
3257 This is probably usable only with connection to lyxserver.
3258 * \li Syntax: command-prefix
3261 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
3263 * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
3264 * \li Action: Run more commands (LFUN and its parameters) in a sequence.
3265 * \li Syntax: command-sequence <CMDS>
3266 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
3267 * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
3268 * \li Origin: Andre, 11 Nov 1999
3271 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
3273 * \var lyx::FuncCode lyx::LFUN_COMMAND_ALTERNATIVES
3274 * \li Action: Runs the first listed command that is enabled.
3275 * \li Notion: This can be used to bind multiple functions to a single key,
3276 and then which one is used will depend upon the context.
3277 * \li Syntax: command-alternatives <CMDS>
3278 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
3279 * \li Sample: command-alternatives completion-accept;cell-forward
3280 * \li Origin: rgh, 24 September 2008
3283 { LFUN_COMMAND_ALTERNATIVES, "command-alternatives", NoBuffer, System },
3285 * \var lyx::FuncCode lyx::LFUN_MESSAGE
3286 * \li Action: Shows message in statusbar (for script purposes).
3287 * \li Syntax: message <STRING>
3288 * \li Origin: Lgb, 8 Apr 2001
3291 { LFUN_MESSAGE, "message", NoBuffer, System },
3293 * \var lyx::FuncCode lyx::LFUN_DEBUG_LEVEL_SET
3294 * \li Action: Set debug output level.
3295 * \li Syntax: debug-level-set <LEVEL>
3296 * \li Params: <LEVEL>: comma separated list of levels or the correspondent number
3297 of their combination. 0 is equivalent to disabling all debug
3298 events. See lyx -dbg for the current list of debug levels
3300 * \li Origin: sanda, 28 Dec 2009
3303 { LFUN_DEBUG_LEVEL_SET, "debug-level-set", NoBuffer, System },
3306 * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
3307 * \li Action: Save user preferences.
3308 * \li Syntax: preferences-save
3309 * \li Origin: Lgb, 27 Nov 1999
3312 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
3314 * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
3315 * \li Action: Reconfigure the automatic settings.
3316 * \li Syntax: reconfigure
3317 * \li Origin: Asger, 14 Feb 1997
3320 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
3322 * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
3323 * \li Action: Apply the given settings to user preferences.
3324 * \li Syntax: lyxrc-apply <SETTINGS>
3325 * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
3326 to get an idea which commands to use and their syntax.
3327 #lyx::LyXRC::LyXRCTags has the list of possible commands.
3330 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
3332 * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
3333 * \li Action: Determine whether keep cursor inside the editing window regardless
3334 the scrollbar movement.
3335 * \li Syntax: toggle-cursor-follows-scrollbar
3336 * \li Origin: ARRae, 2 Dec 1997
3339 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
3341 * \var lyx::FuncCode lyx::LFUN_SET_COLOR
3342 * \li Action: Set the given LyX color to the color defined by the X11 name given.
3343 * \li Notion: A new color entry is created if the color is unknown.
3344 Color names can be stored as a part of user settings.
3345 * \li Syntax: set-color <LYX_NAME> <X11_NAME>
3346 * \li Origin: SLior, 11 Jun 2000
3349 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
3351 * \var lyx::FuncCode lyx::LFUN_STATISTICS
3352 * \li Action: Count the statistics (number of words and characters)
3353 in the document or in the given selection.
3354 * \li Notion: Note that this function gives the number of words/chars written,
3355 not the number of characters which will be typeset.
3356 * \li Syntax: statistics
3357 * \li Origin: lasgouttes, Jan 27 2004; sanda, Jan 8 2008
3360 { LFUN_STATISTICS, "statistics", ReadOnly, System },
3362 * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
3363 * \li Action: Show the inline completion at the cursor position.
3364 * \li Syntax: completion-inline
3365 * \li Origin: sts, Feb 19 2008
3368 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
3370 * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
3371 * \li Action: Show the completion popup at the cursor position.
3372 * \li Syntax: completion-popup
3373 * \li Origin: sts, Feb 19 2008
3376 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
3378 * \var lyx::FuncCode lyx::LFUN_COMPLETION_COMPLETE
3379 * \li Action: Try to complete the word or command at the cursor position.
3380 * \li Syntax: complete
3381 * \li Origin: sts, Feb 19 2008
3384 { LFUN_COMPLETION_COMPLETE, "complete", SingleParUpdate, Edit },
3387 * \var lyx::FuncCode lyx::LFUN_COMPLETION_CANCEL
3388 * \li Action: Try to cancel completion, either the popup or the inline completion.
3389 * \li Syntax: completion-cancel
3390 * \li Origin: sts, Sep 07 2008
3393 { LFUN_COMPLETION_CANCEL, "completion-cancel", SingleParUpdate, Edit },
3395 * \var lyx::FuncCode lyx::LFUN_COMPLETION_ACCEPT
3396 * \li Action: Accept suggested completion.
3397 * \li Syntax: completion-accept
3398 * \li Origin: sanda, Sep 08 2008
3401 { LFUN_COMPLETION_ACCEPT, "completion-accept", SingleParUpdate, Edit },
3405 * \var lyx::FuncCode lyx::LFUN_BRANCH_ADD
3406 * \li Action: Add a branch to the buffer's BranchList.
3407 * \li Syntax: branch-add <BRANCH>
3408 * \li Params: <BRANCH>: Name of the branch to add
3409 * \li Origin: spitz, 7 Jul 2009
3412 { LFUN_BRANCH_ADD, "branch-add", Noop, Buffer },
3416 * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
3417 * \li Action: Activate the branch.
3418 * \li Syntax: branch-activate <BRANCH>
3419 * \li Params: <BRANCH>: The branch to activate
3420 * \li Sample: lyx -x "branch-activate answers" -e pdf2 finalexam.lyx \n
3421 could be used to export a pdf with the answers branch included
3422 without one's having to open LyX and activate the branch manually.
3423 * \li Origin: rgh, 27 May 2008
3426 { LFUN_BRANCH_ACTIVATE, "branch-activate", AtPoint, Buffer },
3428 * \var lyx::FuncCode lyx::LFUN_BRANCH_DEACTIVATE
3429 * \li Action: De-activate the branch.
3430 * \li Syntax: branch-deactivate <BRANCH>
3431 * \li Params: <BRANCH>: The branch to deactivate
3432 * \li Origin: rgh, 27 May 2008
3435 { LFUN_BRANCH_DEACTIVATE, "branch-deactivate", AtPoint, Buffer },
3438 * \var lyx::FuncCode lyx::LFUN_BRANCHES_RENAME
3439 * \li Action: Rename all branches of a given name in a document.
3440 * \li Syntax: branches-rename <OLDNAME> <NEWNAME>
3441 * \li Params: <OLDNAME>: Current name of the branch to be renamed
3442 * <NEWNAME>: New name of the branch
3443 * \li Origin: spitz, 9 Jul 2009
3446 { LFUN_BRANCHES_RENAME, "branches-rename", Noop, Buffer },
3448 * \var lyx::FuncCode lyx::LFUN_BRANCH_ADD_INSERT
3449 * \li Action: Create new branch and directly put the branch inset into
3451 * \li Syntax: branch-add-insert [<NAME>]
3452 * \li Params: <NAME>: Branch name. If it is not specified, you will be asked.
3453 * \li Origin: sanda, 10 Jul 2009
3456 { LFUN_BRANCH_ADD_INSERT, "branch-add-insert", Noop, Buffer },
3460 * \var lyx::FuncCode lyx::LFUN_LABEL_COPY_AS_REF
3461 * \li Action: Copies the label at the cursor as a cross-reference to be pasted elsewhere.
3462 * \li Syntax: copy-label-as-reference <LABEL>
3463 * \li Params: <LABEL>: The label to copy (for multi-line math)
3464 * \li Origin: sts, 16 Nov 2008
3467 { LFUN_LABEL_COPY_AS_REF, "copy-label-as-reference", ReadOnly | NoUpdate, Edit },
3470 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT_AS_REF
3471 * \li Action: Inserts the label as a cross-reference at the position of the cursor.
3472 * \li Syntax: label-insert-as-reference
3473 * \li Origin: vfr, 7 Apr 2009
3476 { LFUN_LABEL_INSERT_AS_REF, "label-insert-as-reference", Noop, Edit},
3479 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_IN
3480 * \li Action: Increases the zoom of the screen fonts.
3481 * \li Syntax: buffer-zoom-in [<ZOOM>]
3482 * \li Params: <ZOOM>: The zoom in %, the default is 20.
3483 * \li Origin: vfr, 30 Mar 2009
3486 { LFUN_BUFFER_ZOOM_IN, "buffer-zoom-in", ReadOnly, Buffer },
3489 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_OUT
3490 * \li Action: Decreases the zoom of the screen fonts.
3491 * \li Syntax: buffer-zoom-out [<ZOOM>]
3492 * \li Params: <ZOOM>: The zoom in %, the default is 20.
3493 * \li Origin: vfr, 30 Mar 2009
3496 { LFUN_BUFFER_ZOOM_OUT, "buffer-zoom-out", ReadOnly, Buffer },
3500 { LFUN_NOACTION, "", Noop, Hidden }
3501 #ifndef DOXYGEN_SHOULD_SKIP_THIS
3504 for (int i = 0; items[i].action != LFUN_NOACTION; ++i)
3505 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
3511 LyXAction::LyXAction()
3517 FuncRequest LyXAction::lookupFunc(string const & func) const
3519 string const func2 = trim(func);
3522 return FuncRequest(LFUN_NOACTION);
3525 string const arg = split(func2, cmd, ' ');
3527 FuncMap::const_iterator const fit = lyx_func_map.find(cmd);
3529 return fit != lyx_func_map.end()
3530 ? FuncRequest(fit->second, arg)
3531 : FuncRequest(LFUN_UNKNOWN_ACTION);
3535 string const LyXAction::getActionName(FuncCode action) const
3537 InfoMap::const_iterator const it = lyx_info_map.find(action);
3538 return it != lyx_info_map.end() ? it->second.name : string();
3542 LyXAction::FuncType LyXAction::getActionType(FuncCode action) const
3544 InfoMap::const_iterator const it = lyx_info_map.find(action);
3545 return it != lyx_info_map.end() ? it->second.type : Hidden;
3549 bool LyXAction::funcHasFlag(FuncCode action,
3550 LyXAction::FuncAttribs flag) const
3552 InfoMap::const_iterator ici = lyx_info_map.find(action);
3554 if (ici == lyx_info_map.end()) {
3555 LYXERR0("action: " << action << " is not known.");
3556 LASSERT(false, /**/);
3559 return ici->second.attrib & flag;
3563 LyXAction::const_iterator LyXAction::func_begin() const
3565 return lyx_func_map.begin();
3569 LyXAction::const_iterator LyXAction::func_end() const
3571 return lyx_func_map.end();
3575 LyXErr & operator<<(LyXErr & l, FuncCode code)
3578 l.stream() << lyxaction.getActionName(code);