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_PERISPOMENI
204 * \li Action: Adds a perispomeni (Greek circumflex)
205 over the next character typed.
206 * \li Syntax: accent-perispomeni
209 { LFUN_ACCENT_PERISPOMENI, "accent-perispomeni", Noop, Edit },
211 * \var lyx::FuncCode lyx::LFUN_ACCENT_TIE
212 * \li Action: Adds a tie \htmlonly (a͡)\endhtmlonly
213 over the next two character typed.
214 * \li Notion: The following char will finish the tie.
215 * \li Syntax: accent-tie
218 { LFUN_ACCENT_TIE, "accent-tie", Noop, Edit },
220 * \var lyx::FuncCode lyx::LFUN_ACCENT_TILDE
221 * \li Action: Adds a tilde \htmlonly (ã)\endhtmlonly
222 over the next character typed.
223 * \li Syntax: accent-tilde
226 { LFUN_ACCENT_TILDE, "accent-tilde", Noop, Edit },
228 * \var lyx::FuncCode lyx::LFUN_ACCENT_UMLAUT
229 * \li Action: Adds an umlaut \htmlonly (ä)\endhtmlonly
230 over the next character typed.
231 * \li Syntax: accent-umlaut
234 { LFUN_ACCENT_UMLAUT, "accent-umlaut", Noop, Edit },
236 * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERBAR
237 * \li Action: Adds a bar \htmlonly (a̠)\endhtmlonly
238 under the next character typed.
239 * \li Syntax: accent-underbar
242 { LFUN_ACCENT_UNDERBAR, "accent-underbar", Noop, Edit },
244 * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERDOT
245 * \li Action: Adds a dot \htmlonly (ạ)\endhtmlonly
246 under the next character typed.
247 * \li Syntax: accent-underdot
250 { LFUN_ACCENT_UNDERDOT, "accent-underdot", Noop, Edit },
253 * \var lyx::FuncCode lyx::LFUN_CAPTION_INSERT
254 * \li Action: Inserts a caption inset.
255 * \li Syntax: caption-insert
256 * \li Origin: Lgb, 18 Jul 2000
259 { LFUN_CAPTION_INSERT, "caption-insert", Noop, Edit },
261 * \var lyx::FuncCode lyx::LFUN_DATE_INSERT
262 * \li Action: Inserts the current date.
263 * \li Syntax: date-insert [<ARG>]
264 * \li Params: <ARG>: Format of date. The default value (%x) can be set
265 in Preferences->Date format. For possible formats
266 see manual page of strftime function.
267 * \li Origin: jdblair, 31 Jan 2000
270 { LFUN_DATE_INSERT, "date-insert", Noop, Edit },
272 * \var lyx::FuncCode lyx::LFUN_FOOTNOTE_INSERT
273 * \li Action: Inserts a footnote inset.
274 * \li Syntax: footnote-insert
275 * \li Origin: Jug, 7 Mar 2000
278 { LFUN_FOOTNOTE_INSERT, "footnote-insert", Noop, Edit },
280 * \var lyx::FuncCode lyx::LFUN_ERT_INSERT
281 * \li Action: Inserts an ERT inset.
282 * \li Syntax: ert-insert
283 * \li Origin: Jug, 18 Feb 2000
286 { LFUN_ERT_INSERT, "ert-insert", Noop, Edit },
288 * \var lyx::FuncCode lyx::LFUN_FLOAT_INSERT
289 * \li Action: Inserts a float inset.
290 * \li Syntax: float-insert <TYPE>
291 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
292 "algorithm", "table", "figure" parameters can be given.
293 * \li Origin: Lgb, 27 Jun 2000
296 { LFUN_FLOAT_INSERT, "float-insert", Noop, Edit },
298 * \var lyx::FuncCode lyx::LFUN_FLOAT_WIDE_INSERT
299 * \li Action: Inserts float insets as in #LFUN_FLOAT_INSERT but span multiple columns.
300 * \li Notion: Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
301 * \li Syntax: float-wide-insert <TYPE>
302 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
303 "algorithm", "table", "figure" parameters can be given.
304 * \li Origin: Lgb, 31 Oct 2001
307 { LFUN_FLOAT_WIDE_INSERT, "float-wide-insert", Noop, Edit },
309 * \var lyx::FuncCode lyx::LFUN_FLOAT_LIST_INSERT
310 * \li Action: Inserts the list of floats in the document.
311 * \li Syntax: float-list-insert <TYPE>
312 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
313 "algorithm", "table", "figure" parameters can be given.
314 * \li Origin: Lgb, 3 May 2001
317 { LFUN_FLOAT_LIST_INSERT, "float-list-insert", Noop, Edit },
319 * \var lyx::FuncCode lyx::LFUN_WRAP_INSERT
320 * \li Action: Inserts floats wrapped by the text around.
321 * \li Syntax: wrap-insert <TYPE>
322 * \li Params: <TYPE>: table|figure
323 * \li Origin: Dekel, 7 Apr 2002
326 { LFUN_WRAP_INSERT, "wrap-insert", Noop, Edit },
328 * \var lyx::FuncCode lyx::LFUN_ARGUMENT_INSERT
329 * \li Action: Inserts an argument (short title) inset.
330 * \li Syntax: argument-insert <argument nr>
331 * \li Params: <argument nr>: see layout declarations
332 * \li Origin: vermeer, 12 Aug 2002
335 { LFUN_ARGUMENT_INSERT, "argument-insert", Noop, Edit },
337 * \var lyx::FuncCode lyx::LFUN_NEWPAGE_INSERT
338 * \li Action: Inserts a new page.
339 * \li Syntax: newpage-insert <ARG>
340 * \li Params: <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
341 * \li Origin: uwestoehr, 24 Nov 2007
344 { LFUN_NEWPAGE_INSERT, "newpage-insert", Noop, Edit },
346 * \var lyx::FuncCode lyx::LFUN_MARGINALNOTE_INSERT
347 * \li Action: Inserts a marginal note.
348 * \li Syntax: marginalnote-insert
349 * \li Origin: Lgb, 26 Jun 2000
352 { LFUN_MARGINALNOTE_INSERT, "marginalnote-insert", Noop, Edit },
354 * \var lyx::FuncCode lyx::LFUN_UNICODE_INSERT
355 * \li Action: Inserts a single unicode character.
356 * \li Syntax: unicode-insert <CHAR>
357 * \li Params: <CHAR>: The character to insert, given as its code
358 point, in hexadecimal.
359 * \li Sample: unicode-insert 0x0100
360 * \li Origin: Lgb, 22 Oct 2006
363 { LFUN_UNICODE_INSERT, "unicode-insert", Noop, Edit },
365 * \var lyx::FuncCode lyx::LFUN_LISTING_INSERT
366 * \li Action: Inserts a new listings inset.
367 * \li Syntax: listing-insert
368 * \li Origin: Herbert, 10 Nov 2001; bpeng, 2 May 2007
371 { LFUN_LISTING_INSERT, "listing-insert", Noop, Edit },
373 * \var lyx::FuncCode lyx::LFUN_PREVIEW_INSERT
374 * \li Action: Inserts a new preview inset.
375 * \li Syntax: preview-insert
376 * \li Origin: vfr, 28 Mar 2010
379 { LFUN_PREVIEW_INSERT, "preview-insert", Noop, Edit },
381 * \var lyx::FuncCode lyx::LFUN_TAB_INSERT
382 * \li Action: Insert a tab into a listings inset.
383 * \li Notion: It also works on a selection.
384 * \li Syntax: tab-insert
385 * \li Origin: vfr, Sep 30 2008
388 { LFUN_TAB_INSERT, "tab-insert", SingleParUpdate, Edit },
390 * \var lyx::FuncCode lyx::LFUN_TAB_DELETE
391 * \li Action: Delete a tab or up to an equivalent amount of spaces from
393 * \li Notion: It also works on a selection - it removes a tab or spaces from the
394 beginning of each line spanned by the selection. This is useful if
395 you want to indent/unindent multiple lines in one action.
396 * \li Syntax: tab-delete
397 * \li Origin: vfr, Sep 30 2008
400 { LFUN_TAB_DELETE, "tab-delete", SingleParUpdate, Edit },
402 * \var lyx::FuncCode lyx::LFUN_QUOTE_INSERT
403 * \li Action: Inserts quotes according to the type and quote-language preference.
404 * \li Notion: Currently 15 different quote styles are distinguished (see params).
405 * \li Syntax: quote-insert [<LEVEL>] [<SIDE>] [<STYLE>]
406 * \li Params: <LEVEL>: 'inner' for (i.e., secondary, usually single) quotes, otherwise
407 * outer (i.e., primary, usually double) quotes will be used.\n
408 * <SIDE>: 'opening' for opening quotes, 'closing' for closing quotes,
409 * otherwise the side will be guessed from the context.\n
410 * <STYLE>: 'british' for `British' quote style (with ``inner quotation'')\n
411 * 'cjk' for Chinese/Japanese/Korean corner bracket quotation marks\n
412 * 'cjk-angle' for Chinese/Japanese/Korean angle bracket quotation marks\n
413 * 'danish' for >>Danish<< quote style (with >inner quotation<)\n
414 * 'english' for ``English'' quote style (with `inner quotation')\n
415 * 'french' for <<french>> quote style (with ``inner quotation'')\n
416 * 'frenchin' for <<frenchin>> quote style (with <<inner quotation>>) ["in" = Imprimerie Nationale]\n
417 * 'german' for ,,German`` quote style (with ,inner quotation`)\n
418 * 'plain' for "Plain" quote style (with 'inner quotation')\n
419 * 'polish' for ,,Polish'' quote style (with ,inner quotation')\n
420 * 'swedish' for ''Swedish'' quote style (with 'inner quotation')\n
421 * 'swedishg' for >>swedishg>> quote style (with 'inner quotation') ["g" = Guillemets]\n
422 * 'swiss' for <<Swiss>> quote style (with <inner quotation>)\n
423 * 'russian' for <<Russian>> quote style (with ,,inner quotation``)\n
424 * 'dynamic' for Dynamic quotation marks which inherit the global
426 * If no quote style is specified, the document-wide will be used.
429 { LFUN_QUOTE_INSERT, "quote-insert", Noop, Edit },
431 * \var lyx::FuncCode lyx::LFUN_INFO_INSERT
432 * \li Action: Displays shortcuts, lyxrc, package and textclass availability and menu
433 information in a non-editable boxed InsetText.
434 * \li Notion: Apart from lfun arguments you can use the following method: \n
435 1. input the type and argument of this inset, e.g. "menu paste", in
437 2. select the text and run info-insert lfun.
438 * \li Syntax: info-insert <TYPE> <ARG>
439 * \li Params: <TYPE>: shortcut[s]|lyxrc|lyxinfo|package|textclass|menu|buffer \n
440 <ARG>: argument for a given type. Look into InsetInfo.h for detailed
442 shortcut[s]: name of lfun (e.g math-insert \alpha) \n
443 lyxrc: name of rc_entry (e.g. bind_file) \n
444 lyxinfo: "version" - used version of LyX \n
445 package: name of latex package (e.g. listings) \n
446 textclass: name of textclass (e.g. article) \n
447 menu: name of lfun used in menu \n
448 icon: icon of lfun used in toolbar or direct icon name\n
449 buffer: "name"|"path"|"class"|"vcs-tree-revision"|
450 "vcs-revision"|"vcs-author"|"vcs-date"|"vcs-time"
451 * \li Sample: command-sequence info-insert buffer path; info-insert buffer name
452 * \li Origin: bpeng, 7 Oct 2007
455 { LFUN_INFO_INSERT, "info-insert", Noop, Edit },
457 * \var lyx::FuncCode lyx::LFUN_BRANCH_INSERT
458 * \li Action: Inserts branch inset.
459 * \li Syntax: branch-insert <BRANCH-NAME>
460 * \li Origin: vermeer, 17 Aug 2003
463 { LFUN_BRANCH_INSERT, "branch-insert", Noop, Edit },
465 * \var lyx::FuncCode lyx::LFUN_BOX_INSERT
466 * \li Action: Inserts Box inset.
467 * \li Syntax: box-insert [<TYPE>]
468 * \li Params: <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox \n
469 Framed is the default one.
470 * \li Origin: vermeer, 7 Oct 2003
473 { LFUN_BOX_INSERT, "box-insert", Noop, Edit },
475 * \var lyx::FuncCode lyx::LFUN_FLEX_INSERT
476 * \li Action: Inserts CharStyle, Custom inset or XML short element.
477 * \li Notion: Look into the Customization manual for more information about
479 To make this command enabled the layout file for the document
480 class you're using has to load the character styles. There are
481 a few contained in the Logical Markup module. You can also of
482 course create some yourself. \n
483 For dissolving the element see #LFUN_INSET_DISSOLVE.
484 * \li Syntax: flex-insert Name
485 * \li Params: Name: This name must be defined either in your layout file
486 or imported by some module. The definition is
487 InsetLayout Name or InsetLayout <Flex:Name>. The Flex:
489 * \li Sample: flex-insert Code
492 { LFUN_FLEX_INSERT, "flex-insert", Noop, Edit },
494 * \var lyx::FuncCode lyx::LFUN_SELF_INSERT
495 * \li Action: Inserts the given string (accordingly to the correct keymap).
496 * \li Notion: Automatically replace the currently selected text. Depends on lyxrc
497 settings "auto_region_delete".
498 * \li Syntax: self-insert <STRING>
501 { LFUN_SELF_INSERT, "self-insert", SingleParUpdate, Hidden },
503 * \var lyx::FuncCode lyx::LFUN_SPACE_INSERT
504 * \li Action: Inserts one of horizontal space insets.
505 * \li Syntax: space-insert <NAME> [<LEN>]
506 * \li Params: <NAME>: normal, protected, visible, thin, quad, qquad, enspace,
507 enskip, negthinspace, negmedspace, negthickspace, hfill,
508 hfill*, dotfill, hrulefill, hspace, hspace* \n
509 Only in math mode: med and thick.\n
510 <LEN>: length for custom spaces (hspace, hspace* for protected)
511 * \li Origin: JSpitzm, 20 May 2003, Mar 17 2008
514 { LFUN_SPACE_INSERT, "space-insert", Noop, Edit },
516 * \var lyx::FuncCode lyx::LFUN_HREF_INSERT
517 * \li Action: Inserts hyperlinks into the document (clickable in pdf output).
518 * \li Notion: Hyperlink target can be set via selection + hyperlink-insert function.
519 * \li Syntax: href-insert [<TARGET>]
520 * \li Origin: CFO-G, 21 Nov 1997
523 { LFUN_HREF_INSERT, "href-insert", Noop, Edit },
525 * \var lyx::FuncCode lyx::LFUN_SPECIALCHAR_INSERT
526 * \li Action: Inserts various characters into the document.
527 * \li Syntax: specialchar-insert <CHAR>
528 * \li Params: <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots,
529 end-of-sentence, menu-separator, lyx, tex, latex, latex2e.
530 * \li Origin: JSpitzm, 6 Dec 2007
533 { LFUN_SPECIALCHAR_INSERT, "specialchar-insert", Noop, Edit },
535 * \var lyx::FuncCode lyx::LFUN_SCRIPT_INSERT
536 * \li Action: Inserts a subscript or superscript inset.
537 * \li Syntax: script-insert <TYPE>
538 * \li Params: <TYPE>: subscript|superscript
539 * \li Origin: Georg, 23 Nov 2010
542 { LFUN_SCRIPT_INSERT, "script-insert", Noop, Edit },
544 * \var lyx::FuncCode lyx::LFUN_APPENDIX
545 * \li Action: Start (or remove) Appendix on the given cursor position.
546 * \li Syntax: appendix
547 * \li Origin: ettrich, 5 May 1998
550 { LFUN_APPENDIX, "appendix", Noop, Edit },
553 * \var lyx::FuncCode lyx::LFUN_INDEX_INSERT
554 * \li Action: Inserts Index entry.
555 * \li Notion: It automatically takes the word on the cursor position.
556 * \li Syntax: index-insert [<TYPE:Name>]
557 * \li Params: <TYPE:Name>: name of the index, if multiple indices are defined.
558 With an empty argument, the default index is selected.
559 * \li Origin: leeming, 3 Aug 2000
562 { LFUN_INDEX_INSERT, "index-insert", Noop, Edit },
564 * \var lyx::FuncCode lyx::LFUN_INDEX_PRINT
565 * \li Action: Inserts list of Index entries on a new page.
566 * \li Syntax: index-print [<TYPE:Name>]
567 * \li Params: <TYPE:Name>: name of the index, if multiple indices are defined.
568 With an empty argument, the default index is selected.
569 * \li Origin: Lgb, 27 Feb 1997
572 { LFUN_INDEX_PRINT, "index-print", Noop, Edit },
574 * \var lyx::FuncCode lyx::LFUN_IPA_INSERT
575 * \li Action: Inserts an IPA inset.
576 * \li Syntax: ipa-insert
577 * \li Origin: spitz, 05 Mar 2012
580 { LFUN_IPA_INSERT, "ipa-insert", Noop, Edit },
582 * \var lyx::FuncCode lyx::LFUN_IN_IPA
583 * \li Action: Only active in IPA inset.
584 * \li Notion: Dummy function which is only active in a IPA inset.
585 It's used to toggle the IPA toolbar if the cursor moves
588 * \li Origin: spitz, 20 May 2012
591 { LFUN_IN_IPA, "in-ipa", Noop, Edit },
593 * \var lyx::FuncCode lyx::LFUN_IPAMACRO_INSERT
594 * \li Action: Inserts special IPA macros into the document.
595 * \li Syntax: ipamacro-insert <CHAR>
596 * \li Params: <CHAR>: tone-falling, tone-rising, tone-high-rising, tone-low-rising,
597 * tone-high-rising-falling, deco bottomtiebar, deco toptiebar.
598 * \li Origin: JSpitzm, 22 Aug 2012
601 { LFUN_IPAMACRO_INSERT, "ipamacro-insert", Noop, Edit },
603 * \var lyx::FuncCode lyx::LFUN_NOMENCL_INSERT
604 * \li Action: Inserts Nomenclature entry.
605 * \li Notion: It automatically takes the word on the cursor position if no symbol is given.
606 * \li Syntax: nomencl-insert [<SYMBOL>]
607 * \li Origin: Ugras, 4 Nov 2006
610 { LFUN_NOMENCL_INSERT, "nomencl-insert", Noop, Edit },
612 * \var lyx::FuncCode lyx::LFUN_NOMENCLATURE_PRINT
613 * \li Action: Inserts list of Nomenclature entries.
614 * \li Syntax: nomenclature-print
615 * \li Origin: Ugras, 4 Nov 2006
618 { LFUN_NOMENCL_PRINT, "nomencl-print", Noop, Edit },
621 * \var lyx::FuncCode lyx::LFUN_NOTE_INSERT
622 * \li Action: Inserts Note on the current cursor position,
623 move selection inside the inset.
624 * \li Syntax: note-insert [<TYPE>]
625 * \li Params: <TYPE>: <Note|Greyedout|Comment> default: Note
628 { LFUN_NOTE_INSERT, "note-insert", Noop, Edit },
630 * \var lyx::FuncCode lyx::LFUN_NOTE_NEXT
631 * \li Action: Moves the cursor to the beginning of next Note inset.
632 * \li Syntax: note-next
635 { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
637 * \var lyx::FuncCode lyx::LFUN_PHANTOM_INSERT
638 * \li Action: Inserts phantom on the current cursor position,
639 move selection inside the inset.
640 * \li Syntax: phantom-insert [<TYPE>]
641 * \li Params: <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
642 * \li Origin: uwestoehr, 30 Jan 2009
645 { LFUN_PHANTOM_INSERT, "phantom-insert", Noop, Edit },
647 * \var lyx::FuncCode lyx::LFUN_NEWLINE_INSERT
648 * \li Action: Inserts a line break or new line.
649 * \li Syntax: newline-insert [<ARG>]
650 * \li Params: <ARG>: <newline|linebreak> default: newline
651 * \li Origin: JSpitzm, 25 Mar 2008
654 { LFUN_NEWLINE_INSERT, "newline-insert", Noop, Edit },
656 * \var lyx::FuncCode lyx::LFUN_SEPARATOR_INSERT
657 * \li Action: Inserts an environment separator or latex paragraph break.
658 * \li Syntax: separator-insert [<ARG>]
659 * \li Params: <ARG>: <plain|parbreak|latexpar> default: plain
660 * \li Origin: ef, 2 May 2014
663 { LFUN_SEPARATOR_INSERT, "separator-insert", Noop, Edit },
665 * \var lyx::FuncCode lyx::LFUN_ESCAPE
666 * \li Action: Clears the selection. If no text is selected call #LFUN_FINISHED_FORWARD.
667 Inside math mode jumps out of the math inset.
669 * \li Origin: Lgb, 17 May 2001
672 { LFUN_ESCAPE, "escape", ReadOnly, Edit },
674 * \var lyx::FuncCode lyx::LFUN_DOWN
675 * \li Action: Moves the cursor one line in downward direction.
679 { LFUN_DOWN, "down", ReadOnly | NoUpdate, Edit },
681 * \var lyx::FuncCode lyx::LFUN_UP
682 * \li Action: Moves the cursor one line in upward direction.
686 { LFUN_UP, "up", ReadOnly | NoUpdate, Edit },
688 * \var lyx::FuncCode lyx::LFUN_DOWN_SELECT
689 * \li Action: Moves the cursor one line in downward direction adding the current
690 position to the selection.
691 * \li Syntax: down-select
694 { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, Edit },
696 * \var lyx::FuncCode lyx::LFUN_UP_SELECT
697 * \li Action: Moves the cursor one line in upward direction adding the current
698 position to the selection.
699 * \li Syntax: up-select
702 { LFUN_UP_SELECT, "up-select", ReadOnly | SingleParUpdate, Edit },
704 * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN
705 * \li Action: Moves the cursor one page in downward direction.
706 * \li Syntax: screen-down
709 { LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit },
711 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP
712 * \li Action: Moves the cursor one page in upward direction.
713 * \li Syntax: screen-up
716 { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit },
718 * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN_SELECT
719 * \li Action: Moves the cursor one screen in downward direction adding the current
720 position to the selection.
721 * \li Syntax: screen-down-select
724 { LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit },
726 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP_SELECT
727 * \li Action: Moves the cursor one page in upward direction adding the current
728 position to the selection.
729 * \li Syntax: screen-up-select
732 { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit },
734 * \var lyx::FuncCode lyx::LFUN_SCROLL
735 * \li Action: Scroll the buffer view.
736 * \li Notion: Only scrolls the screen up or down; does not move the cursor.
737 * \li Syntax: scroll <TYPE> <QUANTITY>
738 * \li Params: <TYPE>: line|page\n
739 <QUANTITY>: up|down|<number>
740 * \li Origin: Abdel, Dec 27 2007
743 { LFUN_SCROLL, "scroll", ReadOnly, Edit },
745 * \var lyx::FuncCode lyx::LFUN_SCREEN_RECENTER
746 * \li Action: Recenters the screen on the current cursor position.
747 * \li Syntax: screen-recenter
750 { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit },
753 * \var lyx::FuncCode lyx::LFUN_SCREEN_SHOW_CURSOR
754 * \li Action: Repositions the screen such that the cursor is visible.
755 * \li Syntax: screen-show-cursor
756 * \li Origin: vfr, 25 Mar 2009
759 { LFUN_SCREEN_SHOW_CURSOR, "screen-show-cursor", ReadOnly, Edit },
762 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD
763 * \li Action: Moves the cursor one position logically backwards.
764 * \li Notion: This is not the action which should be bound to the arrow keys,
765 because backwards may be left or right, depending on the
766 language. The arrow keys should be bound to #LFUN_CHAR_LEFT or
767 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
768 * \li Syntax: char-backward
771 { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit },
773 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD_SELECT
774 * \li Action: Moves the cursor one position logically backwards, adding
775 traversed position to the selection.
776 * \li Notion: See also #LFUN_CHAR_BACKWARD.
777 * \li Syntax: char-backward-select
780 { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit },
782 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_BACKWARD
783 * \li Action: Deletes one character in the backward direction (usually the "BackSpace" key).
784 * \li Syntax: char-delete-backward
787 { LFUN_CHAR_DELETE_BACKWARD, "char-delete-backward", SingleParUpdate, Edit },
789 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_FORWARD
790 * \li Action: Deletes one character in the backward direction (usually the "Delete" key).
791 * \li Syntax: char-delete-forward
794 { LFUN_CHAR_DELETE_FORWARD, "char-delete-forward", SingleParUpdate, Edit },
796 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD
797 * \li Action: Moves the cursor one position logically forward.
798 * \li Notion: This is not the action which should be bound to the arrow keys,
799 because forward may be left or right, depending on the language.
800 The arrow keys should be bound to #LFUN_CHAR_LEFT or
801 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
802 * \li Syntax: char-forward
805 { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit },
807 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD_SELECT
808 * \li Action: Moves the cursor one position logically forward, adding
809 traversed position to the selection.
810 * \li Notion: See also #LFUN_CHAR_FORWARD.
811 * \li Syntax: char-forward-select
814 { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit },
816 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT
817 * \li Action: Moves the cursor one position "to the left".
818 * \li Notion: This is the action which should be taken when the "left" key
819 is pressed. Generally, it moves the cursor one position to the
820 left. However, in Bidi text this become slightly more
821 complicated, and there are different modes of cursor movement.
822 In "visual mode", this moves left, plain and simple. In "logical
823 mode", movement is logically forward in RTL paragraphs, and
824 logically backwards in LTR paragraphs.
825 * \li Syntax: char-left
828 { LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit },
830 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT_SELECT
831 * \li Action: Moves the cursor one position "to the left", adding
832 traversed position to the selection.
833 * \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement.
834 * \li Syntax: char-left-select
837 { LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit },
839 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT
840 * \li Action: Moves the cursor one position "to the right".
841 * \li Notion: This is the action which should be taken when the "right" key
842 is pressed. Generally, it moves the cursor one position to the
843 right. However, in Bidi text this become slightly more
844 complicated, and there are different modes of cursor movement.
845 In "visual mode", this moves right, plain and simple. In "logical
846 mode", movement is logically forward in LTR paragraphs, and
847 logically backwards in RTL paragraphs.
848 * \li Syntax: char-right
851 { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit },
853 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT_SELECT
854 * \li Action: Moves the cursor one position "to the right", adding
855 traversed position to the selection.
856 * \li Notion: See also #LFUN_CHAR_RIGHT for exact details of the movement.
857 * \li Syntax: char-right-select
860 { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit },
863 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD
864 * \li Action: Moves the cursor to the logically previous beginning of a word.
865 * \li Notion: This is not the action which should be bound to the arrow keys,
866 because backwards may be left or right, depending on the
867 language. The arrow keys should be bound to #LFUN_WORD_LEFT or
868 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
869 * \li Syntax: word-backward
872 { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit },
874 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD_SELECT
875 * \li Action: Moves the cursor to the logically previous beginning of a word,
876 adding the logically traversed text to the selection.
877 * \li Notion: See also #LFUN_WORD_BACKWARD.
878 * \li Syntax: word-backward-select
881 { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
883 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_BACKWARD
884 * \li Action: Deletes characters to the beginning of the word (usually the "C+BackSpace" key).
885 * \li Syntax: word-delete-backward
888 { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
890 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_FORWARD
891 * \li Action: Deletes characters to the end of the word (usually the "C+Delete" key).
892 * \li Syntax: word-delete-forward
895 { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
897 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_FORWARD
898 * \li Action: Search for a given string in forward direction.
899 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
900 * \li Syntax: word-find-forward [<STRING>]
901 * \li Origin: Etienne, 16 Feb 1998
904 { LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit },
906 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_BACKWARD
907 * \li Action: Search for a given string in backward direction.
908 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
909 * \li Syntax: word-find-backward [<STRING>]
910 * \li Origin: Etienne, 20 Feb 1998
913 { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
915 * \var lyx::FuncCode lyx::LFUN_WORD_FIND
916 * \li Action: Search for next occurrence of a string.
917 * \li Syntax: word-find [<DATA>]
918 * \li Params: <DATA>: data encoded from Find dialog (see #lyx::find2string()).
919 If no parameter is given, search with last find-dialog
920 data is used for search (i.e. find-next).
921 * \li Origin: Andre, Jan 7 2004
924 { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
926 * \var lyx::FuncCode lyx::LFUN_WORD_REPLACE
927 * \li Action: Replace a string in the document.
928 * \li Syntax: word-replace [<DATA>]
929 * \li Params: <DATA>: data is of the form
932 <casesensitive> <matchword> <all> <forward> <findnext>"
933 * \li Origin: Andre, Jan 7 2004
936 { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
938 * \var lyx::FuncCode lyx::LFUN_WORD_FINDADV
939 * \li Action: Search for next occurrence of a pattern.
940 * \li Syntax: word-findadv [<DATA>]
941 * \li Params: <DATA>: data encoded from FindAdv dialog (see #lyx::findadv2string()).
942 If no parameter is given, search with last find-dialog
943 data is used for search (i.e. find-next).
944 * \li Origin: Tommaso, Nov 15 2007
947 { LFUN_WORD_FINDADV, "word-findadv", ReadOnly | NoBuffer, Edit },
949 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD
950 * \li Action: Moves the cursor to the logically next beginning of a word.
951 * \li Notion: This is not the action which should be bound to the arrow keys,
952 because forward may be left or right, depending on the language.
953 The arrow keys should be bound to #LFUN_WORD_LEFT or
954 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
955 * \li Syntax: word-forward
958 { LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
960 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD_SELECT
961 * \li Action: Moves the cursor to the logically next beginning of a word,
962 adding the logically traversed text to the selection.
963 * \li Notion: See also #LFUN_WORD_FORWARD.
964 * \li Syntax: word-forward-select
967 { LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
969 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT
970 * \li Action: Moves the cursor to the next beginning of a word "on the left".
971 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
972 "left" key is pressed. Generally, it moves the cursor to the
973 next beginning of a word on the left. However, in Bidi text this
974 become slightly more complicated, and there are different modes
975 of cursor movement. In "visual mode", this moves left, plain and
976 simple. In "logical mode", movement is logically forward in RTL
977 paragraphs, and logically backwards in LTR paragraphs.
978 * \li Syntax: word-left
979 * \li Origin: dov, 28 Oct 2007
982 { LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
984 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT_SELECT
985 * \li Action: Moves the cursor to the next beginning of a word "on the left",
986 adding *logically* traversed text to the selection.
987 * \li Notion: See also #LFUN_WORD_LEFT for exact details of the movement.
988 * \li Syntax: word-left-select
989 * \li Origin: dov, 28 Oct 2007
992 { LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit },
994 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT
995 * \li Action: Moves the cursor to the next beginning of a word "on the right".
996 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
997 "right" key is pressed. Generally, it moves the cursor to the
998 next beginning of a word on the right. However, in Bidi text
999 this become slightly more complicated, and there are different
1000 modes of cursor movement. In "visual mode", this moves right,
1001 plain and simple. In "logical mode", movement is logically
1002 forward in LTR paragraphs, and logically backwards in RTL
1004 * \li Syntax: word-right
1005 * \li Origin: dov, 28 Oct 2007
1008 { LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit },
1010 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT_SELECT
1011 * \li Action: Moves the cursor to the next beginning of a word "on the right",
1012 adding *logically* traversed text to the selection.
1013 * \li Notion: See also #LFUN_WORD_RIGHT for exact details of the movement.
1014 * \li Syntax: word-right-select
1015 * \li Origin: dov, 28 Oct 2007
1018 { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
1020 * \var lyx::FuncCode lyx::LFUN_WORD_SELECT
1021 * \li Action: Puts the word where the cursor stands into the selection.
1022 * \li Syntax: word-select
1023 * \li Origin: Andre, 11 Sep 2002
1026 { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
1028 * \var lyx::FuncCode lyx::LFUN_WORD_CAPITALIZE
1029 * \li Action: Capitalizes the words in the selection (i.e. the first letters)
1030 or the first letter of word at cursor position.
1031 * \li Syntax: word-capitalize [<SEL_TYPE>]
1032 * \li Params: <SEL_TYPE>: if this is equal to "partial", then the
1033 * default word starts at cursor position (emacs-style).
1034 * Otherwise, the whole word is considered.
1037 { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
1039 * \var lyx::FuncCode lyx::LFUN_WORD_UPCASE
1040 * \li Action: Change the words in the selection or word at cursor position
1042 * \li Syntax: word-upcase [<SEL_TYPE>]
1043 * \li Params: <SEL_TYPE>: if this is equal to "partial", then the
1044 * default word starts at cursor position (emacs-style).
1045 * Otherwise, the whole word is considered.
1048 { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
1050 * \var lyx::FuncCode lyx::LFUN_WORD_LOWCASE
1051 * \li Action: Change the words in the selection or word at cursor position
1053 * \li Syntax: word-lowcase [<SEL_TYPE>]
1054 * \li Params: <SEL_TYPE>: if this is equal to "partial", then the
1055 * default word starts at cursor position (emacs-style).
1056 * Otherwise, the whole word is considered.
1059 { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
1061 * \var lyx::FuncCode lyx::LFUN_SPELLING_ADD
1062 * \li Action: Add the word under the cursor to the respective
1063 * spell checker dictionary.
1064 * The default for the language is retrieved from the cursor position.
1065 * \li Syntax: spelling-add [<STRING>] [<LANG>]
1066 * \li Params: <WORD>: word to add
1067 <LANG>: language name (see file languages)
1068 * \li Origin: JSpitzm, 18 Jan 2010
1071 { LFUN_SPELLING_ADD, "spelling-add", ReadOnly, Edit },
1073 * \var lyx::FuncCode lyx::LFUN_SPELLING_IGNORE
1074 * \li Action: Let the spell checker ignore the word under the cursor
1075 * in the current session for the given language.
1076 * The default for the language is retrieved from the cursor position.
1077 * \li Syntax: spelling-ignore [<WORD>] [<LANG>]
1078 * \li Params: <WORD>: word to ignore
1079 <LANG>: language name (see file languages)
1080 * \li Origin: JSpitzm, 18 Jan 2010
1083 { LFUN_SPELLING_IGNORE, "spelling-ignore", ReadOnly, Edit },
1085 * \var lyx::FuncCode lyx::LFUN_SPELLING_REMOVE
1086 * \li Action: Remove the word under the cursor from the respective
1087 * spell checker dictionary.
1088 * The default for the language is retrieved from the cursor position.
1089 * \li Syntax: spelling-remove [<STRING>] [<LANG>]
1090 * \li Params: <WORD>: word to remove
1091 * <LANG>: language name (see file languages)
1092 * \li Origin: SWitt, 28 July 2010
1095 { LFUN_SPELLING_REMOVE, "spelling-remove", ReadOnly, Edit },
1098 * \var lyx::FuncCode lyx::LFUN_SPELLING_CONTINUOUSLY
1099 * \li Action: Toggle continuous spell checking.
1100 * \li Syntax: spelling-continuously
1101 * \li Origin: vfr, 24 March 2013
1104 { LFUN_SPELLING_CONTINUOUSLY, "spelling-continuously", ReadOnly, Edit },
1107 * \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
1108 * \li Action: Look up thesaurus entries with respect to the word under the cursor.
1109 * \li Syntax: thesaurus-entry [<STRING>] [lang=<LANG>]
1110 * \li Params: <STRING>: word to look up
1111 <LANG>: language (see file languages)
1112 * \li Origin: Levon, 20 Jul 2001
1115 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
1117 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN
1118 * \li Action: Move the cursor to the beginning of the document.
1119 * \li Syntax: buffer-begin
1122 { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
1124 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN_SELECT
1125 * \li Action: Move the cursor to the beginning of the document adding the
1126 traversed text to the selection.
1127 * \li Syntax: buffer-begin-select
1130 { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
1132 * \var lyx::FuncCode lyx::LFUN_BUFFER_END
1133 * \li Action: Move the cursor to the end of the document.
1134 * \li Syntax: buffer-end
1137 { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
1139 * \var lyx::FuncCode lyx::LFUN_BUFFER_END_SELECT
1140 * \li Action: Move the cursor to the end of the document adding the
1141 traversed text to the selection.
1142 * \li Syntax: buffer-end-select
1145 { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
1148 * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN
1149 * \li Action: Move the cursor to the beginning of the current inset
1150 if it is not already there, or at the beginning of the
1151 enclosing inset otherwise
1152 * \li Syntax: inset-begin
1153 * \li Origin: lasgouttes, 16 Mar 2009
1156 { LFUN_INSET_BEGIN, "inset-begin", ReadOnly, Edit },
1158 * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN_SELECT
1159 * \li Action: Move the cursor to the beginning of the current inset
1160 if it is not already there, or at the beginning of the
1161 enclosing inset otherwise (adding the
1162 traversed text to the selection).
1163 * \li Syntax: inset-begin-select
1164 * \li Origin: lasgouttes, 16 Mar 2009
1167 { LFUN_INSET_BEGIN_SELECT, "inset-begin-select", ReadOnly, Edit },
1169 * \var lyx::FuncCode lyx::LFUN_INSET_END
1170 * \li Action: Move the cursor to the end of the current inset
1171 if it is not already there, or at the end of the
1172 enclosing inset otherwise
1173 * \li Syntax: inset-end
1174 * \li Origin: lasgouttes, 16 Mar 2009
1177 { LFUN_INSET_END, "inset-end", ReadOnly, Edit },
1179 * \var lyx::FuncCode lyx::LFUN_INSET_END_SELECT
1180 * \li Action: Move the cursor to the end of the current inset
1181 if it is not already there, or at the end of the
1182 enclosing inset otherwise (adding the
1183 traversed text to the selection).
1184 * \li Syntax: inset-end-select
1185 * \li Origin: lasgouttes, 16 Mar 2009
1188 { LFUN_INSET_END_SELECT, "inset-end-select", ReadOnly, Edit },
1191 * \var lyx::FuncCode lyx::LFUN_INSET_SELECT_ALL
1192 * \li Action: Select all contents of an inset.
1193 * \li Notion: There are 3 successive levels: select current cell,
1194 * select all cells of inset, select the inset from outside
1195 * (in the enclosing inset).
1196 * \li Syntax: inset-select-all
1197 * \li Origin: vfr, 22 Aug 2009; lasgouttes 1 Nov 2014
1200 { LFUN_INSET_SELECT_ALL, "inset-select-all", ReadOnly, Edit },
1203 * \var lyx::FuncCode lyx::LFUN_SECTION_SELECT
1204 * \li Action: Select the whole section.
1205 * \li Notion: The cursor should be in a section heading
1206 before calling this lfun.
1207 * \li Syntax: section-select
1208 * \li Origin: vfr, 05 May 2009
1211 { LFUN_SECTION_SELECT, "section-select", ReadOnly, Edit },
1214 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN
1215 * \li Action: Move the cursor to the beginning of the (screen) line.
1216 * \li Syntax: line-begin
1219 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
1221 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN_SELECT
1222 * \li Action: Move the cursor to the beginning of the (screen) line adding the
1223 traversed text to the selection.
1224 * \li Syntax: line-begin-select
1227 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
1229 * \var lyx::FuncCode lyx::LFUN_LINE_END
1230 * \li Action: Move the cursor to the end of the (screen) line.
1231 * \li Syntax: line-end
1234 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
1236 * \var lyx::FuncCode lyx::LFUN_LINE_END_SELECT
1237 * \li Action: Move the cursor to the end of the (screen) line adding the
1238 traversed text to the selection.
1239 * \li Syntax: line-end-select
1242 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
1244 * \var lyx::FuncCode lyx::LFUN_LINE_DELETE_FORWARD
1245 * \li Action: Deletes the letters to the end of the (screen) line or
1246 deletes the selection.
1247 * \li Syntax: line-delete-forward
1250 { LFUN_LINE_DELETE_FORWARD, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
1252 * \var lyx::FuncCode lyx::LFUN_COPY
1253 * \li Action: Copies the current selection to the clipboard.
1257 { LFUN_COPY, "copy", ReadOnly, Edit },
1259 * \var lyx::FuncCode lyx::LFUN_CUT
1260 * \li Action: Cuts to the clipboard.
1264 { LFUN_CUT, "cut", Noop, Edit },
1266 * \var lyx::FuncCode lyx::LFUN_PASTE
1267 * \li Action: Pastes material (text or picture) from the active clipboard.
1268 * \li Syntax: paste [<TYPE>|<NUM>]
1269 * \li Params: <TYPE>: emf|pdf|png|jpeg|linkback|wmf|latex|html \n
1270 <NUM>: number of the selection in the internal clipboard stack to be pasted.
1273 { LFUN_PASTE, "paste", Noop, Edit },
1275 * \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE
1276 * \li Action: Pastes text from the active clipboard (retains formatting if the
1277 clipboard contains formatted text). Pastes plain text if plain text is
1278 on the clipboard, but tries to interpret it in special ways for certain
1279 insets, e.g. converting csv data to rows and columns if the paste happens
1281 * \li Notion: Historically, LFUN_CLIPBOARD_PASTE was introduced as a counterpart of
1282 LFUN_PRIMARY_SELECTION_PASTE: It behaved exactly the same, but the source
1283 is the clipboard, not the selection.
1284 * \li Syntax: clipboard-paste [<ARG>]
1285 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1286 * \li Origin: Georg, 10 Jul 2006
1289 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
1291 * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
1292 * \li Action: Pastes the currently selected text.
1293 * \li Notion: Primary selection mechanism is linux-only thing.
1294 * \li Syntax: primary-selection-paste [<ARG>]
1295 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1298 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
1300 * \var lyx::FuncCode lyx::LFUN_SELECTION_PASTE
1301 * \li Action: Pastes the internal selection text in permanent selection.
1302 * \li Notion: Created in order to have middle mouse button pasting correct (bound to
1303 command-alternatives selection-paste ; primary-selection-paste paragraph).
1304 * \li Syntax: selection-paste
1305 * \li Origin: lasgouttes, 14 Jan 2009
1308 { LFUN_SELECTION_PASTE, "selection-paste", Noop, Edit },
1310 * \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE_SIMPLE
1311 * \li Action: Pastes plain text from the active clipboard even if formatted
1312 LyX content is in the clipboard. Pastes plain text if plain text
1313 is on the clipboard, without trying to interpret it in special
1314 ways for certain insets, e.g. converting csv data to rows and
1315 columns if the paste happens in a tabular inset.
1316 * \li Syntax: clipboard-paste-simple [<ARG>]
1317 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1320 { LFUN_CLIPBOARD_PASTE_SIMPLE, "clipboard-paste-simple", Noop, Edit },
1322 * \var lyx::FuncCode lyx::LFUN_UNDO
1323 * \li Action: Undoes the last edit.
1327 { LFUN_UNDO, "undo", ReadOnly, Edit },
1329 * \var lyx::FuncCode lyx::LFUN_REDO
1330 * \li Action: Redoes the last thing undone.
1334 { LFUN_REDO, "redo", ReadOnly, Edit },
1336 * \var lyx::FuncCode lyx::LFUN_REPEAT
1337 * \li Action: Repeat the given command.
1338 * \li Syntax: repeat <COUNT> <LFUN-COMMAND>
1339 * \li Origin: Andre, 27 Oct 2003
1342 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
1344 * \var lyx::FuncCode lyx::LFUN_CHARS_TRANSPOSE
1345 * \li Action: Transposes the character at the cursor with the one before it.
1346 * \li Syntax: chars-transpose
1347 * \li Origin: Lgb, 25 Apr 2001
1350 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
1353 * \var lyx::FuncCode lyx::LFUN_DEPTH_DECREMENT
1354 * \li Action: Decrease the nesting depth of the (selected) paragraph(s)
1356 * \li Syntax: depth-decrement
1359 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
1361 * \var lyx::FuncCode lyx::LFUN_DEPTH_INCREMENT
1362 * \li Action: Increase the nesting depth of the (selected) paragraph(s)
1364 * \li Syntax: depth-increment
1367 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
1370 * \var lyx::FuncCode lyx::LFUN_FONT_BOLD
1371 * \li Action: Toggles the bold font (selection-wise) using mathbf in math.
1372 * \li Syntax: font-bold
1375 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
1378 * \var lyx::FuncCode lyx::LFUN_FONT_BOLDSYMBOL
1379 * \li Action: Toggles the bold font (selection-wise) using boldsymbol in math.
1380 * \li Syntax: font-boldsymbol
1383 { LFUN_FONT_BOLDSYMBOL, "font-boldsymbol", Noop, Layout },
1385 * \var lyx::FuncCode lyx::LFUN_FONT_TYPEWRITER
1386 * \li Action: Toggles the typewriter family font (selection-wise).
1387 * \li Syntax: font-typewriter
1390 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
1392 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERLINE
1393 * \li Action: Toggles underline in the font (selection-wise).
1394 * \li Syntax: font-underline
1397 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
1399 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERUNDERLINE
1400 * \li Action: Toggles double underline in the font (selection-wise).
1401 * \li Syntax: font-underunderline
1402 * \li Origin: sanda, 5 May 2009
1405 { LFUN_FONT_UNDERUNDERLINE, "font-underunderline", Noop, Layout },
1407 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERWAVE
1408 * \li Action: Toggles wavy underline in the font (selection-wise).
1409 * \li Syntax: font-underwave
1410 * \li Origin: sanda, 5 May 2009
1413 { LFUN_FONT_UNDERWAVE, "font-underwave", Noop, Layout },
1415 * \var lyx::FuncCode lyx::LFUN_FONT_STRIKEOUT
1416 * \li Action: Toggles strikeout (strike-through) in the font (selection-wise).
1417 * \li Syntax: font-strikeout
1418 * \li Origin: sanda, 3 May 2009
1421 { LFUN_FONT_STRIKEOUT, "font-strikeout", Noop, Layout },
1423 * \var lyx::FuncCode lyx::LFUN_FONT_EMPH
1424 * \li Action: Toggles the emphasis font style (selection-wise).
1425 * \li Syntax: font-emph
1428 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
1430 * \var lyx::FuncCode lyx::LFUN_FONT_NOUN
1431 * \li Action: Toggles Noun text style font (selection-wise).
1432 * \li Syntax: font-noun
1435 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
1437 * \var lyx::FuncCode lyx::LFUN_FONT_ROMAN
1438 * \li Action: Toggles Roman family font (selection-wise).
1439 * \li Syntax: font-roman
1442 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
1444 * \var lyx::FuncCode lyx::LFUN_FONT_SANS
1445 * \li Action: Toggles Sans Serif family font (selection-wise).
1446 * \li Syntax: font-sans
1449 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
1451 * \var lyx::FuncCode lyx::LFUN_FONT_FRAK
1452 * \li Action: Toggles Fraktur family font (math-mode, selection-wise).
1453 * \li Syntax: font-frak
1454 * \li Origin: vermeer, 10 Jan 2002
1457 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
1459 * \var lyx::FuncCode lyx::LFUN_FONT_ITAL
1460 * \li Action: Toggles Italics font shape (math-mode, selection-wise).
1461 * \li Syntax: font-ital
1462 * \li Origin: vermeer, 10 Jan 2002
1465 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
1467 * \var lyx::FuncCode lyx::LFUN_FONT_DEFAULT
1468 * \li Action: Reverts the settings of the font to the default values (selection-wise).
1469 * \li Syntax: font-default
1472 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
1474 * \var lyx::FuncCode lyx::LFUN_FONT_SIZE
1475 * \li Action: Sets font size according to lyx format string.
1476 * \li Syntax: font-size <SIZE>
1477 * \li Params: <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|\n
1478 largest|huge|giant|increase|decrease|default
1481 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
1483 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_APPLY
1484 * \li Action: Toggle user-defined (=last-time used) text style.
1485 * \li Notion: This style is set via #LFUN_TEXTSTYLE_UPDATE, which is
1486 automatically triggered when using Text Style dialog.
1487 * \li Syntax: textstyle-apply
1488 * \li Origin: leeming, 12 Mar 2003
1491 { LFUN_TEXTSTYLE_APPLY, "textstyle-apply", Noop, Layout },
1493 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_UPDATE
1494 * \li Action: Apply text style and update the settings to be used by #LFUN_TEXTSTYLE_APPLY.
1495 * \li Syntax: textstyle-update <FONT_INFO>
1496 * \li Params: <FONT_INFO>: specifies font atributes, e.g. family, series, shape,
1497 size, emph, noun, underbar, number, color, language,
1499 Use lyx -dbg action for exact syntax of text-style
1501 * \li Origin: leeming, 12 Mar 2003
1504 { LFUN_TEXTSTYLE_UPDATE, "textstyle-update", Noop, Layout },
1506 * \var lyx::FuncCode lyx::LFUN_SCREEN_FONT_UPDATE
1507 * \li Action: Update fonts and its metrics.
1508 * \li Notion: Automatically called after zoom, dpi, font names, or norm change.
1509 * \li Syntax: screen-font-update
1510 * \li Origin: ARRae, 13 Aug 2000
1513 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
1515 * \var lyx::FuncCode lyx::LFUN_FONT_STATE
1516 * \li Action: Returns the info about the current font.
1517 * \li Syntax: font-state
1520 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
1523 * \var lyx::FuncCode lyx::LFUN_CITATION_INSERT
1524 * \li Action: Inserts citation from loaded citation database.
1525 * \li Syntax: citation-insert [<KEY>[|<TEXT_BEFORE>]]
1526 * \li Params: <KEY>: Citation (shortcut listed in available citations). \n
1527 <TEXT_BEFORE>: text which should appear before citation.
1528 * \li Origin: AAS, 97-02-23
1531 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
1533 * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_ADD
1534 * \li Action: Adds database, which will be used for bibtex citations.
1535 * \li Notion: Databases are added to the first BibTeX inset
1536 (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
1537 * \li Syntax: bibtex-database-add <DATABASE-NAME>
1538 * \li Origin: Ale, 30 May 1997
1541 { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit },
1543 * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_DEL
1544 * \li Action: Adds database, which will be used for bibtex citations.
1545 * \li Notion: Databases are deleted from the first BibTeX inset
1546 (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
1547 * \li Syntax: bibtex-database-del <DATABASE-NAME>
1548 * \li Origin: Ale, 30 May 1997
1551 { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
1554 * \var lyx::FuncCode lyx::LFUN_LAYOUT
1555 * \li Action: Sets the layout (that is, environment) for the current paragraph.
1556 * \li Syntax: layout <LAYOUT>
1557 * \li Params: <LAYOUT>: the layout to use
1560 { LFUN_LAYOUT, "layout", Noop, Layout },
1562 * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH
1563 * \li Action: Launches the paragraph settings dialog.
1564 * \li Syntax: layout-paragraph
1567 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
1569 * \var lyx::FuncCode lyx::LFUN_LAYOUT_TABULAR
1570 * \li Action: Launches the tabular settings dialog.
1571 * \li Syntax: layout-tabular
1572 * \li Origin: Jug, 31 Jul 2000
1575 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
1577 * \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE
1578 * \li Action: Displays list of layout choices.
1579 * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
1580 dropbox allowing for choice of layout.
1581 * \li Syntax: drop-layouts-choice
1584 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
1586 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
1587 * \li Action: Clears the module list.
1588 * \li Notion: Clears the list of included modules for the current buffer.
1589 * \li Syntax: layout-modules-clear
1590 * \li Origin: rgh, 25 August 2007
1593 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", NoInternal, Layout },
1595 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULE_ADD
1596 * \li Action: Adds a module.
1597 * \li Notion: Adds a module to the list of included modules for the current buffer.
1598 * \li Syntax: layout-module-add <MODULE>
1599 * \li Params: <MODULE>: the module to be added
1600 * \li Origin: rgh, 25 August 2007
1603 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", NoInternal, Layout },
1605 * \var lyx::FuncCode lyx::LFUN_LAYOUT_RELOAD
1606 * \li Action: Reloads layout information.
1607 * \li Notion: Reloads all layout information for the current buffer from disk, thus
1608 recognizing any changes that have been made to layout files on the fly.
1609 This is intended to be used only by layout developers and should not be
1610 used when one is trying to do actual work.
1611 * \li Syntax: layout-reload
1612 * \li Origin: rgh, 3 September 2007
1615 { LFUN_LAYOUT_RELOAD, "layout-reload", NoInternal, Layout },
1617 * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW_CACHE
1618 * \li Action: Opens the file that was created from last preview of this buffer.
1619 * \li Notion: This LFUN is called by the "Show Output Anyway" button in the LaTeX
1620 * Errors dialog. It can also be called by the user, which is useful
1621 * if the document takes a long time to compile, and you just
1622 * want to see the last previewed version.
1623 * \li Syntax: buffer-view-cache
1626 { LFUN_BUFFER_VIEW_CACHE, "buffer-view-cache", ReadOnly, Buffer },
1628 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
1629 * \li Action: Sets the text class for the current buffer.
1630 * \li Syntax: textclass-apply <TEXTCLASS>
1631 * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
1632 the filename, minus the ".layout" extension.
1635 { LFUN_TEXTCLASS_APPLY, "textclass-apply", NoInternal, Layout },
1637 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
1638 * \li Action: Loads information for a textclass from disk.
1639 * \li Syntax: textclass-load <TEXTCLASS>
1640 * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
1641 the filename, minus the ".layout" extension.
1644 { LFUN_TEXTCLASS_LOAD, "textclass-load", NoInternal, Layout },
1647 * \var lyx::FuncCode lyx::LFUN_MARK_OFF
1648 * \li Action: Disable selecting of text-region.
1649 * \li Syntax: mark-off
1652 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
1654 * \var lyx::FuncCode lyx::LFUN_MARK_ON
1655 * \li Action: Enable selecting of text-region.
1656 * \li Notion: After enabling you can simply move arrow keys to get selected region.
1657 * \li Syntax: mark-on
1660 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
1662 * \var lyx::FuncCode lyx::LFUN_MARK_TOGGLE
1663 * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
1664 * \li Syntax: mark-toggle
1665 * \li Origin: Andre, May 5 2006
1668 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
1671 * \var lyx::FuncCode lyx::LFUN_MATH_DELIM
1672 * \li Action: Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
1673 * \li Syntax: math-delim [<LEFT>] [<RIGHT>]
1674 * \li Params: <LEFT/RIGHT>: Delimiters to be used. Each delimiter can be specified by
1675 either a LaTeX name or a valid character.
1676 ( is the default letter.
1677 * \li Sample: math-delim { rangle
1678 * \li Origin: Alejandro, 18 Jun 1996
1681 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
1683 * \var lyx::FuncCode lyx::LFUN_MATH_BIGDELIM
1684 * \li Action: Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
1685 * \li Syntax: math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
1686 * \li Params: <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r \n
1687 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
1688 * \li Sample: math-bigdelim "Bigl" "\Downarrow" "Bigr" "\}"
1689 * \li Origin: Enrico & Georg, 7 May 2006
1692 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
1694 * \var lyx::FuncCode lyx::LFUN_MATH_DISPLAY
1695 * \li Action: Creates a new displayed equation in text mode.
1696 Toggles inlined/display formula in math mode.
1697 * \li Syntax: math-display [<ARG>]
1698 * \li Params: <ARG>: this argument will be passed to #LFUN_MATH_INSERT when creating
1699 new equation from the text mode.
1700 * \li Origin: Alejandro, 18 Jun 1996
1703 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
1705 * \var lyx::FuncCode lyx::LFUN_MATH_INSERT
1706 * \li Action: Inserts math objects and symbols.
1707 * \li Syntax: math-insert <ARG>
1708 * \li Params: <ARG>: Symbol or LaTeX code to be inserted.
1709 * \li Notion: When <ARG> is a _single_ math inset with more than one cell
1710 (such as "x_y^z" or "\frac{x}{y}"), the content of cell(0) is
1711 replaced by the current selection (only works if the selection
1712 is in mathed). As an example, if "abc" is selected in mathed,
1713 "math-insert \frac{x}{y}" replaces "abc" with "\frac{abc}{y}",
1714 and "math-insert x_y^z" replaces "abc" with "abc_y^z".
1715 If nothing is selected (or the selection is not in mathed),
1716 math-insert works as expected.
1719 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
1721 * \var lyx::FuncCode lyx::LFUN_MATH_SUBSCRIPT
1722 * \li Action: Enters subscript expression in math expression.
1723 * \li Syntax: math-subscript
1724 * \li Origin: vermeer, 12 Dec 2001
1727 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
1729 * \var lyx::FuncCode lyx::LFUN_MATH_SUPERSCRIPT
1730 * \li Action: Enters superscript expression in math expression.
1731 * \li Syntax: math-superscript
1732 * \li Origin: vermeer, 12 Dec 2001
1735 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
1737 * \var lyx::FuncCode lyx::LFUN_MATH_LIMITS
1738 * \li Action: Toggles the position of the limits from above/below to the right
1739 side an vice versa in integral symbol, a limit, a summation, etc.
1740 * \li Notion: Put the cursor before the symbol with the limits and then invoke
1742 * \li Syntax: math-limits [<STATE>]
1743 * \li Params: <STATE>: limits|nolimits
1746 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
1748 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO
1749 * \li Action: Inserts a math macro definition at the cursor position in the text.
1750 * \li Syntax: math-macro <NAME> [<NARGS>] [def]
1751 * \li Params: <NAME>: The name of the macro, e.g. "mymacro".\n
1752 <NARGS>: The number of parameters of the macro. Default is 0.
1753 "def": Has no effect anymore, just for compatibility with former LyX versions.
1754 * \li Origin: ale, 10 May 1997; sts, 21 Dec 2007
1757 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
1759 * \var lyx::FuncCode lyx::LFUN_MATH_MUTATE
1760 * \li Action: Mutates the type of math inset to the newly selected one.
1761 * \li Syntax: math-mutate <TYPE>
1762 * \li Params: <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
1763 multline|gather|flalign
1764 * \li Origin: Andre, 23 May 2001
1767 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
1769 * \var lyx::FuncCode lyx::LFUN_MATH_SPACE
1770 * \li Action: Inserts space into math expression.
1771 * \li Notion: Use spacebar after entering this space to change type of space.
1772 * \li Syntax: math-space [<TYPE>] [<LEN>]
1773 * \li Params: <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace \n
1774 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad \n
1775 custom space: hspace \n
1776 "," used by default.\n
1777 Note that ! is equivalent to negthinspace, , = thinspace,
1778 : = medspace, and ; = thickspace.\n
1779 <LEN>: length for custom spaces (hspace)
1780 * \li Origin: Andre, 25 Jul 2001; sanda, 16 Jun 2008
1783 { LFUN_MATH_SPACE, "math-space", Noop, Math },
1785 * \var lyx::FuncCode lyx::LFUN_MATH_MATRIX
1786 * \li Action: Inserts a matrix.
1787 * \li Syntax: math-matrix <COLS> <ROWS> [<ALIGN>]
1788 * \li Params: <ALIGN>: Alignment is a word composed of the vertical alignment
1789 (b, c or t) (i.e. 1 char) and the horizontal alignments
1790 (l, c or r) (i.e. <COL> chars).
1791 * \li Sample: math-matrix 3 3 bccc
1794 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
1796 * \var lyx::FuncCode lyx::LFUN_MATH_AMS_MATRIX
1797 * \li Action: Inserts an extended matrix as provided by the amsmath package.
1798 * \li Syntax: math-matrix <COLS> <ROWS> [<DECORATION>]
1799 * \li Params: <DECORATION>: Decoration determines the LaTeX name of the matrix
1800 that should be created. Possible values include
1801 pmatrix, bmatrix, Bmatrix, vmatrix, Vmatrix and
1802 matrix. The default is 'matrix'.
1803 * \li Sample: math-ams-matrix 3 3 bmatrix
1806 { LFUN_MATH_AMS_MATRIX, "math-ams-matrix", Noop, Math },
1808 * \var lyx::FuncCode lyx::LFUN_MATH_MODE
1809 * \li Action: In text mode enters math mode (i.e. puts math insets on the current
1810 cursor position), in math mode enters text mode inside math expression.
1811 * \li Notion: If there is some selected text, it puts the text inside created math box.
1812 * \li Syntax: math-mode [on|<ARG>]
1813 * \li Params: <ARG>: eventual argument (LaTeX code) is passed to #LFUN_MATH_INSERT .\n
1814 "on": allow only entering of math mode from text mode.
1815 * \li Origin: Alejandro, 4 Jun 1996
1818 { LFUN_MATH_MODE, "math-mode", Noop, Math },
1820 * \var lyx::FuncCode lyx::LFUN_REGEXP_MODE
1821 * \li Action: Enters regexp mode (i.e., puts regexp insets on the current
1822 cursor position). Used by the advanced search dialog.
1823 * \li Notion: If there is any selected text, then it is moved inside the created
1825 * \li Syntax: regexp-mode [<ARG>]
1826 * \li Params: <ARG>: eventual argument (regular expression).
1827 * \li Origin: Tommaso, 4 Oct 2008
1830 { LFUN_REGEXP_MODE, "regexp-mode", Noop, Math },
1832 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
1833 * \li Action: Toggles numbering of the current formula line.
1834 * \li Notion: Must be in display formula mode.
1835 * \li Syntax: math-number-line-toggle
1836 * \li Origin: Alejandro, 18 Jun 1996
1839 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
1841 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
1842 * \li Action: Toggles numbering/labeling of the current formula.
1843 * \li Notion: Must be in display formula mode.
1844 * \li Syntax: math-number-toggle
1845 * \li Origin: Alejandro, 4 Jun 1996
1848 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
1850 * \var lyx::FuncCode lyx::LFUN_MATH_EXTERN
1851 * \li Action: Calls external program and passes the current expression/equation
1852 as an argument for the calculation in the format appropriate to the
1854 * \li Notion: Selection can be used to determine the input for the external program.
1855 * \li Syntax: math-extern <LANG> [<COMMAND>]
1856 * \li Params: <LANG>: octave|maxima|maple|mathematica|script \n
1857 where "script" stands for the external script (normalized
1858 expression will be passed)
1859 * \li Origin: Andre, 24 Apr 2001
1860 * \li Sample: math-extern maple simplify
1863 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
1865 * \var lyx::FuncCode lyx::LFUN_MATH_SIZE
1866 * \li Action: Changes arbitrarily the size used by math fonts inside a context.
1867 * \li Notion: Provides an interface to the LaTeX math mode font size commands.
1868 * \li Syntax: math-size <STYLE>
1869 * \li Params: <STYLE>: \displaystyle|\textstyle|\scriptstyle|\scriptscriptstyle
1870 * \li Origin: Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
1873 { LFUN_MATH_SIZE, "math-size", Noop, Math },
1875 * \var lyx::FuncCode lyx::LFUN_MATH_FONT_STYLE
1876 * \li Action: Changes the text style used in math.
1877 * \li Syntax: math-font-style <STYLE>
1878 * \li Params: <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf|textnormal\n
1879 |textrm|textsf|texttt|textbf|textmd|textit|textsc|textsl|textup
1880 * \li Origin: vfr, 9 jan 2009
1883 { LFUN_MATH_FONT_STYLE, "math-font-style", Noop, Math },
1885 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
1886 * \li Action: Unfold a Math Macro.
1887 * \li Notion: Unfold the Math Macro the cursor is in, i.e.
1889 * \li Syntax: math-macro-unfold
1890 * \li Origin: sts, 06 January 2008
1893 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
1895 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
1896 * \li Action: Fold a Math Macro.
1897 * \li Notion: Fold the Math Macro the cursor is in if it was
1898 unfolded, i.e. displayed as \foo before.
1899 * \li Syntax: math-macro-fold
1900 * \li Origin: sts, 06 January 2008
1903 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
1905 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
1906 * \li Action: Add a parameter.
1907 * \li Notion: Add a parameter to a Math Macro.
1908 * \li Params: <NUM>: The number of the parameter behind which the new one
1909 will be added (1 for the first, i.e. use 0 for add a
1910 parameter at the left), defaults to the last one.
1911 * \li Syntax: math-macro-add-param <NUM>
1912 * \li Origin: sts, 06 January 2008
1915 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
1917 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
1918 * \li Action: Remove the last parameter.
1919 * \li Notion: Remove the last parameter of a Math Macro and
1920 remove its value in all instances of the macro
1922 * \li Params: <NUM>: The number of the parameter to be deleted (1 for
1923 the first), defaults to the last one.
1924 * \li Syntax: math-macro-remove-param <NUM>
1925 * \li Origin: sts, 06 January 2008
1928 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
1930 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
1931 * \li Action: Append a greedy parameter.
1932 * \li Notion: Append a greedy parameter to a Math Macro which
1933 eats the following mathed cell in every instance of
1934 the macro in the buffer.
1935 * \li Syntax: math-macro-append-greedy-param
1936 * \li Origin: sts, 06 January 2008
1939 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
1941 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
1942 * \li Action: Remove a greedy parameter.
1943 * \li Notion: Remove a greedy parameter of a Math Macro and spit
1944 out the values of it in every instance of the macro
1945 in the buffer. If it is an optional parameter the [valud]
1947 * \li Syntax: math-macro-remove-greedy-param
1948 * \li Origin: sts, 06 January 2008
1951 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
1953 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
1954 * \li Action: Make a parameter optional.
1955 * \li Notion: Turn the first non-optional parameter of a Math Macro
1956 into an optional parameter with a default value.
1957 * \li Syntax: math-macro-make-optional
1958 * \li Origin: sts, 06 January 2008
1961 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
1963 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
1964 * \li Action: Make a parameter non-optional.
1965 * \li Notion: Turn the last optional parameter of a Math Macro
1966 into a non-optional parameter. The default value is
1967 remembered to be reused later if the user changes his mind.
1968 * \li Syntax: math-macro-make-nonoptional
1969 * \li Origin: sts, 06 January 2008
1972 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
1974 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
1975 * \li Action: Add an optional parameter.
1976 * \li Notion: Insert an optional parameter just behind the
1977 already existing optional parameters.
1978 * \li Syntax: math-macro-add-optional-param
1979 * \li Origin: sts, 06 January 2008
1982 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
1984 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
1985 * \li Action: Remove the last optional parameter.
1986 * \li Notion: Remove the last optional parameter of a Math Macro and
1987 remove it in all the instances of the macro in the buffer.
1988 * \li Syntax: math-macro-remove-optional-param
1989 * \li Origin: sts, 06 January 2008
1992 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
1994 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
1995 * \li Action: Add a greedy optional parameter.
1996 * \li Notion: Add a greedy optional parameter which eats the value
1997 from the following cells in mathed which are in the [value]
1999 * \li Syntax: math-macro-add-greedy-optional-param
2000 * \li Origin: sts, 06 January 2008
2003 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
2005 * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
2006 * \li Action: Only active in Math Macro definition.
2007 * \li Notion: Dummy function which is only active in a Math Macro definition.
2008 It's used to toggle the Math Macro toolbar if the cursor moves
2009 into a Math Macro definition.
2010 * \li Syntax: in-mathmacrotemplate
2011 * \li Origin: sts, 06 January 2008
2014 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
2017 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
2018 * \li Action: Moves the current paragraph downwards in the document.
2019 * \li Syntax: paragraph-move-down
2020 * \li Origin: Edwin, 8 Apr 2006
2023 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
2025 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
2026 * \li Action: Moves the current paragraph upwards in the document.
2027 * \li Notion: Movement through the document will possibly break the paragraph-depth
2028 (e.g. itemize structure).
2029 * \li Syntax: paragraph-move-up
2030 * \li Origin: Edwin, 8 Apr 2006
2033 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
2036 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP
2037 * \li Action: Move the cursor to the next paragraph (or beginning of the current one)
2038 in upward direction.
2039 * \li Syntax: paragraph-up
2040 * \li Origin: Asger, 1 Oct 1996
2043 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
2045 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP_SELECT
2046 * \li Action: Move the cursor and select the text to the next paragraph (or
2047 beginning of the current one) in upward direction.
2048 * \li Syntax: paragraph-up-select
2049 * \li Origin: Asger, 1 Oct 1996
2052 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
2054 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN
2055 * \li Action: Move the cursor to the next paragraph (or beginning of the current one)
2056 in downward direction.
2057 * \li Syntax: paragraph-down
2058 * \li Origin: Asger, 1 Oct 1996
2061 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
2063 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN_SELECT
2064 * \li Action: Move the cursor and select the text to the next paragraph (or
2065 beginning of the current one) in downward direction.
2066 * \li Syntax: paragraph-down-select
2067 * \li Origin: Asger, 1 Oct 1996
2070 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
2072 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
2073 * \li Action: Jump to a paragraph given by its id number and optionally the
2074 desired position within the paragraph.
2075 If given four arguments id_start, pos_start, id_end, pos_end,
2076 perform a selection from start to end.
2077 * \li Notion: Note that id number of paragraph is not the sequential number of
2078 paragraph seen on the screen. Moreover the id is unique for all
2079 opened buffers (documents). Both ids must belong to the same
2081 * \li Syntax: paragraph-goto <PAR_ID> <POS_IN_PAR> [<PAR_ID> <POS_IN_PAR>]
2082 * \li Params: <PAR_ID>: paragraph id \n
2083 <POS_IN_PAR>: desired position within the paragraph
2084 * \li Origin: Dekel, 26 Aug 2000
2088 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly | NoInternal, Edit },
2090 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_BREAK
2091 * \li Action: Breaks the current paragraph at the current location.
2092 * \li Notion: Removes the selection.
2093 * \li Syntax: paragraph-break [<LAYOUT>]
2094 * \li Params: <LAYOUT>: "inverse" - decreases depth by one (or change layout
2095 to default layout) when the cursor is at the end of
2099 { LFUN_PARAGRAPH_BREAK, "paragraph-break", Noop, Edit },
2101 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
2102 * \li Action: Change paragraph settings.
2103 * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
2104 This function only modifies, and does not override, existing settings.
2105 Note that the "leftindent" indent setting is deprecated.
2106 * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
2107 * \li Params: <INDENT>: \noindent|\indent|\indent-toggle|\leftindent LENGTH\n
2108 <SPACING>: \paragraph_spacing default|single|onehalf|double|other SIZE \n
2109 <ALIGN>: \align block|left|right|center|default\n
2110 <OTHERS>: \labelwidthstring WIDTH|\start_of_appendix
2111 * \li Origin: rgh, Aug 15 2007
2114 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
2116 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
2117 * \li Action: Change paragraph settings.
2118 * \li Notion: Overwrite all nonspecified settings to the default ones.
2119 Use paragraph-params lfun if you don't want to overwrite others settings.
2120 * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
2121 * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
2122 * \li Origin: leeming, 30 Mar 2004
2125 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
2127 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UPDATE
2128 * \li Action: Updates the values inside the paragraph dialog from the paragraph.
2129 * \li Notion: This is an internal LFUN, not to be used by users. Called internally
2130 by #LFUN_DIALOG_UPDATE.
2131 * \li Origin: leeming, 13 Mar 2003
2134 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
2137 * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
2138 * \li Action: Move the current group in the upward direction in the
2139 structure of the document.
2140 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
2141 the whole substructure of the group.
2142 * \li Syntax: outline-up
2143 * \li Origin: Vermeer, 23 Mar 2006
2146 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
2148 * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
2149 * \li Action: Move the current group in the downward direction in the
2150 structure of the document.
2151 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
2152 the whole substructure of the group.
2153 * \li Syntax: outline-down
2154 * \li Origin: Vermeer, 23 Mar 2006
2157 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
2159 * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
2160 * \li Action: Moves the current group in the downward direction in the
2161 hierarchy of the document structure.
2162 * \li Notion: Part -> Chapter -> Section -> etc.
2163 * \li Syntax: outline-in
2164 * \li Origin: Vermeer, 23 Mar 2006
2167 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
2169 * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
2170 * \li Action: Moves the current group in the upward direction in the
2171 hierarchy of the document structure.
2172 * \li Notion: Part <- Chapter <- Section <- etc.
2173 * \li Syntax: outline-out
2174 * \li Origin: Vermeer, 23 Mar 2006
2177 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
2180 * \var lyx::FuncCode lyx::LFUN_INSET_EDIT
2181 * \li Action: Edit the inset at cursor with an external application,
2182 if one is attributed.
2183 * \li Syntax: inset-edit [<INSET_PARAMS>]
2184 * \li Params: <INSET_PARAMS>: Parameters for the inset. \n
2185 Currently only the filename will be considered.
2186 * \li Origin: JSpitzm, 27 Apr 2006
2189 { LFUN_INSET_EDIT, "inset-edit", ReadOnly | AtPoint, Edit },
2192 * \var lyx::FuncCode lyx::LFUN_TABULAR_INSERT
2193 * \li Action: Inserts table into the document.
2194 * \li Notion: See #LFUN_TABULAR_FEATURE for some more details
2195 about tabular modifications.
2196 * \li Syntax: tabular-insert [<ROWS> <COLUMNS>]
2197 * \li Params: In case no arguments are given show insert dialog.
2198 * \li Origin: Jug, 12 Apr 2000
2201 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
2204 * \var lyx::FuncCode lyx::LFUN_CELL_BACKWARD
2205 * \li Action: Moves the cursor to the previous cell inside the table.
2206 * \li Syntax: cell-backward
2207 * \li Origin: Jug, 22 May 2000
2210 { LFUN_CELL_BACKWARD, "cell-backward", ReadOnly | NoUpdate, Edit },
2212 * \var lyx::FuncCode lyx::LFUN_CELL_FORWARD
2213 * \li Action: Moves the cursor to the next cell inside the table.
2214 * \li Syntax: cell-forward
2217 { LFUN_CELL_FORWARD, "cell-forward", ReadOnly | NoUpdate, Edit },
2219 * \var lyx::FuncCode lyx::LFUN_CELL_SPLIT
2220 * \li Action: Splits cell and shifts right part to the next cell (inside the math grid).
2221 * \li Syntax: cell-split
2222 * \li Origin: Ale, 15 May 1997
2225 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
2228 * \var lyx::FuncCode lyx::LFUN_VC_REGISTER
2229 * \li Action: Register the document as an file inside version control system.
2230 * \li Notion: File is registered inside cvs, svn or rcs repository acording to the existence
2231 of cvs/svn/rcs entries in the document's directory. \n
2232 See LyX Additional Features Manual (Version Control Chapter) for additional
2234 * \li Syntax: vc-register
2235 * \li Origin: Lgb, 1 Jul 1997
2238 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
2240 * \var lyx::FuncCode lyx::LFUN_VC_RENAME
2241 * \li Action: Renames the document to another name.
2242 * \li Notion: Renaming with revision history is only supported by SVN.
2243 For CVS it is simulated by adding the document under a new
2244 name and deleting the old one. For RCS it is not supported.
2245 Disabled if uncommitted changes exist.
2246 * \li Syntax: vc-rename <FILENAME>
2247 * \li Params: <FILENAME>: New name of the document.\n
2248 * A file dialog is opened if no filename is given.
2249 * \li Origin: gb, 05 Feb 2013
2252 { LFUN_VC_RENAME, "vc-rename", ReadOnly, System },
2254 * \var lyx::FuncCode lyx::LFUN_VC_COPY
2255 * \li Action: Copies the document to another name.
2256 * \li Notion: Copying with revision history is only supported by SVN.
2257 For RCS and CVS it is simulated by adding the document
2259 Disabled if uncommitted changes exist.
2260 * \li Syntax: vc-copy <FILENAME>
2261 * \li Params: <FILENAME>: New name of the document.\n
2262 * A file dialog is opened if no filename is given.
2263 * \li Origin: gb, 05 Feb 2013
2266 { LFUN_VC_COPY, "vc-copy", ReadOnly, System },
2268 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_IN
2269 * \li Action: Checks-in/commits the changes of the registered file to the repository.
2270 * \li Notion: In RCS case this also unlocks the file.
2271 * \li Syntax: vc-check-in
2272 * \li Origin: Lgb, 1 Jul 1997
2275 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
2277 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_OUT
2278 * \li Action: Checks-out the document for edit (and locks it in some cases).
2279 * \li Syntax: vc-check-out
2280 * \li Origin: Lgb, 1 Jul 1997
2283 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
2285 * \var lyx::FuncCode lyx::LFUN_VC_REVERT
2286 * \li Action: Reverts the document to the last check-in/commit in VCS.
2287 * \li Syntax: vc-revert
2288 * \li Origin: Lgb, 1 Jul 1997
2291 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
2293 * \var lyx::FuncCode lyx::LFUN_VC_UNDO_LAST
2294 * \li Action: Undo last check-in.
2295 * \li Notion: This is currently implemented only for RCS.
2296 * \li Syntax: vc-check-out
2297 * \li Origin: Lgb, 1 Jul 1997
2300 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
2302 * \var lyx::FuncCode lyx::LFUN_VC_COMMAND
2303 * \li Action: Executes external command. This command is intended to support
2304 additional VCS commands.
2305 * \li Syntax: vc-command <FLAG> <PATH> <COMMAND>
2306 * \li Params: <FLAG>: Flags for the command can be combined together.\n
2307 U - dUmmy - no flags \n
2308 D - Doc - need document loaded to proceed \n
2309 I - dIrty - mark document dirty \n
2310 R - Reload - ensure that the document is saved and reload it after command execution \n
2311 M - Message - ask for input string (commit message)\n
2312 <PATH>: path where to start. $$p will be replaced by the current document path.\n
2313 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current
2314 document(with absolute path)/path/message.
2315 * \li Sample: vc-command DR $$p "svn up"
2316 * \li Origin: sanda, 13 Jan 2009
2319 { LFUN_VC_COMMAND, "vc-command", NoBuffer | ReadOnly, System },
2321 * \var lyx::FuncCode lyx::LFUN_VC_LOCKING_TOGGLE
2322 * \li Action: Toggles the locking property of the edited file.
2323 * \li Notion: This is currently implemented only for SVN.
2324 * \li Syntax: vc-locking-toggle
2325 * \li Origin: sanda, 25 Jun 2009
2328 { LFUN_VC_LOCKING_TOGGLE, "vc-locking-toggle", ReadOnly, System },
2330 * \var lyx::FuncCode lyx::LFUN_VC_REPO_UPDATE
2331 * \li Action: Update the local archive directory in which resides
2332 the current document with the remote repository.
2333 * \li Syntax: vc-repo-update
2334 * \li Origin: sanda, 16 Oct 2009
2337 { LFUN_VC_REPO_UPDATE, "vc-repo-update", ReadOnly, System },
2339 * \var lyx::FuncCode lyx::LFUN_VC_COMPARE
2340 * \li Action: Compares two revisions of the same file under version control.
2341 * \li Syntax: vc-compare [<REV1>] [<REV2>]
2342 * \li Params: Revision number either points directly to commit in history
2343 or if negative number -x it points to (last commit - x).\n
2344 In RCS we subtract only in the last number of revision specification.
2345 Special case "0" is reserved for the last committed revision.\n
2346 <REV1>: Older file.\n
2347 <REV2>: Newer file. Used only if REV1 > 0.\n
2348 If no parameter is given, interactive dialog will be shown.
2349 * \li Sample: Compare current document against last commit\n
2351 Compare current document against current revision - 5 commits\n
2353 Compare revisions 120 and 155\n
2355 * \li Origin: sanda, 12 Feb 2010
2358 { LFUN_VC_COMPARE, "vc-compare", ReadOnly, System },
2361 * \var lyx::FuncCode lyx::LFUN_CHANGES_TRACK
2362 * \li Action: Toggles change tracking to on/off.
2363 * \li Syntax: changes-track
2364 * \li Origin: levon, 1 Oct 2002
2367 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
2369 * \var lyx::FuncCode lyx::LFUN_CHANGES_OUTPUT
2370 * \li Action: Toggles showing of change tracking in typeset output.
2371 * \li Syntax: changes-output
2372 * \li Origin: jspitzm, 21 Jan 2005
2375 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
2377 * \var lyx::FuncCode lyx::LFUN_CHANGE_NEXT
2378 * \li Action: Moves the cursor to the position of the next change
2379 of the change tracking records.
2380 * \li Syntax: change-next
2381 * \li Origin: schmitt, 4 Oct 2006
2384 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
2386 * \var lyx::FuncCode lyx::LFUN_CHANGE_PREVIOUS
2387 * \li Action: Moves the cursor to the position of the previous change
2388 of the change tracking records.
2389 * \li Syntax: change-previous
2390 * \li Origin: vfr, 4 Apr 2009
2393 { LFUN_CHANGE_PREVIOUS, "change-previous", ReadOnly, Edit },
2395 * \var lyx::FuncCode lyx::LFUN_CHANGES_MERGE
2396 * \li Action: Open change tracking dialog for merging and moves the cursor
2397 to the position of the next change.
2398 * \li Syntax: changes-merge
2399 * \li Origin: Levon, 16 Oct 2002
2402 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
2404 * \var lyx::FuncCode lyx::LFUN_CHANGE_ACCEPT
2405 * \li Action: Accepts tracked change inside the selection.
2406 * \li Syntax: change-accept
2407 * \li Origin: Levon, 16 Oct 2002
2410 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
2412 * \var lyx::FuncCode lyx::LFUN_CHANGE_REJECT
2413 * \li Action: Rejects tracked change inside the selection.
2414 * \li Syntax: change-reject
2415 * \li Origin: Levon, 16 Oct 2002
2418 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
2420 * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_ACCEPT
2421 * \li Action: Accepts all tracked changes in the document.
2422 * \li Syntax: all-changes-accept
2423 * \li Origin: Levon, 16 Oct 2002
2426 { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
2428 * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_REJECT
2429 * \li Action: Rejects all tracked changes in the document.
2430 * \li Notion: Reject does not work recursively; the user may have to repeat the operation.
2431 * \li Syntax: all-changes-reject
2432 * \li Origin: Levon, 16 Oct 2002
2435 { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
2438 * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
2439 * \li Action: Apply data for an inset.
2440 * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
2441 be applied. This is either changed to #LFUN_INSET_MODIFY or
2442 #LFUN_INSET_INSERT depending on the context where it is called.
2443 * \li Syntax: inset-apply <ARGS>
2444 * \li Params: See #LFUN_INSET_INSERT .
2447 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
2449 * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE
2450 * \li Action: Dissolve the current inset into text.
2451 * \li Syntax: inset-dissolve [<INSET>]
2452 * \li Params: <INSET>: this can be used to make sure the right kind of inset
2453 is dissolved. For example "dissolve" entry in the charstyles
2454 sub-menu should only dissolve the charstyle inset, even if the
2455 cursor is inside several nested insets of different type.\n
2456 For values see #lyx::InsetLayout::lyxtype_ .
2457 * \li Origin: JSpitz, 7 Aug 2006
2460 { LFUN_INSET_DISSOLVE, "inset-dissolve", AtPoint, Edit },
2462 * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
2463 * \li Action: Insert new inset (type given by the parameters).
2464 * \li Syntax: inset-insert <INSET> <ARGS>
2465 * \li Params: <INSET>: <bibitem|bibtex|citation|ert|listings|external|graphics|tabular|\n
2466 hyperlink|include|index|label|line|nomencl|vspace|ref|toc|script>\n
2467 <ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
2468 * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
2469 where <label name> is the name of the referenced label and
2470 <Format> is one of the following: \n
2471 ref -- <reference> \n
2472 eqref -- (<reference>) \n
2473 pageref -- <page> \n
2474 vpageref -- on <page> \n
2475 vref -- <reference> on <page> \n
2476 formatted -- Formatted reference
2479 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
2481 * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
2482 * \li Action: Modify some properties of an inset.
2483 * \li Notion: Used for argument, bibitem, bibtex, box, branch, caption, citation,
2484 command, ert, external, float, graphics, include, index,
2485 info, label, line, listings, newline, newpage, nomencl,
2486 note, phantom, quotes, ref, script, separator, space,
2487 tabular, vspace and wrap insets.
2488 * \li Syntax: inset-modify <INSET> <ARGS> \n
2489 inset-modify changetype <TYPE>
2490 * \li Sample: Change a Note inset into a Comment inset: \n
2491 inset-modify note Note Comment \n
2492 Change a Box into an Ovalbox: \n
2493 inset-modify changetype Ovalbox \n
2494 Change a quotation mark to e[nglish style], l[eft side = opening], s[ingle = inner, secondary] \n
2495 inset-modify changetype els \n
2496 Change only the style of a quotation mark, maintaining the other aspects (. = wildcard) \n
2497 inset-modify changetype e.. \n
2500 { LFUN_INSET_MODIFY, "inset-modify", AtPoint, Edit },
2502 * \var lyx::FuncCode lyx::LFUN_TABULAR_FEATURE
2503 * \li Action: Modify properties of tabulars and table-like math environments.
2504 * \li Syntax: tabular-feature <FEATURE> [<ARG>]
2505 * \li Params: Generally see #LFUN_INSET_INSERT for further details.\n
2506 * <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|\n
2507 copy-column|move-column-right|move-column-left|move-row-down|move-row-up|\n
2508 toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|\n
2509 align-left|align-right|align-center|align-block|align-decimal|set-decimal-point|\n
2510 valign-top|valign-bottom|valign-middle|longtabular-align-left|\n
2511 longtabular-align-center|longtabular-align-right|m-align-left|m-align-right|\n
2512 m-align-center|m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|\n
2513 set-all-lines|unset-all-lines|toggle-longtabular|set-longtabular|unset-longtabular|set-pwidth|\n
2514 set-mpwidth|set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|\n
2515 set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|\n
2516 unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|\n
2517 set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|\n
2518 set-special-column|set-special-multicolumn|set-special-multirow|\n
2519 toggle-booktabs|set-booktabs|unset-booktabs|set-top-space|set-bottom-space|\n
2520 set-interline-space|set-border-lines|tabular-valign-top|\n
2521 tabular-valign-middle|tabular-valign-bottom|set-tabular-width\n
2522 Various math-environment features are handled as well, e.g. add-vline-left/right for\n
2523 the Grid/Array environment.\n
2524 <ARG>: additional argument for some commands, use debug mode to explore its values.
2525 * \li Origin: gm, 10 Dec 2015
2528 { LFUN_TABULAR_FEATURE, "tabular-feature", Noop, Edit },
2530 * \var lyx::FuncCode lyx::LFUN_INSET_DIALOG_UPDATE
2531 * \li Action: Updates the values inside the dialog from the inset.
2532 * \li Notion: This is an internal LFUN, not to be used by users. Called internally
2533 by #LFUN_DIALOG_UPDATE
2534 * \li Params: <DIALOG-NAME>
2535 * \li Origin: leeming, 25 Feb 2003
2538 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
2540 * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
2541 * \li Action: Open the inset's properties dialog.
2542 * \li Notion: Used for bibitem, bibtex, box, branch, citation, ert, external,
2543 float, graphics, href, include, index, index_print, label, line,
2544 listings, note, phantom, ref, space, tabular, vspace, wrap insets.
2545 * \li Syntax: inset-settings <INSET>
2546 * \li Params: <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|\n
2547 graphics|href|include|index|index_print|label|line|\n
2548 listings|note|phantom|ref|space|tabular|vspace|wrap>.
2551 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly | AtPoint, Edit },
2553 * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
2554 * \li Action: Toggles the collapsible inset at cursor position,
2555 or the inset we are currently in.
2556 * \li Syntax: inset-toggle [<ARG>]
2557 * \li Params: <ARG>: <open|close|toggle|assign>. \n
2558 open/close/toggle are for collapsible insets. toggle is used when no argument is given.\n
2559 assign synchronize the branch-inset with activation status of the branch.
2560 Used for global toggling when changed activation.
2561 * \li Origin: lasgouttes, 19 Jul 2001
2564 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly | AtPoint, Edit },
2566 * \var lyx::FuncCode lyx::LFUN_INSET_FORALL
2567 * \li Action: Apply the given commands on insets of a given name.
2568 * \li Notion: WARNING: use at your own risks; this function gives
2569 you too many ways of shooting yourself in the foot.
2570 A typical example is
2571 inset-forall Note note-insert
2572 which starts an infinite loop. This is mitigated by the fact
2573 that the number of actions is arbitrarily limited to 100000.
2574 Note also that inset-forall does not update metrics between
2575 iterations, which can lead to bugs. This has to be eventually
2577 * \li Syntax: inset-forall <NAME> <LFUN-COMMAND> \n
2578 <NAME>: Type of Inset. If <NAME> is *, all insets are matched.
2579 The name is used like for InsetLayout in layout files: "Note"
2580 matches all note insets, while "Note:Note" only matches LyX
2582 * \li Sample: Remove all index insets: \n
2583 inset-forall Index char-delete-forward \n
2584 Close all Notes (also works for a particular branch, for example): \n
2585 inset-forall Note inset-toggle close \n
2586 Transform all yellow notes to comments \n
2587 inset-forall Note:Note inset-modify note Note Comment \n
2588 Try to put LyX in an infinite loop if there is at least a Note: \n
2589 inset-forall Note char-backward
2590 * \li Origin: lasgouttes, 27 Nov 2009
2593 { LFUN_INSET_FORALL, "inset-forall", ReadOnly, Edit },
2596 * \var lyx::FuncCode lyx::LFUN_GRAPHICS_RELOAD
2597 * \li Action: Reloads the image if necessary.
2598 * \li Syntax: graphics-reload
2599 * \li Origin: vfr, 10 Aug 2009
2602 { LFUN_GRAPHICS_RELOAD, "graphics-reload", ReadOnly | AtPoint, Edit },
2604 * \var lyx::FuncCode lyx::LFUN_SET_GRAPHICS_GROUP
2605 * \li Action: Set the group for the graphics inset on the cursor position.
2606 * \li Syntax: set-graphics-group [<GROUP>]
2607 * \li Params: <GROUP>: Id for an existing group. In case the Id is an empty string,
2608 the graphics inset is removed from the current group.
2609 * \li Origin: sanda, 6 May 2008
2612 { LFUN_SET_GRAPHICS_GROUP, "set-graphics-group", Noop, Edit },
2615 * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
2616 * \li Action: Moves the cursor out of the current slice, going forward.
2617 * \li Notion: Cursor movement within an inset may be different than cursor
2618 movement in the surrounding text. This action should be called
2619 automatically by the cursor movement within the inset, when
2620 movement within the inset has ceased (reached the end of the
2621 last paragraph, for example), in order to move correctly
2622 back into the surrounding text.
2625 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
2627 * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
2628 * \li Action: Moves the cursor out of the current slice, going backwards.
2629 * \li Notion: See also #LFUN_FINISHED_FORWARD.
2632 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
2634 * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
2635 * \li Action: Moves the cursor out of the current slice, going right.
2636 * \li Notion: See also #LFUN_FINISHED_FORWARD
2639 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
2641 * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
2642 * \li Action: Moves the cursor out of the current slice, going left.
2643 * \li Notion: See also #LFUN_FINISHED_FORWARD.
2646 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
2649 * \var lyx::FuncCode lyx::LFUN_LANGUAGE
2650 * \li Action: Set language from the current cursor position.
2651 * \li Syntax: language <LANG> [set]
2652 * \li Params: <LANG>: Requested language. Look in lib/languages for
2653 the list. "language reset" or "language" (without param)
2654 reset to the document language.
2655 set: If used, the language will be set to the specified
2656 language. Otherwise, the language will be toggled (i.e., if
2657 the current language is LANG, switch to the document language
2658 or the default language, if LANG is the document language).
2659 * \li Origin: Dekel, 2 Mar 2000
2662 { LFUN_LANGUAGE, "language", Noop, Edit },
2665 * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
2666 * \li Action: Goto a label.
2667 * \li Syntax: label-goto [<LABEL>]
2668 * \li Params: <LABEL>: Requested label. If no label is given and reference
2669 is on cursor position, Bookmark 0 is saved and
2670 cursor moves to the position of referenced label.
2671 * \li Origin: Ale, 6 Aug 1997
2674 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
2676 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT
2677 * \li Action: Inserts label to text or displayed formula.
2678 * \li Syntax: label-insert [<LABEL>]
2679 * \li Params: <LABEL>: Requested label. If no label is given dialog requesting
2680 name will be opened.
2683 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
2685 * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
2686 * \li Action: Go to the next label or cross-reference.
2687 * \li Syntax: reference-next
2688 * \li Origin: Dekel, 14 Jan 2001
2691 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
2694 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
2695 * \li Action: Moves the cursor to the numbered bookmark, opening the file
2696 if necessary. Note that bookmarks are saved per-session, not
2698 * \li Notion: Bookmark 0 has a special purpose. It is automatically set \n
2699 1. to the paragraph you are currently editing \n
2700 2. to the paragraph from where you are jumping to the last-edited
2701 position (jump-back feature) \n
2702 3. when jumping from crossreference to the requested label by
2704 * \li Syntax: bookmark-goto <NUMBER>
2705 * \li Params: <NUMBER>: the number of the bookmark to restore.
2706 * \li Origin: Dekel, 27 January 2001
2709 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
2711 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
2712 * \li Action: Save a bookmark.
2713 * \li Notion: Saves a numbered bookmark to the sessions file. The number
2714 must be between 1 and 9, inclusive. Note that bookmarks are
2715 saved per-session, not per file.
2716 * \li Syntax: bookmark-save <NUMBER>
2717 * \li Params: <NUMBER>: the number of the bookmark to save.
2718 * \li Origin: Dekel, 27 January 2001
2721 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
2723 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
2724 * \li Action: Clears the list of saved bookmarks.
2725 * \li Syntax: bookmark-clear
2726 * \li Origin: bpeng, 31 October 2006
2729 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
2732 * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
2733 * \li Action: Open the given help file according to the language setting.
2734 * \li Syntax: help-open <FILE>[.lyx]
2735 * \li Params: <FILE>: any document from (/usr/share/)doc directory.
2736 * \li Origin: Jug, 27 Jun 1999
2739 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
2741 * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
2742 * \li Action: Terminates the current LyX instance.
2743 * \li Notion: Terminates the current LyX instance, asking whether to save
2744 modified documents, etc.
2745 * \li Syntax: lyx-quit
2748 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
2750 * \var lyx::FuncCode lyx::LFUN_LYX_ACTIVATE
2751 * \li Action: Activates the LyX window.
2752 * \li Notion: On Linux and Mac OS, this action brings the LyX window
2753 into focus. Such behavior is not allowed by Windows OS
2754 so instead the color of the taskbar entry is changed to
2755 indicate that the window has changed in some way.
2756 This action is useful in combination with reverse search.
2757 * \li Syntax: lyx-activate
2758 * \li Origin: skostysh, 4 Aug 2016
2761 { LFUN_LYX_ACTIVATE, "lyx-activate", ReadOnly | NoBuffer, Hidden },
2763 * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
2764 * \li Action: Toggles visibility of a given toolbar between on/off/auto.
2765 * \li Notion: Skipping "auto" when allowauto is false.
2766 * \li Syntax: toolbar-toggle <NAME> [allowauto]
2767 * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|\n
2768 minibuffer|review|view/update|math_panels|vcs|
2769 view-others|update-others
2770 * \li Origin: Edwin, 21 May 2007
2773 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
2775 * \var lyx::FuncCode lyx::LFUN_ICON_SIZE
2776 * \li Action: Sets icon size of toolbars.
2777 * \li Syntax: icon-size [<SIZE>]
2778 * \li Params: <SIZE> : the icon size in px or one of the logical settings
2779 small|normal|big|huge|giant, the default is normal
2780 (whose size in px is icon set dependent).
2781 * \li Origin: 11 July 2016
2784 { LFUN_ICON_SIZE, "icon-size", NoBuffer, Buffer },
2786 * \var lyx::FuncCode lyx::LFUN_MENU_OPEN
2787 * \li Action: Opens the menu given by its name.
2788 * \li Syntax: menu-open <NAME>
2789 * \li Params: <NAME>: menu name. See various .inc files in lib/ui for candidates.
2792 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
2794 * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
2795 * \li Action: Various UI visibility-toggling actions.
2796 * \li Syntax: ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
2797 * \li Params: statusbar : Toggle visibility of the statusbar.\n
2798 menubar : Toggle visibility of the menubar.\n
2799 scrollbar : Toggle visibility of the scrollbar.\n
2800 frame : Toggle visibility of the frames around editing window.\n
2801 fullscreen : Toggle fullscreen mode. This also covers calling the
2802 previous functions. However #LFUN_TOOLBAR_TOGGLE for the
2803 custom tweaks of the toolbars should be used.
2804 * \li Origin: sanda, 9 Feb 2007
2807 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
2810 * \var lyx::FuncCode lyx::LFUN_WINDOW_NEW
2811 * \li Action: Creates new empty LyX window.
2812 * \li Notion: Already opened documents from the previous window can be found under View menu.
2813 * \li Syntax: window-new [<GEOMETRY>]
2814 * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently
2815 accepted only on Windows platform.
2816 * \li Origin: Abdel, 21 Oct 2006
2819 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
2821 * \var lyx::FuncCode lyx::LFUN_WINDOW_CLOSE
2822 * \li Action: Closes the current LyX window.
2823 * \li Syntax: window-close
2824 * \li Origin: Abdel, 23 Oct 2006
2827 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
2830 * \var lyx::FuncCode lyx::LFUN_VIEW_SPLIT
2831 * \li Action: Creates another split view of current buffer.
2832 * \li Notion: All split views act in the same way independently.
2833 * \li Syntax: view-split <vertical|horizontal>
2834 * \li Params: horizontal : The work areas are laid out side by side.\n
2835 vertical : The work areas laid out vertically.
2836 * \li Origin: Abdel, 20 Feb 2008
2839 { LFUN_VIEW_SPLIT, "view-split", ReadOnly, Buffer },
2842 * \var lyx::FuncCode lyx::LFUN_VIEW_CLOSE
2843 * \li Action: Close the current document work area.
2844 * \li Notion: Close the current work area. If no other work areas are showing the buffer,
2845 then close the associated buffer as well.
2846 * \li Syntax: view-close
2847 * \li Origin: Tommaso, 15 Sep 2012
2850 { LFUN_VIEW_CLOSE, "view-close", ReadOnly, Buffer },
2853 * \var lyx::FuncCode lyx::LFUN_TAB_GROUP_CLOSE
2854 * \li Action: Close the current tab group.
2855 * \li Notion: This only closes the work areas, not the buffers themselves.
2856 The still opened buffers can be visualized in another tab group.
2857 * \li Syntax: tab-group-close
2858 * \li Origin: Abdel, 21 Feb 2008
2861 { LFUN_TAB_GROUP_CLOSE, "tab-group-close", ReadOnly, Buffer },
2864 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW
2865 * \li Action: Shows hidden dialog or creates new one for a given function/inset settings etc.
2866 * \li Syntax: dialog-show <NAME> [<DATA>]
2867 * \li Params: <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|\n
2868 compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|\n
2869 graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimiter|\n
2870 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|\n
2871 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|\n
2872 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL> \n
2873 <SPECIAL>: latexlog|vclog \n
2874 <DATA>: data, usually settings for the given dialog. Use debug mode for the
2876 * \li Origin: leeming, 17 Jun 2003
2879 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
2881 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW_NEW_INSET
2882 * \li Action: Shows hidden dialog or create new one for a given inset settings etc.
2883 * \li Notion: Internally uses #LFUN_DIALOG_SHOW with processed data for a given inset.
2884 * \li Syntax: dialog-show-new-inset <NAME> [<DATA>]
2885 * \li Params: See #LFUN_DIALOG_SHOW .
2886 * \li Origin: leeming, 25 Feb 2003
2889 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
2891 * \var lyx::FuncCode lyx::LFUN_DIALOG_UPDATE
2892 * \li Action: Updates the dialog values from the inset/paragraph/document.
2893 * \li Syntax: dialog-update <NAME>
2894 * \li Params: <NAME>: paragraph|prefs|<INSET> \n
2896 * \li Origin: leeming, 25 Feb 2003
2899 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
2901 * \var lyx::FuncCode lyx::LFUN_DIALOG_HIDE
2902 * \li Action: Hides showed dialog. Counterpart to #LFUN_DIALOG_SHOW .
2903 * \li Syntax: dialog-hide <NAME>
2904 * \li Params: See #LFUN_DIALOG_SHOW .
2905 * \li Origin: leeming, 25 Feb 2003
2908 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
2910 * \var lyx::FuncCode lyx::LFUN_DIALOG_TOGGLE
2911 * \li Action: Toggles dialog between showed/hidden state.
2912 * \li Notion: Internally uses #LFUN_DIALOG_SHOW , #LFUN_DIALOG_HIDE .
2913 * \li Syntax: dialog-toggle <NAME> [<DATA>]
2914 * \li Params: See #LFUN_DIALOG_SHOW .
2915 * \li Origin: JSpitzm, 30 Apr 2007
2918 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
2920 * \var lyx::FuncCode lyx::LFUN_DIALOG_DISCONNECT_INSET
2921 * \li Action: Closes opened connection to opened inset.
2922 * \li Notion: Connection is used for apply functions.
2923 * \li Syntax: dialog-disconnect-inset <INSET-NAME>
2924 * \li Origin: leeming, 25 Feb 2003
2927 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
2930 * \var lyx::FuncCode lyx::LFUN_MOUSE_PRESS
2931 * \li Action: This function is called when mouse button is pressed (inside workarea).
2932 Action depends on the context.
2933 * \li Notion: This is an internal LFUN, not to be used by users.
2934 * \li Origin: Andre, 9 Aug 2002
2937 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
2939 * \var lyx::FuncCode lyx::LFUN_MOUSE_DOUBLE
2940 * \li Action: This function is called when double click on mouse button is
2941 pressed (inside workarea). Action depends on the context.
2942 * \li Notion: This is an internal LFUN, not to be used by users.
2943 * \li Origin: Andre, 9 Aug 2002
2946 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
2948 * \var lyx::FuncCode lyx::LFUN_MOUSE_TRIPLE
2949 * \li Action: This function is called when triple click on mouse button is
2950 pressed (inside workarea). Action depends on the context.
2951 * \li Notion: This is an internal LFUN, not to be used by users.
2952 * \li Origin: Andre, 9 Aug 2002
2955 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
2957 * \var lyx::FuncCode lyx::LFUN_MOUSE_MOTION
2958 * \li Action: This function is called when mouse cursor is moving over the text.
2959 Action depends on the context.
2960 * \li Notion: This is an internal LFUN, not to be used by users.
2961 * \li Origin: Andre, 9 Aug 2002
2964 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
2966 * \var lyx::FuncCode lyx::LFUN_MOUSE_RELEASE
2967 * \li Action: This function is called when mouse button is released (inside workarea).
2968 Action depends on the context.
2969 * \li Notion: This is an internal LFUN, not to be used by users.
2970 * \li Origin: Andre, 9 Aug 2002
2973 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
2976 * \var lyx::FuncCode lyx::LFUN_KEYMAP_OFF
2977 * \li Action: Turn off the loaded keyboard map.
2978 * \li Syntax: keymap-off
2981 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
2983 * \var lyx::FuncCode lyx::LFUN_KEYMAP_PRIMARY
2984 * \li Action: Turn on the primary keyboard map.
2985 * \li Notion: Maps were widely used in past, when X-windows didn't have nowadays
2986 keyboard support. They can be still used to maintain uniform keyboard
2987 layout across the various platforms.\n
2988 The language is to be set in the Preferences dialog.
2989 * \li Syntax: keymap-primary
2992 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
2994 * \var lyx::FuncCode lyx::LFUN_KEYMAP_SECONDARY
2995 * \li Action: Turn on the secondary keyboard map.
2996 * \li Syntax: keymap-secondary
2999 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
3001 * \var lyx::FuncCode lyx::LFUN_KEYMAP_TOGGLE
3002 * \li Action: Toggles keyboard maps (first/second/off).
3003 * \li Syntax: keymap-toggle
3004 * \li Origin: leeming, 30 Mar 2004
3007 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
3010 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_LAYOUT
3011 * \li Action: Returns the current layout (that is environment) name
3012 on the cursor position.
3013 * \li Syntax: server-get-layout
3016 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
3018 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_FILENAME
3019 * \li Action: Returns path and file name of the currently edited document.
3020 * \li Syntax: server-get-filename
3023 { LFUN_SERVER_GET_FILENAME, "server-get-filename", ReadOnly, System },
3025 * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
3026 * \li Action: Sets the cursor position in LyX based on the row number of generated TeX file.
3027 * \li Notion: This can be useful for DVI inverse-search or detection of the problematic
3028 line from LaTeX compilation. Note that before this function can be used
3029 export to LaTeX output must occur (in order to map the row numbers).
3030 * \li Syntax: server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
3031 * \li Params: <FILE>: the path and filename. Environment variables are expanded in the path.
3032 In case this LFUN does not work make sure you are giving correct
3034 If the file is located inside LyX temporary directory it will be
3035 mapped back into the appropriate opened buffer (e.g. for the case
3036 of generated .tex file).\n
3037 .ext: extensions will be automatically replaced by .lyx.\n
3038 <ROW_NUMBER> The row number of the LaTeX file to which to go.
3039 * \li Sample: server-goto-file-row /home/user/example.lyx 41\n
3040 server-goto-file-row /tmp/lyx_tmpdir.XM3088/lyx_tmpbuf0/example.tex 41
3041 * \li Origin: Edmar, 23 Dec 1998
3044 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly | NoBuffer, System },
3046 * \var lyx::FuncCode lyx::LFUN_FORWARD_SEARCH
3047 * \li Action: Sets the cursor position in the previewed (dvi/pdf) file based on the row
3048 number in LyX window.
3049 * \li Notion: The external program used for forward search call can be specified in
3050 LyX Output preferences. See Additional manual for details of these
3052 * \li Syntax: forward-search
3053 * \li Origin: sanda, 14 Apr 2010
3056 { LFUN_FORWARD_SEARCH, "forward-search", ReadOnly, System },
3058 * \var lyx::FuncCode lyx::LFUN_SERVER_NOTIFY
3059 * \li Action: Sends notify message about the last key-sequence to client.
3060 * \li Notion: This can be used to grab last key-sequence used inside the LyX window.
3061 See also Debug extensions section in Additional features manual.
3062 * \li Syntax: server-notify
3065 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
3067 * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
3068 * \li Action: Sets the cursor position based on the editing area coordinates
3069 (similar to clicking on that point with left mouse button).
3070 * \li Syntax: server-set-xy <X> <Y>
3073 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
3075 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
3076 * \li Action: Returns the coordinates of cursor position in the editing area.
3077 * \li Syntax: server-get-xy
3080 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
3083 * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
3084 * \li Action: Generates the code (literate programming).
3085 * \li Notion: Latex file with extension \literate_extension is generated.
3086 Then LyX invokes \build_command (with a default of ``make'') to generate the code and
3087 \build_error_filter to process the compilation error messages. \n
3088 In case you want to process your literate file with a script, or some other program,
3089 just insert in your lyxrc file an entry with:\n
3090 \build_command "my_script my_arguments" \n
3091 The \build_error_filter differs from the \literate_error_filter only in that the
3092 former will identify error messages from your compiler.
3093 * \li Syntax: build-program
3096 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
3099 * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
3100 * \li Action: Saves the current buffer to a temporary file.
3101 * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
3102 is called automatically by LyX, to "autosave" the current buffer.
3103 * \li Syntax: buffer-auto-save
3106 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
3108 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHILD_OPEN
3109 * \li Action: Loads the given child document.
3110 * \li Notion: The current document is treated as a parent.
3111 * \li Syntax: buffer-child-open <FILE>
3112 * \li Params: <FILE>: Filename of the child. The directory of the parent is assumed by default.
3113 * \li Origin: Ale, 28 May 1997
3116 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
3118 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHKTEX
3119 * \li Action: Runs chktex for the current document.
3120 * \li Syntax: buffer-chktex
3121 * \li Origin: Asger, 30 Oct 1997
3124 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
3126 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
3127 * \li Action: Toggles compression of the current document on/off.
3128 * \li Syntax: buffer-toggle-compression
3129 * \li Origin: bpeng, 27 Apr 2006
3132 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
3134 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_OUTPUT_SYNC
3135 * \li Action: Toggles including of resources for forward/reverse search of the given document.
3136 * \li Notion: When toggled on, SyncTeX is invoked for PDF, while srcltx package
3137 is used for DVI. Custom LaTeX macro can be defined in preferences.
3138 * \li Syntax: buffer-toggle-output-sync
3139 * \li Origin: sanda, 25 May 2010
3142 { LFUN_BUFFER_TOGGLE_OUTPUT_SYNC, "buffer-toggle-output-sync", Noop, System },
3144 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
3145 * \li Action: Closes the current buffer.
3146 * \li Notion: Closes the current buffer, asking whether to save it, etc,
3147 if the buffer has been modified.
3148 * \li Syntax: buffer-close
3151 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
3153 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE_ALL
3154 * \li Action: Closes all buffers.
3155 * \li Notion: Closes all buffers, asking whether to save it, etc,
3156 if a buffer has been modified.
3157 * \li Syntax: buffer-close-all
3160 { LFUN_BUFFER_CLOSE_ALL, "buffer-close-all", ReadOnly, Buffer },
3162 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
3163 * \li Action: Exports the current buffer (document) to the given format.
3164 * \li Syntax: buffer-export <FORMAT> [<DEST>]
3165 * \li Params: <FORMAT> is either "custom" or one of the formats which you
3166 can find in Tools->Preferences->File formats->Format.
3167 Usual format you will enter is "pdf2" (pdflatex),
3168 "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
3169 In case of "custom" you will be asked for a format you
3170 want to start from and for the command that you want to
3171 apply to this format. Internally the control is then passed
3172 to #LFUN_BUFFER_EXPORT_CUSTOM.
3173 <DEST> If present, this argument provides the export destination
3174 filename. Its containing folder will also be the destination
3175 folder, where all the needed external files will be copied.
3176 * \li Origin: Lgb, 29 Jul 1997
3179 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
3181 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
3182 * \li Action: Exports the current buffer (document) from the given format using
3183 the given command on it.
3184 * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
3185 * \li Params: <FORMAT> format to start from (LyX will care to produce such
3186 intermediate file).\n
3187 <COMMAND> this command will be launched on the file. Note that you can
3188 use "$$FName" string to qualify the intermediate file.
3189 * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
3190 * \li Origin: leeming, 27 Mar 2004
3193 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
3195 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_AS
3196 * \li Action: Opens a dialog for exporting the current buffer.
3197 * \li Syntax: buffer-export-as [<FORMAT>]
3198 * \li Params: <FORMAT> is the export format initially selected in the dialog.
3199 * You can pass any of the formats which you can find in
3200 * Tools->Preferences->File formats->Format, provided it
3201 * has the "document" flag set. If no format is specified
3202 * the dialog will start with the default output format of
3203 * the current document.
3204 * \li Sample: buffer-export-as pdf2
3205 * \li Origin: tommaso, 6 Oct 2011
3208 { LFUN_BUFFER_EXPORT_AS, "buffer-export-as", ReadOnly, Buffer },
3210 * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
3211 * \li Action: Import a given file as a lyx document.
3212 * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
3213 defined converters in preferences. Look in the File->Import menu to get
3214 an idea of the currently active import formats.
3215 * \li Syntax: buffer-import <FORMAT> [<FILE>]
3216 * \li Origin: Asger, 24 Jul 1998
3219 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
3221 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
3222 * \li Action: Creates a new buffer (that is, document) and switches to it.
3223 * \li Notion: Implicit path can be set in Preferences dialog.
3224 * \li Syntax: buffer-new [<FILE>]
3225 * \li Params: <FILE>: filename of created file with absolute path.
3228 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
3230 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
3231 * \li Action: Creates a new buffer (that is, document) from a template.
3232 * \li Notion: Path for new files and templates can be set in Preferences dialog.
3233 Template will be asked for via Open-dialog.
3234 * \li Syntax: buffer-new-template [<FILE>]
3235 * \li Params: <FILE>: filename of created file with absolute path.
3238 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
3240 * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
3241 * \li Action: Reverts opened document.
3242 * \li Syntax: buffer-reload
3243 * \li Origin: Asger, 2 Feb 1997
3246 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
3248 * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
3249 * \li Action: Display and switch to the given buffer.
3250 * \li Syntax: buffer-switch <BUFFER>
3251 * \li Params: <BUFFER>: path and filename of already opened (but possibly hidden)
3252 document which is to be shown.
3255 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
3257 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
3258 * \li Action: Toggle editing mode of the current document between read/write and read-only.
3259 * \li Notion: This function is not allowed if the file is under version control, since
3260 read-only flag is often used in version control file locking.
3261 * \li Syntax: buffer-toggle-read-only
3262 * \li Origin: Lgb, 27 May 1997
3265 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
3267 * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
3268 * \li Action: Displays current buffer in chosen format.
3269 * \li Notion: Displays the contents of the current buffer in the chosen
3270 format, for example, PDF or DVI. This runs the necessary
3271 converter, calls the defined viewer, and so forth.
3272 * \li Syntax: buffer-view [<FORMAT>]
3273 * \li Params: <FORMAT>: The format to display, where this is one of the
3274 formats defined (in the current GUI) in the
3275 Tools>Preferences>File Formats dialog.
3276 If no format is given, the default format as
3277 specified in the same dialog is used.
3280 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
3282 * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
3283 * \li Action: Exports the current document and put the result into the
3284 temporary directory.
3285 * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
3286 the output will be rewritten - updated. This is useful in case your viewer
3287 is able to detect such changes (e.g. ghostview for postscript).
3288 * \li Syntax: buffer-update [<FORMAT>]
3289 * \li Params: <FORMAT>: The format to display, where this is one of the
3290 formats defined (in the current GUI) in the
3291 Tools>Preferences>File Formats dialog.
3292 If no format is given, the default format as
3293 specified in the same dialog is used.
3294 * \li Origin: Dekel, 5 Aug 2000
3297 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
3300 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
3301 * \li Action: Saves the current buffer.
3302 * \li Notion: Saves the current buffer to disk, using the filename that
3303 is already associated with the buffer, asking for one if
3304 none is yet assigned.
3305 * \li Syntax: buffer-write
3308 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
3310 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
3311 * \li Action: Rename and save current buffer.
3312 * \li Syntax: buffer-write-as <FILENAME>
3313 * \li Params: <FILENAME>: New name of the buffer/file. A relative path
3314 is with respect to the original location of the buffer/file.
3317 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
3319 * \var lyx::FuncCode lyx::LFUN_BUFFER_FORALL
3320 * \li Action: Applies a command to all non-hidden buffers.
3321 * \li Notion: a buffer is `hidden' if it is internally open in LyX, but not
3322 visible in any window.
3323 * \li Syntax: buffer-forall <LFUN-COMMAND>
3324 * \li Params: <LFUN-COMMAND>: The command to be applied to the buffers.
3325 * \li Sample: Close all Notes in buffers: \n
3326 buffer-forall inset-forall Note inset-toggle close \n
3327 Toggle change tracking on buffers: \n
3328 buffer-forall changes-track \n
3329 Toggle read-only for buffers: \n
3330 buffer-forall buffer-toggle-read-only \n
3331 Show statistics for individual buffers: \n
3332 buffer-forall statistics \n
3333 Activate the branch named "Solutions" in buffers: \n
3334 buffer-forall branch-activate Solutions \n
3335 Export buffers to PDF (pdflatex): \n
3336 buffer-forall buffer-export pdf2 \n
3337 * \li Origin: skostysh, 20 Jul 2012
3340 { LFUN_BUFFER_FORALL, "buffer-forall", ReadOnly | Argument, Buffer },
3342 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
3343 * \li Action: Save all changed documents.
3344 * \li Syntax: buffer-write-all
3345 * \li Origin: rgh, gpothier 6 Aug 2007
3348 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
3350 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEXT
3351 * \li Action: Switch to the next opened document.
3352 * \li Notion: Note that this does not necessarily mean next in tabbar
3353 (for full list see View menu).
3354 * \li Syntax: buffer-next
3357 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
3359 * \var lyx::FuncCode lyx::LFUN_BUFFER_MOVE_NEXT
3360 * \li Action: Moves the current tab one spot to the right.
3361 * \li Syntax: buffer-move-next
3362 * \li Origin: skostysh, 7 Apr 2015
3365 { LFUN_BUFFER_MOVE_NEXT, "buffer-move-next", ReadOnly, Buffer },
3367 * \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS
3368 * \li Action: Switch to the previous opened document.
3369 * \li Syntax: buffer-previous
3372 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
3374 * \var lyx::FuncCode lyx::LFUN_BUFFER_MOVE_PREVIOUS
3375 * \li Action: Moves the current tab one spot to the left.
3376 * \li Syntax: buffer-move-previous
3377 * \li Origin: skostysh, 7 Apr 2015
3380 { LFUN_BUFFER_MOVE_PREVIOUS, "buffer-move-previous", ReadOnly, Buffer },
3382 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
3383 * \li Action: Update (export) the document built from the master buffer,
3384 if the current buffer is part of a master/child document.
3385 * \li Syntax: master-buffer-update [<FORMAT>]
3386 * \li Params: <FORMAT>: The format to display, where this is one of the
3387 formats defined (in the current GUI) in the
3388 Tools>Preferences>File Formats dialog.
3389 If no format is given, the default format as
3390 specified in the same dialog is used.
3391 * \li Origin: Tommaso, 20 Sep 2007
3394 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
3396 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
3397 * \li Action: Show a preview built from the master buffer, if available.
3398 if the current buffer is part of a master/child document.
3399 * \li Syntax: master-buffer-view [<FORMAT>]
3400 * \li Params: <FORMAT>: The format to display, where this is one of the
3401 formats defined (in the current GUI) in the
3402 Tools>Preferences>File Formats dialog.
3403 If no format is given, the default format as
3404 specified in the same dialog is used.
3405 * \li Origin: Tommaso, 20 Sep 2007
3408 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
3410 * \var lyx::FuncCode lyx::LFUN_BUFFER_LANGUAGE
3411 * \li Action: Set language of the current document.
3412 * \li Syntax: buffer-language <LANG>
3413 * \li Params: <LANG>: language name. See lib/languages for list.
3414 * \li Origin: leeming, 30 Mar 2004
3417 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
3419 * \var lyx::FuncCode lyx::LFUN_BUFFER_SAVE_AS_DEFAULT
3420 * \li Action: Save the current document settings as default.
3421 * \li Notion: The file will will be saved into ~/.lyx/templates/defaults.lyx .
3422 * \li Syntax: buffer-save-as-default [<ARGS>]
3423 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
3424 you can find in document header of usual .lyx file.
3425 * \li Origin: leeming, 30 Mar 2004
3428 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
3430 * \var lyx::FuncCode lyx::LFUN_BUFFER_PARAMS_APPLY
3431 * \li Action: Apply the given settings to the current document.
3432 * \li Syntax: buffer-params-apply [<ARGS>]
3433 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
3434 you can find in document header of usual .lyx file.
3435 * \li Origin: leeming, 30 Mar 2004
3438 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", NoInternal, Buffer },
3441 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
3442 * \li Action: Inserts another LyX file.
3443 * \li Syntax: file-insert [<FILE>]
3444 * \li Params: <FILE>: Filename to be inserted.
3447 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
3449 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
3450 * \li Action: Inserts plain text file.
3451 * \li Syntax: file-insert-plaintext [<FILE>]
3452 * \li Params: <FILE>: Filename to be inserted.
3453 * \li Origin: CFO-G, 19 Nov 1997
3456 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
3458 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
3459 * \li Action: Inserts plain text file as paragraph (i.e. join lines).
3460 * \li Syntax: file-insert-plaintext-para [<FILE>]
3461 * \li Params: <FILE>: Filename to be inserted.
3462 * \li Origin: Levon, 14 Feb 2001
3465 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
3467 * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
3468 * \li Action: Open LyX document.
3469 * \li Syntax: file-open [<FILE>]
3470 * \li Params: <FILE>: Filename to be opened.
3473 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
3476 * \var lyx::FuncCode lyx::LFUN_CALL
3477 * \li Action: Executes a command defined in a .def file.
3478 * \li Notion: The definitions are by default read from lib/commands/default.def.\n
3479 A .def file allows to define a command with \define "<NAME>" "<LFUN>"
3480 where <NAME> is the name of the new command and <LFUN> is the lfun code
3481 to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
3482 \def_file "FileName" allows to include another .def file. \n
3483 This is particularly useful in connection with toolbar buttons:
3484 Since the name of the button image for this lfun is
3485 lib/images/commands/<NAME>.png this is the way to assign an image
3486 to a complex command-sequence.
3487 * \li Syntax: call <NAME>
3488 * \li Params: <NAME>: Name of the command that must be called.
3489 * \li Origin: broider, 2 Oct 2007
3492 { LFUN_CALL, "call", NoBuffer, System },
3494 * \var lyx::FuncCode lyx::LFUN_META_PREFIX
3495 * \li Action: Simulate halting Meta key (Alt key on PCs).
3496 * \li Notion: Used for buffer edition not for GUI control.
3497 * \li Syntax: meta-prefix
3500 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
3502 * \var lyx::FuncCode lyx::LFUN_CANCEL
3503 * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
3504 * \li Syntax: cancel
3507 { LFUN_CANCEL, "cancel", NoBuffer, System },
3510 * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
3511 * \li Action: Switches the focus to the minibuffer so that the user can type
3512 in there. If necessary, it opens the minibuffer toolbar.
3513 * \li Notion: Usually bound to M-x shortcut.
3514 * \li Syntax: command-execute
3517 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
3520 * \var lyx::FuncCode lyx::LFUN_COMMAND_PREFIX
3521 * \li Action: Return the current key sequence and available options as a string.
3522 * \li Notion: No options are added if no current map exists. \n
3523 This is probably usable only with connection to lyxserver.
3524 * \li Syntax: command-prefix
3527 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
3529 * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
3530 * \li Action: Run more commands (LFUN and its parameters) in a sequence.
3531 * \li Syntax: command-sequence <CMDS>
3532 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
3533 * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
3534 * \li Origin: Andre, 11 Nov 1999
3537 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
3539 * \var lyx::FuncCode lyx::LFUN_COMMAND_ALTERNATIVES
3540 * \li Action: Runs the first listed command that is enabled.
3541 * \li Notion: This can be used to bind multiple functions to a single key,
3542 and then which one is used will depend upon the context.
3543 * \li Syntax: command-alternatives <CMDS>
3544 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
3545 * \li Sample: command-alternatives completion-accept;cell-forward
3546 * \li Origin: rgh, 24 September 2008
3549 { LFUN_COMMAND_ALTERNATIVES, "command-alternatives", NoBuffer, System },
3551 * \var lyx::FuncCode lyx::LFUN_MESSAGE
3552 * \li Action: Shows message in statusbar (for script purposes).
3553 * \li Syntax: message <STRING>
3554 * \li Origin: Lgb, 8 Apr 2001
3557 { LFUN_MESSAGE, "message", NoBuffer, System },
3559 * \var lyx::FuncCode lyx::LFUN_DEBUG_LEVEL_SET
3560 * \li Action: Set debug output level.
3561 * \li Syntax: debug-level-set <LEVEL>
3562 * \li Params: <LEVEL>: comma separated list of levels or the correspondent number
3563 of their combination. 0 is equivalent to disabling all debug
3564 events. See lyx -dbg for the current list of debug levels
3566 * \li Origin: sanda, 28 Dec 2009
3569 { LFUN_DEBUG_LEVEL_SET, "debug-level-set", NoBuffer, System },
3572 * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
3573 * \li Action: Save user preferences.
3574 * \li Syntax: preferences-save
3575 * \li Origin: Lgb, 27 Nov 1999
3578 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
3580 * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
3581 * \li Action: Reconfigure the automatic settings.
3582 * \li Syntax: reconfigure
3583 * \li Origin: Asger, 14 Feb 1997
3586 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
3588 * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
3589 * \li Action: Apply the given settings to user preferences.
3590 * \li Syntax: lyxrc-apply <SETTINGS>
3591 * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
3592 to get an idea which commands to use and their syntax.
3593 #lyx::LyXRC::LyXRCTags has the list of possible commands.
3596 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
3598 * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
3599 * \li Action: Determine whether to keep cursor inside the editing window regardless
3600 of the scrollbar movement.
3601 * \li Syntax: toggle-cursor-follows-scrollbar
3602 * \li Origin: ARRae, 2 Dec 1997
3605 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
3607 * \var lyx::FuncCode lyx::LFUN_SET_COLOR
3608 * \li Action: Set the given LyX color to the color defined by the X11 name given.
3609 * \li Notion: A new color entry is created if the color is unknown.
3610 Color names can be stored as a part of user settings.
3611 * \li Syntax: set-color <LYX_NAME> <X11_NAME>
3612 * \li Origin: SLior, 11 Jun 2000
3615 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
3617 * \var lyx::FuncCode lyx::LFUN_STATISTICS
3618 * \li Action: Count the statistics (number of words and characters)
3619 in the document or in the given selection and display it
3621 * \li Notion: Note that this function gives the number of words/chars written,
3622 not the number of characters which will be typeset.
3623 * \li Syntax: statistics
3624 * \li Origin: lasgouttes, Jan 27 2004; sanda, Jan 8 2008
3627 { LFUN_STATISTICS, "statistics", ReadOnly, System },
3629 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_STATISTICS
3630 * \li Action: Returns the statistics (number of words and characters)
3631 in the document or in the given selection.
3632 * \li Notion: Note that this function gives the number of words/chars written,
3633 not the number of characters which will be typeset.
3634 * \li Syntax: server-get-statistics [<TYPE>]
3635 * \li Params: <TYPE>: <words|chars|chars-space> The requested count; if not
3636 specified, the three values are returned, separated
3638 words: count words.\n
3639 chars: count characters.\n
3640 chars-space: count characters and spaces.
3641 * \li Origin: brokenclock, Oct 10 2014
3644 { LFUN_SERVER_GET_STATISTICS, "server-get-statistics", ReadOnly, System },
3646 * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
3647 * \li Action: Show the inline completion at the cursor position.
3648 * \li Syntax: completion-inline
3649 * \li Origin: sts, Feb 19 2008
3652 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
3654 * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
3655 * \li Action: Show the completion popup at the cursor position.
3656 * \li Syntax: completion-popup
3657 * \li Origin: sts, Feb 19 2008
3660 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
3662 * \var lyx::FuncCode lyx::LFUN_COMPLETE
3663 * \li Action: Try to complete the word or command at the cursor position.
3664 * \li Syntax: complete
3665 * \li Origin: sts, Feb 19 2008
3668 { LFUN_COMPLETE, "complete", SingleParUpdate, Edit },
3671 * \var lyx::FuncCode lyx::LFUN_COMPLETION_CANCEL
3672 * \li Action: Try to cancel completion, either the popup or the inline completion.
3673 * \li Syntax: completion-cancel
3674 * \li Origin: sts, Sep 07 2008
3677 { LFUN_COMPLETION_CANCEL, "completion-cancel", SingleParUpdate, Edit },
3679 * \var lyx::FuncCode lyx::LFUN_COMPLETION_ACCEPT
3680 * \li Action: Accept suggested completion.
3681 * \li Syntax: completion-accept
3682 * \li Origin: sanda, Sep 08 2008
3685 { LFUN_COMPLETION_ACCEPT, "completion-accept", SingleParUpdate, Edit },
3689 * \var lyx::FuncCode lyx::LFUN_BRANCH_ADD
3690 * \li Action: Add a branch to the buffer's BranchList.
3691 * \li Syntax: branch-add <BRANCH>
3692 * \li Params: <BRANCH>: Name of the branch to add
3693 * \li Origin: spitz, 7 Jul 2009
3696 { LFUN_BRANCH_ADD, "branch-add", AtPoint, Buffer },
3700 * \var lyx::FuncCode lyx::LFUN_BRANCH_INVERT
3701 * \li Action: Toggles inversion status of branch inset.
3702 * \li Syntax: branch-invert
3703 * \li Origin: rgheck, 12 July 2016
3706 { LFUN_BRANCH_INVERT, "branch-invert", AtPoint, Buffer },
3709 * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
3710 * \li Action: Activate the branch.
3711 * \li Syntax: branch-activate <BRANCH>
3712 * \li Params: <BRANCH>: The branch to activate
3713 * \li Sample: lyx -x "branch-activate answers" -e pdf2 finalexam.lyx \n
3714 could be used to export a pdf with the answers branch included
3715 without one's having to open LyX and activate the branch manually.
3716 * \li Origin: rgh, 27 May 2008
3719 { LFUN_BRANCH_ACTIVATE, "branch-activate", AtPoint, Buffer },
3721 * \var lyx::FuncCode lyx::LFUN_BRANCH_DEACTIVATE
3722 * \li Action: De-activate the branch.
3723 * \li Syntax: branch-deactivate <BRANCH>
3724 * \li Params: <BRANCH>: The branch to deactivate
3725 * \li Origin: rgh, 27 May 2008
3728 { LFUN_BRANCH_DEACTIVATE, "branch-deactivate", AtPoint, Buffer },
3730 * \var lyx::FuncCode lyx::LFUN_BRANCH_MASTER_ACTIVATE
3731 * \li Action: Activate the branch in the master buffer.
3732 * \li Syntax: branch-master-activate <BRANCH>
3733 * \li Params: <BRANCH>: The branch to activate
3734 * \li Sample: lyx -x "branch-activate answers" -e pdf2 finalexam.lyx \n
3735 could be used to export a pdf with the answers branch included
3736 without one's having to open LyX and activate the branch manually.
3737 * \li Origin: spitz, 30 Sep 2012
3740 { LFUN_BRANCH_MASTER_ACTIVATE, "branch-master-activate", AtPoint, Buffer },
3742 * \var lyx::FuncCode lyx::LFUN_BRANCH_MASTER_DEACTIVATE
3743 * \li Action: De-activate the branch in the master buffer.
3744 * \li Syntax: branch-master-deactivate <BRANCH>
3745 * \li Params: <BRANCH>: The branch to deactivate
3746 * \li Origin: spitz, 30 Sep 2012
3749 { LFUN_BRANCH_MASTER_DEACTIVATE, "branch-master-deactivate", AtPoint, Buffer },
3752 * \var lyx::FuncCode lyx::LFUN_BRANCHES_RENAME
3753 * \li Action: Rename all branches of a given name in a document.
3754 * \li Syntax: branches-rename <OLDNAME> <NEWNAME>
3755 * \li Params: <OLDNAME>: Current name of the branch to be renamed
3756 * <NEWNAME>: New name of the branch
3757 * \li Origin: spitz, 9 Jul 2009
3760 { LFUN_BRANCHES_RENAME, "branches-rename", Noop, Buffer },
3762 * \var lyx::FuncCode lyx::LFUN_BRANCH_ADD_INSERT
3763 * \li Action: Create new branch and directly put the branch inset into
3765 * \li Syntax: branch-add-insert [<NAME>]
3766 * \li Params: <NAME>: Branch name. If it is not specified, you will be asked.
3767 * \li Origin: sanda, 10 Jul 2009
3770 { LFUN_BRANCH_ADD_INSERT, "branch-add-insert", Noop, Buffer },
3774 * \var lyx::FuncCode lyx::LFUN_LABEL_COPY_AS_REF
3775 * \li Action: Copies the label at the cursor as a cross-reference to be pasted elsewhere.
3776 * \li Syntax: copy-label-as-reference <LABEL>
3777 * \li Params: <LABEL>: The label to copy (for multi-line math)
3778 * \li Origin: sts, 16 Nov 2008
3781 { LFUN_LABEL_COPY_AS_REFERENCE, "label-copy-as-reference",
3782 ReadOnly | NoUpdate | AtPoint, Edit },
3785 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT_AS_REFERENCE
3786 * \li Action: Inserts the label (in ToC pane) as a cross-reference at the position of the cursor.
3787 * \li Syntax: label-insert-as-reference
3788 * \li Origin: vfr, 7 Apr 2009
3791 { LFUN_LABEL_INSERT_AS_REFERENCE, "label-insert-as-reference", Noop, Edit},
3794 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_IN
3795 * \li Action: Increases the zoom of the screen fonts.
3796 * \li Syntax: buffer-zoom-in [<ZOOM>]
3797 * \li Params: <ZOOM>: The zoom in % points (neg. or pos.), the default is 20.
3798 * \li Origin: vfr, 30 Mar 2009
3801 { LFUN_BUFFER_ZOOM_IN, "buffer-zoom-in", ReadOnly, Buffer },
3804 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_OUT
3805 * \li Action: Decreases the zoom of the screen fonts.
3806 * \li Syntax: buffer-zoom-out [<ZOOM>]
3807 * \li Params: <ZOOM>: The zoom in % points (neg. or pos.), the default is -20.
3808 * \li Origin: vfr, 30 Mar 2009
3811 { LFUN_BUFFER_ZOOM_OUT, "buffer-zoom-out", ReadOnly, Buffer },
3814 * \var lyx::FuncCode lyx::LFUN_INSET_COPY_AS
3815 * \li Action: Copies the inset to the clipboard as a certain type.
3816 * \li Notion: Currently used only for InsetInfo where its content is copied as a text.
3817 * \li Syntax: inset-copy-as
3818 * \li Origin: vfr, 18 Apr 2010
3821 { LFUN_INSET_COPY_AS, "inset-copy-as", ReadOnly | NoUpdate | AtPoint, Edit },
3824 * \var lyx::FuncCode lyx::LFUN_ENVIRONMENT_SPLIT
3825 * \li Action: Splits the current environment with a Separator.
3826 * \li Syntax: environment-split [outer]
3827 * \li Params: outer: If this is given, LyX will split the outermost environment in
3828 * the current nesting hierarchy.
3829 * \li Origin: spitz, 23 Dec 2012
3832 { LFUN_ENVIRONMENT_SPLIT, "environment-split", Noop, Layout },
3834 { LFUN_NOACTION, "", Noop, Hidden }
3835 #ifndef DOXYGEN_SHOULD_SKIP_THIS
3838 for (int i = 0; items[i].action != LFUN_NOACTION; ++i)
3839 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
3845 LyXAction::LyXAction()
3851 FuncRequest LyXAction::lookupFunc(string const & func) const
3853 string const func2 = trim(func);
3856 return FuncRequest(LFUN_NOACTION);
3859 string const arg = split(func2, cmd, ' ');
3861 FuncMap::const_iterator const fit = lyx_func_map.find(cmd);
3863 return fit != lyx_func_map.end()
3864 ? FuncRequest(fit->second, arg)
3865 : FuncRequest(LFUN_UNKNOWN_ACTION);
3869 string const LyXAction::getActionName(FuncCode action) const
3871 InfoMap::const_iterator const it = lyx_info_map.find(action);
3872 return it != lyx_info_map.end() ? it->second.name : string();
3876 LyXAction::FuncType LyXAction::getActionType(FuncCode action) const
3878 InfoMap::const_iterator const it = lyx_info_map.find(action);
3879 return it != lyx_info_map.end() ? it->second.type : Hidden;
3883 bool LyXAction::funcHasFlag(FuncCode action,
3884 LyXAction::FuncAttribs flag) const
3886 InfoMap::const_iterator ici = lyx_info_map.find(action);
3888 if (ici == lyx_info_map.end()) {
3889 LYXERR0("action: " << action << " is not known.");
3890 LASSERT(false, return false);
3893 return ici->second.attrib & flag;
3897 LyXAction::const_iterator LyXAction::func_begin() const
3899 return lyx_func_map.begin();
3903 LyXAction::const_iterator LyXAction::func_end() const
3905 return lyx_func_map.end();
3909 LyXErr & operator<<(LyXErr & l, FuncCode code)
3912 l.stream() << lyxaction.getActionName(code);