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
898 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
901 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
902 * \li Action: Save all changed documents.
903 * \li Syntax: buffer-write-all
904 * \li Origin: rgh, gpothier 6 Aug 2007
907 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
910 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
911 * \li Action: Rename and save current buffer.
912 * \li Syntax: buffer-write-as <FILENAME>
913 * \li Params: <FILENAME>: New name of the buffer/file. A relative path
914 is with respect to the original location of the buffer/file.
917 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
920 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS_TEMPLATE
921 * \li Action: Rename and save current buffer in the local templates directory.
922 * \li Syntax: buffer-write-as-template <FILENAME>
923 * \li Params: <FILENAME>: New name of the buffer/file. A relative path
924 is with respect to the original location of the buffer/file.
927 { LFUN_BUFFER_WRITE_AS_TEMPLATE, "buffer-write-as-template", ReadOnly, Buffer },
931 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXTERNAL_MODIFICATION_CLEAR
932 * \li Action: Clear the external modification flag on the current buffer.
933 * \li Syntax: buffer-external-modification-clear
934 * \li Origin: gm, 2 March 2017
937 { LFUN_BUFFER_EXTERNAL_MODIFICATION_CLEAR,
938 "buffer-external-modification-clear", ReadOnly, Buffer },
941 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM
942 * \li Action: Sets the zoom of the screen fonts.
943 * \li Syntax: buffer-zoom [<ZOOM>]
944 * \li Params: <ZOOM>: The target zoom value in %;
945 * the default is the default zoom as saved in preferences.
946 * \li Origin: daniel, 28 Oct 2016
949 { LFUN_BUFFER_ZOOM, "buffer-zoom", ReadOnly, Buffer },
952 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_IN
953 * \li Action: Increases the zoom of the screen fonts.
954 * \li Syntax: buffer-zoom-in [<ZOOM>]
955 * \li Params: <ZOOM>: The zoom value addition in % (neg. or pos.);
956 * the default is 10% of the default zoom as saved in preferences.
957 * \li Origin: vfr, 30 Mar 2009
960 { LFUN_BUFFER_ZOOM_IN, "buffer-zoom-in", ReadOnly, Buffer },
964 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_OUT
965 * \li Action: Decreases the zoom of the screen fonts.
966 * \li Syntax: buffer-zoom-out [<ZOOM>]
967 * \li Params: <ZOOM>: The zoom value abstraction in % (neg. or pos.);
968 * the default is 10% of the default zoom as saved in preferences.
969 * \li Origin: vfr, 30 Mar 2009
972 { LFUN_BUFFER_ZOOM_OUT, "buffer-zoom-out", ReadOnly, Buffer },
976 * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
977 * \li Action: Generates the code (literate programming).
978 * \li Notion: Latex file with extension \literate_extension is generated.
979 Then LyX invokes \build_command (with a default of ``make'') to generate the code and
980 \build_error_filter to process the compilation error messages. \n
981 In case you want to process your literate file with a script, or some other program,
982 just insert in your lyxrc file an entry with:\n
983 \build_command "my_script my_arguments" \n
984 The \build_error_filter differs from the \literate_error_filter only in that the
985 former will identify error messages from your compiler.
986 * \li Syntax: build-program
989 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
993 * \var lyx::FuncCode lyx::LFUN_CALL
994 * \li Action: Executes a command defined in a .def file.
995 * \li Notion: The definitions are by default read from lib/commands/default.def.\n
996 A .def file allows to define a command with \define "<NAME>" "<LFUN>"
997 where <NAME> is the name of the new command and <LFUN> is the lfun code
998 to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
999 \def_file "FileName" allows to include another .def file. \n
1000 This is particularly useful in connection with toolbar buttons:
1001 Since the name of the button image for this lfun is
1002 lib/images/commands/<NAME>.png this is the way to assign an image
1003 to a complex command-sequence.
1004 * \li Syntax: call <NAME>
1005 * \li Params: <NAME>: Name of the command that must be called.
1006 * \li Origin: broider, 2 Oct 2007
1009 { LFUN_CALL, "call", NoBuffer, System },
1012 * \var lyx::FuncCode lyx::LFUN_CANCEL
1013 * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
1014 * \li Syntax: cancel
1017 { LFUN_CANCEL, "cancel", NoBuffer, System },
1021 * \var lyx::FuncCode lyx::LFUN_CAPTION_INSERT
1022 * \li Action: Inserts a caption inset.
1023 * \li Syntax: caption-insert
1024 * \li Origin: Lgb, 18 Jul 2000
1027 { LFUN_CAPTION_INSERT, "caption-insert", Noop, Edit },
1030 * \var lyx::FuncCode lyx::LFUN_CELL_BACKWARD
1031 * \li Action: Moves the cursor to the previous cell inside the table.
1032 * \li Syntax: cell-backward
1033 * \li Origin: Jug, 22 May 2000
1036 { LFUN_CELL_BACKWARD, "cell-backward", ReadOnly | NoUpdate, Edit },
1039 * \var lyx::FuncCode lyx::LFUN_CELL_FORWARD
1040 * \li Action: Moves the cursor to the next cell inside the table.
1041 * \li Syntax: cell-forward
1044 { LFUN_CELL_FORWARD, "cell-forward", ReadOnly | NoUpdate, Edit },
1047 * \var lyx::FuncCode lyx::LFUN_CELL_SPLIT
1048 * \li Action: Splits cell and shifts right part to the next cell (inside the math grid).
1049 * \li Syntax: cell-split
1050 * \li Origin: Ale, 15 May 1997
1053 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
1057 * \var lyx::FuncCode lyx::LFUN_CHANGES_MERGE
1058 * \li Action: Open change tracking dialog for merging and moves the cursor
1059 to the position of the next change.
1060 * \li Syntax: changes-merge
1061 * \li Origin: Levon, 16 Oct 2002
1064 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
1067 * \var lyx::FuncCode lyx::LFUN_CHANGES_OUTPUT
1068 * \li Action: Toggles showing of change tracking in typeset output.
1069 * \li Syntax: changes-output
1070 * \li Origin: spitz, 21 Jan 2005
1073 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
1076 * \var lyx::FuncCode lyx::LFUN_CHANGES_TRACK
1077 * \li Action: Toggles change tracking to on/off.
1078 * \li Syntax: changes-track
1079 * \li Origin: levon, 1 Oct 2002
1082 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
1085 * \var lyx::FuncCode lyx::LFUN_CHANGE_ACCEPT
1086 * \li Action: Accepts tracked change inside the selection.
1087 * \li Syntax: change-accept
1088 * \li Origin: Levon, 16 Oct 2002
1091 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
1094 * \var lyx::FuncCode lyx::LFUN_CHANGE_NEXT
1095 * \li Action: Moves the cursor to the position of the next change
1096 of the change tracking records.
1097 * \li Syntax: change-next
1098 * \li Origin: schmitt, 4 Oct 2006
1101 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
1104 * \var lyx::FuncCode lyx::LFUN_CHANGE_PREVIOUS
1105 * \li Action: Moves the cursor to the position of the previous change
1106 of the change tracking records.
1107 * \li Syntax: change-previous
1108 * \li Origin: vfr, 4 Apr 2009
1111 { LFUN_CHANGE_PREVIOUS, "change-previous", ReadOnly, Edit },
1114 * \var lyx::FuncCode lyx::LFUN_CHANGE_REJECT
1115 * \li Action: Rejects tracked change inside the selection.
1116 * \li Syntax: change-reject
1117 * \li Origin: Levon, 16 Oct 2002
1120 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
1123 * \var lyx::FuncCode lyx::LFUN_CHARS_TRANSPOSE
1124 * \li Action: Transposes the character at the cursor with the one before it.
1125 * \li Syntax: chars-transpose
1126 * \li Origin: Lgb, 25 Apr 2001
1129 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
1133 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD
1134 * \li Action: Moves the cursor one position logically backwards.
1135 * \li Notion: This is not the action which should be bound to the arrow keys,
1136 because backwards may be left or right, depending on the
1137 language. The arrow keys should be bound to #LFUN_CHAR_LEFT or
1138 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
1139 * \li Syntax: char-backward
1142 { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit },
1145 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD_SELECT
1146 * \li Action: Moves the cursor one position logically backwards, adding
1147 traversed position to the selection.
1148 * \li Notion: See also #LFUN_CHAR_BACKWARD.
1149 * \li Syntax: char-backward-select
1152 { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit },
1155 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_BACKWARD
1156 * \li Action: Deletes one character in the backward direction (usually the "BackSpace" key).
1157 * \li Syntax: char-delete-backward [force]
1158 * \li Params: force: Delete big insets, do not only select them.
1161 { LFUN_CHAR_DELETE_BACKWARD, "char-delete-backward", SingleParUpdate, Edit },
1164 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_FORWARD
1165 * \li Action: Deletes one character in the backward direction (usually the "Delete" key).
1166 * \li Syntax: char-delete-forward [force]
1167 * \li Params: force: Delete big insets, do not only select them.
1170 { LFUN_CHAR_DELETE_FORWARD, "char-delete-forward", SingleParUpdate, Edit },
1173 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD
1174 * \li Action: Moves the cursor one position logically forward.
1175 * \li Notion: This is not the action which should be bound to the arrow keys,
1176 because forward may be left or right, depending on the language.
1177 The arrow keys should be bound to #LFUN_CHAR_LEFT or
1178 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
1179 * \li Syntax: char-forward
1182 { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit },
1185 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD_SELECT
1186 * \li Action: Moves the cursor one position logically forward, adding
1187 traversed position to the selection.
1188 * \li Notion: See also #LFUN_CHAR_FORWARD.
1189 * \li Syntax: char-forward-select
1192 { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit },
1195 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT
1196 * \li Action: Moves the cursor one position "to the left".
1197 * \li Notion: This is the action which should be taken when the "left" key
1198 is pressed. Generally, it moves the cursor one position to the
1199 left. However, in Bidi text this become slightly more
1200 complicated, and there are different modes of cursor movement.
1201 In "visual mode", this moves left, plain and simple. In "logical
1202 mode", movement is logically forward in RTL paragraphs, and
1203 logically backwards in LTR paragraphs.
1204 * \li Syntax: char-left
1207 { LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit },
1210 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT_SELECT
1211 * \li Action: Moves the cursor one position "to the left", adding
1212 traversed position to the selection.
1213 * \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement.
1214 * \li Syntax: char-left-select
1217 { LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit },
1220 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT
1221 * \li Action: Moves the cursor one position "to the right".
1222 * \li Notion: This is the action which should be taken when the "right" key
1223 is pressed. Generally, it moves the cursor one position to the
1224 right. However, in Bidi text this become slightly more
1225 complicated, and there are different modes of cursor movement.
1226 In "visual mode", this moves right, plain and simple. In "logical
1227 mode", movement is logically forward in LTR paragraphs, and
1228 logically backwards in RTL paragraphs.
1229 * \li Syntax: char-right
1232 { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit },
1235 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT_SELECT
1236 * \li Action: Moves the cursor one position "to the right", adding
1237 traversed position to the selection.
1238 * \li Notion: See also #LFUN_CHAR_RIGHT for exact details of the movement.
1239 * \li Syntax: char-right-select
1242 { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit },
1246 * \var lyx::FuncCode lyx::LFUN_CITATION_INSERT
1247 * \li Action: Inserts citation from loaded citation database.
1248 * \li Syntax: citation-insert [<KEY>[|<TEXT_BEFORE>]]
1249 * \li Params: <KEY>: Citation (shortcut listed in available citations). \n
1250 <TEXT_BEFORE>: text which should appear before citation.
1251 * \li Origin: AAS, 97-02-23
1254 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
1257 * \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE
1258 * \li Action: Pastes text from the active clipboard (retains formatting if the
1259 clipboard contains formatted text). Pastes plain text if plain text is
1260 on the clipboard, but tries to interpret it in special ways for certain
1261 insets, e.g. converting csv data to rows and columns if the paste happens
1263 * \li Notion: Historically, LFUN_CLIPBOARD_PASTE was introduced as a counterpart of
1264 LFUN_PRIMARY_SELECTION_PASTE: It behaved exactly the same, but the source
1265 is the clipboard, not the selection.
1266 * \li Syntax: clipboard-paste [<ARG>]
1267 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1268 * \li Origin: Georg, 10 Jul 2006
1271 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
1274 * \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE_SIMPLE
1275 * \li Action: Pastes plain text from the active clipboard even if formatted
1276 LyX content is in the clipboard. Pastes plain text if plain text
1277 is on the clipboard, without trying to interpret it in special
1278 ways for certain insets, e.g. converting csv data to rows and
1279 columns if the paste happens in a tabular inset.
1280 * \li Syntax: clipboard-paste-simple [<ARG>]
1281 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1284 { LFUN_CLIPBOARD_PASTE_SIMPLE, "clipboard-paste-simple", Noop, Edit },
1287 * \var lyx::FuncCode lyx::LFUN_COMMAND_ALTERNATIVES
1288 * \li Action: Runs the first listed command that is enabled.
1289 * \li Notion: This can be used to bind multiple functions to a single key,
1290 and then which one is used will depend upon the context.
1291 * \li Syntax: command-alternatives <CMDS>
1292 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
1293 * \li Sample: command-alternatives completion-accept;cell-forward
1294 * \li Origin: rgh, 24 September 2008
1297 { LFUN_COMMAND_ALTERNATIVES, "command-alternatives", NoBuffer, System },
1300 * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
1301 * \li Action: Switches the focus to the minibuffer so that the user can type
1302 in there. If necessary, it opens the minibuffer toolbar.
1303 * \li Notion: Usually bound to M-x shortcut.
1304 * \li Syntax: command-execute
1307 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
1311 * \var lyx::FuncCode lyx::LFUN_COMMAND_PREFIX
1312 * \li Action: Return the current key sequence and available options as a string.
1313 * \li Notion: No options are added if no current map exists. \n
1314 This is probably usable only with connection to lyxserver.
1315 * \li Syntax: command-prefix
1318 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
1321 * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
1322 * \li Action: Run more commands (LFUN and its parameters) in a sequence.
1323 * \li Syntax: command-sequence <CMDS>
1324 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
1325 * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
1326 * \li Origin: Andre, 11 Nov 1999
1329 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
1332 * \var lyx::FuncCode lyx::LFUN_COMPLETE
1333 * \li Action: Try to complete the word or command at the cursor position.
1334 * \li Syntax: complete
1335 * \li Origin: sts, Feb 19 2008
1338 { LFUN_COMPLETE, "complete", SingleParUpdate, Edit },
1342 * \var lyx::FuncCode lyx::LFUN_COMPLETION_ACCEPT
1343 * \li Action: Accept suggested completion.
1344 * \li Syntax: completion-accept
1345 * \li Origin: sanda, Sep 08 2008
1348 { LFUN_COMPLETION_ACCEPT, "completion-accept", SingleParUpdate, Edit },
1353 * \var lyx::FuncCode lyx::LFUN_COMPLETION_CANCEL
1354 * \li Action: Try to cancel completion, either the popup or the inline completion.
1355 * \li Syntax: completion-cancel
1356 * \li Origin: sts, Sep 07 2008
1359 { LFUN_COMPLETION_CANCEL, "completion-cancel", SingleParUpdate, Edit },
1362 * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
1363 * \li Action: Show the inline completion at the cursor position.
1364 * \li Syntax: completion-inline
1365 * \li Origin: sts, Feb 19 2008
1368 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
1371 * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
1372 * \li Action: Show the completion popup at the cursor position.
1373 * \li Syntax: completion-popup
1374 * \li Origin: sts, Feb 19 2008
1377 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
1380 * \var lyx::FuncCode lyx::LFUN_COPY
1381 * \li Action: Copies the current selection to the clipboard.
1385 { LFUN_COPY, "copy", ReadOnly, Edit },
1388 * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
1389 * \li Action: Determine whether to keep cursor inside the editing window regardless
1390 of the scrollbar movement.
1391 * \li Syntax: toggle-cursor-follows-scrollbar
1392 * \li Origin: ARRae, 2 Dec 1997
1395 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
1398 * \var lyx::FuncCode lyx::LFUN_CUT
1399 * \li Action: Cuts to the clipboard.
1403 { LFUN_CUT, "cut", Noop, Edit },
1406 * \var lyx::FuncCode lyx::LFUN_DEBUG_LEVEL_SET
1407 * \li Action: Set debug output level.
1408 * \li Syntax: debug-level-set <LEVEL>
1409 * \li Params: <LEVEL>: comma separated list of levels or the correspondent number
1410 of their combination. 0 is equivalent to disabling all debug
1411 events. See lyx -dbg for the current list of debug levels
1413 * \li Origin: sanda, 28 Dec 2009
1416 { LFUN_DEBUG_LEVEL_SET, "debug-level-set", NoBuffer, System },
1420 * \var lyx::FuncCode lyx::LFUN_DEPTH_DECREMENT
1421 * \li Action: Decrease the nesting depth of the (selected) paragraph(s)
1423 * \li Syntax: depth-decrement
1426 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
1429 * \var lyx::FuncCode lyx::LFUN_DEPTH_INCREMENT
1430 * \li Action: Increase the nesting depth of the (selected) paragraph(s)
1432 * \li Syntax: depth-increment
1435 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
1439 * \var lyx::FuncCode lyx::LFUN_DEVEL_MODE_TOGGLE
1440 * \li Action: toggle a mode where more information is given in UI
1441 * \li Syntax: devel-mode-toggle
1442 * \li Notion: in so called "devel" mode, the information given in the
1443 * status bar is more precise, and the help documents are
1444 * open in editing mode.
1445 * \li Origin: lasgouttes, 23 Jul 2017
1448 { LFUN_DEVEL_MODE_TOGGLE, "devel-mode-toggle", NoBuffer, System },
1452 * \var lyx::FuncCode lyx::LFUN_DIALOG_DISCONNECT_INSET
1453 * \li Action: Closes opened connection to opened inset.
1454 * \li Notion: Connection is used for apply functions.
1455 * \li Syntax: dialog-disconnect-inset <INSET-NAME>
1456 * \li Origin: leeming, 25 Feb 2003
1459 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
1463 * \var lyx::FuncCode lyx::LFUN_DIALOG_HIDE
1464 * \li Action: Hides showed dialog. Counterpart to #LFUN_DIALOG_SHOW .
1465 * \li Syntax: dialog-hide <NAME>
1466 * \li Params: See #LFUN_DIALOG_SHOW .
1467 * \li Origin: leeming, 25 Feb 2003
1470 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
1473 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW
1474 * \li Action: Shows hidden dialog or creates new one for a given function/inset settings etc.
1475 * \li Syntax: dialog-show <NAME> [<DATA>]
1476 * \li Params: <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|\n
1477 compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|\n
1478 graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimiter|\n
1479 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|\n
1480 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|\n
1481 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL> \n
1482 <SPECIAL>: latexlog|vclog \n
1483 <DATA>: data, usually settings for the given dialog. Use debug mode for the
1485 * \li Origin: leeming, 17 Jun 2003
1488 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
1491 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW_NEW_INSET
1492 * \li Action: Shows hidden dialog or create new one for a given inset settings etc.
1493 * \li Notion: Internally uses #LFUN_DIALOG_SHOW with processed data for a given inset.
1494 * \li Syntax: dialog-show-new-inset <NAME> [<DATA>]
1495 * \li Params: See #LFUN_DIALOG_SHOW .
1496 * \li Origin: leeming, 25 Feb 2003
1499 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
1502 * \var lyx::FuncCode lyx::LFUN_DIALOG_TOGGLE
1503 * \li Action: Toggles dialog between showed/hidden state.
1504 * \li Notion: Internally uses #LFUN_DIALOG_SHOW , #LFUN_DIALOG_HIDE .
1505 * \li Syntax: dialog-toggle <NAME> [<DATA>]
1506 * \li Params: See #LFUN_DIALOG_SHOW .
1507 * \li Origin: spitz, 30 Apr 2007
1510 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
1513 * \var lyx::FuncCode lyx::LFUN_DIALOG_UPDATE
1514 * \li Action: Updates the dialog values from the inset/paragraph/document.
1515 * \li Syntax: dialog-update <NAME>
1516 * \li Params: <NAME>: paragraph|prefs|<INSET> \n
1518 * \li Origin: leeming, 25 Feb 2003
1521 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
1524 * \var lyx::FuncCode lyx::LFUN_DOWN
1525 * \li Action: Moves the cursor one line in downward direction.
1529 { LFUN_DOWN, "down", ReadOnly | NoUpdate, Edit },
1532 * \var lyx::FuncCode lyx::LFUN_DOWN_SELECT
1533 * \li Action: Moves the cursor one line in downward direction adding the current
1534 position to the selection.
1535 * \li Syntax: down-select
1538 { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, Edit },
1541 * \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE
1542 * \li Action: Displays list of layout choices.
1543 * \li Notion: This LFUN opens the dropbox allowing for choice of layout.
1544 * \li Syntax: drop-layouts-choice
1547 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
1550 * \var lyx::FuncCode lyx::LFUN_ENVIRONMENT_SPLIT
1551 * \li Action: Splits the current environment with a Separator.
1552 * \li Syntax: environment-split [before|outer|previous]
1553 * \li Params: outer: If this is given, LyX will split the outermost environment in
1554 the current nesting hierarchy.\n
1555 previous: If this is given, LyX will split the environment in the previous
1556 paragraph (if there is one).\n
1557 before: If this is given, the new environment will be appended rather than
1559 * \li Origin: spitz, 23 Dec 2012
1562 { LFUN_ENVIRONMENT_SPLIT, "environment-split", Noop, Layout },
1566 * \var lyx::FuncCode lyx::LFUN_ERT_INSERT
1567 * \li Action: Inserts an ERT inset.
1568 * \li Syntax: ert-insert
1569 * \li Origin: Jug, 18 Feb 2000
1572 { LFUN_ERT_INSERT, "ert-insert", Noop, Edit },
1575 * \var lyx::FuncCode lyx::LFUN_ESCAPE
1576 * \li Action: Clears the selection. If no text is selected call #LFUN_FINISHED_FORWARD.
1577 Inside math mode jumps out of the math inset.
1578 * \li Syntax: escape
1579 * \li Origin: Lgb, 17 May 2001
1582 { LFUN_ESCAPE, "escape", ReadOnly, Edit },
1585 * \var lyx::FuncCode lyx::LFUN_EXPORT_CANCEL
1586 * \li Action: Cancel background export process.
1587 * \li Syntax: export-cancel
1588 * \li Origin: rgh, 10 December 2017
1591 { LFUN_EXPORT_CANCEL, "export-cancel", ReadOnly | NoUpdate | NoInternal, Edit },
1594 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
1595 * \li Action: Inserts another LyX file.
1596 * \li Syntax: file-insert [<FILE>] [ignorelang]
1597 * \li Params: <FILE>: Filename to be inserted.
1598 * ignorelang: If given, the (main) language of the inserted file
1599 * is ignored (the context language is used).
1602 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
1605 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
1606 * \li Action: Inserts plain text file.
1607 * \li Syntax: file-insert-plaintext [<FILE>]
1608 * \li Params: <FILE>: Filename to be inserted.
1609 * \li Origin: CFO-G, 19 Nov 1997
1612 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
1615 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
1616 * \li Action: Inserts plain text file as paragraph (i.e. join lines).
1617 * \li Syntax: file-insert-plaintext-para [<FILE>]
1618 * \li Params: <FILE>: Filename to be inserted.
1619 * \li Origin: Levon, 14 Feb 2001
1622 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
1625 * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
1626 * \li Action: Open LyX document.
1627 * \li Syntax: file-open [<FILE>]
1628 * \li Params: <FILE>: Filename to be opened.
1631 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
1635 * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
1636 * \li Action: Moves the cursor out of the current slice, going backwards.
1637 * \li Notion: See also #LFUN_FINISHED_FORWARD.
1640 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
1643 * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
1644 * \li Action: Moves the cursor out of the current slice, going forward.
1645 * \li Notion: Cursor movement within an inset may be different than cursor
1646 movement in the surrounding text. This action should be called
1647 automatically by the cursor movement within the inset, when
1648 movement within the inset has ceased (reached the end of the
1649 last paragraph, for example), in order to move correctly
1650 back into the surrounding text.
1653 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
1656 * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
1657 * \li Action: Moves the cursor out of the current slice, going left.
1658 * \li Notion: See also #LFUN_FINISHED_FORWARD.
1661 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
1665 * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
1666 * \li Action: Moves the cursor out of the current slice, going right.
1667 * \li Notion: See also #LFUN_FINISHED_FORWARD
1670 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
1673 * \var lyx::FuncCode lyx::LFUN_FLEX_INSERT
1674 * \li Action: Inserts CharStyle, Custom inset or XML short element.
1675 * \li Notion: Look into the Customization manual for more information about
1677 To make this command enabled the layout file for the document
1678 class you're using has to load the character styles. There are
1679 a few contained in the Logical Markup module. You can also of
1680 course create some yourself. \n
1681 For dissolving the element see #LFUN_INSET_DISSOLVE.
1682 * \li Syntax: flex-insert Name
1683 * \li Params: Name: This name must be defined either in your layout file
1684 or imported by some module. The definition is
1685 InsetLayout Name or InsetLayout <Flex:Name>. The Flex:
1687 * \li Sample: flex-insert Code
1690 { LFUN_FLEX_INSERT, "flex-insert", Noop, Edit },
1693 * \var lyx::FuncCode lyx::LFUN_FLOAT_INSERT
1694 * \li Action: Inserts a float inset.
1695 * \li Syntax: float-insert <TYPE>
1696 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
1697 "algorithm", "table", "figure" parameters can be given.
1698 * \li Origin: Lgb, 27 Jun 2000
1701 { LFUN_FLOAT_INSERT, "float-insert", Noop, Edit },
1704 * \var lyx::FuncCode lyx::LFUN_FLOAT_LIST_INSERT
1705 * \li Action: Inserts the list of floats in the document.
1706 * \li Syntax: float-list-insert <TYPE>
1707 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
1708 "algorithm", "table", "figure" parameters can be given.
1709 * \li Origin: Lgb, 3 May 2001
1712 { LFUN_FLOAT_LIST_INSERT, "float-list-insert", Noop, Edit },
1715 * \var lyx::FuncCode lyx::LFUN_FLOAT_WIDE_INSERT
1716 * \li Action: Inserts float insets as in #LFUN_FLOAT_INSERT but span multiple columns.
1717 * \li Notion: Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
1718 * \li Syntax: float-wide-insert <TYPE>
1719 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
1720 "algorithm", "table", "figure" parameters can be given.
1721 * \li Origin: Lgb, 31 Oct 2001
1724 { LFUN_FLOAT_WIDE_INSERT, "float-wide-insert", Noop, Edit },
1727 * \var lyx::FuncCode lyx::LFUN_FONT_BOLD
1728 * \li Action: Toggles the bold font (selection-wise) using mathbf in math.
1729 * \li Syntax: font-bold
1732 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
1736 * \var lyx::FuncCode lyx::LFUN_FONT_BOLDSYMBOL
1737 * \li Action: Toggles the bold font (selection-wise) using boldsymbol in math.
1738 * \li Syntax: font-boldsymbol
1741 { LFUN_FONT_BOLDSYMBOL, "font-boldsymbol", Noop, Layout },
1744 * \var lyx::FuncCode lyx::LFUN_FONT_DEFAULT
1745 * \li Action: Reverts the settings of the font to the default values (selection-wise).
1746 * \li Syntax: font-default
1749 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
1752 * \var lyx::FuncCode lyx::LFUN_FONT_EMPH
1753 * \li Action: Toggles the emphasis font style (selection-wise).
1754 * \li Syntax: font-emph
1757 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
1760 * \var lyx::FuncCode lyx::LFUN_FONT_FRAK
1761 * \li Action: Toggles Fraktur family font (math-mode, selection-wise).
1762 * \li Syntax: font-frak
1763 * \li Origin: vermeer, 10 Jan 2002
1766 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
1769 * \var lyx::FuncCode lyx::LFUN_FONT_ITAL
1770 * \li Action: Toggles Italics font shape (math-mode, selection-wise).
1771 * \li Syntax: font-ital
1772 * \li Origin: vermeer, 10 Jan 2002
1775 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
1778 * \var lyx::FuncCode lyx::LFUN_FONT_NOUN
1779 * \li Action: Toggles Noun text style font (selection-wise).
1780 * \li Syntax: font-noun
1783 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
1786 * \var lyx::FuncCode lyx::LFUN_FONT_ROMAN
1787 * \li Action: Toggles Roman family font (selection-wise).
1788 * \li Syntax: font-roman
1791 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
1794 * \var lyx::FuncCode lyx::LFUN_FONT_SANS
1795 * \li Action: Toggles Sans Serif family font (selection-wise).
1796 * \li Syntax: font-sans
1799 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
1802 * \var lyx::FuncCode lyx::LFUN_FONT_SIZE
1803 * \li Action: Sets font size according to lyx format string.
1804 * \li Syntax: font-size <SIZE>
1805 * \li Params: <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|\n
1806 largest|huge|giant|increase|decrease|default
1809 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
1812 * \var lyx::FuncCode lyx::LFUN_FONT_STATE
1813 * \li Action: Returns the info about the current font.
1814 * \li Syntax: font-state
1817 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
1821 * \var lyx::FuncCode lyx::LFUN_FONT_STRIKEOUT
1822 * \li Action: Toggles strikeout (strike-through) in the font (selection-wise).
1823 * \li Syntax: font-strikeout
1824 * \li Origin: sanda, 3 May 2009
1827 { LFUN_FONT_STRIKEOUT, "font-strikeout", Noop, Layout },
1830 * \var lyx::FuncCode lyx::LFUN_FONT_CROSSOUT
1831 * \li Action: Toggles xout (cross-through) in the font (selection-wise).
1832 * \li Syntax: font-crossout
1833 * \li Origin: uwestoehr, 4 April 2017
1836 { LFUN_FONT_CROSSOUT, "font-crossout", Noop, Layout },
1839 * \var lyx::FuncCode lyx::LFUN_FONT_TYPEWRITER
1840 * \li Action: Toggles the typewriter family font (selection-wise).
1841 * \li Syntax: font-typewriter
1844 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
1847 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERLINE
1848 * \li Action: Toggles underline in the font (selection-wise).
1849 * \li Syntax: font-underline
1852 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
1855 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERUNDERLINE
1856 * \li Action: Toggles double underline in the font (selection-wise).
1857 * \li Syntax: font-underunderline
1858 * \li Origin: sanda, 5 May 2009
1861 { LFUN_FONT_UNDERUNDERLINE, "font-underunderline", Noop, Layout },
1864 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERWAVE
1865 * \li Action: Toggles wavy underline in the font (selection-wise).
1866 * \li Syntax: font-underwave
1867 * \li Origin: sanda, 5 May 2009
1870 { LFUN_FONT_UNDERWAVE, "font-underwave", Noop, Layout },
1873 * \var lyx::FuncCode lyx::LFUN_FOOTNOTE_INSERT
1874 * \li Action: Inserts a footnote inset.
1875 * \li Syntax: footnote-insert
1876 * \li Origin: Jug, 7 Mar 2000
1879 { LFUN_FOOTNOTE_INSERT, "footnote-insert", Noop, Edit },
1882 * \var lyx::FuncCode lyx::LFUN_FORWARD_SEARCH
1883 * \li Action: Sets the cursor position in the previewed (dvi/pdf) file based on the row
1884 number in LyX window.
1885 * \li Notion: The external program used for forward search call can be specified in
1886 LyX Output preferences. See Additional manual for details of these
1888 * \li Syntax: forward-search
1889 * \li Origin: sanda, 14 Apr 2010
1892 { LFUN_FORWARD_SEARCH, "forward-search", ReadOnly, System },
1895 * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
1896 * \li Action: Open the given help file according to the language setting.
1897 * \li Syntax: help-open <FILE>[.lyx]
1898 * \li Params: <FILE>: any document from (/usr/share/)doc directory.
1899 * \li Origin: Jug, 27 Jun 1999
1902 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
1905 * \var lyx::FuncCode lyx::LFUN_HREF_INSERT
1906 * \li Action: Inserts hyperlinks into the document (clickable in pdf output).
1907 * \li Notion: Hyperlink target can be set via selection + hyperlink-insert function.
1908 * \li Syntax: href-insert [<TARGET>]
1909 * \li Origin: CFO-G, 21 Nov 1997
1912 { LFUN_HREF_INSERT, "href-insert", Noop, Edit },
1915 * \var lyx::FuncCode lyx::LFUN_ICON_SIZE
1916 * \li Action: Sets icon size of toolbars.
1917 * \li Syntax: icon-size [<SIZE>]
1918 * \li Params: <SIZE> : the icon size in px or one of the logical settings
1919 small|normal|big|huge|giant, the default is normal
1920 (whose size in px is icon set dependent).
1921 * \li Origin: 11 July 2016
1924 { LFUN_ICON_SIZE, "icon-size", NoBuffer, Buffer },
1927 * \var lyx::FuncCode lyx::LFUN_INDEX_INSERT
1928 * \li Action: Inserts Index entry.
1929 * \li Notion: It automatically takes the word on the cursor position.
1930 * \li Syntax: index-insert [<TYPE:Name>]
1931 * \li Params: <TYPE:Name>: name of the index, if multiple indices are defined.
1932 With an empty argument, the default index is selected.
1933 * \li Origin: leeming, 3 Aug 2000
1936 { LFUN_INDEX_INSERT, "index-insert", Noop, Edit },
1939 * \var lyx::FuncCode lyx::LFUN_INDEX_PRINT
1940 * \li Action: Inserts list of Index entries on a new page.
1941 * \li Syntax: index-print [<TYPE:Name>]
1942 * \li Params: <TYPE:Name>: name of the index, if multiple indices are defined.
1943 With an empty argument, the default index is selected.
1944 * \li Origin: Lgb, 27 Feb 1997
1947 { LFUN_INDEX_PRINT, "index-print", Noop, Edit },
1950 * \var lyx::FuncCode lyx::LFUN_INFO_INSERT
1951 * \li Action: Displays shortcuts, lyxrc, package and textclass availability and menu
1952 information in a non-editable boxed InsetText.
1953 * \li Notion: Apart from lfun arguments you can use the following method: \n
1954 1. input the type and argument of this inset, e.g. "menu paste", in
1956 2. select the text and run info-insert lfun.
1957 * \li Syntax: info-insert <TYPE> <ARG>
1958 * \li Params: <TYPE>: date|moddate|fixdate|time|modtime|fixtime|shortcut|shortcuts|lyxrc|
1959 * lyxinfo|package|textclass|menu|l7n|icon|buffer|vcs \n
1960 <ARG>: argument for a given type. Look into InsetInfo.h for detailed
1962 date: current date (formatted and localized)\n
1963 moddate: date of last modification (saving) (formatted and localized)\n
1964 fixdate: a static date (formatted and localized)\n
1965 time: current time (formatted and localized)\n
1966 modtime: time of last modification (saving) (formatted and localized)\n
1967 fixtime: a static time (formatted and localized)\n
1968 shortcut[s]: name of lfun (e.g math-insert \alpha) \n
1969 lyxrc: name of rc_entry (e.g. bind_file) \n
1970 lyxinfo: "version" - used version of LyX \n
1971 package: name of latex package (e.g. listings) \n
1972 textclass: name of textclass (e.g. article) \n
1973 menu: name of lfun used in menu \n
1974 l7n: localizable string.\n
1975 icon: icon of lfun used in toolbar or direct icon name\n
1976 buffer: "name"|"name-noext"|"path"|"class"
1977 vcs: "tree-revision"|"revision"|"author"|"date"|"time"
1978 * \li Sample: command-sequence info-insert buffer path; info-insert buffer name
1979 * \li Origin: bpeng, 7 Oct 2007
1982 { LFUN_INFO_INSERT, "info-insert", Noop, Edit },
1985 * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
1986 * \li Action: Apply data for an inset.
1987 * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
1988 be applied. This is either changed to #LFUN_INSET_MODIFY or
1989 #LFUN_INSET_INSERT depending on the context where it is called.
1990 * \li Syntax: inset-apply <ARGS>
1991 * \li Params: See #LFUN_INSET_INSERT .
1994 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
1997 * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN
1998 * \li Action: Move the cursor to the beginning of the current inset
1999 if it is not already there. If the cursor is already at
2000 the beginning of the current inset, move it to the
2001 beginning of the enclosing inset or the main work area,
2002 respectively, if there is no enclosing inset.
2003 * \li Syntax: inset-begin
2004 * \li Origin: lasgouttes, 16 Mar 2009
2007 { LFUN_INSET_BEGIN, "inset-begin", ReadOnly, Edit },
2010 * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN_SELECT
2011 * \li Action: Move the cursor to the beginning of the current inset
2012 if it is not already there. If the cursor is already at
2013 the beginning of the current inset, move it to the
2014 beginning of the enclosing inset or the main work area,
2015 respectively, if there is no enclosing inset (adding the
2016 traversed text to the selection).
2017 * \li Syntax: inset-begin-select
2018 * \li Origin: lasgouttes, 16 Mar 2009
2021 { LFUN_INSET_BEGIN_SELECT, "inset-begin-select", ReadOnly, Edit },
2024 * \var lyx::FuncCode lyx::LFUN_INSET_COPY_AS
2025 * \li Action: Copies the inset to the clipboard as a certain type.
2026 * \li Notion: Currently used only for InsetInfo where its content is copied as a text.
2027 * \li Syntax: inset-copy-as
2028 * \li Origin: vfr, 18 Apr 2010
2031 { LFUN_INSET_COPY_AS, "inset-copy-as", ReadOnly | NoUpdate | AtPoint, Edit },
2035 * \var lyx::FuncCode lyx::LFUN_INSET_DIALOG_UPDATE
2036 * \li Action: Updates the values inside the dialog from the inset.
2037 * \li Notion: This is an internal LFUN, not to be used by users. Called internally
2038 by #LFUN_DIALOG_UPDATE
2039 * \li Params: <DIALOG-NAME>
2040 * \li Origin: leeming, 25 Feb 2003
2043 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
2046 * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE
2047 * \li Action: Dissolve the current inset into text.
2048 * \li Syntax: inset-dissolve [<INSET>]
2049 * \li Params: <INSET>: this can be used to make sure the right kind of inset
2050 is dissolved. For example "dissolve" entry in the charstyles
2051 sub-menu should only dissolve the charstyle inset, even if the
2052 cursor is inside several nested insets of different type.\n
2053 For values see #lyx::InsetLayout::lyxtype_ .
2054 * \li Origin: JSpitz, 7 Aug 2006
2057 { LFUN_INSET_DISSOLVE, "inset-dissolve", AtPoint, Edit },
2060 * \var lyx::FuncCode lyx::LFUN_INSET_EDIT
2061 * \li Action: Edit the inset at cursor with an external application,
2062 if one is attributed.
2063 If the inset is file based, the referenced file is edited.
2064 Otherwise, the inset contents is written to a temporary file,
2065 the inset is locked, and the temporary file is edited.
2066 In this case, #LFUN_INSET_END_EDIT must be called to overtake
2067 the changes and unlock the inset after editing is finished.
2068 * \li Syntax: inset-edit [<INSET_PARAMS>]
2069 * \li Params: <INSET_PARAMS>: Parameters for the inset. \n
2070 Currently only the filename will be considered.
2071 * \li Origin: spitz, 27 Apr 2006
2074 { LFUN_INSET_EDIT, "inset-edit", ReadOnly | AtPoint, Edit },
2078 * \var lyx::FuncCode lyx::LFUN_INSET_END_EDIT
2079 * \li Action: End editing the inset at cursor with an external application.
2080 * This replaces the inset contents with the contents of the
2081 * temporary file, deletes the file and unlocks the inset.
2082 * \li Syntax: inset-end-edit
2083 * \li Origin: gb, 11 Oct 2015
2086 { LFUN_INSET_END_EDIT, "inset-end-edit", ReadOnly | AtPoint, Edit },
2089 * \var lyx::FuncCode lyx::LFUN_INSET_END
2090 * \li Action: Move the cursor to the end of the current inset if it
2091 is not already there. If the cursor is already at the
2092 end of the current inset, move it to the end of the
2093 enclosing inset or the main work area, respectively, if
2094 there is no enclosing inset.
2095 * \li Syntax: inset-end
2096 * \li Origin: lasgouttes, 16 Mar 2009
2099 { LFUN_INSET_END, "inset-end", ReadOnly, Edit },
2102 * \var lyx::FuncCode lyx::LFUN_INSET_END_SELECT
2103 * \li Action: Move the cursor to the end of the current inset if it
2104 is not already there. If the cursor is already at the
2105 end of the current inset, move it to the end of the
2106 enclosing inset or the main work area, respectively, if
2107 there is no enclosing inset (adding the
2108 traversed text to the selection).
2109 * \li Syntax: inset-end-select
2110 * \li Origin: lasgouttes, 16 Mar 2009
2113 { LFUN_INSET_END_SELECT, "inset-end-select", ReadOnly, Edit },
2117 * \var lyx::FuncCode lyx::LFUN_INSET_FORALL
2118 * \li Action: Apply the given commands on insets of a given name.
2119 * \li Notion: WARNING: use at your own risks; this function gives
2120 you too many ways of shooting yourself in the foot.
2121 A typical example is
2122 inset-forall Note note-insert
2123 which starts an infinite loop. This is mitigated by the fact
2124 that the number of actions is arbitrarily limited to 100000.
2125 Note also that inset-forall does not update metrics between
2126 iterations, which can lead to bugs. This has to be eventually
2128 * \li Syntax: inset-forall <NAME> <LFUN-COMMAND> \n
2129 <NAME>: Type of Inset. If <NAME> is *, all insets are matched.
2130 The name is used like for InsetLayout in layout files: "Note"
2131 matches all note insets, while "Note:Note" only matches LyX
2133 * \li Sample: Remove all index insets: \n
2134 inset-forall Index char-delete-forward force \n
2135 Close all Notes (also works for a particular branch, for example): \n
2136 inset-forall Note inset-toggle close \n
2137 Transform all yellow notes to comments \n
2138 inset-forall Note:Note inset-modify note Note Comment \n
2139 Try to put LyX in an infinite loop if there is at least a Note: \n
2140 inset-forall Note char-backward
2141 * \li Origin: lasgouttes, 27 Nov 2009
2144 { LFUN_INSET_FORALL, "inset-forall", ReadOnly, Edit },
2148 * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
2149 * \li Action: Insert new inset (type given by the parameters).
2150 * \li Syntax: inset-insert <INSET> <ARGS>
2151 * \li Params: <INSET>: <bibitem|bibtex|citation|ert|listings|external|graphics|tabular|\n
2152 hyperlink|include|index|label|line|nomencl|vspace|ref|toc|script>\n
2153 <ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
2154 * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
2155 where <label name> is the name of the referenced label and
2156 <Format> is one of the following: \n
2157 ref -- <reference> \n
2158 eqref -- (<reference>) \n
2159 pageref -- <page> \n
2160 vpageref -- on <page> \n
2161 vref -- <reference> on <page> \n
2162 formatted -- Formatted reference
2165 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
2168 * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
2169 * \li Action: Modify some properties of an inset.
2170 * \li Notion: Used for argument, bibitem, bibtex, box, branch, caption, citation,
2171 command, ert, external, float, graphics, include, index,
2172 info, label, line, listings, newline, newpage, nomencl,
2173 note, phantom, quotes, ref, script, separator, space,
2174 tabular, vspace and wrap insets.
2175 * \li Syntax: inset-modify <INSET> <ARGS> \n
2176 inset-modify changetype <TYPE>
2177 * \li Sample: Change a Note inset into a Comment inset: \n
2178 inset-modify note Note Comment \n
2179 Change a Box into an Ovalbox: \n
2180 inset-modify changetype Ovalbox \n
2181 Change a quotation mark to e[nglish style], l[eft side = opening], s[ingle = inner, secondary] \n
2182 inset-modify changetype els \n
2183 Change only the style of a quotation mark, maintaining the other aspects (. = wildcard) \n
2184 inset-modify changetype e.. \n
2187 { LFUN_INSET_MODIFY, "inset-modify", AtPoint, Edit },
2190 * \var lyx::FuncCode lyx::LFUN_INSET_SELECT_ALL
2191 * \li Action: Select all contents of an inset.
2192 * \li Notion: There are 3 successive levels: select current cell,
2193 * select all cells of inset, select the inset from outside
2194 * (in the enclosing inset).
2195 * \li Syntax: inset-select-all
2196 * \li Origin: vfr, 22 Aug 2009; lasgouttes 1 Nov 2014
2199 { LFUN_INSET_SELECT_ALL, "inset-select-all", ReadOnly, Edit },
2203 * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
2204 * \li Action: Open the inset's properties dialog.
2205 * \li Notion: Used for bibitem, bibtex, box, branch, citation, ert, external,
2206 float, graphics, href, include, index, index_print, label, line,
2207 listings, note, phantom, ref, space, tabular, vspace, wrap insets.
2208 * \li Syntax: inset-settings <INSET>
2209 * \li Params: <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|\n
2210 graphics|href|include|index|index_print|label|line|\n
2211 listings|note|phantom|ref|space|tabular|vspace|wrap>.
2214 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly | AtPoint, Edit },
2217 * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
2218 * \li Action: Toggles the collapsible inset at cursor position,
2219 or the inset we are currently in.
2220 * \li Syntax: inset-toggle [<ARG>]
2221 * \li Params: <ARG>: <open|close|toggle|assign>. \n
2222 open/close/toggle are for collapsible insets. toggle is used when no argument is given.\n
2223 assign synchronize the branch-inset with activation status of the branch.
2224 Used for global toggling when changed activation.
2225 * \li Origin: lasgouttes, 19 Jul 2001
2228 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly | AtPoint, Edit },
2231 * \var lyx::FuncCode lyx::LFUN_IN_IPA
2232 * \li Action: Only active in IPA inset.
2233 * \li Notion: Dummy function which is only active in a IPA inset.
2234 It's used to toggle the IPA toolbar if the cursor moves
2236 * \li Syntax: in-ipa
2237 * \li Origin: spitz, 20 May 2012
2240 { LFUN_IN_IPA, "in-ipa", Noop, Edit },
2243 * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
2244 * \li Action: Only active in Math Macro definition.
2245 * \li Notion: Dummy function which is only active in a Math Macro definition.
2246 It's used to toggle the Math Macro toolbar if the cursor moves
2247 into a Math Macro definition.
2248 * \li Syntax: in-mathmacrotemplate
2249 * \li Origin: sts, 06 January 2008
2252 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
2256 * \var lyx::FuncCode lyx::LFUN_IPAMACRO_INSERT
2257 * \li Action: Inserts special IPA macros into the document.
2258 * \li Syntax: ipamacro-insert <CHAR>
2259 * \li Params: <CHAR>: tone-falling, tone-rising, tone-high-rising, tone-low-rising,
2260 * tone-high-rising-falling, deco bottomtiebar, deco toptiebar.
2261 * \li Origin: spitz, 22 Aug 2012
2264 { LFUN_IPAMACRO_INSERT, "ipamacro-insert", Noop, Edit },
2267 * \var lyx::FuncCode lyx::LFUN_IPA_INSERT
2268 * \li Action: Inserts an IPA inset.
2269 * \li Syntax: ipa-insert
2270 * \li Origin: spitz, 05 Mar 2012
2273 { LFUN_IPA_INSERT, "ipa-insert", Noop, Edit },
2276 * \var lyx::FuncCode lyx::LFUN_KEYMAP_OFF
2277 * \li Action: Turn off the loaded keyboard map.
2278 * \li Syntax: keymap-off
2281 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
2284 * \var lyx::FuncCode lyx::LFUN_KEYMAP_PRIMARY
2285 * \li Action: Turn on the primary keyboard map.
2286 * \li Notion: Maps were widely used in past, when X-windows didn't have nowadays
2287 keyboard support. They can be still used to maintain uniform keyboard
2288 layout across the various platforms.\n
2289 The language is to be set in the Preferences dialog.
2290 * \li Syntax: keymap-primary
2293 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
2296 * \var lyx::FuncCode lyx::LFUN_KEYMAP_SECONDARY
2297 * \li Action: Turn on the secondary keyboard map.
2298 * \li Syntax: keymap-secondary
2301 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
2304 * \var lyx::FuncCode lyx::LFUN_KEYMAP_TOGGLE
2305 * \li Action: Toggles keyboard maps (first/second/off).
2306 * \li Syntax: keymap-toggle
2307 * \li Origin: leeming, 30 Mar 2004
2310 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
2314 * \var lyx::FuncCode lyx::LFUN_LABEL_COPY_AS_REFERENCE
2315 * \li Action: Copies the label at the cursor as a cross-reference to be pasted elsewhere.
2316 * \li Syntax: copy-label-as-reference <LABEL>
2317 * \li Params: <LABEL>: The label to copy (for multi-line math)
2318 * \li Origin: sts, 16 Nov 2008
2321 { LFUN_LABEL_COPY_AS_REFERENCE, "label-copy-as-reference",
2322 ReadOnly | NoUpdate | AtPoint, Edit },
2326 * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
2327 * \li Action: Goto a label.
2328 * \li Syntax: label-goto [<LABEL>]
2329 * \li Params: <LABEL>: Requested label. If no label is given and reference
2330 is on cursor position, Bookmark 0 is saved and
2331 cursor moves to the position of referenced label.
2332 * \li Origin: Ale, 6 Aug 1997
2335 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
2338 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT
2339 * \li Action: Inserts label to text or displayed formula.
2340 * \li Syntax: label-insert [<LABEL>]
2341 * \li Params: <LABEL>: Requested label. If no label is given dialog requesting
2342 name will be opened.
2345 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
2348 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT_AS_REFERENCE
2349 * \li Action: Inserts the label (in ToC pane) as a cross-reference at the position of the cursor.
2350 * \li Syntax: label-insert-as-reference
2351 * \li Origin: vfr, 7 Apr 2009
2354 { LFUN_LABEL_INSERT_AS_REFERENCE, "label-insert-as-reference", Noop, Edit},
2358 * \var lyx::FuncCode lyx::LFUN_LANGUAGE
2359 * \li Action: Set language from the current cursor position.
2360 * \li Syntax: language <LANG> [set]
2361 * \li Params: <LANG>: Requested language. Look in lib/languages for
2362 the list. "language reset" or "language" (without param)
2363 reset to the document language.
2364 set: If used, the language will be set to the specified
2365 language. Otherwise, the language will be toggled (i.e., if
2366 the current language is LANG, switch to the document language
2367 or the default language, if LANG is the document language).
2368 * \li Origin: Dekel, 2 Mar 2000
2371 { LFUN_LANGUAGE, "language", Noop, Edit },
2375 * \var lyx::FuncCode lyx::LFUN_LAYOUT
2376 * \li Action: Sets the layout (that is, environment) for the current paragraph.
2377 * \li Syntax: layout <LAYOUT> [ignorenests]
2378 * \li Params: <LAYOUT>: the layout to use\n
2379 ignorenests: If specified, nesting advices will be ignored.
2382 { LFUN_LAYOUT, "layout", Noop, Layout },
2385 * \var lyx::FuncCode lyx::LFUN_LAYOUT_TOGGLE
2386 * \li Action: Toggles the layout (that is, environment) for the current paragraph.
2387 * \li Notion: Contrary to `layout', this function resets the current
2388 * (or selection) layout to the standard layout it already has the
2389 * correct layout. Useful for toolbar icons.
2390 * \li Syntax: layout-toggle <LAYOUT> [ignorenests]
2391 * \li Params: <LAYOUT>: the layout to toggle\n
2392 ignorenests: If specified, nesting advices will be ignored.
2393 * \li Origin: lasgouttes, 14 May 2018
2396 { LFUN_LAYOUT_TOGGLE, "layout-toggle", Noop, Layout },
2399 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
2400 * \li Action: Clears the module list.
2401 * \li Notion: Clears the list of included modules for the current buffer.
2402 * \li Syntax: layout-modules-clear
2403 * \li Origin: rgh, 25 August 2007
2406 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", NoInternal, Layout },
2409 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULE_ADD
2410 * \li Action: Adds a module.
2411 * \li Notion: Adds a module to the list of included modules for the current buffer.
2412 * \li Syntax: layout-module-add <MODULE>
2413 * \li Params: <MODULE>: the module to be added
2414 * \li Origin: rgh, 25 August 2007
2417 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", NoInternal, Layout },
2420 * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH
2421 * \li Action: Launches the paragraph settings dialog.
2422 * \li Syntax: layout-paragraph
2425 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
2428 * \var lyx::FuncCode lyx::LFUN_LAYOUT_RELOAD
2429 * \li Action: Reloads layout information.
2430 * \li Notion: Reloads all layout information for the current buffer from disk, thus
2431 recognizing any changes that have been made to layout files on the fly.
2432 This is intended to be used only by layout developers and should not be
2433 used when one is trying to do actual work.
2434 * \li Syntax: layout-reload
2435 * \li Origin: rgh, 3 September 2007
2438 { LFUN_LAYOUT_RELOAD, "layout-reload", NoInternal, Layout },
2441 * \var lyx::FuncCode lyx::LFUN_LAYOUT_TABULAR
2442 * \li Action: Launches the tabular settings dialog.
2443 * \li Syntax: layout-tabular
2444 * \li Origin: Jug, 31 Jul 2000
2447 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
2450 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN
2451 * \li Action: Move the cursor to the beginning of the (screen) line.
2452 * \li Syntax: line-begin
2455 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
2458 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN_SELECT
2459 * \li Action: Move the cursor to the beginning of the (screen) line adding the
2460 traversed text to the selection.
2461 * \li Syntax: line-begin-select
2464 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
2467 * \var lyx::FuncCode lyx::LFUN_LINE_DELETE_FORWARD
2468 * \li Action: Deletes the letters to the end of the (screen) line or
2469 deletes the selection.
2470 * \li Syntax: line-delete-forward
2473 { LFUN_LINE_DELETE_FORWARD, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
2476 * \var lyx::FuncCode lyx::LFUN_LINE_END
2477 * \li Action: Move the cursor to the end of the (screen) line.
2478 * \li Syntax: line-end
2481 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
2484 * \var lyx::FuncCode lyx::LFUN_LINE_END_SELECT
2485 * \li Action: Move the cursor to the end of the (screen) line adding the
2486 traversed text to the selection.
2487 * \li Syntax: line-end-select
2490 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
2493 * \var lyx::FuncCode lyx::LFUN_LISTING_INSERT
2494 * \li Action: Inserts a new listings inset.
2495 * \li Syntax: listing-insert
2496 * \li Origin: Herbert, 10 Nov 2001; bpeng, 2 May 2007
2499 { LFUN_LISTING_INSERT, "listing-insert", Noop, Edit },
2502 * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
2503 * \li Action: Apply the given settings to user preferences.
2504 * \li Syntax: lyxrc-apply <SETTINGS>
2505 * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
2506 to get an idea which commands to use and their syntax.
2507 #lyx::LyXRC::LyXRCTags has the list of possible commands.
2510 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
2513 * \var lyx::FuncCode lyx::LFUN_LYX_ACTIVATE
2514 * \li Action: Activates the LyX window.
2515 * \li Notion: On Linux and Mac OS, this action brings the LyX window
2516 into focus. Such behavior is not allowed by Windows OS
2517 so instead the color of the taskbar entry is changed to
2518 indicate that the window has changed in some way.
2519 This action is useful in combination with reverse search.
2520 * \li Syntax: lyx-activate
2521 * \li Origin: skostysh, 4 Aug 2016
2524 { LFUN_LYX_ACTIVATE, "lyx-activate", ReadOnly | NoBuffer, Hidden },
2527 * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
2528 * \li Action: Terminates the current LyX instance.
2529 * \li Notion: Terminates the current LyX instance, asking whether to save
2530 modified documents, etc.
2531 * \li Syntax: lyx-quit
2534 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
2537 * \var lyx::FuncCode lyx::LFUN_MARGINALNOTE_INSERT
2538 * \li Action: Inserts a marginal note.
2539 * \li Syntax: marginalnote-insert
2540 * \li Origin: Lgb, 26 Jun 2000
2543 { LFUN_MARGINALNOTE_INSERT, "marginalnote-insert", Noop, Edit },
2546 * \var lyx::FuncCode lyx::LFUN_MARK_OFF
2547 * \li Action: Disable selecting of text-region.
2548 * \li Syntax: mark-off
2551 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
2554 * \var lyx::FuncCode lyx::LFUN_MARK_ON
2555 * \li Action: Enable selecting of text-region.
2556 * \li Notion: After enabling you can simply move arrow keys to get selected region.
2557 * \li Syntax: mark-on
2560 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
2563 * \var lyx::FuncCode lyx::LFUN_MARK_TOGGLE
2564 * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
2565 * \li Syntax: mark-toggle
2566 * \li Origin: Andre, May 5 2006
2569 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
2573 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_EXPORT
2574 * \li Action: Exports the master buffer (document) to the given format.
2575 * \li Syntax: master-buffer-export [<FORMAT>] [<DEST>]
2576 * \li Params: <FORMAT> is one of the formats which you can find in
2577 Tools->Preferences->File formats->Format.
2578 Usual format you will enter is "pdf2" (pdflatex),
2579 "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
2580 Note that "custom" is not allowed in this case.\n
2581 If absent or "default", then the default output format of the
2583 <DEST> If present, this argument provides the export destination
2584 filename. Its containing folder will also be the destination
2585 folder, where all the needed external files will be copied.
2586 * \li Origin: rkh, 18 April 2018
2589 { LFUN_MASTER_BUFFER_EXPORT, "master-buffer-export", ReadOnly, Buffer },
2592 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
2593 * \li Action: Update (export) the document built from the master buffer,
2594 if the current buffer is part of a master/child document.
2595 * \li Syntax: master-buffer-update [<FORMAT>]
2596 * \li Params: <FORMAT>: The format to display, where this is one of the
2597 formats defined (in the current GUI) in the
2598 Tools>Preferences>File Formats dialog.
2599 If no format is given, the default format as
2600 specified in the same dialog is used.
2601 * \li Origin: Tommaso, 20 Sep 2007
2604 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
2607 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
2608 * \li Action: Show a preview built from the master buffer, if available.
2609 if the current buffer is part of a master/child document.
2610 * \li Syntax: master-buffer-view [<FORMAT>]
2611 * \li Params: <FORMAT>: The format to display, where this is one of the
2612 formats defined (in the current GUI) in the
2613 Tools>Preferences>File Formats dialog.
2614 If no format is given, the default format as
2615 specified in the same dialog is used.
2616 * \li Origin: Tommaso, 20 Sep 2007
2619 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
2622 * \var lyx::FuncCode lyx::LFUN_MATH_AMS_MATRIX
2623 * \li Action: Inserts an extended matrix as provided by the amsmath package.
2624 * \li Syntax: math-matrix <COLS> <ROWS> [<DECORATION>]
2625 * \li Params: <DECORATION>: Decoration determines the LaTeX name of the matrix
2626 that should be created. Possible values include
2627 pmatrix, bmatrix, Bmatrix, vmatrix, Vmatrix, smallmatrix, and
2628 matrix. The default is 'matrix'.
2629 * \li Sample: math-ams-matrix 3 3 bmatrix
2632 { LFUN_MATH_AMS_MATRIX, "math-ams-matrix", Noop, Math },
2635 * \var lyx::FuncCode lyx::LFUN_MATH_BIGDELIM
2636 * \li Action: Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
2637 * \li Syntax: math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
2638 * \li Params: <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r \n
2639 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
2640 * \li Sample: math-bigdelim "Bigl" "\Downarrow" "Bigr" "\}"
2641 * \li Origin: Enrico & Georg, 7 May 2006
2644 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
2647 * \var lyx::FuncCode lyx::LFUN_MATH_DELIM
2648 * \li Action: Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
2649 * \li Syntax: math-delim [<LEFT>] [<RIGHT>]
2650 * \li Params: <LEFT/RIGHT>: Delimiters to be used. Each delimiter can be specified by
2651 either a LaTeX name or a valid character.
2652 ( is the default letter.
2653 * \li Sample: math-delim { rangle
2654 * \li Origin: Alejandro, 18 Jun 1996
2657 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
2660 * \var lyx::FuncCode lyx::LFUN_MATH_DISPLAY
2661 * \li Action: Creates a new displayed equation in text mode.
2662 Toggles inlined/display formula in math mode.
2663 * \li Syntax: math-display [<ARG>]
2664 * \li Params: <ARG>: this argument will be passed to #LFUN_MATH_INSERT when creating
2665 new equation from the text mode.
2666 * \li Origin: Alejandro, 18 Jun 1996
2669 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
2672 * \var lyx::FuncCode lyx::LFUN_MATH_EXTERN
2673 * \li Action: Calls external program and passes the current expression/equation
2674 as an argument for the calculation in the format appropriate to the
2676 * \li Notion: Selection can be used to determine the input for the external program.
2677 * \li Syntax: math-extern <LANG> [<COMMAND>]
2678 * \li Params: <LANG>: octave|maxima|maple|mathematica|script \n
2679 where "script" stands for the external script (normalized
2680 expression will be passed)
2681 * \li Origin: Andre, 24 Apr 2001
2682 * \li Sample: math-extern maple simplify
2685 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
2688 * \var lyx::FuncCode lyx::LFUN_MATH_FONT_STYLE
2689 * \li Action: Changes the text style used in math.
2690 * \li Syntax: math-font-style <STYLE>
2691 * \li Params: <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf|textnormal\n
2692 |textrm|textsf|texttt|textbf|textmd|textit|textsc|textsl|textup
2693 * \li Origin: vfr, 9 jan 2009
2696 { LFUN_MATH_FONT_STYLE, "math-font-style", Noop, Math },
2699 * \var lyx::FuncCode lyx::LFUN_MATH_INSERT
2700 * \li Action: Inserts math objects and symbols.
2701 * \li Syntax: math-insert <ARG>
2702 * \li Params: <ARG>: Symbol or LaTeX code to be inserted.
2703 * \li Notion: When <ARG> is a _single_ math inset with more than one cell
2704 (such as "x_y^z" or "\frac{x}{y}"), the content of cell(0) is
2705 replaced by the current selection (only works if the selection
2706 is in mathed). As an example, if "abc" is selected in mathed,
2707 "math-insert \frac{x}{y}" replaces "abc" with "\frac{abc}{y}",
2708 and "math-insert x_y^z" replaces "abc" with "abc_y^z".
2709 If nothing is selected (or the selection is not in mathed),
2710 math-insert works as expected.
2713 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
2716 * \var lyx::FuncCode lyx::LFUN_MATH_LIMITS
2717 * \li Action: Toggles the position of the limits from above/below to the right
2718 side an vice versa in integral symbol, a limit, a summation, etc.
2719 * \li Notion: Put the cursor before the symbol with the limits and then invoke
2721 * \li Syntax: math-limits [<STATE>]
2722 * \li Params: <STATE>: limits|nolimits
2725 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
2728 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO
2729 * \li Action: Inserts a math macro definition at the cursor position in the text.
2730 * \li Syntax: math-macro <NAME> [<NARGS>] [def]
2731 * \li Params: <NAME>: The name of the macro, e.g. "mymacro".\n
2732 <NARGS>: The number of parameters of the macro. Default is 0.
2733 "def": Has no effect anymore, just for compatibility with former LyX versions.
2734 * \li Origin: ale, 10 May 1997; sts, 21 Dec 2007
2737 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
2740 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
2741 * \li Action: Add a greedy optional parameter.
2742 * \li Notion: Add a greedy optional parameter which eats the value
2743 from the following cells in mathed which are in the [value]
2745 * \li Syntax: math-macro-add-greedy-optional-param
2746 * \li Origin: sts, 06 January 2008
2749 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
2752 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
2753 * \li Action: Add an optional parameter.
2754 * \li Notion: Insert an optional parameter just behind the
2755 already existing optional parameters.
2756 * \li Syntax: math-macro-add-optional-param
2757 * \li Origin: sts, 06 January 2008
2760 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
2763 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
2764 * \li Action: Add a parameter.
2765 * \li Notion: Add a parameter to a Math Macro.
2766 * \li Params: <NUM>: The number of the parameter behind which the new one
2767 will be added (1 for the first, i.e. use 0 for add a
2768 parameter at the left), defaults to the last one.
2769 * \li Syntax: math-macro-add-param <NUM>
2770 * \li Origin: sts, 06 January 2008
2773 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
2776 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
2777 * \li Action: Append a greedy parameter.
2778 * \li Notion: Append a greedy parameter to a Math Macro which
2779 eats the following mathed cell in every instance of
2780 the macro in the buffer.
2781 * \li Syntax: math-macro-append-greedy-param
2782 * \li Origin: sts, 06 January 2008
2785 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
2788 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
2789 * \li Action: Fold a Math Macro.
2790 * \li Notion: Fold the Math Macro the cursor is in if it was
2791 unfolded, i.e. displayed as \foo before.
2792 * \li Syntax: math-macro-fold
2793 * \li Origin: sts, 06 January 2008
2796 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
2799 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
2800 * \li Action: Make a parameter non-optional.
2801 * \li Notion: Turn the last optional parameter of a Math Macro
2802 into a non-optional parameter. The default value is
2803 remembered to be reused later if the user changes his mind.
2804 * \li Syntax: math-macro-make-nonoptional
2805 * \li Origin: sts, 06 January 2008
2808 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
2811 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
2812 * \li Action: Make a parameter optional.
2813 * \li Notion: Turn the first non-optional parameter of a Math Macro
2814 into an optional parameter with a default value.
2815 * \li Syntax: math-macro-make-optional
2816 * \li Origin: sts, 06 January 2008
2819 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
2822 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
2823 * \li Action: Remove a greedy parameter.
2824 * \li Notion: Remove a greedy parameter of a Math Macro and spit
2825 out the values of it in every instance of the macro
2826 in the buffer. If it is an optional parameter the [valud]
2828 * \li Syntax: math-macro-remove-greedy-param
2829 * \li Origin: sts, 06 January 2008
2832 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
2835 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
2836 * \li Action: Remove the last optional parameter.
2837 * \li Notion: Remove the last optional parameter of a Math Macro and
2838 remove it in all the instances of the macro in the buffer.
2839 * \li Syntax: math-macro-remove-optional-param
2840 * \li Origin: sts, 06 January 2008
2843 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
2846 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
2847 * \li Action: Remove the last parameter.
2848 * \li Notion: Remove the last parameter of a Math Macro and
2849 remove its value in all instances of the macro
2851 * \li Params: <NUM>: The number of the parameter to be deleted (1 for
2852 the first), defaults to the last one.
2853 * \li Syntax: math-macro-remove-param <NUM>
2854 * \li Origin: sts, 06 January 2008
2857 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
2860 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
2861 * \li Action: Unfold a Math Macro.
2862 * \li Notion: Unfold the Math Macro the cursor is in, i.e.
2864 * \li Syntax: math-macro-unfold
2865 * \li Origin: sts, 06 January 2008
2868 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
2871 * \var lyx::FuncCode lyx::LFUN_MATH_MATRIX
2872 * \li Action: Inserts a matrix.
2873 * \li Syntax: math-matrix <COLS> <ROWS> [<ALIGN>]
2874 * \li Params: <ALIGN>: Alignment is a word composed of the vertical alignment
2875 (b, c or t) (i.e. 1 char) and the horizontal alignments
2876 (l, c or r) (i.e. <COL> chars).
2877 * \li Sample: math-matrix 3 3 bccc
2880 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
2883 * \var lyx::FuncCode lyx::LFUN_MATH_MODE
2884 * \li Action: In text mode enters math mode (i.e. puts math insets on the current
2885 cursor position), in math mode enters text mode inside math expression.
2886 * \li Notion: If there is some selected text, it puts the text inside created math box.
2887 * \li Syntax: math-mode [on|<ARG>]
2888 * \li Params: <ARG>: eventual argument (LaTeX code) is passed to #LFUN_MATH_INSERT .\n
2889 "on": allow only entering of math mode from text mode.
2890 * \li Origin: Alejandro, 4 Jun 1996
2893 { LFUN_MATH_MODE, "math-mode", Noop, Math },
2896 * \var lyx::FuncCode lyx::LFUN_MATH_MUTATE
2897 * \li Action: Mutates the type of math inset to the newly selected one.
2898 * \li Syntax: math-mutate <TYPE>
2899 * \li Params: <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
2900 multline|gather|flalign
2901 * \li Origin: Andre, 23 May 2001
2904 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
2907 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
2908 * \li Action: Toggles numbering of the current formula line.
2909 * \li Notion: Must be in display formula mode.
2910 * \li Syntax: math-number-line-toggle
2911 * \li Origin: Alejandro, 18 Jun 1996
2914 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
2917 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
2918 * \li Action: Toggles numbering/labeling of the current formula.
2919 * \li Notion: Must be in display formula mode.
2920 * \li Syntax: math-number-toggle
2921 * \li Origin: Alejandro, 4 Jun 1996
2924 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
2927 * \var lyx::FuncCode lyx::LFUN_MATH_SIZE
2928 * \li Action: Changes arbitrarily the size used by math fonts inside a context.
2929 * \li Notion: Provides an interface to the LaTeX math mode font size commands.
2930 * \li Syntax: math-size <STYLE>
2931 * \li Params: <STYLE>: \displaystyle|\textstyle|\scriptstyle|\scriptscriptstyle
2932 * \li Origin: Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
2935 { LFUN_MATH_SIZE, "math-size", Noop, Math },
2938 * \var lyx::FuncCode lyx::LFUN_MATH_SPACE
2939 * \li Action: Inserts space into math expression.
2940 * \li Notion: Use spacebar after entering this space to change type of space.
2941 * \li Syntax: math-space [<TYPE>] [<LEN>]
2942 * \li Params: <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace \n
2943 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad \n
2944 custom space: hspace \n
2945 "," used by default.\n
2946 Note that ! is equivalent to negthinspace, , = thinspace,
2947 : = medspace, and ; = thickspace.\n
2948 <LEN>: length for custom spaces (hspace)
2949 * \li Origin: Andre, 25 Jul 2001; sanda, 16 Jun 2008
2952 { LFUN_MATH_SPACE, "math-space", Noop, Math },
2955 * \var lyx::FuncCode lyx::LFUN_MATH_SUBSCRIPT
2956 * \li Action: Enters subscript expression in math expression.
2957 * \li Syntax: math-subscript
2958 * \li Origin: vermeer, 12 Dec 2001
2961 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
2964 * \var lyx::FuncCode lyx::LFUN_MATH_SUPERSCRIPT
2965 * \li Action: Enters superscript expression in math expression.
2966 * \li Syntax: math-superscript
2967 * \li Origin: vermeer, 12 Dec 2001
2970 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
2973 * \var lyx::FuncCode lyx::LFUN_MENU_OPEN
2974 * \li Action: Opens the menu given by its name.
2975 * \li Syntax: menu-open <NAME>
2976 * \li Params: <NAME>: menu name. See various .inc files in lib/ui for candidates.
2979 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
2982 * \var lyx::FuncCode lyx::LFUN_MESSAGE
2983 * \li Action: Shows message in statusbar (for script purposes).
2984 * \li Syntax: message <STRING>
2985 * \li Origin: Lgb, 8 Apr 2001
2988 { LFUN_MESSAGE, "message", NoBuffer, System },
2991 * \var lyx::FuncCode lyx::LFUN_META_PREFIX
2992 * \li Action: Simulate halting Meta key (Alt key on PCs).
2993 * \li Notion: Used for buffer edition not for GUI control.
2994 * \li Syntax: meta-prefix
2997 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
3000 * \var lyx::FuncCode lyx::LFUN_MOUSE_DOUBLE
3001 * \li Action: This function is called when double click on mouse button is
3002 pressed (inside workarea). Action depends on the context.
3003 * \li Notion: This is an internal LFUN, not to be used by users.
3004 * \li Origin: Andre, 9 Aug 2002
3007 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
3010 * \var lyx::FuncCode lyx::LFUN_MOUSE_MOTION
3011 * \li Action: This function is called when mouse cursor is moving over the text.
3012 Action depends on the context.
3013 * \li Notion: This is an internal LFUN, not to be used by users.
3014 * \li Origin: Andre, 9 Aug 2002
3017 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
3020 * \var lyx::FuncCode lyx::LFUN_MOUSE_PRESS
3021 * \li Action: This function is called when mouse button is pressed (inside workarea).
3022 Action depends on the context.
3023 * \li Notion: This is an internal LFUN, not to be used by users.
3024 * \li Origin: Andre, 9 Aug 2002
3027 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
3030 * \var lyx::FuncCode lyx::LFUN_MOUSE_RELEASE
3031 * \li Action: This function is called when mouse button is released (inside workarea).
3032 Action depends on the context.
3033 * \li Notion: This is an internal LFUN, not to be used by users.
3034 * \li Origin: Andre, 9 Aug 2002
3037 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
3041 * \var lyx::FuncCode lyx::LFUN_MOUSE_TRIPLE
3042 * \li Action: This function is called when triple click on mouse button is
3043 pressed (inside workarea). Action depends on the context.
3044 * \li Notion: This is an internal LFUN, not to be used by users.
3045 * \li Origin: Andre, 9 Aug 2002
3048 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
3051 * \var lyx::FuncCode lyx::LFUN_NEWLINE_INSERT
3052 * \li Action: Inserts a line break or new line.
3053 * \li Syntax: newline-insert [<ARG>]
3054 * \li Params: <ARG>: <newline|linebreak> default: newline
3055 * \li Origin: spitz, 25 Mar 2008
3058 { LFUN_NEWLINE_INSERT, "newline-insert", Noop, Edit },
3061 * \var lyx::FuncCode lyx::LFUN_NEWPAGE_INSERT
3062 * \li Action: Inserts a new page.
3063 * \li Syntax: newpage-insert <ARG>
3064 * \li Params: <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
3065 * \li Origin: uwestoehr, 24 Nov 2007
3068 { LFUN_NEWPAGE_INSERT, "newpage-insert", Noop, Edit },
3071 * \var lyx::FuncCode lyx::LFUN_NOMENCL_INSERT
3072 * \li Action: Inserts Nomenclature entry.
3073 * \li Notion: It automatically takes the word on the cursor position if no symbol is given.
3074 * \li Syntax: nomencl-insert [<SYMBOL>]
3075 * \li Origin: Ugras, 4 Nov 2006
3078 { LFUN_NOMENCL_INSERT, "nomencl-insert", Noop, Edit },
3081 * \var lyx::FuncCode lyx::LFUN_NOMENCLATURE_PRINT
3082 * \li Action: Inserts list of Nomenclature entries.
3083 * \li Syntax: nomenclature-print
3084 * \li Origin: Ugras, 4 Nov 2006
3087 { LFUN_NOMENCL_PRINT, "nomencl-print", Noop, Edit },
3091 * \var lyx::FuncCode lyx::LFUN_NOTE_INSERT
3092 * \li Action: Inserts Note on the current cursor position,
3093 move selection inside the inset.
3094 * \li Syntax: note-insert [<TYPE>]
3095 * \li Params: <TYPE>: <Note|Greyedout|Comment> default: Note
3098 { LFUN_NOTE_INSERT, "note-insert", Noop, Edit },
3101 * \var lyx::FuncCode lyx::LFUN_NOTE_NEXT
3102 * \li Action: Moves the cursor to the beginning of next Note inset.
3103 * \li Syntax: note-next
3106 { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
3109 * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
3110 * \li Action: Move the current group in the downward direction in the
3111 structure of the document.
3112 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
3113 the whole substructure of the group.
3114 * \li Syntax: outline-down
3115 * \li Origin: Vermeer, 23 Mar 2006
3118 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
3121 * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
3122 * \li Action: Moves the current group in the downward direction in the
3123 hierarchy of the document structure.
3124 * \li Notion: Part -> Chapter -> Section -> etc.
3125 * \li Syntax: outline-in
3126 * \li Origin: Vermeer, 23 Mar 2006
3129 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
3132 * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
3133 * \li Action: Moves the current group in the upward direction in the
3134 hierarchy of the document structure.
3135 * \li Notion: Part <- Chapter <- Section <- etc.
3136 * \li Syntax: outline-out
3137 * \li Origin: Vermeer, 23 Mar 2006
3140 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
3144 * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
3145 * \li Action: Move the current group in the upward direction in the
3146 structure of the document.
3147 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
3148 the whole substructure of the group.
3149 * \li Syntax: outline-up
3150 * \li Origin: Vermeer, 23 Mar 2006
3153 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
3156 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_BREAK
3157 * \li Action: Breaks the current paragraph at the current location.
3158 * \li Notion: Removes the selection.
3159 * \li Syntax: paragraph-break [<LAYOUT>] [ignoresep]
3160 * \li Params: <LAYOUT>: "inverse" - decreases depth by one (or change layout
3161 to default layout) when the cursor is at the end of
3163 ignoresep: Do not account for paragraph separators while breaking.
3166 { LFUN_PARAGRAPH_BREAK, "paragraph-break", Noop, Edit },
3169 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN
3170 * \li Action: Move the cursor to the next paragraph (or beginning of the current one)
3171 in downward direction.
3172 * \li Syntax: paragraph-down
3173 * \li Origin: Asger, 1 Oct 1996
3176 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
3179 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN_SELECT
3180 * \li Action: Move the cursor and select the text to the next paragraph (or
3181 beginning of the current one) in downward direction.
3182 * \li Syntax: paragraph-down-select
3183 * \li Origin: Asger, 1 Oct 1996
3186 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
3189 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
3190 * \li Action: Jump to a paragraph given by its id number and optionally the
3191 desired position within the paragraph.
3192 If given four arguments id_start, pos_start, id_end, pos_end,
3193 perform a selection from start to end.
3194 * \li Notion: Note that id number of paragraph is not the sequential number of
3195 paragraph seen on the screen. Moreover the id is unique for all
3196 opened buffers (documents). Both ids must belong to the same
3198 * \li Syntax: paragraph-goto <PAR_ID> <POS_IN_PAR> [<PAR_ID> <POS_IN_PAR>]
3199 * \li Params: <PAR_ID>: paragraph id \n
3200 <POS_IN_PAR>: desired position within the paragraph
3201 * \li Origin: Dekel, 26 Aug 2000
3205 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly | NoInternal, Edit },
3208 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
3209 * \li Action: Moves the current paragraph downwards in the document.
3210 * \li Syntax: paragraph-move-down
3211 * \li Origin: Edwin, 8 Apr 2006
3214 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
3217 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
3218 * \li Action: Moves the current paragraph upwards in the document.
3219 * \li Notion: Movement through the document will possibly break the paragraph-depth
3220 (e.g. itemize structure).
3221 * \li Syntax: paragraph-move-up
3222 * \li Origin: Edwin, 8 Apr 2006
3225 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
3229 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
3230 * \li Action: Change paragraph settings.
3231 * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
3232 This function only modifies, and does not override, existing settings.
3233 Note that the "leftindent" indent setting is deprecated.
3234 * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
3235 * \li Params: <INDENT>: \noindent|\indent|\indent-toggle|\leftindent LENGTH\n
3236 <SPACING>: \paragraph_spacing default|single|onehalf|double|other SIZE \n
3237 <ALIGN>: \align block|left|right|center|default\n
3238 <OTHERS>: \labelwidthstring WIDTH|\start_of_appendix
3239 * \li Origin: rgh, Aug 15 2007
3242 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
3245 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
3246 * \li Action: Change paragraph settings.
3247 * \li Notion: Overwrite all nonspecified settings to the default ones.
3248 Use paragraph-params lfun if you don't want to overwrite others settings.
3249 * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
3250 * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
3251 * \li Origin: leeming, 30 Mar 2004
3254 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
3257 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP
3258 * \li Action: Move the cursor to the next paragraph (or beginning of the current one)
3259 in upward direction.
3260 * \li Syntax: paragraph-up
3261 * \li Origin: Asger, 1 Oct 1996
3264 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
3267 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UPDATE
3268 * \li Action: Updates the values inside the paragraph dialog from the paragraph.
3269 * \li Notion: This is an internal LFUN, not to be used by users. Called internally
3270 by #LFUN_DIALOG_UPDATE.
3271 * \li Origin: leeming, 13 Mar 2003
3274 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
3277 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_SELECT
3278 * \li Action: Move cursor to beginning of current paragraph
3279 and select to the end in downward direction
3280 * \li Notion: This function is by default bound to triple mouse click
3281 * \li Syntax: paragraph-select
3282 * \li Origin: Kornel, 16 Apr 2019
3285 { LFUN_PARAGRAPH_SELECT, "paragraph-select", ReadOnly, Edit },
3288 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP_SELECT
3289 * \li Action: Move the cursor and select the text to the next paragraph (or
3290 beginning of the current one) in upward direction.
3291 * \li Syntax: paragraph-up-select
3292 * \li Origin: Asger, 1 Oct 1996
3295 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
3298 * \var lyx::FuncCode lyx::LFUN_PASTE
3299 * \li Action: Pastes material (text or picture) from the active clipboard.
3300 * \li Syntax: paste [<TYPE>|<NUM>]
3301 * \li Params: <TYPE>: emf|pdf|png|jpeg|linkback|wmf|latex|html \n
3302 <NUM>: number of the selection in the internal clipboard stack to be pasted.
3305 { LFUN_PASTE, "paste", Noop, Edit },
3308 * \var lyx::FuncCode lyx::LFUN_PHANTOM_INSERT
3309 * \li Action: Inserts phantom on the current cursor position,
3310 move selection inside the inset.
3311 * \li Syntax: phantom-insert [<TYPE>]
3312 * \li Params: <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
3313 * \li Origin: uwestoehr, 30 Jan 2009
3316 { LFUN_PHANTOM_INSERT, "phantom-insert", Noop, Edit },
3319 * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
3320 * \li Action: Save user preferences.
3321 * \li Syntax: preferences-save
3322 * \li Origin: Lgb, 27 Nov 1999
3325 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
3328 * \var lyx::FuncCode lyx::LFUN_PREVIEW_INSERT
3329 * \li Action: Inserts a new preview inset.
3330 * \li Syntax: preview-insert
3331 * \li Origin: vfr, 28 Mar 2010
3334 { LFUN_PREVIEW_INSERT, "preview-insert", Noop, Edit },
3337 * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
3338 * \li Action: Pastes the currently selected text.
3339 * \li Notion: Primary selection mechanism is linux-only thing.
3340 * \li Syntax: primary-selection-paste [<ARG>]
3341 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
3344 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
3347 * \var lyx::FuncCode lyx::LFUN_QUOTE_INSERT
3348 * \li Action: Inserts quotes according to the type and quote-language preference.
3349 * \li Notion: Currently 15 different quote styles are distinguished (see params).
3350 * \li Syntax: quote-insert [<LEVEL>] [<SIDE>] [<STYLE>]
3351 * \li Params: <LEVEL>: 'inner' for (i.e., secondary, usually single) quotes, otherwise
3352 * outer (i.e., primary, usually double) quotes will be used.\n
3353 * <SIDE>: 'opening' for opening quotes, 'closing' for closing quotes,
3354 * otherwise the side will be guessed from the context.\n
3355 * <STYLE>: 'british' for `British' quote style (with ``inner quotation'')\n
3356 * 'cjk' for Chinese/Japanese/Korean corner bracket quotation marks\n
3357 * 'cjk-angle' for Chinese/Japanese/Korean angle bracket quotation marks\n
3358 * 'danish' for >>Danish<< quote style (with >inner quotation<)\n
3359 * 'english' for ``English'' quote style (with `inner quotation')\n
3360 * 'french' for <<french>> quote style (with ``inner quotation'')\n
3361 * 'frenchin' for <<frenchin>> quote style (with <<inner quotation>>) ["in" = Imprimerie Nationale]\n
3362 * 'german' for ,,German`` quote style (with ,inner quotation`)\n
3363 * 'plain' for "Plain" quote style (with 'inner quotation')\n
3364 * 'polish' for ,,Polish'' quote style (with ,inner quotation')\n
3365 * 'swedish' for ''Swedish'' quote style (with 'inner quotation')\n
3366 * 'swedishg' for >>swedishg>> quote style (with 'inner quotation') ["g" = Guillemets]\n
3367 * 'swiss' for <<Swiss>> quote style (with <inner quotation>)\n
3368 * 'russian' for <<Russian>> quote style (with ,,inner quotation``)\n
3369 * 'dynamic' for Dynamic quotation marks which inherit the global
3371 * If no quote style is specified, the document-wide will be used.
3374 { LFUN_QUOTE_INSERT, "quote-insert", Noop, Edit },
3377 * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
3378 * \li Action: Reconfigure the automatic settings.
3379 * \li Syntax: reconfigure
3380 * \li Origin: Asger, 14 Feb 1997
3383 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
3386 * \var lyx::FuncCode lyx::LFUN_REDO
3387 * \li Action: Redoes the last thing undone.
3391 { LFUN_REDO, "redo", ReadOnly, Edit },
3394 * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
3395 * \li Action: Go to the next label or cross-reference.
3396 * \li Syntax: reference-next
3397 * \li Origin: Dekel, 14 Jan 2001
3400 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
3404 * \var lyx::FuncCode lyx::LFUN_REGEXP_MODE
3405 * \li Action: Enters regexp mode (i.e., puts regexp insets on the current
3406 cursor position). Used by the advanced search dialog.
3407 * \li Notion: If there is any selected text, then it is moved inside the created
3409 * \li Syntax: regexp-mode [<ARG>]
3410 * \li Params: <ARG>: eventual argument (regular expression).
3411 * \li Origin: Tommaso, 4 Oct 2008
3414 { LFUN_REGEXP_MODE, "regexp-mode", Noop, Math },
3417 * \var lyx::FuncCode lyx::LFUN_REPEAT
3418 * \li Action: Repeat the given command.
3419 * \li Notion: fails when the repeat count is greater than 10000.
3420 * \li Syntax: repeat <COUNT> <LFUN-COMMAND>
3421 * \li Origin: Andre, 27 Oct 2003
3424 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
3427 * \var lyx::FuncCode lyx::LFUN_SEARCH_IGNORE
3428 * \li Action: Enables/disables searching for features in findadv
3429 * \li Syntax: search-ignore <type> <value>
3430 * \li Params: <type>: language|color|sectioning|font|series|shape|family|markup|underline|strike
3431 * \li Params: <value>: true|false
3434 { LFUN_SEARCH_IGNORE, "search-ignore", ReadOnly|NoBuffer|NoUpdate, System },
3437 * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN
3438 * \li Action: Moves the cursor one page in downward direction.
3439 * \li Syntax: screen-down
3442 { LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit },
3445 * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN_SELECT
3446 * \li Action: Moves the cursor one screen in downward direction adding the current
3447 position to the selection.
3448 * \li Syntax: screen-down-select
3451 { LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit },
3454 * \var lyx::FuncCode lyx::LFUN_SCREEN_FONT_UPDATE
3455 * \li Action: Update fonts and its metrics.
3456 * \li Notion: Automatically called after zoom, dpi, font names, or norm change.
3457 * \li Syntax: screen-font-update
3458 * \li Origin: ARRae, 13 Aug 2000
3461 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
3464 * \var lyx::FuncCode lyx::LFUN_SCREEN_RECENTER
3465 * \li Action: Recenters the screen on the current cursor position.
3466 * \li Syntax: screen-recenter
3469 { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit },
3473 * \var lyx::FuncCode lyx::LFUN_SCREEN_SHOW_CURSOR
3474 * \li Action: Repositions the screen such that the cursor is visible.
3475 * \li Syntax: screen-show-cursor
3476 * \li Origin: vfr, 25 Mar 2009
3479 { LFUN_SCREEN_SHOW_CURSOR, "screen-show-cursor", ReadOnly, Edit },
3483 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP
3484 * \li Action: Moves the cursor one page in upward direction.
3485 * \li Syntax: screen-up
3488 { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit },
3491 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP_SELECT
3492 * \li Action: Moves the cursor one page in upward direction adding the current
3493 position to the selection.
3494 * \li Syntax: screen-up-select
3497 { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit },
3500 * \var lyx::FuncCode lyx::LFUN_SCRIPT_INSERT
3501 * \li Action: Inserts a subscript or superscript inset.
3502 * \li Syntax: script-insert <TYPE>
3503 * \li Params: <TYPE>: subscript|superscript
3504 * \li Origin: Georg, 23 Nov 2010
3507 { LFUN_SCRIPT_INSERT, "script-insert", Noop, Edit },
3510 * \var lyx::FuncCode lyx::LFUN_SCROLL
3511 * \li Action: Scroll the buffer view.
3512 * \li Notion: Only scrolls the screen up or down; does not move the cursor.
3513 * \li Syntax: scroll <TYPE> <QUANTITY>
3514 * \li Params: <TYPE>: line|page\n
3515 <QUANTITY>: up|down|<number>
3516 * \li Origin: Abdel, Dec 27 2007
3519 { LFUN_SCROLL, "scroll", ReadOnly, Edit },
3522 * \var lyx::FuncCode lyx::LFUN_SECTION_SELECT
3523 * \li Action: Select the whole section.
3524 * \li Notion: The cursor should be in a section heading
3525 before calling this lfun.
3526 * \li Syntax: section-select
3527 * \li Origin: vfr, 05 May 2009
3530 { LFUN_SECTION_SELECT, "section-select", ReadOnly, Edit },
3534 * \var lyx::FuncCode lyx::LFUN_SELECTION_PASTE
3535 * \li Action: Pastes the internal selection text in permanent selection.
3536 * \li Notion: Created in order to have middle mouse button pasting correct (bound to
3537 command-alternatives selection-paste ; primary-selection-paste paragraph).
3538 * \li Syntax: selection-paste
3539 * \li Origin: lasgouttes, 14 Jan 2009
3542 { LFUN_SELECTION_PASTE, "selection-paste", Noop, Edit },
3545 * \var lyx::FuncCode lyx::LFUN_SELF_INSERT
3546 * \li Action: Inserts the given string (accordingly to the correct keymap).
3547 * \li Notion: Automatically replace the currently selected text. Depends on lyxrc
3548 settings "auto_region_delete".
3549 * \li Syntax: self-insert <STRING>
3552 { LFUN_SELF_INSERT, "self-insert", SingleParUpdate, Hidden },
3555 * \var lyx::FuncCode lyx::LFUN_SEPARATOR_INSERT
3556 * \li Action: Inserts an environment separator or latex paragraph break.
3557 * \li Syntax: separator-insert [<ARG>]
3558 * \li Params: <ARG>: <plain|parbreak|latexpar> default: plain
3559 * \li Origin: ef, 2 May 2014
3562 { LFUN_SEPARATOR_INSERT, "separator-insert", Noop, Edit },
3565 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_FILENAME
3566 * \li Action: Returns path and file name of the currently edited document.
3567 * \li Syntax: server-get-filename
3570 { LFUN_SERVER_GET_FILENAME, "server-get-filename", ReadOnly, System },
3573 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_LAYOUT
3574 * \li Action: Returns the current layout (that is environment) name
3575 on the cursor position.
3576 * \li Syntax: server-get-layout
3579 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
3582 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_STATISTICS
3583 * \li Action: Returns the statistics (number of words and characters)
3584 in the document or in the given selection.
3585 * \li Notion: Note that this function gives the number of words/chars written,
3586 not the number of characters which will be typeset.
3587 * \li Syntax: server-get-statistics [<TYPE>]
3588 * \li Params: <TYPE>: <words|chars|chars-space> The requested count; if not
3589 specified, the three values are returned, separated
3591 words: count words.\n
3592 chars: count characters.\n
3593 chars-space: count characters and spaces.
3594 * \li Origin: brokenclock, Oct 10 2014
3597 { LFUN_SERVER_GET_STATISTICS, "server-get-statistics", ReadOnly, System },
3600 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
3601 * \li Action: Returns the coordinates of cursor position in the editing area.
3602 * \li Syntax: server-get-xy
3605 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
3609 * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
3610 * \li Action: Sets the cursor position in LyX based on the row number of generated TeX file.
3611 * \li Notion: This can be useful for DVI inverse-search or detection of the problematic
3612 line from LaTeX compilation. Note that before this function can be used
3613 export to LaTeX output must occur (in order to map the row numbers).
3614 * \li Syntax: server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
3615 * \li Params: <FILE>: the path and filename. Environment variables are expanded in the path.
3616 In case this LFUN does not work make sure you are giving correct
3618 If the file is located inside LyX temporary directory it will be
3619 mapped back into the appropriate opened buffer (e.g. for the case
3620 of generated .tex file).\n
3621 .ext: extensions will be automatically replaced by .lyx.\n
3622 <ROW_NUMBER> The row number of the LaTeX file to which to go.
3623 * \li Sample: server-goto-file-row /home/user/example.lyx 41\n
3624 server-goto-file-row /tmp/lyx_tmpdir.XM3088/lyx_tmpbuf0/example.tex 41
3625 * \li Origin: Edmar, 23 Dec 1998
3628 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly | NoBuffer, System },
3631 * \var lyx::FuncCode lyx::LFUN_SERVER_NOTIFY
3632 * \li Action: Sends notify message about the last key-sequence to client.
3633 * \li Notion: This can be used to grab last key-sequence used inside the LyX window.
3634 See also Debug extensions section in Additional features manual.
3635 * \li Syntax: server-notify
3638 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
3641 * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
3642 * \li Action: Sets the cursor position based on the editing area coordinates
3643 (similar to clicking on that point with left mouse button).
3644 * \li Syntax: server-set-xy <X> <Y>
3647 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
3650 * \var lyx::FuncCode lyx::LFUN_SET_COLOR
3651 * \li Action: Set the given LyX color to the color defined by the X11 name given.
3652 * \li Notion: A new color entry is created if the color is unknown.
3653 Color names can be stored as a part of user settings.
3654 * \li Syntax: set-color <LYX_NAME> <X11_NAME>
3655 * \li Origin: SLior, 11 Jun 2000
3658 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
3661 * \var lyx::FuncCode lyx::LFUN_GRAPHICS_SET_GROUP
3662 * \li Action: Set the group for the graphics inset on the cursor position.
3663 * \li Syntax: graphics-set-group [<GROUP>]
3664 * \li Params: <GROUP>: Id for an existing group. In case the Id is an empty string,
3665 the graphics inset is removed from the current group.
3666 * \li Origin: sanda, 6 May 2008
3669 { LFUN_GRAPHICS_SET_GROUP, "graphics-set-group", Noop, Edit },
3672 * \var lyx::FuncCode lyx::LFUN_GRAPHICS_UNIFY
3673 * \li Action: Set the same group for all graphics insets in the marked block.
3674 * \li Syntax: graphics-unify [<GROUP>]
3675 * \li Params: <GROUP>: Id for an existing group. In case the Id is an empty string,
3676 the group Id from the first graphics inset will be used.
3677 * \li Origin: sanda, 7 Feb 2018
3680 { LFUN_GRAPHICS_UNIFY, "graphics-unify", Noop, Edit },
3683 * \var lyx::FuncCode lyx::LFUN_GRAPHICS_RELOAD
3684 * \li Action: Reloads the image if necessary.
3685 * \li Syntax: graphics-reload
3686 * \li Origin: vfr, 10 Aug 2009
3689 { LFUN_GRAPHICS_RELOAD, "graphics-reload", ReadOnly | AtPoint, Edit },
3692 * \var lyx::FuncCode lyx::LFUN_SPACE_INSERT
3693 * \li Action: Inserts one of horizontal space insets.
3694 * \li Syntax: space-insert <NAME> [<LEN>]
3695 * \li Params: <NAME>: normal, protected, visible, thin, quad, qquad, enspace,
3696 enskip, negthinspace, negmedspace, negthickspace, hfill,
3697 hfill*, dotfill, hrulefill, hspace, hspace* \n
3698 Only in math mode: med and thick.\n
3699 <LEN>: length for custom spaces (hspace, hspace* for protected)
3700 * \li Origin: spitz, 20 May 2003, Mar 17 2008
3703 { LFUN_SPACE_INSERT, "space-insert", Noop, Edit },
3706 * \var lyx::FuncCode lyx::LFUN_SPECIALCHAR_INSERT
3707 * \li Action: Inserts various characters into the document.
3708 * \li Syntax: specialchar-insert <CHAR>
3709 * \li Params: <CHAR>: hyphenation, allowbreak, ligature-break, slash,
3710 nobreakdash, dots, end-of-sentence, menu-separator,
3711 lyx, tex, latex, latex2e.
3712 * \li Origin: spitz, 6 Dec 2007
3715 { LFUN_SPECIALCHAR_INSERT, "specialchar-insert", Noop, Edit },
3718 * \var lyx::FuncCode lyx::LFUN_SPELLING_ADD
3719 * \li Action: Add the word under the cursor to the respective
3720 * spell checker dictionary.
3721 * The default for the language is retrieved from the cursor position.
3722 * \li Syntax: spelling-add [<STRING>] [<LANG>]
3723 * \li Params: <WORD>: word to add
3724 <LANG>: language name (see file languages)
3725 * \li Origin: spitz, 18 Jan 2010
3728 { LFUN_SPELLING_ADD, "spelling-add", ReadOnly, Edit },
3731 * \var lyx::FuncCode lyx::LFUN_SPELLING_CONTINUOUSLY
3732 * \li Action: Toggle continuous spell checking.
3733 * \li Syntax: spelling-continuously
3734 * \li Origin: vfr, 24 March 2013
3737 { LFUN_SPELLING_CONTINUOUSLY, "spelling-continuously", ReadOnly, Edit },
3741 * \var lyx::FuncCode lyx::LFUN_SPELLING_IGNORE
3742 * \li Action: Let the spell checker ignore the word under the cursor
3743 * in the current session for the given language.
3744 * The default for the language is retrieved from the cursor position.
3745 * \li Syntax: spelling-ignore [<WORD>] [<LANG>]
3746 * \li Params: <WORD>: word to ignore
3747 <LANG>: language name (see file languages)
3748 * \li Origin: spitz, 18 Jan 2010
3751 { LFUN_SPELLING_IGNORE, "spelling-ignore", ReadOnly, Edit },
3754 * \var lyx::FuncCode lyx::LFUN_SPELLING_REMOVE
3755 * \li Action: Remove the word under the cursor from the respective
3756 * spell checker dictionary.
3757 * The default for the language is retrieved from the cursor position.
3758 * \li Syntax: spelling-remove [<STRING>] [<LANG>]
3759 * \li Params: <WORD>: word to remove
3760 * <LANG>: language name (see file languages)
3761 * \li Origin: SWitt, 28 July 2010
3764 { LFUN_SPELLING_REMOVE, "spelling-remove", ReadOnly, Edit },
3768 * \var lyx::FuncCode lyx::LFUN_STATISTICS
3769 * \li Action: Count the statistics (number of words and characters)
3770 in the document or in the given selection and display it
3772 * \li Notion: Note that this function gives the number of words/chars written,
3773 not the number of characters which will be typeset.
3774 * \li Syntax: statistics
3775 * \li Origin: lasgouttes, Jan 27 2004; sanda, Jan 8 2008
3778 { LFUN_STATISTICS, "statistics", ReadOnly, System },
3781 * \var lyx::FuncCode lyx::LFUN_TABULAR_FEATURE
3782 * \li Action: Modify properties of tabulars and table-like math environments.
3783 * \li Syntax: tabular-feature <FEATURE> [<ARG>]
3784 * \li Params: Generally see #LFUN_INSET_INSERT for further details.\n
3785 * <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|\n
3786 copy-column|move-column-right|move-column-left|move-row-down|move-row-up|\n
3787 set-line-top|set-line-bottom|set-line-left|set-line-right|\n
3788 toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|\n
3789 set-ltrim-top|set-rtrim-top|set-ltrim-bottom|set-rtrim-bottom\n
3790 toggle-ltrim-top|toggle-rtrim-top|toggle-ltrim-bottom|toggle-rtrim-bottom\n
3791 align-left|align-right|align-center|align-block|align-decimal|set-decimal-point|\n
3792 valign-top|valign-bottom|valign-middle|longtabular-align-left|\n
3793 longtabular-align-center|longtabular-align-right|m-align-left|m-align-right|\n
3794 m-align-center|m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|\n
3795 reset-formal-default|set-all-lines|unset-all-lines|toggle-longtabular|\n
3796 set-longtabular|unset-longtabular|set-pwidth|\n
3797 set-mpwidth|set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|\n
3798 set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|\n
3799 unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|\n
3800 set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|\n
3801 set-special-column|set-special-multicolumn|set-special-multirow|\n
3802 toggle-booktabs|set-booktabs|unset-booktabs|set-top-space|set-bottom-space|\n
3803 set-interline-space|set-border-lines|tabular-valign-top|\n
3804 tabular-valign-middle|tabular-valign-bottom|set-tabular-width|\n
3805 toggle-varwidth-column
3806 Various math-environment features are handled as well, e.g. add-vline-left/right for\n
3807 the Grid/Array environment.\n
3808 <ARG>: additional argument for some commands, use debug mode to explore its values.
3809 * \li Origin: gm, 10 Dec 2015
3812 { LFUN_TABULAR_FEATURE, "tabular-feature", Noop, Edit },
3815 * \var lyx::FuncCode lyx::LFUN_TABULAR_INSERT
3816 * \li Action: Inserts table into the document.
3817 * \li Notion: See #LFUN_TABULAR_FEATURE for some more details
3818 about tabular modifications.
3819 * \li Syntax: tabular-insert [<ROWS> <COLUMNS>]
3820 * \li Params: In case no arguments are given show insert dialog.
3821 * \li Origin: Jug, 12 Apr 2000
3824 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
3827 * \var lyx::FuncCode lyx::LFUN_TABULAR_STYLE_INSERT
3828 * \li Action: Inserts table of a given style into the document.
3829 * \li Notion: See #LFUN_TABULAR_FEATURE for some more details
3830 about tabular modifications.
3831 * \li Syntax: tabular-style-insert <style> <ROWS> <COLUMNS>
3832 * \li Params: Valid styles are the names of the files in lib/tabletemplates,
3833 * minus _1x<n> and .lyx suffix.
3834 * \li Origin: spitz, 25 Mar 2019
3837 { LFUN_TABULAR_STYLE_INSERT, "tabular-style-insert", Noop, Edit },
3840 * \var lyx::FuncCode lyx::LFUN_TAB_DELETE
3841 * \li Action: Delete a tab or up to an equivalent amount of spaces from
3843 * \li Notion: It also works on a selection - it removes a tab or spaces from the
3844 beginning of each line spanned by the selection. This is useful if
3845 you want to indent/unindent multiple lines in one action.
3846 * \li Syntax: tab-delete
3847 * \li Origin: vfr, Sep 30 2008
3850 { LFUN_TAB_DELETE, "tab-delete", SingleParUpdate, Edit },
3853 * \var lyx::FuncCode lyx::LFUN_TAB_GROUP_CLOSE
3854 * \li Action: Close the current tab group.
3855 * \li Notion: This only closes the work areas, not the buffers themselves.
3856 The still opened buffers can be visualized in another tab group.
3857 * \li Syntax: tab-group-close
3858 * \li Origin: Abdel, 21 Feb 2008
3861 { LFUN_TAB_GROUP_CLOSE, "tab-group-close", ReadOnly, Buffer },
3865 * \var lyx::FuncCode lyx::LFUN_TAB_INSERT
3866 * \li Action: Insert a tab into a listings inset.
3867 * \li Notion: It also works on a selection.
3868 * \li Syntax: tab-insert
3869 * \li Origin: vfr, Sep 30 2008
3872 { LFUN_TAB_INSERT, "tab-insert", SingleParUpdate, Edit },
3875 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
3876 * \li Action: Sets the text class for the current buffer.
3877 * \li Syntax: textclass-apply <TEXTCLASS>
3878 * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
3879 the filename, minus the ".layout" extension.
3882 { LFUN_TEXTCLASS_APPLY, "textclass-apply", NoInternal, Layout },
3885 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
3886 * \li Action: Loads information for a textclass from disk.
3887 * \li Syntax: textclass-load <TEXTCLASS>
3888 * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
3889 the filename, minus the ".layout" extension.
3892 { LFUN_TEXTCLASS_LOAD, "textclass-load", NoInternal, Layout },
3896 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_APPLY
3897 * \li Action: Apply last used text properties.
3898 * \li Syntax: textstyle-apply [<NUM>]
3899 * \li Params: <NUM>: number of the selection in the internal freefonts stack to be applied.
3900 * \li Notion: These properties are stored via #LFUN_TEXTSTYLE_UPDATE, which is
3901 automatically triggered when using Text Style dialog.
3902 * \li Syntax: textstyle-apply
3903 * \li Origin: leeming, 12 Mar 2003
3906 { LFUN_TEXTSTYLE_APPLY, "textstyle-apply", Noop, Layout },
3909 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_UPDATE
3910 * \li Action: Apply text style and update the settings to be used by #LFUN_TEXTSTYLE_APPLY.
3911 * \li Syntax: textstyle-update <FONT_INFO>
3912 * \li Params: <FONT_INFO>: specifies font attributes, e.g. family, series, shape,
3913 size, emph, noun, underbar, number, color, language,
3915 Use lyx -dbg action for exact syntax of text-style
3917 * \li Origin: leeming, 12 Mar 2003
3920 { LFUN_TEXTSTYLE_UPDATE, "textstyle-update", Noop, Layout },
3923 * \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
3924 * \li Action: Look up thesaurus entries with respect to the word under the cursor.
3925 * \li Syntax: thesaurus-entry [<STRING>] [lang=<LANG>]
3926 * \li Params: <STRING>: word to look up
3927 <LANG>: language (see file languages)
3928 * \li Origin: Levon, 20 Jul 2001
3931 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
3934 * \var lyx::FuncCode lyx::LFUN_TOOLBAR_MOVABLE
3935 * \li Action: Toggles movability of a given toolbar between true/false.
3936 * \li Syntax: toolbar-movable <NAME>
3937 * \li Params: <NAME>: *|standard|extra|table|math|mathmacrotemplate|
3938 minibuffer|review|view/update|math_panels|vcs|
3939 view-others|update-others
3940 * \li Origin: daniel, 12 July 2016
3943 { LFUN_TOOLBAR_MOVABLE, "toolbar-movable", NoBuffer, Buffer },
3946 * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
3947 * \li Action: Toggles visibility of a given toolbar between on/off/auto.
3948 * \li Notion: Skipping "auto" when allowauto is false.
3949 * \li Syntax: toolbar-toggle <NAME> [allowauto]
3950 * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|\n
3951 minibuffer|review|view/update|math_panels|vcs|
3952 view-others|update-others
3953 * \li Origin: Edwin, 21 May 2007
3956 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
3959 * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
3960 * \li Action: Various UI visibility-toggling actions.
3961 * \li Syntax: ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
3962 * \li Params: statusbar : Toggle visibility of the statusbar.\n
3963 menubar : Toggle visibility of the menubar.\n
3964 scrollbar : Toggle visibility of the scrollbar.\n
3965 frame : Toggle visibility of the frames around editing window.\n
3966 fullscreen : Toggle fullscreen mode. This also covers calling the
3967 previous functions. However #LFUN_TOOLBAR_TOGGLE for the
3968 custom tweaks of the toolbars should be used.
3969 * \li Origin: sanda, 9 Feb 2007
3972 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
3976 * \var lyx::FuncCode lyx::LFUN_UNDO
3977 * \li Action: Undoes the last edit.
3981 { LFUN_UNDO, "undo", ReadOnly, Edit },
3984 * \var lyx::FuncCode lyx::LFUN_UNICODE_INSERT
3985 * \li Action: Inserts a single unicode character.
3986 * \li Syntax: unicode-insert <CHAR1> <CHAR2> ...
3987 * \li Params: <CHARn>: The character to insert, given as its code
3988 point, in hexadecimal.
3989 * \li Sample: unicode-insert 0x0100 0x0259
3990 * \li Origin: Lgb, 22 Oct 2006
3993 { LFUN_UNICODE_INSERT, "unicode-insert", Noop, Edit },
3996 * \var lyx::FuncCode lyx::LFUN_UP
3997 * \li Action: Moves the cursor one line in upward direction.
4001 { LFUN_UP, "up", ReadOnly | NoUpdate, Edit },
4004 * \var lyx::FuncCode lyx::LFUN_UP_SELECT
4005 * \li Action: Moves the cursor one line in upward direction adding the current
4006 position to the selection.
4007 * \li Syntax: up-select
4010 { LFUN_UP_SELECT, "up-select", ReadOnly | SingleParUpdate, Edit },
4013 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_IN
4014 * \li Action: Checks-in/commits the changes of the registered file to the repository.
4015 * \li Notion: In RCS case this also unlocks the file.
4016 * \li Syntax: vc-check-in
4017 * \li Origin: Lgb, 1 Jul 1997
4020 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
4023 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_OUT
4024 * \li Action: Checks-out the document for edit (and locks it in some cases).
4025 * \li Syntax: vc-check-out
4026 * \li Origin: Lgb, 1 Jul 1997
4029 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
4032 * \var lyx::FuncCode lyx::LFUN_VC_COMMAND
4033 * \li Action: Executes external command. This command is intended to support
4034 additional VCS commands.
4035 * \li Syntax: vc-command <FLAG> <PATH> <COMMAND>
4036 * \li Params: <FLAG>: Flags for the command can be combined together.\n
4037 U - dUmmy - no flags \n
4038 D - Doc - need document loaded to proceed \n
4039 I - dIrty - mark document dirty \n
4040 R - Reload - ensure that the document is saved and reload it after command execution \n
4041 M - Message - ask for input string (commit message)\n
4042 <PATH>: path where to start. $$p will be replaced by the current document path.\n
4043 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current
4044 document(with absolute path)/path/message.
4045 * \li Sample: vc-command DR $$p "svn up"
4046 * \li Origin: sanda, 13 Jan 2009
4049 { LFUN_VC_COMMAND, "vc-command", NoBuffer | ReadOnly, System },
4052 * \var lyx::FuncCode lyx::LFUN_VC_COMPARE
4053 * \li Action: Compares two revisions of the same file under version control.
4054 * \li Syntax: vc-compare [<REV1>] [<REV2>]
4055 * \li Params: Revision number either points directly to commit in history
4056 or if negative number -x it points to (last commit - x).\n
4057 In RCS we subtract only in the last number of revision specification.
4058 Special case "0" is reserved for the last committed revision.\n
4059 <REV1>: Older file.\n
4060 <REV2>: Newer file. Used only if REV1 > 0.\n
4061 If no parameter is given, interactive dialog will be shown.
4062 * \li Sample: Compare current document against last commit\n
4064 Compare current document against current revision - 5 commits\n
4066 Compare revisions 120 and 155\n
4068 * \li Origin: sanda, 12 Feb 2010
4071 { LFUN_VC_COMPARE, "vc-compare", ReadOnly, System },
4075 * \var lyx::FuncCode lyx::LFUN_VC_COPY
4076 * \li Action: Copies the document to another name.
4077 * \li Notion: Copying with revision history is only supported by SVN.
4078 For RCS and CVS it is simulated by adding the document
4080 Disabled if uncommitted changes exist.
4081 * \li Syntax: vc-copy <FILENAME>
4082 * \li Params: <FILENAME>: New name of the document.\n
4083 * A file dialog is opened if no filename is given.
4084 * \li Origin: gb, 05 Feb 2013
4087 { LFUN_VC_COPY, "vc-copy", ReadOnly, System },
4090 * \var lyx::FuncCode lyx::LFUN_VC_LOCKING_TOGGLE
4091 * \li Action: Toggles the locking property of the edited file.
4092 * \li Notion: This is currently implemented only for SVN.
4093 * \li Syntax: vc-locking-toggle
4094 * \li Origin: sanda, 25 Jun 2009
4097 { LFUN_VC_LOCKING_TOGGLE, "vc-locking-toggle", ReadOnly, System },
4100 * \var lyx::FuncCode lyx::LFUN_VC_REGISTER
4101 * \li Action: Register the document as an file inside version control system.
4102 * \li Notion: File is registered inside cvs, svn or rcs repository acording to the existence
4103 of cvs/svn/rcs entries in the document's directory. \n
4104 See LyX Additional Features Manual (Version Control Chapter) for additional
4106 * \li Syntax: vc-register
4107 * \li Origin: Lgb, 1 Jul 1997
4110 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
4113 * \var lyx::FuncCode lyx::LFUN_VC_RENAME
4114 * \li Action: Renames the document to another name.
4115 * \li Notion: Renaming with revision history is only supported by SVN.
4116 For CVS it is simulated by adding the document under a new
4117 name and deleting the old one. For RCS it is not supported.
4118 Disabled if uncommitted changes exist.
4119 * \li Syntax: vc-rename <FILENAME>
4120 * \li Params: <FILENAME>: New name of the document.\n
4121 * A file dialog is opened if no filename is given.
4122 * \li Origin: gb, 05 Feb 2013
4125 { LFUN_VC_RENAME, "vc-rename", ReadOnly, System },
4128 * \var lyx::FuncCode lyx::LFUN_VC_REPO_UPDATE
4129 * \li Action: Update the local archive directory in which resides
4130 the current document with the remote repository.
4131 * \li Syntax: vc-repo-update
4132 * \li Origin: sanda, 16 Oct 2009
4135 { LFUN_VC_REPO_UPDATE, "vc-repo-update", ReadOnly, System },
4138 * \var lyx::FuncCode lyx::LFUN_VC_REVERT
4139 * \li Action: Reverts the document to the last check-in/commit in VCS.
4140 * \li Syntax: vc-revert
4141 * \li Origin: Lgb, 1 Jul 1997
4144 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
4147 * \var lyx::FuncCode lyx::LFUN_VC_UNDO_LAST
4148 * \li Action: Undo last check-in.
4149 * \li Notion: This is currently implemented only for RCS.
4150 * \li Syntax: vc-check-out
4151 * \li Origin: Lgb, 1 Jul 1997
4154 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
4157 * \var lyx::FuncCode lyx::LFUN_VIEW_CLOSE
4158 * \li Action: Close the current document work area.
4159 * \li Notion: Close the current work area. If no other work areas are showing the buffer,
4160 then close the associated buffer as well.
4161 * \li Syntax: view-close
4162 * \li Origin: Tommaso, 15 Sep 2012
4165 { LFUN_VIEW_CLOSE, "view-close", ReadOnly, Buffer },
4169 * \var lyx::FuncCode lyx::LFUN_VIEW_SPLIT
4170 * \li Action: Creates another split view of current buffer.
4171 * \li Notion: All split views act in the same way independently.
4172 * \li Syntax: view-split <vertical|horizontal>
4173 * \li Params: horizontal : The work areas are laid out side by side.\n
4174 vertical : The work areas laid out vertically.
4175 * \li Origin: Abdel, 20 Feb 2008
4178 { LFUN_VIEW_SPLIT, "view-split", ReadOnly, Buffer },
4182 * \var lyx::FuncCode lyx::LFUN_WINDOW_CLOSE
4183 * \li Action: Closes the current LyX window.
4184 * \li Syntax: window-close
4185 * \li Origin: Abdel, 23 Oct 2006
4188 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
4192 * \var lyx::FuncCode lyx::LFUN_WINDOW_NEW
4193 * \li Action: Creates new empty LyX window.
4194 * \li Notion: Already opened documents from the previous window can be found under View menu.
4195 * \li Syntax: window-new [<GEOMETRY>]
4196 * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently
4197 accepted only on Windows platform.
4198 * \li Origin: Abdel, 21 Oct 2006
4201 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
4204 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD
4205 * \li Action: Moves the cursor to the logically previous beginning of a word.
4206 * \li Notion: This is not the action which should be bound to the arrow keys,
4207 because backwards may be left or right, depending on the
4208 language. The arrow keys should be bound to #LFUN_WORD_LEFT or
4209 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
4210 * \li Syntax: word-backward
4213 { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit },
4216 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD_SELECT
4217 * \li Action: Moves the cursor to the logically previous beginning of a word,
4218 adding the logically traversed text to the selection.
4219 * \li Notion: See also #LFUN_WORD_BACKWARD.
4220 * \li Syntax: word-backward-select
4223 { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
4226 * \var lyx::FuncCode lyx::LFUN_WORD_CAPITALIZE
4227 * \li Action: Capitalizes the words in the selection (i.e. the first letters)
4228 or the first letter of word at cursor position.
4229 * \li Syntax: word-capitalize [<SEL_TYPE>]
4230 * \li Params: <SEL_TYPE>: if this is equal to "partial", then the
4231 * default word starts at cursor position (emacs-style).
4232 * Otherwise, the whole word is considered.
4235 { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
4238 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_BACKWARD
4239 * \li Action: Deletes characters to the beginning of the word (usually the "C+BackSpace" key).
4240 * \li Syntax: word-delete-backward [force]
4241 * \li Params: force: Delete big insets, do not only select them.
4244 { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
4247 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_FORWARD
4248 * \li Action: Deletes characters to the end of the word (usually the "C+Delete" key).
4249 * \li Syntax: word-delete-forward [force]
4250 * \li Params: force: Delete big insets, do not only select them.
4253 { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
4256 * \var lyx::FuncCode lyx::LFUN_WORD_FIND
4257 * \li Action: Search for next occurrence of a string.
4258 * \li Syntax: word-find [<DATA>]
4259 * \li Params: <DATA>: data encoded from Find dialog (see #lyx::find2string()).
4260 If no parameter is given, search with last find-dialog
4261 data is used for search (i.e. find-next).
4262 * \li Origin: Andre, Jan 7 2004
4265 { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
4268 * \var lyx::FuncCode lyx::LFUN_WORD_FINDADV
4269 * \li Action: Search for next occurrence of a pattern.
4270 * \li Syntax: word-findadv [<DATA>]
4271 * \li Params: <DATA>: data encoded from FindAdv dialog (see #lyx::findadv2string()).
4272 If no parameter is given, search with last find-dialog
4273 data is used for search (i.e. find-next).
4274 * \li Origin: Tommaso, Nov 15 2007
4277 { LFUN_WORD_FINDADV, "word-findadv", ReadOnly | NoBuffer, Edit },
4280 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_BACKWARD
4281 * \li Action: Search for a given string in backward direction.
4282 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
4283 * \li Syntax: word-find-backward [<STRING>]
4284 * \li Origin: Etienne, 20 Feb 1998
4287 { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
4290 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_FORWARD
4291 * \li Action: Search for a given string in forward direction.
4292 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
4293 * \li Syntax: word-find-forward [<STRING>]
4294 * \li Origin: Etienne, 16 Feb 1998
4297 { LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit },
4300 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD
4301 * \li Action: Moves the cursor to the logically next beginning of a word.
4302 * \li Notion: This is not the action which should be bound to the arrow keys,
4303 because forward may be left or right, depending on the language.
4304 The arrow keys should be bound to #LFUN_WORD_LEFT or
4305 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
4306 * \li Syntax: word-forward
4309 { LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
4312 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD_SELECT
4313 * \li Action: Moves the cursor to the logically next beginning of a word,
4314 adding the logically traversed text to the selection.
4315 * \li Notion: See also #LFUN_WORD_FORWARD.
4316 * \li Syntax: word-forward-select
4319 { LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
4322 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT
4323 * \li Action: Moves the cursor to the next beginning of a word "on the left".
4324 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
4325 "left" key is pressed. Generally, it moves the cursor to the
4326 next beginning of a word on the left. However, in Bidi text this
4327 become slightly more complicated, and there are different modes
4328 of cursor movement. In "visual mode", this moves left, plain and
4329 simple. In "logical mode", movement is logically forward in RTL
4330 paragraphs, and logically backwards in LTR paragraphs.
4331 * \li Syntax: word-left
4332 * \li Origin: dov, 28 Oct 2007
4335 { LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
4338 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT_SELECT
4339 * \li Action: Moves the cursor to the next beginning of a word "on the left",
4340 adding *logically* traversed text to the selection.
4341 * \li Notion: See also #LFUN_WORD_LEFT for exact details of the movement.
4342 * \li Syntax: word-left-select
4343 * \li Origin: dov, 28 Oct 2007
4346 { LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit },
4349 * \var lyx::FuncCode lyx::LFUN_WORD_LOWCASE
4350 * \li Action: Change the words in the selection or word at cursor position
4352 * \li Syntax: word-lowcase [<SEL_TYPE>]
4353 * \li Params: <SEL_TYPE>: if this is equal to "partial", then the
4354 * default word starts at cursor position (emacs-style).
4355 * Otherwise, the whole word is considered.
4358 { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
4361 * \var lyx::FuncCode lyx::LFUN_WORD_REPLACE
4362 * \li Action: Replace a string in the document.
4363 * \li Syntax: word-replace [<DATA>]
4364 * \li Params: <DATA>: data is of the form
4367 <casesensitive> <matchword> <all> <forward> <findnext>"
4368 * \li Origin: Andre, Jan 7 2004
4371 { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
4374 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT
4375 * \li Action: Moves the cursor to the next beginning of a word "on the right".
4376 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
4377 "right" key is pressed. Generally, it moves the cursor to the
4378 next beginning of a word on the right. However, in Bidi text
4379 this become slightly more complicated, and there are different
4380 modes of cursor movement. In "visual mode", this moves right,
4381 plain and simple. In "logical mode", movement is logically
4382 forward in LTR paragraphs, and logically backwards in RTL
4384 * \li Syntax: word-right
4385 * \li Origin: dov, 28 Oct 2007
4388 { LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit },
4391 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT_SELECT
4392 * \li Action: Moves the cursor to the next beginning of a word "on the right",
4393 adding *logically* traversed text to the selection.
4394 * \li Notion: See also #LFUN_WORD_RIGHT for exact details of the movement.
4395 * \li Syntax: word-right-select
4396 * \li Origin: dov, 28 Oct 2007
4399 { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
4402 * \var lyx::FuncCode lyx::LFUN_WORD_SELECT
4403 * \li Action: Puts the word where the cursor stands into the selection.
4404 * \li Syntax: word-select
4405 * \li Origin: Andre, 11 Sep 2002
4408 { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
4411 * \var lyx::FuncCode lyx::LFUN_WORD_UPCASE
4412 * \li Action: Change the words in the selection or word at cursor position
4414 * \li Syntax: word-upcase [<SEL_TYPE>]
4415 * \li Params: <SEL_TYPE>: if this is equal to "partial", then the
4416 * default word starts at cursor position (emacs-style).
4417 * Otherwise, the whole word is considered.
4420 { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
4423 * \var lyx::FuncCode lyx::LFUN_WRAP_INSERT
4424 * \li Action: Inserts floats wrapped by the text around.
4425 * \li Syntax: wrap-insert <TYPE>
4426 * \li Params: <TYPE>: table|figure
4427 * \li Origin: Dekel, 7 Apr 2002
4430 { LFUN_WRAP_INSERT, "wrap-insert", Noop, Edit },
4432 { LFUN_NOACTION, "", Noop, Hidden }
4433 #ifndef DOXYGEN_SHOULD_SKIP_THIS
4436 for (int i = 0; items[i].action != LFUN_NOACTION; ++i)
4437 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
4443 LyXAction::LyXAction()
4449 FuncRequest LyXAction::lookupFunc(string const & func) const
4451 string const func2 = trim(func);
4454 return FuncRequest(LFUN_NOACTION);
4457 string const arg = split(func2, cmd, ' ');
4459 FuncMap::const_iterator const fit = lyx_func_map.find(cmd);
4461 return fit != lyx_func_map.end()
4462 ? FuncRequest(fit->second, arg)
4463 : FuncRequest(LFUN_UNKNOWN_ACTION);
4467 string const LyXAction::getActionName(FuncCode action) const
4469 InfoMap::const_iterator const it = lyx_info_map.find(action);
4470 return it != lyx_info_map.end() ? it->second.name : string();
4474 LyXAction::FuncType LyXAction::getActionType(FuncCode action) const
4476 InfoMap::const_iterator const it = lyx_info_map.find(action);
4477 return it != lyx_info_map.end() ? it->second.type : Hidden;
4481 bool LyXAction::funcHasFlag(FuncCode action,
4482 LyXAction::FuncAttribs flag) const
4484 InfoMap::const_iterator ici = lyx_info_map.find(action);
4486 if (ici == lyx_info_map.end()) {
4487 LYXERR0("action: " << action << " is not known.");
4488 LASSERT(false, return false);
4491 return ici->second.attrib & flag;
4495 LyXAction::const_iterator LyXAction::func_begin() const
4497 return lyx_func_map.begin();
4501 LyXAction::const_iterator LyXAction::func_end() const
4503 return lyx_func_map.end();
4507 LyXErr & operator<<(LyXErr & l, FuncCode code)
4510 l.stream() << lyxaction.getActionName(code);