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 },
336 * \var lyx::FuncCode lyx::LFUN_BIDI
337 * \li Action: Helper function for bidirectional toolbar icons
338 * \li Notion: In a text, the function is marked as `unknown' when the
339 current direction does not correspond to DIRECTION (ltr
340 or rtl). Otherwise the function behaves exactly as
341 ACTION. The result is that ACTION will be associated to
342 a different icon depending on text direction.
343 * \li Syntax: bidi <DIRECTION> <ACTION>
344 * \li Origin: JMarc, 21 July 2019
347 { LFUN_BIDI, "bidi", Noop, System },
350 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
351 * \li Action: Clears the list of saved bookmarks.
352 * \li Syntax: bookmark-clear
353 * \li Origin: bpeng, 31 October 2006
356 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
360 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
361 * \li Action: Moves the cursor to the numbered bookmark, opening the file
362 if necessary. Note that bookmarks are saved per-session, not
364 * \li Notion: Bookmark 0 has a special purpose. It is automatically set \n
365 1. to the paragraph you are currently editing \n
366 2. to the paragraph from where you are jumping to the last-edited
367 position (jump-back feature) \n
368 3. when jumping from crossreference to the requested label by
370 * \li Syntax: bookmark-goto <NUMBER>
371 * \li Params: <NUMBER>: the number of the bookmark to restore.
372 * \li Origin: Dekel, 27 January 2001
375 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
378 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
379 * \li Action: Save a bookmark.
380 * \li Notion: Saves a numbered bookmark to the sessions file. The number
381 must be between 1 and 9, inclusive. Note that bookmarks are
382 saved per-session, not per file.
383 * \li Syntax: bookmark-save <NUMBER>
384 * \li Params: <NUMBER>: the number of the bookmark to save.
385 * \li Origin: Dekel, 27 January 2001
388 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
391 * \var lyx::FuncCode lyx::LFUN_BOX_INSERT
392 * \li Action: Inserts Box inset.
393 * \li Syntax: box-insert [<TYPE>]
394 * \li Params: <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox \n
395 Framed is the default one.
396 * \li Origin: vermeer, 7 Oct 2003
399 { LFUN_BOX_INSERT, "box-insert", Noop, Edit },
402 * \var lyx::FuncCode lyx::LFUN_BRANCHES_RENAME
403 * \li Action: Rename all branches of a given name in a document.
404 * \li Syntax: branches-rename <OLDNAME> <NEWNAME>
405 * \li Params: <OLDNAME>: Current name of the branch to be renamed
406 * <NEWNAME>: New name of the branch
407 * \li Origin: spitz, 9 Jul 2009
410 { LFUN_BRANCHES_RENAME, "branches-rename", Noop, Buffer },
413 * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
414 * \li Action: Activate the branch.
415 * \li Syntax: branch-activate <BRANCH>
416 * \li Params: <BRANCH>: The branch to activate
417 * \li Sample: lyx -x "branch-activate answers" -e pdf2 finalexam.lyx \n
418 could be used to export a pdf with the answers branch included
419 without one's having to open LyX and activate the branch manually.
420 * \li Origin: rgh, 27 May 2008
423 { LFUN_BRANCH_ACTIVATE, "branch-activate", AtPoint, Buffer },
426 * \var lyx::FuncCode lyx::LFUN_BRANCH_ADD
427 * \li Action: Add a branch to the buffer's BranchList.
428 * \li Syntax: branch-add <BRANCH>
429 * \li Params: <BRANCH>: Name of the branch to add
430 * \li Origin: spitz, 7 Jul 2009
433 { LFUN_BRANCH_ADD, "branch-add", AtPoint, Buffer },
438 * \var lyx::FuncCode lyx::LFUN_BRANCH_ADD_INSERT
439 * \li Action: Create new branch and directly put the branch inset into
441 * \li Syntax: branch-add-insert [<NAME>]
442 * \li Params: <NAME>: Branch name. If it is not specified, you will be asked.
443 * \li Origin: sanda, 10 Jul 2009
446 { LFUN_BRANCH_ADD_INSERT, "branch-add-insert", Noop, Buffer },
451 * \var lyx::FuncCode lyx::LFUN_BRANCH_DEACTIVATE
452 * \li Action: De-activate the branch.
453 * \li Syntax: branch-deactivate <BRANCH>
454 * \li Params: <BRANCH>: The branch to deactivate
455 * \li Origin: rgh, 27 May 2008
458 { LFUN_BRANCH_DEACTIVATE, "branch-deactivate", AtPoint, Buffer },
461 * \var lyx::FuncCode lyx::LFUN_BRANCH_INSERT
462 * \li Action: Inserts branch inset.
463 * \li Syntax: branch-insert <BRANCH-NAME>
464 * \li Origin: vermeer, 17 Aug 2003
467 { LFUN_BRANCH_INSERT, "branch-insert", Noop, Edit },
470 * \var lyx::FuncCode lyx::LFUN_BRANCH_INVERT
471 * \li Action: Toggles inversion status of branch inset.
472 * \li Syntax: branch-invert
473 * \li Origin: rgheck, 12 July 2016
476 { LFUN_BRANCH_INVERT, "branch-invert", AtPoint, Buffer },
480 * \var lyx::FuncCode lyx::LFUN_BRANCH_MASTER_ACTIVATE
481 * \li Action: Activate the branch in the master buffer.
482 * \li Syntax: branch-master-activate <BRANCH>
483 * \li Params: <BRANCH>: The branch to activate
484 * \li Sample: lyx -x "branch-activate answers" -e pdf2 finalexam.lyx \n
485 could be used to export a pdf with the answers branch included
486 without one's having to open LyX and activate the branch manually.
487 * \li Origin: spitz, 30 Sep 2012
490 { LFUN_BRANCH_MASTER_ACTIVATE, "branch-master-activate", AtPoint, Buffer },
493 * \var lyx::FuncCode lyx::LFUN_BRANCH_MASTER_DEACTIVATE
494 * \li Action: De-activate the branch in the master buffer.
495 * \li Syntax: branch-master-deactivate <BRANCH>
496 * \li Params: <BRANCH>: The branch to deactivate
497 * \li Origin: spitz, 30 Sep 2012
500 { LFUN_BRANCH_MASTER_DEACTIVATE, "branch-master-deactivate", AtPoint, Buffer },
504 * \var lyx::FuncCode lyx::LFUN_BUFFER_ANONYMIZE
505 * \li Action: For debug purposes only. Convert all [a-zA-Z0-1] characters to
506 single character. Useful when submitting docs to list or bugzilla.
507 * \li Syntax: buffer-anonymize
508 * \li Origin: sanda, Feb 1 2018
511 { LFUN_BUFFER_ANONYMIZE, "buffer-anonymize", Noop, Edit },
515 * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
516 * \li Action: Saves the current buffer to a temporary file.
517 * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
518 is called automatically by LyX, to "autosave" the current buffer.
519 * \li Syntax: buffer-auto-save
522 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
525 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN
526 * \li Action: Move the cursor to the beginning of the document.
527 * \li Syntax: buffer-begin
530 { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
533 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN_SELECT
534 * \li Action: Move the cursor to the beginning of the document adding the
535 traversed text to the selection.
536 * \li Syntax: buffer-begin-select
539 { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
542 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHILD_OPEN
543 * \li Action: Loads the given child document.
544 * \li Notion: The current document is treated as a parent.
545 * \li Syntax: buffer-child-open <FILE>
546 * \li Params: <FILE>: Filename of the child. The directory of the parent is assumed by default.
547 * \li Origin: Ale, 28 May 1997
550 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
553 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHKTEX
554 * \li Action: Runs chktex for the current document.
555 * \li Syntax: buffer-chktex
556 * \li Origin: Asger, 30 Oct 1997
559 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
562 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
563 * \li Action: Closes the current buffer.
564 * \li Notion: Closes the current buffer, asking whether to save it, etc,
565 if the buffer has been modified.
566 * \li Syntax: buffer-close
569 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
572 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE_ALL
573 * \li Action: Closes all buffers.
574 * \li Notion: Closes all buffers, asking whether to save it, etc,
575 if a buffer has been modified.
576 * \li Syntax: buffer-close-all
579 { LFUN_BUFFER_CLOSE_ALL, "buffer-close-all", ReadOnly, Buffer },
582 * \var lyx::FuncCode lyx::LFUN_BUFFER_END
583 * \li Action: Move the cursor to the end of the document.
584 * \li Syntax: buffer-end
587 { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
590 * \var lyx::FuncCode lyx::LFUN_BUFFER_END_SELECT
591 * \li Action: Move the cursor to the end of the document adding the
592 traversed text to the selection.
593 * \li Syntax: buffer-end-select
596 { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
600 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
601 * \li Action: Exports the current buffer (document) to the given format.
602 * \li Syntax: buffer-export [<FORMAT>] [<DEST>]
603 * \li Params: <FORMAT> is either "custom" or one of the formats which you
604 can find in Tools->Preferences->File formats->Format.
605 Usual format you will enter is "pdf2" (pdflatex),
606 "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
607 In case of "custom" you will be asked for a format you
608 want to start from and for the command that you want to
609 apply to this format. Internally the control is then passed
610 to #LFUN_BUFFER_EXPORT_CUSTOM.\n
611 If absent or "default", then the default output format of the
613 <DEST> If present, this argument provides the export destination
614 filename. Its containing folder will also be the destination
615 folder, where all the needed external files will be copied.
616 * \li Origin: Lgb, 29 Jul 1997
619 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
622 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_AS
623 * \li Action: Opens a dialog for exporting the current buffer.
624 * \li Syntax: buffer-export-as [<FORMAT>]
625 * \li Params: <FORMAT> is the export format initially selected in the dialog.
626 * You can pass any of the formats which you can find in
627 * Tools->Preferences->File formats->Format, provided it
628 * has the "document" flag set. If no format is specified
629 * the dialog will start with the default output format of
630 * the current document.
631 * \li Sample: buffer-export-as pdf2
632 * \li Origin: tommaso, 6 Oct 2011
635 { LFUN_BUFFER_EXPORT_AS, "buffer-export-as", ReadOnly, Buffer },
638 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
639 * \li Action: Exports the current buffer (document) from the given format using
640 the given command on it.
641 * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
642 * \li Params: <FORMAT> format to start from (LyX will care to produce such
643 intermediate file).\n
644 <COMMAND> this command will be launched on the file. Note that you can
645 use "$$FName" string to qualify the intermediate file.
646 * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
647 * \li Origin: leeming, 27 Mar 2004
650 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
653 * \var lyx::FuncCode lyx::LFUN_BUFFER_FORALL
654 * \li Action: Applies a command to all non-hidden buffers.
655 * \li Notion: a buffer is `hidden' if it is internally open in LyX, but not
656 visible in any window.
657 * \li Syntax: buffer-forall <LFUN-COMMAND>
658 * \li Params: <LFUN-COMMAND>: The command to be applied to the buffers.
659 * \li Sample: Close all Notes in buffers: \n
660 buffer-forall inset-forall Note inset-toggle close \n
661 Toggle change tracking on buffers: \n
662 buffer-forall changes-track \n
663 Toggle read-only for buffers: \n
664 buffer-forall buffer-toggle-read-only \n
665 Show statistics for individual buffers: \n
666 buffer-forall statistics \n
667 Activate the branch named "Solutions" in buffers: \n
668 buffer-forall branch-activate Solutions \n
669 Export buffers to PDF (pdflatex): \n
670 buffer-forall buffer-export pdf2 \n
671 * \li Origin: skostysh, 20 Jul 2012
674 { LFUN_BUFFER_FORALL, "buffer-forall", ReadOnly | Argument, Buffer },
677 * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
678 * \li Action: Import a given file as a lyx document.
679 * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
680 defined converters in preferences. Look in the File->Import menu to get
681 an idea of the currently active import formats.
682 * \li Syntax: buffer-import <FORMAT> [<FILE>]
683 * \li Origin: Asger, 24 Jul 1998
686 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
689 * \var lyx::FuncCode lyx::LFUN_BUFFER_LANGUAGE
690 * \li Action: Set language of the current document.
691 * \li Syntax: buffer-language <LANG>
692 * \li Params: <LANG>: language name. See lib/languages for list.
693 * \li Origin: leeming, 30 Mar 2004
696 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
699 * \var lyx::FuncCode lyx::LFUN_BUFFER_MOVE_NEXT
700 * \li Action: Moves the current tab one spot to the right.
701 * \li Syntax: buffer-move-next
702 * \li Origin: skostysh, 7 Apr 2015
705 { LFUN_BUFFER_MOVE_NEXT, "buffer-move-next", ReadOnly, Buffer },
708 * \var lyx::FuncCode lyx::LFUN_BUFFER_MOVE_PREVIOUS
709 * \li Action: Moves the current tab one spot to the left.
710 * \li Syntax: buffer-move-previous
711 * \li Origin: skostysh, 7 Apr 2015
714 { LFUN_BUFFER_MOVE_PREVIOUS, "buffer-move-previous", ReadOnly, Buffer },
717 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
718 * \li Action: Creates a new buffer (that is, document) and switches to it.
719 * \li Notion: Implicit path can be set in Preferences dialog.
720 * \li Syntax: buffer-new [<FILE>]
721 * \li Params: <FILE>: filename of created file with absolute path.
724 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
727 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
728 * \li Action: Creates a new buffer (that is, document) from a template.
729 * \li Notion: Path for new files and templates can be set in Preferences dialog.
730 Template will be asked for via Open-dialog.
731 * \li Syntax: buffer-new-template [<FILE>] [<TEMPLATE FILE>]
732 * \li Params: <FILE>: filename of created file with absolute path. If empty
733 * or "newfile", a file with appropriate name is generated.
734 * <TEMPLATE FILE>: filename of template with absolute path. If empty,
735 * a dialog is opened to select the new file.
738 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
741 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEXT
742 * \li Action: Switch to the next opened document.
743 * \li Notion: Note that this does not necessarily mean next in tabbar
744 (for full list see View menu).
745 * \li Syntax: buffer-next
748 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
751 * \var lyx::FuncCode lyx::LFUN_BUFFER_PARAMS_APPLY
752 * \li Action: Apply the given settings to the current document.
753 * \li Syntax: buffer-params-apply [<ARGS>]
754 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
755 you can find in document header of usual .lyx file.
756 * \li Origin: leeming, 30 Mar 2004
759 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", NoInternal, Buffer },
763 * \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS
764 * \li Action: Switch to the previous opened document.
765 * \li Syntax: buffer-previous
768 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
771 * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
772 * \li Action: Reverts opened document.
773 * \li Syntax: buffer-reload [dump]
774 * \li Params: dump: do not ask for any confirmation, just reload. All changes will be lost.
775 * \li Origin: Asger, 2 Feb 1997
778 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
781 * \var lyx::FuncCode lyx::LFUN_BUFFER_RESET_EXPORT
782 * \li Action: Removes the auxiliary file before next export to assure export is done afresh.
783 * \li Syntax: buffer-reset-export
784 * \li Origin: spitz, 27 Dec 2019
787 { LFUN_BUFFER_RESET_EXPORT, "buffer-reset-export", ReadOnly, Buffer },
790 * \var lyx::FuncCode lyx::LFUN_BUFFER_SAVE_AS_DEFAULT
791 * \li Action: Save the current document settings as default.
792 * \li Notion: The file will will be saved into ~/.lyx/templates/defaults.lyx .
793 * \li Syntax: buffer-save-as-default [<ARGS>]
794 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
795 you can find in document header of usual .lyx file.
796 * \li Origin: leeming, 30 Mar 2004
799 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
802 * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
803 * \li Action: Display and switch to the given buffer.
804 * \li Syntax: buffer-switch <BUFFER>
805 * \li Params: <BUFFER>: path and filename of already opened (but possibly hidden)
806 document which is to be shown.
809 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
812 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
813 * \li Action: Toggles compression of the current document on/off.
814 * \li Syntax: buffer-toggle-compression
815 * \li Origin: bpeng, 27 Apr 2006
818 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
821 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_OUTPUT_SYNC
822 * \li Action: Toggles including of resources for forward/reverse search of the given document.
823 * \li Notion: When toggled on, SyncTeX is invoked for PDF, while srcltx package
824 is used for DVI. Custom LaTeX macro can be defined in preferences.
825 * \li Syntax: buffer-toggle-output-sync
826 * \li Origin: sanda, 25 May 2010
829 { LFUN_BUFFER_TOGGLE_OUTPUT_SYNC, "buffer-toggle-output-sync", Noop, System },
832 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
833 * \li Action: Toggle editing mode of the current document between read/write and read-only.
834 * \li Notion: This function is not allowed if the file is under version control, since
835 read-only flag is often used in version control file locking.
836 * \li Syntax: buffer-toggle-read-only
837 * \li Origin: Lgb, 27 May 1997
840 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
843 * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
844 * \li Action: Exports the current document and put the result into the
846 * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
847 the output will be rewritten - updated. This is useful in case your viewer
848 is able to detect such changes (e.g. ghostview for postscript).
849 * \li Syntax: buffer-update [<FORMAT>]
850 * \li Params: <FORMAT>: The format to display, where this is one of the
851 formats defined (in the current GUI) in the
852 Tools>Preferences>File Formats dialog.
853 If no format is given, the default format as
854 specified in the same dialog is used.
855 * \li Origin: Dekel, 5 Aug 2000
858 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
862 * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
863 * \li Action: Displays current buffer in chosen format.
864 * \li Notion: Displays the contents of the current buffer in the chosen
865 format, for example, PDF or DVI. This runs the necessary
866 converter, calls the defined viewer, and so forth.
867 * \li Syntax: buffer-view [<FORMAT>]
868 * \li Params: <FORMAT>: The format to display, where this is one of the
869 formats defined (in the current GUI) in the
870 Tools>Preferences>File Formats dialog.
871 If no format is given, the default format as
872 specified in the same dialog is used.
875 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
878 * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW_CACHE
879 * \li Action: Opens the file that was created from last preview of this buffer.
880 * \li Notion: This LFUN is called by the "Show Output Anyway" button in the LaTeX
881 * Errors dialog. It can also be called by the user, which is useful
882 * if the document takes a long time to compile, and you just
883 * want to see the last previewed version.
884 * \li Syntax: buffer-view-cache
887 { LFUN_BUFFER_VIEW_CACHE, "buffer-view-cache", ReadOnly, Buffer },
890 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
891 * \li Action: Saves the current buffer.
892 * \li Notion: Saves the current buffer to disk, using the filename that
893 is already associated with the buffer, asking for one if
894 none is yet assigned.
895 * \li Syntax: buffer-write [force]
896 * \li Params: force: write even if buffer is clean.
899 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
902 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
903 * \li Action: Save all changed documents.
904 * \li Syntax: buffer-write-all
905 * \li Origin: rgh, gpothier 6 Aug 2007
908 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
911 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
912 * \li Action: Rename and save current buffer.
913 * \li Syntax: buffer-write-as <FILENAME>
914 * \li Params: <FILENAME>: New name of the buffer/file. A relative path
915 is with respect to the original location of the buffer/file.
918 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
921 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS_TEMPLATE
922 * \li Action: Rename and save current buffer in the local templates directory.
923 * \li Syntax: buffer-write-as-template <FILENAME>
924 * \li Params: <FILENAME>: New name of the buffer/file. A relative path
925 is with respect to the original location of the buffer/file.
928 { LFUN_BUFFER_WRITE_AS_TEMPLATE, "buffer-write-as-template", ReadOnly, Buffer },
932 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXTERNAL_MODIFICATION_CLEAR
933 * \li Action: Clear the external modification flag on the current buffer.
934 * \li Syntax: buffer-external-modification-clear
935 * \li Origin: gm, 2 March 2017
938 { LFUN_BUFFER_EXTERNAL_MODIFICATION_CLEAR,
939 "buffer-external-modification-clear", ReadOnly, Buffer },
942 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM
943 * \li Action: Sets the zoom of the screen fonts.
944 * \li Syntax: buffer-zoom [<ZOOM>]
945 * \li Params: <ZOOM>: The target zoom value in %;
946 * the default is the default zoom as saved in preferences.
947 * \li Origin: daniel, 28 Oct 2016
950 { LFUN_BUFFER_ZOOM, "buffer-zoom", ReadOnly, Buffer },
953 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_IN
954 * \li Action: Increases the zoom of the screen fonts.
955 * \li Syntax: buffer-zoom-in [<ZOOM>]
956 * \li Params: <ZOOM>: The zoom value addition in % (neg. or pos.);
957 * the default is 10% of the default zoom as saved in preferences.
958 * \li Origin: vfr, 30 Mar 2009
961 { LFUN_BUFFER_ZOOM_IN, "buffer-zoom-in", ReadOnly, Buffer },
965 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_OUT
966 * \li Action: Decreases the zoom of the screen fonts.
967 * \li Syntax: buffer-zoom-out [<ZOOM>]
968 * \li Params: <ZOOM>: The zoom value abstraction in % (neg. or pos.);
969 * the default is 10% of the default zoom as saved in preferences.
970 * \li Origin: vfr, 30 Mar 2009
973 { LFUN_BUFFER_ZOOM_OUT, "buffer-zoom-out", ReadOnly, Buffer },
977 * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
978 * \li Action: Generates the code (literate programming).
979 * \li Notion: Latex file with extension \literate_extension is generated.
980 Then LyX invokes \build_command (with a default of ``make'') to generate the code and
981 \build_error_filter to process the compilation error messages. \n
982 In case you want to process your literate file with a script, or some other program,
983 just insert in your lyxrc file an entry with:\n
984 \build_command "my_script my_arguments" \n
985 The \build_error_filter differs from the \literate_error_filter only in that the
986 former will identify error messages from your compiler.
987 * \li Syntax: build-program
990 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
994 * \var lyx::FuncCode lyx::LFUN_CALL
995 * \li Action: Executes a command defined in a .def file.
996 * \li Notion: The definitions are by default read from lib/commands/default.def.\n
997 A .def file allows to define a command with \define "<NAME>" "<LFUN>"
998 where <NAME> is the name of the new command and <LFUN> is the lfun code
999 to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
1000 \def_file "FileName" allows to include another .def file. \n
1001 This is particularly useful in connection with toolbar buttons:
1002 Since the name of the button image for this lfun is
1003 lib/images/commands/<NAME>.png this is the way to assign an image
1004 to a complex command-sequence.
1005 * \li Syntax: call <NAME>
1006 * \li Params: <NAME>: Name of the command that must be called.
1007 * \li Origin: broider, 2 Oct 2007
1010 { LFUN_CALL, "call", NoBuffer, System },
1013 * \var lyx::FuncCode lyx::LFUN_CANCEL
1014 * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
1015 * \li Syntax: cancel
1018 { LFUN_CANCEL, "cancel", NoBuffer, System },
1022 * \var lyx::FuncCode lyx::LFUN_CAPTION_INSERT
1023 * \li Action: Inserts a caption inset.
1024 * \li Syntax: caption-insert
1025 * \li Origin: Lgb, 18 Jul 2000
1028 { LFUN_CAPTION_INSERT, "caption-insert", Noop, Edit },
1031 * \var lyx::FuncCode lyx::LFUN_CELL_BACKWARD
1032 * \li Action: Moves the cursor to the previous cell inside the table.
1033 * \li Syntax: cell-backward
1034 * \li Origin: Jug, 22 May 2000
1037 { LFUN_CELL_BACKWARD, "cell-backward", ReadOnly | NoUpdate, Edit },
1040 * \var lyx::FuncCode lyx::LFUN_CELL_FORWARD
1041 * \li Action: Moves the cursor to the next cell inside the table.
1042 * \li Syntax: cell-forward
1045 { LFUN_CELL_FORWARD, "cell-forward", ReadOnly | NoUpdate, Edit },
1048 * \var lyx::FuncCode lyx::LFUN_CELL_SPLIT
1049 * \li Action: Splits cell and shifts right part to the next cell (inside the math grid).
1050 * \li Syntax: cell-split
1051 * \li Origin: Ale, 15 May 1997
1054 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
1058 * \var lyx::FuncCode lyx::LFUN_CHANGES_MERGE
1059 * \li Action: Open change tracking dialog for merging and moves the cursor
1060 to the position of the next change.
1061 * \li Syntax: changes-merge
1062 * \li Origin: Levon, 16 Oct 2002
1065 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
1068 * \var lyx::FuncCode lyx::LFUN_CHANGES_OUTPUT
1069 * \li Action: Toggles showing of change tracking in typeset output.
1070 * \li Syntax: changes-output
1071 * \li Origin: spitz, 21 Jan 2005
1074 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
1077 * \var lyx::FuncCode lyx::LFUN_CHANGES_TRACK
1078 * \li Action: Toggles change tracking to on/off.
1079 * \li Syntax: changes-track
1080 * \li Origin: levon, 1 Oct 2002
1083 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
1086 * \var lyx::FuncCode lyx::LFUN_CHANGE_ACCEPT
1087 * \li Action: Accepts tracked change inside the selection.
1088 * \li Syntax: change-accept
1089 * \li Origin: Levon, 16 Oct 2002
1092 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
1095 * \var lyx::FuncCode lyx::LFUN_CHANGE_NEXT
1096 * \li Action: Moves the cursor to the position of the next change
1097 of the change tracking records.
1098 * \li Syntax: change-next
1099 * \li Origin: schmitt, 4 Oct 2006
1102 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
1105 * \var lyx::FuncCode lyx::LFUN_CHANGE_PREVIOUS
1106 * \li Action: Moves the cursor to the position of the previous change
1107 of the change tracking records.
1108 * \li Syntax: change-previous
1109 * \li Origin: vfr, 4 Apr 2009
1112 { LFUN_CHANGE_PREVIOUS, "change-previous", ReadOnly, Edit },
1115 * \var lyx::FuncCode lyx::LFUN_CHANGE_REJECT
1116 * \li Action: Rejects tracked change inside the selection.
1117 * \li Syntax: change-reject
1118 * \li Origin: Levon, 16 Oct 2002
1121 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
1124 * \var lyx::FuncCode lyx::LFUN_CHARS_TRANSPOSE
1125 * \li Action: Transposes the character at the cursor with the one before it.
1126 * \li Syntax: chars-transpose
1127 * \li Origin: Lgb, 25 Apr 2001
1130 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
1134 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD
1135 * \li Action: Moves the cursor one position logically backwards.
1136 * \li Notion: This is not the action which should be bound to the arrow keys,
1137 because backwards may be left or right, depending on the
1138 language. The arrow keys should be bound to #LFUN_CHAR_LEFT or
1139 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
1140 * \li Syntax: char-backward
1143 { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit },
1146 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD_SELECT
1147 * \li Action: Moves the cursor one position logically backwards, adding
1148 traversed position to the selection.
1149 * \li Notion: See also #LFUN_CHAR_BACKWARD.
1150 * \li Syntax: char-backward-select
1153 { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit },
1156 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_BACKWARD
1157 * \li Action: Deletes one character in the backward direction (usually the "BackSpace" key).
1158 * \li Syntax: char-delete-backward [force]
1159 * \li Params: force: Delete big insets, do not only select them.
1162 { LFUN_CHAR_DELETE_BACKWARD, "char-delete-backward", SingleParUpdate, Edit },
1165 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_FORWARD
1166 * \li Action: Deletes one character in the backward direction (usually the "Delete" key).
1167 * \li Syntax: char-delete-forward [force]
1168 * \li Params: force: Delete big insets, do not only select them.
1171 { LFUN_CHAR_DELETE_FORWARD, "char-delete-forward", SingleParUpdate, Edit },
1174 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD
1175 * \li Action: Moves the cursor one position logically forward.
1176 * \li Notion: This is not the action which should be bound to the arrow keys,
1177 because forward may be left or right, depending on the language.
1178 The arrow keys should be bound to #LFUN_CHAR_LEFT or
1179 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
1180 * \li Syntax: char-forward
1183 { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit },
1186 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD_SELECT
1187 * \li Action: Moves the cursor one position logically forward, adding
1188 traversed position to the selection.
1189 * \li Notion: See also #LFUN_CHAR_FORWARD.
1190 * \li Syntax: char-forward-select
1193 { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit },
1196 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT
1197 * \li Action: Moves the cursor one position "to the left".
1198 * \li Notion: This is the action which should be taken when the "left" key
1199 is pressed. Generally, it moves the cursor one position to the
1200 left. However, in Bidi text this become slightly more
1201 complicated, and there are different modes of cursor movement.
1202 In "visual mode", this moves left, plain and simple. In "logical
1203 mode", movement is logically forward in RTL paragraphs, and
1204 logically backwards in LTR paragraphs.
1205 * \li Syntax: char-left
1208 { LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit },
1211 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT_SELECT
1212 * \li Action: Moves the cursor one position "to the left", adding
1213 traversed position to the selection.
1214 * \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement.
1215 * \li Syntax: char-left-select
1218 { LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit },
1221 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT
1222 * \li Action: Moves the cursor one position "to the right".
1223 * \li Notion: This is the action which should be taken when the "right" key
1224 is pressed. Generally, it moves the cursor one position to the
1225 right. However, in Bidi text this become slightly more
1226 complicated, and there are different modes of cursor movement.
1227 In "visual mode", this moves right, plain and simple. In "logical
1228 mode", movement is logically forward in LTR paragraphs, and
1229 logically backwards in RTL paragraphs.
1230 * \li Syntax: char-right
1233 { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit },
1236 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT_SELECT
1237 * \li Action: Moves the cursor one position "to the right", adding
1238 traversed position to the selection.
1239 * \li Notion: See also #LFUN_CHAR_RIGHT for exact details of the movement.
1240 * \li Syntax: char-right-select
1243 { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit },
1247 * \var lyx::FuncCode lyx::LFUN_CITATION_INSERT
1248 * \li Action: Inserts citation from loaded citation database.
1249 * \li Syntax: citation-insert [<KEY>[|<TEXT_BEFORE>]]
1250 * \li Params: <KEY>: Citation (shortcut listed in available citations). \n
1251 <TEXT_BEFORE>: text which should appear before citation.
1252 * \li Origin: AAS, 97-02-23
1255 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
1258 * \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE
1259 * \li Action: Pastes text from the active clipboard (retains formatting if the
1260 clipboard contains formatted text). Pastes plain text if plain text is
1261 on the clipboard, but tries to interpret it in special ways for certain
1262 insets, e.g. converting csv data to rows and columns if the paste happens
1264 * \li Notion: Historically, LFUN_CLIPBOARD_PASTE was introduced as a counterpart of
1265 LFUN_PRIMARY_SELECTION_PASTE: It behaved exactly the same, but the source
1266 is the clipboard, not the selection.
1267 * \li Syntax: clipboard-paste [<ARG>]
1268 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1269 * \li Origin: Georg, 10 Jul 2006
1272 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
1275 * \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE_SIMPLE
1276 * \li Action: Pastes plain text from the active clipboard even if formatted
1277 LyX content is in the clipboard. Pastes plain text if plain text
1278 is on the clipboard, without trying to interpret it in special
1279 ways for certain insets, e.g. converting csv data to rows and
1280 columns if the paste happens in a tabular inset.
1281 * \li Syntax: clipboard-paste-simple [<ARG>]
1282 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1285 { LFUN_CLIPBOARD_PASTE_SIMPLE, "clipboard-paste-simple", Noop, Edit },
1288 * \var lyx::FuncCode lyx::LFUN_COMMAND_ALTERNATIVES
1289 * \li Action: Runs the first listed command that is enabled.
1290 * \li Notion: This can be used to bind multiple functions to a single key,
1291 and then which one is used will depend upon the context.
1292 * \li Syntax: command-alternatives <CMDS>
1293 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
1294 * \li Sample: command-alternatives completion-accept;cell-forward
1295 * \li Origin: rgh, 24 September 2008
1298 { LFUN_COMMAND_ALTERNATIVES, "command-alternatives", NoBuffer, System },
1301 * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
1302 * \li Action: Switches the focus to the minibuffer so that the user can type
1303 in there. If necessary, it opens the minibuffer toolbar.
1304 * \li Notion: Usually bound to M-x shortcut.
1305 * \li Syntax: command-execute
1308 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
1312 * \var lyx::FuncCode lyx::LFUN_COMMAND_PREFIX
1313 * \li Action: Return the current key sequence and available options as a string.
1314 * \li Notion: No options are added if no current map exists. \n
1315 This is probably usable only with connection to lyxserver.
1316 * \li Syntax: command-prefix
1319 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
1322 * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
1323 * \li Action: Run more commands (LFUN and its parameters) in a sequence.
1324 * \li Syntax: command-sequence <CMDS>
1325 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
1326 * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
1327 * \li Origin: Andre, 11 Nov 1999
1330 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
1333 * \var lyx::FuncCode lyx::LFUN_COMPLETE
1334 * \li Action: Try to complete the word or command at the cursor position.
1335 * \li Syntax: complete
1336 * \li Origin: sts, Feb 19 2008
1339 { LFUN_COMPLETE, "complete", SingleParUpdate, Edit },
1343 * \var lyx::FuncCode lyx::LFUN_COMPLETION_ACCEPT
1344 * \li Action: Accept suggested completion.
1345 * \li Syntax: completion-accept
1346 * \li Origin: sanda, Sep 08 2008
1349 { LFUN_COMPLETION_ACCEPT, "completion-accept", SingleParUpdate, Edit },
1354 * \var lyx::FuncCode lyx::LFUN_COMPLETION_CANCEL
1355 * \li Action: Try to cancel completion, either the popup or the inline completion.
1356 * \li Syntax: completion-cancel
1357 * \li Origin: sts, Sep 07 2008
1360 { LFUN_COMPLETION_CANCEL, "completion-cancel", SingleParUpdate, Edit },
1363 * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
1364 * \li Action: Show the inline completion at the cursor position.
1365 * \li Syntax: completion-inline
1366 * \li Origin: sts, Feb 19 2008
1369 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
1372 * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
1373 * \li Action: Show the completion popup at the cursor position.
1374 * \li Syntax: completion-popup
1375 * \li Origin: sts, Feb 19 2008
1378 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
1381 * \var lyx::FuncCode lyx::LFUN_COPY
1382 * \li Action: Copies the current selection to the clipboard.
1386 { LFUN_COPY, "copy", ReadOnly, Edit },
1389 * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
1390 * \li Action: Determine whether to keep cursor inside the editing window regardless
1391 of the scrollbar movement.
1392 * \li Syntax: toggle-cursor-follows-scrollbar
1393 * \li Origin: ARRae, 2 Dec 1997
1396 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
1399 * \var lyx::FuncCode lyx::LFUN_CUT
1400 * \li Action: Cuts to the clipboard.
1404 { LFUN_CUT, "cut", Noop, Edit },
1407 * \var lyx::FuncCode lyx::LFUN_DEBUG_LEVEL_SET
1408 * \li Action: Set debug output level.
1409 * \li Syntax: debug-level-set <LEVEL>
1410 * \li Params: <LEVEL>: comma separated list of levels or the correspondent number
1411 of their combination. 0 is equivalent to disabling all debug
1412 events. See lyx -dbg for the current list of debug levels
1414 * \li Origin: sanda, 28 Dec 2009
1417 { LFUN_DEBUG_LEVEL_SET, "debug-level-set", NoBuffer, System },
1421 * \var lyx::FuncCode lyx::LFUN_DEPTH_DECREMENT
1422 * \li Action: Decrease the nesting depth of the (selected) paragraph(s)
1424 * \li Syntax: depth-decrement
1427 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
1430 * \var lyx::FuncCode lyx::LFUN_DEPTH_INCREMENT
1431 * \li Action: Increase the nesting depth of the (selected) paragraph(s)
1433 * \li Syntax: depth-increment
1436 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
1440 * \var lyx::FuncCode lyx::LFUN_DEVEL_MODE_TOGGLE
1441 * \li Action: toggle a mode where more information is given in UI
1442 * \li Syntax: devel-mode-toggle
1443 * \li Notion: in so called "devel" mode, the information given in the
1444 * status bar is more precise, and the help documents are
1445 * open in editing mode.
1446 * \li Origin: lasgouttes, 23 Jul 2017
1449 { LFUN_DEVEL_MODE_TOGGLE, "devel-mode-toggle", NoBuffer, System },
1453 * \var lyx::FuncCode lyx::LFUN_DIALOG_DISCONNECT_INSET
1454 * \li Action: Closes opened connection to opened inset.
1455 * \li Notion: Connection is used for apply functions.
1456 * \li Syntax: dialog-disconnect-inset <INSET-NAME>
1457 * \li Origin: leeming, 25 Feb 2003
1460 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
1464 * \var lyx::FuncCode lyx::LFUN_DIALOG_HIDE
1465 * \li Action: Hides showed dialog. Counterpart to #LFUN_DIALOG_SHOW .
1466 * \li Syntax: dialog-hide <NAME>
1467 * \li Params: See #LFUN_DIALOG_SHOW .
1468 * \li Origin: leeming, 25 Feb 2003
1471 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
1474 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW
1475 * \li Action: Shows hidden dialog or creates new one for a given function/inset settings etc.
1476 * \li Syntax: dialog-show <NAME> [<DATA>]
1477 * \li Params: <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|\n
1478 compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|\n
1479 graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimiter|\n
1480 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|\n
1481 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|\n
1482 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL> \n
1483 <SPECIAL>: latexlog|vclog \n
1484 <DATA>: data, usually settings for the given dialog. Use debug mode for the
1486 * \li Origin: leeming, 17 Jun 2003
1489 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
1492 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW_NEW_INSET
1493 * \li Action: Shows hidden dialog or create new one for a given inset settings etc.
1494 * \li Notion: Internally uses #LFUN_DIALOG_SHOW with processed data for a given inset.
1495 * \li Syntax: dialog-show-new-inset <NAME> [<DATA>]
1496 * \li Params: See #LFUN_DIALOG_SHOW .
1497 * \li Origin: leeming, 25 Feb 2003
1500 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
1503 * \var lyx::FuncCode lyx::LFUN_DIALOG_TOGGLE
1504 * \li Action: Toggles dialog between showed/hidden state.
1505 * \li Notion: Internally uses #LFUN_DIALOG_SHOW , #LFUN_DIALOG_HIDE .
1506 * \li Syntax: dialog-toggle <NAME> [<DATA>]
1507 * \li Params: See #LFUN_DIALOG_SHOW .
1508 * \li Origin: spitz, 30 Apr 2007
1511 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
1514 * \var lyx::FuncCode lyx::LFUN_DIALOG_UPDATE
1515 * \li Action: Updates the dialog values from the inset/paragraph/document.
1516 * \li Syntax: dialog-update <NAME>
1517 * \li Params: <NAME>: paragraph|prefs|<INSET> \n
1519 * \li Origin: leeming, 25 Feb 2003
1522 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
1525 * \var lyx::FuncCode lyx::LFUN_DOWN
1526 * \li Action: Moves the cursor one line in downward direction.
1530 { LFUN_DOWN, "down", ReadOnly | NoUpdate, Edit },
1533 * \var lyx::FuncCode lyx::LFUN_DOWN_SELECT
1534 * \li Action: Moves the cursor one line in downward direction adding the current
1535 position to the selection.
1536 * \li Syntax: down-select
1539 { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, Edit },
1542 * \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE
1543 * \li Action: Displays list of layout choices.
1544 * \li Notion: This LFUN opens the dropbox allowing for choice of layout.
1545 * \li Syntax: drop-layouts-choice
1548 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
1551 * \var lyx::FuncCode lyx::LFUN_ENVIRONMENT_SPLIT
1552 * \li Action: Splits the current environment with a Separator.
1553 * \li Syntax: environment-split [before|outer|previous]
1554 * \li Params: outer: If this is given, LyX will split the outermost environment in
1555 the current nesting hierarchy.\n
1556 previous: If this is given, LyX will split the environment in the previous
1557 paragraph (if there is one).\n
1558 before: If this is given, the new environment will be appended rather than
1560 * \li Origin: spitz, 23 Dec 2012
1563 { LFUN_ENVIRONMENT_SPLIT, "environment-split", Noop, Layout },
1567 * \var lyx::FuncCode lyx::LFUN_ERT_INSERT
1568 * \li Action: Inserts an ERT inset.
1569 * \li Syntax: ert-insert
1570 * \li Origin: Jug, 18 Feb 2000
1573 { LFUN_ERT_INSERT, "ert-insert", Noop, Edit },
1576 * \var lyx::FuncCode lyx::LFUN_ESCAPE
1577 * \li Action: Clears the selection. If no text is selected call #LFUN_FINISHED_FORWARD.
1578 Inside math mode jumps out of the math inset.
1579 * \li Syntax: escape
1580 * \li Origin: Lgb, 17 May 2001
1583 { LFUN_ESCAPE, "escape", ReadOnly, Edit },
1586 * \var lyx::FuncCode lyx::LFUN_EXPORT_CANCEL
1587 * \li Action: Cancel background export process.
1588 * \li Syntax: export-cancel
1589 * \li Origin: rgh, 10 December 2017
1592 { LFUN_EXPORT_CANCEL, "export-cancel", ReadOnly | NoUpdate | NoInternal, Edit },
1595 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
1596 * \li Action: Inserts another LyX file.
1597 * \li Syntax: file-insert [<FILE>] [ignorelang]
1598 * \li Params: <FILE>: Filename to be inserted.
1599 * ignorelang: If given, the (main) language of the inserted file
1600 * is ignored (the context language is used).
1603 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
1606 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
1607 * \li Action: Inserts plain text file.
1608 * \li Syntax: file-insert-plaintext [<FILE>]
1609 * \li Params: <FILE>: Filename to be inserted.
1610 * \li Origin: CFO-G, 19 Nov 1997
1613 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
1616 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
1617 * \li Action: Inserts plain text file as paragraph (i.e. join lines).
1618 * \li Syntax: file-insert-plaintext-para [<FILE>]
1619 * \li Params: <FILE>: Filename to be inserted.
1620 * \li Origin: Levon, 14 Feb 2001
1623 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
1626 * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
1627 * \li Action: Open LyX document.
1628 * \li Syntax: file-open [<FILE>]
1629 * \li Params: <FILE>: Filename to be opened.
1632 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
1636 * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
1637 * \li Action: Moves the cursor out of the current slice, going backwards.
1638 * \li Notion: See also #LFUN_FINISHED_FORWARD.
1641 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
1644 * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
1645 * \li Action: Moves the cursor out of the current slice, going forward.
1646 * \li Notion: Cursor movement within an inset may be different than cursor
1647 movement in the surrounding text. This action should be called
1648 automatically by the cursor movement within the inset, when
1649 movement within the inset has ceased (reached the end of the
1650 last paragraph, for example), in order to move correctly
1651 back into the surrounding text.
1654 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
1657 * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
1658 * \li Action: Moves the cursor out of the current slice, going left.
1659 * \li Notion: See also #LFUN_FINISHED_FORWARD.
1662 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
1666 * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
1667 * \li Action: Moves the cursor out of the current slice, going right.
1668 * \li Notion: See also #LFUN_FINISHED_FORWARD
1671 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
1674 * \var lyx::FuncCode lyx::LFUN_FLEX_INSERT
1675 * \li Action: Inserts CharStyle, Custom inset or XML short element.
1676 * \li Notion: Look into the Customization manual for more information about
1678 To make this command enabled the layout file for the document
1679 class you're using has to load the character styles. There are
1680 a few contained in the Logical Markup module. You can also of
1681 course create some yourself. \n
1682 For dissolving the element see #LFUN_INSET_DISSOLVE.
1683 * \li Syntax: flex-insert Name
1684 * \li Params: Name: This name must be defined either in your layout file
1685 or imported by some module. The definition is
1686 InsetLayout Name or InsetLayout <Flex:Name>. The Flex:
1688 * \li Sample: flex-insert Code
1691 { LFUN_FLEX_INSERT, "flex-insert", Noop, Edit },
1694 * \var lyx::FuncCode lyx::LFUN_FLOAT_INSERT
1695 * \li Action: Inserts a float inset.
1696 * \li Syntax: float-insert <TYPE>
1697 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
1698 "algorithm", "table", "figure" parameters can be given.
1699 * \li Origin: Lgb, 27 Jun 2000
1702 { LFUN_FLOAT_INSERT, "float-insert", Noop, Edit },
1705 * \var lyx::FuncCode lyx::LFUN_FLOAT_LIST_INSERT
1706 * \li Action: Inserts the list of floats in the document.
1707 * \li Syntax: float-list-insert <TYPE>
1708 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
1709 "algorithm", "table", "figure" parameters can be given.
1710 * \li Origin: Lgb, 3 May 2001
1713 { LFUN_FLOAT_LIST_INSERT, "float-list-insert", Noop, Edit },
1716 * \var lyx::FuncCode lyx::LFUN_FLOAT_WIDE_INSERT
1717 * \li Action: Inserts float insets as in #LFUN_FLOAT_INSERT but span multiple columns.
1718 * \li Notion: Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
1719 * \li Syntax: float-wide-insert <TYPE>
1720 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
1721 "algorithm", "table", "figure" parameters can be given.
1722 * \li Origin: Lgb, 31 Oct 2001
1725 { LFUN_FLOAT_WIDE_INSERT, "float-wide-insert", Noop, Edit },
1728 * \var lyx::FuncCode lyx::LFUN_FONT_BOLD
1729 * \li Action: Toggles the bold font (selection-wise) using mathbf in math.
1730 * \li Syntax: font-bold
1733 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
1737 * \var lyx::FuncCode lyx::LFUN_FONT_BOLDSYMBOL
1738 * \li Action: Toggles the bold font (selection-wise) using boldsymbol in math.
1739 * \li Syntax: font-boldsymbol
1742 { LFUN_FONT_BOLDSYMBOL, "font-boldsymbol", Noop, Layout },
1745 * \var lyx::FuncCode lyx::LFUN_FONT_DEFAULT
1746 * \li Action: Reverts the settings of the font to the default values (selection-wise).
1747 * \li Syntax: font-default
1750 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
1753 * \var lyx::FuncCode lyx::LFUN_FONT_EMPH
1754 * \li Action: Toggles the emphasis font style (selection-wise).
1755 * \li Syntax: font-emph
1758 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
1761 * \var lyx::FuncCode lyx::LFUN_FONT_FRAK
1762 * \li Action: Toggles Fraktur family font (math-mode, selection-wise).
1763 * \li Syntax: font-frak
1764 * \li Origin: vermeer, 10 Jan 2002
1767 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
1770 * \var lyx::FuncCode lyx::LFUN_FONT_ITAL
1771 * \li Action: Toggles Italics font shape (math-mode, selection-wise).
1772 * \li Syntax: font-ital
1773 * \li Origin: vermeer, 10 Jan 2002
1776 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
1779 * \var lyx::FuncCode lyx::LFUN_FONT_NOUN
1780 * \li Action: Toggles Noun text style font (selection-wise).
1781 * \li Syntax: font-noun
1784 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
1787 * \var lyx::FuncCode lyx::LFUN_FONT_ROMAN
1788 * \li Action: Toggles Roman family font (selection-wise).
1789 * \li Syntax: font-roman
1792 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
1795 * \var lyx::FuncCode lyx::LFUN_FONT_SANS
1796 * \li Action: Toggles Sans Serif family font (selection-wise).
1797 * \li Syntax: font-sans
1800 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
1803 * \var lyx::FuncCode lyx::LFUN_FONT_SIZE
1804 * \li Action: Sets font size according to lyx format string.
1805 * \li Syntax: font-size <SIZE>
1806 * \li Params: <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|\n
1807 largest|huge|giant|increase|decrease|default
1810 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
1813 * \var lyx::FuncCode lyx::LFUN_FONT_STATE
1814 * \li Action: Returns the info about the current font.
1815 * \li Syntax: font-state
1818 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
1822 * \var lyx::FuncCode lyx::LFUN_FONT_STRIKEOUT
1823 * \li Action: Toggles strikeout (strike-through) in the font (selection-wise).
1824 * \li Syntax: font-strikeout
1825 * \li Origin: sanda, 3 May 2009
1828 { LFUN_FONT_STRIKEOUT, "font-strikeout", Noop, Layout },
1831 * \var lyx::FuncCode lyx::LFUN_FONT_CROSSOUT
1832 * \li Action: Toggles xout (cross-through) in the font (selection-wise).
1833 * \li Syntax: font-crossout
1834 * \li Origin: uwestoehr, 4 April 2017
1837 { LFUN_FONT_CROSSOUT, "font-crossout", Noop, Layout },
1840 * \var lyx::FuncCode lyx::LFUN_FONT_TYPEWRITER
1841 * \li Action: Toggles the typewriter family font (selection-wise).
1842 * \li Syntax: font-typewriter
1845 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
1848 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERLINE
1849 * \li Action: Toggles underline in the font (selection-wise).
1850 * \li Syntax: font-underline
1853 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
1856 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERUNDERLINE
1857 * \li Action: Toggles double underline in the font (selection-wise).
1858 * \li Syntax: font-underunderline
1859 * \li Origin: sanda, 5 May 2009
1862 { LFUN_FONT_UNDERUNDERLINE, "font-underunderline", Noop, Layout },
1865 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERWAVE
1866 * \li Action: Toggles wavy underline in the font (selection-wise).
1867 * \li Syntax: font-underwave
1868 * \li Origin: sanda, 5 May 2009
1871 { LFUN_FONT_UNDERWAVE, "font-underwave", Noop, Layout },
1874 * \var lyx::FuncCode lyx::LFUN_FOOTNOTE_INSERT
1875 * \li Action: Inserts a footnote inset.
1876 * \li Syntax: footnote-insert
1877 * \li Origin: Jug, 7 Mar 2000
1880 { LFUN_FOOTNOTE_INSERT, "footnote-insert", Noop, Edit },
1883 * \var lyx::FuncCode lyx::LFUN_FORWARD_SEARCH
1884 * \li Action: Sets the cursor position in the previewed (dvi/pdf) file based on the row
1885 number in LyX window.
1886 * \li Notion: The external program used for forward search call can be specified in
1887 LyX Output preferences. See Additional manual for details of these
1889 * \li Syntax: forward-search
1890 * \li Origin: sanda, 14 Apr 2010
1893 { LFUN_FORWARD_SEARCH, "forward-search", ReadOnly, System },
1896 * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
1897 * \li Action: Open the given help file according to the language setting.
1898 * \li Syntax: help-open <FILE>[.lyx]
1899 * \li Params: <FILE>: any document from (/usr/share/)doc directory.
1900 * \li Origin: Jug, 27 Jun 1999
1903 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
1906 * \var lyx::FuncCode lyx::LFUN_HREF_INSERT
1907 * \li Action: Inserts hyperlinks into the document (clickable in pdf output).
1908 * \li Notion: Hyperlink target can be set via selection + hyperlink-insert function.
1909 * \li Syntax: href-insert [<TARGET>]
1910 * \li Origin: CFO-G, 21 Nov 1997
1913 { LFUN_HREF_INSERT, "href-insert", Noop, Edit },
1916 * \var lyx::FuncCode lyx::LFUN_ICON_SIZE
1917 * \li Action: Sets icon size of toolbars.
1918 * \li Syntax: icon-size [<SIZE>]
1919 * \li Params: <SIZE> : the icon size in px or one of the logical settings
1920 small|normal|big|huge|giant, the default is normal
1921 (whose size in px is icon set dependent).
1922 * \li Origin: 11 July 2016
1925 { LFUN_ICON_SIZE, "icon-size", NoBuffer, Buffer },
1929 * \var lyx::FuncCode lyx::LFUN_IF_RELATIVES
1930 * \li Action: Helper function for master-related actions
1931 * \li Notion: In a buffer, the function will be disabled if the buffer
1932 * has no master or children. It thus allows to enable
1933 * actions only in documents with master/children
1934 * \li Syntax: ifrelatives <ACTION>
1935 * \li Origin: spitz, 2 January 2020
1938 { LFUN_IF_RELATIVES, "ifrelatives", Noop, Buffer },
1941 * \var lyx::FuncCode lyx::LFUN_INDEX_INSERT
1942 * \li Action: Inserts Index entry.
1943 * \li Notion: It automatically takes the word on the cursor position.
1944 * \li Syntax: index-insert [<TYPE:Name>]
1945 * \li Params: <TYPE:Name>: name of the index, if multiple indices are defined.
1946 With an empty argument, the default index is selected.
1947 * \li Origin: leeming, 3 Aug 2000
1950 { LFUN_INDEX_INSERT, "index-insert", Noop, Edit },
1953 * \var lyx::FuncCode lyx::LFUN_INDEX_PRINT
1954 * \li Action: Inserts list of Index entries on a new page.
1955 * \li Syntax: index-print [<TYPE:Name>]
1956 * \li Params: <TYPE:Name>: name of the index, if multiple indices are defined.
1957 With an empty argument, the default index is selected.
1958 * \li Origin: Lgb, 27 Feb 1997
1961 { LFUN_INDEX_PRINT, "index-print", Noop, Edit },
1964 * \var lyx::FuncCode lyx::LFUN_INFO_INSERT
1965 * \li Action: Displays shortcuts, lyxrc, package and textclass availability and menu
1966 information in a non-editable boxed InsetText.
1967 * \li Notion: Apart from lfun arguments you can use the following method: \n
1968 1. input the type and argument of this inset, e.g. "menu paste", in
1970 2. select the text and run info-insert lfun.
1971 * \li Syntax: info-insert <TYPE> <ARG>
1972 * \li Params: <TYPE>: date|moddate|fixdate|time|modtime|fixtime|shortcut|shortcuts|lyxrc|
1973 * lyxinfo|package|textclass|menu|l7n|icon|buffer|vcs \n
1974 <ARG>: argument for a given type. Look into InsetInfo.h for detailed
1976 date: current date (formatted and localized)\n
1977 moddate: date of last modification (saving) (formatted and localized)\n
1978 fixdate: a static date (formatted and localized)\n
1979 time: current time (formatted and localized)\n
1980 modtime: time of last modification (saving) (formatted and localized)\n
1981 fixtime: a static time (formatted and localized)\n
1982 shortcut[s]: name of lfun (e.g math-insert \alpha) \n
1983 lyxrc: name of rc_entry (e.g. bind_file) \n
1984 lyxinfo: "version" - used version of LyX \n
1985 package: name of latex package (e.g. listings) \n
1986 textclass: name of textclass (e.g. article) \n
1987 menu: name of lfun used in menu \n
1988 l7n: localizable string.\n
1989 icon: icon of lfun used in toolbar or direct icon name\n
1990 buffer: "name"|"name-noext"|"path"|"class"
1991 vcs: "tree-revision"|"revision"|"author"|"date"|"time"
1992 * \li Sample: command-sequence info-insert buffer path; info-insert buffer name
1993 * \li Origin: bpeng, 7 Oct 2007
1996 { LFUN_INFO_INSERT, "info-insert", Noop, Edit },
1999 * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
2000 * \li Action: Apply data for an inset.
2001 * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
2002 be applied. This is either changed to #LFUN_INSET_MODIFY or
2003 #LFUN_INSET_INSERT depending on the context where it is called.
2004 * \li Syntax: inset-apply <ARGS>
2005 * \li Params: See #LFUN_INSET_INSERT .
2008 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
2011 * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN
2012 * \li Action: Move the cursor to the beginning of the current inset
2013 if it is not already there. If the cursor is already at
2014 the beginning of the current inset, move it to the
2015 beginning of the enclosing inset or the main work area,
2016 respectively, if there is no enclosing inset.
2017 * \li Syntax: inset-begin
2018 * \li Origin: lasgouttes, 16 Mar 2009
2021 { LFUN_INSET_BEGIN, "inset-begin", ReadOnly, Edit },
2024 * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN_SELECT
2025 * \li Action: Move the cursor to the beginning of the current inset
2026 if it is not already there. If the cursor is already at
2027 the beginning of the current inset, move it to the
2028 beginning of the enclosing inset or the main work area,
2029 respectively, if there is no enclosing inset (adding the
2030 traversed text to the selection).
2031 * \li Syntax: inset-begin-select
2032 * \li Origin: lasgouttes, 16 Mar 2009
2035 { LFUN_INSET_BEGIN_SELECT, "inset-begin-select", ReadOnly, Edit },
2038 * \var lyx::FuncCode lyx::LFUN_INSET_COPY_AS
2039 * \li Action: Copies the inset to the clipboard as a certain type.
2040 * \li Notion: Currently used only for InsetInfo where its content is copied as a text.
2041 * \li Syntax: inset-copy-as
2042 * \li Origin: vfr, 18 Apr 2010
2045 { LFUN_INSET_COPY_AS, "inset-copy-as", ReadOnly | NoUpdate | AtPoint, Edit },
2049 * \var lyx::FuncCode lyx::LFUN_INSET_DIALOG_UPDATE
2050 * \li Action: Updates the values inside the dialog from the inset.
2051 * \li Notion: This is an internal LFUN, not to be used by users. Called internally
2052 by #LFUN_DIALOG_UPDATE
2053 * \li Params: <DIALOG-NAME>
2054 * \li Origin: leeming, 25 Feb 2003
2057 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
2060 * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE
2061 * \li Action: Dissolve the current inset into text.
2062 * \li Syntax: inset-dissolve [<INSET>]
2063 * \li Params: <INSET>: this can be used to make sure the right kind of inset
2064 is dissolved. For example "dissolve" entry in the charstyles
2065 sub-menu should only dissolve the charstyle inset, even if the
2066 cursor is inside several nested insets of different type.\n
2067 For values see #lyx::InsetLayout::lyxtype_ .
2068 * \li Origin: JSpitz, 7 Aug 2006
2071 { LFUN_INSET_DISSOLVE, "inset-dissolve", AtPoint, Edit },
2074 * \var lyx::FuncCode lyx::LFUN_INSET_EDIT
2075 * \li Action: Edit the inset at cursor with an external application,
2076 if one is attributed.
2077 If the inset is file based, the referenced file is edited.
2078 Otherwise, the inset contents is written to a temporary file,
2079 the inset is locked, and the temporary file is edited.
2080 In this case, #LFUN_INSET_END_EDIT must be called to overtake
2081 the changes and unlock the inset after editing is finished.
2082 * \li Syntax: inset-edit [<INSET_PARAMS>]
2083 * \li Params: <INSET_PARAMS>: Parameters for the inset. \n
2084 Currently only the filename will be considered.
2085 * \li Origin: spitz, 27 Apr 2006
2088 { LFUN_INSET_EDIT, "inset-edit", ReadOnly | AtPoint, Edit },
2092 * \var lyx::FuncCode lyx::LFUN_INSET_END_EDIT
2093 * \li Action: End editing the inset at cursor with an external application.
2094 * This replaces the inset contents with the contents of the
2095 * temporary file, deletes the file and unlocks the inset.
2096 * \li Syntax: inset-end-edit
2097 * \li Origin: gb, 11 Oct 2015
2100 { LFUN_INSET_END_EDIT, "inset-end-edit", ReadOnly | AtPoint, Edit },
2103 * \var lyx::FuncCode lyx::LFUN_INSET_END
2104 * \li Action: Move the cursor to the end of the current inset if it
2105 is not already there. If the cursor is already at the
2106 end of the current inset, move it to the end of the
2107 enclosing inset or the main work area, respectively, if
2108 there is no enclosing inset.
2109 * \li Syntax: inset-end
2110 * \li Origin: lasgouttes, 16 Mar 2009
2113 { LFUN_INSET_END, "inset-end", ReadOnly, Edit },
2116 * \var lyx::FuncCode lyx::LFUN_INSET_END_SELECT
2117 * \li Action: Move the cursor to the end of the current inset if it
2118 is not already there. If the cursor is already at the
2119 end of the current inset, move it to the end of the
2120 enclosing inset or the main work area, respectively, if
2121 there is no enclosing inset (adding the
2122 traversed text to the selection).
2123 * \li Syntax: inset-end-select
2124 * \li Origin: lasgouttes, 16 Mar 2009
2127 { LFUN_INSET_END_SELECT, "inset-end-select", ReadOnly, Edit },
2131 * \var lyx::FuncCode lyx::LFUN_INSET_FORALL
2132 * \li Action: Apply the given commands on insets of a given name.
2133 * \li Notion: WARNING: use at your own risks; this function gives
2134 you too many ways of shooting yourself in the foot.
2135 A typical example is
2136 inset-forall Note note-insert
2137 which starts an infinite loop. This is mitigated by the fact
2138 that the number of actions is arbitrarily limited to 100000.
2139 Note also that inset-forall does not update metrics between
2140 iterations, which can lead to bugs. This has to be eventually
2142 * \li Syntax: inset-forall <NAME> <LFUN-COMMAND> \n
2143 <NAME>: Type of Inset. If <NAME> is *, all insets are matched.
2144 The name is used like for InsetLayout in layout files: "Note"
2145 matches all note insets, while "Note:Note" only matches LyX
2147 * \li Sample: Remove all index insets: \n
2148 inset-forall Index char-delete-forward force \n
2149 Close all Notes (also works for a particular branch, for example): \n
2150 inset-forall Note inset-toggle close \n
2151 Transform all yellow notes to comments \n
2152 inset-forall Note:Note inset-modify note Note Comment \n
2153 Try to put LyX in an infinite loop if there is at least a Note: \n
2154 inset-forall Note char-backward
2155 * \li Origin: lasgouttes, 27 Nov 2009
2158 { LFUN_INSET_FORALL, "inset-forall", ReadOnly, Edit },
2162 * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
2163 * \li Action: Insert new inset (type given by the parameters).
2164 * \li Syntax: inset-insert <INSET> <ARGS>
2165 * \li Params: <INSET>: <bibitem|bibtex|citation|ert|listings|external|graphics|tabular|\n
2166 hyperlink|include|index|label|line|nomencl|vspace|ref|toc|script>\n
2167 <ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
2168 * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
2169 where <label name> is the name of the referenced label and
2170 <Format> is one of the following: \n
2171 ref -- <reference> \n
2172 eqref -- (<reference>) \n
2173 pageref -- <page> \n
2174 vpageref -- on <page> \n
2175 vref -- <reference> on <page> \n
2176 formatted -- Formatted reference
2179 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
2182 * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
2183 * \li Action: Modify some properties of an inset.
2184 * \li Notion: Used for argument, bibitem, bibtex, box, branch, caption, citation,
2185 command, ert, external, float, graphics, include, index,
2186 info, label, line, listings, newline, newpage, nomencl,
2187 note, phantom, quotes, ref, script, separator, space,
2188 tabular, vspace and wrap insets.
2189 * \li Syntax: inset-modify <INSET> <ARGS> \n
2190 inset-modify changetype <TYPE>
2191 * \li Sample: Change a Note inset into a Comment inset: \n
2192 inset-modify note Note Comment \n
2193 Change a Box into an Ovalbox: \n
2194 inset-modify changetype Ovalbox \n
2195 Change a quotation mark to e[nglish style], l[eft side = opening], s[ingle = inner, secondary] \n
2196 inset-modify changetype els \n
2197 Change only the style of a quotation mark, maintaining the other aspects (. = wildcard) \n
2198 inset-modify changetype e.. \n
2201 { LFUN_INSET_MODIFY, "inset-modify", AtPoint, Edit },
2204 * \var lyx::FuncCode lyx::LFUN_INSET_SELECT_ALL
2205 * \li Action: Select all contents of an inset.
2206 * \li Notion: There are 3 successive levels: select current cell,
2207 * select all cells of inset, select the inset from outside
2208 * (in the enclosing inset).
2209 * \li Syntax: inset-select-all
2210 * \li Origin: vfr, 22 Aug 2009; lasgouttes 1 Nov 2014
2213 { LFUN_INSET_SELECT_ALL, "inset-select-all", ReadOnly, Edit },
2217 * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
2218 * \li Action: Open the inset's properties dialog.
2219 * \li Notion: Used for bibitem, bibtex, box, branch, citation, ert, external,
2220 float, graphics, href, include, index, index_print, label, line,
2221 listings, note, phantom, ref, space, tabular, vspace, wrap insets.
2222 * \li Syntax: inset-settings <INSET>
2223 * \li Params: <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|\n
2224 graphics|href|include|index|index_print|label|line|\n
2225 listings|note|phantom|ref|space|tabular|vspace|wrap>.
2228 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly | AtPoint, Edit },
2231 * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
2232 * \li Action: Toggles the collapsible inset at cursor position,
2233 or the inset we are currently in.
2234 * \li Syntax: inset-toggle [<ARG>]
2235 * \li Params: <ARG>: <open|close|toggle|assign>. \n
2236 open/close/toggle are for collapsible insets. toggle is used when no argument is given.\n
2237 assign synchronize the branch-inset with activation status of the branch.
2238 Used for global toggling when changed activation.
2239 * \li Origin: lasgouttes, 19 Jul 2001
2242 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly | AtPoint, Edit },
2245 * \var lyx::FuncCode lyx::LFUN_IN_IPA
2246 * \li Action: Only active in IPA inset.
2247 * \li Notion: Dummy function which is only active in a IPA inset.
2248 It's used to toggle the IPA toolbar if the cursor moves
2250 * \li Syntax: in-ipa
2251 * \li Origin: spitz, 20 May 2012
2254 { LFUN_IN_IPA, "in-ipa", Noop, Edit },
2257 * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
2258 * \li Action: Only active in Math Macro definition.
2259 * \li Notion: Dummy function which is only active in a Math Macro definition.
2260 It's used to toggle the Math Macro toolbar if the cursor moves
2261 into a Math Macro definition.
2262 * \li Syntax: in-mathmacrotemplate
2263 * \li Origin: sts, 06 January 2008
2266 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
2270 * \var lyx::FuncCode lyx::LFUN_IPAMACRO_INSERT
2271 * \li Action: Inserts special IPA macros into the document.
2272 * \li Syntax: ipamacro-insert <CHAR>
2273 * \li Params: <CHAR>: tone-falling, tone-rising, tone-high-rising, tone-low-rising,
2274 * tone-high-rising-falling, deco bottomtiebar, deco toptiebar.
2275 * \li Origin: spitz, 22 Aug 2012
2278 { LFUN_IPAMACRO_INSERT, "ipamacro-insert", Noop, Edit },
2281 * \var lyx::FuncCode lyx::LFUN_IPA_INSERT
2282 * \li Action: Inserts an IPA inset.
2283 * \li Syntax: ipa-insert
2284 * \li Origin: spitz, 05 Mar 2012
2287 { LFUN_IPA_INSERT, "ipa-insert", Noop, Edit },
2290 * \var lyx::FuncCode lyx::LFUN_KEYMAP_OFF
2291 * \li Action: Turn off the loaded keyboard map.
2292 * \li Syntax: keymap-off
2295 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
2298 * \var lyx::FuncCode lyx::LFUN_KEYMAP_PRIMARY
2299 * \li Action: Turn on the primary keyboard map.
2300 * \li Notion: Maps were widely used in past, when X-windows didn't have nowadays
2301 keyboard support. They can be still used to maintain uniform keyboard
2302 layout across the various platforms.\n
2303 The language is to be set in the Preferences dialog.
2304 * \li Syntax: keymap-primary
2307 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
2310 * \var lyx::FuncCode lyx::LFUN_KEYMAP_SECONDARY
2311 * \li Action: Turn on the secondary keyboard map.
2312 * \li Syntax: keymap-secondary
2315 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
2318 * \var lyx::FuncCode lyx::LFUN_KEYMAP_TOGGLE
2319 * \li Action: Toggles keyboard maps (first/second/off).
2320 * \li Syntax: keymap-toggle
2321 * \li Origin: leeming, 30 Mar 2004
2324 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
2328 * \var lyx::FuncCode lyx::LFUN_LABEL_COPY_AS_REFERENCE
2329 * \li Action: Copies the label at the cursor as a cross-reference to be pasted elsewhere.
2330 * \li Syntax: copy-label-as-reference <LABEL>
2331 * \li Params: <LABEL>: The label to copy (for multi-line math)
2332 * \li Origin: sts, 16 Nov 2008
2335 { LFUN_LABEL_COPY_AS_REFERENCE, "label-copy-as-reference",
2336 ReadOnly | NoUpdate | AtPoint, Edit },
2340 * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
2341 * \li Action: Goto a label.
2342 * \li Syntax: label-goto [<LABEL>]
2343 * \li Params: <LABEL>: Requested label. If no label is given and reference
2344 is on cursor position, Bookmark 0 is saved and
2345 cursor moves to the position of referenced label.
2346 * \li Origin: Ale, 6 Aug 1997
2349 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
2352 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT
2353 * \li Action: Inserts label to text or displayed formula.
2354 * \li Syntax: label-insert [<LABEL>]
2355 * \li Params: <LABEL>: Requested label. If no label is given dialog requesting
2356 name will be opened.
2359 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
2362 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT_AS_REFERENCE
2363 * \li Action: Inserts the label (in ToC pane) as a cross-reference at the position of the cursor.
2364 * \li Syntax: label-insert-as-reference
2365 * \li Origin: vfr, 7 Apr 2009
2368 { LFUN_LABEL_INSERT_AS_REFERENCE, "label-insert-as-reference", Noop, Edit},
2372 * \var lyx::FuncCode lyx::LFUN_LANGUAGE
2373 * \li Action: Set language from the current cursor position.
2374 * \li Syntax: language <LANG> [set]
2375 * \li Params: <LANG>: Requested language. Look in lib/languages for
2376 the list. "language reset" or "language" (without param)
2377 reset to the document language.
2378 set: If used, the language will be set to the specified
2379 language. Otherwise, the language will be toggled (i.e., if
2380 the current language is LANG, switch to the document language
2381 or the default language, if LANG is the document language).
2382 * \li Origin: Dekel, 2 Mar 2000
2385 { LFUN_LANGUAGE, "language", Noop, Edit },
2389 * \var lyx::FuncCode lyx::LFUN_LAYOUT
2390 * \li Action: Sets the layout (that is, environment) for the current paragraph.
2391 * \li Syntax: layout <LAYOUT> [ignorenests]
2392 * \li Params: <LAYOUT>: the layout to use\n
2393 ignorenests: If specified, nesting advices will be ignored.
2396 { LFUN_LAYOUT, "layout", Noop, Layout },
2399 * \var lyx::FuncCode lyx::LFUN_LAYOUT_TOGGLE
2400 * \li Action: Toggles the layout (that is, environment) for the current paragraph.
2401 * \li Notion: Contrary to `layout', this function resets the current
2402 * (or selection) layout to the standard layout it already has the
2403 * correct layout. Useful for toolbar icons.
2404 * \li Syntax: layout-toggle <LAYOUT> [ignorenests]
2405 * \li Params: <LAYOUT>: the layout to toggle\n
2406 ignorenests: If specified, nesting advices will be ignored.
2407 * \li Origin: lasgouttes, 14 May 2018
2410 { LFUN_LAYOUT_TOGGLE, "layout-toggle", Noop, Layout },
2413 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
2414 * \li Action: Clears the module list.
2415 * \li Notion: Clears the list of included modules for the current buffer.
2416 * \li Syntax: layout-modules-clear
2417 * \li Origin: rgh, 25 August 2007
2420 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", NoInternal, Layout },
2423 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULE_ADD
2424 * \li Action: Adds a module.
2425 * \li Notion: Adds a module to the list of included modules for the current buffer.
2426 * \li Syntax: layout-module-add <MODULE>
2427 * \li Params: <MODULE>: the module to be added
2428 * \li Origin: rgh, 25 August 2007
2431 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", NoInternal, Layout },
2434 * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH
2435 * \li Action: Launches the paragraph settings dialog.
2436 * \li Syntax: layout-paragraph
2439 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
2442 * \var lyx::FuncCode lyx::LFUN_LAYOUT_RELOAD
2443 * \li Action: Reloads layout information.
2444 * \li Notion: Reloads all layout information for the current buffer from disk, thus
2445 recognizing any changes that have been made to layout files on the fly.
2446 This is intended to be used only by layout developers and should not be
2447 used when one is trying to do actual work.
2448 * \li Syntax: layout-reload
2449 * \li Origin: rgh, 3 September 2007
2452 { LFUN_LAYOUT_RELOAD, "layout-reload", NoInternal, Layout },
2455 * \var lyx::FuncCode lyx::LFUN_LAYOUT_TABULAR
2456 * \li Action: Launches the tabular settings dialog.
2457 * \li Syntax: layout-tabular
2458 * \li Origin: Jug, 31 Jul 2000
2461 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
2464 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN
2465 * \li Action: Move the cursor to the beginning of the (screen) line.
2466 * \li Syntax: line-begin
2469 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
2472 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN_SELECT
2473 * \li Action: Move the cursor to the beginning of the (screen) line adding the
2474 traversed text to the selection.
2475 * \li Syntax: line-begin-select
2478 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
2481 * \var lyx::FuncCode lyx::LFUN_LINE_DELETE_FORWARD
2482 * \li Action: Deletes the letters to the end of the (screen) line or
2483 deletes the selection.
2484 * \li Syntax: line-delete-forward
2487 { LFUN_LINE_DELETE_FORWARD, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
2490 * \var lyx::FuncCode lyx::LFUN_LINE_END
2491 * \li Action: Move the cursor to the end of the (screen) line.
2492 * \li Syntax: line-end
2495 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
2498 * \var lyx::FuncCode lyx::LFUN_LINE_END_SELECT
2499 * \li Action: Move the cursor to the end of the (screen) line adding the
2500 traversed text to the selection.
2501 * \li Syntax: line-end-select
2504 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
2507 * \var lyx::FuncCode lyx::LFUN_LISTING_INSERT
2508 * \li Action: Inserts a new listings inset.
2509 * \li Syntax: listing-insert
2510 * \li Origin: Herbert, 10 Nov 2001; bpeng, 2 May 2007
2513 { LFUN_LISTING_INSERT, "listing-insert", Noop, Edit },
2516 * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
2517 * \li Action: Apply the given settings to user preferences.
2518 * \li Syntax: lyxrc-apply <SETTINGS>
2519 * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
2520 to get an idea which commands to use and their syntax.
2521 #lyx::LyXRC::LyXRCTags has the list of possible commands.
2524 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
2527 * \var lyx::FuncCode lyx::LFUN_LYX_ACTIVATE
2528 * \li Action: Activates the LyX window.
2529 * \li Notion: On Linux and Mac OS, this action brings the LyX window
2530 into focus. Such behavior is not allowed by Windows OS
2531 so instead the color of the taskbar entry is changed to
2532 indicate that the window has changed in some way.
2533 This action is useful in combination with reverse search.
2534 * \li Syntax: lyx-activate
2535 * \li Origin: skostysh, 4 Aug 2016
2538 { LFUN_LYX_ACTIVATE, "lyx-activate", ReadOnly | NoBuffer, Hidden },
2541 * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
2542 * \li Action: Terminates the current LyX instance.
2543 * \li Notion: Terminates the current LyX instance, asking whether to save
2544 modified documents, etc.
2545 * \li Syntax: lyx-quit
2548 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
2551 * \var lyx::FuncCode lyx::LFUN_MARGINALNOTE_INSERT
2552 * \li Action: Inserts a marginal note.
2553 * \li Syntax: marginalnote-insert
2554 * \li Origin: Lgb, 26 Jun 2000
2557 { LFUN_MARGINALNOTE_INSERT, "marginalnote-insert", Noop, Edit },
2560 * \var lyx::FuncCode lyx::LFUN_MARK_OFF
2561 * \li Action: Disable selecting of text-region.
2562 * \li Syntax: mark-off
2565 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
2568 * \var lyx::FuncCode lyx::LFUN_MARK_ON
2569 * \li Action: Enable selecting of text-region.
2570 * \li Notion: After enabling you can simply move arrow keys to get selected region.
2571 * \li Syntax: mark-on
2574 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
2577 * \var lyx::FuncCode lyx::LFUN_MARK_TOGGLE
2578 * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
2579 * \li Syntax: mark-toggle
2580 * \li Origin: Andre, May 5 2006
2583 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
2587 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_EXPORT
2588 * \li Action: Exports the master buffer (document) to the given format.
2589 * \li Syntax: master-buffer-export [<FORMAT>] [<DEST>]
2590 * \li Params: <FORMAT> is one of the formats which you can find in
2591 Tools->Preferences->File formats->Format.
2592 Usual format you will enter is "pdf2" (pdflatex),
2593 "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
2594 Note that "custom" is not allowed in this case.\n
2595 If absent or "default", then the default output format of the
2597 <DEST> If present, this argument provides the export destination
2598 filename. Its containing folder will also be the destination
2599 folder, where all the needed external files will be copied.
2600 * \li Origin: rkh, 18 April 2018
2603 { LFUN_MASTER_BUFFER_EXPORT, "master-buffer-export", ReadOnly, Buffer },
2606 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_FORALL
2607 * \li Action: Applies a command to a buffer and all it children, starting from the master.
2608 * \li Syntax: master-buffer-forall <LFUN-COMMAND>
2609 * \li Params: <LFUN-COMMAND>: The command to be applied to the buffers.
2610 * \li Sample: Close all Notes in buffers: \n
2611 master-buffer-forall inset-forall Note inset-toggle close \n
2612 Toggle change tracking on buffers: \n
2613 master-buffer-forall changes-track \n
2614 Toggle read-only for buffers: \n
2615 master-buffer-forall buffer-toggle-read-only \n
2616 Show statistics for individual buffers: \n
2617 master-buffer-forall statistics \n
2618 Activate the branch named "Solutions" in buffers: \n
2619 master-buffer-forall branch-activate Solutions \n
2620 * \li Origin: spitz, 31 Dec 2019
2623 { LFUN_MASTER_BUFFER_FORALL, "master-buffer-forall", ReadOnly | Argument, Buffer },
2626 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
2627 * \li Action: Update (export) the document built from the master buffer,
2628 if the current buffer is part of a master/child document.
2629 * \li Syntax: master-buffer-update [<FORMAT>]
2630 * \li Params: <FORMAT>: The format to display, where this is one of the
2631 formats defined (in the current GUI) in the
2632 Tools>Preferences>File Formats dialog.
2633 If no format is given, the default format as
2634 specified in the same dialog is used.
2635 * \li Origin: Tommaso, 20 Sep 2007
2638 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
2641 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
2642 * \li Action: Show a preview built from the master buffer, if available.
2643 if the current buffer is part of a master/child document.
2644 * \li Syntax: master-buffer-view [<FORMAT>]
2645 * \li Params: <FORMAT>: The format to display, where this is one of the
2646 formats defined (in the current GUI) in the
2647 Tools>Preferences>File Formats dialog.
2648 If no format is given, the default format as
2649 specified in the same dialog is used.
2650 * \li Origin: Tommaso, 20 Sep 2007
2653 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
2656 * \var lyx::FuncCode lyx::LFUN_MATH_AMS_MATRIX
2657 * \li Action: Inserts an extended matrix as provided by the amsmath package.
2658 * \li Syntax: math-matrix <COLS> <ROWS> [<DECORATION>]
2659 * \li Params: <DECORATION>: Decoration determines the LaTeX name of the matrix
2660 that should be created. Possible values include
2661 pmatrix, bmatrix, Bmatrix, vmatrix, Vmatrix, smallmatrix, and
2662 matrix. The default is 'matrix'.
2663 * \li Sample: math-ams-matrix 3 3 bmatrix
2666 { LFUN_MATH_AMS_MATRIX, "math-ams-matrix", Noop, Math },
2669 * \var lyx::FuncCode lyx::LFUN_MATH_BIGDELIM
2670 * \li Action: Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
2671 * \li Syntax: math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
2672 * \li Params: <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r \n
2673 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
2674 * \li Sample: math-bigdelim "Bigl" "\Downarrow" "Bigr" "\}"
2675 * \li Origin: Enrico & Georg, 7 May 2006
2678 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
2681 * \var lyx::FuncCode lyx::LFUN_MATH_DELIM
2682 * \li Action: Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
2683 * \li Syntax: math-delim [<LEFT>] [<RIGHT>]
2684 * \li Params: <LEFT/RIGHT>: Delimiters to be used. Each delimiter can be specified by
2685 either a LaTeX name or a valid character.
2686 ( is the default letter.
2687 * \li Sample: math-delim { rangle
2688 * \li Origin: Alejandro, 18 Jun 1996
2691 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
2694 * \var lyx::FuncCode lyx::LFUN_MATH_DISPLAY
2695 * \li Action: Creates a new displayed equation in text mode.
2696 Toggles inlined/display formula in math mode.
2697 * \li Syntax: math-display [<ARG>]
2698 * \li Params: <ARG>: this argument will be passed to #LFUN_MATH_INSERT when creating
2699 new equation from the text mode.
2700 * \li Origin: Alejandro, 18 Jun 1996
2703 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
2706 * \var lyx::FuncCode lyx::LFUN_MATH_EXTERN
2707 * \li Action: Calls external program and passes the current expression/equation
2708 as an argument for the calculation in the format appropriate to the
2710 * \li Notion: Selection can be used to determine the input for the external program.
2711 * \li Syntax: math-extern <LANG> [<COMMAND>]
2712 * \li Params: <LANG>: octave|maxima|maple|mathematica|script \n
2713 where "script" stands for the external script (normalized
2714 expression will be passed)
2715 * \li Origin: Andre, 24 Apr 2001
2716 * \li Sample: math-extern maple simplify
2719 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
2722 * \var lyx::FuncCode lyx::LFUN_MATH_FONT_STYLE
2723 * \li Action: Changes the text style used in math.
2724 * \li Syntax: math-font-style <STYLE>
2725 * \li Params: <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf|textnormal\n
2726 |textrm|textsf|texttt|textbf|textmd|textit|textsc|textsl|textup
2727 * \li Origin: vfr, 9 jan 2009
2730 { LFUN_MATH_FONT_STYLE, "math-font-style", Noop, Math },
2733 * \var lyx::FuncCode lyx::LFUN_MATH_INSERT
2734 * \li Action: Inserts math objects and symbols.
2735 * \li Syntax: math-insert <ARG>
2736 * \li Params: <ARG>: Symbol or LaTeX code to be inserted.
2737 * \li Notion: When <ARG> is a _single_ math inset with more than one cell
2738 (such as "x_y^z" or "\frac{x}{y}"), the content of cell(0) is
2739 replaced by the current selection (only works if the selection
2740 is in mathed). As an example, if "abc" is selected in mathed,
2741 "math-insert \frac{x}{y}" replaces "abc" with "\frac{abc}{y}",
2742 and "math-insert x_y^z" replaces "abc" with "abc_y^z".
2743 If nothing is selected (or the selection is not in mathed),
2744 math-insert works as expected.
2747 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
2750 * \var lyx::FuncCode lyx::LFUN_MATH_LIMITS
2751 * \li Action: Toggles the position of the limits from above/below to the right
2752 side an vice versa in integral symbol, a limit, a summation, etc.
2753 * \li Notion: Put the cursor before the symbol with the limits and then invoke
2755 * \li Syntax: math-limits [<STATE>]
2756 * \li Params: <STATE>: limits|nolimits
2759 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
2762 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO
2763 * \li Action: Inserts a math macro definition at the cursor position in the text.
2764 * \li Syntax: math-macro <NAME> [<NARGS>] [def]
2765 * \li Params: <NAME>: The name of the macro, e.g. "mymacro".\n
2766 <NARGS>: The number of parameters of the macro. Default is 0.
2767 "def": Has no effect anymore, just for compatibility with former LyX versions.
2768 * \li Origin: ale, 10 May 1997; sts, 21 Dec 2007
2771 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
2774 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
2775 * \li Action: Add a greedy optional parameter.
2776 * \li Notion: Add a greedy optional parameter which eats the value
2777 from the following cells in mathed which are in the [value]
2779 * \li Syntax: math-macro-add-greedy-optional-param
2780 * \li Origin: sts, 06 January 2008
2783 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
2786 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
2787 * \li Action: Add an optional parameter.
2788 * \li Notion: Insert an optional parameter just behind the
2789 already existing optional parameters.
2790 * \li Syntax: math-macro-add-optional-param
2791 * \li Origin: sts, 06 January 2008
2794 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
2797 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
2798 * \li Action: Add a parameter.
2799 * \li Notion: Add a parameter to a Math Macro.
2800 * \li Params: <NUM>: The number of the parameter behind which the new one
2801 will be added (1 for the first, i.e. use 0 for add a
2802 parameter at the left), defaults to the last one.
2803 * \li Syntax: math-macro-add-param <NUM>
2804 * \li Origin: sts, 06 January 2008
2807 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
2810 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
2811 * \li Action: Append a greedy parameter.
2812 * \li Notion: Append a greedy parameter to a Math Macro which
2813 eats the following mathed cell in every instance of
2814 the macro in the buffer.
2815 * \li Syntax: math-macro-append-greedy-param
2816 * \li Origin: sts, 06 January 2008
2819 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
2822 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
2823 * \li Action: Fold a Math Macro.
2824 * \li Notion: Fold the Math Macro the cursor is in if it was
2825 unfolded, i.e. displayed as \foo before.
2826 * \li Syntax: math-macro-fold
2827 * \li Origin: sts, 06 January 2008
2830 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
2833 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
2834 * \li Action: Make a parameter non-optional.
2835 * \li Notion: Turn the last optional parameter of a Math Macro
2836 into a non-optional parameter. The default value is
2837 remembered to be reused later if the user changes his mind.
2838 * \li Syntax: math-macro-make-nonoptional
2839 * \li Origin: sts, 06 January 2008
2842 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
2845 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
2846 * \li Action: Make a parameter optional.
2847 * \li Notion: Turn the first non-optional parameter of a Math Macro
2848 into an optional parameter with a default value.
2849 * \li Syntax: math-macro-make-optional
2850 * \li Origin: sts, 06 January 2008
2853 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
2856 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
2857 * \li Action: Remove a greedy parameter.
2858 * \li Notion: Remove a greedy parameter of a Math Macro and spit
2859 out the values of it in every instance of the macro
2860 in the buffer. If it is an optional parameter the [valud]
2862 * \li Syntax: math-macro-remove-greedy-param
2863 * \li Origin: sts, 06 January 2008
2866 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
2869 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
2870 * \li Action: Remove the last optional parameter.
2871 * \li Notion: Remove the last optional parameter of a Math Macro and
2872 remove it in all the instances of the macro in the buffer.
2873 * \li Syntax: math-macro-remove-optional-param
2874 * \li Origin: sts, 06 January 2008
2877 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
2880 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
2881 * \li Action: Remove the last parameter.
2882 * \li Notion: Remove the last parameter of a Math Macro and
2883 remove its value in all instances of the macro
2885 * \li Params: <NUM>: The number of the parameter to be deleted (1 for
2886 the first), defaults to the last one.
2887 * \li Syntax: math-macro-remove-param <NUM>
2888 * \li Origin: sts, 06 January 2008
2891 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
2894 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
2895 * \li Action: Unfold a Math Macro.
2896 * \li Notion: Unfold the Math Macro the cursor is in, i.e.
2898 * \li Syntax: math-macro-unfold
2899 * \li Origin: sts, 06 January 2008
2902 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
2905 * \var lyx::FuncCode lyx::LFUN_MATH_MATRIX
2906 * \li Action: Inserts a matrix.
2907 * \li Syntax: math-matrix <COLS> <ROWS> [<ALIGN>]
2908 * \li Params: <ALIGN>: Alignment is a word composed of the vertical alignment
2909 (b, c or t) (i.e. 1 char) and the horizontal alignments
2910 (l, c or r) (i.e. <COL> chars).
2911 * \li Sample: math-matrix 3 3 bccc
2914 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
2917 * \var lyx::FuncCode lyx::LFUN_MATH_MODE
2918 * \li Action: In text mode enters math mode (i.e. puts math insets on the current
2919 cursor position), in math mode enters text mode inside math expression.
2920 * \li Notion: If there is some selected text, it puts the text inside created math box.
2921 * \li Syntax: math-mode [on|<ARG>]
2922 * \li Params: <ARG>: eventual argument (LaTeX code) is passed to #LFUN_MATH_INSERT .\n
2923 "on": allow only entering of math mode from text mode.
2924 * \li Origin: Alejandro, 4 Jun 1996
2927 { LFUN_MATH_MODE, "math-mode", Noop, Math },
2930 * \var lyx::FuncCode lyx::LFUN_MATH_MUTATE
2931 * \li Action: Mutates the type of math inset to the newly selected one.
2932 * \li Syntax: math-mutate <TYPE>
2933 * \li Params: <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
2934 multline|gather|flalign
2935 * \li Origin: Andre, 23 May 2001
2938 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
2941 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
2942 * \li Action: Toggles numbering of the current formula line.
2943 * \li Notion: Must be in display formula mode.
2944 * \li Syntax: math-number-line-toggle
2945 * \li Origin: Alejandro, 18 Jun 1996
2948 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
2951 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
2952 * \li Action: Toggles numbering/labeling of the current formula.
2953 * \li Notion: Must be in display formula mode.
2954 * \li Syntax: math-number-toggle
2955 * \li Origin: Alejandro, 4 Jun 1996
2958 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
2961 * \var lyx::FuncCode lyx::LFUN_MATH_SIZE
2962 * \li Action: Changes arbitrarily the size used by math fonts inside a context.
2963 * \li Notion: Provides an interface to the LaTeX math mode font size commands.
2964 * \li Syntax: math-size <STYLE>
2965 * \li Params: <STYLE>: \displaystyle|\textstyle|\scriptstyle|\scriptscriptstyle
2966 * \li Origin: Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
2969 { LFUN_MATH_SIZE, "math-size", Noop, Math },
2972 * \var lyx::FuncCode lyx::LFUN_MATH_SPACE
2973 * \li Action: Inserts space into math expression.
2974 * \li Notion: Use spacebar after entering this space to change type of space.
2975 * \li Syntax: math-space [<TYPE>] [<LEN>]
2976 * \li Params: <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace \n
2977 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad \n
2978 custom space: hspace \n
2979 "," used by default.\n
2980 Note that ! is equivalent to negthinspace, , = thinspace,
2981 : = medspace, and ; = thickspace.\n
2982 <LEN>: length for custom spaces (hspace)
2983 * \li Origin: Andre, 25 Jul 2001; sanda, 16 Jun 2008
2986 { LFUN_MATH_SPACE, "math-space", Noop, Math },
2989 * \var lyx::FuncCode lyx::LFUN_MATH_SUBSCRIPT
2990 * \li Action: Enters subscript expression in math expression.
2991 * \li Syntax: math-subscript
2992 * \li Origin: vermeer, 12 Dec 2001
2995 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
2998 * \var lyx::FuncCode lyx::LFUN_MATH_SUPERSCRIPT
2999 * \li Action: Enters superscript expression in math expression.
3000 * \li Syntax: math-superscript
3001 * \li Origin: vermeer, 12 Dec 2001
3004 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
3007 * \var lyx::FuncCode lyx::LFUN_MENU_OPEN
3008 * \li Action: Opens the menu given by its name.
3009 * \li Syntax: menu-open <NAME>
3010 * \li Params: <NAME>: menu name. See various .inc files in lib/ui for candidates.
3013 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
3016 * \var lyx::FuncCode lyx::LFUN_MESSAGE
3017 * \li Action: Shows message in statusbar (for script purposes).
3018 * \li Syntax: message <STRING>
3019 * \li Origin: Lgb, 8 Apr 2001
3022 { LFUN_MESSAGE, "message", NoBuffer, System },
3025 * \var lyx::FuncCode lyx::LFUN_META_PREFIX
3026 * \li Action: Simulate halting Meta key (Alt key on PCs).
3027 * \li Notion: Used for buffer edition not for GUI control.
3028 * \li Syntax: meta-prefix
3031 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
3034 * \var lyx::FuncCode lyx::LFUN_MOUSE_DOUBLE
3035 * \li Action: This function is called when double click on mouse button is
3036 pressed (inside workarea). Action depends on the context.
3037 * \li Notion: This is an internal LFUN, not to be used by users.
3038 * \li Origin: Andre, 9 Aug 2002
3041 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
3044 * \var lyx::FuncCode lyx::LFUN_MOUSE_MOTION
3045 * \li Action: This function is called when mouse cursor is moving over the text.
3046 Action depends on the context.
3047 * \li Notion: This is an internal LFUN, not to be used by users.
3048 * \li Origin: Andre, 9 Aug 2002
3051 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
3054 * \var lyx::FuncCode lyx::LFUN_MOUSE_PRESS
3055 * \li Action: This function is called when mouse button is pressed (inside workarea).
3056 Action depends on the context.
3057 * \li Notion: This is an internal LFUN, not to be used by users.
3058 * \li Origin: Andre, 9 Aug 2002
3061 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
3064 * \var lyx::FuncCode lyx::LFUN_MOUSE_RELEASE
3065 * \li Action: This function is called when mouse button is released (inside workarea).
3066 Action depends on the context.
3067 * \li Notion: This is an internal LFUN, not to be used by users.
3068 * \li Origin: Andre, 9 Aug 2002
3071 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
3075 * \var lyx::FuncCode lyx::LFUN_MOUSE_TRIPLE
3076 * \li Action: This function is called when triple click on mouse button is
3077 pressed (inside workarea). Action depends on the context.
3078 * \li Notion: This is an internal LFUN, not to be used by users.
3079 * \li Origin: Andre, 9 Aug 2002
3082 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
3085 * \var lyx::FuncCode lyx::LFUN_NEWLINE_INSERT
3086 * \li Action: Inserts a line break or new line.
3087 * \li Syntax: newline-insert [<ARG>]
3088 * \li Params: <ARG>: <newline|linebreak> default: newline
3089 * \li Origin: spitz, 25 Mar 2008
3092 { LFUN_NEWLINE_INSERT, "newline-insert", Noop, Edit },
3095 * \var lyx::FuncCode lyx::LFUN_NEWPAGE_INSERT
3096 * \li Action: Inserts a new page.
3097 * \li Syntax: newpage-insert <ARG>
3098 * \li Params: <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
3099 * \li Origin: uwestoehr, 24 Nov 2007
3102 { LFUN_NEWPAGE_INSERT, "newpage-insert", Noop, Edit },
3105 * \var lyx::FuncCode lyx::LFUN_NOMENCL_INSERT
3106 * \li Action: Inserts Nomenclature entry.
3107 * \li Notion: It automatically takes the word on the cursor position if no symbol is given.
3108 * \li Syntax: nomencl-insert [<SYMBOL>]
3109 * \li Origin: Ugras, 4 Nov 2006
3112 { LFUN_NOMENCL_INSERT, "nomencl-insert", Noop, Edit },
3115 * \var lyx::FuncCode lyx::LFUN_NOMENCLATURE_PRINT
3116 * \li Action: Inserts list of Nomenclature entries.
3117 * \li Syntax: nomenclature-print
3118 * \li Origin: Ugras, 4 Nov 2006
3121 { LFUN_NOMENCL_PRINT, "nomencl-print", Noop, Edit },
3125 * \var lyx::FuncCode lyx::LFUN_NOTE_INSERT
3126 * \li Action: Inserts Note on the current cursor position,
3127 move selection inside the inset.
3128 * \li Syntax: note-insert [<TYPE>]
3129 * \li Params: <TYPE>: <Note|Greyedout|Comment> default: Note
3132 { LFUN_NOTE_INSERT, "note-insert", Noop, Edit },
3135 * \var lyx::FuncCode lyx::LFUN_NOTE_NEXT
3136 * \li Action: Moves the cursor to the beginning of next Note inset.
3137 * \li Syntax: note-next
3140 { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
3143 * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
3144 * \li Action: Move the current group in the downward direction in the
3145 structure of the document.
3146 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
3147 the whole substructure of the group.
3148 * \li Syntax: outline-down
3149 * \li Origin: Vermeer, 23 Mar 2006
3152 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
3155 * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
3156 * \li Action: Moves the current group in the downward direction in the
3157 hierarchy of the document structure.
3158 * \li Notion: Part -> Chapter -> Section -> etc.
3159 * \li Syntax: outline-in
3160 * \li Origin: Vermeer, 23 Mar 2006
3163 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
3166 * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
3167 * \li Action: Moves the current group in the upward direction in the
3168 hierarchy of the document structure.
3169 * \li Notion: Part <- Chapter <- Section <- etc.
3170 * \li Syntax: outline-out
3171 * \li Origin: Vermeer, 23 Mar 2006
3174 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
3178 * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
3179 * \li Action: Move the current group in the upward direction in the
3180 structure of the document.
3181 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
3182 the whole substructure of the group.
3183 * \li Syntax: outline-up
3184 * \li Origin: Vermeer, 23 Mar 2006
3187 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
3190 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_BREAK
3191 * \li Action: Breaks the current paragraph at the current location.
3192 * \li Notion: Removes the selection.
3193 * \li Syntax: paragraph-break [<LAYOUT>] [ignoresep]
3194 * \li Params: <LAYOUT>: "inverse" - decreases depth by one (or change layout
3195 to default layout) when the cursor is at the end of
3197 ignoresep: Do not account for paragraph separators while breaking.
3200 { LFUN_PARAGRAPH_BREAK, "paragraph-break", Noop, Edit },
3203 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN
3204 * \li Action: Move the cursor to the next paragraph (or beginning of the current one)
3205 in downward direction.
3206 * \li Syntax: paragraph-down
3207 * \li Origin: Asger, 1 Oct 1996
3210 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
3213 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN_SELECT
3214 * \li Action: Move the cursor and select the text to the next paragraph (or
3215 beginning of the current one) in downward direction.
3216 * \li Syntax: paragraph-down-select
3217 * \li Origin: Asger, 1 Oct 1996
3220 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
3223 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
3224 * \li Action: Jump to a paragraph given by its id number and optionally the
3225 desired position within the paragraph.
3226 If given four arguments id_start, pos_start, id_end, pos_end,
3227 perform a selection from start to end.
3228 * \li Notion: Note that id number of paragraph is not the sequential number of
3229 paragraph seen on the screen. Moreover the id is unique for all
3230 opened buffers (documents). Both ids must belong to the same
3232 * \li Syntax: paragraph-goto <PAR_ID> <POS_IN_PAR> [<PAR_ID> <POS_IN_PAR>]
3233 * \li Params: <PAR_ID>: paragraph id \n
3234 <POS_IN_PAR>: desired position within the paragraph
3235 * \li Origin: Dekel, 26 Aug 2000
3239 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly | NoInternal, Edit },
3242 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
3243 * \li Action: Moves the current paragraph downwards in the document.
3244 * \li Syntax: paragraph-move-down
3245 * \li Origin: Edwin, 8 Apr 2006
3248 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
3251 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
3252 * \li Action: Moves the current paragraph upwards in the document.
3253 * \li Notion: Movement through the document will possibly break the paragraph-depth
3254 (e.g. itemize structure).
3255 * \li Syntax: paragraph-move-up
3256 * \li Origin: Edwin, 8 Apr 2006
3259 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
3263 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
3264 * \li Action: Change paragraph settings.
3265 * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
3266 This function only modifies, and does not override, existing settings.
3267 Note that the "leftindent" indent setting is deprecated.
3268 * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
3269 * \li Params: <INDENT>: \noindent|\indent|\indent-toggle|\leftindent LENGTH\n
3270 <SPACING>: \paragraph_spacing default|single|onehalf|double|other SIZE \n
3271 <ALIGN>: \align block|left|right|center|default\n
3272 <OTHERS>: \labelwidthstring WIDTH|\start_of_appendix
3273 * \li Origin: rgh, Aug 15 2007
3276 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
3279 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
3280 * \li Action: Change paragraph settings.
3281 * \li Notion: Overwrite all nonspecified settings to the default ones.
3282 Use paragraph-params lfun if you don't want to overwrite others settings.
3283 * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
3284 * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
3285 * \li Origin: leeming, 30 Mar 2004
3288 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
3291 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP
3292 * \li Action: Move the cursor to the next paragraph (or beginning of the current one)
3293 in upward direction.
3294 * \li Syntax: paragraph-up
3295 * \li Origin: Asger, 1 Oct 1996
3298 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
3301 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UPDATE
3302 * \li Action: Updates the values inside the paragraph dialog from the paragraph.
3303 * \li Notion: This is an internal LFUN, not to be used by users. Called internally
3304 by #LFUN_DIALOG_UPDATE.
3305 * \li Origin: leeming, 13 Mar 2003
3308 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
3311 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_SELECT
3312 * \li Action: Move cursor to beginning of current paragraph
3313 and select to the end in downward direction
3314 * \li Notion: This function is by default bound to triple mouse click
3315 * \li Syntax: paragraph-select
3316 * \li Origin: Kornel, 16 Apr 2019
3319 { LFUN_PARAGRAPH_SELECT, "paragraph-select", ReadOnly, Edit },
3322 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP_SELECT
3323 * \li Action: Move the cursor and select the text to the next paragraph (or
3324 beginning of the current one) in upward direction.
3325 * \li Syntax: paragraph-up-select
3326 * \li Origin: Asger, 1 Oct 1996
3329 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
3332 * \var lyx::FuncCode lyx::LFUN_PASTE
3333 * \li Action: Pastes material (text or picture) from the active clipboard.
3334 * \li Syntax: paste [<TYPE>|<NUM>]
3335 * \li Params: <TYPE>: emf|pdf|png|jpeg|linkback|wmf|latex|html \n
3336 <NUM>: number of the selection in the internal clipboard stack to be pasted.
3339 { LFUN_PASTE, "paste", Noop, Edit },
3342 * \var lyx::FuncCode lyx::LFUN_PHANTOM_INSERT
3343 * \li Action: Inserts phantom on the current cursor position,
3344 move selection inside the inset.
3345 * \li Syntax: phantom-insert [<TYPE>]
3346 * \li Params: <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
3347 * \li Origin: uwestoehr, 30 Jan 2009
3350 { LFUN_PHANTOM_INSERT, "phantom-insert", Noop, Edit },
3353 * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
3354 * \li Action: Save user preferences.
3355 * \li Syntax: preferences-save
3356 * \li Origin: Lgb, 27 Nov 1999
3359 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
3362 * \var lyx::FuncCode lyx::LFUN_PREVIEW_INSERT
3363 * \li Action: Inserts a new preview inset.
3364 * \li Syntax: preview-insert
3365 * \li Origin: vfr, 28 Mar 2010
3368 { LFUN_PREVIEW_INSERT, "preview-insert", Noop, Edit },
3371 * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
3372 * \li Action: Pastes the currently selected text.
3373 * \li Notion: Primary selection mechanism is linux-only thing.
3374 * \li Syntax: primary-selection-paste [<ARG>]
3375 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
3378 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
3381 * \var lyx::FuncCode lyx::LFUN_QUOTE_INSERT
3382 * \li Action: Inserts quotes according to the type and quote-language preference.
3383 * \li Notion: Currently 15 different quote styles are distinguished (see params).
3384 * \li Syntax: quote-insert [<LEVEL>] [<SIDE>] [<STYLE>]
3385 * \li Params: <LEVEL>: 'inner' for (i.e., secondary, usually single) quotes, otherwise
3386 * outer (i.e., primary, usually double) quotes will be used.\n
3387 * <SIDE>: 'opening' for opening quotes, 'closing' for closing quotes,
3388 * otherwise the side will be guessed from the context.\n
3389 * <STYLE>: 'british' for `British' quote style (with ``inner quotation'')\n
3390 * 'cjk' for Chinese/Japanese/Korean corner bracket quotation marks\n
3391 * 'cjk-angle' for Chinese/Japanese/Korean angle bracket quotation marks\n
3392 * 'danish' for >>Danish<< quote style (with >inner quotation<)\n
3393 * 'english' for ``English'' quote style (with `inner quotation')\n
3394 * 'french' for <<french>> quote style (with ``inner quotation'')\n
3395 * 'frenchin' for <<frenchin>> quote style (with <<inner quotation>>) ["in" = Imprimerie Nationale]\n
3396 * 'german' for ,,German`` quote style (with ,inner quotation`)\n
3397 * 'plain' for "Plain" quote style (with 'inner quotation')\n
3398 * 'polish' for ,,Polish'' quote style (with ,inner quotation')\n
3399 * 'swedish' for ''Swedish'' quote style (with 'inner quotation')\n
3400 * 'swedishg' for >>swedishg>> quote style (with 'inner quotation') ["g" = Guillemets]\n
3401 * 'swiss' for <<Swiss>> quote style (with <inner quotation>)\n
3402 * 'russian' for <<Russian>> quote style (with ,,inner quotation``)\n
3403 * 'dynamic' for Dynamic quotation marks which inherit the global
3405 * If no quote style is specified, the document-wide will be used.
3408 { LFUN_QUOTE_INSERT, "quote-insert", Noop, Edit },
3411 * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
3412 * \li Action: Reconfigure the automatic settings.
3413 * \li Syntax: reconfigure
3414 * \li Origin: Asger, 14 Feb 1997
3417 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
3420 * \var lyx::FuncCode lyx::LFUN_REDO
3421 * \li Action: Redoes the last thing undone.
3425 { LFUN_REDO, "redo", ReadOnly, Edit },
3428 * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
3429 * \li Action: Go to the next label or cross-reference.
3430 * \li Syntax: reference-next
3431 * \li Origin: Dekel, 14 Jan 2001
3434 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
3438 * \var lyx::FuncCode lyx::LFUN_REGEXP_MODE
3439 * \li Action: Enters regexp mode (i.e., puts regexp insets on the current
3440 cursor position). Used by the advanced search dialog.
3441 * \li Notion: If there is any selected text, then it is moved inside the created
3443 * \li Syntax: regexp-mode [<ARG>]
3444 * \li Params: <ARG>: eventual argument (regular expression).
3445 * \li Origin: Tommaso, 4 Oct 2008
3448 { LFUN_REGEXP_MODE, "regexp-mode", Noop, Math },
3451 * \var lyx::FuncCode lyx::LFUN_REPEAT
3452 * \li Action: Repeat the given command.
3453 * \li Notion: fails when the repeat count is greater than 10000.
3454 * \li Syntax: repeat <COUNT> <LFUN-COMMAND>
3455 * \li Origin: Andre, 27 Oct 2003
3458 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
3461 * \var lyx::FuncCode lyx::LFUN_SEARCH_IGNORE
3462 * \li Action: Enables/disables searching for features in findadv
3463 * \li Syntax: search-ignore <type> <value>
3464 * \li Params: <type>: language|color|sectioning|font|series|shape|family|markup|underline|strike
3465 * \li Params: <value>: true|false
3468 { LFUN_SEARCH_IGNORE, "search-ignore", ReadOnly|NoBuffer|NoUpdate, System },
3471 * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN
3472 * \li Action: Moves the cursor one page in downward direction.
3473 * \li Syntax: screen-down
3476 { LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit },
3479 * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN_SELECT
3480 * \li Action: Moves the cursor one screen in downward direction adding the current
3481 position to the selection.
3482 * \li Syntax: screen-down-select
3485 { LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit },
3488 * \var lyx::FuncCode lyx::LFUN_SCREEN_FONT_UPDATE
3489 * \li Action: Update fonts and its metrics.
3490 * \li Notion: Automatically called after zoom, dpi, font names, or norm change.
3491 * \li Syntax: screen-font-update
3492 * \li Origin: ARRae, 13 Aug 2000
3495 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
3498 * \var lyx::FuncCode lyx::LFUN_SCREEN_RECENTER
3499 * \li Action: Recenters the screen on the current cursor position.
3500 * \li Syntax: screen-recenter
3503 { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit },
3507 * \var lyx::FuncCode lyx::LFUN_SCREEN_SHOW_CURSOR
3508 * \li Action: Repositions the screen such that the cursor is visible.
3509 * \li Syntax: screen-show-cursor
3510 * \li Origin: vfr, 25 Mar 2009
3513 { LFUN_SCREEN_SHOW_CURSOR, "screen-show-cursor", ReadOnly, Edit },
3517 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP
3518 * \li Action: Moves the cursor one page in upward direction.
3519 * \li Syntax: screen-up
3522 { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit },
3525 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP_SELECT
3526 * \li Action: Moves the cursor one page in upward direction adding the current
3527 position to the selection.
3528 * \li Syntax: screen-up-select
3531 { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit },
3534 * \var lyx::FuncCode lyx::LFUN_SCRIPT_INSERT
3535 * \li Action: Inserts a subscript or superscript inset.
3536 * \li Syntax: script-insert <TYPE>
3537 * \li Params: <TYPE>: subscript|superscript
3538 * \li Origin: Georg, 23 Nov 2010
3541 { LFUN_SCRIPT_INSERT, "script-insert", Noop, Edit },
3544 * \var lyx::FuncCode lyx::LFUN_SCROLL
3545 * \li Action: Scroll the buffer view.
3546 * \li Notion: Only scrolls the screen up or down; does not move the cursor.
3547 * \li Syntax: scroll <TYPE> <QUANTITY>
3548 * \li Params: <TYPE>: line|page\n
3549 <QUANTITY>: up|down|<number>
3550 * \li Origin: Abdel, Dec 27 2007
3553 { LFUN_SCROLL, "scroll", ReadOnly, Edit },
3556 * \var lyx::FuncCode lyx::LFUN_SECTION_SELECT
3557 * \li Action: Select the whole section.
3558 * \li Notion: The cursor should be in a section heading
3559 before calling this lfun.
3560 * \li Syntax: section-select
3561 * \li Origin: vfr, 05 May 2009
3564 { LFUN_SECTION_SELECT, "section-select", ReadOnly, Edit },
3568 * \var lyx::FuncCode lyx::LFUN_SELECTION_PASTE
3569 * \li Action: Pastes the internal selection text in permanent selection.
3570 * \li Notion: Created in order to have middle mouse button pasting correct (bound to
3571 command-alternatives selection-paste ; primary-selection-paste paragraph).
3572 * \li Syntax: selection-paste
3573 * \li Origin: lasgouttes, 14 Jan 2009
3576 { LFUN_SELECTION_PASTE, "selection-paste", Noop, Edit },
3579 * \var lyx::FuncCode lyx::LFUN_SELF_INSERT
3580 * \li Action: Inserts the given string (accordingly to the correct keymap).
3581 * \li Notion: Automatically replace the currently selected text. Depends on lyxrc
3582 settings "auto_region_delete".
3583 * \li Syntax: self-insert <STRING>
3586 { LFUN_SELF_INSERT, "self-insert", SingleParUpdate, Hidden },
3589 * \var lyx::FuncCode lyx::LFUN_SEPARATOR_INSERT
3590 * \li Action: Inserts an environment separator or latex paragraph break.
3591 * \li Syntax: separator-insert [<ARG>]
3592 * \li Params: <ARG>: <plain|parbreak|latexpar> default: plain
3593 * \li Origin: ef, 2 May 2014
3596 { LFUN_SEPARATOR_INSERT, "separator-insert", Noop, Edit },
3599 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_FILENAME
3600 * \li Action: Returns path and file name of the currently edited document.
3601 * \li Syntax: server-get-filename
3604 { LFUN_SERVER_GET_FILENAME, "server-get-filename", ReadOnly, System },
3607 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_LAYOUT
3608 * \li Action: Returns the current layout (that is environment) name
3609 on the cursor position.
3610 * \li Syntax: server-get-layout
3613 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
3616 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_STATISTICS
3617 * \li Action: Returns the statistics (number of words and characters)
3618 in the document or in the given selection.
3619 * \li Notion: Note that this function gives the number of words/chars written,
3620 not the number of characters which will be typeset.
3621 * \li Syntax: server-get-statistics [<TYPE>]
3622 * \li Params: <TYPE>: <words|chars|chars-space> The requested count; if not
3623 specified, the three values are returned, separated
3625 words: count words.\n
3626 chars: count characters.\n
3627 chars-space: count characters and spaces.
3628 * \li Origin: brokenclock, Oct 10 2014
3631 { LFUN_SERVER_GET_STATISTICS, "server-get-statistics", ReadOnly, System },
3634 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
3635 * \li Action: Returns the coordinates of cursor position in the editing area.
3636 * \li Syntax: server-get-xy
3639 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
3643 * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
3644 * \li Action: Sets the cursor position in LyX based on the row number of generated TeX file.
3645 * \li Notion: This can be useful for DVI inverse-search or detection of the problematic
3646 line from LaTeX compilation. Note that before this function can be used
3647 export to LaTeX output must occur (in order to map the row numbers).
3648 * \li Syntax: server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
3649 * \li Params: <FILE>: the path and filename. Environment variables are expanded in the path.
3650 In case this LFUN does not work make sure you are giving correct
3652 If the file is located inside LyX temporary directory it will be
3653 mapped back into the appropriate opened buffer (e.g. for the case
3654 of generated .tex file).\n
3655 .ext: extensions will be automatically replaced by .lyx.\n
3656 <ROW_NUMBER> The row number of the LaTeX file to which to go.
3657 * \li Sample: server-goto-file-row /home/user/example.lyx 41\n
3658 server-goto-file-row /tmp/lyx_tmpdir.XM3088/lyx_tmpbuf0/example.tex 41
3659 * \li Origin: Edmar, 23 Dec 1998
3662 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly | NoBuffer, System },
3665 * \var lyx::FuncCode lyx::LFUN_SERVER_NOTIFY
3666 * \li Action: Sends notify message about the last key-sequence to client.
3667 * \li Notion: This can be used to grab last key-sequence used inside the LyX window.
3668 See also Debug extensions section in Additional features manual.
3669 * \li Syntax: server-notify
3672 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
3675 * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
3676 * \li Action: Sets the cursor position based on the editing area coordinates
3677 (similar to clicking on that point with left mouse button).
3678 * \li Syntax: server-set-xy <X> <Y>
3681 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
3684 * \var lyx::FuncCode lyx::LFUN_SET_COLOR
3685 * \li Action: Set the given LyX color to the color defined by the X11 name given.
3686 * \li Notion: A new color entry is created if the color is unknown.
3687 Color names can be stored as a part of user settings.
3688 * \li Syntax: set-color <LYX_NAME> <X11_NAME>
3689 * \li Origin: SLior, 11 Jun 2000
3692 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
3695 * \var lyx::FuncCode lyx::LFUN_GRAPHICS_SET_GROUP
3696 * \li Action: Set the group for the graphics inset on the cursor position.
3697 * \li Syntax: graphics-set-group [<GROUP>]
3698 * \li Params: <GROUP>: Id for an existing group. In case the Id is an empty string,
3699 the graphics inset is removed from the current group.
3700 * \li Origin: sanda, 6 May 2008
3703 { LFUN_GRAPHICS_SET_GROUP, "graphics-set-group", Noop, Edit },
3706 * \var lyx::FuncCode lyx::LFUN_GRAPHICS_UNIFY
3707 * \li Action: Set the same group for all graphics insets in the marked block.
3708 * \li Syntax: graphics-unify [<GROUP>]
3709 * \li Params: <GROUP>: Id for an existing group. In case the Id is an empty string,
3710 the group Id from the first graphics inset will be used.
3711 * \li Origin: sanda, 7 Feb 2018
3714 { LFUN_GRAPHICS_UNIFY, "graphics-unify", Noop, Edit },
3717 * \var lyx::FuncCode lyx::LFUN_GRAPHICS_RELOAD
3718 * \li Action: Reloads the image if necessary.
3719 * \li Syntax: graphics-reload
3720 * \li Origin: vfr, 10 Aug 2009
3723 { LFUN_GRAPHICS_RELOAD, "graphics-reload", ReadOnly | AtPoint, Edit },
3726 * \var lyx::FuncCode lyx::LFUN_SPACE_INSERT
3727 * \li Action: Inserts one of horizontal space insets.
3728 * \li Syntax: space-insert <NAME> [<LEN>]
3729 * \li Params: <NAME>: normal, protected, visible, thin, quad, qquad, enspace,
3730 enskip, negthinspace, negmedspace, negthickspace, hfill,
3731 hfill*, dotfill, hrulefill, hspace, hspace* \n
3732 Only in math mode: med and thick.\n
3733 <LEN>: length for custom spaces (hspace, hspace* for protected)
3734 * \li Origin: spitz, 20 May 2003, Mar 17 2008
3737 { LFUN_SPACE_INSERT, "space-insert", Noop, Edit },
3740 * \var lyx::FuncCode lyx::LFUN_SPECIALCHAR_INSERT
3741 * \li Action: Inserts various characters into the document.
3742 * \li Syntax: specialchar-insert <CHAR>
3743 * \li Params: <CHAR>: hyphenation, allowbreak, ligature-break, slash,
3744 nobreakdash, dots, end-of-sentence, menu-separator,
3745 lyx, tex, latex, latex2e.
3746 * \li Origin: spitz, 6 Dec 2007
3749 { LFUN_SPECIALCHAR_INSERT, "specialchar-insert", Noop, Edit },
3752 * \var lyx::FuncCode lyx::LFUN_SPELLING_ADD
3753 * \li Action: Add the word under the cursor to the respective
3754 * spell checker dictionary.
3755 * The default for the language is retrieved from the cursor position.
3756 * \li Syntax: spelling-add [<STRING>] [<LANG>]
3757 * \li Params: <WORD>: word to add
3758 <LANG>: language name (see file languages)
3759 * \li Origin: spitz, 18 Jan 2010
3762 { LFUN_SPELLING_ADD, "spelling-add", ReadOnly, Edit },
3765 * \var lyx::FuncCode lyx::LFUN_SPELLING_CONTINUOUSLY
3766 * \li Action: Toggle continuous spell checking.
3767 * \li Syntax: spelling-continuously
3768 * \li Origin: vfr, 24 March 2013
3771 { LFUN_SPELLING_CONTINUOUSLY, "spelling-continuously", ReadOnly, Edit },
3775 * \var lyx::FuncCode lyx::LFUN_SPELLING_IGNORE
3776 * \li Action: Let the spell checker ignore the word under the cursor
3777 * in the current session for the given language.
3778 * The default for the language is retrieved from the cursor position.
3779 * \li Syntax: spelling-ignore [<WORD>] [<LANG>]
3780 * \li Params: <WORD>: word to ignore
3781 <LANG>: language name (see file languages)
3782 * \li Origin: spitz, 18 Jan 2010
3785 { LFUN_SPELLING_IGNORE, "spelling-ignore", ReadOnly, Edit },
3788 * \var lyx::FuncCode lyx::LFUN_SPELLING_REMOVE
3789 * \li Action: Remove the word under the cursor from the respective
3790 * spell checker dictionary.
3791 * The default for the language is retrieved from the cursor position.
3792 * \li Syntax: spelling-remove [<STRING>] [<LANG>]
3793 * \li Params: <WORD>: word to remove
3794 * <LANG>: language name (see file languages)
3795 * \li Origin: SWitt, 28 July 2010
3798 { LFUN_SPELLING_REMOVE, "spelling-remove", ReadOnly, Edit },
3802 * \var lyx::FuncCode lyx::LFUN_STATISTICS
3803 * \li Action: Count the statistics (number of words and characters)
3804 in the document or in the given selection and display it
3806 * \li Notion: Note that this function gives the number of words/chars written,
3807 not the number of characters which will be typeset.
3808 * \li Syntax: statistics
3809 * \li Origin: lasgouttes, Jan 27 2004; sanda, Jan 8 2008
3812 { LFUN_STATISTICS, "statistics", ReadOnly, System },
3815 * \var lyx::FuncCode lyx::LFUN_TABULAR_FEATURE
3816 * \li Action: Modify properties of tabulars and table-like math environments.
3817 * \li Syntax: tabular-feature <FEATURE> [<ARG>]
3818 * \li Params: Generally see #LFUN_INSET_INSERT for further details.\n
3819 * <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|\n
3820 copy-column|move-column-right|move-column-left|move-row-down|move-row-up|\n
3821 set-line-top|set-line-bottom|set-line-left|set-line-right|\n
3822 toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|\n
3823 set-ltrim-top|set-rtrim-top|set-ltrim-bottom|set-rtrim-bottom\n
3824 toggle-ltrim-top|toggle-rtrim-top|toggle-ltrim-bottom|toggle-rtrim-bottom\n
3825 align-left|align-right|align-center|align-block|align-decimal|set-decimal-point|\n
3826 valign-top|valign-bottom|valign-middle|longtabular-align-left|\n
3827 longtabular-align-center|longtabular-align-right|m-align-left|m-align-right|\n
3828 m-align-center|m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|\n
3829 reset-formal-default|set-all-lines|unset-all-lines|toggle-longtabular|\n
3830 set-longtabular|unset-longtabular|set-pwidth|\n
3831 set-mpwidth|set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|\n
3832 set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|\n
3833 unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|\n
3834 set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|\n
3835 set-special-column|set-special-multicolumn|set-special-multirow|\n
3836 toggle-booktabs|set-booktabs|unset-booktabs|set-top-space|set-bottom-space|\n
3837 set-interline-space|set-border-lines|tabular-valign-top|\n
3838 tabular-valign-middle|tabular-valign-bottom|set-tabular-width|\n
3839 toggle-varwidth-column
3840 Various math-environment features are handled as well, e.g. add-vline-left/right for\n
3841 the Grid/Array environment.\n
3842 <ARG>: additional argument for some commands, use debug mode to explore its values.
3843 * \li Origin: gm, 10 Dec 2015
3846 { LFUN_TABULAR_FEATURE, "tabular-feature", Noop, Edit },
3849 * \var lyx::FuncCode lyx::LFUN_TABULAR_INSERT
3850 * \li Action: Inserts table into the document.
3851 * \li Notion: See #LFUN_TABULAR_FEATURE for some more details
3852 about tabular modifications.
3853 * \li Syntax: tabular-insert [<ROWS> <COLUMNS>]
3854 * \li Params: In case no arguments are given show insert dialog.
3855 * \li Origin: Jug, 12 Apr 2000
3858 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
3861 * \var lyx::FuncCode lyx::LFUN_TABULAR_STYLE_INSERT
3862 * \li Action: Inserts table of a given style into the document.
3863 * \li Notion: See #LFUN_TABULAR_FEATURE for some more details
3864 about tabular modifications.
3865 * \li Syntax: tabular-style-insert <style> <ROWS> <COLUMNS>
3866 * \li Params: Valid styles are the names of the files in lib/tabletemplates,
3867 * minus _1x<n> and .lyx suffix.
3868 * \li Origin: spitz, 25 Mar 2019
3871 { LFUN_TABULAR_STYLE_INSERT, "tabular-style-insert", Noop, Edit },
3874 * \var lyx::FuncCode lyx::LFUN_TAB_DELETE
3875 * \li Action: Delete a tab or up to an equivalent amount of spaces from
3877 * \li Notion: It also works on a selection - it removes a tab or spaces from the
3878 beginning of each line spanned by the selection. This is useful if
3879 you want to indent/unindent multiple lines in one action.
3880 * \li Syntax: tab-delete
3881 * \li Origin: vfr, Sep 30 2008
3884 { LFUN_TAB_DELETE, "tab-delete", SingleParUpdate, Edit },
3887 * \var lyx::FuncCode lyx::LFUN_TAB_GROUP_CLOSE
3888 * \li Action: Close the current tab group.
3889 * \li Notion: This only closes the work areas, not the buffers themselves.
3890 The still opened buffers can be visualized in another tab group.
3891 * \li Syntax: tab-group-close
3892 * \li Origin: Abdel, 21 Feb 2008
3895 { LFUN_TAB_GROUP_CLOSE, "tab-group-close", ReadOnly, Buffer },
3899 * \var lyx::FuncCode lyx::LFUN_TAB_INSERT
3900 * \li Action: Insert a tab into a listings inset.
3901 * \li Notion: It also works on a selection.
3902 * \li Syntax: tab-insert
3903 * \li Origin: vfr, Sep 30 2008
3906 { LFUN_TAB_INSERT, "tab-insert", SingleParUpdate, Edit },
3909 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
3910 * \li Action: Sets the text class for the current buffer.
3911 * \li Syntax: textclass-apply <TEXTCLASS>
3912 * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
3913 the filename, minus the ".layout" extension.
3916 { LFUN_TEXTCLASS_APPLY, "textclass-apply", NoInternal, Layout },
3919 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
3920 * \li Action: Loads information for a textclass from disk.
3921 * \li Syntax: textclass-load <TEXTCLASS>
3922 * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
3923 the filename, minus the ".layout" extension.
3926 { LFUN_TEXTCLASS_LOAD, "textclass-load", NoInternal, Layout },
3930 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_APPLY
3931 * \li Action: Apply last used text properties.
3932 * \li Syntax: textstyle-apply [<NUM>]
3933 * \li Params: <NUM>: number of the selection in the internal freefonts stack to be applied.
3934 * \li Notion: These properties are stored via #LFUN_TEXTSTYLE_UPDATE, which is
3935 automatically triggered when using Text Style dialog.
3936 * \li Syntax: textstyle-apply
3937 * \li Origin: leeming, 12 Mar 2003
3940 { LFUN_TEXTSTYLE_APPLY, "textstyle-apply", Noop, Layout },
3943 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_UPDATE
3944 * \li Action: Apply text style and update the settings to be used by #LFUN_TEXTSTYLE_APPLY.
3945 * \li Syntax: textstyle-update <FONT_INFO>
3946 * \li Params: <FONT_INFO>: specifies font attributes, e.g. family, series, shape,
3947 size, emph, noun, underbar, number, color, language,
3949 Use lyx -dbg action for exact syntax of text-style
3951 * \li Origin: leeming, 12 Mar 2003
3954 { LFUN_TEXTSTYLE_UPDATE, "textstyle-update", Noop, Layout },
3957 * \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
3958 * \li Action: Look up thesaurus entries with respect to the word under the cursor.
3959 * \li Syntax: thesaurus-entry [<STRING>] [lang=<LANG>]
3960 * \li Params: <STRING>: word to look up
3961 <LANG>: language (see file languages)
3962 * \li Origin: Levon, 20 Jul 2001
3965 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
3968 * \var lyx::FuncCode lyx::LFUN_TOOLBAR_MOVABLE
3969 * \li Action: Toggles movability of a given toolbar between true/false.
3970 * \li Syntax: toolbar-movable <NAME>
3971 * \li Params: <NAME>: *|standard|extra|table|math|mathmacrotemplate|
3972 minibuffer|review|view/update|math_panels|vcs|
3973 view-others|update-others
3974 * \li Origin: daniel, 12 July 2016
3977 { LFUN_TOOLBAR_MOVABLE, "toolbar-movable", NoBuffer, Buffer },
3980 * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
3981 * \li Action: Toggles visibility of a given toolbar between on/off/auto.
3982 * \li Notion: Skipping "auto" when allowauto is false.
3983 * \li Syntax: toolbar-toggle <NAME> [allowauto]
3984 * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|\n
3985 minibuffer|review|view/update|math_panels|vcs|
3986 view-others|update-others
3987 * \li Origin: Edwin, 21 May 2007
3990 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
3993 * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
3994 * \li Action: Various UI visibility-toggling actions.
3995 * \li Syntax: ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
3996 * \li Params: statusbar : Toggle visibility of the statusbar.\n
3997 menubar : Toggle visibility of the menubar.\n
3998 scrollbar : Toggle visibility of the scrollbar.\n
3999 frame : Toggle visibility of the frames around editing window.\n
4000 fullscreen : Toggle fullscreen mode. This also covers calling the
4001 previous functions. However #LFUN_TOOLBAR_TOGGLE for the
4002 custom tweaks of the toolbars should be used.
4003 * \li Origin: sanda, 9 Feb 2007
4006 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
4010 * \var lyx::FuncCode lyx::LFUN_UNDO
4011 * \li Action: Undoes the last edit.
4015 { LFUN_UNDO, "undo", ReadOnly, Edit },
4018 * \var lyx::FuncCode lyx::LFUN_UNICODE_INSERT
4019 * \li Action: Inserts a single unicode character.
4020 * \li Syntax: unicode-insert <CHAR1> <CHAR2> ...
4021 * \li Params: <CHARn>: The character to insert, given as its code
4022 point, in hexadecimal.
4023 * \li Sample: unicode-insert 0x0100 0x0259
4024 * \li Origin: Lgb, 22 Oct 2006
4027 { LFUN_UNICODE_INSERT, "unicode-insert", Noop, Edit },
4030 * \var lyx::FuncCode lyx::LFUN_UP
4031 * \li Action: Moves the cursor one line in upward direction.
4035 { LFUN_UP, "up", ReadOnly | NoUpdate, Edit },
4038 * \var lyx::FuncCode lyx::LFUN_UP_SELECT
4039 * \li Action: Moves the cursor one line in upward direction adding the current
4040 position to the selection.
4041 * \li Syntax: up-select
4044 { LFUN_UP_SELECT, "up-select", ReadOnly | SingleParUpdate, Edit },
4047 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_IN
4048 * \li Action: Checks-in/commits the changes of the registered file to the repository.
4049 * \li Notion: In RCS case this also unlocks the file.
4050 * \li Syntax: vc-check-in
4051 * \li Origin: Lgb, 1 Jul 1997
4054 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
4057 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_OUT
4058 * \li Action: Checks-out the document for edit (and locks it in some cases).
4059 * \li Syntax: vc-check-out
4060 * \li Origin: Lgb, 1 Jul 1997
4063 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
4066 * \var lyx::FuncCode lyx::LFUN_VC_COMMAND
4067 * \li Action: Executes external command. This command is intended to support
4068 additional VCS commands.
4069 * \li Syntax: vc-command <FLAG> <PATH> <COMMAND>
4070 * \li Params: <FLAG>: Flags for the command can be combined together.\n
4071 U - dUmmy - no flags \n
4072 D - Doc - need document loaded to proceed \n
4073 I - dIrty - mark document dirty \n
4074 R - Reload - ensure that the document is saved and reload it after command execution \n
4075 M - Message - ask for input string (commit message)\n
4076 <PATH>: path where to start. $$p will be replaced by the current document path.\n
4077 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current
4078 document(with absolute path)/path/message.
4079 * \li Sample: vc-command DR $$p "svn up"
4080 * \li Origin: sanda, 13 Jan 2009
4083 { LFUN_VC_COMMAND, "vc-command", NoBuffer | ReadOnly, System },
4086 * \var lyx::FuncCode lyx::LFUN_VC_COMPARE
4087 * \li Action: Compares two revisions of the same file under version control.
4088 * \li Syntax: vc-compare [<REV1>] [<REV2>]
4089 * \li Params: Revision number either points directly to commit in history
4090 or if negative number -x it points to (last commit - x).\n
4091 In RCS we subtract only in the last number of revision specification.
4092 Special case "0" is reserved for the last committed revision.\n
4093 <REV1>: Older file.\n
4094 <REV2>: Newer file. Used only if REV1 > 0.\n
4095 If no parameter is given, interactive dialog will be shown.
4096 * \li Sample: Compare current document against last commit\n
4098 Compare current document against current revision - 5 commits\n
4100 Compare revisions 120 and 155\n
4102 * \li Origin: sanda, 12 Feb 2010
4105 { LFUN_VC_COMPARE, "vc-compare", ReadOnly, System },
4109 * \var lyx::FuncCode lyx::LFUN_VC_COPY
4110 * \li Action: Copies the document to another name.
4111 * \li Notion: Copying with revision history is only supported by SVN.
4112 For RCS and CVS it is simulated by adding the document
4114 Disabled if uncommitted changes exist.
4115 * \li Syntax: vc-copy <FILENAME>
4116 * \li Params: <FILENAME>: New name of the document.\n
4117 * A file dialog is opened if no filename is given.
4118 * \li Origin: gb, 05 Feb 2013
4121 { LFUN_VC_COPY, "vc-copy", ReadOnly, System },
4124 * \var lyx::FuncCode lyx::LFUN_VC_LOCKING_TOGGLE
4125 * \li Action: Toggles the locking property of the edited file.
4126 * \li Notion: This is currently implemented only for SVN.
4127 * \li Syntax: vc-locking-toggle
4128 * \li Origin: sanda, 25 Jun 2009
4131 { LFUN_VC_LOCKING_TOGGLE, "vc-locking-toggle", ReadOnly, System },
4134 * \var lyx::FuncCode lyx::LFUN_VC_REGISTER
4135 * \li Action: Register the document as an file inside version control system.
4136 * \li Notion: File is registered inside cvs, svn or rcs repository acording to the existence
4137 of cvs/svn/rcs entries in the document's directory. \n
4138 See LyX Additional Features Manual (Version Control Chapter) for additional
4140 * \li Syntax: vc-register
4141 * \li Origin: Lgb, 1 Jul 1997
4144 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
4147 * \var lyx::FuncCode lyx::LFUN_VC_RENAME
4148 * \li Action: Renames the document to another name.
4149 * \li Notion: Renaming with revision history is only supported by SVN.
4150 For CVS it is simulated by adding the document under a new
4151 name and deleting the old one. For RCS it is not supported.
4152 Disabled if uncommitted changes exist.
4153 * \li Syntax: vc-rename <FILENAME>
4154 * \li Params: <FILENAME>: New name of the document.\n
4155 * A file dialog is opened if no filename is given.
4156 * \li Origin: gb, 05 Feb 2013
4159 { LFUN_VC_RENAME, "vc-rename", ReadOnly, System },
4162 * \var lyx::FuncCode lyx::LFUN_VC_REPO_UPDATE
4163 * \li Action: Update the local archive directory in which resides
4164 the current document with the remote repository.
4165 * \li Syntax: vc-repo-update
4166 * \li Origin: sanda, 16 Oct 2009
4169 { LFUN_VC_REPO_UPDATE, "vc-repo-update", ReadOnly, System },
4172 * \var lyx::FuncCode lyx::LFUN_VC_REVERT
4173 * \li Action: Reverts the document to the last check-in/commit in VCS.
4174 * \li Syntax: vc-revert
4175 * \li Origin: Lgb, 1 Jul 1997
4178 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
4181 * \var lyx::FuncCode lyx::LFUN_VC_UNDO_LAST
4182 * \li Action: Undo last check-in.
4183 * \li Notion: This is currently implemented only for RCS.
4184 * \li Syntax: vc-check-out
4185 * \li Origin: Lgb, 1 Jul 1997
4188 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
4191 * \var lyx::FuncCode lyx::LFUN_VIEW_CLOSE
4192 * \li Action: Close the current document work area.
4193 * \li Notion: Close the current work area. If no other work areas are showing the buffer,
4194 then close the associated buffer as well.
4195 * \li Syntax: view-close
4196 * \li Origin: Tommaso, 15 Sep 2012
4199 { LFUN_VIEW_CLOSE, "view-close", ReadOnly, Buffer },
4203 * \var lyx::FuncCode lyx::LFUN_VIEW_SPLIT
4204 * \li Action: Creates another split view of current buffer.
4205 * \li Notion: All split views act in the same way independently.
4206 * \li Syntax: view-split <vertical|horizontal>
4207 * \li Params: horizontal : The work areas are laid out side by side.\n
4208 vertical : The work areas laid out vertically.
4209 * \li Origin: Abdel, 20 Feb 2008
4212 { LFUN_VIEW_SPLIT, "view-split", ReadOnly, Buffer },
4216 * \var lyx::FuncCode lyx::LFUN_WINDOW_CLOSE
4217 * \li Action: Closes the current LyX window.
4218 * \li Syntax: window-close
4219 * \li Origin: Abdel, 23 Oct 2006
4222 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
4226 * \var lyx::FuncCode lyx::LFUN_WINDOW_NEW
4227 * \li Action: Creates new empty LyX window.
4228 * \li Notion: Already opened documents from the previous window can be found under View menu.
4229 * \li Syntax: window-new [<GEOMETRY>]
4230 * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently
4231 accepted only on Windows platform.
4232 * \li Origin: Abdel, 21 Oct 2006
4235 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
4238 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD
4239 * \li Action: Moves the cursor to the logically previous beginning of a word.
4240 * \li Notion: This is not the action which should be bound to the arrow keys,
4241 because backwards may be left or right, depending on the
4242 language. The arrow keys should be bound to #LFUN_WORD_LEFT or
4243 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
4244 * \li Syntax: word-backward
4247 { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit },
4250 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD_SELECT
4251 * \li Action: Moves the cursor to the logically previous beginning of a word,
4252 adding the logically traversed text to the selection.
4253 * \li Notion: See also #LFUN_WORD_BACKWARD.
4254 * \li Syntax: word-backward-select
4257 { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
4260 * \var lyx::FuncCode lyx::LFUN_WORD_CAPITALIZE
4261 * \li Action: Capitalizes the words in the selection (i.e. the first letters)
4262 or the first letter of word at cursor position.
4263 * \li Syntax: word-capitalize [<SEL_TYPE>]
4264 * \li Params: <SEL_TYPE>: if this is equal to "partial", then the
4265 * default word starts at cursor position (emacs-style).
4266 * Otherwise, the whole word is considered.
4269 { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
4272 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_BACKWARD
4273 * \li Action: Deletes characters to the beginning of the word (usually the "C+BackSpace" key).
4274 * \li Syntax: word-delete-backward [force]
4275 * \li Params: force: Delete big insets, do not only select them.
4278 { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
4281 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_FORWARD
4282 * \li Action: Deletes characters to the end of the word (usually the "C+Delete" key).
4283 * \li Syntax: word-delete-forward [force]
4284 * \li Params: force: Delete big insets, do not only select them.
4287 { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
4290 * \var lyx::FuncCode lyx::LFUN_WORD_FIND
4291 * \li Action: Search for next occurrence of a string.
4292 * \li Syntax: word-find [<DATA>]
4293 * \li Params: <DATA>: data encoded from Find dialog (see #lyx::find2string()).
4294 If no parameter is given, search with last find-dialog
4295 data is used for search (i.e. find-next).
4296 * \li Origin: Andre, Jan 7 2004
4299 { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
4302 * \var lyx::FuncCode lyx::LFUN_WORD_FINDADV
4303 * \li Action: Search for next occurrence of a pattern.
4304 * \li Syntax: word-findadv [<DATA>]
4305 * \li Params: <DATA>: data encoded from FindAdv dialog (see #lyx::findadv2string()).
4306 If no parameter is given, search with last find-dialog
4307 data is used for search (i.e. find-next).
4308 * \li Origin: Tommaso, Nov 15 2007
4311 { LFUN_WORD_FINDADV, "word-findadv", ReadOnly | NoBuffer, Edit },
4314 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_BACKWARD
4315 * \li Action: Search for a given string in backward direction.
4316 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
4317 * \li Syntax: word-find-backward [<STRING>]
4318 * \li Origin: Etienne, 20 Feb 1998
4321 { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
4324 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_FORWARD
4325 * \li Action: Search for a given string in forward direction.
4326 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
4327 * \li Syntax: word-find-forward [<STRING>]
4328 * \li Origin: Etienne, 16 Feb 1998
4331 { LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit },
4334 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD
4335 * \li Action: Moves the cursor to the logically next beginning of a word.
4336 * \li Notion: This is not the action which should be bound to the arrow keys,
4337 because forward may be left or right, depending on the language.
4338 The arrow keys should be bound to #LFUN_WORD_LEFT or
4339 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
4340 * \li Syntax: word-forward
4343 { LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
4346 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD_SELECT
4347 * \li Action: Moves the cursor to the logically next beginning of a word,
4348 adding the logically traversed text to the selection.
4349 * \li Notion: See also #LFUN_WORD_FORWARD.
4350 * \li Syntax: word-forward-select
4353 { LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
4356 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT
4357 * \li Action: Moves the cursor to the next beginning of a word "on the left".
4358 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
4359 "left" key is pressed. Generally, it moves the cursor to the
4360 next beginning of a word on the left. However, in Bidi text this
4361 become slightly more complicated, and there are different modes
4362 of cursor movement. In "visual mode", this moves left, plain and
4363 simple. In "logical mode", movement is logically forward in RTL
4364 paragraphs, and logically backwards in LTR paragraphs.
4365 * \li Syntax: word-left
4366 * \li Origin: dov, 28 Oct 2007
4369 { LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
4372 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT_SELECT
4373 * \li Action: Moves the cursor to the next beginning of a word "on the left",
4374 adding *logically* traversed text to the selection.
4375 * \li Notion: See also #LFUN_WORD_LEFT for exact details of the movement.
4376 * \li Syntax: word-left-select
4377 * \li Origin: dov, 28 Oct 2007
4380 { LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit },
4383 * \var lyx::FuncCode lyx::LFUN_WORD_LOWCASE
4384 * \li Action: Change the words in the selection or word at cursor position
4386 * \li Syntax: word-lowcase [<SEL_TYPE>]
4387 * \li Params: <SEL_TYPE>: if this is equal to "partial", then the
4388 * default word starts at cursor position (emacs-style).
4389 * Otherwise, the whole word is considered.
4392 { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
4395 * \var lyx::FuncCode lyx::LFUN_WORD_REPLACE
4396 * \li Action: Replace a string in the document.
4397 * \li Syntax: word-replace [<DATA>]
4398 * \li Params: <DATA>: data is of the form
4401 <casesensitive> <matchword> <all> <forward> <findnext>"
4402 * \li Origin: Andre, Jan 7 2004
4405 { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
4408 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT
4409 * \li Action: Moves the cursor to the next beginning of a word "on the right".
4410 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
4411 "right" key is pressed. Generally, it moves the cursor to the
4412 next beginning of a word on the right. However, in Bidi text
4413 this become slightly more complicated, and there are different
4414 modes of cursor movement. In "visual mode", this moves right,
4415 plain and simple. In "logical mode", movement is logically
4416 forward in LTR paragraphs, and logically backwards in RTL
4418 * \li Syntax: word-right
4419 * \li Origin: dov, 28 Oct 2007
4422 { LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit },
4425 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT_SELECT
4426 * \li Action: Moves the cursor to the next beginning of a word "on the right",
4427 adding *logically* traversed text to the selection.
4428 * \li Notion: See also #LFUN_WORD_RIGHT for exact details of the movement.
4429 * \li Syntax: word-right-select
4430 * \li Origin: dov, 28 Oct 2007
4433 { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
4436 * \var lyx::FuncCode lyx::LFUN_WORD_SELECT
4437 * \li Action: Puts the word where the cursor stands into the selection.
4438 * \li Syntax: word-select
4439 * \li Origin: Andre, 11 Sep 2002
4442 { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
4445 * \var lyx::FuncCode lyx::LFUN_WORD_UPCASE
4446 * \li Action: Change the words in the selection or word at cursor position
4448 * \li Syntax: word-upcase [<SEL_TYPE>]
4449 * \li Params: <SEL_TYPE>: if this is equal to "partial", then the
4450 * default word starts at cursor position (emacs-style).
4451 * Otherwise, the whole word is considered.
4454 { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
4457 * \var lyx::FuncCode lyx::LFUN_WRAP_INSERT
4458 * \li Action: Inserts floats wrapped by the text around.
4459 * \li Syntax: wrap-insert <TYPE>
4460 * \li Params: <TYPE>: table|figure
4461 * \li Origin: Dekel, 7 Apr 2002
4464 { LFUN_WRAP_INSERT, "wrap-insert", Noop, Edit },
4466 { LFUN_NOACTION, "", Noop, Hidden }
4467 #ifndef DOXYGEN_SHOULD_SKIP_THIS
4470 for (int i = 0; items[i].action != LFUN_NOACTION; ++i)
4471 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
4477 LyXAction::LyXAction()
4483 FuncRequest LyXAction::lookupFunc(string const & func) const
4485 string const func2 = trim(func);
4488 return FuncRequest(LFUN_NOACTION);
4491 string const arg = split(func2, cmd, ' ');
4493 FuncMap::const_iterator const fit = lyx_func_map.find(cmd);
4495 return fit != lyx_func_map.end()
4496 ? FuncRequest(fit->second, arg)
4497 : FuncRequest(LFUN_UNKNOWN_ACTION);
4501 string const LyXAction::getActionName(FuncCode action) const
4503 InfoMap::const_iterator const it = lyx_info_map.find(action);
4504 return it != lyx_info_map.end() ? it->second.name : string();
4508 LyXAction::FuncType LyXAction::getActionType(FuncCode action) const
4510 InfoMap::const_iterator const it = lyx_info_map.find(action);
4511 return it != lyx_info_map.end() ? it->second.type : Hidden;
4515 bool LyXAction::funcHasFlag(FuncCode action,
4516 LyXAction::FuncAttribs flag) const
4518 InfoMap::const_iterator ici = lyx_info_map.find(action);
4520 if (ici == lyx_info_map.end()) {
4521 LYXERR0("action: " << action << " is not known.");
4522 LASSERT(false, return false);
4525 return ici->second.attrib & flag;
4529 LyXAction::const_iterator LyXAction::func_begin() const
4531 return lyx_func_map.begin();
4535 LyXAction::const_iterator LyXAction::func_end() const
4537 return lyx_func_map.end();
4541 LyXErr & operator<<(LyXErr & l, FuncCode code)
4544 l.stream() << lyxaction.getActionName(code);