3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Lars Gullik Bjønnes
7 * \author Jean-Marc Lasgouttes
12 * Full author contact details are available in file CREDITS.
17 #include "LyXAction.h"
19 #include "FuncRequest.h"
21 #include "support/debug.h"
22 #include "support/lstrings.h"
24 #include "support/lassert.h"
29 using namespace lyx::support;
34 NAMING RULES FOR USER-COMMANDS
35 Here's the set of rules to apply when a new command name is introduced:
37 1) Use the object.event order. That is, use `word-forward'
38 instead of `forward-word'.
39 2) Don't introduce an alias for an already named object. Same for events.
40 3) Forward movement or focus is called `forward' (not `right').
41 4) Backward movement or focus is called `backward' (not `left').
42 5) Upward movement of focus is called `up'.
43 6) Downward movement is called `down'.
44 7) The begin of an object is called `begin' (not `start').
45 8) The end of an object is called `end'.
47 (May 19 1996, 12:04, RvdK)
52 * The documentation below is primarily description of purpose and syntax
53 * relating to the different LFUNs.
55 * Try to find an appropriate (thematical) place when adding the new LFUN
56 * and don't forget to add doxygen commentary.
58 * Doxygen template below. Some notes: Parameters should be set in uppercase
59 * and put in <BRACKETS>, [<PARAM>] means optional one.
61 * Use spaces for indentation (doxy -> .lyx generator is tab-sensitive).
65 * \var lyx::FuncCode lyx::LFUN_
78 void LyXAction::newFunc(FuncCode action, string const & name,
79 unsigned int attrib, LyXAction::FuncType type)
81 lyx_func_map[name] = action;
84 tmpinfo.attrib = attrib;
86 lyx_info_map[action] = tmpinfo;
90 // Needed for LFUNs documentation to be accepted, since doxygen won't take
91 // \var inside functions.
92 #ifndef DOXYGEN_SHOULD_SKIP_THIS
93 void LyXAction::init()
95 // This function was changed to use the array below in initalization
96 // instead of calling newFunc numerous times because of compilation
97 // times. Since the array is not static we get back the memory it
98 // occupies after the init is completed. It compiles several
112 ev_item const items[] = {
115 * \var lyx::FuncCode lyx::LFUN_ACCENT_ACUTE
116 * \li Action: Adds an acute accent \htmlonly (á)\endhtmlonly
117 to the next character typed.
118 * \li Syntax: accent-acute
121 { LFUN_ACCENT_ACUTE, "accent-acute", Noop, Edit },
123 * \var lyx::FuncCode lyx::LFUN_ACCENT_BREVE
124 * \li Action: Adds a breve accent \htmlonly (ă)\endhtmlonly
125 to the next character typed.
126 * \li Syntax: accent-breve
129 { LFUN_ACCENT_BREVE, "accent-breve", Noop, Edit },
131 * \var lyx::FuncCode lyx::LFUN_ACCENT_CARON
132 * \li Action: Adds a caron \htmlonly (ǎ)\endhtmlonly
133 to the next character typed.
134 * \li Syntax: accent-caron
137 { LFUN_ACCENT_CARON, "accent-caron", Noop, Edit },
139 * \var lyx::FuncCode lyx::LFUN_ACCENT_CEDILLA
140 * \li Action: Adds a cedilla \htmlonly (ç)\endhtmlonly
141 to the next character typed.
142 * \li Syntax: accent-cedilla
145 { LFUN_ACCENT_CEDILLA, "accent-cedilla", Noop, Edit },
147 * \var lyx::FuncCode lyx::LFUN_ACCENT_CIRCLE
148 * \li Action: Adds a circle accent \htmlonly (å)\endhtmlonly
149 to the next character typed.
150 * \li Syntax: accent-circle
153 { LFUN_ACCENT_CIRCLE, "accent-circle", Noop, Edit },
155 * \var lyx::FuncCode lyx::LFUN_ACCENT_CIRCUMFLEX
156 * \li Action: Adds a circumflex \htmlonly (ê)\endhtmlonly
157 to the next character typed.
158 * \li Syntax: accent-circumflex
161 { LFUN_ACCENT_CIRCUMFLEX, "accent-circumflex", Noop, Edit },
163 * \var lyx::FuncCode lyx::LFUN_ACCENT_DOT
164 * \li Action: Adds a dot accent \htmlonly (ż)\endhtmlonly
165 to the next character typed.
166 * \li Syntax: accent-dot
169 { LFUN_ACCENT_DOT, "accent-dot", Noop, Edit },
171 * \var lyx::FuncCode lyx::LFUN_ACCENT_GRAVE
172 * \li Action: Adds a grave accent \htmlonly (è)\endhtmlonly
173 to the next character typed.
174 * \li Syntax: accent-grave
177 { LFUN_ACCENT_GRAVE, "accent-grave", Noop, Edit },
179 * \var lyx::FuncCode lyx::LFUN_ACCENT_HUNGARIAN_UMLAUT
180 * \li Action: Adds a Hungarian umlaut \htmlonly (ő)\endhtmlonly
181 to the next character typed.
182 * \li Syntax: accent-grave
185 { LFUN_ACCENT_HUNGARIAN_UMLAUT, "accent-hungarian-umlaut", Noop, Edit },
187 * \var lyx::FuncCode lyx::LFUN_ACCENT_MACRON
188 * \li Action: Adds a macron \htmlonly (ā)\endhtmlonly
189 to the next character typed.
190 * \li Syntax: accent-macron
193 { LFUN_ACCENT_MACRON, "accent-macron", Noop, Edit },
195 * \var lyx::FuncCode lyx::LFUN_ACCENT_OGONEK
196 * \li Action: Adds an ogonek accent \htmlonly (ą)\endhtmlonly
197 to the next character typed.
198 * \li Syntax: accent-ogonek
201 { LFUN_ACCENT_OGONEK, "accent-ogonek", Noop, Edit },
203 * \var lyx::FuncCode lyx::LFUN_ACCENT_TIE
204 * \li Action: Adds a tie \htmlonly (a͡)\endhtmlonly
205 over the next two character typed.
206 * \li Notion: The following char will finish the tie.
207 * \li Syntax: accent-tie
210 { LFUN_ACCENT_TIE, "accent-tie", Noop, Edit },
212 * \var lyx::FuncCode lyx::LFUN_ACCENT_TILDE
213 * \li Action: Adds a tilde \htmlonly (ã)\endhtmlonly
214 over the next character typed.
215 * \li Syntax: accent-tilde
218 { LFUN_ACCENT_TILDE, "accent-tilde", Noop, Edit },
220 * \var lyx::FuncCode lyx::LFUN_ACCENT_UMLAUT
221 * \li Action: Adds an umlaut \htmlonly (ä)\endhtmlonly
222 over the next character typed.
223 * \li Syntax: accent-umlaut
226 { LFUN_ACCENT_UMLAUT, "accent-umlaut", Noop, Edit },
228 * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERBAR
229 * \li Action: Adds a bar \htmlonly (a̠)\endhtmlonly
230 under the next character typed.
231 * \li Syntax: accent-underbar
234 { LFUN_ACCENT_UNDERBAR, "accent-underbar", Noop, Edit },
236 * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERDOT
237 * \li Action: Adds a dot \htmlonly (ạ)\endhtmlonly
238 under the next character typed.
239 * \li Syntax: accent-underdot
242 { LFUN_ACCENT_UNDERDOT, "accent-underdot", Noop, Edit },
245 * \var lyx::FuncCode lyx::LFUN_CAPTION_INSERT
246 * \li Action: Inserts a caption inset.
247 * \li Syntax: caption-insert
248 * \li Origin: Lgb, 18 Jul 2000
251 { LFUN_CAPTION_INSERT, "caption-insert", Noop, Edit },
253 * \var lyx::FuncCode lyx::LFUN_DATE_INSERT
254 * \li Action: Inserts the current date.
255 * \li Syntax: date-insert [<ARG>]
256 * \li Params: <ARG>: Format of date. The default value (%x) can be set
257 in Preferences->Date format. For possible formats
258 see manual page of strftime function.
259 * \li Origin: jdblair, 31 Jan 2000
262 { LFUN_DATE_INSERT, "date-insert", Noop, Edit },
264 * \var lyx::FuncCode lyx::LFUN_FOOTNOTE_INSERT
265 * \li Action: Inserts a footnote inset.
266 * \li Syntax: footnote-insert
267 * \li Origin: Jug, 7 Mar 2000
270 { LFUN_FOOTNOTE_INSERT, "footnote-insert", Noop, Edit },
272 * \var lyx::FuncCode lyx::LFUN_ERT_INSERT
273 * \li Action: Inserts an ERT inset.
274 * \li Syntax: ert-insert
275 * \li Origin: Jug, 18 Feb 2000
278 { LFUN_ERT_INSERT, "ert-insert", Noop, Edit },
280 * \var lyx::FuncCode lyx::LFUN_FLOAT_INSERT
281 * \li Action: Inserts a float inset.
282 * \li Syntax: float-insert <TYPE>
283 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
284 "algorithm", "table", "figure" parameters can be given.
285 * \li Origin: Lgb, 27 Jun 2000
288 { LFUN_FLOAT_INSERT, "float-insert", Noop, Edit },
290 * \var lyx::FuncCode lyx::LFUN_FLOAT_WIDE_INSERT
291 * \li Action: Inserts float insets as in #LFUN_FLOAT_INSERT but span multiple columns.
292 * \li Notion: Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
293 * \li Syntax: float-wide-insert <TYPE>
294 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
295 "algorithm", "table", "figure" parameters can be given.
296 * \li Origin: Lgb, 31 Oct 2001
299 { LFUN_FLOAT_WIDE_INSERT, "float-wide-insert", Noop, Edit },
301 * \var lyx::FuncCode lyx::LFUN_FLOAT_LIST_INSERT
302 * \li Action: Inserts the list of floats in the document.
303 * \li Syntax: float-list-insert <TYPE>
304 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
305 "algorithm", "table", "figure" parameters can be given.
306 * \li Origin: Lgb, 3 May 2001
309 { LFUN_FLOAT_LIST_INSERT, "float-list-insert", Noop, Edit },
311 * \var lyx::FuncCode lyx::LFUN_WRAP_INSERT
312 * \li Action: Inserts floats wrapped by the text around.
313 * \li Syntax: wrap-insert <TYPE>
314 * \li Params: <TYPE>: table|figure
315 * \li Origin: Dekel, 7 Apr 2002
318 { LFUN_WRAP_INSERT, "wrap-insert", Noop, Edit },
320 * \var lyx::FuncCode lyx::LFUN_ARGUMENT_INSERT
321 * \li Action: Inserts an argument (short title) inset.
322 * \li Syntax: argument-insert <argument nr>
323 * \li Params: <argument nr>: see layout declarations
324 * \li Origin: vermeer, 12 Aug 2002
327 { LFUN_ARGUMENT_INSERT, "argument-insert", Noop, Edit },
329 * \var lyx::FuncCode lyx::LFUN_NEWPAGE_INSERT
330 * \li Action: Inserts a new page.
331 * \li Syntax: newpage-insert <ARG>
332 * \li Params: <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
333 * \li Origin: uwestoehr, 24 Nov 2007
336 { LFUN_NEWPAGE_INSERT, "newpage-insert", Noop, Edit },
338 * \var lyx::FuncCode lyx::LFUN_MARGINALNOTE_INSERT
339 * \li Action: Inserts a marginal note.
340 * \li Syntax: marginalnote-insert
341 * \li Origin: Lgb, 26 Jun 2000
344 { LFUN_MARGINALNOTE_INSERT, "marginalnote-insert", Noop, Edit },
346 * \var lyx::FuncCode lyx::LFUN_UNICODE_INSERT
347 * \li Action: Inserts a single unicode character.
348 * \li Syntax: unicode-insert <CHAR>
349 * \li Params: <CHAR>: The character to insert, given as its code
350 point, in hexadecimal.
351 * \li Sample: unicode-insert 0x0100
352 * \li Origin: Lgb, 22 Oct 2006
355 { LFUN_UNICODE_INSERT, "unicode-insert", Noop, Edit },
357 * \var lyx::FuncCode lyx::LFUN_LISTING_INSERT
358 * \li Action: Inserts a new listings inset.
359 * \li Syntax: listing-insert
360 * \li Origin: Herbert, 10 Nov 2001; bpeng, 2 May 2007
363 { LFUN_LISTING_INSERT, "listing-insert", Noop, Edit },
365 * \var lyx::FuncCode lyx::LFUN_PREVIEW_INSERT
366 * \li Action: Inserts a new preview inset.
367 * \li Syntax: preview-insert
368 * \li Origin: vfr, 28 Mar 2010
371 { LFUN_PREVIEW_INSERT, "preview-insert", Noop, Edit },
373 * \var lyx::FuncCode lyx::LFUN_TAB_INSERT
374 * \li Action: Insert a tab into a listings inset.
375 * \li Notion: It also works on a selection.
376 * \li Syntax: tab-insert
377 * \li Origin: vfr, Sep 30 2008
380 { LFUN_TAB_INSERT, "tab-insert", SingleParUpdate, Edit },
382 * \var lyx::FuncCode lyx::LFUN_TAB_DELETE
383 * \li Action: Delete a tab or up to an equivalent amount of spaces from
385 * \li Notion: It also works on a selection - it removes a tab or spaces from the
386 beginning of each line spanned by the selection. This is useful if
387 you want to indent/unindent multiple lines in one action.
388 * \li Syntax: tab-delete
389 * \li Origin: vfr, Sep 30 2008
392 { LFUN_TAB_DELETE, "tab-delete", SingleParUpdate, Edit },
394 * \var lyx::FuncCode lyx::LFUN_QUOTE_INSERT
395 * \li Action: Inserts quotes according to the type and quote-language preference.
396 * \li Notion: Currently English, Swedish, German, Polish, French, Danish quotes
398 * \li Syntax: quote-insert [<TYPE>]
399 * \li Params: <TYPE>: 'single' for single quotes, otherwise double quotes will be used.
402 { LFUN_QUOTE_INSERT, "quote-insert", Noop, Edit },
404 * \var lyx::FuncCode lyx::LFUN_INFO_INSERT
405 * \li Action: Displays shortcuts, lyxrc, package and textclass availability and menu
406 information in a non-editable boxed InsetText.
407 * \li Notion: Apart from lfun arguments you can use the following method: \n
408 1. input the type and argument of this inset, e.g. "menu paste", in
410 2. select the text and run info-insert lfun.
411 * \li Syntax: info-insert <TYPE> <ARG>
412 * \li Params: <TYPE>: shortcut[s]|lyxrc|lyxinfo|package|textclass|menu|buffer \n
413 <ARG>: argument for a given type. Look into InsetInfo.h for detailed
415 shortcut[s]: name of lfun (e.g math-insert \alpha) \n
416 lyxrc: name of rc_entry (e.g. bind_file) \n
417 lyxinfo: "version" - used version of LyX \n
418 package: name of latex package (e.g. listings) \n
419 textclass: name of textclass (e.g. article) \n
420 menu: name of lfun used in menu \n
421 icon: icon of lfun used in toolbar \n
422 buffer: "name"|"path"|"class"|"vcs-tree-revision"|
423 "vcs-revision"|"vcs-author"|"vcs-date"|"vcs-time"
424 * \li Sample: command-sequence info-insert buffer path; info-insert buffer name
425 * \li Origin: bpeng, 7 Oct 2007
428 { LFUN_INFO_INSERT, "info-insert", Noop, Edit },
430 * \var lyx::FuncCode lyx::LFUN_BRANCH_INSERT
431 * \li Action: Inserts branch inset.
432 * \li Syntax: branch-insert <BRANCH-NAME>
433 * \li Origin: vermeer, 17 Aug 2003
436 { LFUN_BRANCH_INSERT, "branch-insert", Noop, Edit },
438 * \var lyx::FuncCode lyx::LFUN_BOX_INSERT
439 * \li Action: Inserts Box inset.
440 * \li Syntax: box-insert [<TYPE>]
441 * \li Params: <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox \n
442 Framed is the default one.
443 * \li Origin: vermeer, 7 Oct 2003
446 { LFUN_BOX_INSERT, "box-insert", Noop, Edit },
448 * \var lyx::FuncCode lyx::LFUN_FLEX_INSERT
449 * \li Action: Inserts CharStyle, Custom inset or XML short element.
450 * \li Notion: Look into the Customization manual for more information about
452 To make this command enabled the layout file for the document
453 class you're using has to load the character styles. There are
454 a few contained in the Logical Markup module. You can also of
455 course create some yourself. \n
456 For dissolving the element see #LFUN_INSET_DISSOLVE.
457 * \li Syntax: flex-insert Name
458 * \li Params: Name: This name must be defined either in your layout file
459 or imported by some module. The definition is
460 InsetLayout Name or InsetLayout <Flex:Name>. The Flex:
462 * \li Sample: flex-insert Code
465 { LFUN_FLEX_INSERT, "flex-insert", Noop, Edit },
467 * \var lyx::FuncCode lyx::LFUN_SELF_INSERT
468 * \li Action: Inserts the given string (accordingly to the correct keymap).
469 * \li Notion: Automatically replace the currently selected text. Depends on lyxrc
470 settings "auto_region_delete".
471 * \li Syntax: self-insert <STRING>
474 { LFUN_SELF_INSERT, "self-insert", SingleParUpdate, Hidden },
476 * \var lyx::FuncCode lyx::LFUN_SPACE_INSERT
477 * \li Action: Inserts one of horizontal space insets.
478 * \li Syntax: space-insert <NAME> [<LEN>]
479 * \li Params: <NAME>: normal, protected, visible, thin, quad, qquad, enspace,
480 enskip, negthinspace, negmedspace, negthickspace, hfill,
481 hfill*, dotfill, hrulefill, hspace, hspace* \n
482 Only in math mode: med and thick.\n
483 <LEN>: length for custom spaces (hspace, hspace* for protected)
484 * \li Origin: JSpitzm, 20 May 2003, Mar 17 2008
487 { LFUN_SPACE_INSERT, "space-insert", Noop, Edit },
489 * \var lyx::FuncCode lyx::LFUN_HYPERLINK_INSERT
490 * \li Action: Inserts hyperlinks into the document (clickable in pdf output).
491 * \li Notion: Hyperlink target can be set via selection + hyperlink-insert function.
492 * \li Syntax: href-insert [<TARGET>]
493 * \li Origin: CFO-G, 21 Nov 1997
496 { LFUN_HYPERLINK_INSERT, "href-insert", Noop, Edit },
498 * \var lyx::FuncCode lyx::LFUN_SPECIALCHAR_INSERT
499 * \li Action: Inserts various characters into the document.
500 * \li Syntax: specialchar-insert <CHAR>
501 * \li Params: <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots,
502 end-of-sentence, menu-separator.
503 * \li Origin: JSpitzm, 6 Dec 2007
506 { LFUN_SPECIALCHAR_INSERT, "specialchar-insert", Noop, Edit },
508 * \var lyx::FuncCode lyx::LFUN_SCRIPT_INSERT
509 * \li Action: Inserts a subscript or superscript inset.
510 * \li Syntax: script-insert <TYPE>
511 * \li Params: <TYPE>: subscript|superscript
512 * \li Origin: Georg, 23 Nov 2010
515 { LFUN_SCRIPT_INSERT, "script-insert", Noop, Edit },
517 * \var lyx::FuncCode lyx::LFUN_APPENDIX
518 * \li Action: Start (or remove) Appendix on the given cursor position.
519 * \li Syntax: appendix
520 * \li Origin: ettrich, 5 May 1998
523 { LFUN_APPENDIX, "appendix", Noop, Edit },
526 * \var lyx::FuncCode lyx::LFUN_INDEX_INSERT
527 * \li Action: Inserts Index entry.
528 * \li Notion: It automatically takes the word on the cursor position.
529 * \li Syntax: index-insert [<TYPE:Name>]
530 * \li Params: <TYPE:Name>: name of the index, if multiple indices are defined.
531 With an empty argument, the default index is selected.
532 * \li Origin: leeming, 3 Aug 2000
535 { LFUN_INDEX_INSERT, "index-insert", Noop, Edit },
537 * \var lyx::FuncCode lyx::LFUN_INDEX_PRINT
538 * \li Action: Inserts list of Index entries on a new page.
539 * \li Syntax: index-print [<TYPE:Name>]
540 * \li Params: <TYPE:Name>: name of the index, if multiple indices are defined.
541 With an empty argument, the default index is selected.
542 * \li Origin: Lgb, 27 Feb 1997
545 { LFUN_INDEX_PRINT, "index-print", Noop, Edit },
547 * \var lyx::FuncCode lyx::LFUN_IPA_INSERT
548 * \li Action: Inserts an IPA inset.
549 * \li Syntax: ipa-insert
550 * \li Origin: spitz, 05 Mar 2012
553 { LFUN_IPA_INSERT, "ipa-insert", Noop, Edit },
555 * \var lyx::FuncCode lyx::LFUN_IN_IPA
556 * \li Action: Only active in IPA inset.
557 * \li Notion: Dummy function which is only active in a IPA inset.
558 It's used to toggle the IPA toolbar if the cursor moves
561 * \li Origin: spitz, 20 May 2012
564 { LFUN_IN_IPA, "in-ipa", Noop, Edit },
566 * \var lyx::FuncCode lyx::LFUN_IPAMACRO_INSERT
567 * \li Action: Inserts special IPA macros into the document.
568 * \li Syntax: ipamacro-insert <CHAR>
569 * \li Params: <CHAR>: tone-falling, tone-rising, tone-high-rising, tone-low-rising,
570 * tone-high-rising-falling, deco bottomtiebar, deco toptiebar.
571 * \li Origin: JSpitzm, 22 Aug 2012
574 { LFUN_IPAMACRO_INSERT, "ipamacro-insert", Noop, Edit },
576 * \var lyx::FuncCode lyx::LFUN_NOMENCL_INSERT
577 * \li Action: Inserts Nomenclature entry.
578 * \li Notion: It automatically takes the word on the cursor position if no symbol is given.
579 * \li Syntax: nomencl-insert [<SYMBOL>]
580 * \li Origin: Ugras, 4 Nov 2006
583 { LFUN_NOMENCL_INSERT, "nomencl-insert", Noop, Edit },
585 * \var lyx::FuncCode lyx::LFUN_NOMENCLATURE_PRINT
586 * \li Action: Inserts list of Nomenclature entries.
587 * \li Syntax: nomenclature-print
588 * \li Origin: Ugras, 4 Nov 2006
591 { LFUN_NOMENCL_PRINT, "nomencl-print", Noop, Edit },
594 * \var lyx::FuncCode lyx::LFUN_NOTE_INSERT
595 * \li Action: Inserts Note on the current cursor position,
596 move selection inside the inset.
597 * \li Syntax: note-insert [<TYPE>]
598 * \li Params: <TYPE>: <Note|Greyedout|Comment> default: Note
601 { LFUN_NOTE_INSERT, "note-insert", Noop, Edit },
603 * \var lyx::FuncCode lyx::LFUN_NOTE_NEXT
604 * \li Action: Moves the cursor to the beginning of next Note inset.
605 * \li Syntax: note-next
608 { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
610 * \var lyx::FuncCode lyx::LFUN_PHANTOM_INSERT
611 * \li Action: Inserts phantom on the current cursor position,
612 move selection inside the inset.
613 * \li Syntax: phantom-insert [<TYPE>]
614 * \li Params: <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
615 * \li Origin: uwestoehr, 30 Jan 2009
618 { LFUN_PHANTOM_INSERT, "phantom-insert", Noop, Edit },
620 * \var lyx::FuncCode lyx::LFUN_NEWLINE_INSERT
621 * \li Action: Inserts a line break or new line.
622 * \li Syntax: newline-insert [<ARG>]
623 * \li Params: <ARG>: <newline|linebreak> default: newline
624 * \li Origin: JSpitzm, 25 Mar 2008
627 { LFUN_NEWLINE_INSERT, "newline-insert", Noop, Edit },
629 * \var lyx::FuncCode lyx::LFUN_ESCAPE
630 * \li Action: Clears the selection. If no text is selected call #LFUN_FINISHED_FORWARD.
631 Inside math mode jumps out of the math inset.
633 * \li Origin: Lgb, 17 May 2001
636 { LFUN_ESCAPE, "escape", ReadOnly, Edit },
638 * \var lyx::FuncCode lyx::LFUN_DOWN
639 * \li Action: Moves the cursor one line in downward direction.
643 { LFUN_DOWN, "down", ReadOnly | NoUpdate, Edit },
645 * \var lyx::FuncCode lyx::LFUN_UP
646 * \li Action: Moves the cursor one line in upward direction.
650 { LFUN_UP, "up", ReadOnly | NoUpdate, Edit },
652 * \var lyx::FuncCode lyx::LFUN_DOWN_SELECT
653 * \li Action: Moves the cursor one line in downward direction adding the current
654 position to the selection.
655 * \li Syntax: down-select
658 { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, Edit },
660 * \var lyx::FuncCode lyx::LFUN_UP_SELECT
661 * \li Action: Moves the cursor one line in upward direction adding the current
662 position to the selection.
663 * \li Syntax: up-select
666 { LFUN_UP_SELECT, "up-select", ReadOnly | SingleParUpdate, Edit },
668 * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN
669 * \li Action: Moves the cursor one page in downward direction.
670 * \li Syntax: screen-down
673 { LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit },
675 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP
676 * \li Action: Moves the cursor one page in upward direction.
677 * \li Syntax: screen-up
680 { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit },
682 * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN_SELECT
683 * \li Action: Moves the cursor one screen in downward direction adding the current
684 position to the selection.
685 * \li Syntax: screen-down-select
688 { LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit },
690 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP_SELECT
691 * \li Action: Moves the cursor one page in upward direction adding the current
692 position to the selection.
693 * \li Syntax: screen-up-select
696 { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit },
698 * \var lyx::FuncCode lyx::LFUN_SCROLL
699 * \li Action: Scroll the buffer view.
700 * \li Notion: Only scrolls the screen up or down; does not move the cursor.
701 * \li Syntax: scroll <TYPE> <QUANTITY>
702 * \li Params: <TYPE>: line|page\n
703 <QUANTITY>: up|down|<number>
704 * \li Origin: Abdel, Dec 27 2007
707 { LFUN_SCROLL, "scroll", ReadOnly, Edit },
709 * \var lyx::FuncCode lyx::LFUN_SCREEN_RECENTER
710 * \li Action: Recenters the screen on the current cursor position.
711 * \li Syntax: screen-recenter
714 { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit },
717 * \var lyx::FuncCode lyx::LFUN_SCREEN_SHOW_CURSOR
718 * \li Action: Repositions the screen such that the cursor is visible.
719 * \li Syntax: screen-show-cursor
720 * \li Origin: vfr, 25 Mar 2009
723 { LFUN_SCREEN_SHOW_CURSOR, "screen-show-cursor", ReadOnly, Edit },
726 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD
727 * \li Action: Moves the cursor one position logically backwards.
728 * \li Notion: This is not the action which should be bound to the arrow keys,
729 because backwards may be left or right, depending on the
730 language. The arrow keys should be bound to #LFUN_CHAR_LEFT or
731 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
732 * \li Syntax: char-backward
735 { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit },
737 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD_SELECT
738 * \li Action: Moves the cursor one position logically backwards, adding
739 traversed position to the selection.
740 * \li Notion: See also #LFUN_CHAR_BACKWARD.
741 * \li Syntax: char-backward-select
744 { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit },
746 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_BACKWARD
747 * \li Action: Deletes one character in the backward direction (usually the "BackSpace" key).
748 * \li Syntax: char-delete-backward
751 { LFUN_CHAR_DELETE_BACKWARD, "char-delete-backward", SingleParUpdate, Edit },
753 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_FORWARD
754 * \li Action: Deletes one character in the backward direction (usually the "Delete" key).
755 * \li Syntax: char-delete-forward
758 { LFUN_CHAR_DELETE_FORWARD, "char-delete-forward", SingleParUpdate, Edit },
760 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD
761 * \li Action: Moves the cursor one position logically forward.
762 * \li Notion: This is not the action which should be bound to the arrow keys,
763 because forward may be left or right, depending on the language.
764 The arrow keys should be bound to #LFUN_CHAR_LEFT or
765 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
766 * \li Syntax: char-forward
769 { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit },
771 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD_SELECT
772 * \li Action: Moves the cursor one position logically forward, adding
773 traversed position to the selection.
774 * \li Notion: See also #LFUN_CHAR_FORWARD.
775 * \li Syntax: char-forward-select
778 { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit },
780 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT
781 * \li Action: Moves the cursor one position "to the left".
782 * \li Notion: This is the action which should be taken when the "left" key
783 is pressed. Generally, it moves the cursor one position to the
784 left. However, in Bidi text this become slightly more
785 complicated, and there are different modes of cursor movement.
786 In "visual mode", this moves left, plain and simple. In "logical
787 mode", movement is logically forward in RTL paragraphs, and
788 logically backwards in LTR paragraphs.
789 * \li Syntax: char-left
792 { LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit },
794 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT_SELECT
795 * \li Action: Moves the cursor one position "to the left", adding
796 traversed position to the selection.
797 * \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement.
798 * \li Syntax: char-left-select
801 { LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit },
803 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT
804 * \li Action: Moves the cursor one position "to the right".
805 * \li Notion: This is the action which should be taken when the "right" key
806 is pressed. Generally, it moves the cursor one position to the
807 right. However, in Bidi text this become slightly more
808 complicated, and there are different modes of cursor movement.
809 In "visual mode", this moves right, plain and simple. In "logical
810 mode", movement is logically forward in LTR paragraphs, and
811 logically backwards in RTL paragraphs.
812 * \li Syntax: char-right
815 { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit },
817 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT_SELECT
818 * \li Action: Moves the cursor one position "to the right", adding
819 traversed position to the selection.
820 * \li Notion: See also #LFUN_CHAR_RIGHT for exact details of the movement.
821 * \li Syntax: char-right-select
824 { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit },
827 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD
828 * \li Action: Moves the cursor to the logically previous beginning of a word.
829 * \li Notion: This is not the action which should be bound to the arrow keys,
830 because backwards may be left or right, depending on the
831 language. The arrow keys should be bound to #LFUN_WORD_LEFT or
832 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
833 * \li Syntax: word-backward
836 { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit },
838 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD_SELECT
839 * \li Action: Moves the cursor to the logically previous beginning of a word,
840 adding the logically traversed text to the selection.
841 * \li Notion: See also #LFUN_WORD_BACKWARD.
842 * \li Syntax: word-backward-select
845 { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
847 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_BACKWARD
848 * \li Action: Deletes characters to the beginning of the word (usually the "C+BackSpace" key).
849 * \li Syntax: word-delete-backward
852 { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
854 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_FORWARD
855 * \li Action: Deletes characters to the end of the word (usually the "C+Delete" key).
856 * \li Syntax: word-delete-forward
859 { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
861 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_FORWARD
862 * \li Action: Search for a given string in forward direction.
863 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
864 * \li Syntax: word-find-forward [<STRING>]
865 * \li Origin: Etienne, 16 Feb 1998
868 { LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit },
870 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_BACKWARD
871 * \li Action: Search for a given string in backward direction.
872 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
873 * \li Syntax: word-find-backward [<STRING>]
874 * \li Origin: Etienne, 20 Feb 1998
877 { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
879 * \var lyx::FuncCode lyx::LFUN_WORD_FIND
880 * \li Action: Search for next occurrence of a string.
881 * \li Syntax: word-find [<DATA>]
882 * \li Params: <DATA>: data encoded from Find dialog (see #lyx::find2string()).
883 If no parameter is given, search with last find-dialog
884 data is used for search (i.e. find-next).
885 * \li Origin: Andre, Jan 7 2004
888 { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
890 * \var lyx::FuncCode lyx::LFUN_WORD_REPLACE
891 * \li Action: Replace a string in the document.
892 * \li Syntax: word-replace [<DATA>]
893 * \li Params: <DATA>: data is of the form
896 <casesensitive> <matchword> <all> <forward> <findnext>"
897 * \li Origin: Andre, Jan 7 2004
900 { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
902 * \var lyx::FuncCode lyx::LFUN_WORD_FINDADV
903 * \li Action: Search for next occurrence of a pattern.
904 * \li Syntax: word-findadv [<DATA>]
905 * \li Params: <DATA>: data encoded from FindAdv dialog (see #lyx::findadv2string()).
906 If no parameter is given, search with last find-dialog
907 data is used for search (i.e. find-next).
908 * \li Origin: Tommaso, Nov 15 2007
911 { LFUN_WORD_FINDADV, "word-findadv", ReadOnly | NoBuffer, Edit },
913 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD
914 * \li Action: Moves the cursor to the logically next beginning of a word.
915 * \li Notion: This is not the action which should be bound to the arrow keys,
916 because forward may be left or right, depending on the language.
917 The arrow keys should be bound to #LFUN_WORD_LEFT or
918 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
919 * \li Syntax: word-forward
922 { LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
924 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD_SELECT
925 * \li Action: Moves the cursor to the logically next beginning of a word,
926 adding the logically traversed text to the selection.
927 * \li Notion: See also #LFUN_WORD_FORWARD.
928 * \li Syntax: word-forward-select
931 { LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
933 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT
934 * \li Action: Moves the cursor to the next beginning of a word "on the left".
935 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
936 "left" key is pressed. Generally, it moves the cursor to the
937 next beginning of a word on the left. However, in Bidi text this
938 become slightly more complicated, and there are different modes
939 of cursor movement. In "visual mode", this moves left, plain and
940 simple. In "logical mode", movement is logically forward in RTL
941 paragraphs, and logically backwards in LTR paragraphs.
942 * \li Syntax: word-left
943 * \li Origin: dov, 28 Oct 2007
946 { LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
948 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT_SELECT
949 * \li Action: Moves the cursor to the next beginning of a word "on the left",
950 adding *logically* traversed text to the selection.
951 * \li Notion: See also #LFUN_WORD_LEFT for exact details of the movement.
952 * \li Syntax: word-left-select
953 * \li Origin: dov, 28 Oct 2007
956 { LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit },
958 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT
959 * \li Action: Moves the cursor to the next beginning of a word "on the right".
960 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
961 "right" key is pressed. Generally, it moves the cursor to the
962 next beginning of a word on the right. However, in Bidi text
963 this become slightly more complicated, and there are different
964 modes of cursor movement. In "visual mode", this moves right,
965 plain and simple. In "logical mode", movement is logically
966 forward in LTR paragraphs, and logically backwards in RTL
968 * \li Syntax: word-right
969 * \li Origin: dov, 28 Oct 2007
972 { LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit },
974 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT_SELECT
975 * \li Action: Moves the cursor to the next beginning of a word "on the right",
976 adding *logically* traversed text to the selection.
977 * \li Notion: See also #LFUN_WORD_RIGHT for exact details of the movement.
978 * \li Syntax: word-right-select
979 * \li Origin: dov, 28 Oct 2007
982 { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
984 * \var lyx::FuncCode lyx::LFUN_WORD_SELECT
985 * \li Action: Puts the word where the cursor stands into the selection.
986 * \li Syntax: word-select
987 * \li Origin: Andre, 11 Sep 2002
990 { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
992 * \var lyx::FuncCode lyx::LFUN_WORD_CAPITALIZE
993 * \li Action: Capitalizes the words in the selection (i.e. the first letters)
994 or the letter on the cursor position.
995 * \li Syntax: word-capitalize
998 { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
1000 * \var lyx::FuncCode lyx::LFUN_WORD_UPCASE
1001 * \li Action: Change the words in the selection or from the cursor position
1002 to the end of word to the upper case.
1003 * \li Syntax: word-upcase
1006 { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
1008 * \var lyx::FuncCode lyx::LFUN_WORD_LOWCASE
1009 * \li Action: Change the words in the selection or from the cursor position
1010 to the end of word to the lower case.
1011 * \li Syntax: word-lowcase
1014 { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
1016 * \var lyx::FuncCode lyx::LFUN_SPELLING_ADD
1017 * \li Action: Add the word under the cursor to the respective
1018 * spell checker dictionary.
1019 * \li Syntax: spelling-add [<STRING>] [<LANG>]
1020 * \li Params: <WORD>: word to add
1021 <LANG>: language name (see file languages)
1022 * \li Origin: JSpitzm, 18 Jan 2010
1025 { LFUN_SPELLING_ADD, "spelling-add", ReadOnly, Edit },
1027 * \var lyx::FuncCode lyx::LFUN_SPELLING_IGNORE
1028 * \li Action: Let the spell checker ignore the word under the cursor
1029 * in the current session for the given language.
1030 * \li Syntax: spelling-ignore [<WORD>] [<LANG>]
1031 * \li Params: <WORD>: word to ignore
1032 <LANG>: language name (see file languages)
1033 * \li Origin: JSpitzm, 18 Jan 2010
1036 { LFUN_SPELLING_IGNORE, "spelling-ignore", ReadOnly, Edit },
1038 * \var lyx::FuncCode lyx::LFUN_SPELLING_REMOVE
1039 * \li Action: Remove the word under the cursor from the respective
1040 * spell checker dictionary.
1041 * \li Syntax: spelling-remove [<STRING>] [<LANG>]
1042 * \li Params: <WORD>: word to remove
1043 <LANG>: language name (see file languages)
1044 * \li Origin: SWitt, 28 July 2010
1047 { LFUN_SPELLING_REMOVE, "spelling-remove", ReadOnly, Edit },
1049 * \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
1050 * \li Action: Look up thesaurus entries with respect to the word under the cursor.
1051 * \li Syntax: thesaurus-entry [<STRING>] [lang=<LANG>]
1052 * \li Params: <STRING>: word to look up
1053 <LANG>: language (see file languages)
1054 * \li Origin: Levon, 20 Jul 2001
1057 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
1059 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN
1060 * \li Action: Move the cursor to the beginning of the document.
1061 * \li Syntax: buffer-begin
1064 { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
1066 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN_SELECT
1067 * \li Action: Move the cursor to the beginning of the document adding the
1068 traversed text to the selection.
1069 * \li Syntax: buffer-begin-select
1072 { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
1074 * \var lyx::FuncCode lyx::LFUN_BUFFER_END
1075 * \li Action: Move the cursor to the end of the document.
1076 * \li Syntax: buffer-end
1079 { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
1081 * \var lyx::FuncCode lyx::LFUN_BUFFER_END_SELECT
1082 * \li Action: Move the cursor to the end of the document adding the
1083 traversed text to the selection.
1084 * \li Syntax: buffer-end-select
1087 { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
1090 * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN
1091 * \li Action: Move the cursor to the beginning of the current inset
1092 if it is not already there, or at the beginning of the
1093 enclosing inset otherwise
1094 * \li Syntax: inset-begin
1095 * \li Origin: lasgouttes, 16 Mar 2009
1098 { LFUN_INSET_BEGIN, "inset-begin", ReadOnly, Edit },
1100 * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN_SELECT
1101 * \li Action: Move the cursor to the beginning of the current inset
1102 if it is not already there, or at the beginning of the
1103 enclosing inset otherwise (adding the
1104 traversed text to the selection).
1105 * \li Syntax: inset-begin-select
1106 * \li Origin: lasgouttes, 16 Mar 2009
1109 { LFUN_INSET_BEGIN_SELECT, "inset-begin-select", ReadOnly, Edit },
1111 * \var lyx::FuncCode lyx::LFUN_INSET_END
1112 * \li Action: Move the cursor to the end of the current inset
1113 if it is not already there, or at the end of the
1114 enclosing inset otherwise
1115 * \li Syntax: inset-end
1116 * \li Origin: lasgouttes, 16 Mar 2009
1119 { LFUN_INSET_END, "inset-end", ReadOnly, Edit },
1121 * \var lyx::FuncCode lyx::LFUN_INSET_END_SELECT
1122 * \li Action: Move the cursor to the end of the current inset
1123 if it is not already there, or at the end of the
1124 enclosing inset otherwise (adding the
1125 traversed text to the selection).
1126 * \li Syntax: inset-end-select
1127 * \li Origin: lasgouttes, 16 Mar 2009
1130 { LFUN_INSET_END_SELECT, "inset-end-select", ReadOnly, Edit },
1133 * \var lyx::FuncCode lyx::LFUN_INSET_SELECT_ALL
1134 * \li Action: Selects all contents of an inset.
1135 * \li Syntax: inset-select-all
1136 * \li Origin: vfr, 22 Aug 2009
1139 { LFUN_INSET_SELECT_ALL, "inset-select-all", ReadOnly, Edit },
1142 * \var lyx::FuncCode lyx::LFUN_SECTION_SELECT
1143 * \li Action: Selects the whole section.
1144 * \li Notion: The cursor should be in a section heading
1145 before calling this lfun.
1146 * \li Syntax: section-select
1147 * \li Origin: vfr, 05 May 2009
1150 { LFUN_SECTION_SELECT, "section-select", ReadOnly, Edit },
1153 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN
1154 * \li Action: Move the cursor to the beginning of the (screen) line.
1155 * \li Syntax: line-begin
1158 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
1160 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN_SELECT
1161 * \li Action: Move the cursor to the beginning of the (screen) line adding the
1162 traversed text to the selection.
1163 * \li Syntax: line-begin-select
1166 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
1168 * \var lyx::FuncCode lyx::LFUN_LINE_END
1169 * \li Action: Move the cursor to the end of the (screen) line.
1170 * \li Syntax: line-end
1173 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
1175 * \var lyx::FuncCode lyx::LFUN_LINE_END_SELECT
1176 * \li Action: Move the cursor to the end of the (screen) line adding the
1177 traversed text to the selection.
1178 * \li Syntax: line-end-select
1181 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
1183 * \var lyx::FuncCode lyx::LFUN_LINE_DELETE
1184 * \li Action: Deletes the letters to the end of the (screen) line or
1185 deletes the selection.
1186 * \li Syntax: line-delete-forward
1189 { LFUN_LINE_DELETE, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
1191 * \var lyx::FuncCode lyx::LFUN_COPY
1192 * \li Action: Copies the current selection to the clipboard.
1196 { LFUN_COPY, "copy", ReadOnly, Edit },
1198 * \var lyx::FuncCode lyx::LFUN_CUT
1199 * \li Action: Cuts to the clipboard.
1203 { LFUN_CUT, "cut", Noop, Edit },
1205 * \var lyx::FuncCode lyx::LFUN_PASTE
1206 * \li Action: Pastes material (text or picture) from the active clipboard.
1207 * \li Syntax: paste [<TYPE>|<NUM>]
1208 * \li Params: <TYPE>: emf|pdf|png|jpeg|linkback|wmf \n
1209 <NUM>: number of the selection in the internal clipboard stack to be pasted.
1212 { LFUN_PASTE, "paste", Noop, Edit },
1214 * \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE
1215 * \li Action: Pastes text from the active clipboard.
1216 * \li Syntax: clipboard-paste [<ARG>]
1217 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1218 * \li Origin: Georg, 10 Jul 2006
1221 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
1223 * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
1224 * \li Action: Pastes the currently selected text.
1225 * \li Notion: Primary selection mechanism is linux-only thing.
1226 * \li Syntax: primary-selection-paste [<ARG>]
1227 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1230 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
1232 * \var lyx::FuncCode lyx::LFUN_SELECTION_PASTE
1233 * \li Action: Pastes the internal selection text in permanent selection.
1234 * \li Notion: Created in order to have middle mouse button pasting correct (bound to
1235 command-alternatives selection-paste ; primary-selection-paste paragraph).
1236 * \li Syntax: selection-paste
1237 * \li Origin: lasgouttes, 14 Jan 2009
1240 { LFUN_SELECTION_PASTE, "selection-paste", Noop, Edit },
1242 * \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE_SIMPLE
1243 * \li Action: Pastes simple unformatted text from the active clipboard.
1244 * \li Syntax: clipboard-paste-simple [<ARG>]
1245 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1248 { LFUN_CLIPBOARD_PASTE_SIMPLE, "clipboard-paste-simple", Noop, Edit },
1250 * \var lyx::FuncCode lyx::LFUN_UNDO
1251 * \li Action: Undoes the last edit.
1255 { LFUN_UNDO, "undo", ReadOnly, Edit },
1257 * \var lyx::FuncCode lyx::LFUN_REDO
1258 * \li Action: Redoes the last thing undone.
1262 { LFUN_REDO, "redo", ReadOnly, Edit },
1264 * \var lyx::FuncCode lyx::LFUN_REPEAT
1265 * \li Action: Repeat the given command.
1266 * \li Syntax: repeat <COUNT> <LFUN-COMMAND>
1267 * \li Origin: Andre, 27 Oct 2003
1270 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
1272 * \var lyx::FuncCode lyx::LFUN_CHARS_TRANSPOSE
1273 * \li Action: Transposes the character at the cursor with the one before it.
1274 * \li Syntax: chars-transpose
1275 * \li Origin: Lgb, 25 Apr 2001
1278 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
1281 * \var lyx::FuncCode lyx::LFUN_DEPTH_DECREMENT
1282 * \li Action: Decrease the nesting depth of the (selected) paragraph(s)
1284 * \li Syntax: depth-decrement
1287 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
1289 * \var lyx::FuncCode lyx::LFUN_DEPTH_INCREMENT
1290 * \li Action: Increase the nesting depth of the (selected) paragraph(s)
1292 * \li Syntax: depth-increment
1295 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
1298 * \var lyx::FuncCode lyx::LFUN_FONT_BOLD
1299 * \li Action: Toggles the bold font (selection-wise) using mathbf in math.
1300 * \li Syntax: font-bold
1303 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
1306 * \var lyx::FuncCode lyx::LFUN_FONT_BOLDSYMBOL
1307 * \li Action: Toggles the bold font (selection-wise) using boldsymbol in math.
1308 * \li Syntax: font-boldsymbol
1311 { LFUN_FONT_BOLDSYMBOL, "font-boldsymbol", Noop, Layout },
1313 * \var lyx::FuncCode lyx::LFUN_FONT_TYPEWRITER
1314 * \li Action: Toggles the typewriter family font (selection-wise).
1315 * \li Syntax: font-typewriter
1318 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
1320 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERLINE
1321 * \li Action: Toggles underline in the font (selection-wise).
1322 * \li Syntax: font-underline
1325 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
1327 * \var lyx::FuncCode lyx::LFUN_FONT_UULINE
1328 * \li Action: Toggles double underline in the font (selection-wise).
1329 * \li Syntax: font-underunderline
1330 * \li Origin: sanda, 5 May 2009
1333 { LFUN_FONT_UULINE, "font-underunderline", Noop, Layout },
1335 * \var lyx::FuncCode lyx::LFUN_FONT_UWAVE
1336 * \li Action: Toggles wavy underline in the font (selection-wise).
1337 * \li Syntax: font-underwave
1338 * \li Origin: sanda, 5 May 2009
1341 { LFUN_FONT_UWAVE, "font-underwave", Noop, Layout },
1343 * \var lyx::FuncCode lyx::LFUN_FONT_STRIKEOUT
1344 * \li Action: Toggles strikeout (strike-through) in the font (selection-wise).
1345 * \li Syntax: font-strikeout
1346 * \li Origin: sanda, 3 May 2009
1349 { LFUN_FONT_STRIKEOUT, "font-strikeout", Noop, Layout },
1351 * \var lyx::FuncCode lyx::LFUN_FONT_EMPH
1352 * \li Action: Toggles the emphasis font style (selection-wise).
1353 * \li Syntax: font-emph
1356 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
1358 * \var lyx::FuncCode lyx::LFUN_FONT_NOUN
1359 * \li Action: Toggles Noun text style font (selection-wise).
1360 * \li Syntax: font-noun
1363 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
1365 * \var lyx::FuncCode lyx::LFUN_FONT_ROMAN
1366 * \li Action: Toggles Roman family font (selection-wise).
1367 * \li Syntax: font-roman
1370 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
1372 * \var lyx::FuncCode lyx::LFUN_FONT_SANS
1373 * \li Action: Toggles Sans Serif family font (selection-wise).
1374 * \li Syntax: font-sans
1377 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
1379 * \var lyx::FuncCode lyx::LFUN_FONT_FRAK
1380 * \li Action: Toggles Fraktur family font (math-mode, selection-wise).
1381 * \li Syntax: font-frak
1382 * \li Origin: vermeer, 10 Jan 2002
1385 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
1387 * \var lyx::FuncCode lyx::LFUN_FONT_ITAL
1388 * \li Action: Toggles Italics font shape (math-mode, selection-wise).
1389 * \li Syntax: font-ital
1390 * \li Origin: vermeer, 10 Jan 2002
1393 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
1395 * \var lyx::FuncCode lyx::LFUN_FONT_DEFAULT
1396 * \li Action: Reverts the settings of the font to the default values (selection-wise).
1397 * \li Syntax: font-default
1400 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
1402 * \var lyx::FuncCode lyx::LFUN_FONT_SIZE
1403 * \li Action: Sets font size according to lyx format string.
1404 * \li Syntax: font-size <SIZE>
1405 * \li Params: <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|\n
1406 largest|huge|giant|increase|decrease|default
1409 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
1411 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_APPLY
1412 * \li Action: Toggle user-defined (=last-time used) text style.
1413 * \li Notion: This style is set via #LFUN_TEXTSTYLE_UPDATE, which is
1414 automatically triggered when using Text Style dialog.
1415 * \li Syntax: textstyle-apply
1416 * \li Origin: leeming, 12 Mar 2003
1419 { LFUN_TEXTSTYLE_APPLY, "textstyle-apply", Noop, Layout },
1421 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_UPDATE
1422 * \li Action: Apply text style and update the settings to be used by #LFUN_TEXTSTYLE_APPLY.
1423 * \li Syntax: textstyle-update <FONT_INFO>
1424 * \li Params: <FONT_INFO>: specifies font atributes, e.g. family, series, shape,
1425 size, emph, noun, underbar, number, color, language,
1427 Use lyx -dbg action for exact syntax of text-style
1429 * \li Origin: leeming, 12 Mar 2003
1432 { LFUN_TEXTSTYLE_UPDATE, "textstyle-update", Noop, Layout },
1434 * \var lyx::FuncCode lyx::LFUN_SCREEN_FONT_UPDATE
1435 * \li Action: Update fonts and its metrics.
1436 * \li Notion: Automatically called after zoom, dpi, font names, or norm change.
1437 * \li Syntax: screen-font-update
1438 * \li Origin: ARRae, 13 Aug 2000
1441 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
1443 * \var lyx::FuncCode lyx::LFUN_FONT_STATE
1444 * \li Action: Returns the info about the current font.
1445 * \li Syntax: font-state
1448 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
1451 * \var lyx::FuncCode lyx::LFUN_CITATION_INSERT
1452 * \li Action: Inserts citation from loaded citation database.
1453 * \li Syntax: citation-insert [<KEY>[|<TEXT_BEFORE>]]
1454 * \li Params: <KEY>: Citation (shortcut listed in available citations). \n
1455 <TEXT_BEFORE>: text which should appear before citation.
1456 * \li Origin: AAS, 97-02-23
1459 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
1461 * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_ADD
1462 * \li Action: Adds database, which will be used for bibtex citations.
1463 * \li Notion: Databases are added to the first BibTeX inset
1464 (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
1465 * \li Syntax: bibtex-database-add <DATABASE-NAME>
1466 * \li Origin: Ale, 30 May 1997
1469 { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit },
1471 * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_DEL
1472 * \li Action: Adds database, which will be used for bibtex citations.
1473 * \li Notion: Databases are deleted from the first BibTeX inset
1474 (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
1475 * \li Syntax: bibtex-database-del <DATABASE-NAME>
1476 * \li Origin: Ale, 30 May 1997
1479 { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
1482 * \var lyx::FuncCode lyx::LFUN_LAYOUT
1483 * \li Action: Sets the layout (that is, environment) for the current paragraph.
1484 * \li Syntax: layout <LAYOUT>
1485 * \li Params: <LAYOUT>: the layout to use
1488 { LFUN_LAYOUT, "layout", Noop, Layout },
1490 * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH
1491 * \li Action: Launches the paragraph settings dialog.
1492 * \li Syntax: layout-paragraph
1495 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
1497 * \var lyx::FuncCode lyx::LFUN_LAYOUT_TABULAR
1498 * \li Action: Launches the tabular settings dialog.
1499 * \li Syntax: layout-tabular
1500 * \li Origin: Jug, 31 Jul 2000
1503 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
1505 * \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE
1506 * \li Action: Displays list of layout choices.
1507 * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
1508 dropbox allowing for choice of layout.
1509 * \li Syntax: drop-layouts-choice
1512 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
1514 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
1515 * \li Action: Clears the module list.
1516 * \li Notion: Clears the list of included modules for the current buffer.
1517 * \li Syntax: layout-modules-clear
1518 * \li Origin: rgh, 25 August 2007
1521 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", NoInternal, Layout },
1523 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULE_ADD
1524 * \li Action: Adds a module.
1525 * \li Notion: Adds a module to the list of included modules for the current buffer.
1526 * \li Syntax: layout-module-add <MODULE>
1527 * \li Params: <MODULE>: the module to be added
1528 * \li Origin: rgh, 25 August 2007
1531 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", NoInternal, Layout },
1533 * \var lyx::FuncCode lyx::LFUN_LAYOUT_RELOAD
1534 * \li Action: Reloads layout information.
1535 * \li Notion: Reloads all layout information for the current buffer from disk, thus
1536 recognizing any changes that have been made to layout files on the fly.
1537 This is intended to be used only by layout developers and should not be
1538 used when one is trying to do actual work.
1539 * \li Syntax: layout-reload
1540 * \li Origin: rgh, 3 September 2007
1543 { LFUN_LAYOUT_RELOAD, "layout-reload", NoInternal, Layout },
1545 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
1546 * \li Action: Sets the text class for the current buffer.
1547 * \li Syntax: textclass-apply <TEXTCLASS>
1548 * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
1549 the filename, minus the ".layout" extension.
1552 { LFUN_TEXTCLASS_APPLY, "textclass-apply", NoInternal, Layout },
1554 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
1555 * \li Action: Loads information for a textclass from disk.
1556 * \li Syntax: textclass-load <TEXTCLASS>
1557 * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
1558 the filename, minus the ".layout" extension.
1561 { LFUN_TEXTCLASS_LOAD, "textclass-load", NoInternal, Layout },
1564 * \var lyx::FuncCode lyx::LFUN_MARK_OFF
1565 * \li Action: Disable selecting of text-region.
1566 * \li Syntax: mark-off
1569 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
1571 * \var lyx::FuncCode lyx::LFUN_MARK_ON
1572 * \li Action: Enable selecting of text-region.
1573 * \li Notion: After enabling you can simply move arrow keys to get selected region.
1574 * \li Syntax: mark-on
1577 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
1579 * \var lyx::FuncCode lyx::LFUN_MARK_TOGGLE
1580 * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
1581 * \li Syntax: mark-toggle
1582 * \li Origin: Andre, May 5 2006
1585 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
1588 * \var lyx::FuncCode lyx::LFUN_MATH_DELIM
1589 * \li Action: Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
1590 * \li Syntax: math-delim [<LEFT>] [<RIGHT>]
1591 * \li Params: <LEFT/RIGHT>: Delimiters to be used. Each delimiter can be specified by
1592 either a LaTeX name or a valid character.
1593 ( is the default letter.
1594 * \li Sample: math-delim { rangle
1595 * \li Origin: Alejandro, 18 Jun 1996
1598 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
1600 * \var lyx::FuncCode lyx::LFUN_MATH_BIGDELIM
1601 * \li Action: Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
1602 * \li Syntax: math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
1603 * \li Params: <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r \n
1604 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
1605 * \li Sample: math-bigdelim "Bigl" "\Downarrow" "Bigr" "\}"
1606 * \li Origin: Enrico & Georg, 7 May 2006
1609 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
1611 * \var lyx::FuncCode lyx::LFUN_MATH_DISPLAY
1612 * \li Action: Creates a new displayed equation in text mode.
1613 Toggles inlined/display formula in math mode.
1614 * \li Syntax: math-display [<ARG>]
1615 * \li Params: <ARG>: this argument will be passed to #LFUN_MATH_INSERT when creating
1616 new equation from the text mode.
1617 * \li Origin: Alejandro, 18 Jun 1996
1620 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
1622 * \var lyx::FuncCode lyx::LFUN_MATH_INSERT
1623 * \li Action: Inserts math objects and symbols.
1624 * \li Syntax: math-insert <ARG>
1625 * \li Params: <ARG>: Symbol or LaTeX code to be inserted.
1626 * \li Notion: When <ARG> is a _single_ math inset with more than one cell
1627 (such as "x_y^z" or "\frac{x}{y}"), the content of cell(0) is
1628 replaced by the current selection (only works if the selection
1629 is in mathed). As an example, if "abc" is selected in mathed,
1630 "math-insert \frac{x}{y}" replaces "abc" with "\frac{abc}{y}",
1631 and "math-insert x_y^z" replaces "abc" with "abc_y^z".
1632 If nothing is selected (or the selection is not in mathed),
1633 math-insert works as expected.
1636 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
1638 * \var lyx::FuncCode lyx::LFUN_MATH_SUBSCRIPT
1639 * \li Action: Enters subscript expression in math expression.
1640 * \li Syntax: math-subscript
1641 * \li Origin: vermeer, 12 Dec 2001
1644 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
1646 * \var lyx::FuncCode lyx::LFUN_MATH_SUPERSCRIPT
1647 * \li Action: Enters superscript expression in math expression.
1648 * \li Syntax: math-superscript
1649 * \li Origin: vermeer, 12 Dec 2001
1652 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
1654 * \var lyx::FuncCode lyx::LFUN_MATH_LIMITS
1655 * \li Action: Toggles the position of the limits from above/below to the right
1656 side an vice versa in integral symbol, a limit, a summation, etc.
1657 * \li Notion: Put the cursor before the symbol with the limits and then invoke
1659 * \li Syntax: math-limits [<STATE>]
1660 * \li Params: <STATE>: limits|nolimits
1663 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
1665 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO
1666 * \li Action: Inserts a math macro definition at the cursor position in the text.
1667 * \li Syntax: math-macro <NAME> [<NARGS>] [def]
1668 * \li Params: <NAME>: The name of the macro, e.g. "mymacro".\n
1669 <NARGS>: The number of parameters of the macro. Default is 0.
1670 "def": Has no effect anymore, just for compatibility with former LyX versions.
1671 * \li Origin: ale, 10 May 1997; sts, 21 Dec 2007
1674 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
1676 * \var lyx::FuncCode lyx::LFUN_MATH_MUTATE
1677 * \li Action: Mutates the type of math inset to the newly selected one.
1678 * \li Syntax: math-mutate <TYPE>
1679 * \li Params: <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
1680 multline|gather|flalign
1681 * \li Origin: Andre, 23 May 2001
1684 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
1686 * \var lyx::FuncCode lyx::LFUN_MATH_SPACE
1687 * \li Action: Inserts space into math expression.
1688 * \li Notion: Use spacebar after entering this space to change type of space.
1689 * \li Syntax: math-space [<TYPE>] [<LEN>]
1690 * \li Params: <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace \n
1691 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad \n
1692 custom space: hspace \n
1693 "," used by default.\n
1694 Note that ! is equivalent to negthinspace, , = thinspace,
1695 : = medspace, and ; = thickspace.\n
1696 <LEN>: length for custom spaces (hspace)
1697 * \li Origin: Andre, 25 Jul 2001; sanda, 16 Jun 2008
1700 { LFUN_MATH_SPACE, "math-space", Noop, Math },
1702 * \var lyx::FuncCode lyx::LFUN_MATH_MATRIX
1703 * \li Action: Inserts a matrix.
1704 * \li Syntax: math-matrix <COLS> <ROWS> [<ALIGN>]
1705 * \li Params: <ALIGN>: Alignment is a word composed of the vertical alignment
1706 (b, c or t) (i.e. 1 char) and the horizontal alignments
1707 (l, c or r) (i.e. <COL> chars).
1708 * \li Sample: math-matrix 3 3 bccc
1711 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
1713 * \var lyx::FuncCode lyx::LFUN_MATH_AMS_MATRIX
1714 * \li Action: Inserts a matrix.
1715 * \li Syntax: math-matrix <COLS> <ROWS> [<DECORATION>]
1716 * \li Params: <DECORATION>: Decoration determines the LaTeX name of the matrix
1717 that should be created.
1718 * \li Sample: math-ams-matrix 3 3 bmatrix
1721 { LFUN_MATH_AMS_MATRIX, "math-ams-matrix", Noop, Math },
1723 * \var lyx::FuncCode lyx::LFUN_MATH_MODE
1724 * \li Action: In text mode enters math mode (i.e. puts math insets on the current
1725 cursor position), in math mode enters text mode inside math expression.
1726 * \li Notion: If there is some selected text, it puts the text inside created math box.
1727 * \li Syntax: math-mode [on|<ARG>]
1728 * \li Params: <ARG>: eventual argument (LaTeX code) is passed to #LFUN_MATH_INSERT .\n
1729 "on": allow only entering of math mode from text mode.
1730 * \li Origin: Alejandro, 4 Jun 1996
1733 { LFUN_MATH_MODE, "math-mode", Noop, Math },
1735 * \var lyx::FuncCode lyx::LFUN_REGEXP_MODE
1736 * \li Action: Enters regexp mode (i.e., puts regexp insets on the current
1737 cursor position). Used by the advanced search dialog.
1738 * \li Notion: If there is any selected text, then it is moved inside the created
1740 * \li Syntax: regexp-mode [<ARG>]
1741 * \li Params: <ARG>: eventual argument (regular expression).
1742 * \li Origin: Tommaso, 4 Oct 2008
1745 { LFUN_REGEXP_MODE, "regexp-mode", Noop, Math },
1747 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
1748 * \li Action: Toggles numbering of the current formula line.
1749 * \li Notion: Must be in display formula mode.
1750 * \li Syntax: math-number-line-toggle
1751 * \li Origin: Alejandro, 18 Jun 1996
1754 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
1756 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
1757 * \li Action: Toggles numbering/labeling of the current formula.
1758 * \li Notion: Must be in display formula mode.
1759 * \li Syntax: math-number-toggle
1760 * \li Origin: Alejandro, 4 Jun 1996
1763 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
1765 * \var lyx::FuncCode lyx::LFUN_MATH_EXTERN
1766 * \li Action: Calls external program and passes the current expression/equation
1767 as an argument for the calculation in the format appropriate to the
1769 * \li Notion: Selection can be used to determine the input for the external program.
1770 * \li Syntax: math-extern <LANG> [<COMMAND>]
1771 * \li Params: <LANG>: octave|maxima|maple|mathematica|script \n
1772 where "script" stands for the external script (normalized
1773 expression will be passed)
1774 * \li Origin: Andre, 24 Apr 2001
1775 * \li Sample: math-extern maple simplify
1778 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
1780 * \var lyx::FuncCode lyx::LFUN_MATH_SIZE
1781 * \li Action: Changes arbitrarily the size used by math fonts inside a context.
1782 * \li Notion: Provides an interface to the LaTeX math mode font size commands.
1783 * \li Syntax: math-size <STYLE>
1784 * \li Params: <STYLE>: \displaystyle|\textstyle|\scriptstyle|\scriptscriptstyle
1785 * \li Origin: Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
1788 { LFUN_MATH_SIZE, "math-size", Noop, Math },
1790 * \var lyx::FuncCode lyx::LFUN_MATH_FONT_STYLE
1791 * \li Action: Changes the text style used in math.
1792 * \li Syntax: math-font-style <STYLE>
1793 * \li Params: <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf|textnormal\n
1794 |textrm|textsf|texttt|textbf|textmd|textit|textsc|textsl|textup
1795 * \li Origin: vfr, 9 jan 2009
1798 { LFUN_MATH_FONT_STYLE, "math-font-style", Noop, Math },
1800 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
1801 * \li Action: Unfold a Math Macro.
1802 * \li Notion: Unfold the Math Macro the cursor is in, i.e.
1804 * \li Syntax: math-macro-unfold
1805 * \li Origin: sts, 06 January 2008
1808 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
1810 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
1811 * \li Action: Fold a Math Macro.
1812 * \li Notion: Fold the Math Macro the cursor is in if it was
1813 unfolded, i.e. displayed as \foo before.
1814 * \li Syntax: math-macro-fold
1815 * \li Origin: sts, 06 January 2008
1818 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
1820 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
1821 * \li Action: Add a parameter.
1822 * \li Notion: Add a parameter to a Math Macro.
1823 * \li Params: <NUM>: The number of the parameter behind which the new one
1824 will be added (1 for the first, i.e. use 0 for add a
1825 parameter at the left), defaults to the last one.
1826 * \li Syntax: math-macro-add-param <NUM>
1827 * \li Origin: sts, 06 January 2008
1830 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
1832 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
1833 * \li Action: Remove the last parameter.
1834 * \li Notion: Remove the last parameter of a Math Macro and
1835 remove its value in all instances of the macro
1837 * \li Params: <NUM>: The number of the parameter to be deleted (1 for
1838 the first), defaults to the last one.
1839 * \li Syntax: math-macro-remove-param <NUM>
1840 * \li Origin: sts, 06 January 2008
1843 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
1845 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
1846 * \li Action: Append a greedy parameter.
1847 * \li Notion: Append a greedy parameter to a Math Macro which
1848 eats the following mathed cell in every instance of
1849 the macro in the buffer.
1850 * \li Syntax: math-macro-append-greedy-param
1851 * \li Origin: sts, 06 January 2008
1854 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
1856 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
1857 * \li Action: Remove a greedy parameter.
1858 * \li Notion: Remove a greedy parameter of a Math Macro and spit
1859 out the values of it in every instance of the macro
1860 in the buffer. If it is an optional parameter the [valud]
1862 * \li Syntax: math-macro-remove-greedy-param
1863 * \li Origin: sts, 06 January 2008
1866 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
1868 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
1869 * \li Action: Make a parameter optional.
1870 * \li Notion: Turn the first non-optional parameter of a Math Macro
1871 into an optional parameter with a default value.
1872 * \li Syntax: math-macro-make-optional
1873 * \li Origin: sts, 06 January 2008
1876 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
1878 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
1879 * \li Action: Make a parameter non-optional.
1880 * \li Notion: Turn the last optional parameter of a Math Macro
1881 into a non-optional parameter. The default value is
1882 remembered to be reused later if the user changes his mind.
1883 * \li Syntax: math-macro-make-nonoptional
1884 * \li Origin: sts, 06 January 2008
1887 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
1889 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
1890 * \li Action: Add an optional parameter.
1891 * \li Notion: Insert an optional parameter just behind the
1892 already existing optional parameters.
1893 * \li Syntax: math-macro-add-optional-param
1894 * \li Origin: sts, 06 January 2008
1897 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
1899 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
1900 * \li Action: Remove the last optional parameter.
1901 * \li Notion: Remove the last optional parameter of a Math Macro and
1902 remove it in all the instances of the macro in the buffer.
1903 * \li Syntax: math-macro-remove-optional-param
1904 * \li Origin: sts, 06 January 2008
1907 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
1909 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
1910 * \li Action: Add a greedy optional parameter.
1911 * \li Notion: Add a greedy optional parameter which eats the value
1912 from the following cells in mathed which are in the [value]
1914 * \li Syntax: math-macro-add-greedy-optional-param
1915 * \li Origin: sts, 06 January 2008
1918 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
1920 * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
1921 * \li Action: Only active in Math Macro definition.
1922 * \li Notion: Dummy function which is only active in a Math Macro definition.
1923 It's used to toggle the Math Macro toolbar if the cursor moves
1924 into a Math Macro definition.
1925 * \li Syntax: in-mathmacrotemplate
1926 * \li Origin: sts, 06 January 2008
1929 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
1932 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
1933 * \li Action: Moves the current paragraph downwards in the document.
1934 * \li Syntax: paragraph-move-down
1935 * \li Origin: Edwin, 8 Apr 2006
1938 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
1940 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
1941 * \li Action: Moves the current paragraph upwards in the document.
1942 * \li Notion: Movement through the document will possibly break the paragraph-depth
1943 (e.g. itemize structure).
1944 * \li Syntax: paragraph-move-up
1945 * \li Origin: Edwin, 8 Apr 2006
1948 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
1951 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP
1952 * \li Action: Move the cursor to the next paragraph (or beginning of the current one)
1953 in upward direction.
1954 * \li Syntax: paragraph-up
1955 * \li Origin: Asger, 1 Oct 1996
1958 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
1960 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP_SELECT
1961 * \li Action: Move the cursor and select the text to the next paragraph (or
1962 beginning of the current one) in upward direction.
1963 * \li Syntax: paragraph-up-select
1964 * \li Origin: Asger, 1 Oct 1996
1967 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
1969 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN
1970 * \li Action: Move the cursor to the next paragraph (or beginning of the current one)
1971 in downward direction.
1972 * \li Syntax: paragraph-down
1973 * \li Origin: Asger, 1 Oct 1996
1976 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
1978 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN_SELECT
1979 * \li Action: Move the cursor and select the text to the next paragraph (or
1980 beginning of the current one) in downward direction.
1981 * \li Syntax: paragraph-down-select
1982 * \li Origin: Asger, 1 Oct 1996
1985 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
1987 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
1988 * \li Action: Jump to a paragraph given by its id number and optionally the
1989 desired position within the paragraph.
1990 * \li Notion: Note that id number of paragraph is not the sequential number of paragraph
1991 seen on the screen. Moreover the id is unique for all opened buffers (documents).
1992 * \li Syntax: paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
1993 * \li Params: <PAR_ID_NUMBER>: paragraph id \n
1994 <POSITION_IN_PAR>: desired position within the paragraph
1995 * \li Origin: Dekel, 26 Aug 2000
1998 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly | NoInternal, Edit },
2000 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_BREAK
2001 * \li Action: Breaks the current paragraph at the current location.
2002 * \li Notion: Removes the selection.
2003 * \li Syntax: paragraph-break [<LAYOUT>]
2004 * \li Params: <LAYOUT>: "inverse" - decreases depth by one (or change layout
2005 to default layout) when the cursor is at the end of
2009 { LFUN_PARAGRAPH_BREAK, "paragraph-break", Noop, Edit },
2011 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
2012 * \li Action: Change paragraph settings.
2013 * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
2014 This function only modifies, and does not override, existing settings.
2015 Note that the "leftindent" indent setting is deprecated.
2016 * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
2017 * \li Params: <INDENT>: \noindent|\indent|\indent-toggle|\leftindent LENGTH\n
2018 <SPACING>: \paragraph_spacing default|single|onehalf|double|other SIZE \n
2019 <ALIGN>: \align block|left|right|center|default\n
2020 <OTHERS>: \labelwidthstring WIDTH|\start_of_appendix
2021 * \li Origin: rgh, Aug 15 2007
2024 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
2026 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
2027 * \li Action: Change paragraph settings.
2028 * \li Notion: Overwrite all nonspecified settings to the default ones.
2029 Use paragraph-params lfun if you don't want to overwrite others settings.
2030 * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
2031 * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
2032 * \li Origin: leeming, 30 Mar 2004
2035 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
2037 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UPDATE
2038 * \li Action: Updates the values inside the paragraph dialog from the paragraph.
2039 * \li Notion: This is an internal LFUN, not to be used by users. Called internally
2040 by #LFUN_DIALOG_UPDATE.
2041 * \li Origin: leeming, 13 Mar 2003
2044 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
2047 * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
2048 * \li Action: Move the current group in the upward direction in the
2049 structure of the document.
2050 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
2051 the whole substructure of the group.
2052 * \li Syntax: outline-up
2053 * \li Origin: Vermeer, 23 Mar 2006
2056 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
2058 * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
2059 * \li Action: Move the current group in the downward direction in the
2060 structure of the document.
2061 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
2062 the whole substructure of the group.
2063 * \li Syntax: outline-down
2064 * \li Origin: Vermeer, 23 Mar 2006
2067 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
2069 * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
2070 * \li Action: Moves the current group in the downward direction in the
2071 hierarchy of the document structure.
2072 * \li Notion: Part -> Chapter -> Section -> etc.
2073 * \li Syntax: outline-in
2074 * \li Origin: Vermeer, 23 Mar 2006
2077 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
2079 * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
2080 * \li Action: Moves the current group in the upward direction in the
2081 hierarchy of the document structure.
2082 * \li Notion: Part <- Chapter <- Section <- etc.
2083 * \li Syntax: outline-out
2084 * \li Origin: Vermeer, 23 Mar 2006
2087 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
2090 * \var lyx::FuncCode lyx::LFUN_INSET_EDIT
2091 * \li Action: Edit the inset at cursor with an external application,
2092 if one is attributed.
2093 * \li Syntax: inset-edit [<INSET_PARAMS>]
2094 * \li Params: <INSET_PARAMS>: Parameters for the inset. \n
2095 Currently only the filename will be considered.
2096 * \li Origin: JSpitzm, 27 Apr 2006
2099 { LFUN_INSET_EDIT, "inset-edit", ReadOnly | AtPoint, Edit },
2102 * \var lyx::FuncCode lyx::LFUN_TABULAR_INSERT
2103 * \li Action: Inserts table into the document.
2104 * \li Notion: See #LFUN_INSET_MODIFY for some more details
2105 about tabular modifications.
2106 * \li Syntax: tabular-insert [<ROWS> <COLUMNS>]
2107 * \li Params: In case no arguments are given show insert dialog.
2108 * \li Origin: Jug, 12 Apr 2000
2111 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
2114 * \var lyx::FuncCode lyx::LFUN_CELL_BACKWARD
2115 * \li Action: Moves the cursor to the previous cell inside the table.
2116 * \li Syntax: cell-backward
2117 * \li Origin: Jug, 22 May 2000
2120 { LFUN_CELL_BACKWARD, "cell-backward", ReadOnly | NoUpdate, Edit },
2122 * \var lyx::FuncCode lyx::LFUN_CELL_FORWARD
2123 * \li Action: Moves the cursor to the next cell inside the table.
2124 * \li Syntax: cell-forward
2127 { LFUN_CELL_FORWARD, "cell-forward", ReadOnly | NoUpdate, Edit },
2129 * \var lyx::FuncCode lyx::LFUN_CELL_SPLIT
2130 * \li Action: Splits cell and shifts right part to the next cell (inside the math grid).
2131 * \li Syntax: cell-split
2132 * \li Origin: Ale, 15 May 1997
2135 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
2138 * \var lyx::FuncCode lyx::LFUN_VC_REGISTER
2139 * \li Action: Register the document as an file inside version control system.
2140 * \li Notion: File is registered inside cvs, svn or rcs repository acording to the existence
2141 of cvs/svn/rcs entries in the document's directory. \n
2142 See LyX Additional Features Manual (Version Control Chapter) for additional
2144 * \li Syntax: vc-register
2145 * \li Origin: Lgb, 1 Jul 1997
2148 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
2150 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_IN
2151 * \li Action: Checks-in/commits the changes of the registered file to the repository.
2152 * \li Notion: In RCS case this also unlocks the file.
2153 * \li Syntax: vc-check-in
2154 * \li Origin: Lgb, 1 Jul 1997
2157 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
2159 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_OUT
2160 * \li Action: Checks-out the document for edit (and locks it in some cases).
2161 * \li Syntax: vc-check-out
2162 * \li Origin: Lgb, 1 Jul 1997
2165 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
2167 * \var lyx::FuncCode lyx::LFUN_VC_REVERT
2168 * \li Action: Reverts the document to the last check-in/commit in VCS.
2169 * \li Syntax: vc-revert
2170 * \li Origin: Lgb, 1 Jul 1997
2173 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
2175 * \var lyx::FuncCode lyx::LFUN_VC_UNDO_LAST
2176 * \li Action: Undo last check-in.
2177 * \li Notion: This is currently implemented only for RCS.
2178 * \li Syntax: vc-check-out
2179 * \li Origin: Lgb, 1 Jul 1997
2182 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
2184 * \var lyx::FuncCode lyx::LFUN_VC_COMMAND
2185 * \li Action: Executes external command. This command is intended to support
2186 additional VCS commands.
2187 * \li Syntax: vc-command <FLAG> <PATH> <COMMAND>
2188 * \li Params: <FLAG>: Flags for the command can be combined together.\n
2189 U - dUmmy - no flags \n
2190 D - Doc - need document loaded to proceed \n
2191 I - dIrty - mark document dirty \n
2192 R - Reload - ensure that the document is saved and reload it after command execution \n
2193 M - Message - ask for input string (commit message)\n
2194 <PATH>: path where to start. $$p will be replaced by the current document path.\n
2195 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current
2196 document(with absolute path)/path/message.
2197 * \li Sample: vc-command DR $$p "svn up"
2198 * \li Origin: sanda, 13 Jan 2009
2201 { LFUN_VC_COMMAND, "vc-command", NoBuffer | ReadOnly, System },
2203 * \var lyx::FuncCode lyx::LFUN_VC_LOCKING_TOGGLE
2204 * \li Action: Toggles the locking property of the edited file.
2205 * \li Notion: This is currently implemented only for SVN.
2206 * \li Syntax: vc-locking-toggle
2207 * \li Origin: sanda, 25 Jun 2009
2210 { LFUN_VC_LOCKING_TOGGLE, "vc-locking-toggle", ReadOnly, System },
2212 * \var lyx::FuncCode lyx::LFUN_VC_REPO_UPDATE
2213 * \li Action: Update the local archive directory in which resides
2214 the current document with the remote repository.
2215 * \li Syntax: vc-repo-update
2216 * \li Origin: sanda, 16 Oct 2009
2219 { LFUN_VC_REPO_UPDATE, "vc-repo-update", ReadOnly, System },
2221 * \var lyx::FuncCode lyx::LFUN_VC_COMPARE
2222 * \li Action: Compares two revisions of the same file under version control.
2223 * \li Syntax: vc-compare [<REV1>] [<REV2>]
2224 * \li Params: Revision number either points directly to commit in history
2225 or if negative number -x it points to (last commit - x).\n
2226 In RCS we subtract only in the last number of revision specification.
2227 Special case "0" is reserved for the last committed revision.\n
2228 <REV1>: Older file.\n
2229 <REV2>: Newer file. Used only if REV1 > 0.\n
2230 If no parameter is given, interactive dialog will be shown.
2231 * \li Sample: Compare current document against last commit\n
2233 Compare current document against current revision - 5 commits\n
2235 Compare revisions 120 and 155\n
2237 * \li Origin: sanda, 12 Feb 2010
2240 { LFUN_VC_COMPARE, "vc-compare", ReadOnly, System },
2243 * \var lyx::FuncCode lyx::LFUN_CHANGES_TRACK
2244 * \li Action: Toggles change tracking to on/off.
2245 * \li Syntax: changes-track
2246 * \li Origin: levon, 1 Oct 2002
2249 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
2251 * \var lyx::FuncCode lyx::LFUN_CHANGES_OUTPUT
2252 * \li Action: Toggles showing of change tracking in typesetted output.
2253 * \li Syntax: changes-output
2254 * \li Origin: jspitzm, 21 Jan 2005
2257 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
2259 * \var lyx::FuncCode lyx::LFUN_CHANGE_NEXT
2260 * \li Action: Moves the cursor to the position of the next change
2261 of the change tracking records.
2262 * \li Syntax: change-next
2263 * \li Origin: schmitt, 4 Oct 2006
2266 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
2268 * \var lyx::FuncCode lyx::LFUN_CHANGE_PREVIOUS
2269 * \li Action: Moves the cursor to the position of the previous change
2270 of the change tracking records.
2271 * \li Syntax: change-previous
2272 * \li Origin: vfr, 4 Apr 2009
2275 { LFUN_CHANGE_PREVIOUS, "change-previous", ReadOnly, Edit },
2277 * \var lyx::FuncCode lyx::LFUN_CHANGES_MERGE
2278 * \li Action: Open change tracking dialog for merging and moves the cursor
2279 to the position of the next change.
2280 * \li Syntax: changes-merge
2281 * \li Origin: Levon, 16 Oct 2002
2284 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
2286 * \var lyx::FuncCode lyx::LFUN_CHANGE_ACCEPT
2287 * \li Action: Accepts tracked change inside the selection.
2288 * \li Syntax: change-accept
2289 * \li Origin: Levon, 16 Oct 2002
2292 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
2294 * \var lyx::FuncCode lyx::LFUN_CHANGE_REJECT
2295 * \li Action: Rejects tracked change inside the selection.
2296 * \li Syntax: change-reject
2297 * \li Origin: Levon, 16 Oct 2002
2300 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
2302 * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_ACCEPT
2303 * \li Action: Accepts all tracked changes in the document.
2304 * \li Syntax: all-changes-accept
2305 * \li Origin: Levon, 16 Oct 2002
2308 { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
2310 * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_REJECT
2311 * \li Action: Rejects all tracked changes in the document.
2312 * \li Notion: Reject does not work recursively; the user may have to repeat the operation.
2313 * \li Syntax: all-changes-reject
2314 * \li Origin: Levon, 16 Oct 2002
2317 { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
2320 * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
2321 * \li Action: Apply data for an inset.
2322 * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
2323 be applied. This is either changed to #LFUN_INSET_MODIFY or
2324 #LFUN_INSET_INSERT depending on the context where it is called.
2325 * \li Syntax: inset-apply <ARGS>
2326 * \li Params: See #LFUN_INSET_INSERT .
2329 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
2331 * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE
2332 * \li Action: Dissolve the current inset into text.
2333 * \li Syntax: inset-dissolve [<INSET>]
2334 * \li Params: <INSET>: this can be used to make sure the right kind of inset
2335 is dissolved. For example "dissolve" entry in the charstyles
2336 sub-menu should only dissolve the charstyle inset, even if the
2337 cursor is inside several nested insets of different type.\n
2338 For values see #lyx::InsetLayout::lyxtype_ .
2339 * \li Origin: JSpitz, 7 Aug 2006
2342 { LFUN_INSET_DISSOLVE, "inset-dissolve", AtPoint, Edit },
2344 * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
2345 * \li Action: Insert new inset (type given by the parameters).
2346 * \li Syntax: inset-insert <INSET> <ARGS>
2347 * \li Params: <INSET>: <bibitem|bibtex|citation|ert|listings|external|graphics|tabular|\n
2348 hyperlink|include|index|label|line|nomencl|vspace|ref|toc|script>\n
2349 <ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
2350 * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
2351 where <label name> is the name of the referenced label and
2352 <Format> is one of the following: \n
2353 ref -- <reference> \n
2354 eqref -- (<reference>) \n
2355 pageref -- <page> \n
2356 vpageref -- on <page> \n
2357 vref -- <reference> on <page> \n
2358 formatted -- Formatted reference
2361 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
2363 * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
2364 * \li Action: Modify some properties of an inset.
2365 * \li Notion: Used for bibitem, bibtex, box, branch, command, ert, external,
2366 floats, graphics, include, index, info, label,
2367 listings, newline, newpage, nomencl, note, phantom,
2368 ref, space, tabular, vspace, wrap insets.
2369 * \li Syntax: inset-modify <INSET> <ARGS>
2370 * \li Syntax: inset-modify changetype <TYPE>
2371 * \li Syntax: inset-modify tabular <FEATURE> [<ARG>]
2372 * \li Params: Generally see #LFUN_INSET_INSERT for further details.\n
2373 In case that <INSET> is "tabular" various math-environment features
2374 are handled as well, e.g. add-vline-left/right for the Grid/Array environment.\n
2375 <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|copy-column|
2376 move-column-right|move-column-left|move-row-down|move-row-up|
2377 toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
2378 align-left|align-right|align-center|align-block|align-decimal|set-decimal-point|
2379 valign-top|valign-bottom|valign-middle|longtabular-align-left|
2380 longtabular-align-center|longtabular-align-right|m-align-left|m-align-right|
2381 m-align-center|m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|
2382 set-all-lines|unset-all-lines|set-longtabular|unset-longtabular|set-pwidth|
2383 set-mpwidth|set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|
2384 set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|
2385 unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|
2386 set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
2387 set-special-column|set-special-multicolumn|set-special-multirow|
2388 set-booktabs|unset-booktabs|set-top-space|set-bottom-space|
2389 set-interline-space|set-border-lines|tabular-valign-top|
2390 tabular-valign-middle|tabular-valign-bottom|set-tabular-width \n
2391 <ARG>: additional argument for some commands, use debug mode to explore its values.
2392 * \li Sample: inset-modify note Note Comment \n
2393 inset-modify changetype Ovalbox
2396 { LFUN_INSET_MODIFY, "inset-modify", AtPoint, Edit },
2398 * \var lyx::FuncCode lyx::LFUN_INSET_DIALOG_UPDATE
2399 * \li Action: Updates the values inside the dialog from the inset.
2400 * \li Notion: This is an internal LFUN, not to be used by users. Called internally
2401 by #LFUN_DIALOG_UPDATE
2402 * \li Params: <DIALOG-NAME>
2403 * \li Origin: leeming, 25 Feb 2003
2406 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
2408 * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
2409 * \li Action: Open the inset's properties dialog.
2410 * \li Notion: Used for bibitem, bibtex, box, branch, citation, ert, external,
2411 float, graphics, href, include, index, index_print, label, line,
2412 listings, note, phantom, ref, space, tabular, vspace, wrap insets.
2413 * \li Syntax: inset-settings <INSET>
2414 * \li Params: <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|\n
2415 graphics|href|include|index|index_print|label|line|\n
2416 listings|note|phantom|ref|space|tabular|vspace|wrap>.
2419 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly | AtPoint, Edit },
2421 * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
2422 * \li Action: Toggles the collapsible inset at cursor position,
2423 or the inset we are currently in.
2424 * \li Syntax: inset-toggle [<ARG>]
2425 * \li Params: <ARG>: <open|close|toggle|assign>. \n
2426 open/close/toggle are for collapsible insets. toggle is used when no argument is given.\n
2427 assign synchronize the branch-inset with activation status of the branch.
2428 Used for global toggling when changed activation.
2429 * \li Origin: lasgouttes, 19 Jul 2001
2432 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly | AtPoint, Edit },
2434 * \var lyx::FuncCode lyx::LFUN_INSET_FORALL
2435 * \li Action: Apply the given commands on insets of a given name.
2436 * \li Notion: WARNING: use at your own risks; this function gives
2437 you too many ways of shooting yourself in the foot.
2438 A typical example is
2439 inset-forall Note note-insert
2440 which starts an infinite loop. This is mitigated by the fact
2441 that the number of actions is arbitrarily limited to 100000.
2442 Note also that inset-forall does not update metrics between
2443 iterations, which can lead to bugs. This has to be eventually
2445 * \li Syntax: inset-forall <NAME> <LFUN-COMMAND> \n
2446 <NAME>: Type of Inset. If <NAME> is *, all insets are matched.
2447 The name is used like for InsetLayout in layout files: "Note"
2448 matches all note insets, while "Note:Note" only matches LyX
2450 * \li Sample: Remove all index insets: \n
2451 inset-forall Index char-delete-forward \n
2452 Close all Notes (also works for a particular branch, for example): \n
2453 inset-forall Note inset-toggle close \n
2454 Transform all yellow notes to comments \n
2455 inset-forall Note:Note inset-modify note Note Comment \n
2456 Try to put LyX in an infinite loop if there is at least a Note: \n
2457 inset-forall Note char-backward
2458 * \li Origin: lasgouttes, 27 Nov 2009
2461 { LFUN_INSET_FORALL, "inset-forall", ReadOnly, Edit },
2464 * \var lyx::FuncCode lyx::LFUN_GRAPHICS_RELOAD
2465 * \li Action: Reloads the image if necessary.
2466 * \li Syntax: graphics-reload
2467 * \li Origin: vfr, 10 Aug 2009
2470 { LFUN_GRAPHICS_RELOAD, "graphics-reload", ReadOnly | AtPoint, Edit },
2472 * \var lyx::FuncCode lyx::LFUN_SET_GRAPHICS_GROUP
2473 * \li Action: Set the group for the graphics inset on the cursor position.
2474 * \li Syntax: set-graphics-group [<GROUP>]
2475 * \li Params: <GROUP>: Id for an existing group. In case the Id is an empty string,
2476 the graphics inset is removed from the current group.
2477 * \li Origin: sanda, 6 May 2008
2480 { LFUN_SET_GRAPHICS_GROUP, "set-graphics-group", Noop, Edit },
2483 * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
2484 * \li Action: Moves the cursor out of the current slice, going forward.
2485 * \li Notion: Cursor movement within an inset may be different than cursor
2486 movement in the surrounding text. This action should be called
2487 automatically by the cursor movement within the inset, when
2488 movement within the inset has ceased (reached the end of the
2489 last paragraph, for example), in order to move correctly
2490 back into the surrounding text.
2493 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
2495 * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
2496 * \li Action: Moves the cursor out of the current slice, going backwards.
2497 * \li Notion: See also #LFUN_FINISHED_FORWARD.
2500 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
2502 * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
2503 * \li Action: Moves the cursor out of the current slice, going right.
2504 * \li Notion: See also #LFUN_FINISHED_FORWARD
2507 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
2509 * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
2510 * \li Action: Moves the cursor out of the current slice, going left.
2511 * \li Notion: See also #LFUN_FINISHED_FORWARD.
2514 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
2517 * \var lyx::FuncCode lyx::LFUN_LANGUAGE
2518 * \li Action: Set language from the current cursor position.
2519 * \li Syntax: language <LANG> [set]
2520 * \li Params: <LANG>: Requested language. Look in lib/languages for
2521 the list. "language reset" or "language" (without param)
2522 reset to the document language.
2523 set: If used, the language will be set to the specified
2524 language. Otherwise, the language will be toggled (i.e., if
2525 the current language is LANG, switch to the document language
2526 or the default language, if LANG is the document language).
2527 * \li Origin: Dekel, 2 Mar 2000
2530 { LFUN_LANGUAGE, "language", Noop, Edit },
2533 * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
2534 * \li Action: Goto a label.
2535 * \li Syntax: label-goto [<LABEL>]
2536 * \li Params: <LABEL>: Requested label. If no label is given and reference
2537 is on cursor position, Bookmark 0 is saved and
2538 cursor moves to the position of referenced label.
2539 * \li Origin: Ale, 6 Aug 1997
2542 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
2544 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT
2545 * \li Action: Inserts label to text or displayed formula.
2546 * \li Syntax: label-insert [<LABEL>]
2547 * \li Params: <LABEL>: Requested label. If no label is given dialog requesting
2548 name will be opened.
2551 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
2553 * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
2554 * \li Action: Go to the next label or cross-reference.
2555 * \li Syntax: reference-next
2556 * \li Origin: Dekel, 14 Jan 2001
2559 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
2562 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
2563 * \li Action: Moves the cursor to the numbered bookmark, opening the file
2564 if necessary. Note that bookmarks are saved per-session, not
2566 * \li Notion: Bookmark 0 has a special purpose. It is automatically set \n
2567 1. to the paragraph you are currently editing \n
2568 2. to the paragraph from where you are jumping to the last-edited
2569 position (jump-back feature) \n
2570 3. when jumping from crossreference to the requested label by
2572 * \li Syntax: bookmark-goto <NUMBER>
2573 * \li Params: <NUMBER>: the number of the bookmark to restore.
2574 * \li Origin: Dekel, 27 January 2001
2577 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
2579 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
2580 * \li Action: Save a bookmark.
2581 * \li Notion: Saves a numbered bookmark to the sessions file. The number
2582 must be between 1 and 9, inclusive. Note that bookmarks are
2583 saved per-session, not per file.
2584 * \li Syntax: bookmark-save <NUMBER>
2585 * \li Params: <NUMBER>: the number of the bookmark to save.
2586 * \li Origin: Dekel, 27 January 2001
2589 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
2591 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
2592 * \li Action: Clears the list of saved bookmarks.
2593 * \li Syntax: bookmark-clear
2594 * \li Origin: bpeng, 31 October 2006
2597 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
2600 * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
2601 * \li Action: Open the given help file according to the language setting.
2602 * \li Syntax: help-open <FILE>[.lyx]
2603 * \li Params: <FILE>: any document from (/usr/share/)doc directory.
2604 * \li Origin: Jug, 27 Jun 1999
2607 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
2609 * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
2610 * \li Action: Terminates the current LyX instance.
2611 * \li Notion: Terminates the current LyX instance, asking whether to save
2612 modified documents, etc.
2613 * \li Syntax: lyx-quit
2616 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
2618 * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
2619 * \li Action: Toggles visibility of a given toolbar between on/off/auto.
2620 * \li Notion: Skipping "auto" when allowauto is false.
2621 * \li Syntax: toolbar-toggle <NAME> [allowauto]
2622 * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|\n
2623 minibuffer|review|view/update|math_panels|vcs|
2624 view-others|update-others
2625 * \li Origin: Edwin, 21 May 2007
2628 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
2630 * \var lyx::FuncCode lyx::LFUN_MENU_OPEN
2631 * \li Action: Opens the menu given by its name.
2632 * \li Syntax: menu-open <NAME>
2633 * \li Params: <NAME>: menu name. See various .inc files in lib/ui for candidates.
2636 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
2638 * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
2639 * \li Action: Various UI visibility-toggling actions.
2640 * \li Syntax: ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
2641 * \li Params: statusbar : Toggle visibility of the statusbar.\n
2642 menubar : Toggle visibility of the menubar.\n
2643 scrollbar : Toggle visibility of the scrollbar.\n
2644 frame : Toggle visibility of the frames around editing window.\n
2645 fullscreen : Toggle fullscreen mode. This also covers calling the
2646 previous functions. However #LFUN_TOOLBAR_TOGGLE for the
2647 custom tweaks of the toolbars should be used.
2648 * \li Origin: sanda, 9 Feb 2007
2651 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
2654 * \var lyx::FuncCode lyx::LFUN_WINDOW_NEW
2655 * \li Action: Creates new empty LyX window.
2656 * \li Notion: Already opened documents from the previous window can be found under View menu.
2657 * \li Syntax: window-new [<GEOMETRY>]
2658 * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently
2659 accepted only on Windows platform.
2660 * \li Origin: Abdel, 21 Oct 2006
2663 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
2665 * \var lyx::FuncCode lyx::LFUN_WINDOW_CLOSE
2666 * \li Action: Closes the current LyX window.
2667 * \li Syntax: window-close
2668 * \li Origin: Abdel, 23 Oct 2006
2671 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
2674 * \var lyx::FuncCode lyx::LFUN_VIEW_SPLIT
2675 * \li Action: Creates another split view of current buffer.
2676 * \li Notion: All split views act in the same way independently.
2677 * \li Syntax: view-split <vertical|horizontal>
2678 * \li Params: horizontal : The work areas are laid out side by side.\n
2679 vertical : The work areas laid out vertically.
2680 * \li Origin: Abdel, 20 Feb 2008
2683 { LFUN_VIEW_SPLIT, "view-split", ReadOnly, Buffer },
2686 * \var lyx::FuncCode lyx::LFUN_VIEW_CLOSE
2687 * \li Action: Close the current document work area.
2688 * \li Notion: Close the current work area. If no other work areas are showing the buffer,
2689 then close the associated buffer as well.
2690 * \li Syntax: view-close
2691 * \li Origin: Tommaso, 15 Sep 2012
2694 { LFUN_VIEW_CLOSE, "view-close", ReadOnly, Buffer },
2697 * \var lyx::FuncCode lyx::LFUN_TAB_GROUP_CLOSE
2698 * \li Action: Close the current tab group.
2699 * \li Notion: This only closes the work areas, not the buffers themselves.
2700 The still opened buffers can be visualized in another tab group.
2701 * \li Syntax: tab-group-close
2702 * \li Origin: Abdel, 21 Feb 2008
2705 { LFUN_TAB_GROUP_CLOSE, "tab-group-close", ReadOnly, Buffer },
2708 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW
2709 * \li Action: Shows hidden dialog or creates new one for a given function/inset settings etc.
2710 * \li Syntax: dialog-show <NAME> [<DATA>]
2711 * \li Params: <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|\n
2712 compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|\n
2713 graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimiter|\n
2714 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|\n
2715 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|\n
2716 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL> \n
2717 <SPECIAL>: latexlog|vclog \n
2718 <DATA>: data, usually settings for the given dialog. Use debug mode for the
2720 * \li Origin: leeming, 17 Jun 2003
2723 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
2725 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW_NEW_INSET
2726 * \li Action: Shows hidden dialog or create new one for a given inset settings etc.
2727 * \li Notion: Internally uses #LFUN_DIALOG_SHOW with processed data for a given inset.
2728 * \li Syntax: dialog-show-new-inset <NAME> [<DATA>]
2729 * \li Params: See #LFUN_DIALOG_SHOW .
2730 * \li Origin: leeming, 25 Feb 2003
2733 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
2735 * \var lyx::FuncCode lyx::LFUN_DIALOG_UPDATE
2736 * \li Action: Updates the dialog values from the inset/paragraph/document.
2737 * \li Syntax: dialog-update <NAME>
2738 * \li Params: <NAME>: paragraph|prefs|<INSET> \n
2740 * \li Origin: leeming, 25 Feb 2003
2743 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
2745 * \var lyx::FuncCode lyx::LFUN_DIALOG_HIDE
2746 * \li Action: Hides showed dialog. Counterpart to #LFUN_DIALOG_SHOW .
2747 * \li Syntax: dialog-hide <NAME>
2748 * \li Params: See #LFUN_DIALOG_SHOW .
2749 * \li Origin: leeming, 25 Feb 2003
2752 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
2754 * \var lyx::FuncCode lyx::LFUN_DIALOG_TOGGLE
2755 * \li Action: Toggles dialog between showed/hidden state.
2756 * \li Notion: Internally uses #LFUN_DIALOG_SHOW , #LFUN_DIALOG_HIDE .
2757 * \li Syntax: dialog-toggle <NAME> [<DATA>]
2758 * \li Params: See #LFUN_DIALOG_SHOW .
2759 * \li Origin: JSpitzm, 30 Apr 2007
2762 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
2764 * \var lyx::FuncCode lyx::LFUN_DIALOG_DISCONNECT_INSET
2765 * \li Action: Closes opened connection to opened inset.
2766 * \li Notion: Connection is used for apply functions.
2767 * \li Syntax: dialog-disconnect-inset <INSET-NAME>
2768 * \li Origin: leeming, 25 Feb 2003
2771 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
2774 * \var lyx::FuncCode lyx::LFUN_MOUSE_PRESS
2775 * \li Action: This function is called when mouse button is pressed (inside workarea).
2776 Action depends on the context.
2777 * \li Notion: This is an internal LFUN, not to be used by users.
2778 * \li Origin: Andre, 9 Aug 2002
2781 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
2783 * \var lyx::FuncCode lyx::LFUN_MOUSE_DOUBLE
2784 * \li Action: This function is called when double click on mouse button is
2785 pressed (inside workarea). Action depends on the context.
2786 * \li Notion: This is an internal LFUN, not to be used by users.
2787 * \li Origin: Andre, 9 Aug 2002
2790 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
2792 * \var lyx::FuncCode lyx::LFUN_MOUSE_TRIPLE
2793 * \li Action: This function is called when triple click on mouse button is
2794 pressed (inside workarea). Action depends on the context.
2795 * \li Notion: This is an internal LFUN, not to be used by users.
2796 * \li Origin: Andre, 9 Aug 2002
2799 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
2801 * \var lyx::FuncCode lyx::LFUN_MOUSE_MOTION
2802 * \li Action: This function is called when mouse cursor is moving over the text.
2803 Action depends on the context.
2804 * \li Notion: This is an internal LFUN, not to be used by users.
2805 * \li Origin: Andre, 9 Aug 2002
2808 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
2810 * \var lyx::FuncCode lyx::LFUN_MOUSE_RELEASE
2811 * \li Action: This function is called when mouse button is released (inside workarea).
2812 Action depends on the context.
2813 * \li Notion: This is an internal LFUN, not to be used by users.
2814 * \li Origin: Andre, 9 Aug 2002
2817 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
2820 * \var lyx::FuncCode lyx::LFUN_KEYMAP_OFF
2821 * \li Action: Turn off the loaded keyboard map.
2822 * \li Syntax: keymap-off
2825 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
2827 * \var lyx::FuncCode lyx::LFUN_KEYMAP_PRIMARY
2828 * \li Action: Turn on the primary keyboard map.
2829 * \li Notion: Maps were widely used in past, when X-windows didn't have nowadays
2830 keyboard support. They can be still used to maintain uniform keyboard
2831 layout across the various platforms.\n
2832 The language is to be set in the Preferences dialog.
2833 * \li Syntax: keymap-primary
2836 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
2838 * \var lyx::FuncCode lyx::LFUN_KEYMAP_SECONDARY
2839 * \li Action: Turn on the secondary keyboard map.
2840 * \li Syntax: keymap-secondary
2843 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
2845 * \var lyx::FuncCode lyx::LFUN_KEYMAP_TOGGLE
2846 * \li Action: Toggles keyboard maps (first/second/off).
2847 * \li Syntax: keymap-toggle
2848 * \li Origin: leeming, 30 Mar 2004
2851 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
2854 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_LAYOUT
2855 * \li Action: Returns the current layout (that is environment) name
2856 on the cursor position.
2857 * \li Syntax: server-get-layout
2860 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
2862 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_FILENAME
2863 * \li Action: Returns path and file name of the currently edited document.
2864 * \li Syntax: server-get-filename
2867 { LFUN_SERVER_GET_FILENAME, "server-get-filename", ReadOnly, System },
2869 * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
2870 * \li Action: Sets the cursor position in LyX based on the row number of generated TeX file.
2871 * \li Notion: This can be useful for DVI inverse-search or detection of the problematic
2872 line from LaTeX compilation. Note that before this function can be used
2873 export to LaTeX output must occur (in order to map the row numbers).
2874 * \li Syntax: server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
2875 * \li Params: <FILE>: the path and filename. Environment variables are expanded in the path.
2876 In case this LFUN does not work make sure you are giving correct
2878 If the file is located inside LyX temporary directory it will be
2879 mapped back into the appropriate opened buffer (e.g. for the case
2880 of generated .tex file).\n
2881 .ext: extensions will be automatically replaced by .lyx.\n
2882 <ROW_NUMBER> The row number of the LaTeX file to which to go.
2883 * \li Sample: server-goto-file-row /home/user/example.lyx 41\n
2884 server-goto-file-row /tmp/lyx_tmpdir.XM3088/lyx_tmpbuf0/example.tex 41
2885 * \li Origin: Edmar, 23 Dec 1998
2888 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly | NoBuffer, System },
2890 * \var lyx::FuncCode lyx::LFUN_FORWARD_SEARCH
2891 * \li Action: Sets the cursor position in the previewed (dvi/pdf) file based on the row
2892 number in LyX window.
2893 * \li Notion: The external program used for forward search call can be specified in
2894 LyX Output preferences. See Additional manual for details of these
2896 * \li Syntax: forward-search
2897 * \li Origin: sanda, 14 Apr 2010
2900 { LFUN_FORWARD_SEARCH, "forward-search", ReadOnly, System },
2902 * \var lyx::FuncCode lyx::LFUN_SERVER_NOTIFY
2903 * \li Action: Sends notify message about the last key-sequence to client.
2904 * \li Notion: This can be used to grab last key-sequence used inside the LyX window.
2905 See also Debug extensions section in Additional features manual.
2906 * \li Syntax: server-notify
2909 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
2911 * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
2912 * \li Action: Sets the cursor position based on the editing area coordinates
2913 (similar to clicking on that point with left mouse button).
2914 * \li Syntax: server-set-xy <X> <Y>
2917 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
2919 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
2920 * \li Action: Returns the coordinates of cursor position in the editing area.
2921 * \li Syntax: server-get-xy
2924 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
2927 * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
2928 * \li Action: Generates the code (literate programming).
2929 * \li Notion: Latex file with extension \literate_extension is generated.
2930 Then LyX invokes \build_command (with a default of ``make'') to generate the code and
2931 \build_error_filter to process the compilation error messages. \n
2932 In case you want to process your literate file with a script, or some other program,
2933 just insert in your lyxrc file an entry with:\n
2934 \build_command "my_script my_arguments" \n
2935 The \build_error_filter differs from the \literate_error_filter only in that the
2936 former will identify error messages from your compiler.
2937 * \li Syntax: build-program
2940 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
2943 * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
2944 * \li Action: Saves the current buffer to a temporary file.
2945 * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
2946 is called automatically by LyX, to "autosave" the current buffer.
2947 * \li Syntax: buffer-auto-save
2950 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
2952 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHILD_OPEN
2953 * \li Action: Loads the given child document.
2954 * \li Notion: The current document is treated as a parent.
2955 * \li Syntax: buffer-child-open <FILE>
2956 * \li Params: <FILE>: Filename of the child. The directory of the parent is assumed by default.
2957 * \li Origin: Ale, 28 May 1997
2960 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
2962 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHKTEX
2963 * \li Action: Runs chktex for the current document.
2964 * \li Syntax: buffer-chktex
2965 * \li Origin: Asger, 30 Oct 1997
2968 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
2970 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
2971 * \li Action: Toggles compression of the current document on/off.
2972 * \li Syntax: buffer-toggle-compression
2973 * \li Origin: bpeng, 27 Apr 2006
2976 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
2978 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_OUTPUT_SYNC
2979 * \li Action: Toggles including of resources for forward/reverse search of the given document.
2980 * \li Notion: When toggled on, SyncTeX is invoked for PDF, while srcltx package
2981 is used for DVI. Custom LaTeX macro can be defined in preferences.
2982 * \li Syntax: buffer-toggle-output-sync
2983 * \li Origin: sanda, 25 May 2010
2986 { LFUN_BUFFER_TOGGLE_OUTPUT_SYNC, "buffer-toggle-output-sync", Noop, System },
2988 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
2989 * \li Action: Closes the current buffer.
2990 * \li Notion: Closes the current buffer, asking whether to save it, etc,
2991 if the buffer has been modified.
2992 * \li Syntax: buffer-close
2995 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
2997 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE_ALL
2998 * \li Action: Closes all buffers.
2999 * \li Notion: Closes all buffers, asking whether to save it, etc,
3000 if a buffer has been modified.
3001 * \li Syntax: buffer-close-all
3004 { LFUN_BUFFER_CLOSE_ALL, "buffer-close-all", ReadOnly, Buffer },
3006 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
3007 * \li Action: Exports the current buffer (document) to the given format.
3008 * \li Syntax: buffer-export <FORMAT> [<DEST>]
3009 * \li Params: <FORMAT> is either "custom" or one of the formats which you
3010 can find in Tools->Preferences->File formats->Format.
3011 Usual format you will enter is "pdf2" (pdflatex),
3012 "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
3013 In case of "custom" you will be asked for a format you
3014 want to start from and for the command that you want to
3015 apply to this format. Internally the control is then passed
3016 to #LFUN_BUFFER_EXPORT_CUSTOM.
3017 <DEST> If present, this argument provides the export destination
3018 filename. Its containing folder will also be the destination
3019 folder, where all the needed external files will be copied.
3020 * \li Origin: Lgb, 29 Jul 1997
3023 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
3025 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
3026 * \li Action: Exports the current buffer (document) from the given format using
3027 the given command on it.
3028 * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
3029 * \li Params: <FORMAT> format to start from (LyX will care to produce such
3030 intermediate file).\n
3031 <COMMAND> this command will be launched on the file. Note that you can
3032 use "$$FName" string to qualify the intermediate file.
3033 * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
3034 * \li Origin: leeming, 27 Mar 2004
3037 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
3039 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_AS
3040 * \li Action: Pops up a dialog for exporting the current buffer.
3041 * \li Syntax: buffer-export-as
3042 * \li Origin: tommaso, 6 Oct 2011
3045 { LFUN_BUFFER_EXPORT_AS, "buffer-export-as", ReadOnly, Buffer },
3047 * \var lyx::FuncCode lyx::LFUN_BUFFER_PRINT
3048 * \li Action: Prints the current document.
3049 * \li Notion: Many settings can be given via the preferences dialog.
3050 * \li Syntax: buffer-print <TARGET> <TARGET-NAME> <COMMAND>
3051 * \li Params: <TARGET> is either "printer" or "file".\n
3052 <TARGER-NAME> is either "default" or file name or printer name.\n
3053 <COMMAND> command ensuring the printing job.
3054 * \li Sample: buffer-print file "/trash/newfile1.ps" "dvips"
3055 * \li Origin: leeming, 28 Mar 2004
3058 { LFUN_BUFFER_PRINT, "buffer-print", ReadOnly, Buffer },
3060 * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
3061 * \li Action: Import a given file as a lyx document.
3062 * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
3063 defined converters in preferences. Look in the File->Import menu to get
3064 an idea of the currently active import formats.
3065 * \li Syntax: buffer-import <FORMAT> [<FILE>]
3066 * \li Origin: Asger, 24 Jul 1998
3069 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
3071 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
3072 * \li Action: Creates a new buffer (that is, document) and switches to it.
3073 * \li Notion: Implicit path can be set in Preferences dialog.
3074 * \li Syntax: buffer-new [<FILE>]
3075 * \li Params: <FILE>: filename of created file with absolute path.
3078 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
3080 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
3081 * \li Action: Creates a new buffer (that is, document) from a template.
3082 * \li Notion: Path for new files and templates can be set in Preferences dialog.
3083 Template will be asked for via Open-dialog.
3084 * \li Syntax: buffer-new-template [<FILE>]
3085 * \li Params: <FILE>: filename of created file with absolute path.
3088 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
3090 * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
3091 * \li Action: Reverts opened document.
3092 * \li Syntax: buffer-reload
3093 * \li Origin: Asger, 2 Feb 1997
3096 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
3098 * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
3099 * \li Action: Display and switch to the given buffer.
3100 * \li Syntax: buffer-switch <BUFFER>
3101 * \li Params: <BUFFER>: path and filename of already opened (but possibly hidden)
3102 document which is to be shown.
3105 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
3107 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
3108 * \li Action: Toggle editing mode of the current document between read/write and read-only.
3109 * \li Notion: This function is not allowed if the file is under version control, since
3110 read-only flag is often used in version control file locking.
3111 * \li Syntax: buffer-toggle-read-only
3112 * \li Origin: Lgb, 27 May 1997
3115 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
3117 * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
3118 * \li Action: Displays current buffer in chosen format.
3119 * \li Notion: Displays the contents of the current buffer in the chosen
3120 format, for example, PDF or DVI. This runs the necessary
3121 converter, calls the defined viewer, and so forth.
3122 * \li Syntax: buffer-view [<FORMAT>]
3123 * \li Params: <FORMAT>: The format to display, where this is one of the
3124 formats defined (in the current GUI) in the
3125 Tools>Preferences>File Formats dialog.
3126 If no format is given, the default format as
3127 specified in the same dialog is used.
3130 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
3132 * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
3133 * \li Action: Exports the current document and put the result into the
3134 temporary directory.
3135 * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
3136 the output will be rewritten - updated. This is useful in case your viewer
3137 is able to detect such changes (e.g. ghostview for postscript).
3138 * \li Syntax: buffer-update [<FORMAT>]
3139 * \li Params: <FORMAT>: The format to display, where this is one of the
3140 formats defined (in the current GUI) in the
3141 Tools>Preferences>File Formats dialog.
3142 If no format is given, the default format as
3143 specified in the same dialog is used.
3144 * \li Origin: Dekel, 5 Aug 2000
3147 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
3150 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
3151 * \li Action: Saves the current buffer.
3152 * \li Notion: Saves the current buffer to disk, using the filename that
3153 is already associated with the buffer, asking for one if
3154 none is yet assigned.
3155 * \li Syntax: buffer-write
3158 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
3160 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
3161 * \li Action: Rename and save current buffer.
3162 * \li Syntax: buffer-write-as <FILENAME>
3163 * \li Params: <FILENAME>: New name of the buffer/file. A relative path
3164 is with respect to the original location of the buffer/file.
3167 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
3169 * \var lyx::FuncCode lyx::LFUN_BUFFER_FORALL
3170 * \li Action: Applies a command to all non-hidden buffers.
3171 * \li Notion: a buffer is `hidden' if it is internally open in LyX, but not
3172 visible in any window.
3173 * \li Syntax: buffer-forall <LFUN-COMMAND>
3174 * \li Params: <LFUN-COMMAND>: The command to be applied to the buffers.
3175 * \li Sample: Close all Notes in buffers: \n
3176 buffer-forall inset-forall Note inset-toggle close \n
3177 Toggle change tracking on buffers: \n
3178 buffer-forall changes-track \n
3179 Toggle read-only for buffers: \n
3180 buffer-forall buffer-toggle-read-only \n
3181 Show statistics for individual buffers: \n
3182 buffer-forall statistics \n
3183 Activate the branch named "Solutions" in buffers: \n
3184 buffer-forall branch-activate Solutions \n
3185 Export buffers to PDF (pdflatex): \n
3186 buffer-forall buffer-export pdf2 \n
3187 * \li Origin: scottkostyshak, 20 Jul 2012
3190 { LFUN_BUFFER_FORALL, "buffer-forall", ReadOnly | Argument, Buffer },
3192 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
3193 * \li Action: Save all changed documents.
3194 * \li Syntax: buffer-write-all
3195 * \li Origin: rgh, gpothier 6 Aug 2007
3198 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
3200 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEXT
3201 * \li Action: Switch to the next opened document.
3202 * \li Notion: Note that this does not necessarily mean next in tabbar
3203 (for full list see View menu).
3204 * \li Syntax: buffer-next
3207 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
3209 * \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS
3210 * \li Action: Switch to the previous opened document.
3211 * \li Syntax: buffer-previous
3214 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
3216 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
3217 * \li Action: When run from a child document, this updates (exports) document built
3218 from the master buffer, if available.
3219 * \li Syntax: master-buffer-update [<FORMAT>]
3220 * \li Params: <FORMAT>: The format to display, where this is one of the
3221 formats defined (in the current GUI) in the
3222 Tools>Preferences>File Formats dialog.
3223 If no format is given, the default format as
3224 specified in the same dialog is used.
3225 * \li Origin: Tommaso, 20 Sep 2007
3228 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
3230 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
3231 * \li Action: When run from a child document, this command shows a preview built
3232 from the master buffer, if available.
3233 * \li Syntax: master-buffer-view [<FORMAT>]
3234 * \li Params: <FORMAT>: The format to display, where this is one of the
3235 formats defined (in the current GUI) in the
3236 Tools>Preferences>File Formats dialog.
3237 If no format is given, the default format as
3238 specified in the same dialog is used.
3239 * \li Origin: Tommaso, 20 Sep 2007
3242 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
3244 * \var lyx::FuncCode lyx::LFUN_BUFFER_LANGUAGE
3245 * \li Action: Set language of the current document.
3246 * \li Syntax: buffer-language <LANG>
3247 * \li Params: <LANG>: language name. See lib/languages for list.
3248 * \li Origin: leeming, 30 Mar 2004
3251 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
3253 * \var lyx::FuncCode lyx::LFUN_BUFFER_SAVE_AS_DEFAULT
3254 * \li Action: Save the current document settings as default.
3255 * \li Notion: The file will will be saved into ~/.lyx/templates/defaults.lyx .
3256 * \li Syntax: buffer-save-as-default [<ARGS>]
3257 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
3258 you can find in document header of usual .lyx file.
3259 * \li Origin: leeming, 30 Mar 2004
3262 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
3264 * \var lyx::FuncCode lyx::LFUN_BUFFER_PARAMS_APPLY
3265 * \li Action: Apply the given settings to the current document.
3266 * \li Syntax: buffer-params-apply [<ARGS>]
3267 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
3268 you can find in document header of usual .lyx file.
3269 * \li Origin: leeming, 30 Mar 2004
3272 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", NoInternal, Buffer },
3275 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
3276 * \li Action: Inserts another LyX file.
3277 * \li Syntax: file-insert [<FILE>]
3278 * \li Params: <FILE>: Filename to be inserted.
3281 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
3283 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
3284 * \li Action: Inserts plain text file.
3285 * \li Syntax: file-insert-plaintext [<FILE>]
3286 * \li Params: <FILE>: Filename to be inserted.
3287 * \li Origin: CFO-G, 19 Nov 1997
3290 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
3292 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
3293 * \li Action: Inserts plain text file as paragraph (i.e. join lines).
3294 * \li Syntax: file-insert-plaintext-para [<FILE>]
3295 * \li Params: <FILE>: Filename to be inserted.
3296 * \li Origin: Levon, 14 Feb 2001
3299 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
3301 * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
3302 * \li Action: Open LyX document.
3303 * \li Syntax: file-open [<FILE>]
3304 * \li Params: <FILE>: Filename to be opened.
3307 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
3310 * \var lyx::FuncCode lyx::LFUN_CALL
3311 * \li Action: Executes a command defined in a .def file.
3312 * \li Notion: The definitions are by default read from lib/commands/default.def.\n
3313 A .def file allows to define a command with \define "<NAME>" "<LFUN>"
3314 where <NAME> is the name of the new command and <LFUN> is the lfun code
3315 to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
3316 \def_file "FileName" allows to include another .def file. \n
3317 This is particularly useful in connection with toolbar buttons:
3318 Since the name of the button image for this lfun is
3319 lib/images/commands/<NAME>.png this is the way to assign an image
3320 to a complex command-sequence.
3321 * \li Syntax: call <NAME>
3322 * \li Params: <NAME>: Name of the command that must be called.
3323 * \li Origin: broider, 2 Oct 2007
3326 { LFUN_CALL, "call", NoBuffer, System },
3328 * \var lyx::FuncCode lyx::LFUN_META_PREFIX
3329 * \li Action: Simulate halting Meta key (Alt key on PCs).
3330 * \li Notion: Used for buffer editation not for GUI control.
3331 * \li Syntax: meta-prefix
3334 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
3336 * \var lyx::FuncCode lyx::LFUN_CANCEL
3337 * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
3338 * \li Syntax: cancel
3341 { LFUN_CANCEL, "cancel", NoBuffer, System },
3344 * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
3345 * \li Action: Switches the focus to the minibuffer so that the user can type
3346 in there. If necessary, it opens the minibuffer toolbar.
3347 * \li Notion: Usually bound to M-x shortcut.
3348 * \li Syntax: command-execute
3351 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
3354 * \var lyx::FuncCode lyx::LFUN_COMMAND_PREFIX
3355 * \li Action: Return the current key sequence and available options as a string.
3356 * \li Notion: No options are added if no current map exists. \n
3357 This is probably usable only with connection to lyxserver.
3358 * \li Syntax: command-prefix
3361 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
3363 * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
3364 * \li Action: Run more commands (LFUN and its parameters) in a sequence.
3365 * \li Syntax: command-sequence <CMDS>
3366 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
3367 * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
3368 * \li Origin: Andre, 11 Nov 1999
3371 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
3373 * \var lyx::FuncCode lyx::LFUN_COMMAND_ALTERNATIVES
3374 * \li Action: Runs the first listed command that is enabled.
3375 * \li Notion: This can be used to bind multiple functions to a single key,
3376 and then which one is used will depend upon the context.
3377 * \li Syntax: command-alternatives <CMDS>
3378 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
3379 * \li Sample: command-alternatives completion-accept;cell-forward
3380 * \li Origin: rgh, 24 September 2008
3383 { LFUN_COMMAND_ALTERNATIVES, "command-alternatives", NoBuffer, System },
3385 * \var lyx::FuncCode lyx::LFUN_MESSAGE
3386 * \li Action: Shows message in statusbar (for script purposes).
3387 * \li Syntax: message <STRING>
3388 * \li Origin: Lgb, 8 Apr 2001
3391 { LFUN_MESSAGE, "message", NoBuffer, System },
3393 * \var lyx::FuncCode lyx::LFUN_DEBUG_LEVEL_SET
3394 * \li Action: Set debug output level.
3395 * \li Syntax: debug-level-set <LEVEL>
3396 * \li Params: <LEVEL>: comma separated list of levels or the correspondent number
3397 of their combination. 0 is equivalent to disabling all debug
3398 events. See lyx -dbg for the current list of debug levels
3400 * \li Origin: sanda, 28 Dec 2009
3403 { LFUN_DEBUG_LEVEL_SET, "debug-level-set", NoBuffer, System },
3406 * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
3407 * \li Action: Save user preferences.
3408 * \li Syntax: preferences-save
3409 * \li Origin: Lgb, 27 Nov 1999
3412 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
3414 * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
3415 * \li Action: Reconfigure the automatic settings.
3416 * \li Syntax: reconfigure
3417 * \li Origin: Asger, 14 Feb 1997
3420 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
3422 * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
3423 * \li Action: Apply the given settings to user preferences.
3424 * \li Syntax: lyxrc-apply <SETTINGS>
3425 * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
3426 to get an idea which commands to use and their syntax.
3427 #lyx::LyXRC::LyXRCTags has the list of possible commands.
3430 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
3432 * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
3433 * \li Action: Determine whether to keep cursor inside the editing window regardless
3434 of the scrollbar movement.
3435 * \li Syntax: toggle-cursor-follows-scrollbar
3436 * \li Origin: ARRae, 2 Dec 1997
3439 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
3441 * \var lyx::FuncCode lyx::LFUN_SET_COLOR
3442 * \li Action: Set the given LyX color to the color defined by the X11 name given.
3443 * \li Notion: A new color entry is created if the color is unknown.
3444 Color names can be stored as a part of user settings.
3445 * \li Syntax: set-color <LYX_NAME> <X11_NAME>
3446 * \li Origin: SLior, 11 Jun 2000
3449 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
3451 * \var lyx::FuncCode lyx::LFUN_STATISTICS
3452 * \li Action: Count the statistics (number of words and characters)
3453 in the document or in the given selection.
3454 * \li Notion: Note that this function gives the number of words/chars written,
3455 not the number of characters which will be typeset.
3456 * \li Syntax: statistics
3457 * \li Origin: lasgouttes, Jan 27 2004; sanda, Jan 8 2008
3460 { LFUN_STATISTICS, "statistics", ReadOnly, System },
3462 * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
3463 * \li Action: Show the inline completion at the cursor position.
3464 * \li Syntax: completion-inline
3465 * \li Origin: sts, Feb 19 2008
3468 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
3470 * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
3471 * \li Action: Show the completion popup at the cursor position.
3472 * \li Syntax: completion-popup
3473 * \li Origin: sts, Feb 19 2008
3476 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
3478 * \var lyx::FuncCode lyx::LFUN_COMPLETION_COMPLETE
3479 * \li Action: Try to complete the word or command at the cursor position.
3480 * \li Syntax: complete
3481 * \li Origin: sts, Feb 19 2008
3484 { LFUN_COMPLETION_COMPLETE, "complete", SingleParUpdate, Edit },
3487 * \var lyx::FuncCode lyx::LFUN_COMPLETION_CANCEL
3488 * \li Action: Try to cancel completion, either the popup or the inline completion.
3489 * \li Syntax: completion-cancel
3490 * \li Origin: sts, Sep 07 2008
3493 { LFUN_COMPLETION_CANCEL, "completion-cancel", SingleParUpdate, Edit },
3495 * \var lyx::FuncCode lyx::LFUN_COMPLETION_ACCEPT
3496 * \li Action: Accept suggested completion.
3497 * \li Syntax: completion-accept
3498 * \li Origin: sanda, Sep 08 2008
3501 { LFUN_COMPLETION_ACCEPT, "completion-accept", SingleParUpdate, Edit },
3505 * \var lyx::FuncCode lyx::LFUN_BRANCH_ADD
3506 * \li Action: Add a branch to the buffer's BranchList.
3507 * \li Syntax: branch-add <BRANCH>
3508 * \li Params: <BRANCH>: Name of the branch to add
3509 * \li Origin: spitz, 7 Jul 2009
3512 { LFUN_BRANCH_ADD, "branch-add", AtPoint, Buffer },
3516 * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
3517 * \li Action: Activate the branch.
3518 * \li Syntax: branch-activate <BRANCH>
3519 * \li Params: <BRANCH>: The branch to activate
3520 * \li Sample: lyx -x "branch-activate answers" -e pdf2 finalexam.lyx \n
3521 could be used to export a pdf with the answers branch included
3522 without one's having to open LyX and activate the branch manually.
3523 * \li Origin: rgh, 27 May 2008
3526 { LFUN_BRANCH_ACTIVATE, "branch-activate", AtPoint, Buffer },
3528 * \var lyx::FuncCode lyx::LFUN_BRANCH_DEACTIVATE
3529 * \li Action: De-activate the branch.
3530 * \li Syntax: branch-deactivate <BRANCH>
3531 * \li Params: <BRANCH>: The branch to deactivate
3532 * \li Origin: rgh, 27 May 2008
3535 { LFUN_BRANCH_DEACTIVATE, "branch-deactivate", AtPoint, Buffer },
3537 * \var lyx::FuncCode lyx::LFUN_BRANCH_MASTER_ACTIVATE
3538 * \li Action: Activate the branch in the master buffer.
3539 * \li Syntax: branch-master-activate <BRANCH>
3540 * \li Params: <BRANCH>: The branch to activate
3541 * \li Sample: lyx -x "branch-activate answers" -e pdf2 finalexam.lyx \n
3542 could be used to export a pdf with the answers branch included
3543 without one's having to open LyX and activate the branch manually.
3544 * \li Origin: spitz, 30 Sep 2012
3547 { LFUN_BRANCH_MASTER_ACTIVATE, "branch-master-activate", AtPoint, Buffer },
3549 * \var lyx::FuncCode lyx::LFUN_BRANCH_MASTER_DEACTIVATE
3550 * \li Action: De-activate the branch in the master buffer.
3551 * \li Syntax: branch-master-deactivate <BRANCH>
3552 * \li Params: <BRANCH>: The branch to deactivate
3553 * \li Origin: spitz, 30 Sep 2012
3556 { LFUN_BRANCH_MASTER_DEACTIVATE, "branch-master-deactivate", AtPoint, Buffer },
3559 * \var lyx::FuncCode lyx::LFUN_BRANCHES_RENAME
3560 * \li Action: Rename all branches of a given name in a document.
3561 * \li Syntax: branches-rename <OLDNAME> <NEWNAME>
3562 * \li Params: <OLDNAME>: Current name of the branch to be renamed
3563 * <NEWNAME>: New name of the branch
3564 * \li Origin: spitz, 9 Jul 2009
3567 { LFUN_BRANCHES_RENAME, "branches-rename", Noop, Buffer },
3569 * \var lyx::FuncCode lyx::LFUN_BRANCH_ADD_INSERT
3570 * \li Action: Create new branch and directly put the branch inset into
3572 * \li Syntax: branch-add-insert [<NAME>]
3573 * \li Params: <NAME>: Branch name. If it is not specified, you will be asked.
3574 * \li Origin: sanda, 10 Jul 2009
3577 { LFUN_BRANCH_ADD_INSERT, "branch-add-insert", Noop, Buffer },
3581 * \var lyx::FuncCode lyx::LFUN_LABEL_COPY_AS_REF
3582 * \li Action: Copies the label at the cursor as a cross-reference to be pasted elsewhere.
3583 * \li Syntax: copy-label-as-reference <LABEL>
3584 * \li Params: <LABEL>: The label to copy (for multi-line math)
3585 * \li Origin: sts, 16 Nov 2008
3588 { LFUN_LABEL_COPY_AS_REF, "copy-label-as-reference",
3589 ReadOnly | NoUpdate | AtPoint, Edit },
3592 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT_AS_REF
3593 * \li Action: Inserts the label (in ToC pane) as a cross-reference at the position of the cursor.
3594 * \li Syntax: label-insert-as-reference
3595 * \li Origin: vfr, 7 Apr 2009
3598 { LFUN_LABEL_INSERT_AS_REF, "label-insert-as-reference", Noop, Edit},
3601 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_IN
3602 * \li Action: Increases the zoom of the screen fonts.
3603 * \li Syntax: buffer-zoom-in [<ZOOM>]
3604 * \li Params: <ZOOM>: The zoom in %, the default is 20.
3605 * \li Origin: vfr, 30 Mar 2009
3608 { LFUN_BUFFER_ZOOM_IN, "buffer-zoom-in", ReadOnly, Buffer },
3611 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_OUT
3612 * \li Action: Decreases the zoom of the screen fonts.
3613 * \li Syntax: buffer-zoom-out [<ZOOM>]
3614 * \li Params: <ZOOM>: The zoom in %, the default is 20.
3615 * \li Origin: vfr, 30 Mar 2009
3618 { LFUN_BUFFER_ZOOM_OUT, "buffer-zoom-out", ReadOnly, Buffer },
3621 * \var lyx::FuncCode lyx::LFUN_INSET_COPY_AS
3622 * \li Action: Copies the inset to the clipboard as a certain type.
3623 * \li Notion: Currently used only for InsetInfo where its content is copied as a text.
3624 * \li Syntax: inset-copy-as
3625 * \li Origin: vfr, 18 Apr 2010
3628 { LFUN_INSET_COPY_AS, "inset-copy-as", ReadOnly | NoUpdate | AtPoint, Edit },
3631 * \var lyx::FuncCode lyx::LFUN_ENVIRONMENT_SPLIT
3632 * \li Action: Splits the current environment with a Separator.
3633 * \li Syntax: environment-split
3634 * \li Origin: spitz, 23 Dec 2012
3637 { LFUN_ENVIRONMENT_SPLIT, "environment-split", Noop, Layout },
3639 { LFUN_NOACTION, "", Noop, Hidden }
3640 #ifndef DOXYGEN_SHOULD_SKIP_THIS
3643 for (int i = 0; items[i].action != LFUN_NOACTION; ++i)
3644 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
3650 LyXAction::LyXAction()
3656 FuncRequest LyXAction::lookupFunc(string const & func) const
3658 string const func2 = trim(func);
3661 return FuncRequest(LFUN_NOACTION);
3664 string const arg = split(func2, cmd, ' ');
3666 FuncMap::const_iterator const fit = lyx_func_map.find(cmd);
3668 return fit != lyx_func_map.end()
3669 ? FuncRequest(fit->second, arg)
3670 : FuncRequest(LFUN_UNKNOWN_ACTION);
3674 string const LyXAction::getActionName(FuncCode action) const
3676 InfoMap::const_iterator const it = lyx_info_map.find(action);
3677 return it != lyx_info_map.end() ? it->second.name : string();
3681 LyXAction::FuncType LyXAction::getActionType(FuncCode action) const
3683 InfoMap::const_iterator const it = lyx_info_map.find(action);
3684 return it != lyx_info_map.end() ? it->second.type : Hidden;
3688 bool LyXAction::funcHasFlag(FuncCode action,
3689 LyXAction::FuncAttribs flag) const
3691 InfoMap::const_iterator ici = lyx_info_map.find(action);
3693 if (ici == lyx_info_map.end()) {
3694 LYXERR0("action: " << action << " is not known.");
3695 LASSERT(false, /**/);
3698 return ici->second.attrib & flag;
3702 LyXAction::const_iterator LyXAction::func_begin() const
3704 return lyx_func_map.begin();
3708 LyXAction::const_iterator LyXAction::func_end() const
3710 return lyx_func_map.end();
3714 LyXErr & operator<<(LyXErr & l, FuncCode code)
3717 l.stream() << lyxaction.getActionName(code);