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_BOOKMARK_CLEAR
337 * \li Action: Clears the list of saved bookmarks.
338 * \li Syntax: bookmark-clear
339 * \li Origin: bpeng, 31 October 2006
342 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
346 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
347 * \li Action: Moves the cursor to the numbered bookmark, opening the file
348 if necessary. Note that bookmarks are saved per-session, not
350 * \li Notion: Bookmark 0 has a special purpose. It is automatically set \n
351 1. to the paragraph you are currently editing \n
352 2. to the paragraph from where you are jumping to the last-edited
353 position (jump-back feature) \n
354 3. when jumping from crossreference to the requested label by
356 * \li Syntax: bookmark-goto <NUMBER>
357 * \li Params: <NUMBER>: the number of the bookmark to restore.
358 * \li Origin: Dekel, 27 January 2001
361 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
364 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
365 * \li Action: Save a bookmark.
366 * \li Notion: Saves a numbered bookmark to the sessions file. The number
367 must be between 1 and 9, inclusive. Note that bookmarks are
368 saved per-session, not per file.
369 * \li Syntax: bookmark-save <NUMBER>
370 * \li Params: <NUMBER>: the number of the bookmark to save.
371 * \li Origin: Dekel, 27 January 2001
374 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
377 * \var lyx::FuncCode lyx::LFUN_BOX_INSERT
378 * \li Action: Inserts Box inset.
379 * \li Syntax: box-insert [<TYPE>]
380 * \li Params: <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox \n
381 Framed is the default one.
382 * \li Origin: vermeer, 7 Oct 2003
385 { LFUN_BOX_INSERT, "box-insert", Noop, Edit },
388 * \var lyx::FuncCode lyx::LFUN_BRANCHES_RENAME
389 * \li Action: Rename all branches of a given name in a document.
390 * \li Syntax: branches-rename <OLDNAME> <NEWNAME>
391 * \li Params: <OLDNAME>: Current name of the branch to be renamed
392 * <NEWNAME>: New name of the branch
393 * \li Origin: spitz, 9 Jul 2009
396 { LFUN_BRANCHES_RENAME, "branches-rename", Noop, Buffer },
399 * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
400 * \li Action: Activate the branch.
401 * \li Syntax: branch-activate <BRANCH>
402 * \li Params: <BRANCH>: The branch to activate
403 * \li Sample: lyx -x "branch-activate answers" -e pdf2 finalexam.lyx \n
404 could be used to export a pdf with the answers branch included
405 without one's having to open LyX and activate the branch manually.
406 * \li Origin: rgh, 27 May 2008
409 { LFUN_BRANCH_ACTIVATE, "branch-activate", AtPoint, Buffer },
412 * \var lyx::FuncCode lyx::LFUN_BRANCH_ADD
413 * \li Action: Add a branch to the buffer's BranchList.
414 * \li Syntax: branch-add <BRANCH>
415 * \li Params: <BRANCH>: Name of the branch to add
416 * \li Origin: spitz, 7 Jul 2009
419 { LFUN_BRANCH_ADD, "branch-add", AtPoint, Buffer },
424 * \var lyx::FuncCode lyx::LFUN_BRANCH_ADD_INSERT
425 * \li Action: Create new branch and directly put the branch inset into
427 * \li Syntax: branch-add-insert [<NAME>]
428 * \li Params: <NAME>: Branch name. If it is not specified, you will be asked.
429 * \li Origin: sanda, 10 Jul 2009
432 { LFUN_BRANCH_ADD_INSERT, "branch-add-insert", Noop, Buffer },
437 * \var lyx::FuncCode lyx::LFUN_BRANCH_DEACTIVATE
438 * \li Action: De-activate the branch.
439 * \li Syntax: branch-deactivate <BRANCH>
440 * \li Params: <BRANCH>: The branch to deactivate
441 * \li Origin: rgh, 27 May 2008
444 { LFUN_BRANCH_DEACTIVATE, "branch-deactivate", AtPoint, Buffer },
447 * \var lyx::FuncCode lyx::LFUN_BRANCH_INSERT
448 * \li Action: Inserts branch inset.
449 * \li Syntax: branch-insert <BRANCH-NAME>
450 * \li Origin: vermeer, 17 Aug 2003
453 { LFUN_BRANCH_INSERT, "branch-insert", Noop, Edit },
456 * \var lyx::FuncCode lyx::LFUN_BRANCH_INVERT
457 * \li Action: Toggles inversion status of branch inset.
458 * \li Syntax: branch-invert
459 * \li Origin: rgheck, 12 July 2016
462 { LFUN_BRANCH_INVERT, "branch-invert", AtPoint, Buffer },
466 * \var lyx::FuncCode lyx::LFUN_BRANCH_MASTER_ACTIVATE
467 * \li Action: Activate the branch in the master buffer.
468 * \li Syntax: branch-master-activate <BRANCH>
469 * \li Params: <BRANCH>: The branch to activate
470 * \li Sample: lyx -x "branch-activate answers" -e pdf2 finalexam.lyx \n
471 could be used to export a pdf with the answers branch included
472 without one's having to open LyX and activate the branch manually.
473 * \li Origin: spitz, 30 Sep 2012
476 { LFUN_BRANCH_MASTER_ACTIVATE, "branch-master-activate", AtPoint, Buffer },
479 * \var lyx::FuncCode lyx::LFUN_BRANCH_MASTER_DEACTIVATE
480 * \li Action: De-activate the branch in the master buffer.
481 * \li Syntax: branch-master-deactivate <BRANCH>
482 * \li Params: <BRANCH>: The branch to deactivate
483 * \li Origin: spitz, 30 Sep 2012
486 { LFUN_BRANCH_MASTER_DEACTIVATE, "branch-master-deactivate", AtPoint, Buffer },
490 * \var lyx::FuncCode lyx::LFUN_BUFFER_ANONYMIZE
491 * \li Action: For debug purposes only. Convert all [a-zA-Z0-1] characters to
492 single character. Useful when submitting docs to list or bugzilla.
493 * \li Syntax: buffer-anonymize
494 * \li Origin: sanda, Feb 1 2018
497 { LFUN_BUFFER_ANONYMIZE, "buffer-anonymize", Noop, Edit },
501 * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
502 * \li Action: Saves the current buffer to a temporary file.
503 * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
504 is called automatically by LyX, to "autosave" the current buffer.
505 * \li Syntax: buffer-auto-save
508 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
511 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN
512 * \li Action: Move the cursor to the beginning of the document.
513 * \li Syntax: buffer-begin
516 { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
519 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN_SELECT
520 * \li Action: Move the cursor to the beginning of the document adding the
521 traversed text to the selection.
522 * \li Syntax: buffer-begin-select
525 { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
528 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHILD_OPEN
529 * \li Action: Loads the given child document.
530 * \li Notion: The current document is treated as a parent.
531 * \li Syntax: buffer-child-open <FILE>
532 * \li Params: <FILE>: Filename of the child. The directory of the parent is assumed by default.
533 * \li Origin: Ale, 28 May 1997
536 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
539 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHKTEX
540 * \li Action: Runs chktex for the current document.
541 * \li Syntax: buffer-chktex
542 * \li Origin: Asger, 30 Oct 1997
545 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
548 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
549 * \li Action: Closes the current buffer.
550 * \li Notion: Closes the current buffer, asking whether to save it, etc,
551 if the buffer has been modified.
552 * \li Syntax: buffer-close
555 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
558 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE_ALL
559 * \li Action: Closes all buffers.
560 * \li Notion: Closes all buffers, asking whether to save it, etc,
561 if a buffer has been modified.
562 * \li Syntax: buffer-close-all
565 { LFUN_BUFFER_CLOSE_ALL, "buffer-close-all", ReadOnly, Buffer },
568 * \var lyx::FuncCode lyx::LFUN_BUFFER_END
569 * \li Action: Move the cursor to the end of the document.
570 * \li Syntax: buffer-end
573 { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
576 * \var lyx::FuncCode lyx::LFUN_BUFFER_END_SELECT
577 * \li Action: Move the cursor to the end of the document adding the
578 traversed text to the selection.
579 * \li Syntax: buffer-end-select
582 { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
586 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
587 * \li Action: Exports the current buffer (document) to the given format.
588 * \li Syntax: buffer-export [<FORMAT>] [<DEST>]
589 * \li Params: <FORMAT> is either "custom" or one of the formats which you
590 can find in Tools->Preferences->File formats->Format.
591 Usual format you will enter is "pdf2" (pdflatex),
592 "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
593 In case of "custom" you will be asked for a format you
594 want to start from and for the command that you want to
595 apply to this format. Internally the control is then passed
596 to #LFUN_BUFFER_EXPORT_CUSTOM.\n
597 If absent or "default", then the default output format of the
599 <DEST> If present, this argument provides the export destination
600 filename. Its containing folder will also be the destination
601 folder, where all the needed external files will be copied.
602 * \li Origin: Lgb, 29 Jul 1997
605 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
608 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_AS
609 * \li Action: Opens a dialog for exporting the current buffer.
610 * \li Syntax: buffer-export-as [<FORMAT>]
611 * \li Params: <FORMAT> is the export format initially selected in the dialog.
612 * You can pass any of the formats which you can find in
613 * Tools->Preferences->File formats->Format, provided it
614 * has the "document" flag set. If no format is specified
615 * the dialog will start with the default output format of
616 * the current document.
617 * \li Sample: buffer-export-as pdf2
618 * \li Origin: tommaso, 6 Oct 2011
621 { LFUN_BUFFER_EXPORT_AS, "buffer-export-as", ReadOnly, Buffer },
624 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
625 * \li Action: Exports the current buffer (document) from the given format using
626 the given command on it.
627 * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
628 * \li Params: <FORMAT> format to start from (LyX will care to produce such
629 intermediate file).\n
630 <COMMAND> this command will be launched on the file. Note that you can
631 use "$$FName" string to qualify the intermediate file.
632 * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
633 * \li Origin: leeming, 27 Mar 2004
636 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
639 * \var lyx::FuncCode lyx::LFUN_BUFFER_FORALL
640 * \li Action: Applies a command to all non-hidden buffers.
641 * \li Notion: a buffer is `hidden' if it is internally open in LyX, but not
642 visible in any window.
643 * \li Syntax: buffer-forall <LFUN-COMMAND>
644 * \li Params: <LFUN-COMMAND>: The command to be applied to the buffers.
645 * \li Sample: Close all Notes in buffers: \n
646 buffer-forall inset-forall Note inset-toggle close \n
647 Toggle change tracking on buffers: \n
648 buffer-forall changes-track \n
649 Toggle read-only for buffers: \n
650 buffer-forall buffer-toggle-read-only \n
651 Show statistics for individual buffers: \n
652 buffer-forall statistics \n
653 Activate the branch named "Solutions" in buffers: \n
654 buffer-forall branch-activate Solutions \n
655 Export buffers to PDF (pdflatex): \n
656 buffer-forall buffer-export pdf2 \n
657 * \li Origin: skostysh, 20 Jul 2012
660 { LFUN_BUFFER_FORALL, "buffer-forall", ReadOnly | Argument, Buffer },
663 * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
664 * \li Action: Import a given file as a lyx document.
665 * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
666 defined converters in preferences. Look in the File->Import menu to get
667 an idea of the currently active import formats.
668 * \li Syntax: buffer-import <FORMAT> [<FILE>]
669 * \li Origin: Asger, 24 Jul 1998
672 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
675 * \var lyx::FuncCode lyx::LFUN_BUFFER_LANGUAGE
676 * \li Action: Set language of the current document.
677 * \li Syntax: buffer-language <LANG>
678 * \li Params: <LANG>: language name. See lib/languages for list.
679 * \li Origin: leeming, 30 Mar 2004
682 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
685 * \var lyx::FuncCode lyx::LFUN_BUFFER_MOVE_NEXT
686 * \li Action: Moves the current tab one spot to the right.
687 * \li Syntax: buffer-move-next
688 * \li Origin: skostysh, 7 Apr 2015
691 { LFUN_BUFFER_MOVE_NEXT, "buffer-move-next", ReadOnly, Buffer },
694 * \var lyx::FuncCode lyx::LFUN_BUFFER_MOVE_PREVIOUS
695 * \li Action: Moves the current tab one spot to the left.
696 * \li Syntax: buffer-move-previous
697 * \li Origin: skostysh, 7 Apr 2015
700 { LFUN_BUFFER_MOVE_PREVIOUS, "buffer-move-previous", ReadOnly, Buffer },
703 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
704 * \li Action: Creates a new buffer (that is, document) and switches to it.
705 * \li Notion: Implicit path can be set in Preferences dialog.
706 * \li Syntax: buffer-new [<FILE>]
707 * \li Params: <FILE>: filename of created file with absolute path.
710 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
713 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
714 * \li Action: Creates a new buffer (that is, document) from a template.
715 * \li Notion: Path for new files and templates can be set in Preferences dialog.
716 Template will be asked for via Open-dialog.
717 * \li Syntax: buffer-new-template [<FILE>] [<TEMPLATE FILE>]
718 * \li Params: <FILE>: filename of created file with absolute path. If empty
719 * or "newfile", a file with appropriate name is generated.
720 * <TEMPLATE FILE>: filename of template with absolute path. If empty,
721 * a dialog is opened to select the new file.
724 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
727 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEXT
728 * \li Action: Switch to the next opened document.
729 * \li Notion: Note that this does not necessarily mean next in tabbar
730 (for full list see View menu).
731 * \li Syntax: buffer-next
734 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
737 * \var lyx::FuncCode lyx::LFUN_BUFFER_PARAMS_APPLY
738 * \li Action: Apply the given settings to the current document.
739 * \li Syntax: buffer-params-apply [<ARGS>]
740 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
741 you can find in document header of usual .lyx file.
742 * \li Origin: leeming, 30 Mar 2004
745 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", NoInternal, Buffer },
749 * \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS
750 * \li Action: Switch to the previous opened document.
751 * \li Syntax: buffer-previous
754 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
757 * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
758 * \li Action: Reverts opened document.
759 * \li Syntax: buffer-reload [dump]
760 * \li Params: dump: do not ask for any confirmation, just reload. All changes will be lost.
761 * \li Origin: Asger, 2 Feb 1997
764 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
767 * \var lyx::FuncCode lyx::LFUN_BUFFER_SAVE_AS_DEFAULT
768 * \li Action: Save the current document settings as default.
769 * \li Notion: The file will will be saved into ~/.lyx/templates/defaults.lyx .
770 * \li Syntax: buffer-save-as-default [<ARGS>]
771 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
772 you can find in document header of usual .lyx file.
773 * \li Origin: leeming, 30 Mar 2004
776 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
779 * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
780 * \li Action: Display and switch to the given buffer.
781 * \li Syntax: buffer-switch <BUFFER>
782 * \li Params: <BUFFER>: path and filename of already opened (but possibly hidden)
783 document which is to be shown.
786 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
789 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
790 * \li Action: Toggles compression of the current document on/off.
791 * \li Syntax: buffer-toggle-compression
792 * \li Origin: bpeng, 27 Apr 2006
795 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
798 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_OUTPUT_SYNC
799 * \li Action: Toggles including of resources for forward/reverse search of the given document.
800 * \li Notion: When toggled on, SyncTeX is invoked for PDF, while srcltx package
801 is used for DVI. Custom LaTeX macro can be defined in preferences.
802 * \li Syntax: buffer-toggle-output-sync
803 * \li Origin: sanda, 25 May 2010
806 { LFUN_BUFFER_TOGGLE_OUTPUT_SYNC, "buffer-toggle-output-sync", Noop, System },
809 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
810 * \li Action: Toggle editing mode of the current document between read/write and read-only.
811 * \li Notion: This function is not allowed if the file is under version control, since
812 read-only flag is often used in version control file locking.
813 * \li Syntax: buffer-toggle-read-only
814 * \li Origin: Lgb, 27 May 1997
817 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
820 * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
821 * \li Action: Exports the current document and put the result into the
823 * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
824 the output will be rewritten - updated. This is useful in case your viewer
825 is able to detect such changes (e.g. ghostview for postscript).
826 * \li Syntax: buffer-update [<FORMAT>]
827 * \li Params: <FORMAT>: The format to display, where this is one of the
828 formats defined (in the current GUI) in the
829 Tools>Preferences>File Formats dialog.
830 If no format is given, the default format as
831 specified in the same dialog is used.
832 * \li Origin: Dekel, 5 Aug 2000
835 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
839 * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
840 * \li Action: Displays current buffer in chosen format.
841 * \li Notion: Displays the contents of the current buffer in the chosen
842 format, for example, PDF or DVI. This runs the necessary
843 converter, calls the defined viewer, and so forth.
844 * \li Syntax: buffer-view [<FORMAT>]
845 * \li Params: <FORMAT>: The format to display, where this is one of the
846 formats defined (in the current GUI) in the
847 Tools>Preferences>File Formats dialog.
848 If no format is given, the default format as
849 specified in the same dialog is used.
852 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
855 * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW_CACHE
856 * \li Action: Opens the file that was created from last preview of this buffer.
857 * \li Notion: This LFUN is called by the "Show Output Anyway" button in the LaTeX
858 * Errors dialog. It can also be called by the user, which is useful
859 * if the document takes a long time to compile, and you just
860 * want to see the last previewed version.
861 * \li Syntax: buffer-view-cache
864 { LFUN_BUFFER_VIEW_CACHE, "buffer-view-cache", ReadOnly, Buffer },
867 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
868 * \li Action: Saves the current buffer.
869 * \li Notion: Saves the current buffer to disk, using the filename that
870 is already associated with the buffer, asking for one if
871 none is yet assigned.
872 * \li Syntax: buffer-write
875 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
878 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
879 * \li Action: Save all changed documents.
880 * \li Syntax: buffer-write-all
881 * \li Origin: rgh, gpothier 6 Aug 2007
884 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
887 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
888 * \li Action: Rename and save current buffer.
889 * \li Syntax: buffer-write-as <FILENAME>
890 * \li Params: <FILENAME>: New name of the buffer/file. A relative path
891 is with respect to the original location of the buffer/file.
894 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
897 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS_TEMPLATE
898 * \li Action: Rename and save current buffer in the local templates directory.
899 * \li Syntax: buffer-write-as-template <FILENAME>
900 * \li Params: <FILENAME>: New name of the buffer/file. A relative path
901 is with respect to the original location of the buffer/file.
904 { LFUN_BUFFER_WRITE_AS_TEMPLATE, "buffer-write-as-template", ReadOnly, Buffer },
908 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXTERNAL_MODIFICATION_CLEAR
909 * \li Action: Clear the external modification flag on the current buffer.
910 * \li Syntax: buffer-external-modification-clear
911 * \li Origin: gm, 2 March 2017
914 { LFUN_BUFFER_EXTERNAL_MODIFICATION_CLEAR,
915 "buffer-external-modification-clear", ReadOnly, Buffer },
918 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM
919 * \li Action: Sets the zoom of the screen fonts.
920 * \li Syntax: buffer-zoom [<ZOOM>]
921 * \li Params: <ZOOM>: The target zoom value in %;
922 * the default is the default zoom as saved in preferences.
923 * \li Origin: daniel, 28 Oct 2016
926 { LFUN_BUFFER_ZOOM, "buffer-zoom", ReadOnly, Buffer },
929 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_IN
930 * \li Action: Increases the zoom of the screen fonts.
931 * \li Syntax: buffer-zoom-in [<ZOOM>]
932 * \li Params: <ZOOM>: The zoom value addition in % (neg. or pos.);
933 * the default is 10% of the default zoom as saved in preferences.
934 * \li Origin: vfr, 30 Mar 2009
937 { LFUN_BUFFER_ZOOM_IN, "buffer-zoom-in", ReadOnly, Buffer },
941 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_OUT
942 * \li Action: Decreases the zoom of the screen fonts.
943 * \li Syntax: buffer-zoom-out [<ZOOM>]
944 * \li Params: <ZOOM>: The zoom value abstraction in % (neg. or pos.);
945 * the default is 10% of the default zoom as saved in preferences.
946 * \li Origin: vfr, 30 Mar 2009
949 { LFUN_BUFFER_ZOOM_OUT, "buffer-zoom-out", ReadOnly, Buffer },
953 * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
954 * \li Action: Generates the code (literate programming).
955 * \li Notion: Latex file with extension \literate_extension is generated.
956 Then LyX invokes \build_command (with a default of ``make'') to generate the code and
957 \build_error_filter to process the compilation error messages. \n
958 In case you want to process your literate file with a script, or some other program,
959 just insert in your lyxrc file an entry with:\n
960 \build_command "my_script my_arguments" \n
961 The \build_error_filter differs from the \literate_error_filter only in that the
962 former will identify error messages from your compiler.
963 * \li Syntax: build-program
966 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
970 * \var lyx::FuncCode lyx::LFUN_CALL
971 * \li Action: Executes a command defined in a .def file.
972 * \li Notion: The definitions are by default read from lib/commands/default.def.\n
973 A .def file allows to define a command with \define "<NAME>" "<LFUN>"
974 where <NAME> is the name of the new command and <LFUN> is the lfun code
975 to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
976 \def_file "FileName" allows to include another .def file. \n
977 This is particularly useful in connection with toolbar buttons:
978 Since the name of the button image for this lfun is
979 lib/images/commands/<NAME>.png this is the way to assign an image
980 to a complex command-sequence.
981 * \li Syntax: call <NAME>
982 * \li Params: <NAME>: Name of the command that must be called.
983 * \li Origin: broider, 2 Oct 2007
986 { LFUN_CALL, "call", NoBuffer, System },
989 * \var lyx::FuncCode lyx::LFUN_CANCEL
990 * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
994 { LFUN_CANCEL, "cancel", NoBuffer, System },
998 * \var lyx::FuncCode lyx::LFUN_CAPTION_INSERT
999 * \li Action: Inserts a caption inset.
1000 * \li Syntax: caption-insert
1001 * \li Origin: Lgb, 18 Jul 2000
1004 { LFUN_CAPTION_INSERT, "caption-insert", Noop, Edit },
1007 * \var lyx::FuncCode lyx::LFUN_CELL_BACKWARD
1008 * \li Action: Moves the cursor to the previous cell inside the table.
1009 * \li Syntax: cell-backward
1010 * \li Origin: Jug, 22 May 2000
1013 { LFUN_CELL_BACKWARD, "cell-backward", ReadOnly | NoUpdate, Edit },
1016 * \var lyx::FuncCode lyx::LFUN_CELL_FORWARD
1017 * \li Action: Moves the cursor to the next cell inside the table.
1018 * \li Syntax: cell-forward
1021 { LFUN_CELL_FORWARD, "cell-forward", ReadOnly | NoUpdate, Edit },
1024 * \var lyx::FuncCode lyx::LFUN_CELL_SPLIT
1025 * \li Action: Splits cell and shifts right part to the next cell (inside the math grid).
1026 * \li Syntax: cell-split
1027 * \li Origin: Ale, 15 May 1997
1030 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
1034 * \var lyx::FuncCode lyx::LFUN_CHANGES_MERGE
1035 * \li Action: Open change tracking dialog for merging and moves the cursor
1036 to the position of the next change.
1037 * \li Syntax: changes-merge
1038 * \li Origin: Levon, 16 Oct 2002
1041 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
1044 * \var lyx::FuncCode lyx::LFUN_CHANGES_OUTPUT
1045 * \li Action: Toggles showing of change tracking in typeset output.
1046 * \li Syntax: changes-output
1047 * \li Origin: spitz, 21 Jan 2005
1050 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
1053 * \var lyx::FuncCode lyx::LFUN_CHANGES_TRACK
1054 * \li Action: Toggles change tracking to on/off.
1055 * \li Syntax: changes-track
1056 * \li Origin: levon, 1 Oct 2002
1059 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
1062 * \var lyx::FuncCode lyx::LFUN_CHANGE_ACCEPT
1063 * \li Action: Accepts tracked change inside the selection.
1064 * \li Syntax: change-accept
1065 * \li Origin: Levon, 16 Oct 2002
1068 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
1071 * \var lyx::FuncCode lyx::LFUN_CHANGE_NEXT
1072 * \li Action: Moves the cursor to the position of the next change
1073 of the change tracking records.
1074 * \li Syntax: change-next
1075 * \li Origin: schmitt, 4 Oct 2006
1078 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
1081 * \var lyx::FuncCode lyx::LFUN_CHANGE_PREVIOUS
1082 * \li Action: Moves the cursor to the position of the previous change
1083 of the change tracking records.
1084 * \li Syntax: change-previous
1085 * \li Origin: vfr, 4 Apr 2009
1088 { LFUN_CHANGE_PREVIOUS, "change-previous", ReadOnly, Edit },
1091 * \var lyx::FuncCode lyx::LFUN_CHANGE_REJECT
1092 * \li Action: Rejects tracked change inside the selection.
1093 * \li Syntax: change-reject
1094 * \li Origin: Levon, 16 Oct 2002
1097 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
1100 * \var lyx::FuncCode lyx::LFUN_CHARS_TRANSPOSE
1101 * \li Action: Transposes the character at the cursor with the one before it.
1102 * \li Syntax: chars-transpose
1103 * \li Origin: Lgb, 25 Apr 2001
1106 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
1110 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD
1111 * \li Action: Moves the cursor one position logically backwards.
1112 * \li Notion: This is not the action which should be bound to the arrow keys,
1113 because backwards may be left or right, depending on the
1114 language. The arrow keys should be bound to #LFUN_CHAR_LEFT or
1115 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
1116 * \li Syntax: char-backward
1119 { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit },
1122 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD_SELECT
1123 * \li Action: Moves the cursor one position logically backwards, adding
1124 traversed position to the selection.
1125 * \li Notion: See also #LFUN_CHAR_BACKWARD.
1126 * \li Syntax: char-backward-select
1129 { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit },
1132 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_BACKWARD
1133 * \li Action: Deletes one character in the backward direction (usually the "BackSpace" key).
1134 * \li Syntax: char-delete-backward [force]
1135 * \li Params: force: Delete big insets, do not only select them.
1138 { LFUN_CHAR_DELETE_BACKWARD, "char-delete-backward", SingleParUpdate, Edit },
1141 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_FORWARD
1142 * \li Action: Deletes one character in the backward direction (usually the "Delete" key).
1143 * \li Syntax: char-delete-forward [force]
1144 * \li Params: force: Delete big insets, do not only select them.
1147 { LFUN_CHAR_DELETE_FORWARD, "char-delete-forward", SingleParUpdate, Edit },
1150 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD
1151 * \li Action: Moves the cursor one position logically forward.
1152 * \li Notion: This is not the action which should be bound to the arrow keys,
1153 because forward may be left or right, depending on the language.
1154 The arrow keys should be bound to #LFUN_CHAR_LEFT or
1155 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
1156 * \li Syntax: char-forward
1159 { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit },
1162 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD_SELECT
1163 * \li Action: Moves the cursor one position logically forward, adding
1164 traversed position to the selection.
1165 * \li Notion: See also #LFUN_CHAR_FORWARD.
1166 * \li Syntax: char-forward-select
1169 { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit },
1172 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT
1173 * \li Action: Moves the cursor one position "to the left".
1174 * \li Notion: This is the action which should be taken when the "left" key
1175 is pressed. Generally, it moves the cursor one position to the
1176 left. However, in Bidi text this become slightly more
1177 complicated, and there are different modes of cursor movement.
1178 In "visual mode", this moves left, plain and simple. In "logical
1179 mode", movement is logically forward in RTL paragraphs, and
1180 logically backwards in LTR paragraphs.
1181 * \li Syntax: char-left
1184 { LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit },
1187 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT_SELECT
1188 * \li Action: Moves the cursor one position "to the left", adding
1189 traversed position to the selection.
1190 * \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement.
1191 * \li Syntax: char-left-select
1194 { LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit },
1197 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT
1198 * \li Action: Moves the cursor one position "to the right".
1199 * \li Notion: This is the action which should be taken when the "right" key
1200 is pressed. Generally, it moves the cursor one position to the
1201 right. However, in Bidi text this become slightly more
1202 complicated, and there are different modes of cursor movement.
1203 In "visual mode", this moves right, plain and simple. In "logical
1204 mode", movement is logically forward in LTR paragraphs, and
1205 logically backwards in RTL paragraphs.
1206 * \li Syntax: char-right
1209 { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit },
1212 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT_SELECT
1213 * \li Action: Moves the cursor one position "to the right", adding
1214 traversed position to the selection.
1215 * \li Notion: See also #LFUN_CHAR_RIGHT for exact details of the movement.
1216 * \li Syntax: char-right-select
1219 { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit },
1223 * \var lyx::FuncCode lyx::LFUN_CITATION_INSERT
1224 * \li Action: Inserts citation from loaded citation database.
1225 * \li Syntax: citation-insert [<KEY>[|<TEXT_BEFORE>]]
1226 * \li Params: <KEY>: Citation (shortcut listed in available citations). \n
1227 <TEXT_BEFORE>: text which should appear before citation.
1228 * \li Origin: AAS, 97-02-23
1231 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
1234 * \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE
1235 * \li Action: Pastes text from the active clipboard (retains formatting if the
1236 clipboard contains formatted text). Pastes plain text if plain text is
1237 on the clipboard, but tries to interpret it in special ways for certain
1238 insets, e.g. converting csv data to rows and columns if the paste happens
1240 * \li Notion: Historically, LFUN_CLIPBOARD_PASTE was introduced as a counterpart of
1241 LFUN_PRIMARY_SELECTION_PASTE: It behaved exactly the same, but the source
1242 is the clipboard, not the selection.
1243 * \li Syntax: clipboard-paste [<ARG>]
1244 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1245 * \li Origin: Georg, 10 Jul 2006
1248 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
1251 * \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE_SIMPLE
1252 * \li Action: Pastes plain text from the active clipboard even if formatted
1253 LyX content is in the clipboard. Pastes plain text if plain text
1254 is on the clipboard, without trying to interpret it in special
1255 ways for certain insets, e.g. converting csv data to rows and
1256 columns if the paste happens in a tabular inset.
1257 * \li Syntax: clipboard-paste-simple [<ARG>]
1258 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1261 { LFUN_CLIPBOARD_PASTE_SIMPLE, "clipboard-paste-simple", Noop, Edit },
1264 * \var lyx::FuncCode lyx::LFUN_COMMAND_ALTERNATIVES
1265 * \li Action: Runs the first listed command that is enabled.
1266 * \li Notion: This can be used to bind multiple functions to a single key,
1267 and then which one is used will depend upon the context.
1268 * \li Syntax: command-alternatives <CMDS>
1269 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
1270 * \li Sample: command-alternatives completion-accept;cell-forward
1271 * \li Origin: rgh, 24 September 2008
1274 { LFUN_COMMAND_ALTERNATIVES, "command-alternatives", NoBuffer, System },
1277 * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
1278 * \li Action: Switches the focus to the minibuffer so that the user can type
1279 in there. If necessary, it opens the minibuffer toolbar.
1280 * \li Notion: Usually bound to M-x shortcut.
1281 * \li Syntax: command-execute
1284 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
1288 * \var lyx::FuncCode lyx::LFUN_COMMAND_PREFIX
1289 * \li Action: Return the current key sequence and available options as a string.
1290 * \li Notion: No options are added if no current map exists. \n
1291 This is probably usable only with connection to lyxserver.
1292 * \li Syntax: command-prefix
1295 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
1298 * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
1299 * \li Action: Run more commands (LFUN and its parameters) in a sequence.
1300 * \li Syntax: command-sequence <CMDS>
1301 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
1302 * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
1303 * \li Origin: Andre, 11 Nov 1999
1306 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
1309 * \var lyx::FuncCode lyx::LFUN_COMPLETE
1310 * \li Action: Try to complete the word or command at the cursor position.
1311 * \li Syntax: complete
1312 * \li Origin: sts, Feb 19 2008
1315 { LFUN_COMPLETE, "complete", SingleParUpdate, Edit },
1319 * \var lyx::FuncCode lyx::LFUN_COMPLETION_ACCEPT
1320 * \li Action: Accept suggested completion.
1321 * \li Syntax: completion-accept
1322 * \li Origin: sanda, Sep 08 2008
1325 { LFUN_COMPLETION_ACCEPT, "completion-accept", SingleParUpdate, Edit },
1330 * \var lyx::FuncCode lyx::LFUN_COMPLETION_CANCEL
1331 * \li Action: Try to cancel completion, either the popup or the inline completion.
1332 * \li Syntax: completion-cancel
1333 * \li Origin: sts, Sep 07 2008
1336 { LFUN_COMPLETION_CANCEL, "completion-cancel", SingleParUpdate, Edit },
1339 * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
1340 * \li Action: Show the inline completion at the cursor position.
1341 * \li Syntax: completion-inline
1342 * \li Origin: sts, Feb 19 2008
1345 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
1348 * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
1349 * \li Action: Show the completion popup at the cursor position.
1350 * \li Syntax: completion-popup
1351 * \li Origin: sts, Feb 19 2008
1354 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
1357 * \var lyx::FuncCode lyx::LFUN_COPY
1358 * \li Action: Copies the current selection to the clipboard.
1362 { LFUN_COPY, "copy", ReadOnly, Edit },
1365 * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
1366 * \li Action: Determine whether to keep cursor inside the editing window regardless
1367 of the scrollbar movement.
1368 * \li Syntax: toggle-cursor-follows-scrollbar
1369 * \li Origin: ARRae, 2 Dec 1997
1372 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
1375 * \var lyx::FuncCode lyx::LFUN_CUT
1376 * \li Action: Cuts to the clipboard.
1380 { LFUN_CUT, "cut", Noop, Edit },
1383 * \var lyx::FuncCode lyx::LFUN_DEBUG_LEVEL_SET
1384 * \li Action: Set debug output level.
1385 * \li Syntax: debug-level-set <LEVEL>
1386 * \li Params: <LEVEL>: comma separated list of levels or the correspondent number
1387 of their combination. 0 is equivalent to disabling all debug
1388 events. See lyx -dbg for the current list of debug levels
1390 * \li Origin: sanda, 28 Dec 2009
1393 { LFUN_DEBUG_LEVEL_SET, "debug-level-set", NoBuffer, System },
1397 * \var lyx::FuncCode lyx::LFUN_DEPTH_DECREMENT
1398 * \li Action: Decrease the nesting depth of the (selected) paragraph(s)
1400 * \li Syntax: depth-decrement
1403 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
1406 * \var lyx::FuncCode lyx::LFUN_DEPTH_INCREMENT
1407 * \li Action: Increase the nesting depth of the (selected) paragraph(s)
1409 * \li Syntax: depth-increment
1412 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
1416 * \var lyx::FuncCode lyx::LFUN_DEVEL_MODE_TOGGLE
1417 * \li Action: toggle a mode where more information is given in UI
1418 * \li Syntax: devel-mode-toggle
1419 * \li Notion: in so called "devel" mode, the information given in the
1420 * status bar is more precise, and the help documents are
1421 * open in editing mode.
1422 * \li Origin: lasgouttes, 23 Jul 2017
1425 { LFUN_DEVEL_MODE_TOGGLE, "devel-mode-toggle", NoBuffer, System },
1429 * \var lyx::FuncCode lyx::LFUN_DIALOG_DISCONNECT_INSET
1430 * \li Action: Closes opened connection to opened inset.
1431 * \li Notion: Connection is used for apply functions.
1432 * \li Syntax: dialog-disconnect-inset <INSET-NAME>
1433 * \li Origin: leeming, 25 Feb 2003
1436 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
1440 * \var lyx::FuncCode lyx::LFUN_DIALOG_HIDE
1441 * \li Action: Hides showed dialog. Counterpart to #LFUN_DIALOG_SHOW .
1442 * \li Syntax: dialog-hide <NAME>
1443 * \li Params: See #LFUN_DIALOG_SHOW .
1444 * \li Origin: leeming, 25 Feb 2003
1447 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
1450 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW
1451 * \li Action: Shows hidden dialog or creates new one for a given function/inset settings etc.
1452 * \li Syntax: dialog-show <NAME> [<DATA>]
1453 * \li Params: <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|\n
1454 compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|\n
1455 graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimiter|\n
1456 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|\n
1457 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|\n
1458 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL> \n
1459 <SPECIAL>: latexlog|vclog \n
1460 <DATA>: data, usually settings for the given dialog. Use debug mode for the
1462 * \li Origin: leeming, 17 Jun 2003
1465 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
1468 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW_NEW_INSET
1469 * \li Action: Shows hidden dialog or create new one for a given inset settings etc.
1470 * \li Notion: Internally uses #LFUN_DIALOG_SHOW with processed data for a given inset.
1471 * \li Syntax: dialog-show-new-inset <NAME> [<DATA>]
1472 * \li Params: See #LFUN_DIALOG_SHOW .
1473 * \li Origin: leeming, 25 Feb 2003
1476 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
1479 * \var lyx::FuncCode lyx::LFUN_DIALOG_TOGGLE
1480 * \li Action: Toggles dialog between showed/hidden state.
1481 * \li Notion: Internally uses #LFUN_DIALOG_SHOW , #LFUN_DIALOG_HIDE .
1482 * \li Syntax: dialog-toggle <NAME> [<DATA>]
1483 * \li Params: See #LFUN_DIALOG_SHOW .
1484 * \li Origin: spitz, 30 Apr 2007
1487 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
1490 * \var lyx::FuncCode lyx::LFUN_DIALOG_UPDATE
1491 * \li Action: Updates the dialog values from the inset/paragraph/document.
1492 * \li Syntax: dialog-update <NAME>
1493 * \li Params: <NAME>: paragraph|prefs|<INSET> \n
1495 * \li Origin: leeming, 25 Feb 2003
1498 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
1501 * \var lyx::FuncCode lyx::LFUN_DOWN
1502 * \li Action: Moves the cursor one line in downward direction.
1506 { LFUN_DOWN, "down", ReadOnly | NoUpdate, Edit },
1509 * \var lyx::FuncCode lyx::LFUN_DOWN_SELECT
1510 * \li Action: Moves the cursor one line in downward direction adding the current
1511 position to the selection.
1512 * \li Syntax: down-select
1515 { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, Edit },
1518 * \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE
1519 * \li Action: Displays list of layout choices.
1520 * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
1521 dropbox allowing for choice of layout.
1522 * \li Syntax: drop-layouts-choice
1525 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
1528 * \var lyx::FuncCode lyx::LFUN_ENVIRONMENT_SPLIT
1529 * \li Action: Splits the current environment with a Separator.
1530 * \li Syntax: environment-split [before|outer|previous]
1531 * \li Params: outer: If this is given, LyX will split the outermost environment in
1532 the current nesting hierarchy.\n
1533 previous: If this is given, LyX will split the environment in the previous
1534 paragraph (if there is one).\n
1535 before: If this is given, the new environment will be appended rather than
1537 * \li Origin: spitz, 23 Dec 2012
1540 { LFUN_ENVIRONMENT_SPLIT, "environment-split", Noop, Layout },
1544 * \var lyx::FuncCode lyx::LFUN_ERT_INSERT
1545 * \li Action: Inserts an ERT inset.
1546 * \li Syntax: ert-insert
1547 * \li Origin: Jug, 18 Feb 2000
1550 { LFUN_ERT_INSERT, "ert-insert", Noop, Edit },
1553 * \var lyx::FuncCode lyx::LFUN_ESCAPE
1554 * \li Action: Clears the selection. If no text is selected call #LFUN_FINISHED_FORWARD.
1555 Inside math mode jumps out of the math inset.
1556 * \li Syntax: escape
1557 * \li Origin: Lgb, 17 May 2001
1560 { LFUN_ESCAPE, "escape", ReadOnly, Edit },
1563 * \var lyx::FuncCode lyx::LFUN_EXPORT_CANCEL
1564 * \li Action: Cancel background export process.
1565 * \li Syntax: export-cancel
1566 * \li Origin: rgh, 10 December 2017
1569 { LFUN_EXPORT_CANCEL, "export-cancel", ReadOnly | NoUpdate | NoInternal, Edit },
1572 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
1573 * \li Action: Inserts another LyX file.
1574 * \li Syntax: file-insert [<FILE>] [ignorelang]
1575 * \li Params: <FILE>: Filename to be inserted.
1576 * ignorelang: If given, the (main) language of the inserted file
1577 * is ignored (the context language is used).
1580 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
1583 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
1584 * \li Action: Inserts plain text file.
1585 * \li Syntax: file-insert-plaintext [<FILE>]
1586 * \li Params: <FILE>: Filename to be inserted.
1587 * \li Origin: CFO-G, 19 Nov 1997
1590 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
1593 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
1594 * \li Action: Inserts plain text file as paragraph (i.e. join lines).
1595 * \li Syntax: file-insert-plaintext-para [<FILE>]
1596 * \li Params: <FILE>: Filename to be inserted.
1597 * \li Origin: Levon, 14 Feb 2001
1600 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
1603 * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
1604 * \li Action: Open LyX document.
1605 * \li Syntax: file-open [<FILE>]
1606 * \li Params: <FILE>: Filename to be opened.
1609 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
1613 * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
1614 * \li Action: Moves the cursor out of the current slice, going backwards.
1615 * \li Notion: See also #LFUN_FINISHED_FORWARD.
1618 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
1621 * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
1622 * \li Action: Moves the cursor out of the current slice, going forward.
1623 * \li Notion: Cursor movement within an inset may be different than cursor
1624 movement in the surrounding text. This action should be called
1625 automatically by the cursor movement within the inset, when
1626 movement within the inset has ceased (reached the end of the
1627 last paragraph, for example), in order to move correctly
1628 back into the surrounding text.
1631 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
1634 * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
1635 * \li Action: Moves the cursor out of the current slice, going left.
1636 * \li Notion: See also #LFUN_FINISHED_FORWARD.
1639 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
1643 * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
1644 * \li Action: Moves the cursor out of the current slice, going right.
1645 * \li Notion: See also #LFUN_FINISHED_FORWARD
1648 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
1651 * \var lyx::FuncCode lyx::LFUN_FLEX_INSERT
1652 * \li Action: Inserts CharStyle, Custom inset or XML short element.
1653 * \li Notion: Look into the Customization manual for more information about
1655 To make this command enabled the layout file for the document
1656 class you're using has to load the character styles. There are
1657 a few contained in the Logical Markup module. You can also of
1658 course create some yourself. \n
1659 For dissolving the element see #LFUN_INSET_DISSOLVE.
1660 * \li Syntax: flex-insert Name
1661 * \li Params: Name: This name must be defined either in your layout file
1662 or imported by some module. The definition is
1663 InsetLayout Name or InsetLayout <Flex:Name>. The Flex:
1665 * \li Sample: flex-insert Code
1668 { LFUN_FLEX_INSERT, "flex-insert", Noop, Edit },
1671 * \var lyx::FuncCode lyx::LFUN_FLOAT_INSERT
1672 * \li Action: Inserts a float inset.
1673 * \li Syntax: float-insert <TYPE>
1674 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
1675 "algorithm", "table", "figure" parameters can be given.
1676 * \li Origin: Lgb, 27 Jun 2000
1679 { LFUN_FLOAT_INSERT, "float-insert", Noop, Edit },
1682 * \var lyx::FuncCode lyx::LFUN_FLOAT_LIST_INSERT
1683 * \li Action: Inserts the list of floats in the document.
1684 * \li Syntax: float-list-insert <TYPE>
1685 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
1686 "algorithm", "table", "figure" parameters can be given.
1687 * \li Origin: Lgb, 3 May 2001
1690 { LFUN_FLOAT_LIST_INSERT, "float-list-insert", Noop, Edit },
1693 * \var lyx::FuncCode lyx::LFUN_FLOAT_WIDE_INSERT
1694 * \li Action: Inserts float insets as in #LFUN_FLOAT_INSERT but span multiple columns.
1695 * \li Notion: Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
1696 * \li Syntax: float-wide-insert <TYPE>
1697 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
1698 "algorithm", "table", "figure" parameters can be given.
1699 * \li Origin: Lgb, 31 Oct 2001
1702 { LFUN_FLOAT_WIDE_INSERT, "float-wide-insert", Noop, Edit },
1705 * \var lyx::FuncCode lyx::LFUN_FONT_BOLD
1706 * \li Action: Toggles the bold font (selection-wise) using mathbf in math.
1707 * \li Syntax: font-bold
1710 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
1714 * \var lyx::FuncCode lyx::LFUN_FONT_BOLDSYMBOL
1715 * \li Action: Toggles the bold font (selection-wise) using boldsymbol in math.
1716 * \li Syntax: font-boldsymbol
1719 { LFUN_FONT_BOLDSYMBOL, "font-boldsymbol", Noop, Layout },
1722 * \var lyx::FuncCode lyx::LFUN_FONT_DEFAULT
1723 * \li Action: Reverts the settings of the font to the default values (selection-wise).
1724 * \li Syntax: font-default
1727 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
1730 * \var lyx::FuncCode lyx::LFUN_FONT_EMPH
1731 * \li Action: Toggles the emphasis font style (selection-wise).
1732 * \li Syntax: font-emph
1735 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
1738 * \var lyx::FuncCode lyx::LFUN_FONT_FRAK
1739 * \li Action: Toggles Fraktur family font (math-mode, selection-wise).
1740 * \li Syntax: font-frak
1741 * \li Origin: vermeer, 10 Jan 2002
1744 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
1747 * \var lyx::FuncCode lyx::LFUN_FONT_ITAL
1748 * \li Action: Toggles Italics font shape (math-mode, selection-wise).
1749 * \li Syntax: font-ital
1750 * \li Origin: vermeer, 10 Jan 2002
1753 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
1756 * \var lyx::FuncCode lyx::LFUN_FONT_NOUN
1757 * \li Action: Toggles Noun text style font (selection-wise).
1758 * \li Syntax: font-noun
1761 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
1764 * \var lyx::FuncCode lyx::LFUN_FONT_ROMAN
1765 * \li Action: Toggles Roman family font (selection-wise).
1766 * \li Syntax: font-roman
1769 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
1772 * \var lyx::FuncCode lyx::LFUN_FONT_SANS
1773 * \li Action: Toggles Sans Serif family font (selection-wise).
1774 * \li Syntax: font-sans
1777 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
1780 * \var lyx::FuncCode lyx::LFUN_FONT_SIZE
1781 * \li Action: Sets font size according to lyx format string.
1782 * \li Syntax: font-size <SIZE>
1783 * \li Params: <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|\n
1784 largest|huge|giant|increase|decrease|default
1787 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
1790 * \var lyx::FuncCode lyx::LFUN_FONT_STATE
1791 * \li Action: Returns the info about the current font.
1792 * \li Syntax: font-state
1795 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
1799 * \var lyx::FuncCode lyx::LFUN_FONT_STRIKEOUT
1800 * \li Action: Toggles strikeout (strike-through) in the font (selection-wise).
1801 * \li Syntax: font-strikeout
1802 * \li Origin: sanda, 3 May 2009
1805 { LFUN_FONT_STRIKEOUT, "font-strikeout", Noop, Layout },
1808 * \var lyx::FuncCode lyx::LFUN_FONT_CROSSOUT
1809 * \li Action: Toggles xout (cross-through) in the font (selection-wise).
1810 * \li Syntax: font-crossout
1811 * \li Origin: uwestoehr, 4 April 2017
1814 { LFUN_FONT_CROSSOUT, "font-crossout", Noop, Layout },
1817 * \var lyx::FuncCode lyx::LFUN_FONT_TYPEWRITER
1818 * \li Action: Toggles the typewriter family font (selection-wise).
1819 * \li Syntax: font-typewriter
1822 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
1825 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERLINE
1826 * \li Action: Toggles underline in the font (selection-wise).
1827 * \li Syntax: font-underline
1830 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
1833 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERUNDERLINE
1834 * \li Action: Toggles double underline in the font (selection-wise).
1835 * \li Syntax: font-underunderline
1836 * \li Origin: sanda, 5 May 2009
1839 { LFUN_FONT_UNDERUNDERLINE, "font-underunderline", Noop, Layout },
1842 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERWAVE
1843 * \li Action: Toggles wavy underline in the font (selection-wise).
1844 * \li Syntax: font-underwave
1845 * \li Origin: sanda, 5 May 2009
1848 { LFUN_FONT_UNDERWAVE, "font-underwave", Noop, Layout },
1851 * \var lyx::FuncCode lyx::LFUN_FOOTNOTE_INSERT
1852 * \li Action: Inserts a footnote inset.
1853 * \li Syntax: footnote-insert
1854 * \li Origin: Jug, 7 Mar 2000
1857 { LFUN_FOOTNOTE_INSERT, "footnote-insert", Noop, Edit },
1860 * \var lyx::FuncCode lyx::LFUN_FORWARD_SEARCH
1861 * \li Action: Sets the cursor position in the previewed (dvi/pdf) file based on the row
1862 number in LyX window.
1863 * \li Notion: The external program used for forward search call can be specified in
1864 LyX Output preferences. See Additional manual for details of these
1866 * \li Syntax: forward-search
1867 * \li Origin: sanda, 14 Apr 2010
1870 { LFUN_FORWARD_SEARCH, "forward-search", ReadOnly, System },
1873 * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
1874 * \li Action: Open the given help file according to the language setting.
1875 * \li Syntax: help-open <FILE>[.lyx]
1876 * \li Params: <FILE>: any document from (/usr/share/)doc directory.
1877 * \li Origin: Jug, 27 Jun 1999
1880 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
1883 * \var lyx::FuncCode lyx::LFUN_HREF_INSERT
1884 * \li Action: Inserts hyperlinks into the document (clickable in pdf output).
1885 * \li Notion: Hyperlink target can be set via selection + hyperlink-insert function.
1886 * \li Syntax: href-insert [<TARGET>]
1887 * \li Origin: CFO-G, 21 Nov 1997
1890 { LFUN_HREF_INSERT, "href-insert", Noop, Edit },
1893 * \var lyx::FuncCode lyx::LFUN_ICON_SIZE
1894 * \li Action: Sets icon size of toolbars.
1895 * \li Syntax: icon-size [<SIZE>]
1896 * \li Params: <SIZE> : the icon size in px or one of the logical settings
1897 small|normal|big|huge|giant, the default is normal
1898 (whose size in px is icon set dependent).
1899 * \li Origin: 11 July 2016
1902 { LFUN_ICON_SIZE, "icon-size", NoBuffer, Buffer },
1905 * \var lyx::FuncCode lyx::LFUN_INDEX_INSERT
1906 * \li Action: Inserts Index entry.
1907 * \li Notion: It automatically takes the word on the cursor position.
1908 * \li Syntax: index-insert [<TYPE:Name>]
1909 * \li Params: <TYPE:Name>: name of the index, if multiple indices are defined.
1910 With an empty argument, the default index is selected.
1911 * \li Origin: leeming, 3 Aug 2000
1914 { LFUN_INDEX_INSERT, "index-insert", Noop, Edit },
1917 * \var lyx::FuncCode lyx::LFUN_INDEX_PRINT
1918 * \li Action: Inserts list of Index entries on a new page.
1919 * \li Syntax: index-print [<TYPE:Name>]
1920 * \li Params: <TYPE:Name>: name of the index, if multiple indices are defined.
1921 With an empty argument, the default index is selected.
1922 * \li Origin: Lgb, 27 Feb 1997
1925 { LFUN_INDEX_PRINT, "index-print", Noop, Edit },
1928 * \var lyx::FuncCode lyx::LFUN_INFO_INSERT
1929 * \li Action: Displays shortcuts, lyxrc, package and textclass availability and menu
1930 information in a non-editable boxed InsetText.
1931 * \li Notion: Apart from lfun arguments you can use the following method: \n
1932 1. input the type and argument of this inset, e.g. "menu paste", in
1934 2. select the text and run info-insert lfun.
1935 * \li Syntax: info-insert <TYPE> <ARG>
1936 * \li Params: <TYPE>: date|moddate|fixdate|time|modtime|fixtime|shortcut|shortcuts|lyxrc|
1937 * lyxinfo|package|textclass|menu|l7n|icon|buffer|vcs \n
1938 <ARG>: argument for a given type. Look into InsetInfo.h for detailed
1940 date: current date (formatted and localized)\n
1941 moddate: date of last modification (saving) (formatted and localized)\n
1942 fixdate: a static date (formatted and localized)\n
1943 time: current time (formatted and localized)\n
1944 modtime: time of last modification (saving) (formatted and localized)\n
1945 fixtime: a static time (formatted and localized)\n
1946 shortcut[s]: name of lfun (e.g math-insert \alpha) \n
1947 lyxrc: name of rc_entry (e.g. bind_file) \n
1948 lyxinfo: "version" - used version of LyX \n
1949 package: name of latex package (e.g. listings) \n
1950 textclass: name of textclass (e.g. article) \n
1951 menu: name of lfun used in menu \n
1952 l7n: localizable string.\n
1953 icon: icon of lfun used in toolbar or direct icon name\n
1954 buffer: "name"|"name-noext"|"path"|"class"
1955 vcs: "tree-revision"|"revision"|"author"|"date"|"time"
1956 * \li Sample: command-sequence info-insert buffer path; info-insert buffer name
1957 * \li Origin: bpeng, 7 Oct 2007
1960 { LFUN_INFO_INSERT, "info-insert", Noop, Edit },
1963 * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
1964 * \li Action: Apply data for an inset.
1965 * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
1966 be applied. This is either changed to #LFUN_INSET_MODIFY or
1967 #LFUN_INSET_INSERT depending on the context where it is called.
1968 * \li Syntax: inset-apply <ARGS>
1969 * \li Params: See #LFUN_INSET_INSERT .
1972 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
1975 * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN
1976 * \li Action: Move the cursor to the beginning of the current inset
1977 if it is not already there. If the cursor is already at
1978 the beginning of the current inset, move it to the
1979 beginning of the enclosing inset or the main work area,
1980 respectively, if there is no enclosing inset.
1981 * \li Syntax: inset-begin
1982 * \li Origin: lasgouttes, 16 Mar 2009
1985 { LFUN_INSET_BEGIN, "inset-begin", ReadOnly, Edit },
1988 * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN_SELECT
1989 * \li Action: Move the cursor to the beginning of the current inset
1990 if it is not already there. If the cursor is already at
1991 the beginning of the current inset, move it to the
1992 beginning of the enclosing inset or the main work area,
1993 respectively, if there is no enclosing inset (adding the
1994 traversed text to the selection).
1995 * \li Syntax: inset-begin-select
1996 * \li Origin: lasgouttes, 16 Mar 2009
1999 { LFUN_INSET_BEGIN_SELECT, "inset-begin-select", ReadOnly, Edit },
2002 * \var lyx::FuncCode lyx::LFUN_INSET_COPY_AS
2003 * \li Action: Copies the inset to the clipboard as a certain type.
2004 * \li Notion: Currently used only for InsetInfo where its content is copied as a text.
2005 * \li Syntax: inset-copy-as
2006 * \li Origin: vfr, 18 Apr 2010
2009 { LFUN_INSET_COPY_AS, "inset-copy-as", ReadOnly | NoUpdate | AtPoint, Edit },
2013 * \var lyx::FuncCode lyx::LFUN_INSET_DIALOG_UPDATE
2014 * \li Action: Updates the values inside the dialog from the inset.
2015 * \li Notion: This is an internal LFUN, not to be used by users. Called internally
2016 by #LFUN_DIALOG_UPDATE
2017 * \li Params: <DIALOG-NAME>
2018 * \li Origin: leeming, 25 Feb 2003
2021 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
2024 * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE
2025 * \li Action: Dissolve the current inset into text.
2026 * \li Syntax: inset-dissolve [<INSET>]
2027 * \li Params: <INSET>: this can be used to make sure the right kind of inset
2028 is dissolved. For example "dissolve" entry in the charstyles
2029 sub-menu should only dissolve the charstyle inset, even if the
2030 cursor is inside several nested insets of different type.\n
2031 For values see #lyx::InsetLayout::lyxtype_ .
2032 * \li Origin: JSpitz, 7 Aug 2006
2035 { LFUN_INSET_DISSOLVE, "inset-dissolve", AtPoint, Edit },
2038 * \var lyx::FuncCode lyx::LFUN_INSET_EDIT
2039 * \li Action: Edit the inset at cursor with an external application,
2040 if one is attributed.
2041 If the inset is file based, the referenced file is edited.
2042 Otherwise, the inset contents is written to a temporary file,
2043 the inset is locked, and the temporary file is edited.
2044 In this case, #LFUN_INSET_END_EDIT must be called to overtake
2045 the changes and unlock the inset after editing is finished.
2046 * \li Syntax: inset-edit [<INSET_PARAMS>]
2047 * \li Params: <INSET_PARAMS>: Parameters for the inset. \n
2048 Currently only the filename will be considered.
2049 * \li Origin: spitz, 27 Apr 2006
2052 { LFUN_INSET_EDIT, "inset-edit", ReadOnly | AtPoint, Edit },
2056 * \var lyx::FuncCode lyx::LFUN_INSET_END_EDIT
2057 * \li Action: End editing the inset at cursor with an external application.
2058 * This replaces the inset contents with the contents of the
2059 * temporary file, deletes the file and unlocks the inset.
2060 * \li Syntax: inset-end-edit
2061 * \li Origin: gb, 11 Oct 2015
2064 { LFUN_INSET_END_EDIT, "inset-end-edit", ReadOnly | AtPoint, Edit },
2067 * \var lyx::FuncCode lyx::LFUN_INSET_END
2068 * \li Action: Move the cursor to the end of the current inset if it
2069 is not already there. If the cursor is already at the
2070 end of the current inset, move it to the end of the
2071 enclosing inset or the main work area, respectively, if
2072 there is no enclosing inset.
2073 * \li Syntax: inset-end
2074 * \li Origin: lasgouttes, 16 Mar 2009
2077 { LFUN_INSET_END, "inset-end", ReadOnly, Edit },
2080 * \var lyx::FuncCode lyx::LFUN_INSET_END_SELECT
2081 * \li Action: Move the cursor to the end of the current inset if it
2082 is not already there. If the cursor is already at the
2083 end of the current inset, move it to the end of the
2084 enclosing inset or the main work area, respectively, if
2085 there is no enclosing inset (adding the
2086 traversed text to the selection).
2087 * \li Syntax: inset-end-select
2088 * \li Origin: lasgouttes, 16 Mar 2009
2091 { LFUN_INSET_END_SELECT, "inset-end-select", ReadOnly, Edit },
2095 * \var lyx::FuncCode lyx::LFUN_INSET_FORALL
2096 * \li Action: Apply the given commands on insets of a given name.
2097 * \li Notion: WARNING: use at your own risks; this function gives
2098 you too many ways of shooting yourself in the foot.
2099 A typical example is
2100 inset-forall Note note-insert
2101 which starts an infinite loop. This is mitigated by the fact
2102 that the number of actions is arbitrarily limited to 100000.
2103 Note also that inset-forall does not update metrics between
2104 iterations, which can lead to bugs. This has to be eventually
2106 * \li Syntax: inset-forall <NAME> <LFUN-COMMAND> \n
2107 <NAME>: Type of Inset. If <NAME> is *, all insets are matched.
2108 The name is used like for InsetLayout in layout files: "Note"
2109 matches all note insets, while "Note:Note" only matches LyX
2111 * \li Sample: Remove all index insets: \n
2112 inset-forall Index char-delete-forward force \n
2113 Close all Notes (also works for a particular branch, for example): \n
2114 inset-forall Note inset-toggle close \n
2115 Transform all yellow notes to comments \n
2116 inset-forall Note:Note inset-modify note Note Comment \n
2117 Try to put LyX in an infinite loop if there is at least a Note: \n
2118 inset-forall Note char-backward
2119 * \li Origin: lasgouttes, 27 Nov 2009
2122 { LFUN_INSET_FORALL, "inset-forall", ReadOnly, Edit },
2126 * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
2127 * \li Action: Insert new inset (type given by the parameters).
2128 * \li Syntax: inset-insert <INSET> <ARGS>
2129 * \li Params: <INSET>: <bibitem|bibtex|citation|ert|listings|external|graphics|tabular|\n
2130 hyperlink|include|index|label|line|nomencl|vspace|ref|toc|script>\n
2131 <ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
2132 * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
2133 where <label name> is the name of the referenced label and
2134 <Format> is one of the following: \n
2135 ref -- <reference> \n
2136 eqref -- (<reference>) \n
2137 pageref -- <page> \n
2138 vpageref -- on <page> \n
2139 vref -- <reference> on <page> \n
2140 formatted -- Formatted reference
2143 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
2146 * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
2147 * \li Action: Modify some properties of an inset.
2148 * \li Notion: Used for argument, bibitem, bibtex, box, branch, caption, citation,
2149 command, ert, external, float, graphics, include, index,
2150 info, label, line, listings, newline, newpage, nomencl,
2151 note, phantom, quotes, ref, script, separator, space,
2152 tabular, vspace and wrap insets.
2153 * \li Syntax: inset-modify <INSET> <ARGS> \n
2154 inset-modify changetype <TYPE>
2155 * \li Sample: Change a Note inset into a Comment inset: \n
2156 inset-modify note Note Comment \n
2157 Change a Box into an Ovalbox: \n
2158 inset-modify changetype Ovalbox \n
2159 Change a quotation mark to e[nglish style], l[eft side = opening], s[ingle = inner, secondary] \n
2160 inset-modify changetype els \n
2161 Change only the style of a quotation mark, maintaining the other aspects (. = wildcard) \n
2162 inset-modify changetype e.. \n
2165 { LFUN_INSET_MODIFY, "inset-modify", AtPoint, Edit },
2168 * \var lyx::FuncCode lyx::LFUN_INSET_SELECT_ALL
2169 * \li Action: Select all contents of an inset.
2170 * \li Notion: There are 3 successive levels: select current cell,
2171 * select all cells of inset, select the inset from outside
2172 * (in the enclosing inset).
2173 * \li Syntax: inset-select-all
2174 * \li Origin: vfr, 22 Aug 2009; lasgouttes 1 Nov 2014
2177 { LFUN_INSET_SELECT_ALL, "inset-select-all", ReadOnly, Edit },
2181 * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
2182 * \li Action: Open the inset's properties dialog.
2183 * \li Notion: Used for bibitem, bibtex, box, branch, citation, ert, external,
2184 float, graphics, href, include, index, index_print, label, line,
2185 listings, note, phantom, ref, space, tabular, vspace, wrap insets.
2186 * \li Syntax: inset-settings <INSET>
2187 * \li Params: <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|\n
2188 graphics|href|include|index|index_print|label|line|\n
2189 listings|note|phantom|ref|space|tabular|vspace|wrap>.
2192 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly | AtPoint, Edit },
2195 * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
2196 * \li Action: Toggles the collapsible inset at cursor position,
2197 or the inset we are currently in.
2198 * \li Syntax: inset-toggle [<ARG>]
2199 * \li Params: <ARG>: <open|close|toggle|assign>. \n
2200 open/close/toggle are for collapsible insets. toggle is used when no argument is given.\n
2201 assign synchronize the branch-inset with activation status of the branch.
2202 Used for global toggling when changed activation.
2203 * \li Origin: lasgouttes, 19 Jul 2001
2206 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly | AtPoint, Edit },
2209 * \var lyx::FuncCode lyx::LFUN_IN_IPA
2210 * \li Action: Only active in IPA inset.
2211 * \li Notion: Dummy function which is only active in a IPA inset.
2212 It's used to toggle the IPA toolbar if the cursor moves
2214 * \li Syntax: in-ipa
2215 * \li Origin: spitz, 20 May 2012
2218 { LFUN_IN_IPA, "in-ipa", Noop, Edit },
2221 * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
2222 * \li Action: Only active in Math Macro definition.
2223 * \li Notion: Dummy function which is only active in a Math Macro definition.
2224 It's used to toggle the Math Macro toolbar if the cursor moves
2225 into a Math Macro definition.
2226 * \li Syntax: in-mathmacrotemplate
2227 * \li Origin: sts, 06 January 2008
2230 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
2234 * \var lyx::FuncCode lyx::LFUN_IPAMACRO_INSERT
2235 * \li Action: Inserts special IPA macros into the document.
2236 * \li Syntax: ipamacro-insert <CHAR>
2237 * \li Params: <CHAR>: tone-falling, tone-rising, tone-high-rising, tone-low-rising,
2238 * tone-high-rising-falling, deco bottomtiebar, deco toptiebar.
2239 * \li Origin: spitz, 22 Aug 2012
2242 { LFUN_IPAMACRO_INSERT, "ipamacro-insert", Noop, Edit },
2245 * \var lyx::FuncCode lyx::LFUN_IPA_INSERT
2246 * \li Action: Inserts an IPA inset.
2247 * \li Syntax: ipa-insert
2248 * \li Origin: spitz, 05 Mar 2012
2251 { LFUN_IPA_INSERT, "ipa-insert", Noop, Edit },
2254 * \var lyx::FuncCode lyx::LFUN_KEYMAP_OFF
2255 * \li Action: Turn off the loaded keyboard map.
2256 * \li Syntax: keymap-off
2259 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
2262 * \var lyx::FuncCode lyx::LFUN_KEYMAP_PRIMARY
2263 * \li Action: Turn on the primary keyboard map.
2264 * \li Notion: Maps were widely used in past, when X-windows didn't have nowadays
2265 keyboard support. They can be still used to maintain uniform keyboard
2266 layout across the various platforms.\n
2267 The language is to be set in the Preferences dialog.
2268 * \li Syntax: keymap-primary
2271 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
2274 * \var lyx::FuncCode lyx::LFUN_KEYMAP_SECONDARY
2275 * \li Action: Turn on the secondary keyboard map.
2276 * \li Syntax: keymap-secondary
2279 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
2282 * \var lyx::FuncCode lyx::LFUN_KEYMAP_TOGGLE
2283 * \li Action: Toggles keyboard maps (first/second/off).
2284 * \li Syntax: keymap-toggle
2285 * \li Origin: leeming, 30 Mar 2004
2288 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
2292 * \var lyx::FuncCode lyx::LFUN_LABEL_COPY_AS_REFERENCE
2293 * \li Action: Copies the label at the cursor as a cross-reference to be pasted elsewhere.
2294 * \li Syntax: copy-label-as-reference <LABEL>
2295 * \li Params: <LABEL>: The label to copy (for multi-line math)
2296 * \li Origin: sts, 16 Nov 2008
2299 { LFUN_LABEL_COPY_AS_REFERENCE, "label-copy-as-reference",
2300 ReadOnly | NoUpdate | AtPoint, Edit },
2304 * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
2305 * \li Action: Goto a label.
2306 * \li Syntax: label-goto [<LABEL>]
2307 * \li Params: <LABEL>: Requested label. If no label is given and reference
2308 is on cursor position, Bookmark 0 is saved and
2309 cursor moves to the position of referenced label.
2310 * \li Origin: Ale, 6 Aug 1997
2313 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
2316 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT
2317 * \li Action: Inserts label to text or displayed formula.
2318 * \li Syntax: label-insert [<LABEL>]
2319 * \li Params: <LABEL>: Requested label. If no label is given dialog requesting
2320 name will be opened.
2323 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
2326 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT_AS_REFERENCE
2327 * \li Action: Inserts the label (in ToC pane) as a cross-reference at the position of the cursor.
2328 * \li Syntax: label-insert-as-reference
2329 * \li Origin: vfr, 7 Apr 2009
2332 { LFUN_LABEL_INSERT_AS_REFERENCE, "label-insert-as-reference", Noop, Edit},
2336 * \var lyx::FuncCode lyx::LFUN_LANGUAGE
2337 * \li Action: Set language from the current cursor position.
2338 * \li Syntax: language <LANG> [set]
2339 * \li Params: <LANG>: Requested language. Look in lib/languages for
2340 the list. "language reset" or "language" (without param)
2341 reset to the document language.
2342 set: If used, the language will be set to the specified
2343 language. Otherwise, the language will be toggled (i.e., if
2344 the current language is LANG, switch to the document language
2345 or the default language, if LANG is the document language).
2346 * \li Origin: Dekel, 2 Mar 2000
2349 { LFUN_LANGUAGE, "language", Noop, Edit },
2353 * \var lyx::FuncCode lyx::LFUN_LAYOUT
2354 * \li Action: Sets the layout (that is, environment) for the current paragraph.
2355 * \li Syntax: layout <LAYOUT> [ignorenests]
2356 * \li Params: <LAYOUT>: the layout to use\n
2357 ignorenests: If specified, nesting advices will be ignored.
2360 { LFUN_LAYOUT, "layout", Noop, Layout },
2363 * \var lyx::FuncCode lyx::LFUN_LAYOUT_TOGGLE
2364 * \li Action: Toggles the layout (that is, environment) for the current paragraph.
2365 * \li Notion: Contrary to `layout', this function resets the current
2366 * (or selection) layout to the standard layout it already has the
2367 * correct layout. Useful for toolbar icons.
2368 * \li Syntax: layout-toggle <LAYOUT> [ignorenests]
2369 * \li Params: <LAYOUT>: the layout to toggle\n
2370 ignorenests: If specified, nesting advices will be ignored.
2371 * \li Origin: lasgouttes, 14 May 2018
2374 { LFUN_LAYOUT_TOGGLE, "layout-toggle", Noop, Layout },
2377 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
2378 * \li Action: Clears the module list.
2379 * \li Notion: Clears the list of included modules for the current buffer.
2380 * \li Syntax: layout-modules-clear
2381 * \li Origin: rgh, 25 August 2007
2384 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", NoInternal, Layout },
2387 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULE_ADD
2388 * \li Action: Adds a module.
2389 * \li Notion: Adds a module to the list of included modules for the current buffer.
2390 * \li Syntax: layout-module-add <MODULE>
2391 * \li Params: <MODULE>: the module to be added
2392 * \li Origin: rgh, 25 August 2007
2395 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", NoInternal, Layout },
2398 * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH
2399 * \li Action: Launches the paragraph settings dialog.
2400 * \li Syntax: layout-paragraph
2403 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
2406 * \var lyx::FuncCode lyx::LFUN_LAYOUT_RELOAD
2407 * \li Action: Reloads layout information.
2408 * \li Notion: Reloads all layout information for the current buffer from disk, thus
2409 recognizing any changes that have been made to layout files on the fly.
2410 This is intended to be used only by layout developers and should not be
2411 used when one is trying to do actual work.
2412 * \li Syntax: layout-reload
2413 * \li Origin: rgh, 3 September 2007
2416 { LFUN_LAYOUT_RELOAD, "layout-reload", NoInternal, Layout },
2419 * \var lyx::FuncCode lyx::LFUN_LAYOUT_TABULAR
2420 * \li Action: Launches the tabular settings dialog.
2421 * \li Syntax: layout-tabular
2422 * \li Origin: Jug, 31 Jul 2000
2425 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
2428 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN
2429 * \li Action: Move the cursor to the beginning of the (screen) line.
2430 * \li Syntax: line-begin
2433 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
2436 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN_SELECT
2437 * \li Action: Move the cursor to the beginning of the (screen) line adding the
2438 traversed text to the selection.
2439 * \li Syntax: line-begin-select
2442 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
2445 * \var lyx::FuncCode lyx::LFUN_LINE_DELETE_FORWARD
2446 * \li Action: Deletes the letters to the end of the (screen) line or
2447 deletes the selection.
2448 * \li Syntax: line-delete-forward
2451 { LFUN_LINE_DELETE_FORWARD, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
2454 * \var lyx::FuncCode lyx::LFUN_LINE_END
2455 * \li Action: Move the cursor to the end of the (screen) line.
2456 * \li Syntax: line-end
2459 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
2462 * \var lyx::FuncCode lyx::LFUN_LINE_END_SELECT
2463 * \li Action: Move the cursor to the end of the (screen) line adding the
2464 traversed text to the selection.
2465 * \li Syntax: line-end-select
2468 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
2471 * \var lyx::FuncCode lyx::LFUN_LISTING_INSERT
2472 * \li Action: Inserts a new listings inset.
2473 * \li Syntax: listing-insert
2474 * \li Origin: Herbert, 10 Nov 2001; bpeng, 2 May 2007
2477 { LFUN_LISTING_INSERT, "listing-insert", Noop, Edit },
2480 * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
2481 * \li Action: Apply the given settings to user preferences.
2482 * \li Syntax: lyxrc-apply <SETTINGS>
2483 * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
2484 to get an idea which commands to use and their syntax.
2485 #lyx::LyXRC::LyXRCTags has the list of possible commands.
2488 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
2491 * \var lyx::FuncCode lyx::LFUN_LYX_ACTIVATE
2492 * \li Action: Activates the LyX window.
2493 * \li Notion: On Linux and Mac OS, this action brings the LyX window
2494 into focus. Such behavior is not allowed by Windows OS
2495 so instead the color of the taskbar entry is changed to
2496 indicate that the window has changed in some way.
2497 This action is useful in combination with reverse search.
2498 * \li Syntax: lyx-activate
2499 * \li Origin: skostysh, 4 Aug 2016
2502 { LFUN_LYX_ACTIVATE, "lyx-activate", ReadOnly | NoBuffer, Hidden },
2505 * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
2506 * \li Action: Terminates the current LyX instance.
2507 * \li Notion: Terminates the current LyX instance, asking whether to save
2508 modified documents, etc.
2509 * \li Syntax: lyx-quit
2512 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
2515 * \var lyx::FuncCode lyx::LFUN_MARGINALNOTE_INSERT
2516 * \li Action: Inserts a marginal note.
2517 * \li Syntax: marginalnote-insert
2518 * \li Origin: Lgb, 26 Jun 2000
2521 { LFUN_MARGINALNOTE_INSERT, "marginalnote-insert", Noop, Edit },
2524 * \var lyx::FuncCode lyx::LFUN_MARK_OFF
2525 * \li Action: Disable selecting of text-region.
2526 * \li Syntax: mark-off
2529 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
2532 * \var lyx::FuncCode lyx::LFUN_MARK_ON
2533 * \li Action: Enable selecting of text-region.
2534 * \li Notion: After enabling you can simply move arrow keys to get selected region.
2535 * \li Syntax: mark-on
2538 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
2541 * \var lyx::FuncCode lyx::LFUN_MARK_TOGGLE
2542 * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
2543 * \li Syntax: mark-toggle
2544 * \li Origin: Andre, May 5 2006
2547 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
2551 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_EXPORT
2552 * \li Action: Exports the master buffer (document) to the given format.
2553 * \li Syntax: master-buffer-export [<FORMAT>] [<DEST>]
2554 * \li Params: <FORMAT> is one of the formats which you can find in
2555 Tools->Preferences->File formats->Format.
2556 Usual format you will enter is "pdf2" (pdflatex),
2557 "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
2558 Note that "custom" is not allowed in this case.\n
2559 If absent or "default", then the default output format of the
2561 <DEST> If present, this argument provides the export destination
2562 filename. Its containing folder will also be the destination
2563 folder, where all the needed external files will be copied.
2564 * \li Origin: rkh, 18 April 2018
2567 { LFUN_MASTER_BUFFER_EXPORT, "master-buffer-export", ReadOnly, Buffer },
2570 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
2571 * \li Action: Update (export) the document built from the master buffer,
2572 if the current buffer is part of a master/child document.
2573 * \li Syntax: master-buffer-update [<FORMAT>]
2574 * \li Params: <FORMAT>: The format to display, where this is one of the
2575 formats defined (in the current GUI) in the
2576 Tools>Preferences>File Formats dialog.
2577 If no format is given, the default format as
2578 specified in the same dialog is used.
2579 * \li Origin: Tommaso, 20 Sep 2007
2582 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
2585 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
2586 * \li Action: Show a preview built from the master buffer, if available.
2587 if the current buffer is part of a master/child document.
2588 * \li Syntax: master-buffer-view [<FORMAT>]
2589 * \li Params: <FORMAT>: The format to display, where this is one of the
2590 formats defined (in the current GUI) in the
2591 Tools>Preferences>File Formats dialog.
2592 If no format is given, the default format as
2593 specified in the same dialog is used.
2594 * \li Origin: Tommaso, 20 Sep 2007
2597 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
2600 * \var lyx::FuncCode lyx::LFUN_MATH_AMS_MATRIX
2601 * \li Action: Inserts an extended matrix as provided by the amsmath package.
2602 * \li Syntax: math-matrix <COLS> <ROWS> [<DECORATION>]
2603 * \li Params: <DECORATION>: Decoration determines the LaTeX name of the matrix
2604 that should be created. Possible values include
2605 pmatrix, bmatrix, Bmatrix, vmatrix, Vmatrix and
2606 matrix. The default is 'matrix'.
2607 * \li Sample: math-ams-matrix 3 3 bmatrix
2610 { LFUN_MATH_AMS_MATRIX, "math-ams-matrix", Noop, Math },
2613 * \var lyx::FuncCode lyx::LFUN_MATH_BIGDELIM
2614 * \li Action: Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
2615 * \li Syntax: math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
2616 * \li Params: <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r \n
2617 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
2618 * \li Sample: math-bigdelim "Bigl" "\Downarrow" "Bigr" "\}"
2619 * \li Origin: Enrico & Georg, 7 May 2006
2622 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
2625 * \var lyx::FuncCode lyx::LFUN_MATH_DELIM
2626 * \li Action: Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
2627 * \li Syntax: math-delim [<LEFT>] [<RIGHT>]
2628 * \li Params: <LEFT/RIGHT>: Delimiters to be used. Each delimiter can be specified by
2629 either a LaTeX name or a valid character.
2630 ( is the default letter.
2631 * \li Sample: math-delim { rangle
2632 * \li Origin: Alejandro, 18 Jun 1996
2635 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
2638 * \var lyx::FuncCode lyx::LFUN_MATH_DISPLAY
2639 * \li Action: Creates a new displayed equation in text mode.
2640 Toggles inlined/display formula in math mode.
2641 * \li Syntax: math-display [<ARG>]
2642 * \li Params: <ARG>: this argument will be passed to #LFUN_MATH_INSERT when creating
2643 new equation from the text mode.
2644 * \li Origin: Alejandro, 18 Jun 1996
2647 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
2650 * \var lyx::FuncCode lyx::LFUN_MATH_EXTERN
2651 * \li Action: Calls external program and passes the current expression/equation
2652 as an argument for the calculation in the format appropriate to the
2654 * \li Notion: Selection can be used to determine the input for the external program.
2655 * \li Syntax: math-extern <LANG> [<COMMAND>]
2656 * \li Params: <LANG>: octave|maxima|maple|mathematica|script \n
2657 where "script" stands for the external script (normalized
2658 expression will be passed)
2659 * \li Origin: Andre, 24 Apr 2001
2660 * \li Sample: math-extern maple simplify
2663 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
2666 * \var lyx::FuncCode lyx::LFUN_MATH_FONT_STYLE
2667 * \li Action: Changes the text style used in math.
2668 * \li Syntax: math-font-style <STYLE>
2669 * \li Params: <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf|textnormal\n
2670 |textrm|textsf|texttt|textbf|textmd|textit|textsc|textsl|textup
2671 * \li Origin: vfr, 9 jan 2009
2674 { LFUN_MATH_FONT_STYLE, "math-font-style", Noop, Math },
2677 * \var lyx::FuncCode lyx::LFUN_MATH_INSERT
2678 * \li Action: Inserts math objects and symbols.
2679 * \li Syntax: math-insert <ARG>
2680 * \li Params: <ARG>: Symbol or LaTeX code to be inserted.
2681 * \li Notion: When <ARG> is a _single_ math inset with more than one cell
2682 (such as "x_y^z" or "\frac{x}{y}"), the content of cell(0) is
2683 replaced by the current selection (only works if the selection
2684 is in mathed). As an example, if "abc" is selected in mathed,
2685 "math-insert \frac{x}{y}" replaces "abc" with "\frac{abc}{y}",
2686 and "math-insert x_y^z" replaces "abc" with "abc_y^z".
2687 If nothing is selected (or the selection is not in mathed),
2688 math-insert works as expected.
2691 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
2694 * \var lyx::FuncCode lyx::LFUN_MATH_LIMITS
2695 * \li Action: Toggles the position of the limits from above/below to the right
2696 side an vice versa in integral symbol, a limit, a summation, etc.
2697 * \li Notion: Put the cursor before the symbol with the limits and then invoke
2699 * \li Syntax: math-limits [<STATE>]
2700 * \li Params: <STATE>: limits|nolimits
2703 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
2706 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO
2707 * \li Action: Inserts a math macro definition at the cursor position in the text.
2708 * \li Syntax: math-macro <NAME> [<NARGS>] [def]
2709 * \li Params: <NAME>: The name of the macro, e.g. "mymacro".\n
2710 <NARGS>: The number of parameters of the macro. Default is 0.
2711 "def": Has no effect anymore, just for compatibility with former LyX versions.
2712 * \li Origin: ale, 10 May 1997; sts, 21 Dec 2007
2715 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
2718 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
2719 * \li Action: Add a greedy optional parameter.
2720 * \li Notion: Add a greedy optional parameter which eats the value
2721 from the following cells in mathed which are in the [value]
2723 * \li Syntax: math-macro-add-greedy-optional-param
2724 * \li Origin: sts, 06 January 2008
2727 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
2730 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
2731 * \li Action: Add an optional parameter.
2732 * \li Notion: Insert an optional parameter just behind the
2733 already existing optional parameters.
2734 * \li Syntax: math-macro-add-optional-param
2735 * \li Origin: sts, 06 January 2008
2738 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
2741 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
2742 * \li Action: Add a parameter.
2743 * \li Notion: Add a parameter to a Math Macro.
2744 * \li Params: <NUM>: The number of the parameter behind which the new one
2745 will be added (1 for the first, i.e. use 0 for add a
2746 parameter at the left), defaults to the last one.
2747 * \li Syntax: math-macro-add-param <NUM>
2748 * \li Origin: sts, 06 January 2008
2751 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
2754 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
2755 * \li Action: Append a greedy parameter.
2756 * \li Notion: Append a greedy parameter to a Math Macro which
2757 eats the following mathed cell in every instance of
2758 the macro in the buffer.
2759 * \li Syntax: math-macro-append-greedy-param
2760 * \li Origin: sts, 06 January 2008
2763 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
2766 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
2767 * \li Action: Fold a Math Macro.
2768 * \li Notion: Fold the Math Macro the cursor is in if it was
2769 unfolded, i.e. displayed as \foo before.
2770 * \li Syntax: math-macro-fold
2771 * \li Origin: sts, 06 January 2008
2774 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
2777 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
2778 * \li Action: Make a parameter non-optional.
2779 * \li Notion: Turn the last optional parameter of a Math Macro
2780 into a non-optional parameter. The default value is
2781 remembered to be reused later if the user changes his mind.
2782 * \li Syntax: math-macro-make-nonoptional
2783 * \li Origin: sts, 06 January 2008
2786 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
2789 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
2790 * \li Action: Make a parameter optional.
2791 * \li Notion: Turn the first non-optional parameter of a Math Macro
2792 into an optional parameter with a default value.
2793 * \li Syntax: math-macro-make-optional
2794 * \li Origin: sts, 06 January 2008
2797 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
2800 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
2801 * \li Action: Remove a greedy parameter.
2802 * \li Notion: Remove a greedy parameter of a Math Macro and spit
2803 out the values of it in every instance of the macro
2804 in the buffer. If it is an optional parameter the [valud]
2806 * \li Syntax: math-macro-remove-greedy-param
2807 * \li Origin: sts, 06 January 2008
2810 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
2813 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
2814 * \li Action: Remove the last optional parameter.
2815 * \li Notion: Remove the last optional parameter of a Math Macro and
2816 remove it in all the instances of the macro in the buffer.
2817 * \li Syntax: math-macro-remove-optional-param
2818 * \li Origin: sts, 06 January 2008
2821 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
2824 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
2825 * \li Action: Remove the last parameter.
2826 * \li Notion: Remove the last parameter of a Math Macro and
2827 remove its value in all instances of the macro
2829 * \li Params: <NUM>: The number of the parameter to be deleted (1 for
2830 the first), defaults to the last one.
2831 * \li Syntax: math-macro-remove-param <NUM>
2832 * \li Origin: sts, 06 January 2008
2835 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
2838 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
2839 * \li Action: Unfold a Math Macro.
2840 * \li Notion: Unfold the Math Macro the cursor is in, i.e.
2842 * \li Syntax: math-macro-unfold
2843 * \li Origin: sts, 06 January 2008
2846 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
2849 * \var lyx::FuncCode lyx::LFUN_MATH_MATRIX
2850 * \li Action: Inserts a matrix.
2851 * \li Syntax: math-matrix <COLS> <ROWS> [<ALIGN>]
2852 * \li Params: <ALIGN>: Alignment is a word composed of the vertical alignment
2853 (b, c or t) (i.e. 1 char) and the horizontal alignments
2854 (l, c or r) (i.e. <COL> chars).
2855 * \li Sample: math-matrix 3 3 bccc
2858 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
2861 * \var lyx::FuncCode lyx::LFUN_MATH_MODE
2862 * \li Action: In text mode enters math mode (i.e. puts math insets on the current
2863 cursor position), in math mode enters text mode inside math expression.
2864 * \li Notion: If there is some selected text, it puts the text inside created math box.
2865 * \li Syntax: math-mode [on|<ARG>]
2866 * \li Params: <ARG>: eventual argument (LaTeX code) is passed to #LFUN_MATH_INSERT .\n
2867 "on": allow only entering of math mode from text mode.
2868 * \li Origin: Alejandro, 4 Jun 1996
2871 { LFUN_MATH_MODE, "math-mode", Noop, Math },
2874 * \var lyx::FuncCode lyx::LFUN_MATH_MUTATE
2875 * \li Action: Mutates the type of math inset to the newly selected one.
2876 * \li Syntax: math-mutate <TYPE>
2877 * \li Params: <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
2878 multline|gather|flalign
2879 * \li Origin: Andre, 23 May 2001
2882 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
2885 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
2886 * \li Action: Toggles numbering of the current formula line.
2887 * \li Notion: Must be in display formula mode.
2888 * \li Syntax: math-number-line-toggle
2889 * \li Origin: Alejandro, 18 Jun 1996
2892 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
2895 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
2896 * \li Action: Toggles numbering/labeling of the current formula.
2897 * \li Notion: Must be in display formula mode.
2898 * \li Syntax: math-number-toggle
2899 * \li Origin: Alejandro, 4 Jun 1996
2902 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
2905 * \var lyx::FuncCode lyx::LFUN_MATH_SIZE
2906 * \li Action: Changes arbitrarily the size used by math fonts inside a context.
2907 * \li Notion: Provides an interface to the LaTeX math mode font size commands.
2908 * \li Syntax: math-size <STYLE>
2909 * \li Params: <STYLE>: \displaystyle|\textstyle|\scriptstyle|\scriptscriptstyle
2910 * \li Origin: Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
2913 { LFUN_MATH_SIZE, "math-size", Noop, Math },
2916 * \var lyx::FuncCode lyx::LFUN_MATH_SPACE
2917 * \li Action: Inserts space into math expression.
2918 * \li Notion: Use spacebar after entering this space to change type of space.
2919 * \li Syntax: math-space [<TYPE>] [<LEN>]
2920 * \li Params: <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace \n
2921 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad \n
2922 custom space: hspace \n
2923 "," used by default.\n
2924 Note that ! is equivalent to negthinspace, , = thinspace,
2925 : = medspace, and ; = thickspace.\n
2926 <LEN>: length for custom spaces (hspace)
2927 * \li Origin: Andre, 25 Jul 2001; sanda, 16 Jun 2008
2930 { LFUN_MATH_SPACE, "math-space", Noop, Math },
2933 * \var lyx::FuncCode lyx::LFUN_MATH_SUBSCRIPT
2934 * \li Action: Enters subscript expression in math expression.
2935 * \li Syntax: math-subscript
2936 * \li Origin: vermeer, 12 Dec 2001
2939 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
2942 * \var lyx::FuncCode lyx::LFUN_MATH_SUPERSCRIPT
2943 * \li Action: Enters superscript expression in math expression.
2944 * \li Syntax: math-superscript
2945 * \li Origin: vermeer, 12 Dec 2001
2948 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
2951 * \var lyx::FuncCode lyx::LFUN_MENU_OPEN
2952 * \li Action: Opens the menu given by its name.
2953 * \li Syntax: menu-open <NAME>
2954 * \li Params: <NAME>: menu name. See various .inc files in lib/ui for candidates.
2957 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
2960 * \var lyx::FuncCode lyx::LFUN_MESSAGE
2961 * \li Action: Shows message in statusbar (for script purposes).
2962 * \li Syntax: message <STRING>
2963 * \li Origin: Lgb, 8 Apr 2001
2966 { LFUN_MESSAGE, "message", NoBuffer, System },
2969 * \var lyx::FuncCode lyx::LFUN_META_PREFIX
2970 * \li Action: Simulate halting Meta key (Alt key on PCs).
2971 * \li Notion: Used for buffer edition not for GUI control.
2972 * \li Syntax: meta-prefix
2975 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
2978 * \var lyx::FuncCode lyx::LFUN_MOUSE_DOUBLE
2979 * \li Action: This function is called when double click on mouse button is
2980 pressed (inside workarea). Action depends on the context.
2981 * \li Notion: This is an internal LFUN, not to be used by users.
2982 * \li Origin: Andre, 9 Aug 2002
2985 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
2988 * \var lyx::FuncCode lyx::LFUN_MOUSE_MOTION
2989 * \li Action: This function is called when mouse cursor is moving over the text.
2990 Action depends on the context.
2991 * \li Notion: This is an internal LFUN, not to be used by users.
2992 * \li Origin: Andre, 9 Aug 2002
2995 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
2998 * \var lyx::FuncCode lyx::LFUN_MOUSE_PRESS
2999 * \li Action: This function is called when mouse button is pressed (inside workarea).
3000 Action depends on the context.
3001 * \li Notion: This is an internal LFUN, not to be used by users.
3002 * \li Origin: Andre, 9 Aug 2002
3005 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
3008 * \var lyx::FuncCode lyx::LFUN_MOUSE_RELEASE
3009 * \li Action: This function is called when mouse button is released (inside workarea).
3010 Action depends on the context.
3011 * \li Notion: This is an internal LFUN, not to be used by users.
3012 * \li Origin: Andre, 9 Aug 2002
3015 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
3019 * \var lyx::FuncCode lyx::LFUN_MOUSE_TRIPLE
3020 * \li Action: This function is called when triple click on mouse button is
3021 pressed (inside workarea). Action depends on the context.
3022 * \li Notion: This is an internal LFUN, not to be used by users.
3023 * \li Origin: Andre, 9 Aug 2002
3026 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
3029 * \var lyx::FuncCode lyx::LFUN_NEWLINE_INSERT
3030 * \li Action: Inserts a line break or new line.
3031 * \li Syntax: newline-insert [<ARG>]
3032 * \li Params: <ARG>: <newline|linebreak> default: newline
3033 * \li Origin: spitz, 25 Mar 2008
3036 { LFUN_NEWLINE_INSERT, "newline-insert", Noop, Edit },
3039 * \var lyx::FuncCode lyx::LFUN_NEWPAGE_INSERT
3040 * \li Action: Inserts a new page.
3041 * \li Syntax: newpage-insert <ARG>
3042 * \li Params: <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
3043 * \li Origin: uwestoehr, 24 Nov 2007
3046 { LFUN_NEWPAGE_INSERT, "newpage-insert", Noop, Edit },
3049 * \var lyx::FuncCode lyx::LFUN_NOMENCL_INSERT
3050 * \li Action: Inserts Nomenclature entry.
3051 * \li Notion: It automatically takes the word on the cursor position if no symbol is given.
3052 * \li Syntax: nomencl-insert [<SYMBOL>]
3053 * \li Origin: Ugras, 4 Nov 2006
3056 { LFUN_NOMENCL_INSERT, "nomencl-insert", Noop, Edit },
3059 * \var lyx::FuncCode lyx::LFUN_NOMENCLATURE_PRINT
3060 * \li Action: Inserts list of Nomenclature entries.
3061 * \li Syntax: nomenclature-print
3062 * \li Origin: Ugras, 4 Nov 2006
3065 { LFUN_NOMENCL_PRINT, "nomencl-print", Noop, Edit },
3069 * \var lyx::FuncCode lyx::LFUN_NOTE_INSERT
3070 * \li Action: Inserts Note on the current cursor position,
3071 move selection inside the inset.
3072 * \li Syntax: note-insert [<TYPE>]
3073 * \li Params: <TYPE>: <Note|Greyedout|Comment> default: Note
3076 { LFUN_NOTE_INSERT, "note-insert", Noop, Edit },
3079 * \var lyx::FuncCode lyx::LFUN_NOTE_NEXT
3080 * \li Action: Moves the cursor to the beginning of next Note inset.
3081 * \li Syntax: note-next
3084 { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
3087 * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
3088 * \li Action: Move the current group in the downward direction in the
3089 structure of the document.
3090 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
3091 the whole substructure of the group.
3092 * \li Syntax: outline-down
3093 * \li Origin: Vermeer, 23 Mar 2006
3096 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
3099 * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
3100 * \li Action: Moves the current group in the downward direction in the
3101 hierarchy of the document structure.
3102 * \li Notion: Part -> Chapter -> Section -> etc.
3103 * \li Syntax: outline-in
3104 * \li Origin: Vermeer, 23 Mar 2006
3107 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
3110 * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
3111 * \li Action: Moves the current group in the upward direction in the
3112 hierarchy of the document structure.
3113 * \li Notion: Part <- Chapter <- Section <- etc.
3114 * \li Syntax: outline-out
3115 * \li Origin: Vermeer, 23 Mar 2006
3118 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
3122 * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
3123 * \li Action: Move the current group in the upward direction in the
3124 structure of the document.
3125 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
3126 the whole substructure of the group.
3127 * \li Syntax: outline-up
3128 * \li Origin: Vermeer, 23 Mar 2006
3131 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
3134 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_BREAK
3135 * \li Action: Breaks the current paragraph at the current location.
3136 * \li Notion: Removes the selection.
3137 * \li Syntax: paragraph-break [<LAYOUT>] [ignoresep]
3138 * \li Params: <LAYOUT>: "inverse" - decreases depth by one (or change layout
3139 to default layout) when the cursor is at the end of
3141 ignoresep: Do not account for paragraph separators while breaking.
3144 { LFUN_PARAGRAPH_BREAK, "paragraph-break", Noop, Edit },
3147 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN
3148 * \li Action: Move the cursor to the next paragraph (or beginning of the current one)
3149 in downward direction.
3150 * \li Syntax: paragraph-down
3151 * \li Origin: Asger, 1 Oct 1996
3154 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
3157 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN_SELECT
3158 * \li Action: Move the cursor and select the text to the next paragraph (or
3159 beginning of the current one) in downward direction.
3160 * \li Syntax: paragraph-down-select
3161 * \li Origin: Asger, 1 Oct 1996
3164 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
3167 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
3168 * \li Action: Jump to a paragraph given by its id number and optionally the
3169 desired position within the paragraph.
3170 If given four arguments id_start, pos_start, id_end, pos_end,
3171 perform a selection from start to end.
3172 * \li Notion: Note that id number of paragraph is not the sequential number of
3173 paragraph seen on the screen. Moreover the id is unique for all
3174 opened buffers (documents). Both ids must belong to the same
3176 * \li Syntax: paragraph-goto <PAR_ID> <POS_IN_PAR> [<PAR_ID> <POS_IN_PAR>]
3177 * \li Params: <PAR_ID>: paragraph id \n
3178 <POS_IN_PAR>: desired position within the paragraph
3179 * \li Origin: Dekel, 26 Aug 2000
3183 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly | NoInternal, Edit },
3186 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
3187 * \li Action: Moves the current paragraph downwards in the document.
3188 * \li Syntax: paragraph-move-down
3189 * \li Origin: Edwin, 8 Apr 2006
3192 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
3195 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
3196 * \li Action: Moves the current paragraph upwards in the document.
3197 * \li Notion: Movement through the document will possibly break the paragraph-depth
3198 (e.g. itemize structure).
3199 * \li Syntax: paragraph-move-up
3200 * \li Origin: Edwin, 8 Apr 2006
3203 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
3207 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
3208 * \li Action: Change paragraph settings.
3209 * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
3210 This function only modifies, and does not override, existing settings.
3211 Note that the "leftindent" indent setting is deprecated.
3212 * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
3213 * \li Params: <INDENT>: \noindent|\indent|\indent-toggle|\leftindent LENGTH\n
3214 <SPACING>: \paragraph_spacing default|single|onehalf|double|other SIZE \n
3215 <ALIGN>: \align block|left|right|center|default\n
3216 <OTHERS>: \labelwidthstring WIDTH|\start_of_appendix
3217 * \li Origin: rgh, Aug 15 2007
3220 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
3223 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
3224 * \li Action: Change paragraph settings.
3225 * \li Notion: Overwrite all nonspecified settings to the default ones.
3226 Use paragraph-params lfun if you don't want to overwrite others settings.
3227 * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
3228 * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
3229 * \li Origin: leeming, 30 Mar 2004
3232 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
3235 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP
3236 * \li Action: Move the cursor to the next paragraph (or beginning of the current one)
3237 in upward direction.
3238 * \li Syntax: paragraph-up
3239 * \li Origin: Asger, 1 Oct 1996
3242 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
3245 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UPDATE
3246 * \li Action: Updates the values inside the paragraph dialog from the paragraph.
3247 * \li Notion: This is an internal LFUN, not to be used by users. Called internally
3248 by #LFUN_DIALOG_UPDATE.
3249 * \li Origin: leeming, 13 Mar 2003
3252 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
3255 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_SELECT
3256 * \li Action: Move cursor to beginning of current paragraph
3257 and select to the end in downward direction
3258 * \li Notion: This function is by default bound to triple mouse click
3259 * \li Syntax: paragraph-select
3260 * \li Origin: Kornel, 16 Apr 2019
3263 { LFUN_PARAGRAPH_SELECT, "paragraph-select", ReadOnly, Edit },
3266 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP_SELECT
3267 * \li Action: Move the cursor and select the text to the next paragraph (or
3268 beginning of the current one) in upward direction.
3269 * \li Syntax: paragraph-up-select
3270 * \li Origin: Asger, 1 Oct 1996
3273 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
3276 * \var lyx::FuncCode lyx::LFUN_PASTE
3277 * \li Action: Pastes material (text or picture) from the active clipboard.
3278 * \li Syntax: paste [<TYPE>|<NUM>]
3279 * \li Params: <TYPE>: emf|pdf|png|jpeg|linkback|wmf|latex|html \n
3280 <NUM>: number of the selection in the internal clipboard stack to be pasted.
3283 { LFUN_PASTE, "paste", Noop, Edit },
3286 * \var lyx::FuncCode lyx::LFUN_PHANTOM_INSERT
3287 * \li Action: Inserts phantom on the current cursor position,
3288 move selection inside the inset.
3289 * \li Syntax: phantom-insert [<TYPE>]
3290 * \li Params: <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
3291 * \li Origin: uwestoehr, 30 Jan 2009
3294 { LFUN_PHANTOM_INSERT, "phantom-insert", Noop, Edit },
3297 * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
3298 * \li Action: Save user preferences.
3299 * \li Syntax: preferences-save
3300 * \li Origin: Lgb, 27 Nov 1999
3303 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
3306 * \var lyx::FuncCode lyx::LFUN_PREVIEW_INSERT
3307 * \li Action: Inserts a new preview inset.
3308 * \li Syntax: preview-insert
3309 * \li Origin: vfr, 28 Mar 2010
3312 { LFUN_PREVIEW_INSERT, "preview-insert", Noop, Edit },
3315 * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
3316 * \li Action: Pastes the currently selected text.
3317 * \li Notion: Primary selection mechanism is linux-only thing.
3318 * \li Syntax: primary-selection-paste [<ARG>]
3319 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
3322 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
3325 * \var lyx::FuncCode lyx::LFUN_QUOTE_INSERT
3326 * \li Action: Inserts quotes according to the type and quote-language preference.
3327 * \li Notion: Currently 15 different quote styles are distinguished (see params).
3328 * \li Syntax: quote-insert [<LEVEL>] [<SIDE>] [<STYLE>]
3329 * \li Params: <LEVEL>: 'inner' for (i.e., secondary, usually single) quotes, otherwise
3330 * outer (i.e., primary, usually double) quotes will be used.\n
3331 * <SIDE>: 'opening' for opening quotes, 'closing' for closing quotes,
3332 * otherwise the side will be guessed from the context.\n
3333 * <STYLE>: 'british' for `British' quote style (with ``inner quotation'')\n
3334 * 'cjk' for Chinese/Japanese/Korean corner bracket quotation marks\n
3335 * 'cjk-angle' for Chinese/Japanese/Korean angle bracket quotation marks\n
3336 * 'danish' for >>Danish<< quote style (with >inner quotation<)\n
3337 * 'english' for ``English'' quote style (with `inner quotation')\n
3338 * 'french' for <<french>> quote style (with ``inner quotation'')\n
3339 * 'frenchin' for <<frenchin>> quote style (with <<inner quotation>>) ["in" = Imprimerie Nationale]\n
3340 * 'german' for ,,German`` quote style (with ,inner quotation`)\n
3341 * 'plain' for "Plain" quote style (with 'inner quotation')\n
3342 * 'polish' for ,,Polish'' quote style (with ,inner quotation')\n
3343 * 'swedish' for ''Swedish'' quote style (with 'inner quotation')\n
3344 * 'swedishg' for >>swedishg>> quote style (with 'inner quotation') ["g" = Guillemets]\n
3345 * 'swiss' for <<Swiss>> quote style (with <inner quotation>)\n
3346 * 'russian' for <<Russian>> quote style (with ,,inner quotation``)\n
3347 * 'dynamic' for Dynamic quotation marks which inherit the global
3349 * If no quote style is specified, the document-wide will be used.
3352 { LFUN_QUOTE_INSERT, "quote-insert", Noop, Edit },
3355 * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
3356 * \li Action: Reconfigure the automatic settings.
3357 * \li Syntax: reconfigure
3358 * \li Origin: Asger, 14 Feb 1997
3361 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
3364 * \var lyx::FuncCode lyx::LFUN_REDO
3365 * \li Action: Redoes the last thing undone.
3369 { LFUN_REDO, "redo", ReadOnly, Edit },
3372 * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
3373 * \li Action: Go to the next label or cross-reference.
3374 * \li Syntax: reference-next
3375 * \li Origin: Dekel, 14 Jan 2001
3378 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
3382 * \var lyx::FuncCode lyx::LFUN_REGEXP_MODE
3383 * \li Action: Enters regexp mode (i.e., puts regexp insets on the current
3384 cursor position). Used by the advanced search dialog.
3385 * \li Notion: If there is any selected text, then it is moved inside the created
3387 * \li Syntax: regexp-mode [<ARG>]
3388 * \li Params: <ARG>: eventual argument (regular expression).
3389 * \li Origin: Tommaso, 4 Oct 2008
3392 { LFUN_REGEXP_MODE, "regexp-mode", Noop, Math },
3395 * \var lyx::FuncCode lyx::LFUN_REPEAT
3396 * \li Action: Repeat the given command.
3397 * \li Notion: fails when the repeat count is greater than 10000.
3398 * \li Syntax: repeat <COUNT> <LFUN-COMMAND>
3399 * \li Origin: Andre, 27 Oct 2003
3402 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
3405 * \var lyx::FuncCode lyx::LFUN_SEARCH_IGNORE
3406 * \li Action: Enables/disables searching for features in findadv
3407 * \li Syntax: search-ignore <type> <value>
3408 * \li Params: <type>: language|color|sectioning|font|series|shape|family|markup|underline|strike
3409 * \li Params: <value>: true|false
3412 { LFUN_SEARCH_IGNORE, "search-ignore", ReadOnly|NoBuffer|NoUpdate, System },
3415 * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN
3416 * \li Action: Moves the cursor one page in downward direction.
3417 * \li Syntax: screen-down
3420 { LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit },
3423 * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN_SELECT
3424 * \li Action: Moves the cursor one screen in downward direction adding the current
3425 position to the selection.
3426 * \li Syntax: screen-down-select
3429 { LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit },
3432 * \var lyx::FuncCode lyx::LFUN_SCREEN_FONT_UPDATE
3433 * \li Action: Update fonts and its metrics.
3434 * \li Notion: Automatically called after zoom, dpi, font names, or norm change.
3435 * \li Syntax: screen-font-update
3436 * \li Origin: ARRae, 13 Aug 2000
3439 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
3442 * \var lyx::FuncCode lyx::LFUN_SCREEN_RECENTER
3443 * \li Action: Recenters the screen on the current cursor position.
3444 * \li Syntax: screen-recenter
3447 { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit },
3451 * \var lyx::FuncCode lyx::LFUN_SCREEN_SHOW_CURSOR
3452 * \li Action: Repositions the screen such that the cursor is visible.
3453 * \li Syntax: screen-show-cursor
3454 * \li Origin: vfr, 25 Mar 2009
3457 { LFUN_SCREEN_SHOW_CURSOR, "screen-show-cursor", ReadOnly, Edit },
3461 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP
3462 * \li Action: Moves the cursor one page in upward direction.
3463 * \li Syntax: screen-up
3466 { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit },
3469 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP_SELECT
3470 * \li Action: Moves the cursor one page in upward direction adding the current
3471 position to the selection.
3472 * \li Syntax: screen-up-select
3475 { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit },
3478 * \var lyx::FuncCode lyx::LFUN_SCRIPT_INSERT
3479 * \li Action: Inserts a subscript or superscript inset.
3480 * \li Syntax: script-insert <TYPE>
3481 * \li Params: <TYPE>: subscript|superscript
3482 * \li Origin: Georg, 23 Nov 2010
3485 { LFUN_SCRIPT_INSERT, "script-insert", Noop, Edit },
3488 * \var lyx::FuncCode lyx::LFUN_SCROLL
3489 * \li Action: Scroll the buffer view.
3490 * \li Notion: Only scrolls the screen up or down; does not move the cursor.
3491 * \li Syntax: scroll <TYPE> <QUANTITY>
3492 * \li Params: <TYPE>: line|page\n
3493 <QUANTITY>: up|down|<number>
3494 * \li Origin: Abdel, Dec 27 2007
3497 { LFUN_SCROLL, "scroll", ReadOnly, Edit },
3500 * \var lyx::FuncCode lyx::LFUN_SECTION_SELECT
3501 * \li Action: Select the whole section.
3502 * \li Notion: The cursor should be in a section heading
3503 before calling this lfun.
3504 * \li Syntax: section-select
3505 * \li Origin: vfr, 05 May 2009
3508 { LFUN_SECTION_SELECT, "section-select", ReadOnly, Edit },
3512 * \var lyx::FuncCode lyx::LFUN_SELECTION_PASTE
3513 * \li Action: Pastes the internal selection text in permanent selection.
3514 * \li Notion: Created in order to have middle mouse button pasting correct (bound to
3515 command-alternatives selection-paste ; primary-selection-paste paragraph).
3516 * \li Syntax: selection-paste
3517 * \li Origin: lasgouttes, 14 Jan 2009
3520 { LFUN_SELECTION_PASTE, "selection-paste", Noop, Edit },
3523 * \var lyx::FuncCode lyx::LFUN_SELF_INSERT
3524 * \li Action: Inserts the given string (accordingly to the correct keymap).
3525 * \li Notion: Automatically replace the currently selected text. Depends on lyxrc
3526 settings "auto_region_delete".
3527 * \li Syntax: self-insert <STRING>
3530 { LFUN_SELF_INSERT, "self-insert", SingleParUpdate, Hidden },
3533 * \var lyx::FuncCode lyx::LFUN_SEPARATOR_INSERT
3534 * \li Action: Inserts an environment separator or latex paragraph break.
3535 * \li Syntax: separator-insert [<ARG>]
3536 * \li Params: <ARG>: <plain|parbreak|latexpar> default: plain
3537 * \li Origin: ef, 2 May 2014
3540 { LFUN_SEPARATOR_INSERT, "separator-insert", Noop, Edit },
3543 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_FILENAME
3544 * \li Action: Returns path and file name of the currently edited document.
3545 * \li Syntax: server-get-filename
3548 { LFUN_SERVER_GET_FILENAME, "server-get-filename", ReadOnly, System },
3551 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_LAYOUT
3552 * \li Action: Returns the current layout (that is environment) name
3553 on the cursor position.
3554 * \li Syntax: server-get-layout
3557 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
3560 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_STATISTICS
3561 * \li Action: Returns the statistics (number of words and characters)
3562 in the document or in the given selection.
3563 * \li Notion: Note that this function gives the number of words/chars written,
3564 not the number of characters which will be typeset.
3565 * \li Syntax: server-get-statistics [<TYPE>]
3566 * \li Params: <TYPE>: <words|chars|chars-space> The requested count; if not
3567 specified, the three values are returned, separated
3569 words: count words.\n
3570 chars: count characters.\n
3571 chars-space: count characters and spaces.
3572 * \li Origin: brokenclock, Oct 10 2014
3575 { LFUN_SERVER_GET_STATISTICS, "server-get-statistics", ReadOnly, System },
3578 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
3579 * \li Action: Returns the coordinates of cursor position in the editing area.
3580 * \li Syntax: server-get-xy
3583 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
3587 * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
3588 * \li Action: Sets the cursor position in LyX based on the row number of generated TeX file.
3589 * \li Notion: This can be useful for DVI inverse-search or detection of the problematic
3590 line from LaTeX compilation. Note that before this function can be used
3591 export to LaTeX output must occur (in order to map the row numbers).
3592 * \li Syntax: server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
3593 * \li Params: <FILE>: the path and filename. Environment variables are expanded in the path.
3594 In case this LFUN does not work make sure you are giving correct
3596 If the file is located inside LyX temporary directory it will be
3597 mapped back into the appropriate opened buffer (e.g. for the case
3598 of generated .tex file).\n
3599 .ext: extensions will be automatically replaced by .lyx.\n
3600 <ROW_NUMBER> The row number of the LaTeX file to which to go.
3601 * \li Sample: server-goto-file-row /home/user/example.lyx 41\n
3602 server-goto-file-row /tmp/lyx_tmpdir.XM3088/lyx_tmpbuf0/example.tex 41
3603 * \li Origin: Edmar, 23 Dec 1998
3606 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly | NoBuffer, System },
3609 * \var lyx::FuncCode lyx::LFUN_SERVER_NOTIFY
3610 * \li Action: Sends notify message about the last key-sequence to client.
3611 * \li Notion: This can be used to grab last key-sequence used inside the LyX window.
3612 See also Debug extensions section in Additional features manual.
3613 * \li Syntax: server-notify
3616 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
3619 * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
3620 * \li Action: Sets the cursor position based on the editing area coordinates
3621 (similar to clicking on that point with left mouse button).
3622 * \li Syntax: server-set-xy <X> <Y>
3625 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
3628 * \var lyx::FuncCode lyx::LFUN_SET_COLOR
3629 * \li Action: Set the given LyX color to the color defined by the X11 name given.
3630 * \li Notion: A new color entry is created if the color is unknown.
3631 Color names can be stored as a part of user settings.
3632 * \li Syntax: set-color <LYX_NAME> <X11_NAME>
3633 * \li Origin: SLior, 11 Jun 2000
3636 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
3639 * \var lyx::FuncCode lyx::LFUN_GRAPHICS_SET_GROUP
3640 * \li Action: Set the group for the graphics inset on the cursor position.
3641 * \li Syntax: graphics-set-group [<GROUP>]
3642 * \li Params: <GROUP>: Id for an existing group. In case the Id is an empty string,
3643 the graphics inset is removed from the current group.
3644 * \li Origin: sanda, 6 May 2008
3647 { LFUN_GRAPHICS_SET_GROUP, "graphics-set-group", Noop, Edit },
3650 * \var lyx::FuncCode lyx::LFUN_GRAPHICS_UNIFY
3651 * \li Action: Set the same group for all graphics insets in the marked block.
3652 * \li Syntax: graphics-unify [<GROUP>]
3653 * \li Params: <GROUP>: Id for an existing group. In case the Id is an empty string,
3654 the group Id from the first graphics inset will be used.
3655 * \li Origin: sanda, 7 Feb 2018
3658 { LFUN_GRAPHICS_UNIFY, "graphics-unify", Noop, Edit },
3661 * \var lyx::FuncCode lyx::LFUN_GRAPHICS_RELOAD
3662 * \li Action: Reloads the image if necessary.
3663 * \li Syntax: graphics-reload
3664 * \li Origin: vfr, 10 Aug 2009
3667 { LFUN_GRAPHICS_RELOAD, "graphics-reload", ReadOnly | AtPoint, Edit },
3670 * \var lyx::FuncCode lyx::LFUN_SPACE_INSERT
3671 * \li Action: Inserts one of horizontal space insets.
3672 * \li Syntax: space-insert <NAME> [<LEN>]
3673 * \li Params: <NAME>: normal, protected, visible, thin, quad, qquad, enspace,
3674 enskip, negthinspace, negmedspace, negthickspace, hfill,
3675 hfill*, dotfill, hrulefill, hspace, hspace* \n
3676 Only in math mode: med and thick.\n
3677 <LEN>: length for custom spaces (hspace, hspace* for protected)
3678 * \li Origin: spitz, 20 May 2003, Mar 17 2008
3681 { LFUN_SPACE_INSERT, "space-insert", Noop, Edit },
3684 * \var lyx::FuncCode lyx::LFUN_SPECIALCHAR_INSERT
3685 * \li Action: Inserts various characters into the document.
3686 * \li Syntax: specialchar-insert <CHAR>
3687 * \li Params: <CHAR>: hyphenation, allowbreak, ligature-break, slash,
3688 nobreakdash, dots, end-of-sentence, menu-separator,
3689 lyx, tex, latex, latex2e.
3690 * \li Origin: spitz, 6 Dec 2007
3693 { LFUN_SPECIALCHAR_INSERT, "specialchar-insert", Noop, Edit },
3696 * \var lyx::FuncCode lyx::LFUN_SPELLING_ADD
3697 * \li Action: Add the word under the cursor to the respective
3698 * spell checker dictionary.
3699 * The default for the language is retrieved from the cursor position.
3700 * \li Syntax: spelling-add [<STRING>] [<LANG>]
3701 * \li Params: <WORD>: word to add
3702 <LANG>: language name (see file languages)
3703 * \li Origin: spitz, 18 Jan 2010
3706 { LFUN_SPELLING_ADD, "spelling-add", ReadOnly, Edit },
3709 * \var lyx::FuncCode lyx::LFUN_SPELLING_CONTINUOUSLY
3710 * \li Action: Toggle continuous spell checking.
3711 * \li Syntax: spelling-continuously
3712 * \li Origin: vfr, 24 March 2013
3715 { LFUN_SPELLING_CONTINUOUSLY, "spelling-continuously", ReadOnly, Edit },
3719 * \var lyx::FuncCode lyx::LFUN_SPELLING_IGNORE
3720 * \li Action: Let the spell checker ignore the word under the cursor
3721 * in the current session for the given language.
3722 * The default for the language is retrieved from the cursor position.
3723 * \li Syntax: spelling-ignore [<WORD>] [<LANG>]
3724 * \li Params: <WORD>: word to ignore
3725 <LANG>: language name (see file languages)
3726 * \li Origin: spitz, 18 Jan 2010
3729 { LFUN_SPELLING_IGNORE, "spelling-ignore", ReadOnly, Edit },
3732 * \var lyx::FuncCode lyx::LFUN_SPELLING_REMOVE
3733 * \li Action: Remove the word under the cursor from the respective
3734 * spell checker dictionary.
3735 * The default for the language is retrieved from the cursor position.
3736 * \li Syntax: spelling-remove [<STRING>] [<LANG>]
3737 * \li Params: <WORD>: word to remove
3738 * <LANG>: language name (see file languages)
3739 * \li Origin: SWitt, 28 July 2010
3742 { LFUN_SPELLING_REMOVE, "spelling-remove", ReadOnly, Edit },
3746 * \var lyx::FuncCode lyx::LFUN_STATISTICS
3747 * \li Action: Count the statistics (number of words and characters)
3748 in the document or in the given selection and display it
3750 * \li Notion: Note that this function gives the number of words/chars written,
3751 not the number of characters which will be typeset.
3752 * \li Syntax: statistics
3753 * \li Origin: lasgouttes, Jan 27 2004; sanda, Jan 8 2008
3756 { LFUN_STATISTICS, "statistics", ReadOnly, System },
3759 * \var lyx::FuncCode lyx::LFUN_TABULAR_FEATURE
3760 * \li Action: Modify properties of tabulars and table-like math environments.
3761 * \li Syntax: tabular-feature <FEATURE> [<ARG>]
3762 * \li Params: Generally see #LFUN_INSET_INSERT for further details.\n
3763 * <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|\n
3764 copy-column|move-column-right|move-column-left|move-row-down|move-row-up|\n
3765 set-line-top|set-line-bottom|set-line-left|set-line-right|\n
3766 toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|\n
3767 set-ltrim-top|set-rtrim-top|set-ltrim-bottom|set-rtrim-bottom\n
3768 toggle-ltrim-top|toggle-rtrim-top|toggle-ltrim-bottom|toggle-rtrim-bottom\n
3769 align-left|align-right|align-center|align-block|align-decimal|set-decimal-point|\n
3770 valign-top|valign-bottom|valign-middle|longtabular-align-left|\n
3771 longtabular-align-center|longtabular-align-right|m-align-left|m-align-right|\n
3772 m-align-center|m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|\n
3773 reset-formal-default|set-all-lines|unset-all-lines|toggle-longtabular|\n
3774 set-longtabular|unset-longtabular|set-pwidth|\n
3775 set-mpwidth|set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|\n
3776 set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|\n
3777 unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|\n
3778 set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|\n
3779 set-special-column|set-special-multicolumn|set-special-multirow|\n
3780 toggle-booktabs|set-booktabs|unset-booktabs|set-top-space|set-bottom-space|\n
3781 set-interline-space|set-border-lines|tabular-valign-top|\n
3782 tabular-valign-middle|tabular-valign-bottom|set-tabular-width|\n
3783 toggle-varwidth-column
3784 Various math-environment features are handled as well, e.g. add-vline-left/right for\n
3785 the Grid/Array environment.\n
3786 <ARG>: additional argument for some commands, use debug mode to explore its values.
3787 * \li Origin: gm, 10 Dec 2015
3790 { LFUN_TABULAR_FEATURE, "tabular-feature", Noop, Edit },
3793 * \var lyx::FuncCode lyx::LFUN_TABULAR_INSERT
3794 * \li Action: Inserts table into the document.
3795 * \li Notion: See #LFUN_TABULAR_FEATURE for some more details
3796 about tabular modifications.
3797 * \li Syntax: tabular-insert [<ROWS> <COLUMNS>]
3798 * \li Params: In case no arguments are given show insert dialog.
3799 * \li Origin: Jug, 12 Apr 2000
3802 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
3805 * \var lyx::FuncCode lyx::LFUN_TABULAR_STYLE_INSERT
3806 * \li Action: Inserts table of a given style into the document.
3807 * \li Notion: See #LFUN_TABULAR_FEATURE for some more details
3808 about tabular modifications.
3809 * \li Syntax: tabular-style-insert <style> <ROWS> <COLUMNS>
3810 * \li Params: Valid styles are the names of the files in lib/tabletemplates,
3811 * minus _1x<n> and .lyx suffix.
3812 * \li Origin: spitz, 25 Mar 2019
3815 { LFUN_TABULAR_STYLE_INSERT, "tabular-style-insert", Noop, Edit },
3818 * \var lyx::FuncCode lyx::LFUN_TAB_DELETE
3819 * \li Action: Delete a tab or up to an equivalent amount of spaces from
3821 * \li Notion: It also works on a selection - it removes a tab or spaces from the
3822 beginning of each line spanned by the selection. This is useful if
3823 you want to indent/unindent multiple lines in one action.
3824 * \li Syntax: tab-delete
3825 * \li Origin: vfr, Sep 30 2008
3828 { LFUN_TAB_DELETE, "tab-delete", SingleParUpdate, Edit },
3831 * \var lyx::FuncCode lyx::LFUN_TAB_GROUP_CLOSE
3832 * \li Action: Close the current tab group.
3833 * \li Notion: This only closes the work areas, not the buffers themselves.
3834 The still opened buffers can be visualized in another tab group.
3835 * \li Syntax: tab-group-close
3836 * \li Origin: Abdel, 21 Feb 2008
3839 { LFUN_TAB_GROUP_CLOSE, "tab-group-close", ReadOnly, Buffer },
3843 * \var lyx::FuncCode lyx::LFUN_TAB_INSERT
3844 * \li Action: Insert a tab into a listings inset.
3845 * \li Notion: It also works on a selection.
3846 * \li Syntax: tab-insert
3847 * \li Origin: vfr, Sep 30 2008
3850 { LFUN_TAB_INSERT, "tab-insert", SingleParUpdate, Edit },
3853 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
3854 * \li Action: Sets the text class for the current buffer.
3855 * \li Syntax: textclass-apply <TEXTCLASS>
3856 * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
3857 the filename, minus the ".layout" extension.
3860 { LFUN_TEXTCLASS_APPLY, "textclass-apply", NoInternal, Layout },
3863 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
3864 * \li Action: Loads information for a textclass from disk.
3865 * \li Syntax: textclass-load <TEXTCLASS>
3866 * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
3867 the filename, minus the ".layout" extension.
3870 { LFUN_TEXTCLASS_LOAD, "textclass-load", NoInternal, Layout },
3874 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_APPLY
3875 * \li Action: Apply last used text properties.
3876 * \li Syntax: textstyle-apply [<NUM>]
3877 * \li Params: <NUM>: number of the selection in the internal freefonts stack to be applied.
3878 * \li Notion: These properties are stored via #LFUN_TEXTSTYLE_UPDATE, which is
3879 automatically triggered when using Text Style dialog.
3880 * \li Syntax: textstyle-apply
3881 * \li Origin: leeming, 12 Mar 2003
3884 { LFUN_TEXTSTYLE_APPLY, "textstyle-apply", Noop, Layout },
3887 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_UPDATE
3888 * \li Action: Apply text style and update the settings to be used by #LFUN_TEXTSTYLE_APPLY.
3889 * \li Syntax: textstyle-update <FONT_INFO>
3890 * \li Params: <FONT_INFO>: specifies font attributes, e.g. family, series, shape,
3891 size, emph, noun, underbar, number, color, language,
3893 Use lyx -dbg action for exact syntax of text-style
3895 * \li Origin: leeming, 12 Mar 2003
3898 { LFUN_TEXTSTYLE_UPDATE, "textstyle-update", Noop, Layout },
3901 * \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
3902 * \li Action: Look up thesaurus entries with respect to the word under the cursor.
3903 * \li Syntax: thesaurus-entry [<STRING>] [lang=<LANG>]
3904 * \li Params: <STRING>: word to look up
3905 <LANG>: language (see file languages)
3906 * \li Origin: Levon, 20 Jul 2001
3909 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
3912 * \var lyx::FuncCode lyx::LFUN_TOOLBAR_MOVABLE
3913 * \li Action: Toggles movability of a given toolbar between true/false.
3914 * \li Syntax: toolbar-movable <NAME>
3915 * \li Params: <NAME>: *|standard|extra|table|math|mathmacrotemplate|
3916 minibuffer|review|view/update|math_panels|vcs|
3917 view-others|update-others
3918 * \li Origin: daniel, 12 July 2016
3921 { LFUN_TOOLBAR_MOVABLE, "toolbar-movable", NoBuffer, Buffer },
3924 * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
3925 * \li Action: Toggles visibility of a given toolbar between on/off/auto.
3926 * \li Notion: Skipping "auto" when allowauto is false.
3927 * \li Syntax: toolbar-toggle <NAME> [allowauto]
3928 * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|\n
3929 minibuffer|review|view/update|math_panels|vcs|
3930 view-others|update-others
3931 * \li Origin: Edwin, 21 May 2007
3934 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
3937 * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
3938 * \li Action: Various UI visibility-toggling actions.
3939 * \li Syntax: ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
3940 * \li Params: statusbar : Toggle visibility of the statusbar.\n
3941 menubar : Toggle visibility of the menubar.\n
3942 scrollbar : Toggle visibility of the scrollbar.\n
3943 frame : Toggle visibility of the frames around editing window.\n
3944 fullscreen : Toggle fullscreen mode. This also covers calling the
3945 previous functions. However #LFUN_TOOLBAR_TOGGLE for the
3946 custom tweaks of the toolbars should be used.
3947 * \li Origin: sanda, 9 Feb 2007
3950 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
3954 * \var lyx::FuncCode lyx::LFUN_UNDO
3955 * \li Action: Undoes the last edit.
3959 { LFUN_UNDO, "undo", ReadOnly, Edit },
3962 * \var lyx::FuncCode lyx::LFUN_UNICODE_INSERT
3963 * \li Action: Inserts a single unicode character.
3964 * \li Syntax: unicode-insert <CHAR1> <CHAR2> ...
3965 * \li Params: <CHARn>: The character to insert, given as its code
3966 point, in hexadecimal.
3967 * \li Sample: unicode-insert 0x0100 0x0259
3968 * \li Origin: Lgb, 22 Oct 2006
3971 { LFUN_UNICODE_INSERT, "unicode-insert", Noop, Edit },
3974 * \var lyx::FuncCode lyx::LFUN_UP
3975 * \li Action: Moves the cursor one line in upward direction.
3979 { LFUN_UP, "up", ReadOnly | NoUpdate, Edit },
3982 * \var lyx::FuncCode lyx::LFUN_UP_SELECT
3983 * \li Action: Moves the cursor one line in upward direction adding the current
3984 position to the selection.
3985 * \li Syntax: up-select
3988 { LFUN_UP_SELECT, "up-select", ReadOnly | SingleParUpdate, Edit },
3991 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_IN
3992 * \li Action: Checks-in/commits the changes of the registered file to the repository.
3993 * \li Notion: In RCS case this also unlocks the file.
3994 * \li Syntax: vc-check-in
3995 * \li Origin: Lgb, 1 Jul 1997
3998 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
4001 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_OUT
4002 * \li Action: Checks-out the document for edit (and locks it in some cases).
4003 * \li Syntax: vc-check-out
4004 * \li Origin: Lgb, 1 Jul 1997
4007 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
4010 * \var lyx::FuncCode lyx::LFUN_VC_COMMAND
4011 * \li Action: Executes external command. This command is intended to support
4012 additional VCS commands.
4013 * \li Syntax: vc-command <FLAG> <PATH> <COMMAND>
4014 * \li Params: <FLAG>: Flags for the command can be combined together.\n
4015 U - dUmmy - no flags \n
4016 D - Doc - need document loaded to proceed \n
4017 I - dIrty - mark document dirty \n
4018 R - Reload - ensure that the document is saved and reload it after command execution \n
4019 M - Message - ask for input string (commit message)\n
4020 <PATH>: path where to start. $$p will be replaced by the current document path.\n
4021 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current
4022 document(with absolute path)/path/message.
4023 * \li Sample: vc-command DR $$p "svn up"
4024 * \li Origin: sanda, 13 Jan 2009
4027 { LFUN_VC_COMMAND, "vc-command", NoBuffer | ReadOnly, System },
4030 * \var lyx::FuncCode lyx::LFUN_VC_COMPARE
4031 * \li Action: Compares two revisions of the same file under version control.
4032 * \li Syntax: vc-compare [<REV1>] [<REV2>]
4033 * \li Params: Revision number either points directly to commit in history
4034 or if negative number -x it points to (last commit - x).\n
4035 In RCS we subtract only in the last number of revision specification.
4036 Special case "0" is reserved for the last committed revision.\n
4037 <REV1>: Older file.\n
4038 <REV2>: Newer file. Used only if REV1 > 0.\n
4039 If no parameter is given, interactive dialog will be shown.
4040 * \li Sample: Compare current document against last commit\n
4042 Compare current document against current revision - 5 commits\n
4044 Compare revisions 120 and 155\n
4046 * \li Origin: sanda, 12 Feb 2010
4049 { LFUN_VC_COMPARE, "vc-compare", ReadOnly, System },
4053 * \var lyx::FuncCode lyx::LFUN_VC_COPY
4054 * \li Action: Copies the document to another name.
4055 * \li Notion: Copying with revision history is only supported by SVN.
4056 For RCS and CVS it is simulated by adding the document
4058 Disabled if uncommitted changes exist.
4059 * \li Syntax: vc-copy <FILENAME>
4060 * \li Params: <FILENAME>: New name of the document.\n
4061 * A file dialog is opened if no filename is given.
4062 * \li Origin: gb, 05 Feb 2013
4065 { LFUN_VC_COPY, "vc-copy", ReadOnly, System },
4068 * \var lyx::FuncCode lyx::LFUN_VC_LOCKING_TOGGLE
4069 * \li Action: Toggles the locking property of the edited file.
4070 * \li Notion: This is currently implemented only for SVN.
4071 * \li Syntax: vc-locking-toggle
4072 * \li Origin: sanda, 25 Jun 2009
4075 { LFUN_VC_LOCKING_TOGGLE, "vc-locking-toggle", ReadOnly, System },
4078 * \var lyx::FuncCode lyx::LFUN_VC_REGISTER
4079 * \li Action: Register the document as an file inside version control system.
4080 * \li Notion: File is registered inside cvs, svn or rcs repository acording to the existence
4081 of cvs/svn/rcs entries in the document's directory. \n
4082 See LyX Additional Features Manual (Version Control Chapter) for additional
4084 * \li Syntax: vc-register
4085 * \li Origin: Lgb, 1 Jul 1997
4088 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
4091 * \var lyx::FuncCode lyx::LFUN_VC_RENAME
4092 * \li Action: Renames the document to another name.
4093 * \li Notion: Renaming with revision history is only supported by SVN.
4094 For CVS it is simulated by adding the document under a new
4095 name and deleting the old one. For RCS it is not supported.
4096 Disabled if uncommitted changes exist.
4097 * \li Syntax: vc-rename <FILENAME>
4098 * \li Params: <FILENAME>: New name of the document.\n
4099 * A file dialog is opened if no filename is given.
4100 * \li Origin: gb, 05 Feb 2013
4103 { LFUN_VC_RENAME, "vc-rename", ReadOnly, System },
4106 * \var lyx::FuncCode lyx::LFUN_VC_REPO_UPDATE
4107 * \li Action: Update the local archive directory in which resides
4108 the current document with the remote repository.
4109 * \li Syntax: vc-repo-update
4110 * \li Origin: sanda, 16 Oct 2009
4113 { LFUN_VC_REPO_UPDATE, "vc-repo-update", ReadOnly, System },
4116 * \var lyx::FuncCode lyx::LFUN_VC_REVERT
4117 * \li Action: Reverts the document to the last check-in/commit in VCS.
4118 * \li Syntax: vc-revert
4119 * \li Origin: Lgb, 1 Jul 1997
4122 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
4125 * \var lyx::FuncCode lyx::LFUN_VC_UNDO_LAST
4126 * \li Action: Undo last check-in.
4127 * \li Notion: This is currently implemented only for RCS.
4128 * \li Syntax: vc-check-out
4129 * \li Origin: Lgb, 1 Jul 1997
4132 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
4135 * \var lyx::FuncCode lyx::LFUN_VIEW_CLOSE
4136 * \li Action: Close the current document work area.
4137 * \li Notion: Close the current work area. If no other work areas are showing the buffer,
4138 then close the associated buffer as well.
4139 * \li Syntax: view-close
4140 * \li Origin: Tommaso, 15 Sep 2012
4143 { LFUN_VIEW_CLOSE, "view-close", ReadOnly, Buffer },
4147 * \var lyx::FuncCode lyx::LFUN_VIEW_SPLIT
4148 * \li Action: Creates another split view of current buffer.
4149 * \li Notion: All split views act in the same way independently.
4150 * \li Syntax: view-split <vertical|horizontal>
4151 * \li Params: horizontal : The work areas are laid out side by side.\n
4152 vertical : The work areas laid out vertically.
4153 * \li Origin: Abdel, 20 Feb 2008
4156 { LFUN_VIEW_SPLIT, "view-split", ReadOnly, Buffer },
4160 * \var lyx::FuncCode lyx::LFUN_WINDOW_CLOSE
4161 * \li Action: Closes the current LyX window.
4162 * \li Syntax: window-close
4163 * \li Origin: Abdel, 23 Oct 2006
4166 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
4170 * \var lyx::FuncCode lyx::LFUN_WINDOW_NEW
4171 * \li Action: Creates new empty LyX window.
4172 * \li Notion: Already opened documents from the previous window can be found under View menu.
4173 * \li Syntax: window-new [<GEOMETRY>]
4174 * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently
4175 accepted only on Windows platform.
4176 * \li Origin: Abdel, 21 Oct 2006
4179 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
4182 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD
4183 * \li Action: Moves the cursor to the logically previous beginning of a word.
4184 * \li Notion: This is not the action which should be bound to the arrow keys,
4185 because backwards may be left or right, depending on the
4186 language. The arrow keys should be bound to #LFUN_WORD_LEFT or
4187 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
4188 * \li Syntax: word-backward
4191 { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit },
4194 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD_SELECT
4195 * \li Action: Moves the cursor to the logically previous beginning of a word,
4196 adding the logically traversed text to the selection.
4197 * \li Notion: See also #LFUN_WORD_BACKWARD.
4198 * \li Syntax: word-backward-select
4201 { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
4204 * \var lyx::FuncCode lyx::LFUN_WORD_CAPITALIZE
4205 * \li Action: Capitalizes the words in the selection (i.e. the first letters)
4206 or the first letter of word at cursor position.
4207 * \li Syntax: word-capitalize [<SEL_TYPE>]
4208 * \li Params: <SEL_TYPE>: if this is equal to "partial", then the
4209 * default word starts at cursor position (emacs-style).
4210 * Otherwise, the whole word is considered.
4213 { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
4216 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_BACKWARD
4217 * \li Action: Deletes characters to the beginning of the word (usually the "C+BackSpace" key).
4218 * \li Syntax: word-delete-backward [force]
4219 * \li Params: force: Delete big insets, do not only select them.
4222 { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
4225 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_FORWARD
4226 * \li Action: Deletes characters to the end of the word (usually the "C+Delete" key).
4227 * \li Syntax: word-delete-forward [force]
4228 * \li Params: force: Delete big insets, do not only select them.
4231 { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
4234 * \var lyx::FuncCode lyx::LFUN_WORD_FIND
4235 * \li Action: Search for next occurrence of a string.
4236 * \li Syntax: word-find [<DATA>]
4237 * \li Params: <DATA>: data encoded from Find dialog (see #lyx::find2string()).
4238 If no parameter is given, search with last find-dialog
4239 data is used for search (i.e. find-next).
4240 * \li Origin: Andre, Jan 7 2004
4243 { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
4246 * \var lyx::FuncCode lyx::LFUN_WORD_FINDADV
4247 * \li Action: Search for next occurrence of a pattern.
4248 * \li Syntax: word-findadv [<DATA>]
4249 * \li Params: <DATA>: data encoded from FindAdv dialog (see #lyx::findadv2string()).
4250 If no parameter is given, search with last find-dialog
4251 data is used for search (i.e. find-next).
4252 * \li Origin: Tommaso, Nov 15 2007
4255 { LFUN_WORD_FINDADV, "word-findadv", ReadOnly | NoBuffer, Edit },
4258 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_BACKWARD
4259 * \li Action: Search for a given string in backward direction.
4260 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
4261 * \li Syntax: word-find-backward [<STRING>]
4262 * \li Origin: Etienne, 20 Feb 1998
4265 { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
4268 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_FORWARD
4269 * \li Action: Search for a given string in forward direction.
4270 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
4271 * \li Syntax: word-find-forward [<STRING>]
4272 * \li Origin: Etienne, 16 Feb 1998
4275 { LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit },
4278 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD
4279 * \li Action: Moves the cursor to the logically next beginning of a word.
4280 * \li Notion: This is not the action which should be bound to the arrow keys,
4281 because forward may be left or right, depending on the language.
4282 The arrow keys should be bound to #LFUN_WORD_LEFT or
4283 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
4284 * \li Syntax: word-forward
4287 { LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
4290 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD_SELECT
4291 * \li Action: Moves the cursor to the logically next beginning of a word,
4292 adding the logically traversed text to the selection.
4293 * \li Notion: See also #LFUN_WORD_FORWARD.
4294 * \li Syntax: word-forward-select
4297 { LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
4300 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT
4301 * \li Action: Moves the cursor to the next beginning of a word "on the left".
4302 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
4303 "left" key is pressed. Generally, it moves the cursor to the
4304 next beginning of a word on the left. However, in Bidi text this
4305 become slightly more complicated, and there are different modes
4306 of cursor movement. In "visual mode", this moves left, plain and
4307 simple. In "logical mode", movement is logically forward in RTL
4308 paragraphs, and logically backwards in LTR paragraphs.
4309 * \li Syntax: word-left
4310 * \li Origin: dov, 28 Oct 2007
4313 { LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
4316 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT_SELECT
4317 * \li Action: Moves the cursor to the next beginning of a word "on the left",
4318 adding *logically* traversed text to the selection.
4319 * \li Notion: See also #LFUN_WORD_LEFT for exact details of the movement.
4320 * \li Syntax: word-left-select
4321 * \li Origin: dov, 28 Oct 2007
4324 { LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit },
4327 * \var lyx::FuncCode lyx::LFUN_WORD_LOWCASE
4328 * \li Action: Change the words in the selection or word at cursor position
4330 * \li Syntax: word-lowcase [<SEL_TYPE>]
4331 * \li Params: <SEL_TYPE>: if this is equal to "partial", then the
4332 * default word starts at cursor position (emacs-style).
4333 * Otherwise, the whole word is considered.
4336 { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
4339 * \var lyx::FuncCode lyx::LFUN_WORD_REPLACE
4340 * \li Action: Replace a string in the document.
4341 * \li Syntax: word-replace [<DATA>]
4342 * \li Params: <DATA>: data is of the form
4345 <casesensitive> <matchword> <all> <forward> <findnext>"
4346 * \li Origin: Andre, Jan 7 2004
4349 { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
4352 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT
4353 * \li Action: Moves the cursor to the next beginning of a word "on the right".
4354 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
4355 "right" key is pressed. Generally, it moves the cursor to the
4356 next beginning of a word on the right. However, in Bidi text
4357 this become slightly more complicated, and there are different
4358 modes of cursor movement. In "visual mode", this moves right,
4359 plain and simple. In "logical mode", movement is logically
4360 forward in LTR paragraphs, and logically backwards in RTL
4362 * \li Syntax: word-right
4363 * \li Origin: dov, 28 Oct 2007
4366 { LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit },
4369 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT_SELECT
4370 * \li Action: Moves the cursor to the next beginning of a word "on the right",
4371 adding *logically* traversed text to the selection.
4372 * \li Notion: See also #LFUN_WORD_RIGHT for exact details of the movement.
4373 * \li Syntax: word-right-select
4374 * \li Origin: dov, 28 Oct 2007
4377 { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
4380 * \var lyx::FuncCode lyx::LFUN_WORD_SELECT
4381 * \li Action: Puts the word where the cursor stands into the selection.
4382 * \li Syntax: word-select
4383 * \li Origin: Andre, 11 Sep 2002
4386 { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
4389 * \var lyx::FuncCode lyx::LFUN_WORD_UPCASE
4390 * \li Action: Change the words in the selection or word at cursor position
4392 * \li Syntax: word-upcase [<SEL_TYPE>]
4393 * \li Params: <SEL_TYPE>: if this is equal to "partial", then the
4394 * default word starts at cursor position (emacs-style).
4395 * Otherwise, the whole word is considered.
4398 { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
4401 * \var lyx::FuncCode lyx::LFUN_WRAP_INSERT
4402 * \li Action: Inserts floats wrapped by the text around.
4403 * \li Syntax: wrap-insert <TYPE>
4404 * \li Params: <TYPE>: table|figure
4405 * \li Origin: Dekel, 7 Apr 2002
4408 { LFUN_WRAP_INSERT, "wrap-insert", Noop, Edit },
4410 { LFUN_NOACTION, "", Noop, Hidden }
4411 #ifndef DOXYGEN_SHOULD_SKIP_THIS
4414 for (int i = 0; items[i].action != LFUN_NOACTION; ++i)
4415 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
4421 LyXAction::LyXAction()
4427 FuncRequest LyXAction::lookupFunc(string const & func) const
4429 string const func2 = trim(func);
4432 return FuncRequest(LFUN_NOACTION);
4435 string const arg = split(func2, cmd, ' ');
4437 FuncMap::const_iterator const fit = lyx_func_map.find(cmd);
4439 return fit != lyx_func_map.end()
4440 ? FuncRequest(fit->second, arg)
4441 : FuncRequest(LFUN_UNKNOWN_ACTION);
4445 string const LyXAction::getActionName(FuncCode action) const
4447 InfoMap::const_iterator const it = lyx_info_map.find(action);
4448 return it != lyx_info_map.end() ? it->second.name : string();
4452 LyXAction::FuncType LyXAction::getActionType(FuncCode action) const
4454 InfoMap::const_iterator const it = lyx_info_map.find(action);
4455 return it != lyx_info_map.end() ? it->second.type : Hidden;
4459 bool LyXAction::funcHasFlag(FuncCode action,
4460 LyXAction::FuncAttribs flag) const
4462 InfoMap::const_iterator ici = lyx_info_map.find(action);
4464 if (ici == lyx_info_map.end()) {
4465 LYXERR0("action: " << action << " is not known.");
4466 LASSERT(false, return false);
4469 return ici->second.attrib & flag;
4473 LyXAction::const_iterator LyXAction::func_begin() const
4475 return lyx_func_map.begin();
4479 LyXAction::const_iterator LyXAction::func_end() const
4481 return lyx_func_map.end();
4485 LyXErr & operator<<(LyXErr & l, FuncCode code)
4488 l.stream() << lyxaction.getActionName(code);