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 primarily describes the purpose and syntax
53 * of the various LFUNs.
55 * The list is alphabetized. Try to keep it that way, and don't forget to add
56 * doxygen commentary. This allows the file LFUNs.lyx to be auto-generated.
57 * (If you should want to do that, see the gen_lfuns.py script, which is in
58 * the development/tools/ directory.)
60 * Doxygen template below. Some notes: Parameters should be set in uppercase
61 * and put in <BRACKETS>, [<PARAM>] means optional one.
63 * Use spaces for indentation (doxy -> .lyx generator is tab-sensitive).
67 * \var lyx::FuncCode lyx::LFUN_
80 void LyXAction::newFunc(FuncCode action, string const & name,
81 unsigned int attrib, LyXAction::FuncType type)
83 lyx_func_map[name] = action;
86 tmpinfo.attrib = attrib;
88 lyx_info_map[action] = tmpinfo;
92 // Needed for LFUNs documentation to be accepted, since doxygen won't take
93 // \var inside functions.
94 #ifndef DOXYGEN_SHOULD_SKIP_THIS
95 void LyXAction::init()
97 // This function was changed to use the array below in initalization
98 // instead of calling newFunc numerous times because of compilation
99 // times. Since the array is not static we get back the memory it
100 // occupies after the init is completed. It compiles several
101 // magnitudes faster.
114 ev_item const items[] = {
118 * \var lyx::FuncCode lyx::LFUN_ACCENT_ACUTE
119 * \li Action: Adds an acute accent \htmlonly (á)\endhtmlonly
120 to the next character typed.
121 * \li Syntax: accent-acute
124 { LFUN_ACCENT_ACUTE, "accent-acute", Noop, Edit },
127 * \var lyx::FuncCode lyx::LFUN_ACCENT_BREVE
128 * \li Action: Adds a breve accent \htmlonly (ă)\endhtmlonly
129 to the next character typed.
130 * \li Syntax: accent-breve
133 { LFUN_ACCENT_BREVE, "accent-breve", Noop, Edit },
136 * \var lyx::FuncCode lyx::LFUN_ACCENT_CARON
137 * \li Action: Adds a caron \htmlonly (ǎ)\endhtmlonly
138 to the next character typed.
139 * \li Syntax: accent-caron
142 { LFUN_ACCENT_CARON, "accent-caron", Noop, Edit },
145 * \var lyx::FuncCode lyx::LFUN_ACCENT_CEDILLA
146 * \li Action: Adds a cedilla \htmlonly (ç)\endhtmlonly
147 to the next character typed.
148 * \li Syntax: accent-cedilla
151 { LFUN_ACCENT_CEDILLA, "accent-cedilla", Noop, Edit },
154 * \var lyx::FuncCode lyx::LFUN_ACCENT_CIRCLE
155 * \li Action: Adds a circle accent \htmlonly (å)\endhtmlonly
156 to the next character typed.
157 * \li Syntax: accent-circle
160 { LFUN_ACCENT_CIRCLE, "accent-circle", Noop, Edit },
163 * \var lyx::FuncCode lyx::LFUN_ACCENT_CIRCUMFLEX
164 * \li Action: Adds a circumflex \htmlonly (ê)\endhtmlonly
165 to the next character typed.
166 * \li Syntax: accent-circumflex
169 { LFUN_ACCENT_CIRCUMFLEX, "accent-circumflex", Noop, Edit },
172 * \var lyx::FuncCode lyx::LFUN_ACCENT_DOT
173 * \li Action: Adds a dot accent \htmlonly (ż)\endhtmlonly
174 to the next character typed.
175 * \li Syntax: accent-dot
178 { LFUN_ACCENT_DOT, "accent-dot", Noop, Edit },
181 * \var lyx::FuncCode lyx::LFUN_ACCENT_GRAVE
182 * \li Action: Adds a grave accent \htmlonly (è)\endhtmlonly
183 to the next character typed.
184 * \li Syntax: accent-grave
187 { LFUN_ACCENT_GRAVE, "accent-grave", Noop, Edit },
190 * \var lyx::FuncCode lyx::LFUN_ACCENT_HUNGARIAN_UMLAUT
191 * \li Action: Adds a Hungarian umlaut \htmlonly (ő)\endhtmlonly
192 to the next character typed.
193 * \li Syntax: accent-grave
196 { LFUN_ACCENT_HUNGARIAN_UMLAUT, "accent-hungarian-umlaut", Noop, Edit },
199 * \var lyx::FuncCode lyx::LFUN_ACCENT_MACRON
200 * \li Action: Adds a macron \htmlonly (ā)\endhtmlonly
201 to the next character typed.
202 * \li Syntax: accent-macron
205 { LFUN_ACCENT_MACRON, "accent-macron", Noop, Edit },
208 * \var lyx::FuncCode lyx::LFUN_ACCENT_OGONEK
209 * \li Action: Adds an ogonek accent \htmlonly (ą)\endhtmlonly
210 to the next character typed.
211 * \li Syntax: accent-ogonek
214 { LFUN_ACCENT_OGONEK, "accent-ogonek", Noop, Edit },
217 * \var lyx::FuncCode lyx::LFUN_ACCENT_PERISPOMENI
218 * \li Action: Adds a perispomeni (Greek circumflex)
219 over the next character typed.
220 * \li Syntax: accent-perispomeni
223 { LFUN_ACCENT_PERISPOMENI, "accent-perispomeni", Noop, Edit },
226 * \var lyx::FuncCode lyx::LFUN_ACCENT_TIE
227 * \li Action: Adds a tie \htmlonly (a͡)\endhtmlonly
228 over the next two character typed.
229 * \li Notion: The following char will finish the tie.
230 * \li Syntax: accent-tie
233 { LFUN_ACCENT_TIE, "accent-tie", Noop, Edit },
236 * \var lyx::FuncCode lyx::LFUN_ACCENT_TILDE
237 * \li Action: Adds a tilde \htmlonly (ã)\endhtmlonly
238 over the next character typed.
239 * \li Syntax: accent-tilde
242 { LFUN_ACCENT_TILDE, "accent-tilde", Noop, Edit },
245 * \var lyx::FuncCode lyx::LFUN_ACCENT_UMLAUT
246 * \li Action: Adds an umlaut \htmlonly (ä)\endhtmlonly
247 over the next character typed.
248 * \li Syntax: accent-umlaut
251 { LFUN_ACCENT_UMLAUT, "accent-umlaut", Noop, Edit },
254 * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERBAR
255 * \li Action: Adds a bar \htmlonly (a̠)\endhtmlonly
256 under the next character typed.
257 * \li Syntax: accent-underbar
260 { LFUN_ACCENT_UNDERBAR, "accent-underbar", Noop, Edit },
263 * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERDOT
264 * \li Action: Adds a dot \htmlonly (ạ)\endhtmlonly
265 under the next character typed.
266 * \li Syntax: accent-underdot
269 { LFUN_ACCENT_UNDERDOT, "accent-underdot", Noop, Edit },
273 * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_ACCEPT
274 * \li Action: Accepts all tracked changes in the document.
275 * \li Syntax: all-changes-accept
276 * \li Origin: Levon, 16 Oct 2002
279 { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
282 * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_REJECT
283 * \li Action: Rejects all tracked changes in the document.
284 * \li Notion: Reject does not work recursively; the user may have to repeat the operation.
285 * \li Syntax: all-changes-reject
286 * \li Origin: Levon, 16 Oct 2002
289 { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
293 * \var lyx::FuncCode lyx::LFUN_APPENDIX
294 * \li Action: Start (or remove) Appendix on the given cursor position.
295 * \li Syntax: appendix
296 * \li Origin: ettrich, 5 May 1998
299 { LFUN_APPENDIX, "appendix", Noop, Edit },
303 * \var lyx::FuncCode lyx::LFUN_ARGUMENT_INSERT
304 * \li Action: Inserts an argument (short title) inset.
305 * \li Syntax: argument-insert <argument nr>
306 * \li Params: <argument nr>: see layout declarations
307 * \li Origin: vermeer, 12 Aug 2002
310 { LFUN_ARGUMENT_INSERT, "argument-insert", Noop, Edit },
313 * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_ADD
314 * \li Action: Adds database, which will be used for bibtex citations.
315 * \li Notion: Databases are added to the first BibTeX inset
316 (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
317 * \li Syntax: bibtex-database-add <DATABASE-NAME>
318 * \li Origin: Ale, 30 May 1997
321 { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit },
324 * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_DEL
325 * \li Action: Adds database, which will be used for bibtex citations.
326 * \li Notion: Databases are deleted from the first BibTeX inset
327 (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
328 * \li Syntax: bibtex-database-del <DATABASE-NAME>
329 * \li Origin: Ale, 30 May 1997
332 { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
335 * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_LIST
336 * \li Action: Lists the available databases (separated by path separator common
338 * \li Notion: Used by bibliographic managers
339 * \li Syntax: bibtex-database-list
340 * \li Origin: bpiwowar, 18 December 2022
343 { LFUN_BIBTEX_DATABASE_LIST, "bibtex-database-list", ReadOnly, System },
346 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
347 * \li Action: Clears the list of saved bookmarks.
348 * \li Syntax: bookmark-clear
349 * \li Origin: bpeng, 31 October 2006
352 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
356 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
357 * \li Action: Moves the cursor to the numbered bookmark, opening the file
358 if necessary. Note that bookmarks are saved per-session, not
360 * \li Notion: Bookmark 0 has a special purpose. It is automatically set \n
361 1. to the paragraph you are currently editing \n
362 2. to the paragraph from where you are jumping to the last-edited
363 position (jump-back feature) \n
364 3. when jumping from crossreference to the requested label by
366 * \li Syntax: bookmark-goto <NUMBER>
367 * \li Params: <NUMBER>: the number of the bookmark to restore.
368 * \li Origin: Dekel, 27 January 2001
371 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
374 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
375 * \li Action: Save a bookmark.
376 * \li Notion: Saves a numbered bookmark to the sessions file. The number
377 must be between 1 and 9, inclusive. Note that bookmarks are
378 saved per-session, not per file.
379 * \li Syntax: bookmark-save <NUMBER>
380 * \li Params: <NUMBER>: the number of the bookmark to save.
381 * \li Origin: Dekel, 27 January 2001
384 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
387 * \var lyx::FuncCode lyx::LFUN_BOX_INSERT
388 * \li Action: Inserts Box inset.
389 * \li Syntax: box-insert [<TYPE>]
390 * \li Params: <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox \n
391 Framed is the default one.
392 * \li Origin: vermeer, 7 Oct 2003
395 { LFUN_BOX_INSERT, "box-insert", Noop, Edit },
398 * \var lyx::FuncCode lyx::LFUN_BRANCHES_RENAME
399 * \li Action: Rename all branches of a given name in a document.
400 * \li Syntax: branches-rename <OLDNAME> <NEWNAME>
401 * \li Params: <OLDNAME>: Current name of the branch to be renamed
402 * <NEWNAME>: New name of the branch
403 * \li Origin: spitz, 9 Jul 2009
406 { LFUN_BRANCHES_RENAME, "branches-rename", Noop, Buffer },
409 * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
410 * \li Action: Activate the branch.
411 * \li Syntax: branch-activate <BRANCH>
412 * \li Params: <BRANCH>: The branch to activate
413 * \li Sample: lyx -x "branch-activate answers" -e pdf2 finalexam.lyx \n
414 could be used to export a pdf with the answers branch included
415 without one's having to open LyX and activate the branch manually.
416 * \li Origin: rgh, 27 May 2008
419 { LFUN_BRANCH_ACTIVATE, "branch-activate", AtPoint, Buffer },
422 * \var lyx::FuncCode lyx::LFUN_BRANCH_ADD
423 * \li Action: Add a branch to the buffer's BranchList.
424 * \li Syntax: branch-add <BRANCH>
425 * \li Params: <BRANCH>: Name of the branch to add
426 * \li Origin: spitz, 7 Jul 2009
429 { LFUN_BRANCH_ADD, "branch-add", AtPoint, Buffer },
434 * \var lyx::FuncCode lyx::LFUN_BRANCH_ADD_INSERT
435 * \li Action: Create new branch and directly put the branch inset into
437 * \li Syntax: branch-add-insert [<NAME>]
438 * \li Params: <NAME>: Branch name. If it is not specified, you will be asked.
439 * \li Origin: sanda, 10 Jul 2009
442 { LFUN_BRANCH_ADD_INSERT, "branch-add-insert", Noop, Buffer },
447 * \var lyx::FuncCode lyx::LFUN_BRANCH_DEACTIVATE
448 * \li Action: De-activate the branch.
449 * \li Syntax: branch-deactivate <BRANCH>
450 * \li Params: <BRANCH>: The branch to deactivate
451 * \li Origin: rgh, 27 May 2008
454 { LFUN_BRANCH_DEACTIVATE, "branch-deactivate", AtPoint, Buffer },
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 },
466 * \var lyx::FuncCode lyx::LFUN_BRANCH_SYNC_ALL
467 * \li Action: Open/close all insets of selected branch (depending on its activation status).
468 * \li Syntax: branch-sync-all
469 * \li Origin: sanda, 15 April 2022
472 { LFUN_BRANCH_SYNC_ALL, "branch-sync-all", AtPoint, Buffer },
475 * \var lyx::FuncCode lyx::LFUN_BRANCH_INVERT
476 * \li Action: Toggles inversion status of branch inset.
477 * \li Syntax: branch-invert
478 * \li Origin: rgheck, 12 July 2016
481 { LFUN_BRANCH_INVERT, "branch-invert", AtPoint, Buffer },
485 * \var lyx::FuncCode lyx::LFUN_BRANCH_MASTER_ACTIVATE
486 * \li Action: Activate the branch in the master buffer.
487 * \li Syntax: branch-master-activate <BRANCH>
488 * \li Params: <BRANCH>: The branch to activate
489 * \li Sample: lyx -x "branch-activate answers" -e pdf2 finalexam.lyx \n
490 could be used to export a pdf with the answers branch included
491 without one's having to open LyX and activate the branch manually.
492 * \li Origin: spitz, 30 Sep 2012
495 { LFUN_BRANCH_MASTER_ACTIVATE, "branch-master-activate", AtPoint, Buffer },
498 * \var lyx::FuncCode lyx::LFUN_BRANCH_MASTER_DEACTIVATE
499 * \li Action: De-activate the branch in the master buffer.
500 * \li Syntax: branch-master-deactivate <BRANCH>
501 * \li Params: <BRANCH>: The branch to deactivate
502 * \li Origin: spitz, 30 Sep 2012
505 { LFUN_BRANCH_MASTER_DEACTIVATE, "branch-master-deactivate", AtPoint, Buffer },
509 * \var lyx::FuncCode lyx::LFUN_BUFFER_ANONYMIZE
510 * \li Action: For debug purposes only. Convert all [a-zA-Z0-1] characters to
511 single character. Useful when submitting docs to list or bugzilla.
512 * \li Syntax: buffer-anonymize
513 * \li Origin: sanda, Feb 1 2018
516 { LFUN_BUFFER_ANONYMIZE, "buffer-anonymize", Noop, Edit },
520 * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
521 * \li Action: Saves the current buffer to a temporary file.
522 * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
523 is called automatically by LyX, to "autosave" the current buffer.
524 * \li Syntax: buffer-auto-save
527 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
530 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN
531 * \li Action: Move the cursor to the beginning of the document.
532 * \li Syntax: buffer-begin
535 { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
538 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN_SELECT
539 * \li Action: Move the cursor to the beginning of the document adding the
540 traversed text to the selection.
541 * \li Syntax: buffer-begin-select
544 { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
547 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHILD_OPEN
548 * \li Action: Loads the given child document.
549 * \li Notion: The current document is treated as a parent.
550 * \li Syntax: buffer-child-open <FILE>
551 * \li Params: <FILE>: Filename of the child. The directory of the parent is assumed by default.
552 * \li Origin: Ale, 28 May 1997
555 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
558 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHKTEX
559 * \li Action: Runs chktex for the current document.
560 * \li Syntax: buffer-chktex
561 * \li Origin: Asger, 30 Oct 1997
564 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
567 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
568 * \li Action: Closes the current buffer.
569 * \li Notion: Closes the current buffer, asking whether to save it, etc,
570 if the buffer has been modified.
571 * \li Syntax: buffer-close
574 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
577 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE_ALL
578 * \li Action: Closes all buffers.
579 * \li Notion: Closes all buffers, asking whether to save it, etc,
580 if a buffer has been modified.
581 * \li Syntax: buffer-close-all
584 { LFUN_BUFFER_CLOSE_ALL, "buffer-close-all", ReadOnly, Buffer },
587 * \var lyx::FuncCode lyx::LFUN_BUFFER_END
588 * \li Action: Move the cursor to the end of the document.
589 * \li Syntax: buffer-end
592 { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
595 * \var lyx::FuncCode lyx::LFUN_BUFFER_END_SELECT
596 * \li Action: Move the cursor to the end of the document adding the
597 traversed text to the selection.
598 * \li Syntax: buffer-end-select
601 { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
605 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
606 * \li Action: Exports the current buffer (document) to the given format.
607 * \li Syntax: buffer-export [<FORMAT>] [<DEST>]
608 * \li Params: <FORMAT> is either "custom" or one of the formats which you
609 can find in Tools->Preferences->File formats->Format.
610 Usual format you will enter is "pdf2" (pdflatex),
611 "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
612 In case of "custom" you will be asked for a format you
613 want to start from and for the command that you want to
614 apply to this format. Internally the control is then passed
615 to #LFUN_BUFFER_EXPORT_CUSTOM.\n
616 If absent or "default", then the default output format of the
618 <DEST> If present, this argument provides the export destination
619 filename. Its containing folder will also be the destination
620 folder, where all the needed external files will be copied.
621 * \li Origin: Lgb, 29 Jul 1997
624 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
627 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_AS
628 * \li Action: Opens a dialog for exporting the current buffer.
629 * \li Syntax: buffer-export-as [<FORMAT>]
630 * \li Params: <FORMAT> is the export format initially selected in the dialog.
631 * You can pass any of the formats which you can find in
632 * Tools->Preferences->File formats->Format, provided it
633 * has the "document" flag set. If no format is specified
634 * the dialog will start with the default output format of
635 * the current document.
636 * \li Sample: buffer-export-as pdf2
637 * \li Origin: tommaso, 6 Oct 2011
640 { LFUN_BUFFER_EXPORT_AS, "buffer-export-as", ReadOnly, Buffer },
643 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
644 * \li Action: Exports the current buffer (document) from the given format using
645 the given command on it.
646 * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
647 * \li Params: <FORMAT> format to start from (LyX will care to produce such
648 intermediate file).\n
649 <COMMAND> this command will be launched on the file. Note that you can
650 use "$$FName" string to qualify the intermediate file.
651 * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
652 * \li Origin: leeming, 27 Mar 2004
655 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
658 * \var lyx::FuncCode lyx::LFUN_BUFFER_FORALL
659 * \li Action: Applies a command to all non-hidden buffers.
660 * \li Notion: a buffer is `hidden' if it is internally open in LyX, but not
661 visible in any window.
662 * \li Syntax: buffer-forall <LFUN-COMMAND>
663 * \li Params: <LFUN-COMMAND>: The command to be applied to the buffers.
664 * \li Sample: Close all Notes in all buffers: \n
665 buffer-forall inset-forall Note inset-toggle close \n
666 Toggle change tracking on buffers: \n
667 buffer-forall changes-track \n
668 Toggle read-only for buffers: \n
669 buffer-forall buffer-toggle-read-only \n
670 Show statistics for individual buffers: \n
671 buffer-forall statistics \n
672 Activate the branch named "Solutions" in buffers: \n
673 buffer-forall branch-activate Solutions \n
674 Export buffers to PDF (pdflatex): \n
675 buffer-forall buffer-export pdf2 \n
676 * \li Origin: skostysh, 20 Jul 2012
679 { LFUN_BUFFER_FORALL, "buffer-forall", ReadOnly | Argument, Buffer },
682 * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
683 * \li Action: Import a given file as a lyx document.
684 * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
685 defined converters in preferences. Look in the File->Import menu to get
686 an idea of the currently active import formats.
687 * \li Syntax: buffer-import <FORMAT> [<FILE>]
688 * \li Origin: Asger, 24 Jul 1998
691 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
694 * \var lyx::FuncCode lyx::LFUN_BUFFER_LANGUAGE
695 * \li Action: Set language of the current document.
696 * \li Syntax: buffer-language <LANG>
697 * \li Params: <LANG>: language name. See lib/languages for list.
698 * \li Origin: leeming, 30 Mar 2004
701 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
704 * \var lyx::FuncCode lyx::LFUN_BUFFER_MOVE_NEXT
705 * \li Action: Moves the current tab one spot to the right.
706 * \li Syntax: buffer-move-next
707 * \li Origin: skostysh, 7 Apr 2015
710 { LFUN_BUFFER_MOVE_NEXT, "buffer-move-next", ReadOnly, Buffer },
713 * \var lyx::FuncCode lyx::LFUN_BUFFER_MOVE_PREVIOUS
714 * \li Action: Moves the current tab one spot to the left.
715 * \li Syntax: buffer-move-previous
716 * \li Origin: skostysh, 7 Apr 2015
719 { LFUN_BUFFER_MOVE_PREVIOUS, "buffer-move-previous", ReadOnly, Buffer },
722 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
723 * \li Action: Creates a new buffer (that is, document) and switches to it.
724 * \li Notion: Implicit path can be set in Preferences dialog.
725 * \li Syntax: buffer-new [<FILE>]
726 * \li Params: <FILE>: filename of created file with absolute path.
729 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
732 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
733 * \li Action: Creates a new buffer (that is, document) from a template.
734 * \li Notion: Path for new files and templates can be set in Preferences dialog.
735 Template will be asked for via Open-dialog.
736 * \li Syntax: buffer-new-template [<FILE>] [<TEMPLATE FILE>]
737 * \li Params: <FILE>: filename of created file with absolute path. If empty
738 * or "newfile", a file with appropriate name is generated.\n
739 * <TEMPLATE FILE>: filename of template with absolute path. If empty,
740 * a dialog is opened to select the new file.
743 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
746 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEXT
747 * \li Action: Switch to the next opened document.
748 * \li Notion: Note that this does not necessarily mean next in tabbar
749 (for full list see View menu).
750 * \li Syntax: buffer-next
753 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
756 * \var lyx::FuncCode lyx::LFUN_BUFFER_PARAMS_APPLY
757 * \li Action: Apply the given settings to the current document.
758 * \li Syntax: buffer-params-apply [<ARGS>]
759 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
760 you can find in document header of usual .lyx file.
761 * \li Origin: leeming, 30 Mar 2004
764 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", NoInternal, Buffer },
768 * \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS
769 * \li Action: Switch to the previous opened document.
770 * \li Syntax: buffer-previous
773 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
776 * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
777 * \li Action: Reverts opened document.
778 * \li Syntax: buffer-reload [dump]
779 * \li Params: dump: do not ask for any confirmation, just reload. All changes will be lost.
780 * \li Origin: Asger, 2 Feb 1997
783 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
786 * \var lyx::FuncCode lyx::LFUN_BUFFER_RESET_EXPORT
787 * \li Action: Removes the auxiliary file before next export to assure export is done afresh.
788 * \li Syntax: buffer-reset-export
789 * \li Origin: spitz, 27 Dec 2019
792 { LFUN_BUFFER_RESET_EXPORT, "buffer-reset-export", ReadOnly, Buffer },
795 * \var lyx::FuncCode lyx::LFUN_BUFFER_SAVE_AS_DEFAULT
796 * \li Action: Save the current document settings as default.
797 * \li Notion: The file will will be saved into ~/.lyx/templates/defaults.lyx .
798 * \li Syntax: buffer-save-as-default [<ARGS>]
799 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
800 you can find in document header of usual .lyx file.
801 * \li Origin: leeming, 30 Mar 2004
804 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
807 * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
808 * \li Action: Display and switch to the given buffer.
809 * \li Syntax: buffer-switch <BUFFER>
810 * \li Params: <BUFFER>: path and filename of already opened (but possibly hidden)
811 document which is to be shown.
814 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
817 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
818 * \li Action: Toggles compression of the current document on/off.
819 * \li Syntax: buffer-toggle-compression
820 * \li Origin: bpeng, 27 Apr 2006
823 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
826 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_OUTPUT_SYNC
827 * \li Action: Toggles including of resources for forward/reverse search of the given document.
828 * \li Notion: When toggled on, SyncTeX is invoked for PDF, while srcltx package
829 is used for DVI. Custom LaTeX macro can be defined in preferences.
830 * \li Syntax: buffer-toggle-output-sync
831 * \li Origin: sanda, 25 May 2010
834 { LFUN_BUFFER_TOGGLE_OUTPUT_SYNC, "buffer-toggle-output-sync", Noop, System },
837 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
838 * \li Action: Toggle editing mode of the current document between read/write and read-only.
839 * \li Notion: This function is not allowed if the file is under version control, since
840 read-only flag is often used in version control file locking.
841 * \li Syntax: buffer-toggle-read-only
842 * \li Origin: Lgb, 27 May 1997
845 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
848 * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
849 * \li Action: Exports the current document and put the result into the
851 * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
852 the output will be rewritten - updated. This is useful in case your viewer
853 is able to detect such changes (e.g. ghostview for postscript).
854 * \li Syntax: buffer-update [<FORMAT>]
855 * \li Params: <FORMAT>: The format to display, where this is one of the
856 formats defined in the Tools>Preferences>File Formats dialog,
857 use the "Short name" field.
858 If no format is given, the default format as
859 specified in the same dialog is used.
860 * \li Origin: Dekel, 5 Aug 2000
863 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
867 * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
868 * \li Action: Displays current buffer in chosen format.
869 * \li Notion: Displays the contents of the current buffer in the chosen
870 format, for example, PDF or DVI. This runs the necessary
871 converter, calls the defined viewer, and so forth.
872 * \li Syntax: buffer-view [<FORMAT>]
873 * \li Params: <FORMAT>: The format to display, where this is one of the
874 formats defined (in the current GUI) in the
875 Tools>Preferences>File Formats dialog.
876 If no format is given, the default format as
877 specified in the same dialog is used.
880 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
883 * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW_CACHE
884 * \li Action: Opens the file that was created from last preview of this buffer.
885 * \li Notion: This LFUN is called by the "Show Output Anyway" button in the LaTeX
886 * Errors dialog. It can also be called by the user, which is useful
887 * if the document takes a long time to compile, and you just
888 * want to see the last previewed version.
889 * \li Syntax: buffer-view-cache
892 { LFUN_BUFFER_VIEW_CACHE, "buffer-view-cache", ReadOnly, Buffer },
895 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
896 * \li Action: Saves the current buffer.
897 * \li Notion: Saves the current buffer to disk, using the filename that
898 is already associated with the buffer, asking for one if
899 none is yet assigned.
900 * \li Syntax: buffer-write [force]
901 * \li Params: force: write even if buffer is not marked as modified.
904 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
907 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
908 * \li Action: Save all changed documents.
909 * \li Syntax: buffer-write-all
910 * \li Origin: rgh, gpothier 6 Aug 2007
913 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
916 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
917 * \li Action: Rename and save current buffer.
918 * \li Syntax: buffer-write-as <FILENAME>
919 * \li Params: <FILENAME>: New name of the buffer/file. A relative path
920 is with respect to the original location of the buffer/file.
923 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
926 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS_TEMPLATE
927 * \li Action: Rename and save current buffer in the local templates directory.
928 * \li Syntax: buffer-write-as-template <FILENAME>
929 * \li Params: <FILENAME>: New name of the buffer/file. A relative path
930 is with respect to the original location of the buffer/file.
933 { LFUN_BUFFER_WRITE_AS_TEMPLATE, "buffer-write-as-template", ReadOnly, Buffer },
937 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXTERNAL_MODIFICATION_CLEAR
938 * \li Action: Clear the external modification flag on the current buffer.
939 * \li Syntax: buffer-external-modification-clear
940 * \li Origin: gm, 2 March 2017
943 { LFUN_BUFFER_EXTERNAL_MODIFICATION_CLEAR,
944 "buffer-external-modification-clear", ReadOnly, Buffer },
947 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM
948 * \li Action: Sets the zoom of the screen fonts.
949 * \li Syntax: buffer-zoom [<ZOOM>]
950 * \li Params: <ZOOM>: The target zoom value in %;
951 * the default is the default zoom as saved in preferences.
952 * \li Origin: daniel, 28 Oct 2016
955 { LFUN_BUFFER_ZOOM, "buffer-zoom", ReadOnly, Buffer },
958 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_IN
959 * \li Action: Increases the zoom of the screen fonts.
960 * \li Syntax: buffer-zoom-in [<ZOOM>]
961 * \li Params: <ZOOM>: The zoom value addition in % (neg. or pos.);
962 * the default is 10% of the default zoom as saved in preferences.
963 * \li Origin: vfr, 30 Mar 2009
966 { LFUN_BUFFER_ZOOM_IN, "buffer-zoom-in", ReadOnly, Buffer },
970 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_OUT
971 * \li Action: Decreases the zoom of the screen fonts.
972 * \li Syntax: buffer-zoom-out [<ZOOM>]
973 * \li Params: <ZOOM>: The zoom value abstraction in % (neg. or pos.);
974 * the default is 10% of the default zoom as saved in preferences.
975 * \li Origin: vfr, 30 Mar 2009
978 { LFUN_BUFFER_ZOOM_OUT, "buffer-zoom-out", ReadOnly, Buffer },
982 * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
983 * \li Action: Generates the code (literate programming).
984 * \li Notion: Latex file with extension \literate_extension is generated.
985 Then LyX invokes \build_command (with a default of ``make'') to generate the code and
986 \build_error_filter to process the compilation error messages. \n
987 In case you want to process your literate file with a script, or some other program,
988 just insert in your lyxrc file an entry with:\n
989 \build_command "my_script my_arguments" \n
990 The \build_error_filter differs from the \literate_error_filter only in that the
991 former will identify error messages from your compiler.
992 * \li Syntax: build-program
995 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
999 * \var lyx::FuncCode lyx::LFUN_CALL
1000 * \li Action: Executes a command defined in a .def file.
1001 * \li Notion: The definitions are by default read from lib/commands/default.def.\n
1002 A .def file allows to define a command with \define "<NAME>" "<LFUN>"
1003 where <NAME> is the name of the new command and <LFUN> is the lfun code
1004 to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
1005 \def_file "FileName" allows to include another .def file. \n
1006 This is particularly useful in connection with toolbar buttons:
1007 Since the name of the button image for this lfun is
1008 lib/images/commands/<NAME>.png this is the way to assign an image
1009 to a complex command-sequence.
1010 * \li Syntax: call <NAME>
1011 * \li Params: <NAME>: Name of the command that must be called.
1012 * \li Origin: broider, 2 Oct 2007
1015 { LFUN_CALL, "call", NoBuffer, System },
1018 * \var lyx::FuncCode lyx::LFUN_CANCEL
1019 * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
1020 * \li Syntax: cancel
1023 { LFUN_CANCEL, "cancel", NoBuffer, System },
1027 * \var lyx::FuncCode lyx::LFUN_CAPTION_INSERT
1028 * \li Action: Inserts a caption inset.
1029 * \li Syntax: caption-insert
1030 * \li Origin: Lgb, 18 Jul 2000
1033 { LFUN_CAPTION_INSERT, "caption-insert", Noop, Edit },
1036 * \var lyx::FuncCode lyx::LFUN_CELL_BACKWARD
1037 * \li Action: Moves the cursor to the previous cell inside the table.
1038 * \li Syntax: cell-backward
1039 * \li Origin: Jug, 22 May 2000
1042 { LFUN_CELL_BACKWARD, "cell-backward", ReadOnly | NoUpdate, Edit },
1045 * \var lyx::FuncCode lyx::LFUN_CELL_FORWARD
1046 * \li Action: Moves the cursor to the next cell inside the table.
1047 * \li Syntax: cell-forward
1050 { LFUN_CELL_FORWARD, "cell-forward", ReadOnly | NoUpdate, Edit },
1053 * \var lyx::FuncCode lyx::LFUN_CELL_SPLIT
1054 * \li Action: Splits cell and shifts right part to the next cell (inside the math grid).
1055 * \li Syntax: cell-split
1056 * \li Origin: Ale, 15 May 1997
1059 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
1063 * \var lyx::FuncCode lyx::LFUN_CHANGES_MERGE
1064 * \li Action: Open change tracking dialog for merging and moves the cursor
1065 to the position of the next change.
1066 * \li Syntax: changes-merge
1067 * \li Origin: Levon, 16 Oct 2002
1070 { LFUN_CHANGES_MERGE, "changes-merge", ReadOnly, Edit },
1073 * \var lyx::FuncCode lyx::LFUN_CHANGES_OUTPUT
1074 * \li Action: Toggles showing of change tracking in typeset output.
1075 * \li Syntax: changes-output
1076 * \li Origin: spitz, 21 Jan 2005
1079 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
1082 * \var lyx::FuncCode lyx::LFUN_CHANGES_TRACK
1083 * \li Action: Toggles change tracking to on/off.
1084 * \li Syntax: changes-track
1085 * \li Origin: levon, 1 Oct 2002
1088 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
1091 * \var lyx::FuncCode lyx::LFUN_CHANGE_ACCEPT
1092 * \li Action: Accepts tracked change inside the selection.
1093 * \li Syntax: change-accept
1094 * \li Origin: Levon, 16 Oct 2002
1097 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
1100 * \var lyx::FuncCode lyx::LFUN_CHANGE_NEXT
1101 * \li Action: Moves the cursor to the position of the next change
1102 of the change tracking records.
1103 * \li Syntax: change-next
1104 * \li Origin: schmitt, 4 Oct 2006
1107 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
1110 * \var lyx::FuncCode lyx::LFUN_CHANGE_PREVIOUS
1111 * \li Action: Moves the cursor to the position of the previous change
1112 of the change tracking records.
1113 * \li Syntax: change-previous
1114 * \li Origin: vfr, 4 Apr 2009
1117 { LFUN_CHANGE_PREVIOUS, "change-previous", ReadOnly, Edit },
1120 * \var lyx::FuncCode lyx::LFUN_CHANGE_REJECT
1121 * \li Action: Rejects tracked change inside the selection.
1122 * \li Syntax: change-reject
1123 * \li Origin: Levon, 16 Oct 2002
1126 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
1129 * \var lyx::FuncCode lyx::LFUN_CHARS_TRANSPOSE
1130 * \li Action: Transposes the character at the cursor with the one before it.
1131 * \li Syntax: chars-transpose
1132 * \li Origin: Lgb, 25 Apr 2001
1135 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
1139 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD
1140 * \li Action: Moves the cursor one position logically backwards.
1141 * \li Notion: This is not the action which should be bound to the arrow keys,
1142 because backwards may be left or right, depending on the
1143 language. The arrow keys should be bound to #LFUN_CHAR_LEFT or
1144 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
1145 * \li Syntax: char-backward
1148 { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit },
1151 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD_SELECT
1152 * \li Action: Moves the cursor one position logically backwards, adding
1153 traversed position to the selection.
1154 * \li Notion: See also #LFUN_CHAR_BACKWARD.
1155 * \li Syntax: char-backward-select
1158 { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit },
1161 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_BACKWARD
1162 * \li Action: Deletes one character in the backward direction (usually the "BackSpace" key).
1163 * \li Syntax: char-delete-backward [confirm]
1164 * \li Params: confirm: Select big insets, do not directly delete them.
1167 { LFUN_CHAR_DELETE_BACKWARD, "char-delete-backward", SingleParUpdate, Edit },
1170 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_FORWARD
1171 * \li Action: Deletes one character in the backward direction (usually the "Delete" key).
1172 * \li Syntax: char-delete-forward [confirm]
1173 * \li Params: confirm: Select big insets, do not directly delete them.
1176 { LFUN_CHAR_DELETE_FORWARD, "char-delete-forward", SingleParUpdate, Edit },
1179 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD
1180 * \li Action: Moves the cursor one position logically forward.
1181 * \li Notion: This is not the action which should be bound to the arrow keys,
1182 because forward may be left or right, depending on the language.
1183 The arrow keys should be bound to #LFUN_CHAR_LEFT or
1184 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
1185 * \li Syntax: char-forward
1188 { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit },
1191 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD_SELECT
1192 * \li Action: Moves the cursor one position logically forward, adding
1193 traversed position to the selection.
1194 * \li Notion: See also #LFUN_CHAR_FORWARD.
1195 * \li Syntax: char-forward-select
1198 { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit },
1201 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT
1202 * \li Action: Moves the cursor one position "to the left".
1203 * \li Notion: This is the action which should be taken when the "left" key
1204 is pressed. Generally, it moves the cursor one position to the
1205 left. However, in Bidi text this become slightly more
1206 complicated, and there are different modes of cursor movement.
1207 In "visual mode", this moves left, plain and simple. In "logical
1208 mode", movement is logically forward in RTL paragraphs, and
1209 logically backwards in LTR paragraphs.
1210 * \li Syntax: char-left
1213 { LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit },
1216 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT_SELECT
1217 * \li Action: Moves the cursor one position "to the left", adding
1218 traversed position to the selection.
1219 * \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement.
1220 * \li Syntax: char-left-select
1223 { LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit },
1226 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT
1227 * \li Action: Moves the cursor one position "to the right".
1228 * \li Notion: This is the action which should be taken when the "right" key
1229 is pressed. Generally, it moves the cursor one position to the
1230 right. However, in Bidi text this become slightly more
1231 complicated, and there are different modes of cursor movement.
1232 In "visual mode", this moves right, plain and simple. In "logical
1233 mode", movement is logically forward in LTR paragraphs, and
1234 logically backwards in RTL paragraphs.
1235 * \li Syntax: char-right
1238 { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit },
1241 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT_SELECT
1242 * \li Action: Moves the cursor one position "to the right", adding
1243 traversed position to the selection.
1244 * \li Notion: See also #LFUN_CHAR_RIGHT for exact details of the movement.
1245 * \li Syntax: char-right-select
1248 { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit },
1252 * \var lyx::FuncCode lyx::LFUN_CITATION_INSERT
1253 * \li Action: Inserts citation from loaded citation database.
1254 * \li Syntax: citation-insert [<KEY>[|<TEXT_BEFORE>]]
1255 * \li Params: <KEY>: Citation (shortcut listed in available citations). \n
1256 <TEXT_BEFORE>: text which should appear before citation.
1257 * \li Origin: AAS, 97-02-23
1260 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
1262 * \var lyx::FuncCode lyx::LFUN_CITATION_OPEN
1263 * \li Action: Opens the corresponding pdf/url for a given citation inset.
1264 * \li Syntax: citation-open [EXTERNAL] TARGET
1265 * \li Params: <TARGET>: URL (https:,file:) of the document. \n
1266 <EXTERNAL>: Use external executable script for finding target \n
1267 and launching viewer. In this case TARGET consists of author and year \n
1268 and will be passed as an input argument to the script.
1269 * \li Origin: Sanda, 16 Aug 2020
1272 { LFUN_CITATION_OPEN, "citation-open", ReadOnly | NoUpdate | Argument, 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 },
1292 * \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE_SIMPLE
1293 * \li Action: Pastes plain text from the active clipboard even if formatted
1294 LyX content is in the clipboard. Pastes plain text if plain text
1295 is on the clipboard, without trying to interpret it in special
1296 ways for certain insets, e.g. converting csv data to rows and
1297 columns if the paste happens in a tabular inset.
1298 * \li Syntax: clipboard-paste-simple [<ARG>]
1299 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1302 { LFUN_CLIPBOARD_PASTE_SIMPLE, "clipboard-paste-simple", Noop, Edit },
1305 * \var lyx::FuncCode lyx::LFUN_COMMAND_ALTERNATIVES
1306 * \li Action: Runs the first listed command that is enabled.
1307 * \li Notion: This can be used to bind multiple functions to a single key,
1308 and then which one is used will depend upon the context.
1309 * \li Syntax: command-alternatives <CMDS>
1310 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
1311 * \li Sample: command-alternatives completion-accept;cell-forward
1312 * \li Origin: rgh, 24 September 2008
1315 { LFUN_COMMAND_ALTERNATIVES, "command-alternatives", NoBuffer, System },
1318 * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
1319 * \li Action: Switches the focus to the minibuffer so that the user can type
1320 in there. If necessary, it opens the minibuffer toolbar.
1321 * \li Notion: Usually bound to M-x shortcut.
1322 * \li Syntax: command-execute
1325 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
1329 * \var lyx::FuncCode lyx::LFUN_COMMAND_PREFIX
1330 * \li Action: Return the current key sequence and available options as a string.
1331 * \li Notion: No options are added if no current map exists. \n
1332 This is probably usable only with connection to lyxserver.
1333 * \li Syntax: command-prefix
1336 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
1339 * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
1340 * \li Action: Run more commands (LFUN and its parameters) in a sequence.
1341 * \li Syntax: command-sequence <CMDS>
1342 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
1343 * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
1344 * \li Origin: Andre, 11 Nov 1999
1347 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
1350 * \var lyx::FuncCode lyx::LFUN_COMPLETE
1351 * \li Action: Try to complete the word or command at the cursor position.
1352 * \li Syntax: complete
1353 * \li Origin: sts, Feb 19 2008
1356 { LFUN_COMPLETE, "complete", SingleParUpdate, Edit },
1360 * \var lyx::FuncCode lyx::LFUN_COMPLETION_ACCEPT
1361 * \li Action: Accept suggested completion.
1362 * \li Syntax: completion-accept
1363 * \li Origin: sanda, Sep 08 2008
1366 { LFUN_COMPLETION_ACCEPT, "completion-accept", SingleParUpdate, Edit },
1371 * \var lyx::FuncCode lyx::LFUN_COMPLETION_CANCEL
1372 * \li Action: Try to cancel completion, either the popup or the inline completion.
1373 * \li Syntax: completion-cancel
1374 * \li Origin: sts, Sep 07 2008
1377 { LFUN_COMPLETION_CANCEL, "completion-cancel", SingleParUpdate, Edit },
1380 * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
1381 * \li Action: Show the inline completion at the cursor position.
1382 * \li Syntax: completion-inline
1383 * \li Origin: sts, Feb 19 2008
1386 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
1389 * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
1390 * \li Action: Show the completion popup at the cursor position.
1391 * \li Syntax: completion-popup
1392 * \li Origin: sts, Feb 19 2008
1395 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
1398 * \var lyx::FuncCode lyx::LFUN_COPY
1399 * \li Action: Copies the current selection to the clipboard.
1403 { LFUN_COPY, "copy", ReadOnly, Edit },
1406 * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
1407 * \li Action: Determine whether to keep cursor inside the editing window regardless
1408 of the scrollbar movement.
1409 * \li Syntax: toggle-cursor-follows-scrollbar
1410 * \li Origin: ARRae, 2 Dec 1997
1413 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
1416 * \var lyx::FuncCode lyx::LFUN_CUT
1417 * \li Action: Cuts to the clipboard.
1421 { LFUN_CUT, "cut", Noop, Edit },
1424 * \var lyx::FuncCode lyx::LFUN_DEBUG_LEVEL_SET
1425 * \li Action: Set debug output level.
1426 * \li Syntax: debug-level-set <LEVEL>
1427 * \li Params: <LEVEL>: comma separated list of levels or the correspondent number
1428 of their combination. 0 is equivalent to disabling all debug
1429 events. See lyx -dbg for the current list of debug levels
1431 * \li Origin: sanda, 28 Dec 2009
1434 { LFUN_DEBUG_LEVEL_SET, "debug-level-set", NoBuffer, System },
1438 * \var lyx::FuncCode lyx::LFUN_DEPTH_DECREMENT
1439 * \li Action: Decrease the nesting depth of the (selected) paragraph(s)
1441 * \li Syntax: depth-decrement
1444 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
1447 * \var lyx::FuncCode lyx::LFUN_DEPTH_INCREMENT
1448 * \li Action: Increase the nesting depth of the (selected) paragraph(s)
1450 * \li Syntax: depth-increment
1453 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
1457 * \var lyx::FuncCode lyx::LFUN_DEVEL_MODE_TOGGLE
1458 * \li Action: toggle a mode where more information is given in UI
1459 * \li Syntax: devel-mode-toggle
1460 * \li Notion: in so called "devel" mode, the information given in the
1461 * status bar is more precise, and the help documents are
1462 * open in editing mode.
1463 * \li Origin: lasgouttes, 23 Jul 2017
1466 { LFUN_DEVEL_MODE_TOGGLE, "devel-mode-toggle", NoBuffer, System },
1470 * \var lyx::FuncCode lyx::LFUN_DIALOG_DISCONNECT_INSET
1471 * \li Action: Closes opened connection to opened inset.
1472 * \li Notion: Connection is used for apply functions.
1473 * \li Syntax: dialog-disconnect-inset <INSET-NAME>
1474 * \li Origin: leeming, 25 Feb 2003
1477 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
1481 * \var lyx::FuncCode lyx::LFUN_DIALOG_HIDE
1482 * \li Action: Hides showed dialog. Counterpart to #LFUN_DIALOG_SHOW .
1483 * \li Syntax: dialog-hide <NAME>
1484 * \li Params: See #LFUN_DIALOG_SHOW .
1485 * \li Origin: leeming, 25 Feb 2003
1488 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
1491 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW
1492 * \li Action: Shows hidden dialog or creates new one for a given function/inset settings etc.
1493 * \li Syntax: dialog-show <NAME> [<DATA>]
1494 * \li Params: <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|\n
1495 compare|counter|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|\n
1496 graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimiter|\n
1497 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|\n
1498 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|\n
1499 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL> \n
1500 <SPECIAL>: latexlog|vclog \n
1501 <DATA>: data, usually settings for the given dialog. Use debug mode for the
1503 * \li Origin: leeming, 17 Jun 2003
1506 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
1509 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW_NEW_INSET
1510 * \li Action: Shows hidden dialog or create new one for a given inset settings etc.
1511 * \li Notion: Internally uses #LFUN_DIALOG_SHOW with processed data for a given inset.
1512 * \li Syntax: dialog-show-new-inset <NAME> [<DATA>]
1513 * \li Params: See #LFUN_DIALOG_SHOW .
1514 * \li Origin: leeming, 25 Feb 2003
1517 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
1520 * \var lyx::FuncCode lyx::LFUN_DIALOG_TOGGLE
1521 * \li Action: Toggles dialog between showed/hidden state.
1522 * \li Notion: Internally uses #LFUN_DIALOG_SHOW , #LFUN_DIALOG_HIDE .
1523 * \li Syntax: dialog-toggle <NAME> [<DATA>]
1524 * \li Params: See #LFUN_DIALOG_SHOW .
1525 * \li Origin: spitz, 30 Apr 2007
1528 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
1531 * \var lyx::FuncCode lyx::LFUN_DIALOG_UPDATE
1532 * \li Action: Updates the dialog values from the inset/paragraph/document.
1533 * \li Syntax: dialog-update <NAME>
1534 * \li Params: <NAME>: paragraph|prefs|<INSET> \n
1536 * \li Origin: leeming, 25 Feb 2003
1539 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
1542 * \var lyx::FuncCode lyx::LFUN_DOWN
1543 * \li Action: Moves the cursor one line in downward direction.
1547 { LFUN_DOWN, "down", ReadOnly | NoUpdate, Edit },
1550 * \var lyx::FuncCode lyx::LFUN_DOWN_SELECT
1551 * \li Action: Moves the cursor one line in downward direction adding the current
1552 position to the selection.
1553 * \li Syntax: down-select
1556 { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, Edit },
1559 * \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE
1560 * \li Action: Displays list of layout choices.
1561 * \li Notion: This LFUN opens the dropbox allowing for choice of layout.
1562 * \li Syntax: drop-layouts-choice
1565 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
1568 * \var lyx::FuncCode lyx::LFUN_ENVIRONMENT_SPLIT
1569 * \li Action: Splits the current environment with a Separator.
1570 * \li Syntax: environment-split [before|outer|previous]
1571 * \li Params: outer: If this is given, LyX will split the outermost environment in
1572 the current nesting hierarchy.\n
1573 previous: If this is given, LyX will split the environment in the previous
1574 paragraph (if there is one).\n
1575 before: If this is given, the new environment will be appended rather than
1577 * \li Origin: spitz, 23 Dec 2012
1580 { LFUN_ENVIRONMENT_SPLIT, "environment-split", Noop, Layout },
1584 * \var lyx::FuncCode lyx::LFUN_ERT_INSERT
1585 * \li Action: Inserts an ERT inset.
1586 * \li Syntax: ert-insert
1587 * \li Origin: Jug, 18 Feb 2000
1590 { LFUN_ERT_INSERT, "ert-insert", Noop, Edit },
1593 * \var lyx::FuncCode lyx::LFUN_ESCAPE
1594 * \li Action: Clears the selection. If no text is selected call #LFUN_FINISHED_FORWARD.
1595 Inside math mode jumps out of the math inset.
1596 * \li Syntax: escape
1597 * \li Origin: Lgb, 17 May 2001
1600 { LFUN_ESCAPE, "escape", ReadOnly, Edit },
1603 * \var lyx::FuncCode lyx::LFUN_EXPORT_CANCEL
1604 * \li Action: Cancel background export process.
1605 * \li Syntax: export-cancel
1606 * \li Origin: rgh, 10 December 2017
1609 { LFUN_EXPORT_CANCEL, "export-cancel", ReadOnly | NoUpdate | NoInternal, Edit },
1612 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
1613 * \li Action: Inserts another LyX file.
1614 * \li Syntax: file-insert [<FILE>] [ignorelang]
1615 * \li Params: <FILE>: Filename to be inserted.
1616 * ignorelang: If given, the (main) language of the inserted file
1617 * is ignored (the context language is used).
1620 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
1623 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
1624 * \li Action: Inserts plain text file.
1625 * \li Syntax: file-insert-plaintext [<FILE>]
1626 * \li Params: <FILE>: Filename to be inserted.
1627 * \li Origin: CFO-G, 19 Nov 1997
1630 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
1633 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
1634 * \li Action: Inserts plain text file as paragraph (i.e. join lines).
1635 * \li Syntax: file-insert-plaintext-para [<FILE>]
1636 * \li Params: <FILE>: Filename to be inserted.
1637 * \li Origin: Levon, 14 Feb 2001
1640 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
1643 * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
1644 * \li Action: Open LyX document.
1645 * \li Syntax: file-open [<FILE>]
1646 * \li Params: <FILE>: Filename to be opened.
1649 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
1653 * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
1654 * \li Action: Moves the cursor out of the current slice, going backwards.
1655 * \li Notion: See also #LFUN_FINISHED_FORWARD.
1658 { LFUN_FINISHED_BACKWARD, "", ReadOnly | NoUpdate, Hidden },
1661 * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
1662 * \li Action: Moves the cursor out of the current slice, going forward.
1663 * \li Notion: Cursor movement within an inset may be different than cursor
1664 movement in the surrounding text. This action should be called
1665 automatically by the cursor movement within the inset, when
1666 movement within the inset has ceased (reached the end of the
1667 last paragraph, for example), in order to move correctly
1668 back into the surrounding text.
1671 { LFUN_FINISHED_FORWARD, "", ReadOnly | NoUpdate, Hidden },
1674 * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
1675 * \li Action: Moves the cursor out of the current slice, going left.
1676 * \li Notion: See also #LFUN_FINISHED_FORWARD.
1679 { LFUN_FINISHED_LEFT, "", ReadOnly | NoUpdate, Hidden },
1683 * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
1684 * \li Action: Moves the cursor out of the current slice, going right.
1685 * \li Notion: See also #LFUN_FINISHED_FORWARD
1688 { LFUN_FINISHED_RIGHT, "", ReadOnly | NoUpdate, Hidden },
1691 * \var lyx::FuncCode lyx::LFUN_FLEX_INSERT
1692 * \li Action: Inserts CharStyle, Custom inset or XML short element.
1693 * \li Notion: Look into the Customization manual for more information about
1695 To make this command enabled the layout file for the document
1696 class you're using has to load the character styles. There are
1697 a few contained in the Logical Markup module. You can also of
1698 course create some yourself. \n
1699 For dissolving the element see #LFUN_INSET_DISSOLVE.
1700 * \li Syntax: flex-insert Name
1701 * \li Params: Name: This name must be defined either in your layout file
1702 or imported by some module. The definition is
1703 InsetLayout Name or InsetLayout <Flex:Name>. The Flex:
1705 * \li Sample: flex-insert Code
1708 { LFUN_FLEX_INSERT, "flex-insert", Noop, Edit },
1711 * \var lyx::FuncCode lyx::LFUN_FLOAT_INSERT
1712 * \li Action: Inserts a float inset.
1713 * \li Syntax: float-insert <TYPE>
1714 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
1715 "algorithm", "table", "figure" parameters can be given.
1716 * \li Origin: Lgb, 27 Jun 2000
1719 { LFUN_FLOAT_INSERT, "float-insert", Noop, Edit },
1722 * \var lyx::FuncCode lyx::LFUN_FLOAT_LIST_INSERT
1723 * \li Action: Inserts the list of floats in the document.
1724 * \li Syntax: float-list-insert <TYPE>
1725 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
1726 "algorithm", "table", "figure" parameters can be given.
1727 * \li Origin: Lgb, 3 May 2001
1730 { LFUN_FLOAT_LIST_INSERT, "float-list-insert", Noop, Edit },
1733 * \var lyx::FuncCode lyx::LFUN_FLOAT_WIDE_INSERT
1734 * \li Action: Inserts float insets as in #LFUN_FLOAT_INSERT but span multiple columns.
1735 * \li Notion: Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
1736 * \li Syntax: float-wide-insert <TYPE>
1737 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
1738 "algorithm", "table", "figure" parameters can be given.
1739 * \li Origin: Lgb, 31 Oct 2001
1742 { LFUN_FLOAT_WIDE_INSERT, "float-wide-insert", Noop, Edit },
1745 * \var lyx::FuncCode lyx::LFUN_FONT_BOLD
1746 * \li Action: Toggles the bold font (selection-wise) using mathbf in math.
1747 * \li Syntax: font-bold
1750 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
1754 * \var lyx::FuncCode lyx::LFUN_FONT_BOLDSYMBOL
1755 * \li Action: Toggles the bold font (selection-wise) using boldsymbol in math.
1756 * \li Syntax: font-boldsymbol
1759 { LFUN_FONT_BOLDSYMBOL, "font-boldsymbol", Noop, Layout },
1762 * \var lyx::FuncCode lyx::LFUN_FONT_DEFAULT
1763 * \li Action: Reverts the settings of the font to the default values (selection-wise).
1764 * \li Syntax: font-default
1767 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
1770 * \var lyx::FuncCode lyx::LFUN_FONT_EMPH
1771 * \li Action: Toggles the emphasis font style (selection-wise).
1772 * \li Syntax: font-emph
1775 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
1778 * \var lyx::FuncCode lyx::LFUN_FONT_FRAK
1779 * \li Action: Toggles Fraktur family font (math-mode, selection-wise).
1780 * \li Syntax: font-frak
1781 * \li Origin: vermeer, 10 Jan 2002
1784 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
1787 * \var lyx::FuncCode lyx::LFUN_FONT_ITAL
1788 * \li Action: Toggles Italics font shape (math-mode, selection-wise).
1789 * \li Syntax: font-ital
1790 * \li Origin: vermeer, 10 Jan 2002
1793 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
1796 * \var lyx::FuncCode lyx::LFUN_FONT_NOUN
1797 * \li Action: Toggles Noun text style font (selection-wise).
1798 * \li Syntax: font-noun
1801 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
1804 * \var lyx::FuncCode lyx::LFUN_FONT_ROMAN
1805 * \li Action: Toggles Roman family font (selection-wise).
1806 * \li Syntax: font-roman
1809 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
1812 * \var lyx::FuncCode lyx::LFUN_FONT_SANS
1813 * \li Action: Toggles Sans Serif family font (selection-wise).
1814 * \li Syntax: font-sans
1817 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
1820 * \var lyx::FuncCode lyx::LFUN_FONT_SIZE
1821 * \li Action: Sets font size according to lyx format string.
1822 * \li Syntax: font-size <SIZE>
1823 * \li Params: <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|\n
1824 largest|huge|giant|increase|decrease|default
1827 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
1830 * \var lyx::FuncCode lyx::LFUN_FONT_STATE
1831 * \li Action: Returns the info about the current font.
1832 * \li Syntax: font-state
1835 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
1839 * \var lyx::FuncCode lyx::LFUN_FONT_STRIKEOUT
1840 * \li Action: Toggles strikeout (strike-through) in the font (selection-wise).
1841 * \li Syntax: font-strikeout
1842 * \li Origin: sanda, 3 May 2009
1845 { LFUN_FONT_STRIKEOUT, "font-strikeout", Noop, Layout },
1848 * \var lyx::FuncCode lyx::LFUN_FONT_CROSSOUT
1849 * \li Action: Toggles xout (cross-through) in the font (selection-wise).
1850 * \li Syntax: font-crossout
1851 * \li Origin: uwestoehr, 4 April 2017
1854 { LFUN_FONT_CROSSOUT, "font-crossout", Noop, Layout },
1857 * \var lyx::FuncCode lyx::LFUN_FONT_NO_SPELLCHECK
1858 * \li Action: Toggles nospellcheck status in the font (selection-wise).
1859 * \li Syntax: font-nospellcheck
1860 * \li Origin: spitz, 5 March 2021
1863 { LFUN_FONT_NO_SPELLCHECK, "font-nospellcheck", Noop, Layout },
1866 * \var lyx::FuncCode lyx::LFUN_FONT_TYPEWRITER
1867 * \li Action: Toggles the typewriter family font (selection-wise).
1868 * \li Syntax: font-typewriter
1871 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
1874 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERLINE
1875 * \li Action: Toggles underline in the font (selection-wise).
1876 * \li Syntax: font-underline
1879 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
1882 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERUNDERLINE
1883 * \li Action: Toggles double underline in the font (selection-wise).
1884 * \li Syntax: font-underunderline
1885 * \li Origin: sanda, 5 May 2009
1888 { LFUN_FONT_UNDERUNDERLINE, "font-underunderline", Noop, Layout },
1891 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERWAVE
1892 * \li Action: Toggles wavy underline in the font (selection-wise).
1893 * \li Syntax: font-underwave
1894 * \li Origin: sanda, 5 May 2009
1897 { LFUN_FONT_UNDERWAVE, "font-underwave", Noop, Layout },
1900 * \var lyx::FuncCode lyx::LFUN_FOOTNOTE_INSERT
1901 * \li Action: Inserts a footnote inset.
1902 * \li Syntax: footnote-insert
1903 * \li Origin: Jug, 7 Mar 2000
1906 { LFUN_FOOTNOTE_INSERT, "footnote-insert", Noop, Edit },
1909 * \var lyx::FuncCode lyx::LFUN_FORWARD_SEARCH
1910 * \li Action: Sets the cursor position in the previewed (dvi/pdf) file based on the row
1911 number in LyX window.
1912 * \li Notion: The external program used for forward search call can be specified in
1913 LyX Output preferences. See Additional manual for details of these
1915 * \li Syntax: forward-search
1916 * \li Origin: sanda, 14 Apr 2010
1919 { LFUN_FORWARD_SEARCH, "forward-search", ReadOnly, System },
1922 * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
1923 * \li Action: Open the given help file according to the language setting.
1924 * \li Syntax: help-open <FILE>[.lyx]
1925 * \li Params: <FILE>: any document from (/usr/share/)doc directory.
1926 * \li Origin: Jug, 27 Jun 1999
1929 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
1932 * \var lyx::FuncCode lyx::LFUN_LYXFILES_OPEN
1933 * \li Action: Open lyxfiles (templates/examples). Create a view if he have none.
1934 * \li Syntax: lyxfiles-open [<TYPE>]
1935 * \li Params: <TYPE>: templates or examples. Default is templates.
1936 * \li Origin: spitz, 10 Feb 2021
1939 { LFUN_LYXFILES_OPEN, "lyxfiles-open", NoBuffer | Argument, Buffer },
1942 * \var lyx::FuncCode lyx::LFUN_HREF_INSERT
1943 * \li Action: Inserts hyperlinks into the document (clickable in pdf output).
1944 * \li Notion: Hyperlink target can be set via selection + hyperlink-insert function.
1945 * \li Syntax: href-insert [<TARGET>]
1946 * \li Origin: CFO-G, 21 Nov 1997
1949 { LFUN_HREF_INSERT, "href-insert", Noop, Edit },
1952 * \var lyx::FuncCode lyx::LFUN_ICON_SIZE
1953 * \li Action: Sets icon size of toolbars.
1954 * \li Syntax: icon-size [<SIZE>]
1955 * \li Params: <SIZE> : the icon size in px or one of the logical settings
1956 small|normal|big|huge|giant, the default is normal
1957 (whose size in px is icon set dependent).
1958 * \li Origin: 11 July 2016
1961 { LFUN_ICON_SIZE, "icon-size", NoBuffer, Buffer },
1965 * \var lyx::FuncCode lyx::LFUN_IF_RELATIVES
1966 * \li Action: Helper function for master-related actions
1967 * \li Notion: In a buffer, the function will be disabled if the buffer
1968 * has no master or children. It thus allows to enable
1969 * actions only in documents with master/children
1970 * \li Syntax: ifrelatives <ACTION>
1971 * \li Origin: spitz, 2 January 2020
1974 { LFUN_IF_RELATIVES, "ifrelatives", Noop, Buffer },
1977 * \var lyx::FuncCode lyx::LFUN_INDEX_INSERT
1978 * \li Action: Inserts Index entry.
1979 * \li Notion: It automatically takes the word on the cursor position.
1980 * \li Syntax: index-insert [<TYPE:Name>]
1981 * \li Params: <TYPE:Name>: name of the index, if multiple indices are defined.
1982 With an empty argument, the default index is selected.
1983 * \li Origin: leeming, 3 Aug 2000
1986 { LFUN_INDEX_INSERT, "index-insert", Noop, Edit },
1989 * \var lyx::FuncCode lyx::LFUN_INDEX_TAG_ALL
1990 * \li Action: Tags all occurrences of the word before the cursor with the
1991 * index inset at cursor.
1992 * \li Notion: It automatically takes the word on the cursor position.
1993 * \li Syntax: index-tag-all
1994 * \li Origin: spitz, 5 Nov 2022
1997 { LFUN_INDEX_TAG_ALL, "index-tag-all", AtPoint, Edit },
2000 * \var lyx::FuncCode lyx::LFUN_INDEX_PRINT
2001 * \li Action: Inserts list of Index entries on a new page.
2002 * \li Syntax: index-print [<TYPE:Name>]
2003 * \li Params: <TYPE:Name>: name of the index, if multiple indices are defined.
2004 With an empty argument, the default index is selected.
2005 * \li Origin: Lgb, 27 Feb 1997
2008 { LFUN_INDEX_PRINT, "index-print", Noop, Edit },
2011 * \var lyx::FuncCode lyx::LFUN_INFO_INSERT
2012 * \li Action: Displays shortcuts, lyxrc, package and textclass availability and menu
2013 information in a non-editable boxed InsetText.
2014 * \li Notion: Apart from lfun arguments you can use the following method: \n
2015 1. input the type and argument of this inset, e.g. "menu paste", in
2017 2. select the text and run info-insert lfun.
2018 * \li Syntax: info-insert <TYPE> <ARG>
2019 * \li Params: <TYPE>: date|moddate|fixdate|time|modtime|fixtime|shortcut|shortcuts|lyxrc|
2020 * lyxinfo|package|textclass|menu|l7n|icon|buffer|vcs \n
2021 <ARG>: argument for a given type. Look into InsetInfo.h for detailed
2023 date: current date (formatted and localized)\n
2024 moddate: date of last modification (saving) (formatted and localized)\n
2025 fixdate: a static date (formatted and localized)\n
2026 time: current time (formatted and localized)\n
2027 modtime: time of last modification (saving) (formatted and localized)\n
2028 fixtime: a static time (formatted and localized)\n
2029 shortcut[s]: name of lfun (e.g math-insert \alpha) \n
2030 lyxrc: name of rc_entry (e.g. bind_file) \n
2031 lyxinfo: "version" - used version of LyX \n
2032 package: name of latex package (e.g. listings) \n
2033 textclass: name of textclass (e.g. article) \n
2034 menu: name of lfun used in menu \n
2035 l7n: localizable string.\n
2036 icon: icon of lfun used in toolbar or direct icon name\n
2037 buffer: "name"|"name-noext"|"path"|"class"
2038 vcs: "tree-revision"|"revision"|"author"|"date"|"time"
2039 * \li Sample: command-sequence info-insert buffer path; info-insert buffer name
2040 * \li Origin: bpeng, 7 Oct 2007
2043 { LFUN_INFO_INSERT, "info-insert", Noop, Edit },
2046 * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
2047 * \li Action: Apply data for an inset.
2048 * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
2049 be applied. This is either changed to #LFUN_INSET_MODIFY or
2050 #LFUN_INSET_INSERT depending on the context where it is called.
2051 * \li Syntax: inset-apply <ARGS>
2052 * \li Params: See #LFUN_INSET_INSERT .
2055 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
2058 * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN
2059 * \li Action: Move the cursor to the beginning of the current inset
2060 if it is not already there. If the cursor is already at
2061 the beginning of the current inset, move it to the
2062 beginning of the enclosing inset or the main work area,
2063 respectively, if there is no enclosing inset.
2064 * \li Syntax: inset-begin
2065 * \li Origin: lasgouttes, 16 Mar 2009
2068 { LFUN_INSET_BEGIN, "inset-begin", ReadOnly, Edit },
2071 * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN_SELECT
2072 * \li Action: Move the cursor to the beginning of the current inset
2073 if it is not already there. If the cursor is already at
2074 the beginning of the current inset, move it to the
2075 beginning of the enclosing inset or the main work area,
2076 respectively, if there is no enclosing inset (adding the
2077 traversed text to the selection).
2078 * \li Syntax: inset-begin-select
2079 * \li Origin: lasgouttes, 16 Mar 2009
2082 { LFUN_INSET_BEGIN_SELECT, "inset-begin-select", ReadOnly, Edit },
2085 * \var lyx::FuncCode lyx::LFUN_INSET_COPY_AS
2086 * \li Action: Copies the inset to the clipboard as a certain type.
2087 * \li Notion: Currently used only for InsetInfo where its content is copied as a text.
2088 * \li Syntax: inset-copy-as
2089 * \li Origin: vfr, 18 Apr 2010
2092 { LFUN_INSET_COPY_AS, "inset-copy-as", ReadOnly | NoUpdate | AtPoint, Edit },
2095 * \var lyx::FuncCode lyx::LFUN_INSET_INSERT_COPY
2096 * \li Action: Inserts the inset's content (in ToC pane) at the position of the cursor.
2097 * \li Syntax: inset-insert-copy
2098 * \li Origin: spitz, 1 Nov 2022
2101 { LFUN_INSET_INSERT_COPY, "inset-insert-copy", Noop, Edit},
2104 * \var lyx::FuncCode lyx::LFUN_INSET_DIALOG_UPDATE
2105 * \li Action: Updates the values inside the dialog from the inset.
2106 * \li Notion: This is an internal LFUN, not to be used by users. Called internally
2107 by #LFUN_DIALOG_UPDATE
2108 * \li Params: <DIALOG-NAME>
2109 * \li Origin: leeming, 25 Feb 2003
2112 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
2115 * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE
2116 * \li Action: Dissolve the current inset into text.
2117 * \li Syntax: inset-dissolve [<INSET>]
2118 * \li Params: <INSET>: this can be used to make sure the right kind of inset
2119 is dissolved. For example "dissolve" entry in the charstyles
2120 sub-menu should only dissolve the charstyle inset, even if the
2121 cursor is inside several nested insets of different type.\n
2122 For values see #lyx::InsetLayout::lyxtype_ .
2123 * \li Origin: JSpitz, 7 Aug 2006
2126 { LFUN_INSET_DISSOLVE, "inset-dissolve", AtPoint, Edit },
2129 * \var lyx::FuncCode lyx::LFUN_INSET_EDIT
2130 * \li Action: Edit the inset at cursor with an external application,
2131 if one is attributed.
2132 If the inset is file based, the referenced file is edited.
2133 Otherwise, the inset contents is written to a temporary file,
2134 the inset is locked, and the temporary file is edited.
2135 In this case, #LFUN_INSET_END_EDIT must be called to overtake
2136 the changes and unlock the inset after editing is finished.
2137 * \li Syntax: inset-edit [nogui] [<INSET_PARAMS>]
2138 * \li Params: <INSET_PARAMS>: Parameters for the inset. \n
2139 Currently only the filename will be considered.\n
2140 nogui: does not launch external editor, only returns filename
2142 * \li Origin: spitz, 27 Apr 2006
2145 { LFUN_INSET_EDIT, "inset-edit", ReadOnly | AtPoint, Edit },
2149 * \var lyx::FuncCode lyx::LFUN_INSET_END_EDIT
2150 * \li Action: End editing the inset at cursor with an external application.
2151 * This replaces the inset contents with the contents of the
2152 * temporary file, deletes the file and unlocks the inset.
2153 * \li Syntax: inset-end-edit
2154 * \li Origin: gb, 11 Oct 2015
2157 { LFUN_INSET_END_EDIT, "inset-end-edit", ReadOnly | AtPoint, Edit },
2160 * \var lyx::FuncCode lyx::LFUN_INSET_END
2161 * \li Action: Move the cursor to the end of the current inset if it
2162 is not already there. If the cursor is already at the
2163 end of the current inset, move it to the end of the
2164 enclosing inset or the main work area, respectively, if
2165 there is no enclosing inset.
2166 * \li Syntax: inset-end
2167 * \li Origin: lasgouttes, 16 Mar 2009
2170 { LFUN_INSET_END, "inset-end", ReadOnly, Edit },
2173 * \var lyx::FuncCode lyx::LFUN_INSET_END_SELECT
2174 * \li Action: Move the cursor to the end of the current inset if it
2175 is not already there. If the cursor is already at the
2176 end of the current inset, move it to the end of the
2177 enclosing inset or the main work area, respectively, if
2178 there is no enclosing inset (adding the
2179 traversed text to the selection).
2180 * \li Syntax: inset-end-select
2181 * \li Origin: lasgouttes, 16 Mar 2009
2184 { LFUN_INSET_END_SELECT, "inset-end-select", ReadOnly, Edit },
2188 * \var lyx::FuncCode lyx::LFUN_INSET_FORALL
2189 * \li Action: Apply the given commands on insets of a given name.
2190 * \li Notion: WARNING: use at your own risks; this function gives
2191 you too many ways of shooting yourself in the foot.
2192 A typical example is
2193 inset-forall Note note-insert
2194 which starts an infinite loop. This is mitigated by the fact
2195 that the number of actions is arbitrarily limited to 100000.
2196 Note also that inset-forall does not update metrics between
2197 iterations, which can lead to bugs. This has to be eventually
2199 * \li Syntax: inset-forall <NAME> <LFUN-COMMAND> \n
2200 <NAME>: Type of Inset. If <NAME> is *, all insets are matched.
2201 The name is used like for InsetLayout in layout files: "Note"
2202 matches all note insets, while "Note:Note" only matches LyX
2204 * \li Sample: Remove all index insets: \n
2205 inset-forall Index char-delete-forward \n
2207 inset-forall Note inset-toggle close \n
2208 Open all branch insets of branch "myBranch": \n
2209 inset-forall Branch:myBranch inset-toggle open \n
2210 Transform all yellow notes to comments \n
2211 inset-forall Note:Note inset-modify note Note Comment \n
2212 Try to put LyX in an infinite loop if there is at least a Note: \n
2213 inset-forall Note char-backward
2214 * \li Origin: lasgouttes, 27 Nov 2009
2217 { LFUN_INSET_FORALL, "inset-forall", ReadOnly, Edit },
2221 * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
2222 * \li Action: Insert new inset (type given by the parameters).
2223 * \li Syntax: inset-insert <INSET> <ARGS>
2224 * \li Params: <INSET>: <bibitem|bibtex|citation|ert|listings|external|graphics|tabular|\n
2225 hyperlink|include|index|label|line|nomencl|vspace|ref|toc|script>\n
2226 <ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
2227 * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
2228 where <label name> is the name of the referenced label and
2229 <Format> is one of the following: \n
2230 ref -- <reference> \n
2231 eqref -- (<reference>) \n
2232 pageref -- <page> \n
2233 vpageref -- on <page> \n
2234 vref -- <reference> on <page> \n
2235 formatted -- Formatted reference
2238 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
2241 * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
2242 * \li Action: Modify some properties of an inset.
2243 * \li Notion: Used for argument, bibitem, bibtex, box, branch, caption, citation,
2244 command, ert, external, float, graphics, include, index,
2245 info, label, line, listings, newline, newpage, nomencl,
2246 note, phantom, quotes, ref, script, separator, space,
2247 tabular, vspace and wrap insets.
2248 * \li Syntax: inset-modify <INSET> <ARGS> \n
2249 inset-modify changetype <TYPE>
2250 * \li Sample: Change a Note inset into a Comment inset: \n
2251 inset-modify note Note Comment \n
2252 Change a Box into an Ovalbox: \n
2253 inset-modify changetype Ovalbox \n
2254 Change a quotation mark to e[nglish style], l[eft side = opening], s[ingle = inner, secondary] \n
2255 inset-modify changetype els \n
2256 Change only the style of a quotation mark, maintaining the other aspects (. = wildcard) \n
2257 inset-modify changetype e.. \n
2260 { LFUN_INSET_MODIFY, "inset-modify", AtPoint, Edit },
2263 * \var lyx::FuncCode lyx::LFUN_INSET_SELECT_ALL
2264 * \li Action: Select all contents of an inset.
2265 * \li Notion: There are 3 successive levels: select current cell,
2266 * select all cells of inset, select the inset from outside
2267 * (in the enclosing inset).
2268 * \li Syntax: inset-select-all
2269 * \li Origin: vfr, 22 Aug 2009; lasgouttes 1 Nov 2014
2272 { LFUN_INSET_SELECT_ALL, "inset-select-all", ReadOnly, Edit },
2276 * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
2277 * \li Action: Open the inset's properties dialog.
2278 * \li Notion: Used for bibitem, bibtex, box, branch, citation, ert, external,
2279 float, graphics, href, include, index, index_print, label, line,
2280 listings, note, phantom, ref, space, tabular, vspace, wrap insets.
2281 * \li Syntax: inset-settings <INSET>
2282 * \li Params: <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|\n
2283 graphics|href|include|index|index_print|label|line|\n
2284 listings|note|phantom|ref|space|tabular|vspace|wrap>.
2287 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly | AtPoint, Edit },
2290 * \var lyx::FuncCode lyx::LFUN_INSET_SPLIT
2291 * \li Action: Splits the current inset into two at current position.
2292 * \li Syntax: inset-split [<INSET>]
2293 * \li Params: <INSET>: this can be used to make sure the right kind of inset
2294 is dissolved. For example "split" entry in the charstyles
2295 sub-menu should only dissolve the charstyle inset, even if the
2296 cursor is inside several nested insets of different type.\n
2297 For values see #lyx::InsetLayout::lyxtype_ .
2298 * \li Origin: spitz, 22 Dec 2020
2301 { LFUN_INSET_SPLIT, "inset-split", Noop, Edit },
2304 * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
2305 * \li Action: Toggles the collapsible inset at cursor position,
2306 or the inset we are currently in.
2307 * \li Syntax: inset-toggle [<ARG>]
2308 * \li Params: <ARG>: <open|close|toggle|assign>. \n
2309 open/close/toggle are for collapsible insets. toggle is used when no argument is given.\n
2310 assign synchronize the branch-inset with activation status of the branch.
2311 Used for global toggling when changed activation.
2312 * \li Origin: lasgouttes, 19 Jul 2001
2315 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly | AtPoint, Edit },
2318 * \var lyx::FuncCode lyx::LFUN_IN_IPA
2319 * \li Action: Only active in IPA inset.
2320 * \li Notion: Dummy function which is only active in a IPA inset.
2321 It's used to toggle the IPA toolbar if the cursor moves
2323 * \li Syntax: in-ipa
2324 * \li Origin: spitz, 20 May 2012
2327 { LFUN_IN_IPA, "in-ipa", Noop, Edit },
2330 * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
2331 * \li Action: Only active in Math Macro definition.
2332 * \li Notion: Dummy function which is only active in a Math Macro definition.
2333 It's used to toggle the Math Macro toolbar if the cursor moves
2334 into a Math Macro definition.
2335 * \li Syntax: in-mathmacrotemplate
2336 * \li Origin: sts, 06 January 2008
2339 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
2342 * \var lyx::FuncCode lyx::LFUN_INDEXMACRO_INSERT
2343 * \li Action: Inserts special Index macros into the document.
2344 * \li Syntax: indexmacro-insert <type>
2345 * \li Params: <type>: see, seealso, subentry, sortkey.
2346 * \li Origin: spitz, 20 Feb 2022
2349 { LFUN_INDEXMACRO_INSERT, "indexmacro-insert", Noop, Edit },
2353 * \var lyx::FuncCode lyx::LFUN_IPAMACRO_INSERT
2354 * \li Action: Inserts special IPA macros into the document.
2355 * \li Syntax: ipamacro-insert <CHAR>
2356 * \li Params: <CHAR>: tone-falling, tone-rising, tone-high-rising, tone-low-rising,
2357 * tone-high-rising-falling, deco bottomtiebar, deco toptiebar.
2358 * \li Origin: spitz, 22 Aug 2012
2361 { LFUN_IPAMACRO_INSERT, "ipamacro-insert", Noop, Edit },
2364 * \var lyx::FuncCode lyx::LFUN_IPA_INSERT
2365 * \li Action: Inserts an IPA inset.
2366 * \li Syntax: ipa-insert
2367 * \li Origin: spitz, 05 Mar 2012
2370 { LFUN_IPA_INSERT, "ipa-insert", Noop, Edit },
2373 * \var lyx::FuncCode lyx::LFUN_KEYMAP_OFF
2374 * \li Action: Turn off the loaded keyboard map.
2375 * \li Syntax: keymap-off
2378 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
2381 * \var lyx::FuncCode lyx::LFUN_KEYMAP_PRIMARY
2382 * \li Action: Turn on the primary keyboard map.
2383 * \li Notion: Maps were widely used in past, when X-windows didn't have nowadays
2384 keyboard support. They can be still used to maintain uniform keyboard
2385 layout across the various platforms.\n
2386 The language is to be set in the Preferences dialog.
2387 * \li Syntax: keymap-primary
2390 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
2393 * \var lyx::FuncCode lyx::LFUN_KEYMAP_SECONDARY
2394 * \li Action: Turn on the secondary keyboard map.
2395 * \li Syntax: keymap-secondary
2398 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
2401 * \var lyx::FuncCode lyx::LFUN_KEYMAP_TOGGLE
2402 * \li Action: Toggles keyboard maps (first/second/off).
2403 * \li Syntax: keymap-toggle
2404 * \li Origin: leeming, 30 Mar 2004
2407 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
2411 * \var lyx::FuncCode lyx::LFUN_LABEL_COPY_AS_REFERENCE
2412 * \li Action: Copies the label at the cursor as a cross-reference to be pasted elsewhere.
2413 * \li Syntax: copy-label-as-reference <LABEL>
2414 * \li Params: <LABEL>: The label to copy (for multi-line math)
2415 * \li Origin: sts, 16 Nov 2008
2418 { LFUN_LABEL_COPY_AS_REFERENCE, "label-copy-as-reference",
2419 ReadOnly | NoUpdate | AtPoint, Edit },
2423 * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
2424 * \li Action: Goto a label.
2425 * \li Syntax: label-goto [<LABEL>]
2426 * \li Params: <LABEL>: Requested label. If no label is given and reference
2427 is on cursor position, Bookmark 0 is saved and
2428 cursor moves to the position of referenced label.
2429 * \li Origin: Ale, 6 Aug 1997
2432 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
2435 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT
2436 * \li Action: Inserts label to text or displayed formula.
2437 * \li Syntax: label-insert [<LABEL>]
2438 * \li Params: <LABEL>: Requested label. If no label is given dialog requesting
2439 name will be opened.
2442 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
2445 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT_AS_REFERENCE
2446 * \li Action: Inserts the label (in ToC pane) as a cross-reference at the position of the cursor.
2447 * \li Syntax: label-insert-as-reference
2448 * \li Origin: vfr, 7 Apr 2009
2451 { LFUN_LABEL_INSERT_AS_REFERENCE, "label-insert-as-reference", Noop, Edit},
2455 * \var lyx::FuncCode lyx::LFUN_LANGUAGE
2456 * \li Action: Set language from the current cursor position.
2457 * \li Syntax: language <LANG> [set]
2458 * \li Params: <LANG>: Requested language. Look in lib/languages for
2459 the list. "language reset" or "language" (without param)
2460 reset to the document language.
2461 set: If used, the language will be set to the specified
2462 language. Otherwise, the language will be toggled (i.e., if
2463 the current language is LANG, switch to the document language
2464 or the default language, if LANG is the document language).
2465 * \li Origin: Dekel, 2 Mar 2000
2468 { LFUN_LANGUAGE, "language", Noop, Edit },
2472 * \var lyx::FuncCode lyx::LFUN_LAYOUT
2473 * \li Action: Sets the layout (that is, environment) for the current paragraph.
2474 * \li Syntax: layout <LAYOUT> [ignoreautonests]
2475 * \li Params: <LAYOUT>: the layout to use\n
2476 ignoreautonests: If specified, nesting advices will be ignored.
2479 { LFUN_LAYOUT, "layout", Noop, Layout },
2482 * \var lyx::FuncCode lyx::LFUN_LAYOUT_TOGGLE
2483 * \li Action: Toggles the layout (that is, environment) for the current paragraph.
2484 * \li Notion: Contrary to `layout', this function resets the current
2485 * (or selection) layout to the standard layout it already has the
2486 * correct layout. Useful for toolbar icons.
2487 * \li Syntax: layout-toggle <LAYOUT> [ignoreautonests]
2488 * \li Params: <LAYOUT>: the layout to toggle\n
2489 ignoreautonests: If specified, nesting advices will be ignored.
2490 * \li Origin: lasgouttes, 14 May 2018
2493 { LFUN_LAYOUT_TOGGLE, "layout-toggle", Noop, Layout },
2496 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
2497 * \li Action: Clears the module list.
2498 * \li Notion: Clears the list of included modules for the current buffer.
2499 * \li Syntax: layout-modules-clear
2500 * \li Origin: rgh, 25 August 2007
2503 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", NoInternal, Layout },
2506 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULE_ADD
2507 * \li Action: Adds a module.
2508 * \li Notion: Adds a module to the list of included modules for the current buffer.
2509 * \li Syntax: layout-module-add <MODULE>
2510 * \li Params: <MODULE>: the module to be added
2511 * \li Origin: rgh, 25 August 2007
2514 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", NoInternal, Layout },
2517 * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH
2518 * \li Action: Launches the paragraph settings dialog.
2519 * \li Syntax: layout-paragraph
2522 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
2525 * \var lyx::FuncCode lyx::LFUN_LAYOUT_RELOAD
2526 * \li Action: Reloads layout information.
2527 * \li Notion: Reloads all layout information for the current buffer from disk, thus
2528 recognizing any changes that have been made to layout files on the fly.
2529 This is intended to be used only by layout developers and should not be
2530 used when one is trying to do actual work.
2531 * \li Syntax: layout-reload
2532 * \li Origin: rgh, 3 September 2007
2535 { LFUN_LAYOUT_RELOAD, "layout-reload", NoInternal, Layout },
2538 * \var lyx::FuncCode lyx::LFUN_LAYOUT_TABULAR
2539 * \li Action: Launches the tabular settings dialog.
2540 * \li Syntax: layout-tabular
2541 * \li Origin: Jug, 31 Jul 2000
2544 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
2547 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN
2548 * \li Action: Move the cursor to the beginning of the (screen) line.
2549 * \li Syntax: line-begin
2552 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
2555 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN_SELECT
2556 * \li Action: Move the cursor to the beginning of the (screen) line adding the
2557 traversed text to the selection.
2558 * \li Syntax: line-begin-select
2561 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
2564 * \var lyx::FuncCode lyx::LFUN_LINE_DELETE_FORWARD
2565 * \li Action: Deletes the letters to the end of the (screen) line or
2566 deletes the selection.
2567 * \li Syntax: line-delete-forward
2570 { LFUN_LINE_DELETE_FORWARD, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
2573 * \var lyx::FuncCode lyx::LFUN_LINE_END
2574 * \li Action: Move the cursor to the end of the (screen) line.
2575 * \li Syntax: line-end
2578 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
2581 * \var lyx::FuncCode lyx::LFUN_LINE_END_SELECT
2582 * \li Action: Move the cursor to the end of the (screen) line adding the
2583 traversed text to the selection.
2584 * \li Syntax: line-end-select
2587 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
2590 * \var lyx::FuncCode lyx::LFUN_LISTING_INSERT
2591 * \li Action: Inserts a new listings inset.
2592 * \li Syntax: listing-insert
2593 * \li Origin: Herbert, 10 Nov 2001; bpeng, 2 May 2007
2596 { LFUN_LISTING_INSERT, "listing-insert", Noop, Edit },
2599 * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
2600 * \li Action: Apply the given settings to user preferences.
2601 * \li Syntax: lyxrc-apply <SETTINGS>
2602 * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
2603 to get an idea which commands to use and their syntax.
2604 #lyx::LyXRC::LyXRCTags has the list of possible commands.
2607 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
2610 * \var lyx::FuncCode lyx::LFUN_LYX_ACTIVATE
2611 * \li Action: Activates the LyX window.
2612 * \li Notion: On Linux and Mac OS, this action brings the LyX window
2613 into focus. Such behavior is not allowed by Windows OS
2614 so instead the color of the taskbar entry is changed to
2615 indicate that the window has changed in some way.
2616 This action is useful in combination with reverse search.
2617 * \li Syntax: lyx-activate
2618 * \li Origin: skostysh, 4 Aug 2016
2621 { LFUN_LYX_ACTIVATE, "lyx-activate", ReadOnly | NoBuffer, Hidden },
2624 * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
2625 * \li Action: Terminates the current LyX instance.
2626 * \li Notion: Terminates the current LyX instance, asking whether to save
2627 modified documents, etc.
2628 * \li Syntax: lyx-quit
2631 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
2634 * \var lyx::FuncCode lyx::LFUN_MARGINALNOTE_INSERT
2635 * \li Action: Inserts a marginal note.
2636 * \li Syntax: marginalnote-insert
2637 * \li Origin: Lgb, 26 Jun 2000
2640 { LFUN_MARGINALNOTE_INSERT, "marginalnote-insert", Noop, Edit },
2643 * \var lyx::FuncCode lyx::LFUN_MARK_OFF
2644 * \li Action: Disable selecting of text-region.
2645 * \li Syntax: mark-off
2648 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
2651 * \var lyx::FuncCode lyx::LFUN_MARK_ON
2652 * \li Action: Enable selecting of text-region.
2653 * \li Notion: After enabling you can simply move arrow keys to get selected region.
2654 * \li Syntax: mark-on
2657 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
2660 * \var lyx::FuncCode lyx::LFUN_MARK_TOGGLE
2661 * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
2662 * \li Syntax: mark-toggle
2663 * \li Origin: Andre, May 5 2006
2666 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
2670 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_EXPORT
2671 * \li Action: Exports the master buffer (document) to the given format.
2672 * \li Syntax: master-buffer-export [<FORMAT>] [<DEST>]
2673 * \li Params: <FORMAT> is one of the formats which you can find in
2674 Tools->Preferences->File formats->Format.
2675 Usual format you will enter is "pdf2" (pdflatex),
2676 "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
2677 Note that "custom" is not allowed in this case.\n
2678 If absent or "default", then the default output format of the
2680 <DEST> If present, this argument provides the export destination
2681 filename. Its containing folder will also be the destination
2682 folder, where all the needed external files will be copied.
2683 * \li Origin: rkh, 18 April 2018
2686 { LFUN_MASTER_BUFFER_EXPORT, "master-buffer-export", ReadOnly, Buffer },
2689 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_FORALL
2690 * \li Action: Applies a command to a buffer and all it children, starting from the master.
2691 * \li Syntax: master-buffer-forall <LFUN-COMMAND>
2692 * \li Params: <LFUN-COMMAND>: The command to be applied to the buffers.
2693 * \li Sample: Close all Notes in buffers: \n
2694 master-buffer-forall inset-forall Note inset-toggle close \n
2695 Toggle change tracking on buffers: \n
2696 master-buffer-forall changes-track \n
2697 Toggle read-only for buffers: \n
2698 master-buffer-forall buffer-toggle-read-only \n
2699 Show statistics for individual buffers: \n
2700 master-buffer-forall statistics \n
2701 Activate the branch named "Solutions" in buffers: \n
2702 master-buffer-forall branch-activate Solutions \n
2703 * \li Origin: spitz, 31 Dec 2019
2706 { LFUN_MASTER_BUFFER_FORALL, "master-buffer-forall", ReadOnly | Argument, Buffer },
2709 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
2710 * \li Action: Update (export) the document built from the master buffer,
2711 if the current buffer is part of a master/child document.
2712 * \li Syntax: master-buffer-update [<FORMAT>]
2713 * \li Params: <FORMAT>: The format to display, where this is one of the
2714 formats defined (in the current GUI) in the
2715 Tools>Preferences>File Formats dialog.
2716 If no format is given, the default format as
2717 specified in the same dialog is used.
2718 * \li Origin: Tommaso, 20 Sep 2007
2721 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
2724 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
2725 * \li Action: Show a preview built from the master buffer, if available.
2726 if the current buffer is part of a master/child document.
2727 * \li Syntax: master-buffer-view [<FORMAT>]
2728 * \li Params: <FORMAT>: The format to display, where this is one of the
2729 formats defined (in the current GUI) in the
2730 Tools>Preferences>File Formats dialog.
2731 If no format is given, the default format as
2732 specified in the same dialog is used.
2733 * \li Origin: Tommaso, 20 Sep 2007
2736 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
2739 * \var lyx::FuncCode lyx::LFUN_MATH_AMS_MATRIX
2740 * \li Action: Inserts an extended matrix as provided by the amsmath package.
2741 * \li Syntax: math-matrix <COLS> <ROWS> [<DECORATION>]
2742 * \li Params: <DECORATION>: Decoration determines the LaTeX name of the matrix
2743 that should be created. Possible values include
2744 pmatrix, bmatrix, Bmatrix, vmatrix, Vmatrix, smallmatrix, and
2745 matrix. The default is 'matrix'.
2746 * \li Sample: math-ams-matrix 3 3 bmatrix
2749 { LFUN_MATH_AMS_MATRIX, "math-ams-matrix", Noop, Math },
2752 * \var lyx::FuncCode lyx::LFUN_MATH_BIGDELIM
2753 * \li Action: Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
2754 * \li Syntax: math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
2755 * \li Params: <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r \n
2756 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
2757 * \li Sample: math-bigdelim "Bigl" "\Downarrow" "Bigr" "\}"
2758 * \li Origin: Enrico & Georg, 7 May 2006
2761 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
2764 * \var lyx::FuncCode lyx::LFUN_MATH_DELIM
2765 * \li Action: Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
2766 * \li Syntax: math-delim [<LEFT>] [<RIGHT>]
2767 * \li Params: <LEFT/RIGHT>: Delimiters to be used. Each delimiter can be specified by
2768 either a LaTeX name or a valid character.
2769 ( is the default letter.
2770 * \li Sample: math-delim { rangle
2771 * \li Origin: Alejandro, 18 Jun 1996
2774 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
2777 * \var lyx::FuncCode lyx::LFUN_MATH_DISPLAY
2778 * \li Action: Creates a new displayed equation in text mode.
2779 Toggles inlined/display formula in math mode.
2780 * \li Syntax: math-display [<ARG>]
2781 * \li Params: <ARG>: this argument will be passed to #LFUN_MATH_INSERT when creating
2782 new equation from the text mode.
2783 * \li Origin: Alejandro, 18 Jun 1996
2786 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
2789 * \var lyx::FuncCode lyx::LFUN_MATH_EXTERN
2790 * \li Action: Calls external program and passes the current expression/equation
2791 as an argument for the calculation in the format appropriate to the
2793 * \li Notion: Selection can be used to determine the input for the external program.
2794 * \li Syntax: math-extern <LANG> [<COMMAND>]
2795 * \li Params: <LANG>: octave|maxima|maple|mathematica|script \n
2796 where "script" stands for the external script (normalized
2797 expression will be passed)
2798 * \li Origin: Andre, 24 Apr 2001
2799 * \li Sample: math-extern maple simplify
2802 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
2805 * \var lyx::FuncCode lyx::LFUN_MATH_FONT_STYLE
2806 * \li Action: Changes the text style used in math.
2807 * \li Syntax: math-font-style <STYLE>
2808 * \li Params: <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf|textnormal\n
2809 |textrm|textsf|texttt|textbf|textmd|textit|textsc|textsl|textup
2810 * \li Origin: vfr, 9 jan 2009
2813 { LFUN_MATH_FONT_STYLE, "math-font-style", Noop, Math },
2816 * \var lyx::FuncCode lyx::LFUN_MATH_INSERT
2817 * \li Action: Inserts math objects and symbols.
2818 * \li Syntax: math-insert <ARG>
2819 * \li Params: <ARG>: Symbol or LaTeX code to be inserted.
2820 * \li Notion: When <ARG> is a _single_ math inset with more than one cell
2821 (such as "x_y^z" or "\frac{x}{y}"), the content of cell(0) is
2822 replaced by the current selection (only works if the selection
2823 is in mathed). As an example, if "abc" is selected in mathed,
2824 "math-insert \frac{x}{y}" replaces "abc" with "\frac{abc}{y}",
2825 and "math-insert x_y^z" replaces "abc" with "abc_y^z".
2826 If nothing is selected (or the selection is not in mathed),
2827 math-insert works as expected.
2830 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
2833 * \var lyx::FuncCode lyx::LFUN_MATH_LIMITS
2834 * \li Action: Toggles the position of the limits from above/below to the right
2835 side an vice versa in integral symbol, a limit, a summation, etc.
2836 * \li Notion: Put the cursor before the symbol with the limits and then invoke
2838 * \li Syntax: math-limits [<STATE>]
2839 * \li Params: <STATE>: limits|nolimits
2842 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
2845 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO
2846 * \li Action: Inserts a math macro definition at the cursor position in the text.
2847 * \li Syntax: math-macro <NAME> [<NARGS>] [def]
2848 * \li Params: <NAME>: The name of the macro, e.g. "mymacro".\n
2849 <NARGS>: The number of parameters of the macro. Default is 0.
2850 "def": Has no effect anymore, just for compatibility with former LyX versions.
2851 * \li Origin: ale, 10 May 1997; sts, 21 Dec 2007
2854 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
2857 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
2858 * \li Action: Add a greedy optional parameter.
2859 * \li Notion: Add a greedy optional parameter which eats the value
2860 from the following cells in mathed which are in the [value]
2862 * \li Syntax: math-macro-add-greedy-optional-param
2863 * \li Origin: sts, 06 January 2008
2866 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
2869 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
2870 * \li Action: Add an optional parameter.
2871 * \li Notion: Insert an optional parameter just behind the
2872 already existing optional parameters.
2873 * \li Syntax: math-macro-add-optional-param
2874 * \li Origin: sts, 06 January 2008
2877 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
2880 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
2881 * \li Action: Add a parameter.
2882 * \li Notion: Add a parameter to a Math Macro.
2883 * \li Params: <NUM>: The number of the parameter behind which the new one
2884 will be added (1 for the first, i.e. use 0 for add a
2885 parameter at the left), defaults to the last one.
2886 * \li Syntax: math-macro-add-param <NUM>
2887 * \li Origin: sts, 06 January 2008
2890 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
2893 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
2894 * \li Action: Append a greedy parameter.
2895 * \li Notion: Append a greedy parameter to a Math Macro which
2896 eats the following mathed cell in every instance of
2897 the macro in the buffer.
2898 * \li Syntax: math-macro-append-greedy-param
2899 * \li Origin: sts, 06 January 2008
2902 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
2905 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
2906 * \li Action: Fold a Math Macro.
2907 * \li Notion: Fold the Math Macro the cursor is in if it was
2908 unfolded, i.e. displayed as \foo before.
2909 * \li Syntax: math-macro-fold
2910 * \li Origin: sts, 06 January 2008
2913 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
2916 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
2917 * \li Action: Make a parameter non-optional.
2918 * \li Notion: Turn the last optional parameter of a Math Macro
2919 into a non-optional parameter. The default value is
2920 remembered to be reused later if the user changes his mind.
2921 * \li Syntax: math-macro-make-nonoptional
2922 * \li Origin: sts, 06 January 2008
2925 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
2928 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
2929 * \li Action: Make a parameter optional.
2930 * \li Notion: Turn the first non-optional parameter of a Math Macro
2931 into an optional parameter with a default value.
2932 * \li Syntax: math-macro-make-optional
2933 * \li Origin: sts, 06 January 2008
2936 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
2939 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
2940 * \li Action: Remove a greedy parameter.
2941 * \li Notion: Remove a greedy parameter of a Math Macro and spit
2942 out the values of it in every instance of the macro
2943 in the buffer. If it is an optional parameter the [valud]
2945 * \li Syntax: math-macro-remove-greedy-param
2946 * \li Origin: sts, 06 January 2008
2949 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
2952 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
2953 * \li Action: Remove the last optional parameter.
2954 * \li Notion: Remove the last optional parameter of a Math Macro and
2955 remove it in all the instances of the macro in the buffer.
2956 * \li Syntax: math-macro-remove-optional-param
2957 * \li Origin: sts, 06 January 2008
2960 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
2963 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
2964 * \li Action: Remove the last parameter.
2965 * \li Notion: Remove the last parameter of a Math Macro and
2966 remove its value in all instances of the macro
2968 * \li Params: <NUM>: The number of the parameter to be deleted (1 for
2969 the first), defaults to the last one.
2970 * \li Syntax: math-macro-remove-param <NUM>
2971 * \li Origin: sts, 06 January 2008
2974 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
2977 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
2978 * \li Action: Unfold a Math Macro.
2979 * \li Notion: Unfold the Math Macro the cursor is in, i.e.
2981 * \li Syntax: math-macro-unfold
2982 * \li Origin: sts, 06 January 2008
2985 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
2988 * \var lyx::FuncCode lyx::LFUN_MATH_MATRIX
2989 * \li Action: Inserts a matrix.
2990 * \li Syntax: math-matrix <COLS> <ROWS> [<ALIGN>]
2991 * \li Params: <ALIGN>: Alignment is a word composed of the vertical alignment
2992 (b, c or t) (i.e. 1 char) and the horizontal alignments
2993 (l, c or r) (i.e. <COL> chars).
2994 * \li Sample: math-matrix 3 3 bccc
2997 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
3000 * \var lyx::FuncCode lyx::LFUN_MATH_MODE
3001 * \li Action: In text mode enters math mode (i.e. puts math insets on the current
3002 cursor position), in math mode enters text mode inside math expression.
3003 * \li Notion: If there is some selected text, it puts the text inside created math box.
3004 * \li Syntax: math-mode [on|<ARG>]
3005 * \li Params: <ARG>: eventual argument (LaTeX code) is passed to #LFUN_MATH_INSERT .\n
3006 "on": allow only entering of math mode from text mode.
3007 * \li Origin: Alejandro, 4 Jun 1996
3010 { LFUN_MATH_MODE, "math-mode", Noop, Math },
3013 * \var lyx::FuncCode lyx::LFUN_MATH_MUTATE
3014 * \li Action: Mutates the type of math inset to the newly selected one.
3015 * \li Syntax: math-mutate <TYPE>
3016 * \li Params: <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
3017 multline|gather|flalign
3018 * \li Origin: Andre, 23 May 2001
3021 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
3024 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
3025 * \li Action: Toggles numbering of the current formula line.
3026 * \li Notion: Must be in display formula mode.
3027 * \li Syntax: math-number-line-toggle
3028 * \li Origin: Alejandro, 18 Jun 1996
3031 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
3034 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
3035 * \li Action: Toggles numbering/labeling of the current formula.
3036 * \li Notion: Must be in display formula mode.
3037 * \li Syntax: math-number-toggle
3038 * \li Origin: Alejandro, 4 Jun 1996
3041 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
3044 * \var lyx::FuncCode lyx::LFUN_MATH_SIZE
3045 * \li Action: Changes arbitrarily the size used by math fonts inside a context.
3046 * \li Notion: Provides an interface to the LaTeX math mode font size commands.
3047 * \li Syntax: math-size <STYLE>
3048 * \li Params: <STYLE>: \displaystyle|\textstyle|\scriptstyle|\scriptscriptstyle
3049 * \li Origin: Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
3052 { LFUN_MATH_SIZE, "math-size", Noop, Math },
3055 * \var lyx::FuncCode lyx::LFUN_MATH_SPACE
3056 * \li Action: Inserts space into math expression.
3057 * \li Notion: Use spacebar after entering this space to change type of space.
3058 * \li Syntax: math-space [<TYPE>] [<LEN>]
3059 * \li Params: <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace \n
3060 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad \n
3061 custom space: hspace \n
3062 "," used by default.\n
3063 Note that ! is equivalent to negthinspace, , = thinspace,
3064 : = medspace, and ; = thickspace.\n
3065 <LEN>: length for custom spaces (hspace)
3066 * \li Origin: Andre, 25 Jul 2001; sanda, 16 Jun 2008
3069 { LFUN_MATH_SPACE, "math-space", Noop, Math },
3072 * \var lyx::FuncCode lyx::LFUN_MATH_SUBSCRIPT
3073 * \li Action: Enters subscript expression in math expression.
3074 * \li Syntax: math-subscript
3075 * \li Origin: vermeer, 12 Dec 2001
3078 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
3081 * \var lyx::FuncCode lyx::LFUN_MATH_SUPERSCRIPT
3082 * \li Action: Enters superscript expression in math expression.
3083 * \li Syntax: math-superscript
3084 * \li Origin: vermeer, 12 Dec 2001
3087 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
3090 * \var lyx::FuncCode lyx::LFUN_MENU_OPEN
3091 * \li Action: Opens the menu given by its name.
3092 * \li Syntax: menu-open <NAME>
3093 * \li Params: <NAME>: menu name. See various .inc files in lib/ui for candidates.
3096 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
3099 * \var lyx::FuncCode lyx::LFUN_MESSAGE
3100 * \li Action: Shows message in statusbar (for script purposes).
3101 * \li Syntax: message <STRING>
3102 * \li Origin: Lgb, 8 Apr 2001
3105 { LFUN_MESSAGE, "message", NoBuffer, System },
3108 * \var lyx::FuncCode lyx::LFUN_META_PREFIX
3109 * \li Action: Simulate halting Meta key (Alt key on PCs).
3110 * \li Notion: Used for buffer edition not for GUI control.
3111 * \li Syntax: meta-prefix
3114 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
3117 * \var lyx::FuncCode lyx::LFUN_MOUSE_DOUBLE
3118 * \li Action: This function is called when double click on mouse button is
3119 pressed (inside workarea). Action depends on the context.
3120 * \li Notion: This is an internal LFUN, not to be used by users.
3121 * \li Origin: Andre, 9 Aug 2002
3124 { LFUN_MOUSE_DOUBLE, "", ReadOnly | NoUpdate, Hidden },
3127 * \var lyx::FuncCode lyx::LFUN_MOUSE_MOTION
3128 * \li Action: This function is called when mouse cursor is moving over the text.
3129 Action depends on the context.
3130 * \li Notion: This is an internal LFUN, not to be used by users.
3131 * \li Origin: Andre, 9 Aug 2002
3134 { LFUN_MOUSE_MOTION, "", ReadOnly | NoUpdate, Hidden },
3137 * \var lyx::FuncCode lyx::LFUN_MOUSE_PRESS
3138 * \li Action: This function is called when mouse button is pressed (inside workarea).
3139 Action depends on the context.
3140 * \li Notion: This is an internal LFUN, not to be used by users.
3141 * \li Origin: Andre, 9 Aug 2002
3144 { LFUN_MOUSE_PRESS, "", ReadOnly | NoUpdate, Hidden },
3147 * \var lyx::FuncCode lyx::LFUN_MOUSE_RELEASE
3148 * \li Action: This function is called when mouse button is released (inside workarea).
3149 Action depends on the context.
3150 * \li Notion: This is an internal LFUN, not to be used by users.
3151 * \li Origin: Andre, 9 Aug 2002
3154 { LFUN_MOUSE_RELEASE, "", ReadOnly | NoUpdate, Hidden },
3158 * \var lyx::FuncCode lyx::LFUN_MOUSE_TRIPLE
3159 * \li Action: This function is called when triple click on mouse button is
3160 pressed (inside workarea). Action depends on the context.
3161 * \li Notion: This is an internal LFUN, not to be used by users.
3162 * \li Origin: Andre, 9 Aug 2002
3165 { LFUN_MOUSE_TRIPLE, "", ReadOnly | NoUpdate, Hidden },
3168 * \var lyx::FuncCode lyx::LFUN_NEWLINE_INSERT
3169 * \li Action: Inserts a line break or new line.
3170 * \li Syntax: newline-insert [<ARG>]
3171 * \li Params: <ARG>: <newline|linebreak> default: newline
3172 * \li Origin: spitz, 25 Mar 2008
3175 { LFUN_NEWLINE_INSERT, "newline-insert", Noop, Edit },
3178 * \var lyx::FuncCode lyx::LFUN_NEWPAGE_INSERT
3179 * \li Action: Inserts a new page.
3180 * \li Syntax: newpage-insert <ARG>
3181 * \li Params: <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
3182 * \li Origin: uwestoehr, 24 Nov 2007
3185 { LFUN_NEWPAGE_INSERT, "newpage-insert", Noop, Edit },
3188 * \var lyx::FuncCode lyx::LFUN_NOMENCL_INSERT
3189 * \li Action: Inserts Nomenclature entry.
3190 * \li Notion: It automatically takes the word on the cursor position if no symbol is given.
3191 * \li Syntax: nomencl-insert [<SYMBOL>]
3192 * \li Origin: Ugras, 4 Nov 2006
3195 { LFUN_NOMENCL_INSERT, "nomencl-insert", Noop, Edit },
3198 * \var lyx::FuncCode lyx::LFUN_NOMENCLATURE_PRINT
3199 * \li Action: Inserts list of Nomenclature entries.
3200 * \li Syntax: nomenclature-print
3201 * \li Origin: Ugras, 4 Nov 2006
3204 { LFUN_NOMENCL_PRINT, "nomencl-print", Noop, Edit },
3208 * \var lyx::FuncCode lyx::LFUN_NOTE_INSERT
3209 * \li Action: Inserts Note on the current cursor position,
3210 move selection inside the inset.
3211 * \li Syntax: note-insert [<TYPE>]
3212 * \li Params: <TYPE>: <Note|Greyedout|Comment> default: Note
3215 { LFUN_NOTE_INSERT, "note-insert", Noop, Edit },
3218 * \var lyx::FuncCode lyx::LFUN_NOTE_NEXT
3219 * \li Action: Moves the cursor to the beginning of next Note inset.
3220 * \li Syntax: note-next
3223 { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
3226 * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
3227 * \li Action: Move the current group in the downward direction in the
3228 structure of the document.
3229 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
3230 the whole substructure of the group.
3231 * \li Syntax: outline-down
3232 * \li Origin: Vermeer, 23 Mar 2006
3235 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
3238 * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
3239 * \li Action: Moves the current group in the downward direction in the
3240 hierarchy of the document structure.
3241 * \li Notion: Part -> Chapter -> Section -> etc.
3242 * \li Syntax: outline-in [local]
3243 * \li Params: local: if given, only the current paragraph will be affected.
3244 * \li Origin: Vermeer, 23 Mar 2006
3247 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
3250 * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
3251 * \li Action: Moves the current group in the upward direction in the
3252 hierarchy of the document structure.
3253 * \li Notion: Part <- Chapter <- Section <- etc.
3254 * \li Syntax: outline-out [local]
3255 * \li Params: local: if given, only the current paragraph will be affected.
3256 * \li Origin: Vermeer, 23 Mar 2006
3259 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
3263 * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
3264 * \li Action: Move the current group in the upward direction in the
3265 structure of the document.
3266 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
3267 the whole substructure of the group.
3268 * \li Syntax: outline-up
3269 * \li Origin: Vermeer, 23 Mar 2006
3272 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
3275 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_BREAK
3276 * \li Action: Breaks the current paragraph at the current location.
3277 * \li Notion: Removes the selection.
3278 * \li Syntax: paragraph-break [<LAYOUT>] [ignoresep]
3279 * \li Params: <LAYOUT>: "inverse" - decreases depth by one (or change layout
3280 to default layout) when the cursor is at the end of
3282 ignoresep: Do not account for paragraph separators while breaking.
3285 { LFUN_PARAGRAPH_BREAK, "paragraph-break", Noop, Edit },
3288 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN
3289 * \li Action: Move the cursor to the next paragraph (or beginning of the current one)
3290 in downward direction.
3291 * \li Syntax: paragraph-down
3292 * \li Origin: Asger, 1 Oct 1996
3295 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
3298 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN_SELECT
3299 * \li Action: Move the cursor and select the text to the next paragraph (or
3300 beginning of the current one) in downward direction.
3301 * \li Syntax: paragraph-down-select
3302 * \li Origin: Asger, 1 Oct 1996
3305 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
3308 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
3309 * \li Action: Jump to a paragraph given by its id number and optionally the
3310 desired position within the paragraph.
3311 If given four arguments id_start, pos_start, id_end, pos_end,
3312 perform a selection from start to end.
3313 * \li Notion: Note that id number of paragraph is not the sequential number of
3314 paragraph seen on the screen. Moreover the id is unique for all
3315 opened buffers (documents). Both ids must belong to the same
3317 * \li Syntax: paragraph-goto <PAR_ID> <POS_IN_PAR> [<PAR_ID> <POS_IN_PAR>]
3318 * \li Params: <PAR_ID>: paragraph id \n
3319 <POS_IN_PAR>: desired position within the paragraph
3320 * \li Origin: Dekel, 26 Aug 2000
3324 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly | NoInternal, Edit },
3327 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
3328 * \li Action: Moves the current paragraph downwards in the document.
3329 * \li Syntax: paragraph-move-down
3330 * \li Origin: Edwin, 8 Apr 2006
3333 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
3336 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
3337 * \li Action: Moves the current paragraph upwards in the document.
3338 * \li Notion: Movement through the document will possibly break the paragraph-depth
3339 (e.g. itemize structure).
3340 * \li Syntax: paragraph-move-up
3341 * \li Origin: Edwin, 8 Apr 2006
3344 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
3348 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
3349 * \li Action: Change paragraph settings.
3350 * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
3351 This function only modifies, and does not override, existing settings.
3352 Note that the "leftindent" indent setting is deprecated.
3353 * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
3354 * \li Params: <INDENT>: \noindent|\indent|\indent-toggle|\leftindent LENGTH\n
3355 <SPACING>: \paragraph_spacing default|single|onehalf|double|other SIZE \n
3356 <ALIGN>: \align block|left|right|center|default\n
3357 <OTHERS>: \labelwidthstring WIDTH|\start_of_appendix
3358 * \li Origin: rgh, Aug 15 2007
3361 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
3364 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
3365 * \li Action: Change paragraph settings.
3366 * \li Notion: Overwrite all nonspecified settings to the default ones.
3367 Use paragraph-params lfun if you don't want to overwrite others settings.
3368 * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
3369 * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
3370 * \li Origin: leeming, 30 Mar 2004
3373 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
3376 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP
3377 * \li Action: Move the cursor to the next paragraph (or beginning of the current one)
3378 in upward direction.
3379 * \li Syntax: paragraph-up
3380 * \li Origin: Asger, 1 Oct 1996
3383 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
3386 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UPDATE
3387 * \li Action: Updates the values inside the paragraph dialog from the paragraph.
3388 * \li Notion: This is an internal LFUN, not to be used by users. Called internally
3389 by #LFUN_DIALOG_UPDATE.
3390 * \li Origin: leeming, 13 Mar 2003
3393 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
3396 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_SELECT
3397 * \li Action: Move cursor to beginning of current paragraph
3398 and select to the end in downward direction
3399 * \li Notion: This function is by default bound to triple mouse click
3400 * \li Syntax: paragraph-select
3401 * \li Origin: Kornel, 16 Apr 2019
3404 { LFUN_PARAGRAPH_SELECT, "paragraph-select", ReadOnly, Edit },
3407 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP_SELECT
3408 * \li Action: Move the cursor and select the text to the next paragraph (or
3409 beginning of the current one) in upward direction.
3410 * \li Syntax: paragraph-up-select
3411 * \li Origin: Asger, 1 Oct 1996
3414 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
3417 * \var lyx::FuncCode lyx::LFUN_PASTE
3418 * \li Action: Pastes material (text or picture) from the active clipboard.
3419 * \li Syntax: paste [<TYPE>|<NUM>]
3420 * \li Params: <TYPE>: emf|pdf|png|jpeg|linkback|wmf|latex|html \n
3421 <NUM>: number of the selection in the internal clipboard stack to be pasted.
3424 { LFUN_PASTE, "paste", Noop, Edit },
3427 * \var lyx::FuncCode lyx::LFUN_PHANTOM_INSERT
3428 * \li Action: Inserts phantom on the current cursor position,
3429 move selection inside the inset.
3430 * \li Syntax: phantom-insert [<TYPE>]
3431 * \li Params: <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
3432 * \li Origin: uwestoehr, 30 Jan 2009
3435 { LFUN_PHANTOM_INSERT, "phantom-insert", Noop, Edit },
3438 * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
3439 * \li Action: Save user preferences.
3440 * \li Syntax: preferences-save
3441 * \li Origin: Lgb, 27 Nov 1999
3444 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
3447 * \var lyx::FuncCode lyx::LFUN_PREVIEW_INSERT
3448 * \li Action: Inserts a new preview inset.
3449 * \li Syntax: preview-insert
3450 * \li Origin: vfr, 28 Mar 2010
3453 { LFUN_PREVIEW_INSERT, "preview-insert", Noop, Edit },
3456 * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
3457 * \li Action: Pastes the currently selected text.
3458 * \li Notion: Primary selection mechanism is X11/Wayland-only thing.
3459 * \li Syntax: primary-selection-paste [<ARG>]
3460 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
3463 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
3466 * \var lyx::FuncCode lyx::LFUN_QUOTE_INSERT
3467 * \li Action: Inserts quotes according to the type and quote-language preference.
3468 * \li Notion: Currently 15 different quote styles are distinguished (see params).
3469 * \li Syntax: quote-insert [<LEVEL>] [<SIDE> <STYLE>]
3470 * \li Params: <LEVEL>: 'inner' for (i.e., secondary, usually single) quotes, otherwise
3471 * outer (i.e., primary, usually double) quotes will be used.\n
3472 * <SIDE>: 'opening' for opening quotes, 'closing' for closing quotes,
3473 * otherwise the side will be guessed from the context. Use 'auto'
3474 * to force this default. (You will need to give this argument if
3475 * you also want to give <STYLE>.)\n
3476 * <STYLE>: 'british' for `British' quote style (with ``inner quotation'')\n
3477 * 'cjk' for Chinese/Japanese/Korean corner bracket quotation marks\n
3478 * 'cjk-angle' for Chinese/Japanese/Korean angle bracket quotation marks\n
3479 * 'danish' for >>Danish<< quote style (with >inner quotation<)\n
3480 * 'english' for ``English'' quote style (with `inner quotation')\n
3481 * 'french' for <<french>> quote style (with ``inner quotation'')\n
3482 * 'frenchin' for <<frenchin>> quote style (with <<inner quotation>>) ["in" = Imprimerie Nationale]\n
3483 * 'german' for ,,German`` quote style (with ,inner quotation`)\n
3484 * 'hebrew' for ''hebrew,, quote style (with 'inner quotation,)\n
3485 * 'plain' for "Plain" quote style (with 'inner quotation')\n
3486 * 'polish' for ,,Polish'' quote style (with ,inner quotation')\n
3487 * 'swedish' for ''Swedish'' quote style (with 'inner quotation')\n
3488 * 'swedishg' for >>swedishg>> quote style (with 'inner quotation') ["g" = Guillemets]\n
3489 * 'swiss' for <<Swiss>> quote style (with <inner quotation>)\n
3490 * 'russian' for <<Russian>> quote style (with ,,inner quotation``)\n
3491 * 'dynamic' for Dynamic quotation marks which inherit the global
3493 * If no quote style is specified, the document-wide will be used.
3496 { LFUN_QUOTE_INSERT, "quote-insert", Noop, Edit },
3499 * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
3500 * \li Action: Reconfigure the automatic settings.
3501 * \li Syntax: reconfigure
3502 * \li Origin: Asger, 14 Feb 1997
3505 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
3508 * \var lyx::FuncCode lyx::LFUN_REDO
3509 * \li Action: Redoes the last thing undone.
3513 { LFUN_REDO, "redo", ReadOnly, Edit },
3516 * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
3517 * \li Action: Go to the next label or cross-reference.
3518 * \li Syntax: reference-next
3519 * \li Origin: Dekel, 14 Jan 2001
3522 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
3526 * \var lyx::FuncCode lyx::LFUN_REGEXP_MODE
3527 * \li Action: Enters regexp mode (i.e., puts regexp insets on the current
3528 cursor position). Used by the advanced search dialog.
3529 * \li Notion: If there is any selected text, then it is moved inside the created
3531 * \li Syntax: regexp-mode [<ARG>]
3532 * \li Params: <ARG>: eventual argument (regular expression).
3533 * \li Origin: Tommaso, 4 Oct 2008
3536 { LFUN_REGEXP_MODE, "regexp-mode", Noop, Math },
3539 * \var lyx::FuncCode lyx::LFUN_REPEAT
3540 * \li Action: Repeat the given command.
3541 * \li Notion: fails when the repeat count is greater than 10000.
3542 * \li Syntax: repeat <COUNT> <LFUN-COMMAND>
3543 * \li Origin: Andre, 27 Oct 2003
3546 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
3549 * \var lyx::FuncCode lyx::LFUN_SEARCH_IGNORE
3550 * \li Action: Enables/disables searching for features in findadv
3551 * \li Syntax: search-ignore <type> <value>
3552 * \li Params: <type>: language|color|sectioning|font|series|shape|family|markup|underline|strike|deleted|non-output-content\n
3553 * \li Params: <value>: true|false
3556 { LFUN_SEARCH_IGNORE, "search-ignore", ReadOnly|NoBuffer|NoUpdate, System },
3559 * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN
3560 * \li Action: Moves the cursor one page in downward direction.
3561 * \li Syntax: screen-down
3564 { LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit },
3567 * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN_SELECT
3568 * \li Action: Moves the cursor one screen in downward direction adding the current
3569 position to the selection.
3570 * \li Syntax: screen-down-select
3573 { LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit },
3576 * \var lyx::FuncCode lyx::LFUN_SCREEN_FONT_UPDATE
3577 * \li Action: Update fonts and its metrics.
3578 * \li Notion: Automatically called after zoom, dpi, font names, or norm change.
3579 * \li Syntax: screen-font-update
3580 * \li Origin: ARRae, 13 Aug 2000
3583 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
3586 * \var lyx::FuncCode lyx::LFUN_SCREEN_RECENTER
3587 * \li Action: Recenters the screen on the current cursor position.
3588 * \li Syntax: screen-recenter
3591 { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit },
3595 * \var lyx::FuncCode lyx::LFUN_SCREEN_SHOW_CURSOR
3596 * \li Action: Repositions the screen such that the cursor is visible.
3597 * \li Syntax: screen-show-cursor
3598 * \li Origin: vfr, 25 Mar 2009
3601 { LFUN_SCREEN_SHOW_CURSOR, "screen-show-cursor", ReadOnly, Edit },
3605 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP
3606 * \li Action: Moves the cursor one page in upward direction.
3607 * \li Syntax: screen-up
3610 { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit },
3613 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP_SELECT
3614 * \li Action: Moves the cursor one page in upward direction adding the current
3615 position to the selection.
3616 * \li Syntax: screen-up-select
3619 { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit },
3622 * \var lyx::FuncCode lyx::LFUN_SCRIPT_INSERT
3623 * \li Action: Inserts a subscript or superscript inset.
3624 * \li Syntax: script-insert <TYPE>
3625 * \li Params: <TYPE>: subscript|superscript
3626 * \li Origin: Georg, 23 Nov 2010
3629 { LFUN_SCRIPT_INSERT, "script-insert", Noop, Edit },
3632 * \var lyx::FuncCode lyx::LFUN_SCROLL
3633 * \li Action: Scroll the buffer view.
3634 * \li Notion: Only scrolls the screen up or down; does not move the cursor.
3635 * \li Syntax: scroll <TYPE> <QUANTITY>
3636 * \li Params: <TYPE>: line|page\n
3637 <QUANTITY>: up|down|<number>
3638 * \li Origin: Abdel, Dec 27 2007
3641 { LFUN_SCROLL, "scroll", ReadOnly, Edit },
3644 * \var lyx::FuncCode lyx::LFUN_SECTION_SELECT
3645 * \li Action: Select the whole section.
3646 * \li Notion: The cursor should be in a section heading
3647 before calling this lfun.
3648 * \li Syntax: section-select
3649 * \li Origin: vfr, 05 May 2009
3652 { LFUN_SECTION_SELECT, "section-select", ReadOnly, Edit },
3656 * \var lyx::FuncCode lyx::LFUN_SELECTION_PASTE
3657 * \li Action: Pastes the internal selection text in permanent selection.
3658 * \li Notion: Created in order to have middle mouse button pasting correct. The middle
3659 button is bound to "command-alternatives selection-paste ; primary-selection-paste".
3660 selection-paste makes sure that if something is highlighted in LyX window
3661 it gets into selection buffer and pasted. If nothing is highlighted, then
3662 primary-selection-paste covers the cases of pasting from selection
3663 buffer from another apps (or from LyX once the highlight is gone).
3664 * \li Syntax: selection-paste
3665 * \li Origin: lasgouttes, 14 Jan 2009
3668 { LFUN_SELECTION_PASTE, "selection-paste", Noop, Edit },
3671 * \var lyx::FuncCode lyx::LFUN_SELF_INSERT
3672 * \li Action: Inserts the given string (accordingly to the correct keymap).
3673 * \li Notion: Automatically replace the currently selected text. Depends on lyxrc
3674 settings "auto_region_delete".
3675 * \li Syntax: self-insert <STRING>
3678 { LFUN_SELF_INSERT, "self-insert", SingleParUpdate, Hidden },
3681 * \var lyx::FuncCode lyx::LFUN_SEPARATOR_INSERT
3682 * \li Action: Inserts an environment separator or latex paragraph break.
3683 * \li Syntax: separator-insert [<ARG>]
3684 * \li Params: <ARG>: <plain|parbreak|latexpar> default: plain
3685 * \li Origin: ef, 2 May 2014
3688 { LFUN_SEPARATOR_INSERT, "separator-insert", Noop, Edit },
3691 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_FILENAME
3692 * \li Action: Returns path and file name of the currently edited document.
3693 * \li Syntax: server-get-filename
3696 { LFUN_SERVER_GET_FILENAME, "server-get-filename", ReadOnly, System },
3699 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_LAYOUT
3700 * \li Action: Returns the current layout (that is environment) name
3701 on the cursor position.
3702 * \li Syntax: server-get-layout
3705 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
3708 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_STATISTICS
3709 * \li Action: Returns the statistics (number of words and characters)
3710 in the document or in the given selection.
3711 * \li Notion: Note that this function gives the number of words/chars written,
3712 not the number of characters which will be typeset.
3713 * \li Syntax: server-get-statistics [<TYPE>]
3714 * \li Params: <TYPE>: <words|chars|chars-space> The requested count; if not
3715 specified, the three values are returned, separated
3717 words: count words.\n
3718 chars: count characters.\n
3719 chars-space: count characters and spaces.
3720 * \li Origin: brokenclock, Oct 10 2014
3723 { LFUN_SERVER_GET_STATISTICS, "server-get-statistics", ReadOnly, System },
3726 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
3727 * \li Action: Returns the coordinates of cursor position in the editing area.
3728 * \li Syntax: server-get-xy
3731 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
3735 * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
3736 * \li Action: Sets the cursor position in LyX based on the row number of generated TeX file.
3737 * \li Notion: This can be useful for DVI inverse-search or detection of the problematic
3738 line from LaTeX compilation. Note that before this function can be used
3739 export to LaTeX output must occur (in order to map the row numbers).
3740 * \li Syntax: server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
3741 * \li Params: <FILE>: the path and filename. Environment variables are expanded in the path.
3742 In case this LFUN does not work make sure you are giving correct
3744 If the file is located inside LyX temporary directory it will be
3745 mapped back into the appropriate opened buffer (e.g. for the case
3746 of generated .tex file).\n
3747 .ext: extensions will be automatically replaced by .lyx.\n
3748 <ROW_NUMBER> The row number of the LaTeX file to which to go.
3749 * \li Sample: server-goto-file-row /home/user/example.lyx 41\n
3750 server-goto-file-row /tmp/lyx_tmpdir.XM3088/lyx_tmpbuf0/example.tex 41
3751 * \li Origin: Edmar, 23 Dec 1998
3754 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly | NoBuffer, System },
3757 * \var lyx::FuncCode lyx::LFUN_SERVER_NOTIFY
3758 * \li Action: Sends notify message about the last key-sequence to client.
3759 * \li Notion: This can be used to grab last key-sequence used inside the LyX window.
3760 See also Debug extensions section in Additional features manual.
3761 * \li Syntax: server-notify
3764 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
3767 * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
3768 * \li Action: Sets the cursor position based on the editing area coordinates
3769 (similar to clicking on that point with left mouse button).
3770 * \li Syntax: server-set-xy <X> <Y>
3773 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
3776 * \var lyx::FuncCode lyx::LFUN_SET_COLOR
3777 * \li Action: Set the given LyX color to the color defined by the X11 name given,
3778 * and optionally a specific color for dark mode.
3779 * \li Notion: A new color entry is created if the color is unknown.
3780 Color names can be stored as a part of user settings.
3781 * \li Syntax: set-color <LYX_NAME> <X11_NAME> [<X11_DARKNAME>]
3782 * \li Origin: SLior, 11 Jun 2000
3785 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
3788 * \var lyx::FuncCode lyx::LFUN_GRAPHICS_SET_GROUP
3789 * \li Action: Set the group for the graphics inset on the cursor position.
3790 * \li Syntax: graphics-set-group [<GROUP>]
3791 * \li Params: <GROUP>: Id for an existing group. In case the Id is an empty string,
3792 the graphics inset is removed from the current group.
3793 * \li Origin: sanda, 6 May 2008
3796 { LFUN_GRAPHICS_SET_GROUP, "graphics-set-group", Noop, Edit },
3799 * \var lyx::FuncCode lyx::LFUN_GRAPHICS_UNIFY
3800 * \li Action: Set the same group for all graphics insets in the marked block.
3801 * \li Syntax: graphics-unify [<GROUP>]
3802 * \li Params: <GROUP>: Id for an existing group. In case the Id is an empty string,
3803 the group Id from the first graphics inset will be used.
3804 * \li Origin: sanda, 7 Feb 2018
3807 { LFUN_GRAPHICS_UNIFY, "graphics-unify", Noop, Edit },
3810 * \var lyx::FuncCode lyx::LFUN_GRAPHICS_RELOAD
3811 * \li Action: Reloads the image if necessary.
3812 * \li Syntax: graphics-reload
3813 * \li Origin: vfr, 10 Aug 2009
3816 { LFUN_GRAPHICS_RELOAD, "graphics-reload", ReadOnly | AtPoint, Edit },
3819 * \var lyx::FuncCode lyx::LFUN_SPACE_INSERT
3820 * \li Action: Inserts one of horizontal space insets.
3821 * \li Syntax: space-insert <NAME> [<LEN>]
3822 * \li Params: <NAME>: normal, protected, visible, thin, quad, qquad, enspace,
3823 enskip, negthinspace, negmedspace, negthickspace, hfill,
3824 hfill*, dotfill, hrulefill, hspace, hspace* \n
3825 Only in math mode: med and thick.\n
3826 <LEN>: length for custom spaces (hspace, hspace* for protected)
3827 * \li Origin: spitz, 20 May 2003, Mar 17 2008
3830 { LFUN_SPACE_INSERT, "space-insert", Noop, Edit },
3833 * \var lyx::FuncCode lyx::LFUN_SPECIALCHAR_INSERT
3834 * \li Action: Inserts various characters into the document.
3835 * \li Syntax: specialchar-insert <CHAR>
3836 * \li Params: <CHAR>: hyphenation, allowbreak, ligature-break, slash,
3837 nobreakdash, dots, end-of-sentence, menu-separator,
3838 lyx, tex, latex, latex2e.
3839 * \li Origin: spitz, 6 Dec 2007
3842 { LFUN_SPECIALCHAR_INSERT, "specialchar-insert", Noop, Edit },
3845 * \var lyx::FuncCode lyx::LFUN_SPELLING_ADD
3846 * \li Action: Add the word under the cursor to the respective
3847 * spell checker dictionary.
3848 * The default for the language is retrieved from the cursor position.
3849 * \li Syntax: spelling-add [<STRING>] [<LANG>]
3850 * \li Params: <WORD>: word to add\n
3851 <LANG>: language name (see file languages)
3852 * \li Origin: spitz, 18 Jan 2010
3855 { LFUN_SPELLING_ADD, "spelling-add", ReadOnly, Edit },
3858 * \var lyx::FuncCode lyx::LFUN_SPELLING_ADD_LOCAL
3859 * \li Action: Add the word under the cursor to the document's local
3860 * spell checker dictionary.
3861 * The default for the language is retrieved from the cursor position.
3862 * \li Syntax: spelling-add-local [<STRING>] [<LANG>]
3863 * \li Params: <WORD>: word to add\n
3864 <LANG>: language name (see file languages)
3865 * \li Origin: spitz, 6 Mar 2021
3868 { LFUN_SPELLING_ADD_LOCAL, "spelling-add-local", Noop, Edit },
3871 * \var lyx::FuncCode lyx::LFUN_SPELLING_REMOVE_LOCAL
3872 * \li Action: Remove the word under the cursor from the document's local
3873 * spell checker dictionary.
3874 * The default for the language is retrieved from the cursor position.
3875 * \li Syntax: spelling-remove-local [<STRING>] [<LANG>]
3876 * \li Params: <WORD>: word to remove\n
3877 <LANG>: language name (see file languages)
3878 * \li Origin: spitz, 7 Mar 2021
3881 { LFUN_SPELLING_REMOVE_LOCAL, "spelling-remove-local", Noop, Edit },
3884 * \var lyx::FuncCode lyx::LFUN_SPELLING_CONTINUOUSLY
3885 * \li Action: Toggle continuous spell checking.
3886 * \li Syntax: spelling-continuously
3887 * \li Origin: vfr, 24 March 2013
3890 { LFUN_SPELLING_CONTINUOUSLY, "spelling-continuously", ReadOnly, Edit },
3894 * \var lyx::FuncCode lyx::LFUN_SPELLING_IGNORE
3895 * \li Action: Let the spell checker ignore the word under the cursor
3896 * in the current session for the given language.
3897 * The default for the language is retrieved from the cursor position.
3898 * \li Syntax: spelling-ignore [<WORD>] [<LANG>]
3899 * \li Params: <WORD>: word to ignore\n
3900 <LANG>: language name (see file languages)
3901 * \li Origin: spitz, 18 Jan 2010
3904 { LFUN_SPELLING_IGNORE, "spelling-ignore", ReadOnly, Edit },
3907 * \var lyx::FuncCode lyx::LFUN_SPELLING_REMOVE
3908 * \li Action: Remove the word under the cursor from the respective
3909 * spell checker dictionary.
3910 * The default for the language is retrieved from the cursor position.
3911 * \li Syntax: spelling-remove [<STRING>] [<LANG>]
3912 * \li Params: <WORD>: word to remove\n
3913 <LANG>: language name (see file languages)
3914 * \li Origin: SWitt, 28 July 2010
3917 { LFUN_SPELLING_REMOVE, "spelling-remove", ReadOnly, Edit },
3921 * \var lyx::FuncCode lyx::LFUN_STATISTICS
3922 * \li Action: Count the statistics (number of words and characters)
3923 in the document or in the given selection and display it
3925 * \li Notion: Note that this function gives the number of words/chars written,
3926 not the number of characters which will be typeset.
3927 * \li Syntax: statistics
3928 * \li Origin: lasgouttes, Jan 27 2004; sanda, Jan 8 2008
3931 { LFUN_STATISTICS, "statistics", ReadOnly, System },
3933 * \var lyx::FuncCode lyx::LFUN_STATISTICS_REFERENCE_CLAMP
3934 * \li Action: Count statistics relative to the current value.
3935 In other words all future values will be subtracted by this value.
3936 * \li Syntax: statistics-reference-clamp [reset]
3937 * \li Params: reset: remove the clamp, i.e. count in the absolute numbers again
3938 * \li Origin: sanda, Mar 28 2024
3941 { LFUN_STATISTICS_REFERENCE_CLAMP, "statistics-reference-clamp", ReadOnly, System },
3944 * \var lyx::FuncCode lyx::LFUN_TABULAR_FEATURE
3945 * \li Action: Modify properties of tabulars and table-like math environments.
3946 * \li Syntax: tabular-feature <FEATURE> [<ARG>]
3947 * \li Params: Generally see #LFUN_INSET_INSERT for further details.\n
3948 * <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|\n
3949 copy-column|move-column-right|move-column-left|move-row-down|move-row-up|\n
3950 set-line-top|set-line-bottom|set-line-left|set-line-right|\n
3951 toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|\n
3952 set-ltrim-top|set-rtrim-top|set-ltrim-bottom|set-rtrim-bottom\n
3953 toggle-ltrim-top|toggle-rtrim-top|toggle-ltrim-bottom|toggle-rtrim-bottom\n
3954 align-left|align-right|align-center|align-block|align-decimal|set-decimal-point|\n
3955 valign-top|valign-bottom|valign-middle|longtabular-align-left|\n
3956 longtabular-align-center|longtabular-align-right|m-align-left|m-align-right|\n
3957 m-align-center|m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|\n
3958 reset-formal-default|set-all-lines|toggle-all-lines|unset-all-lines|\n
3959 toggle-longtabular|set-longtabular|unset-longtabular|set-pwidth|\n
3960 set-mpwidth|set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|\n
3961 set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|\n
3962 unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|\n
3963 set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|\n
3964 set-special-column|set-special-multicolumn|set-special-multirow|\n
3965 toggle-booktabs|set-booktabs|unset-booktabs|set-top-space|set-bottom-space|\n
3966 set-interline-space|tabular-valign-top|tabular-valign-middle|\n
3967 tabular-valign-bottom|set-tabular-width|toggle-varwidth-column|\n
3968 set-border-lines|toggle-border-lines|set-inner-lines|toggle-inner-lines
3969 Various math-environment features are handled as well, e.g. add-vline-left/right for\n
3970 the Grid/Array environment.\n
3971 <ARG>: additional argument for some commands, use debug mode to explore its values.
3972 * \li Origin: gm, 10 Dec 2015
3975 { LFUN_TABULAR_FEATURE, "tabular-feature", Noop, Edit },
3978 * \var lyx::FuncCode lyx::LFUN_TABULAR_INSERT
3979 * \li Action: Inserts table into the document.
3980 * \li Notion: See #LFUN_TABULAR_FEATURE for some more details
3981 about tabular modifications.
3982 * \li Syntax: tabular-insert [<ROWS> <COLUMNS>]
3983 * \li Params: In case no arguments are given show insert dialog.
3984 * \li Origin: Jug, 12 Apr 2000
3987 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
3990 * \var lyx::FuncCode lyx::LFUN_TABULAR_STYLE_INSERT
3991 * \li Action: Inserts table of a given style into the document.
3992 * \li Notion: See #LFUN_TABULAR_FEATURE for some more details
3993 about tabular modifications.
3994 * \li Syntax: tabular-style-insert <style> <ROWS> <COLUMNS>
3995 * \li Params: Valid styles are the names of the files in lib/tabletemplates,
3996 * minus _1x<n> and .lyx suffix.
3997 * \li Origin: spitz, 25 Mar 2019
4000 { LFUN_TABULAR_STYLE_INSERT, "tabular-style-insert", Noop, Edit },
4003 * \var lyx::FuncCode lyx::LFUN_TAB_DELETE
4004 * \li Action: Delete a tab or up to an equivalent amount of spaces from
4006 * \li Notion: It also works on a selection - it removes a tab or spaces from the
4007 beginning of each line spanned by the selection. This is useful if
4008 you want to indent/unindent multiple lines in one action.
4009 * \li Syntax: tab-delete
4010 * \li Origin: vfr, Sep 30 2008
4013 { LFUN_TAB_DELETE, "tab-delete", SingleParUpdate, Edit },
4016 * \var lyx::FuncCode lyx::LFUN_TAB_GROUP_NEXT
4017 * \li Action: Switch to the next tab group in split view.
4018 * \li Syntax: tab-group-next
4021 { LFUN_TAB_GROUP_NEXT, "tab-group-next", ReadOnly, Buffer },
4024 * \var lyx::FuncCode lyx::LFUN_TAB_GROUP_PREVIOUS
4025 * \li Action: Switch to the previous tab group in split view.
4026 * \li Syntax: tab-group-previous
4029 { LFUN_TAB_GROUP_PREVIOUS, "tab-group-previous", ReadOnly, Buffer },
4032 * \var lyx::FuncCode lyx::LFUN_TAB_GROUP_CLOSE
4033 * \li Action: Close the current tab group.
4034 * \li Notion: This only closes the work areas, not the buffers themselves.
4035 The still opened buffers can be visualized in another tab group.
4036 * \li Syntax: tab-group-close
4037 * \li Origin: Abdel, 21 Feb 2008
4040 { LFUN_TAB_GROUP_CLOSE, "tab-group-close", ReadOnly, Buffer },
4044 * \var lyx::FuncCode lyx::LFUN_TAB_INSERT
4045 * \li Action: Insert a tab into a listings inset.
4046 * \li Notion: It also works on a selection.
4047 * \li Syntax: tab-insert
4048 * \li Origin: vfr, Sep 30 2008
4051 { LFUN_TAB_INSERT, "tab-insert", SingleParUpdate, Edit },
4054 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
4055 * \li Action: Sets the text class for the current buffer.
4056 * \li Syntax: textclass-apply <TEXTCLASS>
4057 * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
4058 the filename, minus the ".layout" extension.
4061 { LFUN_TEXTCLASS_APPLY, "textclass-apply", NoInternal, Layout },
4064 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
4065 * \li Action: Loads information for a textclass from disk.
4066 * \li Syntax: textclass-load <TEXTCLASS>
4067 * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
4068 the filename, minus the ".layout" extension.
4071 { LFUN_TEXTCLASS_LOAD, "textclass-load", NoInternal, Layout },
4075 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_APPLY
4076 * \li Action: Apply last used text properties.
4077 * \li Syntax: textstyle-apply [<NUM>]
4078 * \li Params: <NUM>: number of the selection in the internal freefonts stack to be applied.
4079 * \li Notion: These properties are stored via #LFUN_TEXTSTYLE_UPDATE, which is
4080 automatically triggered when using Text Style dialog.
4081 * \li Syntax: textstyle-apply
4082 * \li Origin: leeming, 12 Mar 2003
4085 { LFUN_TEXTSTYLE_APPLY, "textstyle-apply", Noop, Layout },
4088 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_UPDATE
4089 * \li Action: Apply text style and update the settings to be used by #LFUN_TEXTSTYLE_APPLY.
4090 * \li Syntax: textstyle-update <FONT_INFO>
4091 * \li Params: <FONT_INFO>: specifies font attributes, e.g. family, series, shape,
4092 size, emph, noun, underbar, number, color, language,
4094 Use lyx -dbg action for exact syntax of text-style
4095 dialog parameters. The code is expecting numerical parameters,
4096 so that one needs to use e.g. "series 1" instead of "series bold".
4097 * \li Sample: textstyle-update series 1
4098 * \li Origin: leeming, 12 Mar 2003
4101 { LFUN_TEXTSTYLE_UPDATE, "textstyle-update", Noop, Layout },
4104 * \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
4105 * \li Action: Look up thesaurus entries with respect to the word under the cursor.
4106 * \li Syntax: thesaurus-entry [<STRING>] [lang=<LANG>]
4107 * \li Params: <STRING>: word to look up\n
4108 <LANG>: language (see file languages)
4109 * \li Origin: Levon, 20 Jul 2001
4112 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
4115 * \var lyx::FuncCode lyx::LFUN_TOOLBAR_MOVABLE
4116 * \li Action: Toggles movability of a given toolbar between true/false.
4117 * \li Syntax: toolbar-movable <NAME>
4118 * \li Params: <NAME>: *|standard|extra|table|math|mathmacrotemplate|
4119 minibuffer|review|view/update|math_panels|vcs|
4120 view-others|update-others
4121 * \li Origin: daniel, 12 July 2016
4124 { LFUN_TOOLBAR_MOVABLE, "toolbar-movable", NoBuffer, Buffer },
4127 * \var lyx::FuncCode lyx::LFUN_TOOLBAR_SET
4128 * \li Action: Sets visibility of a given toolbar to on, off, or auto.
4129 * \li Notion: Skipping "auto" when allowauto is false.
4130 * \li Syntax: toolbar-set <NAME> [on|off|auto]
4131 * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|\n
4132 minibuffer|review|view/update|math_panels|vcs|\n
4133 view-others|update-others
4134 * \li Origin: spitz, 17 Dec 2020
4137 { LFUN_TOOLBAR_SET, "toolbar-set", NoBuffer, Buffer },
4140 * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
4141 * \li Action: Toggles visibility of a given toolbar between on/off/auto.
4142 * \li Notion: Skipping "auto" when allowauto is false.
4143 * \li Syntax: toolbar-toggle <NAME> [allowauto]
4144 * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|\n
4145 minibuffer|review|view/update|math_panels|vcs|\n
4146 view-others|update-others
4147 * \li Origin: Edwin, 21 May 2007
4150 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
4153 * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
4154 * \li Action: Various UI visibility-toggling actions.
4155 * \li Syntax: ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
4156 * \li Params: statusbar : Toggle visibility of the statusbar.\n
4157 menubar : Toggle visibility of the menubar.\n
4158 scrollbar : Toggle visibility of the scrollbar.\n
4159 frame : Toggle visibility of the frames around editing window.\n
4160 zoomslider : Toggle visibility of the zoom slider in statusbar.\n
4161 zoomlevel : Toggle visibility of the zoom level display in statusbar.\n
4162 statistics-w : Toggle visibility of the document word count in statusbar.\n
4163 statistics-cb : Toggle visibility of the document character count (incl. blanks)
4165 statistics-c : Toggle visibility of the document character count (excl. blanks)
4167 fullscreen : Toggle fullscreen mode. This also covers calling the
4168 previous functions. However #LFUN_TOOLBAR_TOGGLE for the
4169 custom tweaks of the toolbars should be used.
4170 * \li Origin: sanda, 9 Feb 2007
4173 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
4177 * \var lyx::FuncCode lyx::LFUN_UNDO
4178 * \li Action: Undoes the last edit.
4182 { LFUN_UNDO, "undo", ReadOnly, Edit },
4185 * \var lyx::FuncCode lyx::LFUN_UNICODE_INSERT
4186 * \li Action: Inserts a single unicode character.
4187 * \li Syntax: unicode-insert <CHAR1> <CHAR2> ...
4188 * \li Params: <CHARn>: The character to insert, given as its code
4189 point, in hexadecimal.
4190 * \li Sample: unicode-insert 0x0100 0x0259
4191 * \li Origin: Lgb, 22 Oct 2006
4194 { LFUN_UNICODE_INSERT, "unicode-insert", Noop, Edit },
4197 * \var lyx::FuncCode lyx::LFUN_UP
4198 * \li Action: Moves the cursor one line in upward direction.
4202 { LFUN_UP, "up", ReadOnly | NoUpdate, Edit },
4205 * \var lyx::FuncCode lyx::LFUN_UP_SELECT
4206 * \li Action: Moves the cursor one line in upward direction adding the current
4207 position to the selection.
4208 * \li Syntax: up-select
4211 { LFUN_UP_SELECT, "up-select", ReadOnly | SingleParUpdate, Edit },
4214 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_IN
4215 * \li Action: Checks-in/commits the changes of the registered file to the repository.
4216 * \li Notion: In RCS case this also unlocks the file.
4217 * \li Syntax: vc-check-in
4218 * \li Origin: Lgb, 1 Jul 1997
4221 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
4224 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_OUT
4225 * \li Action: Checks-out the document for edit (and locks it in some cases).
4226 * \li Syntax: vc-check-out
4227 * \li Origin: Lgb, 1 Jul 1997
4230 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
4233 * \var lyx::FuncCode lyx::LFUN_VC_COMMAND
4234 * \li Action: Executes external command. This command is intended to support
4235 additional VCS commands.
4236 * \li Syntax: vc-command <FLAG> <PATH> <COMMAND>
4237 * \li Params: <FLAG>: Flags for the command can be combined together.\n
4238 U - dUmmy - no flags \n
4239 D - Doc - need document loaded to proceed \n
4240 I - dIrty - mark document dirty \n
4241 R - Reload - ensure that the document is saved and reload it after command execution \n
4242 M - Message - ask for input string (commit message)\n
4243 <PATH>: path where to start. $$p will be replaced by the current document path.\n
4244 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current
4245 document(with absolute path)/path/message.
4246 * \li Sample: vc-command DR $$p "svn up"
4247 * \li Origin: sanda, 13 Jan 2009
4250 { LFUN_VC_COMMAND, "vc-command", NoBuffer | ReadOnly, System },
4253 * \var lyx::FuncCode lyx::LFUN_VC_COMPARE
4254 * \li Action: Compares two revisions of the same file under version control.
4255 * \li Syntax: vc-compare [<REV1>] [<REV2>]
4256 * \li Params: Revision number either points directly to commit in history
4257 or if negative number -x it points to (last commit - x).\n
4258 In RCS we subtract only in the last number of revision specification.
4259 Special case "0" is reserved for the last committed revision.\n
4260 <REV1>: Older file.\n
4261 <REV2>: Newer file. Used only if REV1 > 0.\n
4262 If no parameter is given, interactive dialog will be shown.
4263 * \li Sample: Compare current document against last commit\n
4265 Compare current document against current revision - 5 commits\n
4267 Compare revisions 120 and 155\n
4269 * \li Origin: sanda, 12 Feb 2010
4272 { LFUN_VC_COMPARE, "vc-compare", ReadOnly, System },
4276 * \var lyx::FuncCode lyx::LFUN_VC_COPY
4277 * \li Action: Copies the document to another name.
4278 * \li Notion: Copying with revision history is only supported by SVN.
4279 For RCS and CVS it is simulated by adding the document
4281 Disabled if uncommitted changes exist.
4282 * \li Syntax: vc-copy <FILENAME>
4283 * \li Params: <FILENAME>: New name of the document.\n
4284 * A file dialog is opened if no filename is given.
4285 * \li Origin: gb, 05 Feb 2013
4288 { LFUN_VC_COPY, "vc-copy", ReadOnly, System },
4291 * \var lyx::FuncCode lyx::LFUN_VC_LOCKING_TOGGLE
4292 * \li Action: Toggles the locking property of the edited file.
4293 * \li Notion: This is currently implemented only for SVN.
4294 * \li Syntax: vc-locking-toggle
4295 * \li Origin: sanda, 25 Jun 2009
4298 { LFUN_VC_LOCKING_TOGGLE, "vc-locking-toggle", ReadOnly, System },
4301 * \var lyx::FuncCode lyx::LFUN_VC_REGISTER
4302 * \li Action: Register the document as an file inside version control system.
4303 * \li Notion: File is registered inside cvs, svn or rcs repository acording to the existence
4304 of cvs/svn/rcs entries in the document's directory. \n
4305 See LyX Additional Features Manual (Version Control Chapter) for additional
4307 * \li Syntax: vc-register
4308 * \li Origin: Lgb, 1 Jul 1997
4311 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
4314 * \var lyx::FuncCode lyx::LFUN_VC_RENAME
4315 * \li Action: Renames the document to another name.
4316 * \li Notion: Renaming with revision history is only supported by SVN.
4317 For CVS it is simulated by adding the document under a new
4318 name and deleting the old one. For RCS it is not supported.
4319 Disabled if uncommitted changes exist.
4320 * \li Syntax: vc-rename <FILENAME>
4321 * \li Params: <FILENAME>: New name of the document.\n
4322 * A file dialog is opened if no filename is given.
4323 * \li Origin: gb, 05 Feb 2013
4326 { LFUN_VC_RENAME, "vc-rename", ReadOnly, System },
4329 * \var lyx::FuncCode lyx::LFUN_VC_REPO_UPDATE
4330 * \li Action: Update the local archive directory in which resides
4331 the current document with the remote repository.
4332 * \li Syntax: vc-repo-update
4333 * \li Origin: sanda, 16 Oct 2009
4336 { LFUN_VC_REPO_UPDATE, "vc-repo-update", ReadOnly, System },
4339 * \var lyx::FuncCode lyx::LFUN_VC_REVERT
4340 * \li Action: Reverts the document to the last check-in/commit in VCS.
4341 * \li Syntax: vc-revert
4342 * \li Origin: Lgb, 1 Jul 1997
4345 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
4348 * \var lyx::FuncCode lyx::LFUN_VC_UNDO_LAST
4349 * \li Action: Undo last check-in.
4350 * \li Notion: This is currently implemented only for RCS.
4351 * \li Syntax: vc-check-out
4352 * \li Origin: Lgb, 1 Jul 1997
4355 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
4358 * \var lyx::FuncCode lyx::LFUN_VIEW_CLOSE
4359 * \li Action: Close the current document work area.
4360 * \li Notion: Close the current work area. If no other work areas are showing the buffer,
4361 then close the associated buffer as well.
4362 * \li Syntax: view-close
4363 * \li Origin: Tommaso, 15 Sep 2012
4366 { LFUN_VIEW_CLOSE, "view-close", ReadOnly, Buffer },
4370 * \var lyx::FuncCode lyx::LFUN_VIEW_SPLIT
4371 * \li Action: Creates another split view of current buffer.
4372 * \li Notion: All split views act in the same way independently.
4373 * \li Syntax: view-split <vertical|horizontal>
4374 * \li Params: horizontal : The work areas are laid out side by side.\n
4375 vertical : The work areas laid out vertically.
4376 * \li Origin: Abdel, 20 Feb 2008
4379 { LFUN_VIEW_SPLIT, "view-split", ReadOnly, Buffer },
4383 * \var lyx::FuncCode lyx::LFUN_WINDOW_CLOSE
4384 * \li Action: Closes the current LyX window.
4385 * \li Syntax: window-close
4386 * \li Origin: Abdel, 23 Oct 2006
4389 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
4393 * \var lyx::FuncCode lyx::LFUN_WINDOW_NEW
4394 * \li Action: Creates new empty LyX window.
4395 * \li Notion: Already opened documents from the previous window can be found under View menu.
4396 * \li Syntax: window-new [<GEOMETRY>]
4397 * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently
4398 accepted only on Windows platform.
4399 * \li Origin: Abdel, 21 Oct 2006
4402 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
4405 * \var lyx::FuncCode lyx::LFUN_WINDOW_RAISE
4406 * \li Action: Raises the LyX window.
4407 * \li Notion: Brings the LyX window to the front. Such behavior is allowed
4408 on Windows only when no other application has focus.
4409 This action is used when LyX is in single instance mode.
4410 * \li Syntax: window-raise
4411 * \li Origin: forenr, 21 Apr 2020
4414 { LFUN_WINDOW_RAISE, "window-raise", ReadOnly | NoBuffer, Hidden },
4417 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD
4418 * \li Action: Moves the cursor to the logically previous beginning of a word.
4419 * \li Notion: This is not the action which should be bound to the arrow keys,
4420 because backwards may be left or right, depending on the
4421 language. The arrow keys should be bound to #LFUN_WORD_LEFT or
4422 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
4423 * \li Syntax: word-backward
4426 { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit },
4429 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD_SELECT
4430 * \li Action: Moves the cursor to the logically previous beginning of a word,
4431 adding the logically traversed text to the selection.
4432 * \li Notion: See also #LFUN_WORD_BACKWARD.
4433 * \li Syntax: word-backward-select
4436 { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
4439 * \var lyx::FuncCode lyx::LFUN_WORD_CAPITALIZE
4440 * \li Action: Capitalizes the words in the selection (i.e. the first letters)
4441 or the first letter of word at cursor position.
4442 * \li Syntax: word-capitalize [<SEL_TYPE>]
4443 * \li Params: <SEL_TYPE>: if this is equal to "partial", then the
4444 * default word starts at cursor position (emacs-style).
4445 * Otherwise, the whole word is considered.
4448 { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
4451 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_BACKWARD
4452 * \li Action: Deletes characters to the beginning of the word (usually the "C+BackSpace" key).
4453 * \li Syntax: word-delete-backward [confirm]
4454 * \li Params: confirm: Select big insets, do not directly delete them.
4457 { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
4460 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_FORWARD
4461 * \li Action: Deletes characters to the end of the word (usually the "C+Delete" key).
4462 * \li Syntax: word-delete-forward [confirm]
4463 * \li Params: confirm: Select big insets, do not directly delete them.
4466 { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
4469 * \var lyx::FuncCode lyx::LFUN_WORD_FIND
4470 * \li Action: Search for next occurrence of a string.
4471 * \li Syntax: word-find [<DATA>]
4472 * \li Params: <DATA>: data encoded from Find dialog (see #lyx::find2string()).
4473 If no parameter is given, search with last find-dialog
4474 data is used for search (i.e. find-next).
4475 * \li Origin: Andre, Jan 7 2004
4478 { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
4481 * \var lyx::FuncCode lyx::LFUN_SEARCH_STRING_SET
4482 * \li Action: Set search string buffer.
4483 * \li Syntax: search-string-set [<DATA>]
4484 * \li Params: <DATA>: string to search for. If no parameter is given,
4485 * use (word under) selection.
4486 * \li Origin: stwitt, spitz, Feb 12 2021
4489 { LFUN_SEARCH_STRING_SET, "search-string-set", ReadOnly, Edit },
4492 * \var lyx::FuncCode lyx::LFUN_WORD_FINDADV
4493 * \li Action: Search for next occurrence of a pattern.
4494 * \li Syntax: word-findadv [<DATA>]
4495 * \li Params: <DATA>: data encoded from FindAdv dialog (see #lyx::findadv2string()).
4496 If no parameter is given, search with last find-dialog
4497 data is used for search (i.e. find-next).
4498 * \li Origin: Tommaso, Nov 15 2007
4501 { LFUN_WORD_FINDADV, "word-findadv", ReadOnly | NoBuffer, Edit },
4504 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_BACKWARD
4505 * \li Action: Search for a given string in backward direction.
4506 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
4507 * \li Syntax: word-find-backward [<STRING>]
4508 * \li Origin: Etienne, 20 Feb 1998
4511 { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
4514 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_FORWARD
4515 * \li Action: Search for a given string in forward direction.
4516 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
4517 * \li Syntax: word-find-forward [<STRING>]
4518 * \li Origin: Etienne, 16 Feb 1998
4521 { LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit },
4524 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD
4525 * \li Action: Moves the cursor to the logically next beginning of a word.
4526 * \li Notion: This is not the action which should be bound to the arrow keys,
4527 because forward may be left or right, depending on the language.
4528 The arrow keys should be bound to #LFUN_WORD_LEFT or
4529 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
4530 * \li Syntax: word-forward
4533 { LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
4536 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD_SELECT
4537 * \li Action: Moves the cursor to the logically next beginning of a word,
4538 adding the logically traversed text to the selection.
4539 * \li Notion: See also #LFUN_WORD_FORWARD.
4540 * \li Syntax: word-forward-select
4543 { LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
4546 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT
4547 * \li Action: Moves the cursor to the next beginning of a word "on the left".
4548 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
4549 "left" key is pressed. Generally, it moves the cursor to the
4550 next beginning of a word on the left. However, in Bidi text this
4551 become slightly more complicated, and there are different modes
4552 of cursor movement. In "visual mode", this moves left, plain and
4553 simple. In "logical mode", movement is logically forward in RTL
4554 paragraphs, and logically backwards in LTR paragraphs.
4555 * \li Syntax: word-left
4556 * \li Origin: dov, 28 Oct 2007
4559 { LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
4562 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT_SELECT
4563 * \li Action: Moves the cursor to the next beginning of a word "on the left",
4564 adding *logically* traversed text to the selection.
4565 * \li Notion: See also #LFUN_WORD_LEFT for exact details of the movement.
4566 * \li Syntax: word-left-select
4567 * \li Origin: dov, 28 Oct 2007
4570 { LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit },
4573 * \var lyx::FuncCode lyx::LFUN_WORD_LOWCASE
4574 * \li Action: Change the words in the selection or word at cursor position
4576 * \li Syntax: word-lowcase [<SEL_TYPE>]
4577 * \li Params: <SEL_TYPE>: if this is equal to "partial", then the
4578 * default word starts at cursor position (emacs-style).
4579 * Otherwise, the whole word is considered.
4582 { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
4585 * \var lyx::FuncCode lyx::LFUN_WORD_REPLACE
4586 * \li Action: Replace a string in the document.
4587 * \li Syntax: word-replace [<DATA>]
4588 * \li Params: <DATA>: data is of the form
4591 <casesensitive> <matchword> <all> <forward> <findnext>"
4592 * \li Origin: Andre, Jan 7 2004
4595 { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
4598 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT
4599 * \li Action: Moves the cursor to the next beginning of a word "on the right".
4600 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
4601 "right" key is pressed. Generally, it moves the cursor to the
4602 next beginning of a word on the right. However, in Bidi text
4603 this become slightly more complicated, and there are different
4604 modes of cursor movement. In "visual mode", this moves right,
4605 plain and simple. In "logical mode", movement is logically
4606 forward in LTR paragraphs, and logically backwards in RTL
4608 * \li Syntax: word-right
4609 * \li Origin: dov, 28 Oct 2007
4612 { LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit },
4615 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT_SELECT
4616 * \li Action: Moves the cursor to the next beginning of a word "on the right",
4617 adding *logically* traversed text to the selection.
4618 * \li Notion: See also #LFUN_WORD_RIGHT for exact details of the movement.
4619 * \li Syntax: word-right-select
4620 * \li Origin: dov, 28 Oct 2007
4623 { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
4626 * \var lyx::FuncCode lyx::LFUN_WORD_SELECT
4627 * \li Action: Puts the word where the cursor stands into the selection.
4628 * \li Syntax: word-select
4629 * \li Origin: Andre, 11 Sep 2002
4632 { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
4635 * \var lyx::FuncCode lyx::LFUN_WORD_UPCASE
4636 * \li Action: Change the words in the selection or word at cursor position
4638 * \li Syntax: word-upcase [<SEL_TYPE>]
4639 * \li Params: <SEL_TYPE>: if this is equal to "partial", then the
4640 * default word starts at cursor position (emacs-style).
4641 * Otherwise, the whole word is considered.
4644 { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
4647 * \var lyx::FuncCode lyx::LFUN_WRAP_INSERT
4648 * \li Action: Inserts floats wrapped by the text around.
4649 * \li Syntax: wrap-insert <TYPE>
4650 * \li Params: <TYPE>: table|figure
4651 * \li Origin: Dekel, 7 Apr 2002
4654 { LFUN_WRAP_INSERT, "wrap-insert", Noop, Edit },
4656 { LFUN_NOACTION, "", Noop, Hidden }
4657 #ifndef DOXYGEN_SHOULD_SKIP_THIS
4660 for (int i = 0; items[i].action != LFUN_NOACTION; ++i)
4661 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
4667 LyXAction::LyXAction()
4673 FuncRequest LyXAction::lookupFunc(string const & func_name) const
4675 string const func2 = trim(func_name);
4678 return FuncRequest(LFUN_NOACTION);
4681 string const arg = split(func2, cmd, ' ');
4683 FuncMap::const_iterator const fit = lyx_func_map.find(cmd);
4685 return fit != lyx_func_map.end()
4686 ? FuncRequest(fit->second, arg)
4687 : FuncRequest(LFUN_UNKNOWN_ACTION);
4691 string const LyXAction::getActionName(FuncCode action) const
4693 InfoMap::const_iterator const it = lyx_info_map.find(action);
4694 return it != lyx_info_map.end() ? it->second.name : string();
4698 LyXAction::FuncType LyXAction::getActionType(FuncCode action) const
4700 InfoMap::const_iterator const it = lyx_info_map.find(action);
4701 return it != lyx_info_map.end() ? it->second.type : Hidden;
4705 bool LyXAction::funcHasFlag(FuncCode action,
4706 LyXAction::FuncAttribs flag) const
4708 InfoMap::const_iterator ici = lyx_info_map.find(action);
4710 if (ici == lyx_info_map.end()) {
4711 LYXERR0("action: " << action << " is not known.");
4712 LASSERT(false, return false);
4715 return ici->second.attrib & flag;
4719 LyXAction::const_iterator LyXAction::begin() const
4721 return lyx_func_map.begin();
4725 LyXAction::const_iterator LyXAction::end() const
4727 return lyx_func_map.end();
4731 LyXErr & operator<<(LyXErr & l, FuncCode code)
4734 l.stream() << lyxaction.getActionName(code);