3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Lars Gullik Bjønnes
7 * \author Jean-Marc Lasgouttes
12 * Full author contact details are available in file CREDITS.
17 #include "LyXAction.h"
19 #include "FuncRequest.h"
21 #include "support/debug.h"
22 #include "support/lstrings.h"
24 #include "support/lassert.h"
29 using namespace lyx::support;
34 NAMING RULES FOR USER-COMMANDS
35 Here's the set of rules to apply when a new command name is introduced:
37 1) Use the object.event order. That is, use `word-forward'
38 instead of `forward-word'.
39 2) Don't introduce an alias for an already named object. Same for events.
40 3) Forward movement or focus is called `forward' (not `right').
41 4) Backward movement or focus is called `backward' (not `left').
42 5) Upward movement of focus is called `up'.
43 6) Downward movement is called `down'.
44 7) The begin of an object is called `begin' (not `start').
45 8) The end of an object is called `end'.
47 (May 19 1996, 12:04, RvdK)
52 * The documentation below is primarily description of purpose and syntax
53 * relating to the different LFUNs.
55 * Try to find an appropriate (thematical) place when adding the new LFUN
56 * and don't forget to add doxygen commentary.
58 * Doxygen template below. Some notes: Parameters should be set in uppercase
59 * and put in <BRACKETS>, [<PARAM>] means optional one.
61 * Use spaces for indentation (doxy -> .lyx generator is tab-sensitive).
65 * \var lyx::FuncCode lyx::LFUN_
78 void LyXAction::newFunc(FuncCode action, string const & name,
79 unsigned int attrib, LyXAction::FuncType type)
81 lyx_func_map[name] = action;
84 tmpinfo.attrib = attrib;
86 lyx_info_map[action] = tmpinfo;
90 // Needed for LFUNs documentation to be accepted, since doxygen won't take
91 // \var inside functions.
92 #ifndef DOXYGEN_SHOULD_SKIP_THIS
93 void LyXAction::init()
95 // This function was changed to use the array below in initalization
96 // instead of calling newFunc numerous times because of compilation
97 // times. Since the array is not static we get back the memory it
98 // occupies after the init is completed. It compiles several
112 ev_item const items[] = {
115 * \var lyx::FuncCode lyx::LFUN_ACCENT_ACUTE
116 * \li Action: Adds an acute accent \htmlonly (á)\endhtmlonly
117 to the next character typed.
118 * \li Syntax: accent-acute
121 { LFUN_ACCENT_ACUTE, "accent-acute", Noop, Edit },
123 * \var lyx::FuncCode lyx::LFUN_ACCENT_BREVE
124 * \li Action: Adds a breve accent \htmlonly (ă)\endhtmlonly
125 to the next character typed.
126 * \li Syntax: accent-breve
129 { LFUN_ACCENT_BREVE, "accent-breve", Noop, Edit },
131 * \var lyx::FuncCode lyx::LFUN_ACCENT_CARON
132 * \li Action: Adds a caron \htmlonly (ǎ)\endhtmlonly
133 to the next character typed.
134 * \li Syntax: accent-caron
137 { LFUN_ACCENT_CARON, "accent-caron", Noop, Edit },
139 * \var lyx::FuncCode lyx::LFUN_ACCENT_CEDILLA
140 * \li Action: Adds a cedilla \htmlonly (ç)\endhtmlonly
141 to the next character typed.
142 * \li Syntax: accent-cedilla
145 { LFUN_ACCENT_CEDILLA, "accent-cedilla", Noop, Edit },
147 * \var lyx::FuncCode lyx::LFUN_ACCENT_CIRCLE
148 * \li Action: Adds a circle accent \htmlonly (å)\endhtmlonly
149 to the next character typed.
150 * \li Syntax: accent-circle
153 { LFUN_ACCENT_CIRCLE, "accent-circle", Noop, Edit },
155 * \var lyx::FuncCode lyx::LFUN_ACCENT_CIRCUMFLEX
156 * \li Action: Adds a circumflex \htmlonly (ê)\endhtmlonly
157 to the next character typed.
158 * \li Syntax: accent-circumflex
161 { LFUN_ACCENT_CIRCUMFLEX, "accent-circumflex", Noop, Edit },
163 * \var lyx::FuncCode lyx::LFUN_ACCENT_DOT
164 * \li Action: Adds a dot accent \htmlonly (ż)\endhtmlonly
165 to the next character typed.
166 * \li Syntax: accent-dot
169 { LFUN_ACCENT_DOT, "accent-dot", Noop, Edit },
171 * \var lyx::FuncCode lyx::LFUN_ACCENT_GRAVE
172 * \li Action: Adds a grave accent \htmlonly (è)\endhtmlonly
173 to the next character typed.
174 * \li Syntax: accent-grave
177 { LFUN_ACCENT_GRAVE, "accent-grave", Noop, Edit },
179 * \var lyx::FuncCode lyx::LFUN_ACCENT_HUNGARIAN_UMLAUT
180 * \li Action: Adds a Hungarian umlaut \htmlonly (ő)\endhtmlonly
181 to the next character typed.
182 * \li Syntax: accent-grave
185 { LFUN_ACCENT_HUNGARIAN_UMLAUT, "accent-hungarian-umlaut", Noop, Edit },
187 * \var lyx::FuncCode lyx::LFUN_ACCENT_MACRON
188 * \li Action: Adds a macron \htmlonly (ā)\endhtmlonly
189 to the next character typed.
190 * \li Syntax: accent-macron
193 { LFUN_ACCENT_MACRON, "accent-macron", Noop, Edit },
195 * \var lyx::FuncCode lyx::LFUN_ACCENT_OGONEK
196 * \li Action: Adds an ogonek accent \htmlonly (ą)\endhtmlonly
197 to the next character typed.
198 * \li Syntax: accent-ogonek
201 { LFUN_ACCENT_OGONEK, "accent-ogonek", Noop, Edit },
203 * \var lyx::FuncCode lyx::LFUN_ACCENT_TIE
204 * \li Action: Adds a tie \htmlonly (a͡)\endhtmlonly
205 over the next two character typed.
206 * \li Notion: The following char will finish the tie.
207 * \li Syntax: accent-tie
210 { LFUN_ACCENT_TIE, "accent-tie", Noop, Edit },
212 * \var lyx::FuncCode lyx::LFUN_ACCENT_TILDE
213 * \li Action: Adds a tilde \htmlonly (ã)\endhtmlonly
214 over the next character typed.
215 * \li Syntax: accent-tilde
218 { LFUN_ACCENT_TILDE, "accent-tilde", Noop, Edit },
220 * \var lyx::FuncCode lyx::LFUN_ACCENT_UMLAUT
221 * \li Action: Adds an umlaut \htmlonly (ä)\endhtmlonly
222 over the next character typed.
223 * \li Syntax: accent-umlaut
226 { LFUN_ACCENT_UMLAUT, "accent-umlaut", Noop, Edit },
228 * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERBAR
229 * \li Action: Adds a bar \htmlonly (a̠)\endhtmlonly
230 under the next character typed.
231 * \li Syntax: accent-underbar
234 { LFUN_ACCENT_UNDERBAR, "accent-underbar", Noop, Edit },
236 * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERDOT
237 * \li Action: Adds a dot \htmlonly (ạ)\endhtmlonly
238 under the next character typed.
239 * \li Syntax: accent-underdot
242 { LFUN_ACCENT_UNDERDOT, "accent-underdot", Noop, Edit },
245 * \var lyx::FuncCode lyx::LFUN_CAPTION_INSERT
246 * \li Action: Inserts a caption inset.
247 * \li Syntax: caption-insert
248 * \li Origin: Lgb, 18 Jul 2000
251 { LFUN_CAPTION_INSERT, "caption-insert", Noop, Edit },
253 * \var lyx::FuncCode lyx::LFUN_DATE_INSERT
254 * \li Action: Inserts the current date.
255 * \li Syntax: date-insert [<ARG>]
256 * \li Params: <ARG>: Format of date. The default value (%x) can be set
257 in Preferences->Date format. For possible formats
258 see manual page of strftime function.
259 * \li Origin: jdblair, 31 Jan 2000
262 { LFUN_DATE_INSERT, "date-insert", Noop, Edit },
264 * \var lyx::FuncCode lyx::LFUN_FOOTNOTE_INSERT
265 * \li Action: Inserts a footnote inset.
266 * \li Syntax: footnote-insert
267 * \li Origin: Jug, 7 Mar 2000
270 { LFUN_FOOTNOTE_INSERT, "footnote-insert", Noop, Edit },
272 * \var lyx::FuncCode lyx::LFUN_ERT_INSERT
273 * \li Action: Inserts an ERT inset.
274 * \li Syntax: ert-insert
275 * \li Origin: Jug, 18 Feb 2000
278 { LFUN_ERT_INSERT, "ert-insert", Noop, Edit },
280 * \var lyx::FuncCode lyx::LFUN_FLOAT_INSERT
281 * \li Action: Inserts a float inset.
282 * \li Syntax: float-insert <TYPE>
283 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
284 "algorithm", "table", "figure" parameters can be given.
285 * \li Origin: Lgb, 27 Jun 2000
288 { LFUN_FLOAT_INSERT, "float-insert", Noop, Edit },
290 * \var lyx::FuncCode lyx::LFUN_FLOAT_WIDE_INSERT
291 * \li Action: Inserts float insets as in #LFUN_FLOAT_INSERT but span multiple columns.
292 * \li Notion: Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
293 * \li Syntax: float-wide-insert <TYPE>
294 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
295 "algorithm", "table", "figure" parameters can be given.
296 * \li Origin: Lgb, 31 Oct 2001
299 { LFUN_FLOAT_WIDE_INSERT, "float-wide-insert", Noop, Edit },
301 * \var lyx::FuncCode lyx::LFUN_FLOAT_LIST_INSERT
302 * \li Action: Inserts the list of floats in the document.
303 * \li Syntax: float-list-insert <TYPE>
304 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
305 "algorithm", "table", "figure" parameters can be given.
306 * \li Origin: Lgb, 3 May 2001
309 { LFUN_FLOAT_LIST_INSERT, "float-list-insert", Noop, Edit },
311 * \var lyx::FuncCode lyx::LFUN_WRAP_INSERT
312 * \li Action: Inserts floats wrapped by the text around.
313 * \li Syntax: wrap-insert <TYPE>
314 * \li Params: <TYPE>: table|figure
315 * \li Origin: Dekel, 7 Apr 2002
318 { LFUN_WRAP_INSERT, "wrap-insert", Noop, Edit },
320 * \var lyx::FuncCode lyx::LFUN_ARGUMENT_INSERT
321 * \li Action: Inserts an argument (short title) inset.
322 * \li Syntax: argument-insert
323 * \li Origin: vermeer, 12 Aug 2002
326 { LFUN_ARGUMENT_INSERT, "argument-insert", Noop, Edit },
328 * \var lyx::FuncCode lyx::LFUN_NEWPAGE_INSERT
329 * \li Action: Inserts a new page.
330 * \li Syntax: newpage-insert <ARG>
331 * \li Params: <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
332 * \li Origin: uwestoehr, 24 Nov 2007
335 { LFUN_NEWPAGE_INSERT, "newpage-insert", Noop, Edit },
337 * \var lyx::FuncCode lyx::LFUN_MARGINALNOTE_INSERT
338 * \li Action: Inserts a marginal note.
339 * \li Syntax: marginalnote-insert
340 * \li Origin: Lgb, 26 Jun 2000
343 { LFUN_MARGINALNOTE_INSERT, "marginalnote-insert", Noop, Edit },
345 * \var lyx::FuncCode lyx::LFUN_UNICODE_INSERT
346 * \li Action: Inserts a single unicode character.
347 * \li Syntax: unicode-insert <CHAR>
348 * \li Params: <CHAR>: The character to insert, given as its code
349 point, in hexadecimal.
350 * \li Sample: unicode-insert 0x0100
351 * \li Origin: Lgb, 22 Oct 2006
354 { LFUN_UNICODE_INSERT, "unicode-insert", Noop, Edit },
356 * \var lyx::FuncCode lyx::LFUN_LISTING_INSERT
357 * \li Action: Inserts a new listings inset.
358 * \li Syntax: listing-insert
359 * \li Origin: Herbert, 10 Nov 2001; bpeng, 2 May 2007
362 { LFUN_LISTING_INSERT, "listing-insert", Noop, Edit },
364 * \var lyx::FuncCode lyx::LFUN_PREVIEW_INSERT
365 * \li Action: Inserts a new preview inset.
366 * \li Syntax: preview-insert
367 * \li Origin: vfr, 28 Mar 2010
370 { LFUN_PREVIEW_INSERT, "preview-insert", Noop, Edit },
372 * \var lyx::FuncCode lyx::LFUN_TAB_INSERT
373 * \li Action: Insert a tab into a listings inset.
374 * \li Notion: It also works on a selection.
375 * \li Syntax: tab-insert
376 * \li Origin: vfr, Sep 30 2008
379 { LFUN_TAB_INSERT, "tab-insert", SingleParUpdate, Edit },
381 * \var lyx::FuncCode lyx::LFUN_TAB_DELETE
382 * \li Action: Delete a tab or up to an equivalent amount of spaces from
384 * \li Notion: It also works on a selection - it removes a tab or spaces from the
385 beginning of each line spanned by the selection. This is useful if
386 you want to indent/unindent multiple lines in one action.
387 * \li Syntax: tab-delete
388 * \li Origin: vfr, Sep 30 2008
391 { LFUN_TAB_DELETE, "tab-delete", SingleParUpdate, Edit },
393 * \var lyx::FuncCode lyx::LFUN_QUOTE_INSERT
394 * \li Action: Inserts quotes according to the type and quote-language preference.
395 * \li Notion: Currently English, Swedish, German, Polish, French, Danish quotes
397 * \li Syntax: quote-insert [<TYPE>]
398 * \li Params: <TYPE>: 'single' for single quotes, otherwise double quotes will be used.
401 { LFUN_QUOTE_INSERT, "quote-insert", Noop, Edit },
403 * \var lyx::FuncCode lyx::LFUN_INFO_INSERT
404 * \li Action: Displays shortcuts, lyxrc, package and textclass availability and menu
405 information in a non-editable boxed InsetText.
406 * \li Notion: Apart from lfun arguments you can use the following method: \n
407 1. input the type and argument of this inset, e.g. "menu paste", in
409 2. select the text and run info-insert lfun.
410 * \li Syntax: info-insert <TYPE> <ARG>
411 * \li Params: <TYPE>: shortcut[s]|lyxrc|lyxinfo|package|textclass|menu|buffer \n
412 <ARG>: argument for a given type. Look into InsetInfo.h for detailed
414 shortcut[s]: name of lfun (e.g math-insert \alpha) \n
415 lyxrc: name of rc_entry (e.g. bind_file) \n
416 lyxinfo: "version" - used version of LyX \n
417 package: name of latex package (e.g. listings) \n
418 textclass: name of textclass (e.g. article) \n
419 menu: name of lfun used in menu \n
420 icon: icon of lfun used in toolbar \n
421 buffer: "name"|"path"|"class"|"vcs-tree-revision"|
422 "vcs-revision"|"vcs-author"|"vcs-date"|"vcs-time"
423 * \li Sample: command-sequence info-insert buffer path; info-insert buffer name
424 * \li Origin: bpeng, 7 Oct 2007
427 { LFUN_INFO_INSERT, "info-insert", Noop, Edit },
429 * \var lyx::FuncCode lyx::LFUN_BRANCH_INSERT
430 * \li Action: Inserts branch inset.
431 * \li Syntax: branch-insert <BRANCH-NAME>
432 * \li Origin: vermeer, 17 Aug 2003
435 { LFUN_BRANCH_INSERT, "branch-insert", Noop, Edit },
437 * \var lyx::FuncCode lyx::LFUN_BOX_INSERT
438 * \li Action: Inserts Box inset.
439 * \li Syntax: box-insert [<TYPE>]
440 * \li Params: <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox \n
441 Framed is the default one.
442 * \li Origin: vermeer, 7 Oct 2003
445 { LFUN_BOX_INSERT, "box-insert", Noop, Edit },
447 * \var lyx::FuncCode lyx::LFUN_FLEX_INSERT
448 * \li Action: Inserts CharStyle, Custom inset or XML short element.
449 * \li Notion: Look into the Customization manual for more information about
451 To make this command enabled the layout file for the document
452 class you're using has to load the character styles. There are
453 a few contained in the Logical Markup module. You can also of
454 course create some yourself. \n
455 For dissolving the element see #LFUN_INSET_DISSOLVE.
456 * \li Syntax: flex-insert Name
457 * \li Params: Name: This name must be defined either in your layout file
458 or imported by some module. The definition is
459 InsetLayout Name or InsetLayout <Flex:Name>. The Flex:
461 * \li Sample: flex-insert Code
464 { LFUN_FLEX_INSERT, "flex-insert", Noop, Edit },
466 * \var lyx::FuncCode lyx::LFUN_SELF_INSERT
467 * \li Action: Inserts the given string (accordingly to the correct keymap).
468 * \li Notion: Automatically replace the currently selected text. Depends on lyxrc
469 settings "auto_region_delete".
470 * \li Syntax: self-insert <STRING>
473 { LFUN_SELF_INSERT, "self-insert", SingleParUpdate, Hidden },
475 * \var lyx::FuncCode lyx::LFUN_SPACE_INSERT
476 * \li Action: Inserts one of horizontal space insets.
477 * \li Syntax: space-insert <NAME> [<LEN>]
478 * \li Params: <NAME>: normal, protected, visible, thin, quad, qquad, enspace,
479 enskip, negthinspace, negmedspace, negthickspace, hfill,
480 hfill*, dotfill, hrulefill, hspace, hspace* \n
481 Only in math mode: med and thick.\n
482 <LEN>: length for custom spaces (hspace, hspace* for protected)
483 * \li Origin: JSpitzm, 20 May 2003, Mar 17 2008
486 { LFUN_SPACE_INSERT, "space-insert", Noop, Edit },
488 * \var lyx::FuncCode lyx::LFUN_HYPERLINK_INSERT
489 * \li Action: Inserts hyperlinks into the document (clickable in pdf output).
490 * \li Notion: Hyperlink target can be set via selection + hyperlink-insert function.
491 * \li Syntax: href-insert [<TARGET>]
492 * \li Origin: CFO-G, 21 Nov 1997
495 { LFUN_HYPERLINK_INSERT, "href-insert", Noop, Edit },
497 * \var lyx::FuncCode lyx::LFUN_SPECIALCHAR_INSERT
498 * \li Action: Inserts various characters into the document.
499 * \li Syntax: specialchar-insert <CHAR>
500 * \li Params: <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots,
501 end-of-sentence, menu-separator.
502 * \li Origin: JSpitzm, 6 Dec 2007
505 { LFUN_SPECIALCHAR_INSERT, "specialchar-insert", Noop, Edit },
507 * \var lyx::FuncCode lyx::LFUN_SCRIPT_INSERT
508 * \li Action: Inserts a subscript or superscript inset.
509 * \li Syntax: script-insert <TYPE>
510 * \li Params: <TYPE>: subscript|superscript
511 * \li Origin: Georg, 23 Nov 2010
514 { LFUN_SCRIPT_INSERT, "script-insert", Noop, Edit },
516 * \var lyx::FuncCode lyx::LFUN_APPENDIX
517 * \li Action: Start (or remove) Appendix on the given cursor position.
518 * \li Syntax: appendix
519 * \li Origin: ettrich, 5 May 1998
522 { LFUN_APPENDIX, "appendix", Noop, Edit },
525 * \var lyx::FuncCode lyx::LFUN_INDEX_INSERT
526 * \li Action: Inserts Index entry.
527 * \li Notion: It automatically takes the word on the cursor position.
528 * \li Syntax: index-insert [<TYPE:Name>]
529 * \li Params: <TYPE:Name>: name of the index, if multiple indices are defined.
530 With an empty argument, the default index is selected.
531 * \li Origin: leeming, 3 Aug 2000
534 { LFUN_INDEX_INSERT, "index-insert", Noop, Edit },
536 * \var lyx::FuncCode lyx::LFUN_INDEX_PRINT
537 * \li Action: Inserts list of Index entries on a new page.
538 * \li Syntax: index-print [<TYPE:Name>]
539 * \li Params: <TYPE:Name>: name of the index, if multiple indices are defined.
540 With an empty argument, the default index is selected.
541 * \li Origin: Lgb, 27 Feb 1997
544 { LFUN_INDEX_PRINT, "index-print", Noop, Edit },
546 * \var lyx::FuncCode lyx::LFUN_IPA_INSERT
547 * \li Action: Inserts an IPA inset.
548 * \li Syntax: ipa-insert
549 * \li Origin: spitz, 05 Mar 2012
552 { LFUN_IPA_INSERT, "ipa-insert", Noop, Edit },
554 * \var lyx::FuncCode lyx::LFUN_IN_IPA
555 * \li Action: Only active in IPA inset.
556 * \li Notion: Dummy function which is only active in a IPA inset.
557 It's used to toggle the IPA toolbar if the cursor moves
560 * \li Origin: spitz, 20 May 2012
563 { LFUN_IN_IPA, "in-ipa", Noop, Edit },
565 * \var lyx::FuncCode lyx::LFUN_IPAMACRO_INSERT
566 * \li Action: Inserts special IPA macros into the document.
567 * \li Syntax: ipamacro-insert <CHAR>
568 * \li Params: <CHAR>: tone-falling, tone-rising, tone-high-rising, tone-low-rising,
569 * tone-high-rising-falling, deco bottomtiebar, deco toptiebar.
570 * \li Origin: JSpitzm, 22 Aug 2012
573 { LFUN_IPAMACRO_INSERT, "ipamacro-insert", Noop, Edit },
575 * \var lyx::FuncCode lyx::LFUN_NOMENCL_INSERT
576 * \li Action: Inserts Nomenclature entry.
577 * \li Notion: It automatically takes the word on the cursor position if no symbol is given.
578 * \li Syntax: nomencl-insert [<SYMBOL>]
579 * \li Origin: Ugras, 4 Nov 2006
582 { LFUN_NOMENCL_INSERT, "nomencl-insert", Noop, Edit },
584 * \var lyx::FuncCode lyx::LFUN_NOMENCLATURE_PRINT
585 * \li Action: Inserts list of Nomenclature entries.
586 * \li Syntax: nomenclature-print
587 * \li Origin: Ugras, 4 Nov 2006
590 { LFUN_NOMENCL_PRINT, "nomencl-print", Noop, Edit },
593 * \var lyx::FuncCode lyx::LFUN_NOTE_INSERT
594 * \li Action: Inserts Note on the current cursor position,
595 move selection inside the inset.
596 * \li Syntax: note-insert [<TYPE>]
597 * \li Params: <TYPE>: <Note|Greyedout|Comment> default: Note
600 { LFUN_NOTE_INSERT, "note-insert", Noop, Edit },
602 * \var lyx::FuncCode lyx::LFUN_NOTE_NEXT
603 * \li Action: Moves the cursor to the beginning of next Note inset.
604 * \li Syntax: note-next
607 { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
609 * \var lyx::FuncCode lyx::LFUN_PHANTOM_INSERT
610 * \li Action: Inserts phantom on the current cursor position,
611 move selection inside the inset.
612 * \li Syntax: phantom-insert [<TYPE>]
613 * \li Params: <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
614 * \li Origin: uwestoehr, 30 Jan 2009
617 { LFUN_PHANTOM_INSERT, "phantom-insert", Noop, Edit },
619 * \var lyx::FuncCode lyx::LFUN_NEWLINE_INSERT
620 * \li Action: Inserts a line break or new line.
621 * \li Syntax: newline-insert [<ARG>]
622 * \li Params: <ARG>: <newline|linebreak> default: newline
623 * \li Origin: JSpitzm, 25 Mar 2008
626 { LFUN_NEWLINE_INSERT, "newline-insert", Noop, Edit },
628 * \var lyx::FuncCode lyx::LFUN_ESCAPE
629 * \li Action: Clears the selection. If no text is selected call #LFUN_FINISHED_FORWARD.
630 Inside math mode jumps out of the math inset.
632 * \li Origin: Lgb, 17 May 2001
635 { LFUN_ESCAPE, "escape", ReadOnly, Edit },
637 * \var lyx::FuncCode lyx::LFUN_DOWN
638 * \li Action: Moves the cursor one line in downward direction.
642 { LFUN_DOWN, "down", ReadOnly | NoUpdate, Edit },
644 * \var lyx::FuncCode lyx::LFUN_UP
645 * \li Action: Moves the cursor one line in upward direction.
649 { LFUN_UP, "up", ReadOnly | NoUpdate, Edit },
651 * \var lyx::FuncCode lyx::LFUN_DOWN_SELECT
652 * \li Action: Moves the cursor one line in downward direction adding the current
653 position to the selection.
654 * \li Syntax: down-select
657 { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, Edit },
659 * \var lyx::FuncCode lyx::LFUN_UP_SELECT
660 * \li Action: Moves the cursor one line in upward direction adding the current
661 position to the selection.
662 * \li Syntax: up-select
665 { LFUN_UP_SELECT, "up-select", ReadOnly | SingleParUpdate, Edit },
667 * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN
668 * \li Action: Moves the cursor one page in downward direction.
669 * \li Syntax: screen-down
672 { LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit },
674 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP
675 * \li Action: Moves the cursor one page in upward direction.
676 * \li Syntax: screen-up
679 { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit },
681 * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN_SELECT
682 * \li Action: Moves the cursor one screen in downward direction adding the current
683 position to the selection.
684 * \li Syntax: screen-down-select
687 { LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit },
689 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP_SELECT
690 * \li Action: Moves the cursor one page in upward direction adding the current
691 position to the selection.
692 * \li Syntax: screen-up-select
695 { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit },
697 * \var lyx::FuncCode lyx::LFUN_SCROLL
698 * \li Action: Scroll the buffer view.
699 * \li Notion: Only scrolls the screen up or down; does not move the cursor.
700 * \li Syntax: scroll <TYPE> <QUANTITY>
701 * \li Params: <TYPE>: line|page\n
702 <QUANTITY>: up|down|<number>
703 * \li Origin: Abdel, Dec 27 2007
706 { LFUN_SCROLL, "scroll", ReadOnly, Edit },
708 * \var lyx::FuncCode lyx::LFUN_SCREEN_RECENTER
709 * \li Action: Recenters the screen on the current cursor position.
710 * \li Syntax: screen-recenter
713 { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit },
716 * \var lyx::FuncCode lyx::LFUN_SCREEN_SHOW_CURSOR
717 * \li Action: Repositions the screen such that the cursor is visible.
718 * \li Syntax: screen-show-cursor
719 * \li Origin: vfr, 25 Mar 2009
722 { LFUN_SCREEN_SHOW_CURSOR, "screen-show-cursor", ReadOnly, Edit },
725 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD
726 * \li Action: Moves the cursor one position logically backwards.
727 * \li Notion: This is not the action which should be bound to the arrow keys,
728 because backwards may be left or right, depending on the
729 language. The arrow keys should be bound to #LFUN_CHAR_LEFT or
730 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
731 * \li Syntax: char-backward
734 { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit },
736 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD_SELECT
737 * \li Action: Moves the cursor one position logically backwards, adding
738 traversed position to the selection.
739 * \li Notion: See also #LFUN_CHAR_BACKWARD.
740 * \li Syntax: char-backward-select
743 { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit },
745 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_BACKWARD
746 * \li Action: Deletes one character in the backward direction (usually the "BackSpace" key).
747 * \li Syntax: char-delete-backward
750 { LFUN_CHAR_DELETE_BACKWARD, "char-delete-backward", SingleParUpdate, Edit },
752 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_FORWARD
753 * \li Action: Deletes one character in the backward direction (usually the "Delete" key).
754 * \li Syntax: char-delete-forward
757 { LFUN_CHAR_DELETE_FORWARD, "char-delete-forward", SingleParUpdate, Edit },
759 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD
760 * \li Action: Moves the cursor one position logically forward.
761 * \li Notion: This is not the action which should be bound to the arrow keys,
762 because forward may be left or right, depending on the language.
763 The arrow keys should be bound to #LFUN_CHAR_LEFT or
764 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
765 * \li Syntax: char-forward
768 { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit },
770 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD_SELECT
771 * \li Action: Moves the cursor one position logically forward, adding
772 traversed position to the selection.
773 * \li Notion: See also #LFUN_CHAR_FORWARD.
774 * \li Syntax: char-forward-select
777 { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit },
779 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT
780 * \li Action: Moves the cursor one position "to the left".
781 * \li Notion: This is the action which should be taken when the "left" key
782 is pressed. Generally, it moves the cursor one position to the
783 left. However, in Bidi text this become slightly more
784 complicated, and there are different modes of cursor movement.
785 In "visual mode", this moves left, plain and simple. In "logical
786 mode", movement is logically forward in RTL paragraphs, and
787 logically backwards in LTR paragraphs.
788 * \li Syntax: char-left
791 { LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit },
793 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT_SELECT
794 * \li Action: Moves the cursor one position "to the left", adding
795 traversed position to the selection.
796 * \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement.
797 * \li Syntax: char-left-select
800 { LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit },
802 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT
803 * \li Action: Moves the cursor one position "to the right".
804 * \li Notion: This is the action which should be taken when the "right" key
805 is pressed. Generally, it moves the cursor one position to the
806 right. However, in Bidi text this become slightly more
807 complicated, and there are different modes of cursor movement.
808 In "visual mode", this moves right, plain and simple. In "logical
809 mode", movement is logically forward in LTR paragraphs, and
810 logically backwards in RTL paragraphs.
811 * \li Syntax: char-right
814 { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit },
816 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT_SELECT
817 * \li Action: Moves the cursor one position "to the right", adding
818 traversed position to the selection.
819 * \li Notion: See also #LFUN_CHAR_RIGHT for exact details of the movement.
820 * \li Syntax: char-right-select
823 { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit },
826 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD
827 * \li Action: Moves the cursor to the logically previous beginning of a word.
828 * \li Notion: This is not the action which should be bound to the arrow keys,
829 because backwards may be left or right, depending on the
830 language. The arrow keys should be bound to #LFUN_WORD_LEFT or
831 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
832 * \li Syntax: word-backward
835 { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit },
837 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD_SELECT
838 * \li Action: Moves the cursor to the logically previous beginning of a word,
839 adding the logically traversed text to the selection.
840 * \li Notion: See also #LFUN_WORD_BACKWARD.
841 * \li Syntax: word-backward-select
844 { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
846 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_BACKWARD
847 * \li Action: Deletes characters to the beginning of the word (usually the "C+BackSpace" key).
848 * \li Syntax: word-delete-backward
851 { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
853 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_FORWARD
854 * \li Action: Deletes characters to the end of the word (usually the "C+Delete" key).
855 * \li Syntax: word-delete-forward
858 { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
860 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_FORWARD
861 * \li Action: Search for a given string in forward direction.
862 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
863 * \li Syntax: word-find-forward [<STRING>]
864 * \li Origin: Etienne, 16 Feb 1998
867 { LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit },
869 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_BACKWARD
870 * \li Action: Search for a given string in backward direction.
871 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
872 * \li Syntax: word-find-backward [<STRING>]
873 * \li Origin: Etienne, 20 Feb 1998
876 { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
878 * \var lyx::FuncCode lyx::LFUN_WORD_FIND
879 * \li Action: Search for next occurrence of a string.
880 * \li Syntax: word-find [<DATA>]
881 * \li Params: <DATA>: data encoded from Find dialog (see #lyx::find2string()).
882 If no parameter is given, search with last find-dialog
883 data is used for search (i.e. find-next).
884 * \li Origin: Andre, Jan 7 2004
887 { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
889 * \var lyx::FuncCode lyx::LFUN_WORD_REPLACE
890 * \li Action: Replace a string in the document.
891 * \li Syntax: word-replace [<DATA>]
892 * \li Params: <DATA>: data is of the form
895 <casesensitive> <matchword> <all> <forward> <findnext>"
896 * \li Origin: Andre, Jan 7 2004
899 { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
901 * \var lyx::FuncCode lyx::LFUN_WORD_FINDADV
902 * \li Action: Search for next occurrence of a pattern.
903 * \li Syntax: word-findadv [<DATA>]
904 * \li Params: <DATA>: data encoded from FindAdv dialog (see #lyx::findadv2string()).
905 If no parameter is given, search with last find-dialog
906 data is used for search (i.e. find-next).
907 * \li Origin: Tommaso, Nov 15 2007
910 { LFUN_WORD_FINDADV, "word-findadv", ReadOnly | NoBuffer, Edit },
912 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD
913 * \li Action: Moves the cursor to the logically next beginning of a word.
914 * \li Notion: This is not the action which should be bound to the arrow keys,
915 because forward may be left or right, depending on the language.
916 The arrow keys should be bound to #LFUN_WORD_LEFT or
917 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
918 * \li Syntax: word-forward
921 { LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
923 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD_SELECT
924 * \li Action: Moves the cursor to the logically next beginning of a word,
925 adding the logically traversed text to the selection.
926 * \li Notion: See also #LFUN_WORD_FORWARD.
927 * \li Syntax: word-forward-select
930 { LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
932 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT
933 * \li Action: Moves the cursor to the next beginning of a word "on the left".
934 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
935 "left" key is pressed. Generally, it moves the cursor to the
936 next beginning of a word on the left. However, in Bidi text this
937 become slightly more complicated, and there are different modes
938 of cursor movement. In "visual mode", this moves left, plain and
939 simple. In "logical mode", movement is logically forward in RTL
940 paragraphs, and logically backwards in LTR paragraphs.
941 * \li Syntax: word-left
942 * \li Origin: dov, 28 Oct 2007
945 { LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
947 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT_SELECT
948 * \li Action: Moves the cursor to the next beginning of a word "on the left",
949 adding *logically* traversed text to the selection.
950 * \li Notion: See also #LFUN_WORD_LEFT for exact details of the movement.
951 * \li Syntax: word-left-select
952 * \li Origin: dov, 28 Oct 2007
955 { LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit },
957 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT
958 * \li Action: Moves the cursor to the next beginning of a word "on the right".
959 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
960 "right" key is pressed. Generally, it moves the cursor to the
961 next beginning of a word on the right. However, in Bidi text
962 this become slightly more complicated, and there are different
963 modes of cursor movement. In "visual mode", this moves right,
964 plain and simple. In "logical mode", movement is logically
965 forward in LTR paragraphs, and logically backwards in RTL
967 * \li Syntax: word-right
968 * \li Origin: dov, 28 Oct 2007
971 { LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit },
973 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT_SELECT
974 * \li Action: Moves the cursor to the next beginning of a word "on the right",
975 adding *logically* traversed text to the selection.
976 * \li Notion: See also #LFUN_WORD_RIGHT for exact details of the movement.
977 * \li Syntax: word-right-select
978 * \li Origin: dov, 28 Oct 2007
981 { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
983 * \var lyx::FuncCode lyx::LFUN_WORD_SELECT
984 * \li Action: Puts the word where the cursor stands into the selection.
985 * \li Syntax: word-select
986 * \li Origin: Andre, 11 Sep 2002
989 { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
991 * \var lyx::FuncCode lyx::LFUN_WORD_CAPITALIZE
992 * \li Action: Capitalizes the words in the selection (i.e. the first letters)
993 or the letter on the cursor position.
994 * \li Syntax: word-capitalize
997 { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
999 * \var lyx::FuncCode lyx::LFUN_WORD_UPCASE
1000 * \li Action: Change the words in the selection or from the cursor position
1001 to the end of word to the upper case.
1002 * \li Syntax: word-upcase
1005 { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
1007 * \var lyx::FuncCode lyx::LFUN_WORD_LOWCASE
1008 * \li Action: Change the words in the selection or from the cursor position
1009 to the end of word to the lower case.
1010 * \li Syntax: word-lowcase
1013 { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
1015 * \var lyx::FuncCode lyx::LFUN_SPELLING_ADD
1016 * \li Action: Add the word under the cursor to the respective
1017 * spell checker dictionary.
1018 * \li Syntax: spelling-add [<STRING>] [<LANG>]
1019 * \li Params: <WORD>: word to add
1020 <LANG>: language name (see file languages)
1021 * \li Origin: JSpitzm, 18 Jan 2010
1024 { LFUN_SPELLING_ADD, "spelling-add", ReadOnly, Edit },
1026 * \var lyx::FuncCode lyx::LFUN_SPELLING_IGNORE
1027 * \li Action: Let the spell checker ignore the word under the cursor
1028 * in the current session for the given language.
1029 * \li Syntax: spelling-ignore [<WORD>] [<LANG>]
1030 * \li Params: <WORD>: word to ignore
1031 <LANG>: language name (see file languages)
1032 * \li Origin: JSpitzm, 18 Jan 2010
1035 { LFUN_SPELLING_IGNORE, "spelling-ignore", ReadOnly, Edit },
1037 * \var lyx::FuncCode lyx::LFUN_SPELLING_REMOVE
1038 * \li Action: Remove the word under the cursor from the respective
1039 * spell checker dictionary.
1040 * \li Syntax: spelling-remove [<STRING>] [<LANG>]
1041 * \li Params: <WORD>: word to remove
1042 <LANG>: language name (see file languages)
1043 * \li Origin: SWitt, 28 July 2010
1046 { LFUN_SPELLING_REMOVE, "spelling-remove", ReadOnly, Edit },
1048 * \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
1049 * \li Action: Look up thesaurus entries with respect to the word under the cursor.
1050 * \li Syntax: thesaurus-entry [<STRING>] [lang=<LANG>]
1051 * \li Params: <STRING>: word to look up
1052 <LANG>: language (see file languages)
1053 * \li Origin: Levon, 20 Jul 2001
1056 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
1058 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN
1059 * \li Action: Move the cursor to the beginning of the document.
1060 * \li Syntax: buffer-begin
1063 { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
1065 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN_SELECT
1066 * \li Action: Move the cursor to the beginning of the document adding the
1067 traversed text to the selection.
1068 * \li Syntax: buffer-begin-select
1071 { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
1073 * \var lyx::FuncCode lyx::LFUN_BUFFER_END
1074 * \li Action: Move the cursor to the end of the document.
1075 * \li Syntax: buffer-end
1078 { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
1080 * \var lyx::FuncCode lyx::LFUN_BUFFER_END_SELECT
1081 * \li Action: Move the cursor to the end of the document adding the
1082 traversed text to the selection.
1083 * \li Syntax: buffer-end-select
1086 { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
1089 * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN
1090 * \li Action: Move the cursor to the beginning of the current inset
1091 if it is not already there, or at the beginning of the
1092 enclosing inset otherwise
1093 * \li Syntax: inset-begin
1094 * \li Origin: lasgouttes, 16 Mar 2009
1097 { LFUN_INSET_BEGIN, "inset-begin", ReadOnly, Edit },
1099 * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN_SELECT
1100 * \li Action: Move the cursor to the beginning of the current inset
1101 if it is not already there, or at the beginning of the
1102 enclosing inset otherwise (adding the
1103 traversed text to the selection).
1104 * \li Syntax: inset-begin-select
1105 * \li Origin: lasgouttes, 16 Mar 2009
1108 { LFUN_INSET_BEGIN_SELECT, "inset-begin-select", ReadOnly, Edit },
1110 * \var lyx::FuncCode lyx::LFUN_INSET_END
1111 * \li Action: Move the cursor to the end of the current inset
1112 if it is not already there, or at the end of the
1113 enclosing inset otherwise
1114 * \li Syntax: inset-end
1115 * \li Origin: lasgouttes, 16 Mar 2009
1118 { LFUN_INSET_END, "inset-end", ReadOnly, Edit },
1120 * \var lyx::FuncCode lyx::LFUN_INSET_END_SELECT
1121 * \li Action: Move the cursor to the end of the current inset
1122 if it is not already there, or at the end of the
1123 enclosing inset otherwise (adding the
1124 traversed text to the selection).
1125 * \li Syntax: inset-end-select
1126 * \li Origin: lasgouttes, 16 Mar 2009
1129 { LFUN_INSET_END_SELECT, "inset-end-select", ReadOnly, Edit },
1132 * \var lyx::FuncCode lyx::LFUN_INSET_SELECT_ALL
1133 * \li Action: Selects all contents of an inset.
1134 * \li Syntax: inset-select-all
1135 * \li Origin: vfr, 22 Aug 2009
1138 { LFUN_INSET_SELECT_ALL, "inset-select-all", ReadOnly, Edit },
1141 * \var lyx::FuncCode lyx::LFUN_SECTION_SELECT
1142 * \li Action: Selects the whole section.
1143 * \li Notion: The cursor should be in a section heading
1144 before calling this lfun.
1145 * \li Syntax: section-select
1146 * \li Origin: vfr, 05 May 2009
1149 { LFUN_SECTION_SELECT, "section-select", ReadOnly, Edit },
1152 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN
1153 * \li Action: Move the cursor to the beginning of the (screen) line.
1154 * \li Syntax: line-begin
1157 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
1159 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN_SELECT
1160 * \li Action: Move the cursor to the beginning of the (screen) line adding the
1161 traversed text to the selection.
1162 * \li Syntax: line-begin-select
1165 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
1167 * \var lyx::FuncCode lyx::LFUN_LINE_END
1168 * \li Action: Move the cursor to the end of the (screen) line.
1169 * \li Syntax: line-end
1172 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
1174 * \var lyx::FuncCode lyx::LFUN_LINE_END_SELECT
1175 * \li Action: Move the cursor to the end of the (screen) line adding the
1176 traversed text to the selection.
1177 * \li Syntax: line-end-select
1180 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
1182 * \var lyx::FuncCode lyx::LFUN_LINE_DELETE
1183 * \li Action: Deletes the letters to the end of the (screen) line or
1184 deletes the selection.
1185 * \li Syntax: line-delete-forward
1188 { LFUN_LINE_DELETE, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
1190 * \var lyx::FuncCode lyx::LFUN_COPY
1191 * \li Action: Copies the current selection to the clipboard.
1195 { LFUN_COPY, "copy", ReadOnly, Edit },
1197 * \var lyx::FuncCode lyx::LFUN_CUT
1198 * \li Action: Cuts to the clipboard.
1202 { LFUN_CUT, "cut", Noop, Edit },
1204 * \var lyx::FuncCode lyx::LFUN_PASTE
1205 * \li Action: Pastes material (text or picture) from the active clipboard.
1206 * \li Syntax: paste [<TYPE>|<NUM>]
1207 * \li Params: <TYPE>: emf|pdf|png|jpeg|linkback|wmf \n
1208 <NUM>: number of the selection in the internal clipboard stack to be pasted.
1211 { LFUN_PASTE, "paste", Noop, Edit },
1213 * \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE
1214 * \li Action: Pastes text from the active clipboard.
1215 * \li Syntax: clipboard-paste [<ARG>]
1216 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1217 * \li Origin: Georg, 10 Jul 2006
1220 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
1222 * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
1223 * \li Action: Pastes the currently selected text.
1224 * \li Notion: Primary selection mechanism is linux-only thing.
1225 * \li Syntax: primary-selection-paste [<ARG>]
1226 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1229 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
1231 * \var lyx::FuncCode lyx::LFUN_SELECTION_PASTE
1232 * \li Action: Pastes the internal selection text in permanent selection.
1233 * \li Notion: Created in order to have middle mouse button pasting correct (bound to
1234 command-alternatives selection-paste ; primary-selection-paste paragraph).
1235 * \li Syntax: selection-paste
1236 * \li Origin: lasgouttes, 14 Jan 2009
1239 { LFUN_SELECTION_PASTE, "selection-paste", Noop, Edit },
1241 * \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE_SIMPLE
1242 * \li Action: Pastes simple unformatted text from the active clipboard.
1243 * \li Syntax: clipboard-paste-simple [<ARG>]
1244 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1247 { LFUN_CLIPBOARD_PASTE_SIMPLE, "clipboard-paste-simple", Noop, Edit },
1249 * \var lyx::FuncCode lyx::LFUN_UNDO
1250 * \li Action: Undoes the last edit.
1254 { LFUN_UNDO, "undo", ReadOnly, Edit },
1256 * \var lyx::FuncCode lyx::LFUN_REDO
1257 * \li Action: Redoes the last thing undone.
1261 { LFUN_REDO, "redo", ReadOnly, Edit },
1263 * \var lyx::FuncCode lyx::LFUN_REPEAT
1264 * \li Action: Repeat the given command.
1265 * \li Syntax: repeat <COUNT> <LFUN-COMMAND>
1266 * \li Origin: Andre, 27 Oct 2003
1269 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
1271 * \var lyx::FuncCode lyx::LFUN_CHARS_TRANSPOSE
1272 * \li Action: Transposes the character at the cursor with the one before it.
1273 * \li Syntax: chars-transpose
1274 * \li Origin: Lgb, 25 Apr 2001
1277 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
1280 * \var lyx::FuncCode lyx::LFUN_DEPTH_DECREMENT
1281 * \li Action: Decrease the nesting depth of the (selected) paragraph(s)
1283 * \li Syntax: depth-decrement
1286 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
1288 * \var lyx::FuncCode lyx::LFUN_DEPTH_INCREMENT
1289 * \li Action: Increase the nesting depth of the (selected) paragraph(s)
1291 * \li Syntax: depth-increment
1294 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
1297 * \var lyx::FuncCode lyx::LFUN_FONT_BOLD
1298 * \li Action: Toggles the bold font (selection-wise) using mathbf in math.
1299 * \li Syntax: font-bold
1302 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
1305 * \var lyx::FuncCode lyx::LFUN_FONT_BOLDSYMBOL
1306 * \li Action: Toggles the bold font (selection-wise) using boldsymbol in math.
1307 * \li Syntax: font-boldsymbol
1310 { LFUN_FONT_BOLDSYMBOL, "font-boldsymbol", Noop, Layout },
1312 * \var lyx::FuncCode lyx::LFUN_FONT_TYPEWRITER
1313 * \li Action: Toggles the typewriter family font (selection-wise).
1314 * \li Syntax: font-typewriter
1317 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
1319 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERLINE
1320 * \li Action: Toggles underline in the font (selection-wise).
1321 * \li Syntax: font-underline
1324 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
1326 * \var lyx::FuncCode lyx::LFUN_FONT_UULINE
1327 * \li Action: Toggles double underline in the font (selection-wise).
1328 * \li Syntax: font-underunderline
1329 * \li Origin: sanda, 5 May 2009
1332 { LFUN_FONT_UULINE, "font-underunderline", Noop, Layout },
1334 * \var lyx::FuncCode lyx::LFUN_FONT_UWAVE
1335 * \li Action: Toggles wavy underline in the font (selection-wise).
1336 * \li Syntax: font-underwave
1337 * \li Origin: sanda, 5 May 2009
1340 { LFUN_FONT_UWAVE, "font-underwave", Noop, Layout },
1342 * \var lyx::FuncCode lyx::LFUN_FONT_STRIKEOUT
1343 * \li Action: Toggles strikeout (strike-through) in the font (selection-wise).
1344 * \li Syntax: font-strikeout
1345 * \li Origin: sanda, 3 May 2009
1348 { LFUN_FONT_STRIKEOUT, "font-strikeout", Noop, Layout },
1350 * \var lyx::FuncCode lyx::LFUN_FONT_EMPH
1351 * \li Action: Toggles the emphasis font style (selection-wise).
1352 * \li Syntax: font-emph
1355 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
1357 * \var lyx::FuncCode lyx::LFUN_FONT_NOUN
1358 * \li Action: Toggles Noun text style font (selection-wise).
1359 * \li Syntax: font-noun
1362 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
1364 * \var lyx::FuncCode lyx::LFUN_FONT_ROMAN
1365 * \li Action: Toggles Roman family font (selection-wise).
1366 * \li Syntax: font-roman
1369 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
1371 * \var lyx::FuncCode lyx::LFUN_FONT_SANS
1372 * \li Action: Toggles Sans Serif family font (selection-wise).
1373 * \li Syntax: font-sans
1376 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
1378 * \var lyx::FuncCode lyx::LFUN_FONT_FRAK
1379 * \li Action: Toggles Fraktur family font (math-mode, selection-wise).
1380 * \li Syntax: font-frak
1381 * \li Origin: vermeer, 10 Jan 2002
1384 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
1386 * \var lyx::FuncCode lyx::LFUN_FONT_ITAL
1387 * \li Action: Toggles Italics font shape (math-mode, selection-wise).
1388 * \li Syntax: font-ital
1389 * \li Origin: vermeer, 10 Jan 2002
1392 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
1394 * \var lyx::FuncCode lyx::LFUN_FONT_DEFAULT
1395 * \li Action: Reverts the settings of the font to the default values (selection-wise).
1396 * \li Syntax: font-default
1399 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
1401 * \var lyx::FuncCode lyx::LFUN_FONT_SIZE
1402 * \li Action: Sets font size according to lyx format string.
1403 * \li Syntax: font-size <SIZE>
1404 * \li Params: <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|\n
1405 largest|huge|giant|increase|decrease|default
1408 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
1410 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_APPLY
1411 * \li Action: Toggle user-defined (=last-time used) text style.
1412 * \li Notion: This style is set via #LFUN_TEXTSTYLE_UPDATE, which is
1413 automatically triggered when using Text Style dialog.
1414 * \li Syntax: textstyle-apply
1415 * \li Origin: leeming, 12 Mar 2003
1418 { LFUN_TEXTSTYLE_APPLY, "textstyle-apply", Noop, Layout },
1420 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_UPDATE
1421 * \li Action: Apply text style and update the settings to be used by #LFUN_TEXTSTYLE_APPLY.
1422 * \li Syntax: textstyle-update <FONT_INFO>
1423 * \li Params: <FONT_INFO>: specifies font atributes, e.g. family, series, shape,
1424 size, emph, noun, underbar, number, color, language,
1426 Use lyx -dbg action for exact syntax of text-style
1428 * \li Origin: leeming, 12 Mar 2003
1431 { LFUN_TEXTSTYLE_UPDATE, "textstyle-update", Noop, Layout },
1433 * \var lyx::FuncCode lyx::LFUN_SCREEN_FONT_UPDATE
1434 * \li Action: Update fonts and its metrics.
1435 * \li Notion: Automatically called after zoom, dpi, font names, or norm change.
1436 * \li Syntax: screen-font-update
1437 * \li Origin: ARRae, 13 Aug 2000
1440 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
1442 * \var lyx::FuncCode lyx::LFUN_FONT_STATE
1443 * \li Action: Returns the info about the current font.
1444 * \li Syntax: font-state
1447 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
1450 * \var lyx::FuncCode lyx::LFUN_CITATION_INSERT
1451 * \li Action: Inserts citation from loaded citation database.
1452 * \li Syntax: citation-insert [<KEY>[|<TEXT_BEFORE>]]
1453 * \li Params: <KEY>: Citation (shortcut listed in available citations). \n
1454 <TEXT_BEFORE>: text which should appear before citation.
1455 * \li Origin: AAS, 97-02-23
1458 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
1460 * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_ADD
1461 * \li Action: Adds database, which will be used for bibtex citations.
1462 * \li Notion: Databases are added to the first BibTeX inset
1463 (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
1464 * \li Syntax: bibtex-database-add <DATABASE-NAME>
1465 * \li Origin: Ale, 30 May 1997
1468 { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit },
1470 * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_DEL
1471 * \li Action: Adds database, which will be used for bibtex citations.
1472 * \li Notion: Databases are deleted from the first BibTeX inset
1473 (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
1474 * \li Syntax: bibtex-database-del <DATABASE-NAME>
1475 * \li Origin: Ale, 30 May 1997
1478 { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
1481 * \var lyx::FuncCode lyx::LFUN_LAYOUT
1482 * \li Action: Sets the layout (that is, environment) for the current paragraph.
1483 * \li Syntax: layout <LAYOUT>
1484 * \li Params: <LAYOUT>: the layout to use
1487 { LFUN_LAYOUT, "layout", Noop, Layout },
1489 * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH
1490 * \li Action: Launches the paragraph settings dialog.
1491 * \li Syntax: layout-paragraph
1494 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
1496 * \var lyx::FuncCode lyx::LFUN_LAYOUT_TABULAR
1497 * \li Action: Launches the tabular settings dialog.
1498 * \li Syntax: layout-tabular
1499 * \li Origin: Jug, 31 Jul 2000
1502 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
1504 * \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE
1505 * \li Action: Displays list of layout choices.
1506 * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
1507 dropbox allowing for choice of layout.
1508 * \li Syntax: drop-layouts-choice
1511 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
1513 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
1514 * \li Action: Clears the module list.
1515 * \li Notion: Clears the list of included modules for the current buffer.
1516 * \li Syntax: layout-modules-clear
1517 * \li Origin: rgh, 25 August 2007
1520 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", NoInternal, Layout },
1522 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULE_ADD
1523 * \li Action: Adds a module.
1524 * \li Notion: Adds a module to the list of included modules for the current buffer.
1525 * \li Syntax: layout-module-add <MODULE>
1526 * \li Params: <MODULE>: the module to be added
1527 * \li Origin: rgh, 25 August 2007
1530 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", NoInternal, Layout },
1532 * \var lyx::FuncCode lyx::LFUN_LAYOUT_RELOAD
1533 * \li Action: Reloads layout information.
1534 * \li Notion: Reloads all layout information for the current buffer from disk, thus
1535 recognizing any changes that have been made to layout files on the fly.
1536 This is intended to be used only by layout developers and should not be
1537 used when one is trying to do actual work.
1538 * \li Syntax: layout-reload
1539 * \li Origin: rgh, 3 September 2007
1542 { LFUN_LAYOUT_RELOAD, "layout-reload", NoInternal, Layout },
1544 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
1545 * \li Action: Sets the text class for the current buffer.
1546 * \li Syntax: textclass-apply <TEXTCLASS>
1547 * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
1548 the filename, minus the ".layout" extension.
1551 { LFUN_TEXTCLASS_APPLY, "textclass-apply", NoInternal, Layout },
1553 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
1554 * \li Action: Loads information for a textclass from disk.
1555 * \li Syntax: textclass-load <TEXTCLASS>
1556 * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
1557 the filename, minus the ".layout" extension.
1560 { LFUN_TEXTCLASS_LOAD, "textclass-load", NoInternal, Layout },
1563 * \var lyx::FuncCode lyx::LFUN_MARK_OFF
1564 * \li Action: Disable selecting of text-region.
1565 * \li Syntax: mark-off
1568 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
1570 * \var lyx::FuncCode lyx::LFUN_MARK_ON
1571 * \li Action: Enable selecting of text-region.
1572 * \li Notion: After enabling you can simply move arrow keys to get selected region.
1573 * \li Syntax: mark-on
1576 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
1578 * \var lyx::FuncCode lyx::LFUN_MARK_TOGGLE
1579 * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
1580 * \li Syntax: mark-toggle
1581 * \li Origin: Andre, May 5 2006
1584 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
1587 * \var lyx::FuncCode lyx::LFUN_MATH_DELIM
1588 * \li Action: Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
1589 * \li Syntax: math-delim [<LEFT>] [<RIGHT>]
1590 * \li Params: <LEFT/RIGHT>: Delimiters to be used. Each delimiter can be specified by
1591 either a LaTeX name or a valid character.
1592 ( is the default letter.
1593 * \li Sample: math-delim { rangle
1594 * \li Origin: Alejandro, 18 Jun 1996
1597 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
1599 * \var lyx::FuncCode lyx::LFUN_MATH_BIGDELIM
1600 * \li Action: Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
1601 * \li Syntax: math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
1602 * \li Params: <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r \n
1603 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
1604 * \li Sample: math-bigdelim "Bigl" "\Downarrow" "Bigr" "\}"
1605 * \li Origin: Enrico & Georg, 7 May 2006
1608 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
1610 * \var lyx::FuncCode lyx::LFUN_MATH_DISPLAY
1611 * \li Action: Creates a new displayed equation in text mode.
1612 Toggles inlined/display formula in math mode.
1613 * \li Syntax: math-display [<ARG>]
1614 * \li Params: <ARG>: this argument will be passed to #LFUN_MATH_INSERT when creating
1615 new equation from the text mode.
1616 * \li Origin: Alejandro, 18 Jun 1996
1619 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
1621 * \var lyx::FuncCode lyx::LFUN_MATH_INSERT
1622 * \li Action: Inserts math objects and symbols.
1623 * \li Syntax: math-insert <ARG>
1624 * \li Params: <ARG>: Symbol or LaTeX code to be inserted.
1625 * \li Notion: When <ARG> is a _single_ math inset with more than one cell
1626 (such as "x_y^z" or "\frac{x}{y}"), the content of cell(0) is
1627 replaced by the current selection (only works if the selection
1628 is in mathed). As an example, if "abc" is selected in mathed,
1629 "math-insert \frac{x}{y}" replaces "abc" with "\frac{abc}{y}",
1630 and "math-insert x_y^z" replaces "abc" with "abc_y^z".
1631 If nothing is selected (or the selection is not in mathed),
1632 math-insert works as expected.
1635 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
1637 * \var lyx::FuncCode lyx::LFUN_MATH_SUBSCRIPT
1638 * \li Action: Enters subscript expression in math expression.
1639 * \li Syntax: math-subscript
1640 * \li Origin: vermeer, 12 Dec 2001
1643 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
1645 * \var lyx::FuncCode lyx::LFUN_MATH_SUPERSCRIPT
1646 * \li Action: Enters superscript expression in math expression.
1647 * \li Syntax: math-superscript
1648 * \li Origin: vermeer, 12 Dec 2001
1651 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
1653 * \var lyx::FuncCode lyx::LFUN_MATH_LIMITS
1654 * \li Action: Toggles the position of the limits from above/below to the right
1655 side an vice versa in integral symbol, a limit, a summation, etc.
1656 * \li Notion: Put the cursor before the symbol with the limits and then invoke
1658 * \li Syntax: math-limits [<STATE>]
1659 * \li Params: <STATE>: limits|nolimits
1662 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
1664 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO
1665 * \li Action: Inserts a math macro definition at the cursor position in the text.
1666 * \li Syntax: math-macro <NAME> [<NARGS>] [def]
1667 * \li Params: <NAME>: The name of the macro, e.g. "mymacro".\n
1668 <NARGS>: The number of parameters of the macro. Default is 0.
1669 "def": Has no effect anymore, just for compatibility with former LyX versions.
1670 * \li Origin: ale, 10 May 1997; sts, 21 Dec 2007
1673 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
1675 * \var lyx::FuncCode lyx::LFUN_MATH_MUTATE
1676 * \li Action: Mutates the type of math inset to the newly selected one.
1677 * \li Syntax: math-mutate <TYPE>
1678 * \li Params: <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
1679 multline|gather|flalign
1680 * \li Origin: Andre, 23 May 2001
1683 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
1685 * \var lyx::FuncCode lyx::LFUN_MATH_SPACE
1686 * \li Action: Inserts space into math expression.
1687 * \li Notion: Use spacebar after entering this space to change type of space.
1688 * \li Syntax: math-space [<TYPE>] [<LEN>]
1689 * \li Params: <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace \n
1690 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad \n
1691 custom space: hspace \n
1692 "," used by default.\n
1693 Note that ! is equivalent to negthinspace, , = thinspace,
1694 : = medspace, and ; = thickspace.\n
1695 <LEN>: length for custom spaces (hspace)
1696 * \li Origin: Andre, 25 Jul 2001; sanda, 16 Jun 2008
1699 { LFUN_MATH_SPACE, "math-space", Noop, Math },
1701 * \var lyx::FuncCode lyx::LFUN_MATH_MATRIX
1702 * \li Action: Inserts a matrix.
1703 * \li Syntax: math-matrix <COLS> <ROWS> [<ALIGN>]
1704 * \li Params: <ALIGN>: Alignment is a word composed of the vertical alignment
1705 (b, c or t) (i.e. 1 char) and the horizontal alignments
1706 (l, c or r) (i.e. <COL> chars).
1707 * \li Sample: math-matrix 3 3 bccc
1710 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
1712 * \var lyx::FuncCode lyx::LFUN_MATH_AMS_MATRIX
1713 * \li Action: Inserts a matrix.
1714 * \li Syntax: math-matrix <COLS> <ROWS> [<DECORATION>]
1715 * \li Params: <DECORATION>: Decoration determines the LaTeX name of the matrix
1716 that should be created.
1717 * \li Sample: math-ams-matrix 3 3 bmatrix
1720 { LFUN_MATH_AMS_MATRIX, "math-ams-matrix", Noop, Math },
1722 * \var lyx::FuncCode lyx::LFUN_MATH_MODE
1723 * \li Action: In text mode enters math mode (i.e. puts math insets on the current
1724 cursor position), in math mode enters text mode inside math expression.
1725 * \li Notion: If there is some selected text, it puts the text inside created math box.
1726 * \li Syntax: math-mode [on|<ARG>]
1727 * \li Params: <ARG>: eventual argument (LaTeX code) is passed to #LFUN_MATH_INSERT .\n
1728 "on": allow only entering of math mode from text mode.
1729 * \li Origin: Alejandro, 4 Jun 1996
1732 { LFUN_MATH_MODE, "math-mode", Noop, Math },
1734 * \var lyx::FuncCode lyx::LFUN_REGEXP_MODE
1735 * \li Action: Enters regexp mode (i.e., puts regexp insets on the current
1736 cursor position). Used by the advanced search dialog.
1737 * \li Notion: If there is any selected text, then it is moved inside the created
1739 * \li Syntax: regexp-mode [<ARG>]
1740 * \li Params: <ARG>: eventual argument (regular expression).
1741 * \li Origin: Tommaso, 4 Oct 2008
1744 { LFUN_REGEXP_MODE, "regexp-mode", Noop, Math },
1746 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
1747 * \li Action: Toggles numbering of the current formula line.
1748 * \li Notion: Must be in display formula mode.
1749 * \li Syntax: math-number-line-toggle
1750 * \li Origin: Alejandro, 18 Jun 1996
1753 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
1755 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
1756 * \li Action: Toggles numbering/labeling of the current formula.
1757 * \li Notion: Must be in display formula mode.
1758 * \li Syntax: math-number-toggle
1759 * \li Origin: Alejandro, 4 Jun 1996
1762 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
1764 * \var lyx::FuncCode lyx::LFUN_MATH_EXTERN
1765 * \li Action: Calls external program and passes the current expression/equation
1766 as an argument for the calculation in the format appropriate to the
1768 * \li Notion: Selection can be used to determine the input for the external program.
1769 * \li Syntax: math-extern <LANG> [<COMMAND>]
1770 * \li Params: <LANG>: octave|maxima|maple|mathematica|script \n
1771 where "script" stands for the external script (normalized
1772 expression will be passed)
1773 * \li Origin: Andre, 24 Apr 2001
1774 * \li Sample: math-extern maple simplify
1777 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
1779 * \var lyx::FuncCode lyx::LFUN_MATH_SIZE
1780 * \li Action: Changes arbitrarily the size used by math fonts inside a context.
1781 * \li Notion: Provides an interface to the LaTeX math mode font size commands.
1782 * \li Syntax: math-size <STYLE>
1783 * \li Params: <STYLE>: \displaystyle|\textstyle|\scriptstyle|\scriptscriptstyle
1784 * \li Origin: Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
1787 { LFUN_MATH_SIZE, "math-size", Noop, Math },
1789 * \var lyx::FuncCode lyx::LFUN_MATH_FONT_STYLE
1790 * \li Action: Changes the text style used in math.
1791 * \li Syntax: math-font-style <STYLE>
1792 * \li Params: <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf|textnormal\n
1793 |textrm|textsf|texttt|textbf|textmd|textit|textsc|textsl|textup
1794 * \li Origin: vfr, 9 jan 2009
1797 { LFUN_MATH_FONT_STYLE, "math-font-style", Noop, Math },
1799 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
1800 * \li Action: Unfold a Math Macro.
1801 * \li Notion: Unfold the Math Macro the cursor is in, i.e.
1803 * \li Syntax: math-macro-unfold
1804 * \li Origin: sts, 06 January 2008
1807 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
1809 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
1810 * \li Action: Fold a Math Macro.
1811 * \li Notion: Fold the Math Macro the cursor is in if it was
1812 unfolded, i.e. displayed as \foo before.
1813 * \li Syntax: math-macro-fold
1814 * \li Origin: sts, 06 January 2008
1817 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
1819 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
1820 * \li Action: Add a parameter.
1821 * \li Notion: Add a parameter to a Math Macro.
1822 * \li Params: <NUM>: The number of the parameter behind which the new one
1823 will be added (1 for the first, i.e. use 0 for add a
1824 parameter at the left), defaults to the last one.
1825 * \li Syntax: math-macro-add-param <NUM>
1826 * \li Origin: sts, 06 January 2008
1829 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
1831 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
1832 * \li Action: Remove the last parameter.
1833 * \li Notion: Remove the last parameter of a Math Macro and
1834 remove its value in all instances of the macro
1836 * \li Params: <NUM>: The number of the parameter to be deleted (1 for
1837 the first), defaults to the last one.
1838 * \li Syntax: math-macro-remove-param <NUM>
1839 * \li Origin: sts, 06 January 2008
1842 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
1844 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
1845 * \li Action: Append a greedy parameter.
1846 * \li Notion: Append a greedy parameter to a Math Macro which
1847 eats the following mathed cell in every instance of
1848 the macro in the buffer.
1849 * \li Syntax: math-macro-append-greedy-param
1850 * \li Origin: sts, 06 January 2008
1853 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
1855 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
1856 * \li Action: Remove a greedy parameter.
1857 * \li Notion: Remove a greedy parameter of a Math Macro and spit
1858 out the values of it in every instance of the macro
1859 in the buffer. If it is an optional parameter the [valud]
1861 * \li Syntax: math-macro-remove-greedy-param
1862 * \li Origin: sts, 06 January 2008
1865 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
1867 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
1868 * \li Action: Make a parameter optional.
1869 * \li Notion: Turn the first non-optional parameter of a Math Macro
1870 into an optional parameter with a default value.
1871 * \li Syntax: math-macro-make-optional
1872 * \li Origin: sts, 06 January 2008
1875 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
1877 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
1878 * \li Action: Make a parameter non-optional.
1879 * \li Notion: Turn the last optional parameter of a Math Macro
1880 into a non-optional parameter. The default value is
1881 remembered to be reused later if the user changes his mind.
1882 * \li Syntax: math-macro-make-nonoptional
1883 * \li Origin: sts, 06 January 2008
1886 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
1888 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
1889 * \li Action: Add an optional parameter.
1890 * \li Notion: Insert an optional parameter just behind the
1891 already existing optional parameters.
1892 * \li Syntax: math-macro-add-optional-param
1893 * \li Origin: sts, 06 January 2008
1896 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
1898 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
1899 * \li Action: Remove the last optional parameter.
1900 * \li Notion: Remove the last optional parameter of a Math Macro and
1901 remove it in all the instances of the macro in the buffer.
1902 * \li Syntax: math-macro-remove-optional-param
1903 * \li Origin: sts, 06 January 2008
1906 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
1908 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
1909 * \li Action: Add a greedy optional parameter.
1910 * \li Notion: Add a greedy optional parameter which eats the value
1911 from the following cells in mathed which are in the [value]
1913 * \li Syntax: math-macro-add-greedy-optional-param
1914 * \li Origin: sts, 06 January 2008
1917 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
1919 * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
1920 * \li Action: Only active in Math Macro definition.
1921 * \li Notion: Dummy function which is only active in a Math Macro definition.
1922 It's used to toggle the Math Macro toolbar if the cursor moves
1923 into a Math Macro definition.
1924 * \li Syntax: in-mathmacrotemplate
1925 * \li Origin: sts, 06 January 2008
1928 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
1931 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
1932 * \li Action: Moves the current paragraph downwards in the document.
1933 * \li Syntax: paragraph-move-down
1934 * \li Origin: Edwin, 8 Apr 2006
1937 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
1939 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
1940 * \li Action: Moves the current paragraph upwards in the document.
1941 * \li Notion: Movement through the document will possibly break the paragraph-depth
1942 (e.g. itemize structure).
1943 * \li Syntax: paragraph-move-up
1944 * \li Origin: Edwin, 8 Apr 2006
1947 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
1950 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP
1951 * \li Action: Move the cursor to the next paragraph (or beginning of the current one)
1952 in upward direction.
1953 * \li Syntax: paragraph-up
1954 * \li Origin: Asger, 1 Oct 1996
1957 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
1959 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP_SELECT
1960 * \li Action: Move the cursor and select the text to the next paragraph (or
1961 beginning of the current one) in upward direction.
1962 * \li Syntax: paragraph-up-select
1963 * \li Origin: Asger, 1 Oct 1996
1966 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
1968 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN
1969 * \li Action: Move the cursor to the next paragraph (or beginning of the current one)
1970 in downward direction.
1971 * \li Syntax: paragraph-down
1972 * \li Origin: Asger, 1 Oct 1996
1975 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
1977 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN_SELECT
1978 * \li Action: Move the cursor and select the text to the next paragraph (or
1979 beginning of the current one) in downward direction.
1980 * \li Syntax: paragraph-down-select
1981 * \li Origin: Asger, 1 Oct 1996
1984 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
1986 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
1987 * \li Action: Jump to a paragraph given by its id number and optionally the
1988 desired position within the paragraph.
1989 * \li Notion: Note that id number of paragraph is not the sequential number of paragraph
1990 seen on the screen. Moreover the id is unique for all opened buffers (documents).
1991 * \li Syntax: paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
1992 * \li Params: <PAR_ID_NUMBER>: paragraph id \n
1993 <POSITION_IN_PAR>: desired position within the paragraph
1994 * \li Origin: Dekel, 26 Aug 2000
1997 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly | NoInternal, Edit },
1999 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_BREAK
2000 * \li Action: Breaks the current paragraph at the current location.
2001 * \li Notion: Removes the selection.
2002 * \li Syntax: paragraph-break [<LAYOUT>]
2003 * \li Params: <LAYOUT>: "inverse" - decreases depth by one (or change layout
2004 to default layout) when the cursor is at the end of
2008 { LFUN_PARAGRAPH_BREAK, "paragraph-break", Noop, Edit },
2010 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
2011 * \li Action: Change paragraph settings.
2012 * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
2013 This function only modifies, and does not override, existing settings.
2014 Note that the "leftindent" indent setting is deprecated.
2015 * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
2016 * \li Params: <INDENT>: \noindent|\indent|\indent-toggle|\leftindent LENGTH\n
2017 <SPACING>: \paragraph_spacing default|single|onehalf|double|other SIZE \n
2018 <ALIGN>: \align block|left|right|center|default\n
2019 <OTHERS>: \labelwidthstring WIDTH|\start_of_appendix
2020 * \li Origin: rgh, Aug 15 2007
2023 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
2025 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
2026 * \li Action: Change paragraph settings.
2027 * \li Notion: Overwrite all nonspecified settings to the default ones.
2028 Use paragraph-params lfun if you don't want to overwrite others settings.
2029 * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
2030 * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
2031 * \li Origin: leeming, 30 Mar 2004
2034 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
2036 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UPDATE
2037 * \li Action: Updates the values inside the paragraph dialog from the paragraph.
2038 * \li Notion: This is an internal LFUN, not to be used by users. Called internally
2039 by #LFUN_DIALOG_UPDATE.
2040 * \li Origin: leeming, 13 Mar 2003
2043 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
2046 * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
2047 * \li Action: Move the current group in the upward direction in the
2048 structure of the document.
2049 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
2050 the whole substructure of the group.
2051 * \li Syntax: outline-up
2052 * \li Origin: Vermeer, 23 Mar 2006
2055 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
2057 * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
2058 * \li Action: Move the current group in the downward direction in the
2059 structure of the document.
2060 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
2061 the whole substructure of the group.
2062 * \li Syntax: outline-down
2063 * \li Origin: Vermeer, 23 Mar 2006
2066 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
2068 * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
2069 * \li Action: Moves the current group in the downward direction in the
2070 hierarchy of the document structure.
2071 * \li Notion: Part -> Chapter -> Section -> etc.
2072 * \li Syntax: outline-in
2073 * \li Origin: Vermeer, 23 Mar 2006
2076 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
2078 * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
2079 * \li Action: Moves the current group in the upward direction in the
2080 hierarchy of the document structure.
2081 * \li Notion: Part <- Chapter <- Section <- etc.
2082 * \li Syntax: outline-out
2083 * \li Origin: Vermeer, 23 Mar 2006
2086 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
2089 * \var lyx::FuncCode lyx::LFUN_INSET_EDIT
2090 * \li Action: Edit the inset at cursor with an external application,
2091 if one is attributed.
2092 * \li Syntax: inset-edit [<INSET_PARAMS>]
2093 * \li Params: <INSET_PARAMS>: Parameters for the inset. \n
2094 Currently only the filename will be considered.
2095 * \li Origin: JSpitzm, 27 Apr 2006
2098 { LFUN_INSET_EDIT, "inset-edit", ReadOnly | AtPoint, Edit },
2101 * \var lyx::FuncCode lyx::LFUN_TABULAR_INSERT
2102 * \li Action: Inserts table into the document.
2103 * \li Notion: See #LFUN_INSET_MODIFY for some more details
2104 about tabular modifications.
2105 * \li Syntax: tabular-insert [<ROWS> <COLUMNS>]
2106 * \li Params: In case no arguments are given show insert dialog.
2107 * \li Origin: Jug, 12 Apr 2000
2110 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
2113 * \var lyx::FuncCode lyx::LFUN_CELL_BACKWARD
2114 * \li Action: Moves the cursor to the previous cell inside the table.
2115 * \li Syntax: cell-backward
2116 * \li Origin: Jug, 22 May 2000
2119 { LFUN_CELL_BACKWARD, "cell-backward", ReadOnly | NoUpdate, Edit },
2121 * \var lyx::FuncCode lyx::LFUN_CELL_FORWARD
2122 * \li Action: Moves the cursor to the next cell inside the table.
2123 * \li Syntax: cell-forward
2126 { LFUN_CELL_FORWARD, "cell-forward", ReadOnly | NoUpdate, Edit },
2128 * \var lyx::FuncCode lyx::LFUN_CELL_SPLIT
2129 * \li Action: Splits cell and shifts right part to the next cell (inside the math grid).
2130 * \li Syntax: cell-split
2131 * \li Origin: Ale, 15 May 1997
2134 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
2137 * \var lyx::FuncCode lyx::LFUN_VC_REGISTER
2138 * \li Action: Register the document as an file inside version control system.
2139 * \li Notion: File is registered inside cvs, svn or rcs repository acording to the existence
2140 of cvs/svn/rcs entries in the document's directory. \n
2141 See LyX Additional Features Manual (Version Control Chapter) for additional
2143 * \li Syntax: vc-register
2144 * \li Origin: Lgb, 1 Jul 1997
2147 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
2149 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_IN
2150 * \li Action: Checks-in/commits the changes of the registered file to the repository.
2151 * \li Notion: In RCS case this also unlocks the file.
2152 * \li Syntax: vc-check-in
2153 * \li Origin: Lgb, 1 Jul 1997
2156 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
2158 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_OUT
2159 * \li Action: Checks-out the document for edit (and locks it in some cases).
2160 * \li Syntax: vc-check-out
2161 * \li Origin: Lgb, 1 Jul 1997
2164 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
2166 * \var lyx::FuncCode lyx::LFUN_VC_REVERT
2167 * \li Action: Reverts the document to the last check-in/commit in VCS.
2168 * \li Syntax: vc-revert
2169 * \li Origin: Lgb, 1 Jul 1997
2172 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
2174 * \var lyx::FuncCode lyx::LFUN_VC_UNDO_LAST
2175 * \li Action: Undo last check-in.
2176 * \li Notion: This is currently implemented only for RCS.
2177 * \li Syntax: vc-check-out
2178 * \li Origin: Lgb, 1 Jul 1997
2181 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
2183 * \var lyx::FuncCode lyx::LFUN_VC_COMMAND
2184 * \li Action: Executes external command. This command is intended to support
2185 additional VCS commands.
2186 * \li Syntax: vc-command <FLAG> <PATH> <COMMAND>
2187 * \li Params: <FLAG>: Flags for the command can be combined together.\n
2188 U - dUmmy - no flags \n
2189 D - Doc - need document loaded to proceed \n
2190 I - dIrty - mark document dirty \n
2191 R - Reload - ensure that the document is saved and reload it after command execution \n
2192 M - Message - ask for input string (commit message)\n
2193 <PATH>: path where to start. $$p will be replaced by the current document path.\n
2194 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current
2195 document(with absolute path)/path/message.
2196 * \li Sample: vc-command DR $$p "svn up"
2197 * \li Origin: sanda, 13 Jan 2009
2200 { LFUN_VC_COMMAND, "vc-command", NoBuffer | ReadOnly, System },
2202 * \var lyx::FuncCode lyx::LFUN_VC_LOCKING_TOGGLE
2203 * \li Action: Toggles the locking property of the edited file.
2204 * \li Notion: This is currently implemented only for SVN.
2205 * \li Syntax: vc-locking-toggle
2206 * \li Origin: sanda, 25 Jun 2009
2209 { LFUN_VC_LOCKING_TOGGLE, "vc-locking-toggle", ReadOnly, System },
2211 * \var lyx::FuncCode lyx::LFUN_VC_REPO_UPDATE
2212 * \li Action: Update the local archive directory in which resides
2213 the current document with the remote repository.
2214 * \li Syntax: vc-repo-update
2215 * \li Origin: sanda, 16 Oct 2009
2218 { LFUN_VC_REPO_UPDATE, "vc-repo-update", ReadOnly, System },
2220 * \var lyx::FuncCode lyx::LFUN_VC_COMPARE
2221 * \li Action: Compares two revisions of the same file under version control.
2222 * \li Syntax: vc-compare [<REV1>] [<REV2>]
2223 * \li Params: Revision number either points directly to commit in history
2224 or if negative number -x it points to (last commit - x).\n
2225 In RCS we subtract only in the last number of revision specification.
2226 Special case "0" is reserved for the last committed revision.\n
2227 <REV1>: Older file.\n
2228 <REV2>: Newer file. Used only if REV1 > 0.\n
2229 If no parameter is given, interactive dialog will be shown.
2230 * \li Sample: Compare current document against last commit\n
2232 Compare current document against current revision - 5 commits\n
2234 Compare revisions 120 and 155\n
2236 * \li Origin: sanda, 12 Feb 2010
2239 { LFUN_VC_COMPARE, "vc-compare", ReadOnly, System },
2242 * \var lyx::FuncCode lyx::LFUN_CHANGES_TRACK
2243 * \li Action: Toggles change tracking to on/off.
2244 * \li Syntax: changes-track
2245 * \li Origin: levon, 1 Oct 2002
2248 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
2250 * \var lyx::FuncCode lyx::LFUN_CHANGES_OUTPUT
2251 * \li Action: Toggles showing of change tracking in typesetted output.
2252 * \li Syntax: changes-output
2253 * \li Origin: jspitzm, 21 Jan 2005
2256 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
2258 * \var lyx::FuncCode lyx::LFUN_CHANGE_NEXT
2259 * \li Action: Moves the cursor to the position of the next change
2260 of the change tracking records.
2261 * \li Syntax: change-next
2262 * \li Origin: schmitt, 4 Oct 2006
2265 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
2267 * \var lyx::FuncCode lyx::LFUN_CHANGE_PREVIOUS
2268 * \li Action: Moves the cursor to the position of the previous change
2269 of the change tracking records.
2270 * \li Syntax: change-previous
2271 * \li Origin: vfr, 4 Apr 2009
2274 { LFUN_CHANGE_PREVIOUS, "change-previous", ReadOnly, Edit },
2276 * \var lyx::FuncCode lyx::LFUN_CHANGES_MERGE
2277 * \li Action: Open change tracking dialog for merging and moves the cursor
2278 to the position of the next change.
2279 * \li Syntax: changes-merge
2280 * \li Origin: Levon, 16 Oct 2002
2283 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
2285 * \var lyx::FuncCode lyx::LFUN_CHANGE_ACCEPT
2286 * \li Action: Accepts tracked change inside the selection.
2287 * \li Syntax: change-accept
2288 * \li Origin: Levon, 16 Oct 2002
2291 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
2293 * \var lyx::FuncCode lyx::LFUN_CHANGE_REJECT
2294 * \li Action: Rejects tracked change inside the selection.
2295 * \li Syntax: change-reject
2296 * \li Origin: Levon, 16 Oct 2002
2299 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
2301 * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_ACCEPT
2302 * \li Action: Accepts all tracked changes in the document.
2303 * \li Syntax: all-changes-accept
2304 * \li Origin: Levon, 16 Oct 2002
2307 { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
2309 * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_REJECT
2310 * \li Action: Rejects all tracked changes in the document.
2311 * \li Notion: Reject does not work recursively; the user may have to repeat the operation.
2312 * \li Syntax: all-changes-reject
2313 * \li Origin: Levon, 16 Oct 2002
2316 { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
2319 * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
2320 * \li Action: Apply data for an inset.
2321 * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
2322 be applied. This is either changed to #LFUN_INSET_MODIFY or
2323 #LFUN_INSET_INSERT depending on the context where it is called.
2324 * \li Syntax: inset-apply <ARGS>
2325 * \li Params: See #LFUN_INSET_INSERT .
2328 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
2330 * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE
2331 * \li Action: Dissolve the current inset into text.
2332 * \li Syntax: inset-dissolve [<INSET>]
2333 * \li Params: <INSET>: this can be used to make sure the right kind of inset
2334 is dissolved. For example "dissolve" entry in the charstyles
2335 sub-menu should only dissolve the charstyle inset, even if the
2336 cursor is inside several nested insets of different type.\n
2337 For values see #lyx::InsetLayout::lyxtype_ .
2338 * \li Origin: JSpitz, 7 Aug 2006
2341 { LFUN_INSET_DISSOLVE, "inset-dissolve", AtPoint, Edit },
2343 * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
2344 * \li Action: Insert new inset (type given by the parameters).
2345 * \li Syntax: inset-insert <INSET> <ARGS>
2346 * \li Params: <INSET>: <bibitem|bibtex|citation|ert|listings|external|graphics|tabular|\n
2347 hyperlink|include|index|label|line|nomencl|vspace|ref|toc|script>\n
2348 <ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
2349 * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
2350 where <label name> is the name of the referenced label and
2351 <Format> is one of the following: \n
2352 ref -- <reference> \n
2353 eqref -- (<reference>) \n
2354 pageref -- <page> \n
2355 vpageref -- on <page> \n
2356 vref -- <reference> on <page> \n
2357 formatted -- Formatted reference
2360 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
2362 * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
2363 * \li Action: Modify some properties of an inset.
2364 * \li Notion: Used for bibitem, bibtex, box, branch, command, ert, external,
2365 floats, graphics, include, index, info, label,
2366 listings, newline, newpage, nomencl, note, phantom,
2367 ref, space, tabular, vspace, wrap insets.
2368 * \li Syntax: inset-modify <INSET> <ARGS>
2369 * \li Syntax: inset-modify changetype <TYPE>
2370 * \li Syntax: inset-modify tabular <FEATURE> [<ARG>]
2371 * \li Params: Generally see #LFUN_INSET_INSERT for further details.\n
2372 In case that <INSET> is "tabular" various math-environment features
2373 are handled as well, e.g. add-vline-left/right for the Grid/Array environment.\n
2374 <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|copy-column|
2375 toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
2376 align-left|align-right|align-center|align-block|align-decimal|set-decimal-point|
2377 valign-top|valign-bottom|valign-middle|longtabular-align-left|
2378 longtabular-align-center|longtabular-align-right|m-align-left|m-align-right|
2379 m-align-center|m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|
2380 set-all-lines|unset-all-lines|set-longtabular|unset-longtabular|set-pwidth|
2381 set-mpwidth|set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|
2382 set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|
2383 unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|
2384 set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
2385 set-special-column|set-special-multicolumn|set-special-multirow|
2386 set-booktabs|unset-booktabs|set-top-space|set-bottom-space|
2387 set-interline-space|set-border-lines|tabular-valign-top|
2388 tabular-valign-middle|tabular-valign-bottom|set-tabular-width \n
2389 <ARG>: additional argument for some commands, use debug mode to explore its values.
2390 * \li Sample: inset-modify note Note Comment \n
2391 inset-modify changetype Ovalbox
2394 { LFUN_INSET_MODIFY, "inset-modify", AtPoint, Edit },
2396 * \var lyx::FuncCode lyx::LFUN_INSET_DIALOG_UPDATE
2397 * \li Action: Updates the values inside the dialog from the inset.
2398 * \li Notion: This is an internal LFUN, not to be used by users. Called internally
2399 by #LFUN_DIALOG_UPDATE
2400 * \li Params: <DIALOG-NAME>
2401 * \li Origin: leeming, 25 Feb 2003
2404 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
2406 * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
2407 * \li Action: Open the inset's properties dialog.
2408 * \li Notion: Used for bibitem, bibtex, box, branch, citation, ert, external,
2409 float, graphics, href, include, index, index_print, label, line,
2410 listings, note, phantom, ref, space, tabular, vspace, wrap insets.
2411 * \li Syntax: inset-settings <INSET>
2412 * \li Params: <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|\n
2413 graphics|href|include|index|index_print|label|line|\n
2414 listings|note|phantom|ref|space|tabular|vspace|wrap>.
2417 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly | AtPoint, Edit },
2419 * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
2420 * \li Action: Toggles the collapsible inset at cursor position,
2421 or the inset we are currently in.
2422 * \li Syntax: inset-toggle [<ARG>]
2423 * \li Params: <ARG>: <open|close|toggle|assign>. \n
2424 open/close/toggle are for collapsible insets. toggle is used when no argument is given.\n
2425 assign synchronize the branch-inset with activation status of the branch.
2426 Used for global toggling when changed activation.
2427 * \li Origin: lasgouttes, 19 Jul 2001
2430 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly | AtPoint, Edit },
2432 * \var lyx::FuncCode lyx::LFUN_INSET_FORALL
2433 * \li Action: Apply the given commands on insets of a given name.
2434 * \li Notion: WARNING: use at your own risks; this function gives
2435 you too many ways of shooting yourself in the foot.
2436 A typical example is
2437 inset-forall Note note-insert
2438 which starts an infinite loop. This is mitigated by the fact
2439 that the number of actions is arbitrarily limited to 100000.
2440 Note also that inset-forall does not update metrics between
2441 iterations, which can lead to bugs. This has to be eventually
2443 * \li Syntax: inset-forall <NAME> <LFUN-COMMAND> \n
2444 <NAME>: Type of Inset. If <NAME> is *, all insets are matched.
2445 The name is used like for InsetLayout in layout files: "Note"
2446 matches all note insets, while "Note:Note" only matches LyX
2448 * \li Sample: Remove all index insets: \n
2449 inset-forall Index delete-char-forward \n
2450 Close all Notes (also works for a particular branch, for example): \n
2451 inset-forall Note inset-toggle close \n
2452 Transform all yellow notes to comments \n
2453 inset-forall Note:Note inset-modify note Note Comment \n
2454 Try to put LyX in an infinite loop if there is at least a Note: \n
2455 inset-forall Note char-backward
2456 * \li Origin: lasgouttes, 27 Nov 2009
2459 { LFUN_INSET_FORALL, "inset-forall", ReadOnly, Edit },
2462 * \var lyx::FuncCode lyx::LFUN_GRAPHICS_RELOAD
2463 * \li Action: Reloads the image if necessary.
2464 * \li Syntax: graphics-reload
2465 * \li Origin: vfr, 10 Aug 2009
2468 { LFUN_GRAPHICS_RELOAD, "graphics-reload", ReadOnly | AtPoint, Edit },
2470 * \var lyx::FuncCode lyx::LFUN_SET_GRAPHICS_GROUP
2471 * \li Action: Set the group for the graphics inset on the cursor position.
2472 * \li Syntax: set-graphics-group [<GROUP>]
2473 * \li Params: <GROUP>: Id for an existing group. In case the Id is an empty string,
2474 the graphics inset is removed from the current group.
2475 * \li Origin: sanda, 6 May 2008
2478 { LFUN_SET_GRAPHICS_GROUP, "set-graphics-group", Noop, Edit },
2481 * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
2482 * \li Action: Moves the cursor out of the current slice, going forward.
2483 * \li Notion: Cursor movement within an inset may be different than cursor
2484 movement in the surrounding text. This action should be called
2485 automatically by the cursor movement within the inset, when
2486 movement within the inset has ceased (reached the end of the
2487 last paragraph, for example), in order to move correctly
2488 back into the surrounding text.
2491 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
2493 * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
2494 * \li Action: Moves the cursor out of the current slice, going backwards.
2495 * \li Notion: See also #LFUN_FINISHED_FORWARD.
2498 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
2500 * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
2501 * \li Action: Moves the cursor out of the current slice, going right.
2502 * \li Notion: See also #LFUN_FINISHED_FORWARD
2505 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
2507 * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
2508 * \li Action: Moves the cursor out of the current slice, going left.
2509 * \li Notion: See also #LFUN_FINISHED_FORWARD.
2512 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
2515 * \var lyx::FuncCode lyx::LFUN_LANGUAGE
2516 * \li Action: Set language from the current cursor position.
2517 * \li Syntax: language <LANG>
2518 * \li Params: <LANG>: Requested language. Look in lib/languages for
2520 * \li Origin: Dekel, 2 Mar 2000
2523 { LFUN_LANGUAGE, "language", Noop, Edit },
2526 * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
2527 * \li Action: Goto a label.
2528 * \li Syntax: label-goto [<LABEL>]
2529 * \li Params: <LABEL>: Requested label. If no label is given and reference
2530 is on cursor position, Bookmark 0 is saved and
2531 cursor moves to the position of referenced label.
2532 * \li Origin: Ale, 6 Aug 1997
2535 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
2537 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT
2538 * \li Action: Inserts label to text or displayed formula.
2539 * \li Syntax: label-insert [<LABEL>]
2540 * \li Params: <LABEL>: Requested label. If no label is given dialog requesting
2541 name will be opened.
2544 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
2546 * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
2547 * \li Action: Go to the next label or cross-reference.
2548 * \li Syntax: reference-next
2549 * \li Origin: Dekel, 14 Jan 2001
2552 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
2555 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
2556 * \li Action: Moves the cursor to the numbered bookmark, opening the file
2557 if necessary. Note that bookmarks are saved per-session, not
2559 * \li Notion: Bookmark 0 has a special purpose. It is automatically set \n
2560 1. to the paragraph you are currently editing \n
2561 2. to the paragraph from where you are jumping to the last-edited
2562 position (jump-back feature) \n
2563 3. when jumping from crossreference to the requested label by
2565 * \li Syntax: bookmark-goto <NUMBER>
2566 * \li Params: <NUMBER>: the number of the bookmark to restore.
2567 * \li Origin: Dekel, 27 January 2001
2570 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
2572 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
2573 * \li Action: Save a bookmark.
2574 * \li Notion: Saves a numbered bookmark to the sessions file. The number
2575 must be between 1 and 9, inclusive. Note that bookmarks are
2576 saved per-session, not per file.
2577 * \li Syntax: bookmark-save <NUMBER>
2578 * \li Params: <NUMBER>: the number of the bookmark to save.
2579 * \li Origin: Dekel, 27 January 2001
2582 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
2584 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
2585 * \li Action: Clears the list of saved bookmarks.
2586 * \li Syntax: bookmark-clear
2587 * \li Origin: bpeng, 31 October 2006
2590 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
2593 * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
2594 * \li Action: Open the given help file according to the language setting.
2595 * \li Syntax: help-open <FILE>[.lyx]
2596 * \li Params: <FILE>: any document from (/usr/share/)doc directory.
2597 * \li Origin: Jug, 27 Jun 1999
2600 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
2602 * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
2603 * \li Action: Terminates the current LyX instance.
2604 * \li Notion: Terminates the current LyX instance, asking whether to save
2605 modified documents, etc.
2606 * \li Syntax: lyx-quit
2609 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
2611 * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
2612 * \li Action: Toggles visibility of a given toolbar between on/off/auto.
2613 * \li Notion: Skipping "auto" when allowauto is false.
2614 * \li Syntax: toolbar-toggle <NAME> [allowauto]
2615 * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|\n
2616 minibuffer|review|view/update|math_panels|vcs|
2617 view-others|update-others
2618 * \li Origin: Edwin, 21 May 2007
2621 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
2623 * \var lyx::FuncCode lyx::LFUN_MENU_OPEN
2624 * \li Action: Opens the menu given by its name.
2625 * \li Syntax: menu-open <NAME>
2626 * \li Params: <NAME>: menu name. See various .inc files in lib/ui for candidates.
2629 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
2631 * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
2632 * \li Action: Various UI visibility-toggling actions.
2633 * \li Syntax: ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
2634 * \li Params: statusbar : Toggle visibility of the statusbar.\n
2635 menubar : Toggle visibility of the menubar.\n
2636 scrollbar : Toggle visibility of the scrollbar.\n
2637 frame : Toggle visibility of the frames around editing window.\n
2638 fullscreen : Toggle fullscreen mode. This also covers calling the
2639 previous functions. However #LFUN_TOOLBAR_TOGGLE for the
2640 custom tweaks of the toolbars should be used.
2641 * \li Origin: sanda, 9 Feb 2007
2644 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
2647 * \var lyx::FuncCode lyx::LFUN_WINDOW_NEW
2648 * \li Action: Creates new empty LyX window.
2649 * \li Notion: Already opened documents from the previous window can be found under View menu.
2650 * \li Syntax: window-new [<GEOMETRY>]
2651 * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently
2652 accepted only on Windows platform.
2653 * \li Origin: Abdel, 21 Oct 2006
2656 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
2658 * \var lyx::FuncCode lyx::LFUN_WINDOW_CLOSE
2659 * \li Action: Closes the current LyX window.
2660 * \li Syntax: window-close
2661 * \li Origin: Abdel, 23 Oct 2006
2664 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
2667 * \var lyx::FuncCode lyx::LFUN_VIEW_SPLIT
2668 * \li Action: Creates another split view of current buffer.
2669 * \li Notion: All split views act in the same way independently.
2670 * \li Syntax: view-split <vertical|horizontal>
2671 * \li Params: horizontal : The work areas are laid out side by side.\n
2672 vertical : The work areas laid out vertically.
2673 * \li Origin: Abdel, 20 Feb 2008
2676 { LFUN_VIEW_SPLIT, "view-split", ReadOnly, Buffer },
2679 * \var lyx::FuncCode lyx::LFUN_VIEW_CLOSE
2680 * \li Action: Close the current document work area.
2681 * \li Notion: Close the current work area. If no other work areas are showing the buffer,
2682 then close the associated buffer as well.
2683 * \li Syntax: view-close
2684 * \li Origin: Tommaso, 15 Sep 2012
2687 { LFUN_VIEW_CLOSE, "view-close", ReadOnly, Buffer },
2690 * \var lyx::FuncCode lyx::LFUN_TAB_GROUP_CLOSE
2691 * \li Action: Close the current tab group.
2692 * \li Notion: This only closes the work areas, not the buffers themselves.
2693 The still opened buffers can be visualized in another tab group.
2694 * \li Syntax: tab-group-close
2695 * \li Origin: Abdel, 21 Feb 2008
2698 { LFUN_TAB_GROUP_CLOSE, "tab-group-close", ReadOnly, Buffer },
2701 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW
2702 * \li Action: Shows hidden dialog or creates new one for a given function/inset settings etc.
2703 * \li Syntax: dialog-show <NAME> [<DATA>]
2704 * \li Params: <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|\n
2705 compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|\n
2706 graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimiter|\n
2707 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|\n
2708 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|\n
2709 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL> \n
2710 <SPECIAL>: latexlog|vclog \n
2711 <DATA>: data, usually settings for the given dialog. Use debug mode for the
2713 * \li Origin: leeming, 17 Jun 2003
2716 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
2718 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW_NEW_INSET
2719 * \li Action: Shows hidden dialog or create new one for a given inset settings etc.
2720 * \li Notion: Internally uses #LFUN_DIALOG_SHOW with processed data for a given inset.
2721 * \li Syntax: dialog-show-new-inset <NAME> [<DATA>]
2722 * \li Params: See #LFUN_DIALOG_SHOW .
2723 * \li Origin: leeming, 25 Feb 2003
2726 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
2728 * \var lyx::FuncCode lyx::LFUN_DIALOG_UPDATE
2729 * \li Action: Updates the dialog values from the inset/paragraph/document.
2730 * \li Syntax: dialog-update <NAME>
2731 * \li Params: <NAME>: paragraph|prefs|<INSET> \n
2733 * \li Origin: leeming, 25 Feb 2003
2736 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
2738 * \var lyx::FuncCode lyx::LFUN_DIALOG_HIDE
2739 * \li Action: Hides showed dialog. Counterpart to #LFUN_DIALOG_SHOW .
2740 * \li Syntax: dialog-hide <NAME>
2741 * \li Params: See #LFUN_DIALOG_SHOW .
2742 * \li Origin: leeming, 25 Feb 2003
2745 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
2747 * \var lyx::FuncCode lyx::LFUN_DIALOG_TOGGLE
2748 * \li Action: Toggles dialog between showed/hidden state.
2749 * \li Notion: Internally uses #LFUN_DIALOG_SHOW , #LFUN_DIALOG_HIDE .
2750 * \li Syntax: dialog-toggle <NAME> [<DATA>]
2751 * \li Params: See #LFUN_DIALOG_SHOW .
2752 * \li Origin: JSpitzm, 30 Apr 2007
2755 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
2757 * \var lyx::FuncCode lyx::LFUN_DIALOG_DISCONNECT_INSET
2758 * \li Action: Closes opened connection to opened inset.
2759 * \li Notion: Connection is used for apply functions.
2760 * \li Syntax: dialog-disconnect-inset <INSET-NAME>
2761 * \li Origin: leeming, 25 Feb 2003
2764 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
2767 * \var lyx::FuncCode lyx::LFUN_MOUSE_PRESS
2768 * \li Action: This function is called when mouse button is pressed (inside workarea).
2769 Action depends on the context.
2770 * \li Notion: This is an internal LFUN, not to be used by users.
2771 * \li Origin: Andre, 9 Aug 2002
2774 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
2776 * \var lyx::FuncCode lyx::LFUN_MOUSE_DOUBLE
2777 * \li Action: This function is called when double click on mouse button is
2778 pressed (inside workarea). Action depends on the context.
2779 * \li Notion: This is an internal LFUN, not to be used by users.
2780 * \li Origin: Andre, 9 Aug 2002
2783 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
2785 * \var lyx::FuncCode lyx::LFUN_MOUSE_TRIPLE
2786 * \li Action: This function is called when triple click on mouse button is
2787 pressed (inside workarea). Action depends on the context.
2788 * \li Notion: This is an internal LFUN, not to be used by users.
2789 * \li Origin: Andre, 9 Aug 2002
2792 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
2794 * \var lyx::FuncCode lyx::LFUN_MOUSE_MOTION
2795 * \li Action: This function is called when mouse cursor is moving over the text.
2796 Action depends on the context.
2797 * \li Notion: This is an internal LFUN, not to be used by users.
2798 * \li Origin: Andre, 9 Aug 2002
2801 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
2803 * \var lyx::FuncCode lyx::LFUN_MOUSE_RELEASE
2804 * \li Action: This function is called when mouse button is released (inside workarea).
2805 Action depends on the context.
2806 * \li Notion: This is an internal LFUN, not to be used by users.
2807 * \li Origin: Andre, 9 Aug 2002
2810 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
2813 * \var lyx::FuncCode lyx::LFUN_KEYMAP_OFF
2814 * \li Action: Turn off the loaded keyboard map.
2815 * \li Syntax: keymap-off
2818 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
2820 * \var lyx::FuncCode lyx::LFUN_KEYMAP_PRIMARY
2821 * \li Action: Turn on the primary keyboard map.
2822 * \li Notion: Maps were widely used in past, when X-windows didn't have nowadays
2823 keyboard support. They can be still used to maintain uniform keyboard
2824 layout across the various platforms.\n
2825 The language is to be set in the Preferences dialog.
2826 * \li Syntax: keymap-primary
2829 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
2831 * \var lyx::FuncCode lyx::LFUN_KEYMAP_SECONDARY
2832 * \li Action: Turn on the secondary keyboard map.
2833 * \li Syntax: keymap-secondary
2836 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
2838 * \var lyx::FuncCode lyx::LFUN_KEYMAP_TOGGLE
2839 * \li Action: Toggles keyboard maps (first/second/off).
2840 * \li Syntax: keymap-toggle
2841 * \li Origin: leeming, 30 Mar 2004
2844 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
2847 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_LAYOUT
2848 * \li Action: Returns the current layout (that is environment) name
2849 on the cursor position.
2850 * \li Syntax: server-get-layout
2853 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
2855 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_FILENAME
2856 * \li Action: Returns path and file name of the currently edited document.
2857 * \li Syntax: server-get-filename
2860 { LFUN_SERVER_GET_FILENAME, "server-get-filename", ReadOnly, System },
2862 * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
2863 * \li Action: Sets the cursor position in LyX based on the row number of generated TeX file.
2864 * \li Notion: This can be useful for DVI inverse-search or detection of the problematic
2865 line from LaTeX compilation. Note that before this function can be used
2866 export to LaTeX output must occur (in order to map the row numbers).
2867 * \li Syntax: server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
2868 * \li Params: <FILE>: the path and filename. Environment variables are expanded in the path.
2869 In case this LFUN does not work make sure you are giving correct
2871 If the file is located inside LyX temporary directory it will be
2872 mapped back into the appropriate opened buffer (e.g. for the case
2873 of generated .tex file).\n
2874 .ext: extensions will be automatically replaced by .lyx.\n
2875 <ROW_NUMBER> The row number of the LaTeX file to which to go.
2876 * \li Sample: server-goto-file-row /home/user/example.lyx 41\n
2877 server-goto-file-row /tmp/lyx_tmpdir.XM3088/lyx_tmpbuf0/example.tex 41
2878 * \li Origin: Edmar, 23 Dec 1998
2881 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly | NoBuffer, System },
2883 * \var lyx::FuncCode lyx::LFUN_FORWARD_SEARCH
2884 * \li Action: Sets the cursor position in the previewed (dvi/pdf) file based on the row
2885 number in LyX window.
2886 * \li Notion: The external program used for forward search call can be specified in
2887 LyX Output preferences. See Additional manual for details of these
2889 * \li Syntax: forward-search
2890 * \li Origin: sanda, 14 Apr 2010
2893 { LFUN_FORWARD_SEARCH, "forward-search", ReadOnly, System },
2895 * \var lyx::FuncCode lyx::LFUN_SERVER_NOTIFY
2896 * \li Action: Sends notify message about the last key-sequence to client.
2897 * \li Notion: This can be used to grab last key-sequence used inside the LyX window.
2898 See also Debug extensions section in Additional features manual.
2899 * \li Syntax: server-notify
2902 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
2904 * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
2905 * \li Action: Sets the cursor position based on the editing area coordinates
2906 (similar to clicking on that point with left mouse button).
2907 * \li Syntax: server-set-xy <X> <Y>
2910 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
2912 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
2913 * \li Action: Returns the coordinates of cursor position in the editing area.
2914 * \li Syntax: server-get-xy
2917 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
2920 * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
2921 * \li Action: Generates the code (literate programming).
2922 * \li Notion: Latex file with extension \literate_extension is generated.
2923 Then LyX invokes \build_command (with a default of ``make'') to generate the code and
2924 \build_error_filter to process the compilation error messages. \n
2925 In case you want to process your literate file with a script, or some other program,
2926 just insert in your lyxrc file an entry with:\n
2927 \build_command "my_script my_arguments" \n
2928 The \build_error_filter differs from the \literate_error_filter only in that the
2929 former will identify error messages from your compiler.
2930 * \li Syntax: build-program
2933 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
2936 * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
2937 * \li Action: Saves the current buffer to a temporary file.
2938 * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
2939 is called automatically by LyX, to "autosave" the current buffer.
2940 * \li Syntax: buffer-auto-save
2943 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
2945 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHILD_OPEN
2946 * \li Action: Loads the given child document.
2947 * \li Notion: The current document is treated as a parent.
2948 * \li Syntax: buffer-child-open <FILE>
2949 * \li Params: <FILE>: Filename of the child. The directory of the parent is assumed by default.
2950 * \li Origin: Ale, 28 May 1997
2953 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
2955 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHKTEX
2956 * \li Action: Runs chktex for the current document.
2957 * \li Syntax: buffer-chktex
2958 * \li Origin: Asger, 30 Oct 1997
2961 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
2963 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
2964 * \li Action: Toggles compression of the current document on/off.
2965 * \li Syntax: buffer-toggle-compression
2966 * \li Origin: bpeng, 27 Apr 2006
2969 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
2971 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_OUTPUT_SYNC
2972 * \li Action: Toggles including of resources for forward/reverse search of the given document.
2973 * \li Notion: When toggled on, SyncTeX is invoked for PDF, while srcltx package
2974 is used for DVI. Custom LaTeX macro can be defined in preferences.
2975 * \li Syntax: buffer-toggle-output-sync
2976 * \li Origin: sanda, 25 May 2010
2979 { LFUN_BUFFER_TOGGLE_OUTPUT_SYNC, "buffer-toggle-output-sync", Noop, System },
2981 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
2982 * \li Action: Closes the current buffer.
2983 * \li Notion: Closes the current buffer, asking whether to save it, etc,
2984 if the buffer has been modified.
2985 * \li Syntax: buffer-close
2988 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
2990 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE_ALL
2991 * \li Action: Closes all buffers.
2992 * \li Notion: Closes all buffers, asking whether to save it, etc,
2993 if a buffer has been modified.
2994 * \li Syntax: buffer-close-all
2997 { LFUN_BUFFER_CLOSE_ALL, "buffer-close-all", ReadOnly, Buffer },
2999 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
3000 * \li Action: Exports the current buffer (document) to the given format.
3001 * \li Syntax: buffer-export <FORMAT> [<DEST>]
3002 * \li Params: <FORMAT> is either "custom" or one of the formats which you
3003 can find in Tools->Preferences->File formats->Format.
3004 Usual format you will enter is "pdf2" (pdflatex),
3005 "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
3006 In case of "custom" you will be asked for a format you
3007 want to start from and for the command that you want to
3008 apply to this format. Internally the control is then passed
3009 to #LFUN_BUFFER_EXPORT_CUSTOM.
3010 <DEST> If present, this argument provides the export destination
3011 filename. Its containing folder will also be the destination
3012 folder, where all the needed external files will be copied.
3013 * \li Origin: Lgb, 29 Jul 1997
3016 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
3018 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
3019 * \li Action: Exports the current buffer (document) from the given format using
3020 the given command on it.
3021 * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
3022 * \li Params: <FORMAT> format to start from (LyX will care to produce such
3023 intermediate file).\n
3024 <COMMAND> this command will be launched on the file. Note that you can
3025 use "$$FName" string to qualify the intermediate file.
3026 * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
3027 * \li Origin: leeming, 27 Mar 2004
3030 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
3032 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_AS
3033 * \li Action: Pops up a dialog for exporting the current buffer.
3034 * \li Syntax: buffer-export-as
3035 * \li Origin: tommaso, 6 Oct 2011
3038 { LFUN_BUFFER_EXPORT_AS, "buffer-export-as", ReadOnly, Buffer },
3040 * \var lyx::FuncCode lyx::LFUN_BUFFER_PRINT
3041 * \li Action: Prints the current document.
3042 * \li Notion: Many settings can be given via the preferences dialog.
3043 * \li Syntax: buffer-print <TARGET> <TARGET-NAME> <COMMAND>
3044 * \li Params: <TARGET> is either "printer" or "file".\n
3045 <TARGER-NAME> is either "default" or file name or printer name.\n
3046 <COMMAND> command ensuring the printing job.
3047 * \li Sample: buffer-print file "/trash/newfile1.ps" "dvips"
3048 * \li Origin: leeming, 28 Mar 2004
3051 { LFUN_BUFFER_PRINT, "buffer-print", ReadOnly, Buffer },
3053 * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
3054 * \li Action: Import a given file as a lyx document.
3055 * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
3056 defined converters in preferences. Look in the File->Import menu to get
3057 an idea of the currently active import formats.
3058 * \li Syntax: buffer-import <FORMAT> [<FILE>]
3059 * \li Origin: Asger, 24 Jul 1998
3062 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
3064 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
3065 * \li Action: Creates a new buffer (that is, document) and switches to it.
3066 * \li Notion: Implicit path can be set in Preferences dialog.
3067 * \li Syntax: buffer-new [<FILE>]
3068 * \li Params: <FILE>: filename of created file with absolute path.
3071 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
3073 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
3074 * \li Action: Creates a new buffer (that is, document) from a template.
3075 * \li Notion: Path for new files and templates can be set in Preferences dialog.
3076 Template will be asked for via Open-dialog.
3077 * \li Syntax: buffer-new-template [<FILE>]
3078 * \li Params: <FILE>: filename of created file with absolute path.
3081 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
3083 * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
3084 * \li Action: Reverts opened document.
3085 * \li Syntax: buffer-reload
3086 * \li Origin: Asger, 2 Feb 1997
3089 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
3091 * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
3092 * \li Action: Display and switch to the given buffer.
3093 * \li Syntax: buffer-switch <BUFFER>
3094 * \li Params: <BUFFER>: path and filename of already opened (but possibly hidden)
3095 document which is to be shown.
3098 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
3100 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
3101 * \li Action: Toggle editing mode of the current document between read/write and read-only.
3102 * \li Notion: This function is not allowed if the file is under version control, since
3103 read-only flag is often used in version control file locking.
3104 * \li Syntax: buffer-toggle-read-only
3105 * \li Origin: Lgb, 27 May 1997
3108 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
3110 * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
3111 * \li Action: Displays current buffer in chosen format.
3112 * \li Notion: Displays the contents of the current buffer in the chosen
3113 format, for example, PDF or DVI. This runs the necessary
3114 converter, calls the defined viewer, and so forth.
3115 * \li Syntax: buffer-view [<FORMAT>]
3116 * \li Params: <FORMAT>: The format to display, where this is one of the
3117 formats defined (in the current GUI) in the
3118 Tools>Preferences>File Formats dialog.
3119 If no format is given, the default format as
3120 specified in the same dialog is used.
3123 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
3125 * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
3126 * \li Action: Exports the current document and put the result into the
3127 temporary directory.
3128 * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
3129 the output will be rewritten - updated. This is useful in case your viewer
3130 is able to detect such changes (e.g. ghostview for postscript).
3131 * \li Syntax: buffer-update [<FORMAT>]
3132 * \li Params: <FORMAT>: The format to display, where this is one of the
3133 formats defined (in the current GUI) in the
3134 Tools>Preferences>File Formats dialog.
3135 If no format is given, the default format as
3136 specified in the same dialog is used.
3137 * \li Origin: Dekel, 5 Aug 2000
3140 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
3143 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
3144 * \li Action: Saves the current buffer.
3145 * \li Notion: Saves the current buffer to disk, using the filename that
3146 is already associated with the buffer, asking for one if
3147 none is yet assigned.
3148 * \li Syntax: buffer-write
3151 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
3153 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
3154 * \li Action: Rename and save current buffer.
3155 * \li Syntax: buffer-write-as <FILENAME>
3156 * \li Params: <FILENAME>: New name of the buffer/file. A relative path
3157 is with respect to the original location of the buffer/file.
3160 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
3162 * \var lyx::FuncCode lyx::LFUN_BUFFER_FORALL
3163 * \li Action: Applies a command to all visible, hidden, or both types of buffers in the active window.
3164 * \li Syntax: buffer-forall [<BUFFER-TYPE>] <LFUN-COMMAND>
3165 * \li Params: <BUFFER-TYPE>: <visible|hidden|both default:> default: visible
3166 <LFUN-COMMAND>: The command that is to be applied to the buffers.
3167 * \li Sample: Close all Notes in all visible documents: \n
3168 buffer-forall inset-forall Note inset-toggle close \n
3169 Toggle change tracking on all documents: \n
3170 buffer-forall both changes-track \n
3171 Toggle read-only for all visible documents: \n
3172 buffer-forall buffer-toggle-read-only \n
3173 Show statistics for each document: \n
3174 buffer-forall both statistics \n
3175 Activate the branch named "Solutions" in all visible documents: \n
3176 buffer-forall branch-activate Solutions \n
3177 Export all visible documents to PDF (pdflatex): \n
3178 buffer-forall buffer-export pdf2 \n
3179 * \li Origin: scottkostyshak, 20 Jul 2012
3182 { LFUN_BUFFER_FORALL, "buffer-forall", ReadOnly | Argument, Buffer },
3184 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
3185 * \li Action: Save all changed documents.
3186 * \li Syntax: buffer-write-all
3187 * \li Origin: rgh, gpothier 6 Aug 2007
3190 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
3192 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEXT
3193 * \li Action: Switch to the next opened document.
3194 * \li Notion: Note that this does not necessarily mean next in tabbar
3195 (for full list see View menu).
3196 * \li Syntax: buffer-next
3199 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
3201 * \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS
3202 * \li Action: Switch to the previous opened document.
3203 * \li Syntax: buffer-previous
3206 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
3208 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
3209 * \li Action: When run from a child document, this updates (exports) document built
3210 from the master buffer, if available.
3211 * \li Syntax: master-buffer-update [<FORMAT>]
3212 * \li Params: <FORMAT>: The format to display, where this is one of the
3213 formats defined (in the current GUI) in the
3214 Tools>Preferences>File Formats dialog.
3215 If no format is given, the default format as
3216 specified in the same dialog is used.
3217 * \li Origin: Tommaso, 20 Sep 2007
3220 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
3222 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
3223 * \li Action: When run from a child document, this command shows a preview built
3224 from the master buffer, if available.
3225 * \li Syntax: master-buffer-view [<FORMAT>]
3226 * \li Params: <FORMAT>: The format to display, where this is one of the
3227 formats defined (in the current GUI) in the
3228 Tools>Preferences>File Formats dialog.
3229 If no format is given, the default format as
3230 specified in the same dialog is used.
3231 * \li Origin: Tommaso, 20 Sep 2007
3234 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
3236 * \var lyx::FuncCode lyx::LFUN_BUFFER_LANGUAGE
3237 * \li Action: Set language of the current document.
3238 * \li Syntax: buffer-language <LANG>
3239 * \li Params: <LANG>: language name. See lib/languages for list.
3240 * \li Origin: leeming, 30 Mar 2004
3243 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
3245 * \var lyx::FuncCode lyx::LFUN_BUFFER_SAVE_AS_DEFAULT
3246 * \li Action: Save the current document settings as default.
3247 * \li Notion: The file will will be saved into ~/.lyx/templates/defaults.lyx .
3248 * \li Syntax: buffer-save-as-default [<ARGS>]
3249 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
3250 you can find in document header of usual .lyx file.
3251 * \li Origin: leeming, 30 Mar 2004
3254 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
3256 * \var lyx::FuncCode lyx::LFUN_BUFFER_PARAMS_APPLY
3257 * \li Action: Apply the given settings to the current document.
3258 * \li Syntax: buffer-params-apply [<ARGS>]
3259 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
3260 you can find in document header of usual .lyx file.
3261 * \li Origin: leeming, 30 Mar 2004
3264 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", NoInternal, Buffer },
3267 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
3268 * \li Action: Inserts another LyX file.
3269 * \li Syntax: file-insert [<FILE>]
3270 * \li Params: <FILE>: Filename to be inserted.
3273 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
3275 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
3276 * \li Action: Inserts plain text file.
3277 * \li Syntax: file-insert-plaintext [<FILE>]
3278 * \li Params: <FILE>: Filename to be inserted.
3279 * \li Origin: CFO-G, 19 Nov 1997
3282 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
3284 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
3285 * \li Action: Inserts plain text file as paragraph (i.e. join lines).
3286 * \li Syntax: file-insert-plaintext-para [<FILE>]
3287 * \li Params: <FILE>: Filename to be inserted.
3288 * \li Origin: Levon, 14 Feb 2001
3291 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
3293 * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
3294 * \li Action: Open LyX document.
3295 * \li Syntax: file-open [<FILE>]
3296 * \li Params: <FILE>: Filename to be opened.
3299 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
3302 * \var lyx::FuncCode lyx::LFUN_CALL
3303 * \li Action: Executes a command defined in a .def file.
3304 * \li Notion: The definitions are by default read from lib/commands/default.def.\n
3305 A .def file allows to define a command with \define "<NAME>" "<LFUN>"
3306 where <NAME> is the name of the new command and <LFUN> is the lfun code
3307 to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
3308 \def_file "FileName" allows to include another .def file. \n
3309 This is particularly useful in connection with toolbar buttons:
3310 Since the name of the button image for this lfun is
3311 lib/images/commands/<NAME>.png this is the way to assign an image
3312 to a complex command-sequence.
3313 * \li Syntax: call <NAME>
3314 * \li Params: <NAME>: Name of the command that must be called.
3315 * \li Origin: broider, 2 Oct 2007
3318 { LFUN_CALL, "call", NoBuffer, System },
3320 * \var lyx::FuncCode lyx::LFUN_META_PREFIX
3321 * \li Action: Simulate halting Meta key (Alt key on PCs).
3322 * \li Notion: Used for buffer editation not for GUI control.
3323 * \li Syntax: meta-prefix
3326 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
3328 * \var lyx::FuncCode lyx::LFUN_CANCEL
3329 * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
3330 * \li Syntax: cancel
3333 { LFUN_CANCEL, "cancel", NoBuffer, System },
3336 * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
3337 * \li Action: Switches the focus to the minibuffer so that the user can type
3338 in there. If necessary, it opens the minibuffer toolbar.
3339 * \li Notion: Usually bound to M-x shortcut.
3340 * \li Syntax: command-execute
3343 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
3346 * \var lyx::FuncCode lyx::LFUN_COMMAND_PREFIX
3347 * \li Action: Return the current key sequence and available options as a string.
3348 * \li Notion: No options are added if no current map exists. \n
3349 This is probably usable only with connection to lyxserver.
3350 * \li Syntax: command-prefix
3353 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
3355 * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
3356 * \li Action: Run more commands (LFUN and its parameters) in a sequence.
3357 * \li Syntax: command-sequence <CMDS>
3358 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
3359 * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
3360 * \li Origin: Andre, 11 Nov 1999
3363 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
3365 * \var lyx::FuncCode lyx::LFUN_COMMAND_ALTERNATIVES
3366 * \li Action: Runs the first listed command that is enabled.
3367 * \li Notion: This can be used to bind multiple functions to a single key,
3368 and then which one is used will depend upon the context.
3369 * \li Syntax: command-alternatives <CMDS>
3370 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
3371 * \li Sample: command-alternatives completion-accept;cell-forward
3372 * \li Origin: rgh, 24 September 2008
3375 { LFUN_COMMAND_ALTERNATIVES, "command-alternatives", NoBuffer, System },
3377 * \var lyx::FuncCode lyx::LFUN_MESSAGE
3378 * \li Action: Shows message in statusbar (for script purposes).
3379 * \li Syntax: message <STRING>
3380 * \li Origin: Lgb, 8 Apr 2001
3383 { LFUN_MESSAGE, "message", NoBuffer, System },
3385 * \var lyx::FuncCode lyx::LFUN_DEBUG_LEVEL_SET
3386 * \li Action: Set debug output level.
3387 * \li Syntax: debug-level-set <LEVEL>
3388 * \li Params: <LEVEL>: comma separated list of levels or the correspondent number
3389 of their combination. 0 is equivalent to disabling all debug
3390 events. See lyx -dbg for the current list of debug levels
3392 * \li Origin: sanda, 28 Dec 2009
3395 { LFUN_DEBUG_LEVEL_SET, "debug-level-set", NoBuffer, System },
3398 * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
3399 * \li Action: Save user preferences.
3400 * \li Syntax: preferences-save
3401 * \li Origin: Lgb, 27 Nov 1999
3404 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
3406 * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
3407 * \li Action: Reconfigure the automatic settings.
3408 * \li Syntax: reconfigure
3409 * \li Origin: Asger, 14 Feb 1997
3412 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
3414 * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
3415 * \li Action: Apply the given settings to user preferences.
3416 * \li Syntax: lyxrc-apply <SETTINGS>
3417 * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
3418 to get an idea which commands to use and their syntax.
3419 #lyx::LyXRC::LyXRCTags has the list of possible commands.
3422 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
3424 * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
3425 * \li Action: Determine whether to keep cursor inside the editing window regardless
3426 of the scrollbar movement.
3427 * \li Syntax: toggle-cursor-follows-scrollbar
3428 * \li Origin: ARRae, 2 Dec 1997
3431 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
3433 * \var lyx::FuncCode lyx::LFUN_SET_COLOR
3434 * \li Action: Set the given LyX color to the color defined by the X11 name given.
3435 * \li Notion: A new color entry is created if the color is unknown.
3436 Color names can be stored as a part of user settings.
3437 * \li Syntax: set-color <LYX_NAME> <X11_NAME>
3438 * \li Origin: SLior, 11 Jun 2000
3441 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
3443 * \var lyx::FuncCode lyx::LFUN_STATISTICS
3444 * \li Action: Count the statistics (number of words and characters)
3445 in the document or in the given selection.
3446 * \li Notion: Note that this function gives the number of words/chars written,
3447 not the number of characters which will be typeset.
3448 * \li Syntax: statistics
3449 * \li Origin: lasgouttes, Jan 27 2004; sanda, Jan 8 2008
3452 { LFUN_STATISTICS, "statistics", ReadOnly, System },
3454 * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
3455 * \li Action: Show the inline completion at the cursor position.
3456 * \li Syntax: completion-inline
3457 * \li Origin: sts, Feb 19 2008
3460 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
3462 * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
3463 * \li Action: Show the completion popup at the cursor position.
3464 * \li Syntax: completion-popup
3465 * \li Origin: sts, Feb 19 2008
3468 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
3470 * \var lyx::FuncCode lyx::LFUN_COMPLETION_COMPLETE
3471 * \li Action: Try to complete the word or command at the cursor position.
3472 * \li Syntax: complete
3473 * \li Origin: sts, Feb 19 2008
3476 { LFUN_COMPLETION_COMPLETE, "complete", SingleParUpdate, Edit },
3479 * \var lyx::FuncCode lyx::LFUN_COMPLETION_CANCEL
3480 * \li Action: Try to cancel completion, either the popup or the inline completion.
3481 * \li Syntax: completion-cancel
3482 * \li Origin: sts, Sep 07 2008
3485 { LFUN_COMPLETION_CANCEL, "completion-cancel", SingleParUpdate, Edit },
3487 * \var lyx::FuncCode lyx::LFUN_COMPLETION_ACCEPT
3488 * \li Action: Accept suggested completion.
3489 * \li Syntax: completion-accept
3490 * \li Origin: sanda, Sep 08 2008
3493 { LFUN_COMPLETION_ACCEPT, "completion-accept", SingleParUpdate, Edit },
3497 * \var lyx::FuncCode lyx::LFUN_BRANCH_ADD
3498 * \li Action: Add a branch to the buffer's BranchList.
3499 * \li Syntax: branch-add <BRANCH>
3500 * \li Params: <BRANCH>: Name of the branch to add
3501 * \li Origin: spitz, 7 Jul 2009
3504 { LFUN_BRANCH_ADD, "branch-add", Noop, Buffer },
3508 * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
3509 * \li Action: Activate the branch.
3510 * \li Syntax: branch-activate <BRANCH>
3511 * \li Params: <BRANCH>: The branch to activate
3512 * \li Sample: lyx -x "branch-activate answers" -e pdf2 finalexam.lyx \n
3513 could be used to export a pdf with the answers branch included
3514 without one's having to open LyX and activate the branch manually.
3515 * \li Origin: rgh, 27 May 2008
3518 { LFUN_BRANCH_ACTIVATE, "branch-activate", AtPoint, Buffer },
3520 * \var lyx::FuncCode lyx::LFUN_BRANCH_DEACTIVATE
3521 * \li Action: De-activate the branch.
3522 * \li Syntax: branch-deactivate <BRANCH>
3523 * \li Params: <BRANCH>: The branch to deactivate
3524 * \li Origin: rgh, 27 May 2008
3527 { LFUN_BRANCH_DEACTIVATE, "branch-deactivate", AtPoint, Buffer },
3529 * \var lyx::FuncCode lyx::LFUN_BRANCH_MASTER_ACTIVATE
3530 * \li Action: Activate the branch in the master buffer.
3531 * \li Syntax: branch-master-activate <BRANCH>
3532 * \li Params: <BRANCH>: The branch to activate
3533 * \li Sample: lyx -x "branch-activate answers" -e pdf2 finalexam.lyx \n
3534 could be used to export a pdf with the answers branch included
3535 without one's having to open LyX and activate the branch manually.
3536 * \li Origin: spitz, 30 Sep 2012
3539 { LFUN_BRANCH_MASTER_ACTIVATE, "branch-master-activate", AtPoint, Buffer },
3541 * \var lyx::FuncCode lyx::LFUN_BRANCH_MASTER_DEACTIVATE
3542 * \li Action: De-activate the branch in the master buffer.
3543 * \li Syntax: branch-master-deactivate <BRANCH>
3544 * \li Params: <BRANCH>: The branch to deactivate
3545 * \li Origin: spitz, 30 Sep 2012
3548 { LFUN_BRANCH_MASTER_DEACTIVATE, "branch-master-deactivate", AtPoint, Buffer },
3551 * \var lyx::FuncCode lyx::LFUN_BRANCHES_RENAME
3552 * \li Action: Rename all branches of a given name in a document.
3553 * \li Syntax: branches-rename <OLDNAME> <NEWNAME>
3554 * \li Params: <OLDNAME>: Current name of the branch to be renamed
3555 * <NEWNAME>: New name of the branch
3556 * \li Origin: spitz, 9 Jul 2009
3559 { LFUN_BRANCHES_RENAME, "branches-rename", Noop, Buffer },
3561 * \var lyx::FuncCode lyx::LFUN_BRANCH_ADD_INSERT
3562 * \li Action: Create new branch and directly put the branch inset into
3564 * \li Syntax: branch-add-insert [<NAME>]
3565 * \li Params: <NAME>: Branch name. If it is not specified, you will be asked.
3566 * \li Origin: sanda, 10 Jul 2009
3569 { LFUN_BRANCH_ADD_INSERT, "branch-add-insert", Noop, Buffer },
3573 * \var lyx::FuncCode lyx::LFUN_LABEL_COPY_AS_REF
3574 * \li Action: Copies the label at the cursor as a cross-reference to be pasted elsewhere.
3575 * \li Syntax: copy-label-as-reference <LABEL>
3576 * \li Params: <LABEL>: The label to copy (for multi-line math)
3577 * \li Origin: sts, 16 Nov 2008
3580 { LFUN_LABEL_COPY_AS_REF, "copy-label-as-reference",
3581 ReadOnly | NoUpdate | AtPoint, Edit },
3584 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT_AS_REF
3585 * \li Action: Inserts the label as a cross-reference at the position of the cursor.
3586 * \li Syntax: label-insert-as-reference
3587 * \li Origin: vfr, 7 Apr 2009
3590 { LFUN_LABEL_INSERT_AS_REF, "label-insert-as-reference", Noop, Edit},
3593 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_IN
3594 * \li Action: Increases the zoom of the screen fonts.
3595 * \li Syntax: buffer-zoom-in [<ZOOM>]
3596 * \li Params: <ZOOM>: The zoom in %, the default is 20.
3597 * \li Origin: vfr, 30 Mar 2009
3600 { LFUN_BUFFER_ZOOM_IN, "buffer-zoom-in", ReadOnly, Buffer },
3603 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_OUT
3604 * \li Action: Decreases the zoom of the screen fonts.
3605 * \li Syntax: buffer-zoom-out [<ZOOM>]
3606 * \li Params: <ZOOM>: The zoom in %, the default is 20.
3607 * \li Origin: vfr, 30 Mar 2009
3610 { LFUN_BUFFER_ZOOM_OUT, "buffer-zoom-out", ReadOnly, Buffer },
3613 * \var lyx::FuncCode lyx::LFUN_INSET_COPY_AS
3614 * \li Action: Copies the inset to the clipboard as a certain type.
3615 * \li Notion: Currently used only for InsetInfo where its content is copied as a text.
3616 * \li Syntax: inset-copy-as
3617 * \li Origin: vfr, 18 Apr 2010
3620 { LFUN_INSET_COPY_AS, "inset-copy-as", ReadOnly | NoUpdate | AtPoint, Edit },
3622 { LFUN_NOACTION, "", Noop, Hidden }
3623 #ifndef DOXYGEN_SHOULD_SKIP_THIS
3626 for (int i = 0; items[i].action != LFUN_NOACTION; ++i)
3627 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
3633 LyXAction::LyXAction()
3639 FuncRequest LyXAction::lookupFunc(string const & func) const
3641 string const func2 = trim(func);
3644 return FuncRequest(LFUN_NOACTION);
3647 string const arg = split(func2, cmd, ' ');
3649 FuncMap::const_iterator const fit = lyx_func_map.find(cmd);
3651 return fit != lyx_func_map.end()
3652 ? FuncRequest(fit->second, arg)
3653 : FuncRequest(LFUN_UNKNOWN_ACTION);
3657 string const LyXAction::getActionName(FuncCode action) const
3659 InfoMap::const_iterator const it = lyx_info_map.find(action);
3660 return it != lyx_info_map.end() ? it->second.name : string();
3664 LyXAction::FuncType LyXAction::getActionType(FuncCode action) const
3666 InfoMap::const_iterator const it = lyx_info_map.find(action);
3667 return it != lyx_info_map.end() ? it->second.type : Hidden;
3671 bool LyXAction::funcHasFlag(FuncCode action,
3672 LyXAction::FuncAttribs flag) const
3674 InfoMap::const_iterator ici = lyx_info_map.find(action);
3676 if (ici == lyx_info_map.end()) {
3677 LYXERR0("action: " << action << " is not known.");
3678 LASSERT(false, /**/);
3681 return ici->second.attrib & flag;
3685 LyXAction::const_iterator LyXAction::func_begin() const
3687 return lyx_func_map.begin();
3691 LyXAction::const_iterator LyXAction::func_end() const
3693 return lyx_func_map.end();
3697 LyXErr & operator<<(LyXErr & l, FuncCode code)
3700 l.stream() << lyxaction.getActionName(code);