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>]
718 * \li Params: <FILE>: filename of created file with absolute path.
721 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
724 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEXT
725 * \li Action: Switch to the next opened document.
726 * \li Notion: Note that this does not necessarily mean next in tabbar
727 (for full list see View menu).
728 * \li Syntax: buffer-next
731 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
734 * \var lyx::FuncCode lyx::LFUN_BUFFER_PARAMS_APPLY
735 * \li Action: Apply the given settings to the current document.
736 * \li Syntax: buffer-params-apply [<ARGS>]
737 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
738 you can find in document header of usual .lyx file.
739 * \li Origin: leeming, 30 Mar 2004
742 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", NoInternal, Buffer },
746 * \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS
747 * \li Action: Switch to the previous opened document.
748 * \li Syntax: buffer-previous
751 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
754 * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
755 * \li Action: Reverts opened document.
756 * \li Syntax: buffer-reload [dump]
757 * \li Params: dump: do not ask for any confirmation, just reload. All changes will be lost.
758 * \li Origin: Asger, 2 Feb 1997
761 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
764 * \var lyx::FuncCode lyx::LFUN_BUFFER_SAVE_AS_DEFAULT
765 * \li Action: Save the current document settings as default.
766 * \li Notion: The file will will be saved into ~/.lyx/templates/defaults.lyx .
767 * \li Syntax: buffer-save-as-default [<ARGS>]
768 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
769 you can find in document header of usual .lyx file.
770 * \li Origin: leeming, 30 Mar 2004
773 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
776 * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
777 * \li Action: Display and switch to the given buffer.
778 * \li Syntax: buffer-switch <BUFFER>
779 * \li Params: <BUFFER>: path and filename of already opened (but possibly hidden)
780 document which is to be shown.
783 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
786 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
787 * \li Action: Toggles compression of the current document on/off.
788 * \li Syntax: buffer-toggle-compression
789 * \li Origin: bpeng, 27 Apr 2006
792 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
795 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_OUTPUT_SYNC
796 * \li Action: Toggles including of resources for forward/reverse search of the given document.
797 * \li Notion: When toggled on, SyncTeX is invoked for PDF, while srcltx package
798 is used for DVI. Custom LaTeX macro can be defined in preferences.
799 * \li Syntax: buffer-toggle-output-sync
800 * \li Origin: sanda, 25 May 2010
803 { LFUN_BUFFER_TOGGLE_OUTPUT_SYNC, "buffer-toggle-output-sync", Noop, System },
806 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
807 * \li Action: Toggle editing mode of the current document between read/write and read-only.
808 * \li Notion: This function is not allowed if the file is under version control, since
809 read-only flag is often used in version control file locking.
810 * \li Syntax: buffer-toggle-read-only
811 * \li Origin: Lgb, 27 May 1997
814 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
817 * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
818 * \li Action: Exports the current document and put the result into the
820 * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
821 the output will be rewritten - updated. This is useful in case your viewer
822 is able to detect such changes (e.g. ghostview for postscript).
823 * \li Syntax: buffer-update [<FORMAT>]
824 * \li Params: <FORMAT>: The format to display, where this is one of the
825 formats defined (in the current GUI) in the
826 Tools>Preferences>File Formats dialog.
827 If no format is given, the default format as
828 specified in the same dialog is used.
829 * \li Origin: Dekel, 5 Aug 2000
832 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
836 * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
837 * \li Action: Displays current buffer in chosen format.
838 * \li Notion: Displays the contents of the current buffer in the chosen
839 format, for example, PDF or DVI. This runs the necessary
840 converter, calls the defined viewer, and so forth.
841 * \li Syntax: buffer-view [<FORMAT>]
842 * \li Params: <FORMAT>: The format to display, where this is one of the
843 formats defined (in the current GUI) in the
844 Tools>Preferences>File Formats dialog.
845 If no format is given, the default format as
846 specified in the same dialog is used.
849 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
852 * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW_CACHE
853 * \li Action: Opens the file that was created from last preview of this buffer.
854 * \li Notion: This LFUN is called by the "Show Output Anyway" button in the LaTeX
855 * Errors dialog. It can also be called by the user, which is useful
856 * if the document takes a long time to compile, and you just
857 * want to see the last previewed version.
858 * \li Syntax: buffer-view-cache
861 { LFUN_BUFFER_VIEW_CACHE, "buffer-view-cache", ReadOnly, Buffer },
864 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
865 * \li Action: Saves the current buffer.
866 * \li Notion: Saves the current buffer to disk, using the filename that
867 is already associated with the buffer, asking for one if
868 none is yet assigned.
869 * \li Syntax: buffer-write
872 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
875 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
876 * \li Action: Save all changed documents.
877 * \li Syntax: buffer-write-all
878 * \li Origin: rgh, gpothier 6 Aug 2007
881 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
884 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
885 * \li Action: Rename and save current buffer.
886 * \li Syntax: buffer-write-as <FILENAME>
887 * \li Params: <FILENAME>: New name of the buffer/file. A relative path
888 is with respect to the original location of the buffer/file.
891 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
894 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXTERNAL_MODIFICATION_CLEAR
895 * \li Action: Clear the external modification flag on the current buffer.
896 * \li Syntax: buffer-external-modification-clear
897 * \li Origin: gm, 2 March 2017
900 { LFUN_BUFFER_EXTERNAL_MODIFICATION_CLEAR,
901 "buffer-external-modification-clear", ReadOnly, Buffer },
904 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM
905 * \li Action: Sets the zoom of the screen fonts.
906 * \li Syntax: buffer-zoom [<ZOOM>]
907 * \li Params: <ZOOM>: The target zoom value in %;
908 * the default is the default zoom as saved in preferences.
909 * \li Origin: daniel, 28 Oct 2016
912 { LFUN_BUFFER_ZOOM, "buffer-zoom", ReadOnly, Buffer },
915 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_IN
916 * \li Action: Increases the zoom of the screen fonts.
917 * \li Syntax: buffer-zoom-in [<ZOOM>]
918 * \li Params: <ZOOM>: The zoom value addition in % (neg. or pos.);
919 * the default is 10% of the default zoom as saved in preferences.
920 * \li Origin: vfr, 30 Mar 2009
923 { LFUN_BUFFER_ZOOM_IN, "buffer-zoom-in", ReadOnly, Buffer },
927 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_OUT
928 * \li Action: Decreases the zoom of the screen fonts.
929 * \li Syntax: buffer-zoom-out [<ZOOM>]
930 * \li Params: <ZOOM>: The zoom value abstraction in % (neg. or pos.);
931 * the default is 10% of the default zoom as saved in preferences.
932 * \li Origin: vfr, 30 Mar 2009
935 { LFUN_BUFFER_ZOOM_OUT, "buffer-zoom-out", ReadOnly, Buffer },
939 * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
940 * \li Action: Generates the code (literate programming).
941 * \li Notion: Latex file with extension \literate_extension is generated.
942 Then LyX invokes \build_command (with a default of ``make'') to generate the code and
943 \build_error_filter to process the compilation error messages. \n
944 In case you want to process your literate file with a script, or some other program,
945 just insert in your lyxrc file an entry with:\n
946 \build_command "my_script my_arguments" \n
947 The \build_error_filter differs from the \literate_error_filter only in that the
948 former will identify error messages from your compiler.
949 * \li Syntax: build-program
952 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
956 * \var lyx::FuncCode lyx::LFUN_CALL
957 * \li Action: Executes a command defined in a .def file.
958 * \li Notion: The definitions are by default read from lib/commands/default.def.\n
959 A .def file allows to define a command with \define "<NAME>" "<LFUN>"
960 where <NAME> is the name of the new command and <LFUN> is the lfun code
961 to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
962 \def_file "FileName" allows to include another .def file. \n
963 This is particularly useful in connection with toolbar buttons:
964 Since the name of the button image for this lfun is
965 lib/images/commands/<NAME>.png this is the way to assign an image
966 to a complex command-sequence.
967 * \li Syntax: call <NAME>
968 * \li Params: <NAME>: Name of the command that must be called.
969 * \li Origin: broider, 2 Oct 2007
972 { LFUN_CALL, "call", NoBuffer, System },
975 * \var lyx::FuncCode lyx::LFUN_CANCEL
976 * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
980 { LFUN_CANCEL, "cancel", NoBuffer, System },
984 * \var lyx::FuncCode lyx::LFUN_CAPTION_INSERT
985 * \li Action: Inserts a caption inset.
986 * \li Syntax: caption-insert
987 * \li Origin: Lgb, 18 Jul 2000
990 { LFUN_CAPTION_INSERT, "caption-insert", Noop, Edit },
993 * \var lyx::FuncCode lyx::LFUN_CELL_BACKWARD
994 * \li Action: Moves the cursor to the previous cell inside the table.
995 * \li Syntax: cell-backward
996 * \li Origin: Jug, 22 May 2000
999 { LFUN_CELL_BACKWARD, "cell-backward", ReadOnly | NoUpdate, Edit },
1002 * \var lyx::FuncCode lyx::LFUN_CELL_FORWARD
1003 * \li Action: Moves the cursor to the next cell inside the table.
1004 * \li Syntax: cell-forward
1007 { LFUN_CELL_FORWARD, "cell-forward", ReadOnly | NoUpdate, Edit },
1010 * \var lyx::FuncCode lyx::LFUN_CELL_SPLIT
1011 * \li Action: Splits cell and shifts right part to the next cell (inside the math grid).
1012 * \li Syntax: cell-split
1013 * \li Origin: Ale, 15 May 1997
1016 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
1020 * \var lyx::FuncCode lyx::LFUN_CHANGES_MERGE
1021 * \li Action: Open change tracking dialog for merging and moves the cursor
1022 to the position of the next change.
1023 * \li Syntax: changes-merge
1024 * \li Origin: Levon, 16 Oct 2002
1027 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
1030 * \var lyx::FuncCode lyx::LFUN_CHANGES_OUTPUT
1031 * \li Action: Toggles showing of change tracking in typeset output.
1032 * \li Syntax: changes-output
1033 * \li Origin: spitz, 21 Jan 2005
1036 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
1039 * \var lyx::FuncCode lyx::LFUN_CHANGES_TRACK
1040 * \li Action: Toggles change tracking to on/off.
1041 * \li Syntax: changes-track
1042 * \li Origin: levon, 1 Oct 2002
1045 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
1048 * \var lyx::FuncCode lyx::LFUN_CHANGE_ACCEPT
1049 * \li Action: Accepts tracked change inside the selection.
1050 * \li Syntax: change-accept
1051 * \li Origin: Levon, 16 Oct 2002
1054 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
1057 * \var lyx::FuncCode lyx::LFUN_CHANGE_NEXT
1058 * \li Action: Moves the cursor to the position of the next change
1059 of the change tracking records.
1060 * \li Syntax: change-next
1061 * \li Origin: schmitt, 4 Oct 2006
1064 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
1067 * \var lyx::FuncCode lyx::LFUN_CHANGE_PREVIOUS
1068 * \li Action: Moves the cursor to the position of the previous change
1069 of the change tracking records.
1070 * \li Syntax: change-previous
1071 * \li Origin: vfr, 4 Apr 2009
1074 { LFUN_CHANGE_PREVIOUS, "change-previous", ReadOnly, Edit },
1077 * \var lyx::FuncCode lyx::LFUN_CHANGE_REJECT
1078 * \li Action: Rejects tracked change inside the selection.
1079 * \li Syntax: change-reject
1080 * \li Origin: Levon, 16 Oct 2002
1083 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
1086 * \var lyx::FuncCode lyx::LFUN_CHARS_TRANSPOSE
1087 * \li Action: Transposes the character at the cursor with the one before it.
1088 * \li Syntax: chars-transpose
1089 * \li Origin: Lgb, 25 Apr 2001
1092 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
1096 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD
1097 * \li Action: Moves the cursor one position logically backwards.
1098 * \li Notion: This is not the action which should be bound to the arrow keys,
1099 because backwards may be left or right, depending on the
1100 language. The arrow keys should be bound to #LFUN_CHAR_LEFT or
1101 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
1102 * \li Syntax: char-backward
1105 { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit },
1108 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD_SELECT
1109 * \li Action: Moves the cursor one position logically backwards, adding
1110 traversed position to the selection.
1111 * \li Notion: See also #LFUN_CHAR_BACKWARD.
1112 * \li Syntax: char-backward-select
1115 { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit },
1118 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_BACKWARD
1119 * \li Action: Deletes one character in the backward direction (usually the "BackSpace" key).
1120 * \li Syntax: char-delete-backward [force]
1121 * \li Params: force: Delete big insets, do not only select them.
1124 { LFUN_CHAR_DELETE_BACKWARD, "char-delete-backward", SingleParUpdate, Edit },
1127 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_FORWARD
1128 * \li Action: Deletes one character in the backward direction (usually the "Delete" key).
1129 * \li Syntax: char-delete-forward [force]
1130 * \li Params: force: Delete big insets, do not only select them.
1133 { LFUN_CHAR_DELETE_FORWARD, "char-delete-forward", SingleParUpdate, Edit },
1136 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD
1137 * \li Action: Moves the cursor one position logically forward.
1138 * \li Notion: This is not the action which should be bound to the arrow keys,
1139 because forward may be left or right, depending on the language.
1140 The arrow keys should be bound to #LFUN_CHAR_LEFT or
1141 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
1142 * \li Syntax: char-forward
1145 { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit },
1148 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD_SELECT
1149 * \li Action: Moves the cursor one position logically forward, adding
1150 traversed position to the selection.
1151 * \li Notion: See also #LFUN_CHAR_FORWARD.
1152 * \li Syntax: char-forward-select
1155 { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit },
1158 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT
1159 * \li Action: Moves the cursor one position "to the left".
1160 * \li Notion: This is the action which should be taken when the "left" key
1161 is pressed. Generally, it moves the cursor one position to the
1162 left. However, in Bidi text this become slightly more
1163 complicated, and there are different modes of cursor movement.
1164 In "visual mode", this moves left, plain and simple. In "logical
1165 mode", movement is logically forward in RTL paragraphs, and
1166 logically backwards in LTR paragraphs.
1167 * \li Syntax: char-left
1170 { LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit },
1173 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT_SELECT
1174 * \li Action: Moves the cursor one position "to the left", adding
1175 traversed position to the selection.
1176 * \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement.
1177 * \li Syntax: char-left-select
1180 { LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit },
1183 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT
1184 * \li Action: Moves the cursor one position "to the right".
1185 * \li Notion: This is the action which should be taken when the "right" key
1186 is pressed. Generally, it moves the cursor one position to the
1187 right. However, in Bidi text this become slightly more
1188 complicated, and there are different modes of cursor movement.
1189 In "visual mode", this moves right, plain and simple. In "logical
1190 mode", movement is logically forward in LTR paragraphs, and
1191 logically backwards in RTL paragraphs.
1192 * \li Syntax: char-right
1195 { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit },
1198 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT_SELECT
1199 * \li Action: Moves the cursor one position "to the right", adding
1200 traversed position to the selection.
1201 * \li Notion: See also #LFUN_CHAR_RIGHT for exact details of the movement.
1202 * \li Syntax: char-right-select
1205 { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit },
1209 * \var lyx::FuncCode lyx::LFUN_CITATION_INSERT
1210 * \li Action: Inserts citation from loaded citation database.
1211 * \li Syntax: citation-insert [<KEY>[|<TEXT_BEFORE>]]
1212 * \li Params: <KEY>: Citation (shortcut listed in available citations). \n
1213 <TEXT_BEFORE>: text which should appear before citation.
1214 * \li Origin: AAS, 97-02-23
1217 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
1220 * \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE
1221 * \li Action: Pastes text from the active clipboard (retains formatting if the
1222 clipboard contains formatted text). Pastes plain text if plain text is
1223 on the clipboard, but tries to interpret it in special ways for certain
1224 insets, e.g. converting csv data to rows and columns if the paste happens
1226 * \li Notion: Historically, LFUN_CLIPBOARD_PASTE was introduced as a counterpart of
1227 LFUN_PRIMARY_SELECTION_PASTE: It behaved exactly the same, but the source
1228 is the clipboard, not the selection.
1229 * \li Syntax: clipboard-paste [<ARG>]
1230 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1231 * \li Origin: Georg, 10 Jul 2006
1234 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
1237 * \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE_SIMPLE
1238 * \li Action: Pastes plain text from the active clipboard even if formatted
1239 LyX content is in the clipboard. Pastes plain text if plain text
1240 is on the clipboard, without trying to interpret it in special
1241 ways for certain insets, e.g. converting csv data to rows and
1242 columns if the paste happens in a tabular inset.
1243 * \li Syntax: clipboard-paste-simple [<ARG>]
1244 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1247 { LFUN_CLIPBOARD_PASTE_SIMPLE, "clipboard-paste-simple", Noop, Edit },
1250 * \var lyx::FuncCode lyx::LFUN_COMMAND_ALTERNATIVES
1251 * \li Action: Runs the first listed command that is enabled.
1252 * \li Notion: This can be used to bind multiple functions to a single key,
1253 and then which one is used will depend upon the context.
1254 * \li Syntax: command-alternatives <CMDS>
1255 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
1256 * \li Sample: command-alternatives completion-accept;cell-forward
1257 * \li Origin: rgh, 24 September 2008
1260 { LFUN_COMMAND_ALTERNATIVES, "command-alternatives", NoBuffer, System },
1263 * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
1264 * \li Action: Switches the focus to the minibuffer so that the user can type
1265 in there. If necessary, it opens the minibuffer toolbar.
1266 * \li Notion: Usually bound to M-x shortcut.
1267 * \li Syntax: command-execute
1270 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
1274 * \var lyx::FuncCode lyx::LFUN_COMMAND_PREFIX
1275 * \li Action: Return the current key sequence and available options as a string.
1276 * \li Notion: No options are added if no current map exists. \n
1277 This is probably usable only with connection to lyxserver.
1278 * \li Syntax: command-prefix
1281 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
1284 * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
1285 * \li Action: Run more commands (LFUN and its parameters) in a sequence.
1286 * \li Syntax: command-sequence <CMDS>
1287 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
1288 * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
1289 * \li Origin: Andre, 11 Nov 1999
1292 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
1295 * \var lyx::FuncCode lyx::LFUN_COMPLETE
1296 * \li Action: Try to complete the word or command at the cursor position.
1297 * \li Syntax: complete
1298 * \li Origin: sts, Feb 19 2008
1301 { LFUN_COMPLETE, "complete", SingleParUpdate, Edit },
1305 * \var lyx::FuncCode lyx::LFUN_COMPLETION_ACCEPT
1306 * \li Action: Accept suggested completion.
1307 * \li Syntax: completion-accept
1308 * \li Origin: sanda, Sep 08 2008
1311 { LFUN_COMPLETION_ACCEPT, "completion-accept", SingleParUpdate, Edit },
1316 * \var lyx::FuncCode lyx::LFUN_COMPLETION_CANCEL
1317 * \li Action: Try to cancel completion, either the popup or the inline completion.
1318 * \li Syntax: completion-cancel
1319 * \li Origin: sts, Sep 07 2008
1322 { LFUN_COMPLETION_CANCEL, "completion-cancel", SingleParUpdate, Edit },
1325 * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
1326 * \li Action: Show the inline completion at the cursor position.
1327 * \li Syntax: completion-inline
1328 * \li Origin: sts, Feb 19 2008
1331 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
1334 * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
1335 * \li Action: Show the completion popup at the cursor position.
1336 * \li Syntax: completion-popup
1337 * \li Origin: sts, Feb 19 2008
1340 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
1343 * \var lyx::FuncCode lyx::LFUN_COPY
1344 * \li Action: Copies the current selection to the clipboard.
1348 { LFUN_COPY, "copy", ReadOnly, Edit },
1351 * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
1352 * \li Action: Determine whether to keep cursor inside the editing window regardless
1353 of the scrollbar movement.
1354 * \li Syntax: toggle-cursor-follows-scrollbar
1355 * \li Origin: ARRae, 2 Dec 1997
1358 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
1361 * \var lyx::FuncCode lyx::LFUN_CUT
1362 * \li Action: Cuts to the clipboard.
1366 { LFUN_CUT, "cut", Noop, Edit },
1369 * \var lyx::FuncCode lyx::LFUN_DATE_INSERT
1370 * \li Action: Inserts the current date.
1371 * \li Syntax: date-insert [<ARG>]
1372 * \li Params: <ARG>: Format of date. The default value (%x) can be set
1373 in Preferences->Output->General->Date format. For
1374 possible formats see the manual page of the
1376 * \li Origin: jdblair, 31 Jan 2000
1379 { LFUN_DATE_INSERT, "date-insert", Noop, Edit },
1382 * \var lyx::FuncCode lyx::LFUN_DEBUG_LEVEL_SET
1383 * \li Action: Set debug output level.
1384 * \li Syntax: debug-level-set <LEVEL>
1385 * \li Params: <LEVEL>: comma separated list of levels or the correspondent number
1386 of their combination. 0 is equivalent to disabling all debug
1387 events. See lyx -dbg for the current list of debug levels
1389 * \li Origin: sanda, 28 Dec 2009
1392 { LFUN_DEBUG_LEVEL_SET, "debug-level-set", NoBuffer, System },
1396 * \var lyx::FuncCode lyx::LFUN_DEPTH_DECREMENT
1397 * \li Action: Decrease the nesting depth of the (selected) paragraph(s)
1399 * \li Syntax: depth-decrement
1402 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
1405 * \var lyx::FuncCode lyx::LFUN_DEPTH_INCREMENT
1406 * \li Action: Increase the nesting depth of the (selected) paragraph(s)
1408 * \li Syntax: depth-increment
1411 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
1415 * \var lyx::FuncCode lyx::LFUN_DEVEL_MODE_TOGGLE
1416 * \li Action: toggle a mode where more information is given in UI
1417 * \li Syntax: devel-mode-toggle
1418 * \li Notion: in so called "devel" mode, the information given in the
1419 * status bar is more precise, and the help documents are
1420 * open in editing mode.
1421 * \li Origin: lasgouttes, 23 Jul 2017
1424 { LFUN_DEVEL_MODE_TOGGLE, "devel-mode-toggle", NoBuffer, System },
1428 * \var lyx::FuncCode lyx::LFUN_DIALOG_DISCONNECT_INSET
1429 * \li Action: Closes opened connection to opened inset.
1430 * \li Notion: Connection is used for apply functions.
1431 * \li Syntax: dialog-disconnect-inset <INSET-NAME>
1432 * \li Origin: leeming, 25 Feb 2003
1435 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
1439 * \var lyx::FuncCode lyx::LFUN_DIALOG_HIDE
1440 * \li Action: Hides showed dialog. Counterpart to #LFUN_DIALOG_SHOW .
1441 * \li Syntax: dialog-hide <NAME>
1442 * \li Params: See #LFUN_DIALOG_SHOW .
1443 * \li Origin: leeming, 25 Feb 2003
1446 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
1449 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW
1450 * \li Action: Shows hidden dialog or creates new one for a given function/inset settings etc.
1451 * \li Syntax: dialog-show <NAME> [<DATA>]
1452 * \li Params: <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|\n
1453 compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|\n
1454 graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimiter|\n
1455 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|\n
1456 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|\n
1457 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL> \n
1458 <SPECIAL>: latexlog|vclog \n
1459 <DATA>: data, usually settings for the given dialog. Use debug mode for the
1461 * \li Origin: leeming, 17 Jun 2003
1464 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
1467 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW_NEW_INSET
1468 * \li Action: Shows hidden dialog or create new one for a given inset settings etc.
1469 * \li Notion: Internally uses #LFUN_DIALOG_SHOW with processed data for a given inset.
1470 * \li Syntax: dialog-show-new-inset <NAME> [<DATA>]
1471 * \li Params: See #LFUN_DIALOG_SHOW .
1472 * \li Origin: leeming, 25 Feb 2003
1475 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
1478 * \var lyx::FuncCode lyx::LFUN_DIALOG_TOGGLE
1479 * \li Action: Toggles dialog between showed/hidden state.
1480 * \li Notion: Internally uses #LFUN_DIALOG_SHOW , #LFUN_DIALOG_HIDE .
1481 * \li Syntax: dialog-toggle <NAME> [<DATA>]
1482 * \li Params: See #LFUN_DIALOG_SHOW .
1483 * \li Origin: spitz, 30 Apr 2007
1486 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
1489 * \var lyx::FuncCode lyx::LFUN_DIALOG_UPDATE
1490 * \li Action: Updates the dialog values from the inset/paragraph/document.
1491 * \li Syntax: dialog-update <NAME>
1492 * \li Params: <NAME>: paragraph|prefs|<INSET> \n
1494 * \li Origin: leeming, 25 Feb 2003
1497 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
1500 * \var lyx::FuncCode lyx::LFUN_DOWN
1501 * \li Action: Moves the cursor one line in downward direction.
1505 { LFUN_DOWN, "down", ReadOnly | NoUpdate, Edit },
1508 * \var lyx::FuncCode lyx::LFUN_DOWN_SELECT
1509 * \li Action: Moves the cursor one line in downward direction adding the current
1510 position to the selection.
1511 * \li Syntax: down-select
1514 { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, Edit },
1517 * \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE
1518 * \li Action: Displays list of layout choices.
1519 * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
1520 dropbox allowing for choice of layout.
1521 * \li Syntax: drop-layouts-choice
1524 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
1527 * \var lyx::FuncCode lyx::LFUN_ENVIRONMENT_SPLIT
1528 * \li Action: Splits the current environment with a Separator.
1529 * \li Syntax: environment-split [before|outer|previous]
1530 * \li Params: outer: If this is given, LyX will split the outermost environment in
1531 the current nesting hierarchy.\n
1532 previous: If this is given, LyX will split the environment in the previous
1533 paragraph (is there is one).\n
1534 before: If this is given, the new environment will be appended rather than
1536 * \li Origin: spitz, 23 Dec 2012
1539 { LFUN_ENVIRONMENT_SPLIT, "environment-split", Noop, Layout },
1543 * \var lyx::FuncCode lyx::LFUN_ERT_INSERT
1544 * \li Action: Inserts an ERT inset.
1545 * \li Syntax: ert-insert
1546 * \li Origin: Jug, 18 Feb 2000
1549 { LFUN_ERT_INSERT, "ert-insert", Noop, Edit },
1552 * \var lyx::FuncCode lyx::LFUN_ESCAPE
1553 * \li Action: Clears the selection. If no text is selected call #LFUN_FINISHED_FORWARD.
1554 Inside math mode jumps out of the math inset.
1555 * \li Syntax: escape
1556 * \li Origin: Lgb, 17 May 2001
1559 { LFUN_ESCAPE, "escape", ReadOnly, Edit },
1562 * \var lyx::FuncCode lyx::LFUN_EXPORT_CANCEL
1563 * \li Action: Cancel background export process.
1564 * \li Syntax: export-cancel
1565 * \li Origin: rgh, 10 December 2017
1568 { LFUN_EXPORT_CANCEL, "export-cancel", ReadOnly | NoUpdate | NoInternal, Edit },
1571 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
1572 * \li Action: Inserts another LyX file.
1573 * \li Syntax: file-insert [<FILE>]
1574 * \li Params: <FILE>: Filename to be inserted.
1577 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
1580 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
1581 * \li Action: Inserts plain text file.
1582 * \li Syntax: file-insert-plaintext [<FILE>]
1583 * \li Params: <FILE>: Filename to be inserted.
1584 * \li Origin: CFO-G, 19 Nov 1997
1587 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
1590 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
1591 * \li Action: Inserts plain text file as paragraph (i.e. join lines).
1592 * \li Syntax: file-insert-plaintext-para [<FILE>]
1593 * \li Params: <FILE>: Filename to be inserted.
1594 * \li Origin: Levon, 14 Feb 2001
1597 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
1600 * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
1601 * \li Action: Open LyX document.
1602 * \li Syntax: file-open [<FILE>]
1603 * \li Params: <FILE>: Filename to be opened.
1606 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
1610 * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
1611 * \li Action: Moves the cursor out of the current slice, going backwards.
1612 * \li Notion: See also #LFUN_FINISHED_FORWARD.
1615 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
1618 * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
1619 * \li Action: Moves the cursor out of the current slice, going forward.
1620 * \li Notion: Cursor movement within an inset may be different than cursor
1621 movement in the surrounding text. This action should be called
1622 automatically by the cursor movement within the inset, when
1623 movement within the inset has ceased (reached the end of the
1624 last paragraph, for example), in order to move correctly
1625 back into the surrounding text.
1628 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
1631 * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
1632 * \li Action: Moves the cursor out of the current slice, going left.
1633 * \li Notion: See also #LFUN_FINISHED_FORWARD.
1636 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
1640 * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
1641 * \li Action: Moves the cursor out of the current slice, going right.
1642 * \li Notion: See also #LFUN_FINISHED_FORWARD
1645 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
1648 * \var lyx::FuncCode lyx::LFUN_FLEX_INSERT
1649 * \li Action: Inserts CharStyle, Custom inset or XML short element.
1650 * \li Notion: Look into the Customization manual for more information about
1652 To make this command enabled the layout file for the document
1653 class you're using has to load the character styles. There are
1654 a few contained in the Logical Markup module. You can also of
1655 course create some yourself. \n
1656 For dissolving the element see #LFUN_INSET_DISSOLVE.
1657 * \li Syntax: flex-insert Name
1658 * \li Params: Name: This name must be defined either in your layout file
1659 or imported by some module. The definition is
1660 InsetLayout Name or InsetLayout <Flex:Name>. The Flex:
1662 * \li Sample: flex-insert Code
1665 { LFUN_FLEX_INSERT, "flex-insert", Noop, Edit },
1668 * \var lyx::FuncCode lyx::LFUN_FLOAT_INSERT
1669 * \li Action: Inserts a float inset.
1670 * \li Syntax: float-insert <TYPE>
1671 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
1672 "algorithm", "table", "figure" parameters can be given.
1673 * \li Origin: Lgb, 27 Jun 2000
1676 { LFUN_FLOAT_INSERT, "float-insert", Noop, Edit },
1679 * \var lyx::FuncCode lyx::LFUN_FLOAT_LIST_INSERT
1680 * \li Action: Inserts the list of floats in the document.
1681 * \li Syntax: float-list-insert <TYPE>
1682 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
1683 "algorithm", "table", "figure" parameters can be given.
1684 * \li Origin: Lgb, 3 May 2001
1687 { LFUN_FLOAT_LIST_INSERT, "float-list-insert", Noop, Edit },
1690 * \var lyx::FuncCode lyx::LFUN_FLOAT_WIDE_INSERT
1691 * \li Action: Inserts float insets as in #LFUN_FLOAT_INSERT but span multiple columns.
1692 * \li Notion: Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
1693 * \li Syntax: float-wide-insert <TYPE>
1694 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
1695 "algorithm", "table", "figure" parameters can be given.
1696 * \li Origin: Lgb, 31 Oct 2001
1699 { LFUN_FLOAT_WIDE_INSERT, "float-wide-insert", Noop, Edit },
1702 * \var lyx::FuncCode lyx::LFUN_FONT_BOLD
1703 * \li Action: Toggles the bold font (selection-wise) using mathbf in math.
1704 * \li Syntax: font-bold
1707 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
1711 * \var lyx::FuncCode lyx::LFUN_FONT_BOLDSYMBOL
1712 * \li Action: Toggles the bold font (selection-wise) using boldsymbol in math.
1713 * \li Syntax: font-boldsymbol
1716 { LFUN_FONT_BOLDSYMBOL, "font-boldsymbol", Noop, Layout },
1719 * \var lyx::FuncCode lyx::LFUN_FONT_DEFAULT
1720 * \li Action: Reverts the settings of the font to the default values (selection-wise).
1721 * \li Syntax: font-default
1724 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
1727 * \var lyx::FuncCode lyx::LFUN_FONT_EMPH
1728 * \li Action: Toggles the emphasis font style (selection-wise).
1729 * \li Syntax: font-emph
1732 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
1735 * \var lyx::FuncCode lyx::LFUN_FONT_FRAK
1736 * \li Action: Toggles Fraktur family font (math-mode, selection-wise).
1737 * \li Syntax: font-frak
1738 * \li Origin: vermeer, 10 Jan 2002
1741 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
1744 * \var lyx::FuncCode lyx::LFUN_FONT_ITAL
1745 * \li Action: Toggles Italics font shape (math-mode, selection-wise).
1746 * \li Syntax: font-ital
1747 * \li Origin: vermeer, 10 Jan 2002
1750 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
1753 * \var lyx::FuncCode lyx::LFUN_FONT_NOUN
1754 * \li Action: Toggles Noun text style font (selection-wise).
1755 * \li Syntax: font-noun
1758 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
1761 * \var lyx::FuncCode lyx::LFUN_FONT_ROMAN
1762 * \li Action: Toggles Roman family font (selection-wise).
1763 * \li Syntax: font-roman
1766 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
1769 * \var lyx::FuncCode lyx::LFUN_FONT_SANS
1770 * \li Action: Toggles Sans Serif family font (selection-wise).
1771 * \li Syntax: font-sans
1774 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
1777 * \var lyx::FuncCode lyx::LFUN_FONT_SIZE
1778 * \li Action: Sets font size according to lyx format string.
1779 * \li Syntax: font-size <SIZE>
1780 * \li Params: <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|\n
1781 largest|huge|giant|increase|decrease|default
1784 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
1787 * \var lyx::FuncCode lyx::LFUN_FONT_STATE
1788 * \li Action: Returns the info about the current font.
1789 * \li Syntax: font-state
1792 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
1796 * \var lyx::FuncCode lyx::LFUN_FONT_STRIKEOUT
1797 * \li Action: Toggles strikeout (strike-through) in the font (selection-wise).
1798 * \li Syntax: font-strikeout
1799 * \li Origin: sanda, 3 May 2009
1802 { LFUN_FONT_STRIKEOUT, "font-strikeout", Noop, Layout },
1805 * \var lyx::FuncCode lyx::LFUN_FONT_CROSSOUT
1806 * \li Action: Toggles xout (cross-through) in the font (selection-wise).
1807 * \li Syntax: font-crossout
1808 * \li Origin: uwestoehr, 4 April 2017
1811 { LFUN_FONT_CROSSOUT, "font-crossout", Noop, Layout },
1814 * \var lyx::FuncCode lyx::LFUN_FONT_TYPEWRITER
1815 * \li Action: Toggles the typewriter family font (selection-wise).
1816 * \li Syntax: font-typewriter
1819 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
1822 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERLINE
1823 * \li Action: Toggles underline in the font (selection-wise).
1824 * \li Syntax: font-underline
1827 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
1830 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERUNDERLINE
1831 * \li Action: Toggles double underline in the font (selection-wise).
1832 * \li Syntax: font-underunderline
1833 * \li Origin: sanda, 5 May 2009
1836 { LFUN_FONT_UNDERUNDERLINE, "font-underunderline", Noop, Layout },
1839 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERWAVE
1840 * \li Action: Toggles wavy underline in the font (selection-wise).
1841 * \li Syntax: font-underwave
1842 * \li Origin: sanda, 5 May 2009
1845 { LFUN_FONT_UNDERWAVE, "font-underwave", Noop, Layout },
1848 * \var lyx::FuncCode lyx::LFUN_FOOTNOTE_INSERT
1849 * \li Action: Inserts a footnote inset.
1850 * \li Syntax: footnote-insert
1851 * \li Origin: Jug, 7 Mar 2000
1854 { LFUN_FOOTNOTE_INSERT, "footnote-insert", Noop, Edit },
1857 * \var lyx::FuncCode lyx::LFUN_FORWARD_SEARCH
1858 * \li Action: Sets the cursor position in the previewed (dvi/pdf) file based on the row
1859 number in LyX window.
1860 * \li Notion: The external program used for forward search call can be specified in
1861 LyX Output preferences. See Additional manual for details of these
1863 * \li Syntax: forward-search
1864 * \li Origin: sanda, 14 Apr 2010
1867 { LFUN_FORWARD_SEARCH, "forward-search", ReadOnly, System },
1870 * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
1871 * \li Action: Open the given help file according to the language setting.
1872 * \li Syntax: help-open <FILE>[.lyx]
1873 * \li Params: <FILE>: any document from (/usr/share/)doc directory.
1874 * \li Origin: Jug, 27 Jun 1999
1877 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
1880 * \var lyx::FuncCode lyx::LFUN_HREF_INSERT
1881 * \li Action: Inserts hyperlinks into the document (clickable in pdf output).
1882 * \li Notion: Hyperlink target can be set via selection + hyperlink-insert function.
1883 * \li Syntax: href-insert [<TARGET>]
1884 * \li Origin: CFO-G, 21 Nov 1997
1887 { LFUN_HREF_INSERT, "href-insert", Noop, Edit },
1890 * \var lyx::FuncCode lyx::LFUN_ICON_SIZE
1891 * \li Action: Sets icon size of toolbars.
1892 * \li Syntax: icon-size [<SIZE>]
1893 * \li Params: <SIZE> : the icon size in px or one of the logical settings
1894 small|normal|big|huge|giant, the default is normal
1895 (whose size in px is icon set dependent).
1896 * \li Origin: 11 July 2016
1899 { LFUN_ICON_SIZE, "icon-size", NoBuffer, Buffer },
1902 * \var lyx::FuncCode lyx::LFUN_INDEX_INSERT
1903 * \li Action: Inserts Index entry.
1904 * \li Notion: It automatically takes the word on the cursor position.
1905 * \li Syntax: index-insert [<TYPE:Name>]
1906 * \li Params: <TYPE:Name>: name of the index, if multiple indices are defined.
1907 With an empty argument, the default index is selected.
1908 * \li Origin: leeming, 3 Aug 2000
1911 { LFUN_INDEX_INSERT, "index-insert", Noop, Edit },
1914 * \var lyx::FuncCode lyx::LFUN_INDEX_PRINT
1915 * \li Action: Inserts list of Index entries on a new page.
1916 * \li Syntax: index-print [<TYPE:Name>]
1917 * \li Params: <TYPE:Name>: name of the index, if multiple indices are defined.
1918 With an empty argument, the default index is selected.
1919 * \li Origin: Lgb, 27 Feb 1997
1922 { LFUN_INDEX_PRINT, "index-print", Noop, Edit },
1925 * \var lyx::FuncCode lyx::LFUN_INFO_INSERT
1926 * \li Action: Displays shortcuts, lyxrc, package and textclass availability and menu
1927 information in a non-editable boxed InsetText.
1928 * \li Notion: Apart from lfun arguments you can use the following method: \n
1929 1. input the type and argument of this inset, e.g. "menu paste", in
1931 2. select the text and run info-insert lfun.
1932 * \li Syntax: info-insert <TYPE> <ARG>
1933 * \li Params: <TYPE>: shortcut[s]|lyxrc|lyxinfo|package|textclass|menu|icon|buffer \n
1934 <ARG>: argument for a given type. Look into InsetInfo.h for detailed
1936 date: current date (formatted and localized)\n
1937 moddate: date of last modification (saving) (formatted and localized)\n
1938 fixdate: a static date (formatted and localized)\n
1939 time: current time (formatted and localized)\n
1940 modtime: time of last modification (saving) (formatted and localized)\n
1941 fixtime: a static time (formatted and localized)\n
1942 shortcut[s]: name of lfun (e.g math-insert \alpha) \n
1943 lyxrc: name of rc_entry (e.g. bind_file) \n
1944 lyxinfo: "version" - used version of LyX \n
1945 package: name of latex package (e.g. listings) \n
1946 textclass: name of textclass (e.g. article) \n
1947 menu: name of lfun used in menu \n
1948 icon: icon of lfun used in toolbar or direct icon name\n
1949 buffer: "name"|"name-noext"|"path"|"class"
1950 vcs: "tree-revision"|"revision"|"author"|"date"|"time"
1951 * \li Sample: command-sequence info-insert buffer path; info-insert buffer name
1952 * \li Origin: bpeng, 7 Oct 2007
1955 { LFUN_INFO_INSERT, "info-insert", Noop, Edit },
1958 * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
1959 * \li Action: Apply data for an inset.
1960 * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
1961 be applied. This is either changed to #LFUN_INSET_MODIFY or
1962 #LFUN_INSET_INSERT depending on the context where it is called.
1963 * \li Syntax: inset-apply <ARGS>
1964 * \li Params: See #LFUN_INSET_INSERT .
1967 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
1970 * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN
1971 * \li Action: Move the cursor to the beginning of the current inset
1972 if it is not already there. If the cursor is already at
1973 the beginning of the current inset, move it to the
1974 beginning of the enclosing inset or the main work area,
1975 respectively, if there is no enclosing inset.
1976 * \li Syntax: inset-begin
1977 * \li Origin: lasgouttes, 16 Mar 2009
1980 { LFUN_INSET_BEGIN, "inset-begin", ReadOnly, Edit },
1983 * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN_SELECT
1984 * \li Action: Move the cursor to the beginning of the current inset
1985 if it is not already there. If the cursor is already at
1986 the beginning of the current inset, move it to the
1987 beginning of the enclosing inset or the main work area,
1988 respectively, if there is no enclosing inset (adding the
1989 traversed text to the selection).
1990 * \li Syntax: inset-begin-select
1991 * \li Origin: lasgouttes, 16 Mar 2009
1994 { LFUN_INSET_BEGIN_SELECT, "inset-begin-select", ReadOnly, Edit },
1997 * \var lyx::FuncCode lyx::LFUN_INSET_COPY_AS
1998 * \li Action: Copies the inset to the clipboard as a certain type.
1999 * \li Notion: Currently used only for InsetInfo where its content is copied as a text.
2000 * \li Syntax: inset-copy-as
2001 * \li Origin: vfr, 18 Apr 2010
2004 { LFUN_INSET_COPY_AS, "inset-copy-as", ReadOnly | NoUpdate | AtPoint, Edit },
2008 * \var lyx::FuncCode lyx::LFUN_INSET_DIALOG_UPDATE
2009 * \li Action: Updates the values inside the dialog from the inset.
2010 * \li Notion: This is an internal LFUN, not to be used by users. Called internally
2011 by #LFUN_DIALOG_UPDATE
2012 * \li Params: <DIALOG-NAME>
2013 * \li Origin: leeming, 25 Feb 2003
2016 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
2019 * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE
2020 * \li Action: Dissolve the current inset into text.
2021 * \li Syntax: inset-dissolve [<INSET>]
2022 * \li Params: <INSET>: this can be used to make sure the right kind of inset
2023 is dissolved. For example "dissolve" entry in the charstyles
2024 sub-menu should only dissolve the charstyle inset, even if the
2025 cursor is inside several nested insets of different type.\n
2026 For values see #lyx::InsetLayout::lyxtype_ .
2027 * \li Origin: JSpitz, 7 Aug 2006
2030 { LFUN_INSET_DISSOLVE, "inset-dissolve", AtPoint, Edit },
2033 * \var lyx::FuncCode lyx::LFUN_INSET_EDIT
2034 * \li Action: Edit the inset at cursor with an external application,
2035 if one is attributed.
2036 If the inset is file based, the referenced file is edited.
2037 Otherwise, the inset contents is written to a temporary file,
2038 the inset is locked, and the temporary file is edited.
2039 In this case, #LFUN_INSET_END_EDIT must be called to overtake
2040 the changes and unlock the inset after editing is finished.
2041 * \li Syntax: inset-edit [<INSET_PARAMS>]
2042 * \li Params: <INSET_PARAMS>: Parameters for the inset. \n
2043 Currently only the filename will be considered.
2044 * \li Origin: spitz, 27 Apr 2006
2047 { LFUN_INSET_EDIT, "inset-edit", ReadOnly | AtPoint, Edit },
2051 * \var lyx::FuncCode lyx::LFUN_INSET_END_EDIT
2052 * \li Action: End editing the inset at cursor with an external application.
2053 * This replaces the inset contents with the contents of the
2054 * temporary file, deletes the file and unlocks the inset.
2055 * \li Syntax: inset-end-edit
2056 * \li Origin: gb, 11 Oct 2015
2059 { LFUN_INSET_END_EDIT, "inset-end-edit", ReadOnly | AtPoint, Edit },
2062 * \var lyx::FuncCode lyx::LFUN_INSET_END
2063 * \li Action: Move the cursor to the end of the current inset if it
2064 is not already there. If the cursor is already at the
2065 end of the current inset, move it to the end of the
2066 enclosing inset or the main work area, respectively, if
2067 there is no enclosing inset.
2068 * \li Syntax: inset-end
2069 * \li Origin: lasgouttes, 16 Mar 2009
2072 { LFUN_INSET_END, "inset-end", ReadOnly, Edit },
2075 * \var lyx::FuncCode lyx::LFUN_INSET_END_SELECT
2076 * \li Action: Move the cursor to the end of the current inset if it
2077 is not already there. If the cursor is already at the
2078 end of the current inset, move it to the end of the
2079 enclosing inset or the main work area, respectively, if
2080 there is no enclosing inset (adding the
2081 traversed text to the selection).
2082 * \li Syntax: inset-end-select
2083 * \li Origin: lasgouttes, 16 Mar 2009
2086 { LFUN_INSET_END_SELECT, "inset-end-select", ReadOnly, Edit },
2090 * \var lyx::FuncCode lyx::LFUN_INSET_FORALL
2091 * \li Action: Apply the given commands on insets of a given name.
2092 * \li Notion: WARNING: use at your own risks; this function gives
2093 you too many ways of shooting yourself in the foot.
2094 A typical example is
2095 inset-forall Note note-insert
2096 which starts an infinite loop. This is mitigated by the fact
2097 that the number of actions is arbitrarily limited to 100000.
2098 Note also that inset-forall does not update metrics between
2099 iterations, which can lead to bugs. This has to be eventually
2101 * \li Syntax: inset-forall <NAME> <LFUN-COMMAND> \n
2102 <NAME>: Type of Inset. If <NAME> is *, all insets are matched.
2103 The name is used like for InsetLayout in layout files: "Note"
2104 matches all note insets, while "Note:Note" only matches LyX
2106 * \li Sample: Remove all index insets: \n
2107 inset-forall Index char-delete-forward force \n
2108 Close all Notes (also works for a particular branch, for example): \n
2109 inset-forall Note inset-toggle close \n
2110 Transform all yellow notes to comments \n
2111 inset-forall Note:Note inset-modify note Note Comment \n
2112 Try to put LyX in an infinite loop if there is at least a Note: \n
2113 inset-forall Note char-backward
2114 * \li Origin: lasgouttes, 27 Nov 2009
2117 { LFUN_INSET_FORALL, "inset-forall", ReadOnly, Edit },
2121 * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
2122 * \li Action: Insert new inset (type given by the parameters).
2123 * \li Syntax: inset-insert <INSET> <ARGS>
2124 * \li Params: <INSET>: <bibitem|bibtex|citation|ert|listings|external|graphics|tabular|\n
2125 hyperlink|include|index|label|line|nomencl|vspace|ref|toc|script>\n
2126 <ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
2127 * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
2128 where <label name> is the name of the referenced label and
2129 <Format> is one of the following: \n
2130 ref -- <reference> \n
2131 eqref -- (<reference>) \n
2132 pageref -- <page> \n
2133 vpageref -- on <page> \n
2134 vref -- <reference> on <page> \n
2135 formatted -- Formatted reference
2138 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
2141 * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
2142 * \li Action: Modify some properties of an inset.
2143 * \li Notion: Used for argument, bibitem, bibtex, box, branch, caption, citation,
2144 command, ert, external, float, graphics, include, index,
2145 info, label, line, listings, newline, newpage, nomencl,
2146 note, phantom, quotes, ref, script, separator, space,
2147 tabular, vspace and wrap insets.
2148 * \li Syntax: inset-modify <INSET> <ARGS> \n
2149 inset-modify changetype <TYPE>
2150 * \li Sample: Change a Note inset into a Comment inset: \n
2151 inset-modify note Note Comment \n
2152 Change a Box into an Ovalbox: \n
2153 inset-modify changetype Ovalbox \n
2154 Change a quotation mark to e[nglish style], l[eft side = opening], s[ingle = inner, secondary] \n
2155 inset-modify changetype els \n
2156 Change only the style of a quotation mark, maintaining the other aspects (. = wildcard) \n
2157 inset-modify changetype e.. \n
2160 { LFUN_INSET_MODIFY, "inset-modify", AtPoint, Edit },
2163 * \var lyx::FuncCode lyx::LFUN_INSET_SELECT_ALL
2164 * \li Action: Select all contents of an inset.
2165 * \li Notion: There are 3 successive levels: select current cell,
2166 * select all cells of inset, select the inset from outside
2167 * (in the enclosing inset).
2168 * \li Syntax: inset-select-all
2169 * \li Origin: vfr, 22 Aug 2009; lasgouttes 1 Nov 2014
2172 { LFUN_INSET_SELECT_ALL, "inset-select-all", ReadOnly, Edit },
2176 * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
2177 * \li Action: Open the inset's properties dialog.
2178 * \li Notion: Used for bibitem, bibtex, box, branch, citation, ert, external,
2179 float, graphics, href, include, index, index_print, label, line,
2180 listings, note, phantom, ref, space, tabular, vspace, wrap insets.
2181 * \li Syntax: inset-settings <INSET>
2182 * \li Params: <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|\n
2183 graphics|href|include|index|index_print|label|line|\n
2184 listings|note|phantom|ref|space|tabular|vspace|wrap>.
2187 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly | AtPoint, Edit },
2190 * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
2191 * \li Action: Toggles the collapsible inset at cursor position,
2192 or the inset we are currently in.
2193 * \li Syntax: inset-toggle [<ARG>]
2194 * \li Params: <ARG>: <open|close|toggle|assign>. \n
2195 open/close/toggle are for collapsible insets. toggle is used when no argument is given.\n
2196 assign synchronize the branch-inset with activation status of the branch.
2197 Used for global toggling when changed activation.
2198 * \li Origin: lasgouttes, 19 Jul 2001
2201 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly | AtPoint, Edit },
2204 * \var lyx::FuncCode lyx::LFUN_IN_IPA
2205 * \li Action: Only active in IPA inset.
2206 * \li Notion: Dummy function which is only active in a IPA inset.
2207 It's used to toggle the IPA toolbar if the cursor moves
2209 * \li Syntax: in-ipa
2210 * \li Origin: spitz, 20 May 2012
2213 { LFUN_IN_IPA, "in-ipa", Noop, Edit },
2216 * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
2217 * \li Action: Only active in Math Macro definition.
2218 * \li Notion: Dummy function which is only active in a Math Macro definition.
2219 It's used to toggle the Math Macro toolbar if the cursor moves
2220 into a Math Macro definition.
2221 * \li Syntax: in-mathmacrotemplate
2222 * \li Origin: sts, 06 January 2008
2225 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
2229 * \var lyx::FuncCode lyx::LFUN_IPAMACRO_INSERT
2230 * \li Action: Inserts special IPA macros into the document.
2231 * \li Syntax: ipamacro-insert <CHAR>
2232 * \li Params: <CHAR>: tone-falling, tone-rising, tone-high-rising, tone-low-rising,
2233 * tone-high-rising-falling, deco bottomtiebar, deco toptiebar.
2234 * \li Origin: spitz, 22 Aug 2012
2237 { LFUN_IPAMACRO_INSERT, "ipamacro-insert", Noop, Edit },
2240 * \var lyx::FuncCode lyx::LFUN_IPA_INSERT
2241 * \li Action: Inserts an IPA inset.
2242 * \li Syntax: ipa-insert
2243 * \li Origin: spitz, 05 Mar 2012
2246 { LFUN_IPA_INSERT, "ipa-insert", Noop, Edit },
2249 * \var lyx::FuncCode lyx::LFUN_KEYMAP_OFF
2250 * \li Action: Turn off the loaded keyboard map.
2251 * \li Syntax: keymap-off
2254 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
2257 * \var lyx::FuncCode lyx::LFUN_KEYMAP_PRIMARY
2258 * \li Action: Turn on the primary keyboard map.
2259 * \li Notion: Maps were widely used in past, when X-windows didn't have nowadays
2260 keyboard support. They can be still used to maintain uniform keyboard
2261 layout across the various platforms.\n
2262 The language is to be set in the Preferences dialog.
2263 * \li Syntax: keymap-primary
2266 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
2269 * \var lyx::FuncCode lyx::LFUN_KEYMAP_SECONDARY
2270 * \li Action: Turn on the secondary keyboard map.
2271 * \li Syntax: keymap-secondary
2274 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
2277 * \var lyx::FuncCode lyx::LFUN_KEYMAP_TOGGLE
2278 * \li Action: Toggles keyboard maps (first/second/off).
2279 * \li Syntax: keymap-toggle
2280 * \li Origin: leeming, 30 Mar 2004
2283 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
2287 * \var lyx::FuncCode lyx::LFUN_LABEL_COPY_AS_REF
2288 * \li Action: Copies the label at the cursor as a cross-reference to be pasted elsewhere.
2289 * \li Syntax: copy-label-as-reference <LABEL>
2290 * \li Params: <LABEL>: The label to copy (for multi-line math)
2291 * \li Origin: sts, 16 Nov 2008
2294 { LFUN_LABEL_COPY_AS_REFERENCE, "label-copy-as-reference",
2295 ReadOnly | NoUpdate | AtPoint, Edit },
2299 * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
2300 * \li Action: Goto a label.
2301 * \li Syntax: label-goto [<LABEL>]
2302 * \li Params: <LABEL>: Requested label. If no label is given and reference
2303 is on cursor position, Bookmark 0 is saved and
2304 cursor moves to the position of referenced label.
2305 * \li Origin: Ale, 6 Aug 1997
2308 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
2311 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT
2312 * \li Action: Inserts label to text or displayed formula.
2313 * \li Syntax: label-insert [<LABEL>]
2314 * \li Params: <LABEL>: Requested label. If no label is given dialog requesting
2315 name will be opened.
2318 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
2321 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT_AS_REFERENCE
2322 * \li Action: Inserts the label (in ToC pane) as a cross-reference at the position of the cursor.
2323 * \li Syntax: label-insert-as-reference
2324 * \li Origin: vfr, 7 Apr 2009
2327 { LFUN_LABEL_INSERT_AS_REFERENCE, "label-insert-as-reference", Noop, Edit},
2331 * \var lyx::FuncCode lyx::LFUN_LANGUAGE
2332 * \li Action: Set language from the current cursor position.
2333 * \li Syntax: language <LANG> [set]
2334 * \li Params: <LANG>: Requested language. Look in lib/languages for
2335 the list. "language reset" or "language" (without param)
2336 reset to the document language.
2337 set: If used, the language will be set to the specified
2338 language. Otherwise, the language will be toggled (i.e., if
2339 the current language is LANG, switch to the document language
2340 or the default language, if LANG is the document language).
2341 * \li Origin: Dekel, 2 Mar 2000
2344 { LFUN_LANGUAGE, "language", Noop, Edit },
2348 * \var lyx::FuncCode lyx::LFUN_LAYOUT
2349 * \li Action: Sets the layout (that is, environment) for the current paragraph.
2350 * \li Syntax: layout <LAYOUT> [ignorenests]
2351 * \li Params: <LAYOUT>: the layout to use\n
2352 ignorenests: If specified, nesting advices will be ignored.
2355 { LFUN_LAYOUT, "layout", Noop, Layout },
2358 * \var lyx::FuncCode lyx::LFUN_LAYOUT_TOGGLE
2359 * \li Action: Toggles the layout (that is, environment) for the current paragraph.
2360 * \li Notion: Contrary to `layout', this function resets the current
2361 * (or selection) layout to the standard layout it already has the
2362 * correct layout. Useful for toolbar icons.
2363 * \li Syntax: layout-toggle <LAYOUT> [ignorenests]
2364 * \li Params: <LAYOUT>: the layout to toggle\n
2365 ignorenests: If specified, nesting advices will be ignored.
2366 * \li Origin: lasgouttes, 14 May 2018
2369 { LFUN_LAYOUT_TOGGLE, "layout-toggle", Noop, Layout },
2372 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
2373 * \li Action: Clears the module list.
2374 * \li Notion: Clears the list of included modules for the current buffer.
2375 * \li Syntax: layout-modules-clear
2376 * \li Origin: rgh, 25 August 2007
2379 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", NoInternal, Layout },
2382 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULE_ADD
2383 * \li Action: Adds a module.
2384 * \li Notion: Adds a module to the list of included modules for the current buffer.
2385 * \li Syntax: layout-module-add <MODULE>
2386 * \li Params: <MODULE>: the module to be added
2387 * \li Origin: rgh, 25 August 2007
2390 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", NoInternal, Layout },
2393 * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH
2394 * \li Action: Launches the paragraph settings dialog.
2395 * \li Syntax: layout-paragraph
2398 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
2401 * \var lyx::FuncCode lyx::LFUN_LAYOUT_RELOAD
2402 * \li Action: Reloads layout information.
2403 * \li Notion: Reloads all layout information for the current buffer from disk, thus
2404 recognizing any changes that have been made to layout files on the fly.
2405 This is intended to be used only by layout developers and should not be
2406 used when one is trying to do actual work.
2407 * \li Syntax: layout-reload
2408 * \li Origin: rgh, 3 September 2007
2411 { LFUN_LAYOUT_RELOAD, "layout-reload", NoInternal, Layout },
2414 * \var lyx::FuncCode lyx::LFUN_LAYOUT_TABULAR
2415 * \li Action: Launches the tabular settings dialog.
2416 * \li Syntax: layout-tabular
2417 * \li Origin: Jug, 31 Jul 2000
2420 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
2423 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN
2424 * \li Action: Move the cursor to the beginning of the (screen) line.
2425 * \li Syntax: line-begin
2428 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
2431 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN_SELECT
2432 * \li Action: Move the cursor to the beginning of the (screen) line adding the
2433 traversed text to the selection.
2434 * \li Syntax: line-begin-select
2437 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
2440 * \var lyx::FuncCode lyx::LFUN_LINE_DELETE_FORWARD
2441 * \li Action: Deletes the letters to the end of the (screen) line or
2442 deletes the selection.
2443 * \li Syntax: line-delete-forward
2446 { LFUN_LINE_DELETE_FORWARD, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
2449 * \var lyx::FuncCode lyx::LFUN_LINE_END
2450 * \li Action: Move the cursor to the end of the (screen) line.
2451 * \li Syntax: line-end
2454 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
2457 * \var lyx::FuncCode lyx::LFUN_LINE_END_SELECT
2458 * \li Action: Move the cursor to the end of the (screen) line adding the
2459 traversed text to the selection.
2460 * \li Syntax: line-end-select
2463 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
2466 * \var lyx::FuncCode lyx::LFUN_LISTING_INSERT
2467 * \li Action: Inserts a new listings inset.
2468 * \li Syntax: listing-insert
2469 * \li Origin: Herbert, 10 Nov 2001; bpeng, 2 May 2007
2472 { LFUN_LISTING_INSERT, "listing-insert", Noop, Edit },
2475 * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
2476 * \li Action: Apply the given settings to user preferences.
2477 * \li Syntax: lyxrc-apply <SETTINGS>
2478 * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
2479 to get an idea which commands to use and their syntax.
2480 #lyx::LyXRC::LyXRCTags has the list of possible commands.
2483 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
2486 * \var lyx::FuncCode lyx::LFUN_LYX_ACTIVATE
2487 * \li Action: Activates the LyX window.
2488 * \li Notion: On Linux and Mac OS, this action brings the LyX window
2489 into focus. Such behavior is not allowed by Windows OS
2490 so instead the color of the taskbar entry is changed to
2491 indicate that the window has changed in some way.
2492 This action is useful in combination with reverse search.
2493 * \li Syntax: lyx-activate
2494 * \li Origin: skostysh, 4 Aug 2016
2497 { LFUN_LYX_ACTIVATE, "lyx-activate", ReadOnly | NoBuffer, Hidden },
2500 * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
2501 * \li Action: Terminates the current LyX instance.
2502 * \li Notion: Terminates the current LyX instance, asking whether to save
2503 modified documents, etc.
2504 * \li Syntax: lyx-quit
2507 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
2510 * \var lyx::FuncCode lyx::LFUN_MARGINALNOTE_INSERT
2511 * \li Action: Inserts a marginal note.
2512 * \li Syntax: marginalnote-insert
2513 * \li Origin: Lgb, 26 Jun 2000
2516 { LFUN_MARGINALNOTE_INSERT, "marginalnote-insert", Noop, Edit },
2519 * \var lyx::FuncCode lyx::LFUN_MARK_OFF
2520 * \li Action: Disable selecting of text-region.
2521 * \li Syntax: mark-off
2524 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
2527 * \var lyx::FuncCode lyx::LFUN_MARK_ON
2528 * \li Action: Enable selecting of text-region.
2529 * \li Notion: After enabling you can simply move arrow keys to get selected region.
2530 * \li Syntax: mark-on
2533 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
2536 * \var lyx::FuncCode lyx::LFUN_MARK_TOGGLE
2537 * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
2538 * \li Syntax: mark-toggle
2539 * \li Origin: Andre, May 5 2006
2542 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
2546 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_EXPORT
2547 * \li Action: Exports the master buffer (document) to the given format.
2548 * \li Syntax: master-buffer-export [<FORMAT>] [<DEST>]
2549 * \li Params: <FORMAT> is one of the formats which you can find in
2550 Tools->Preferences->File formats->Format.
2551 Usual format you will enter is "pdf2" (pdflatex),
2552 "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
2553 Note that "custom" is not allowed in this case.\n
2554 If absent or "default", then the default output format of the
2556 <DEST> If present, this argument provides the export destination
2557 filename. Its containing folder will also be the destination
2558 folder, where all the needed external files will be copied.
2559 * \li Origin: rkh, 18 April 2018
2562 { LFUN_MASTER_BUFFER_EXPORT, "master-buffer-export", ReadOnly, Buffer },
2565 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
2566 * \li Action: Update (export) the document built from the master buffer,
2567 if the current buffer is part of a master/child document.
2568 * \li Syntax: master-buffer-update [<FORMAT>]
2569 * \li Params: <FORMAT>: The format to display, where this is one of the
2570 formats defined (in the current GUI) in the
2571 Tools>Preferences>File Formats dialog.
2572 If no format is given, the default format as
2573 specified in the same dialog is used.
2574 * \li Origin: Tommaso, 20 Sep 2007
2577 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
2580 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
2581 * \li Action: Show a preview built from the master buffer, if available.
2582 if the current buffer is part of a master/child document.
2583 * \li Syntax: master-buffer-view [<FORMAT>]
2584 * \li Params: <FORMAT>: The format to display, where this is one of the
2585 formats defined (in the current GUI) in the
2586 Tools>Preferences>File Formats dialog.
2587 If no format is given, the default format as
2588 specified in the same dialog is used.
2589 * \li Origin: Tommaso, 20 Sep 2007
2592 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
2595 * \var lyx::FuncCode lyx::LFUN_MATH_AMS_MATRIX
2596 * \li Action: Inserts an extended matrix as provided by the amsmath package.
2597 * \li Syntax: math-matrix <COLS> <ROWS> [<DECORATION>]
2598 * \li Params: <DECORATION>: Decoration determines the LaTeX name of the matrix
2599 that should be created. Possible values include
2600 pmatrix, bmatrix, Bmatrix, vmatrix, Vmatrix and
2601 matrix. The default is 'matrix'.
2602 * \li Sample: math-ams-matrix 3 3 bmatrix
2605 { LFUN_MATH_AMS_MATRIX, "math-ams-matrix", Noop, Math },
2608 * \var lyx::FuncCode lyx::LFUN_MATH_BIGDELIM
2609 * \li Action: Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
2610 * \li Syntax: math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
2611 * \li Params: <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r \n
2612 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
2613 * \li Sample: math-bigdelim "Bigl" "\Downarrow" "Bigr" "\}"
2614 * \li Origin: Enrico & Georg, 7 May 2006
2617 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
2620 * \var lyx::FuncCode lyx::LFUN_MATH_DELIM
2621 * \li Action: Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
2622 * \li Syntax: math-delim [<LEFT>] [<RIGHT>]
2623 * \li Params: <LEFT/RIGHT>: Delimiters to be used. Each delimiter can be specified by
2624 either a LaTeX name or a valid character.
2625 ( is the default letter.
2626 * \li Sample: math-delim { rangle
2627 * \li Origin: Alejandro, 18 Jun 1996
2630 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
2633 * \var lyx::FuncCode lyx::LFUN_MATH_DISPLAY
2634 * \li Action: Creates a new displayed equation in text mode.
2635 Toggles inlined/display formula in math mode.
2636 * \li Syntax: math-display [<ARG>]
2637 * \li Params: <ARG>: this argument will be passed to #LFUN_MATH_INSERT when creating
2638 new equation from the text mode.
2639 * \li Origin: Alejandro, 18 Jun 1996
2642 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
2645 * \var lyx::FuncCode lyx::LFUN_MATH_EXTERN
2646 * \li Action: Calls external program and passes the current expression/equation
2647 as an argument for the calculation in the format appropriate to the
2649 * \li Notion: Selection can be used to determine the input for the external program.
2650 * \li Syntax: math-extern <LANG> [<COMMAND>]
2651 * \li Params: <LANG>: octave|maxima|maple|mathematica|script \n
2652 where "script" stands for the external script (normalized
2653 expression will be passed)
2654 * \li Origin: Andre, 24 Apr 2001
2655 * \li Sample: math-extern maple simplify
2658 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
2661 * \var lyx::FuncCode lyx::LFUN_MATH_FONT_STYLE
2662 * \li Action: Changes the text style used in math.
2663 * \li Syntax: math-font-style <STYLE>
2664 * \li Params: <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf|textnormal\n
2665 |textrm|textsf|texttt|textbf|textmd|textit|textsc|textsl|textup
2666 * \li Origin: vfr, 9 jan 2009
2669 { LFUN_MATH_FONT_STYLE, "math-font-style", Noop, Math },
2672 * \var lyx::FuncCode lyx::LFUN_MATH_INSERT
2673 * \li Action: Inserts math objects and symbols.
2674 * \li Syntax: math-insert <ARG>
2675 * \li Params: <ARG>: Symbol or LaTeX code to be inserted.
2676 * \li Notion: When <ARG> is a _single_ math inset with more than one cell
2677 (such as "x_y^z" or "\frac{x}{y}"), the content of cell(0) is
2678 replaced by the current selection (only works if the selection
2679 is in mathed). As an example, if "abc" is selected in mathed,
2680 "math-insert \frac{x}{y}" replaces "abc" with "\frac{abc}{y}",
2681 and "math-insert x_y^z" replaces "abc" with "abc_y^z".
2682 If nothing is selected (or the selection is not in mathed),
2683 math-insert works as expected.
2686 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
2689 * \var lyx::FuncCode lyx::LFUN_MATH_LIMITS
2690 * \li Action: Toggles the position of the limits from above/below to the right
2691 side an vice versa in integral symbol, a limit, a summation, etc.
2692 * \li Notion: Put the cursor before the symbol with the limits and then invoke
2694 * \li Syntax: math-limits [<STATE>]
2695 * \li Params: <STATE>: limits|nolimits
2698 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
2701 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO
2702 * \li Action: Inserts a math macro definition at the cursor position in the text.
2703 * \li Syntax: math-macro <NAME> [<NARGS>] [def]
2704 * \li Params: <NAME>: The name of the macro, e.g. "mymacro".\n
2705 <NARGS>: The number of parameters of the macro. Default is 0.
2706 "def": Has no effect anymore, just for compatibility with former LyX versions.
2707 * \li Origin: ale, 10 May 1997; sts, 21 Dec 2007
2710 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
2713 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
2714 * \li Action: Add a greedy optional parameter.
2715 * \li Notion: Add a greedy optional parameter which eats the value
2716 from the following cells in mathed which are in the [value]
2718 * \li Syntax: math-macro-add-greedy-optional-param
2719 * \li Origin: sts, 06 January 2008
2722 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
2725 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
2726 * \li Action: Add an optional parameter.
2727 * \li Notion: Insert an optional parameter just behind the
2728 already existing optional parameters.
2729 * \li Syntax: math-macro-add-optional-param
2730 * \li Origin: sts, 06 January 2008
2733 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
2736 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
2737 * \li Action: Add a parameter.
2738 * \li Notion: Add a parameter to a Math Macro.
2739 * \li Params: <NUM>: The number of the parameter behind which the new one
2740 will be added (1 for the first, i.e. use 0 for add a
2741 parameter at the left), defaults to the last one.
2742 * \li Syntax: math-macro-add-param <NUM>
2743 * \li Origin: sts, 06 January 2008
2746 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
2749 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
2750 * \li Action: Append a greedy parameter.
2751 * \li Notion: Append a greedy parameter to a Math Macro which
2752 eats the following mathed cell in every instance of
2753 the macro in the buffer.
2754 * \li Syntax: math-macro-append-greedy-param
2755 * \li Origin: sts, 06 January 2008
2758 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
2761 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
2762 * \li Action: Fold a Math Macro.
2763 * \li Notion: Fold the Math Macro the cursor is in if it was
2764 unfolded, i.e. displayed as \foo before.
2765 * \li Syntax: math-macro-fold
2766 * \li Origin: sts, 06 January 2008
2769 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
2772 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
2773 * \li Action: Make a parameter non-optional.
2774 * \li Notion: Turn the last optional parameter of a Math Macro
2775 into a non-optional parameter. The default value is
2776 remembered to be reused later if the user changes his mind.
2777 * \li Syntax: math-macro-make-nonoptional
2778 * \li Origin: sts, 06 January 2008
2781 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
2784 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
2785 * \li Action: Make a parameter optional.
2786 * \li Notion: Turn the first non-optional parameter of a Math Macro
2787 into an optional parameter with a default value.
2788 * \li Syntax: math-macro-make-optional
2789 * \li Origin: sts, 06 January 2008
2792 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
2795 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
2796 * \li Action: Remove a greedy parameter.
2797 * \li Notion: Remove a greedy parameter of a Math Macro and spit
2798 out the values of it in every instance of the macro
2799 in the buffer. If it is an optional parameter the [valud]
2801 * \li Syntax: math-macro-remove-greedy-param
2802 * \li Origin: sts, 06 January 2008
2805 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
2808 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
2809 * \li Action: Remove the last optional parameter.
2810 * \li Notion: Remove the last optional parameter of a Math Macro and
2811 remove it in all the instances of the macro in the buffer.
2812 * \li Syntax: math-macro-remove-optional-param
2813 * \li Origin: sts, 06 January 2008
2816 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
2819 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
2820 * \li Action: Remove the last parameter.
2821 * \li Notion: Remove the last parameter of a Math Macro and
2822 remove its value in all instances of the macro
2824 * \li Params: <NUM>: The number of the parameter to be deleted (1 for
2825 the first), defaults to the last one.
2826 * \li Syntax: math-macro-remove-param <NUM>
2827 * \li Origin: sts, 06 January 2008
2830 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
2833 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
2834 * \li Action: Unfold a Math Macro.
2835 * \li Notion: Unfold the Math Macro the cursor is in, i.e.
2837 * \li Syntax: math-macro-unfold
2838 * \li Origin: sts, 06 January 2008
2841 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
2844 * \var lyx::FuncCode lyx::LFUN_MATH_MATRIX
2845 * \li Action: Inserts a matrix.
2846 * \li Syntax: math-matrix <COLS> <ROWS> [<ALIGN>]
2847 * \li Params: <ALIGN>: Alignment is a word composed of the vertical alignment
2848 (b, c or t) (i.e. 1 char) and the horizontal alignments
2849 (l, c or r) (i.e. <COL> chars).
2850 * \li Sample: math-matrix 3 3 bccc
2853 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
2856 * \var lyx::FuncCode lyx::LFUN_MATH_MODE
2857 * \li Action: In text mode enters math mode (i.e. puts math insets on the current
2858 cursor position), in math mode enters text mode inside math expression.
2859 * \li Notion: If there is some selected text, it puts the text inside created math box.
2860 * \li Syntax: math-mode [on|<ARG>]
2861 * \li Params: <ARG>: eventual argument (LaTeX code) is passed to #LFUN_MATH_INSERT .\n
2862 "on": allow only entering of math mode from text mode.
2863 * \li Origin: Alejandro, 4 Jun 1996
2866 { LFUN_MATH_MODE, "math-mode", Noop, Math },
2869 * \var lyx::FuncCode lyx::LFUN_MATH_MUTATE
2870 * \li Action: Mutates the type of math inset to the newly selected one.
2871 * \li Syntax: math-mutate <TYPE>
2872 * \li Params: <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
2873 multline|gather|flalign
2874 * \li Origin: Andre, 23 May 2001
2877 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
2880 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
2881 * \li Action: Toggles numbering of the current formula line.
2882 * \li Notion: Must be in display formula mode.
2883 * \li Syntax: math-number-line-toggle
2884 * \li Origin: Alejandro, 18 Jun 1996
2887 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
2890 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
2891 * \li Action: Toggles numbering/labeling of the current formula.
2892 * \li Notion: Must be in display formula mode.
2893 * \li Syntax: math-number-toggle
2894 * \li Origin: Alejandro, 4 Jun 1996
2897 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
2900 * \var lyx::FuncCode lyx::LFUN_MATH_SIZE
2901 * \li Action: Changes arbitrarily the size used by math fonts inside a context.
2902 * \li Notion: Provides an interface to the LaTeX math mode font size commands.
2903 * \li Syntax: math-size <STYLE>
2904 * \li Params: <STYLE>: \displaystyle|\textstyle|\scriptstyle|\scriptscriptstyle
2905 * \li Origin: Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
2908 { LFUN_MATH_SIZE, "math-size", Noop, Math },
2911 * \var lyx::FuncCode lyx::LFUN_MATH_SPACE
2912 * \li Action: Inserts space into math expression.
2913 * \li Notion: Use spacebar after entering this space to change type of space.
2914 * \li Syntax: math-space [<TYPE>] [<LEN>]
2915 * \li Params: <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace \n
2916 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad \n
2917 custom space: hspace \n
2918 "," used by default.\n
2919 Note that ! is equivalent to negthinspace, , = thinspace,
2920 : = medspace, and ; = thickspace.\n
2921 <LEN>: length for custom spaces (hspace)
2922 * \li Origin: Andre, 25 Jul 2001; sanda, 16 Jun 2008
2925 { LFUN_MATH_SPACE, "math-space", Noop, Math },
2928 * \var lyx::FuncCode lyx::LFUN_MATH_SUBSCRIPT
2929 * \li Action: Enters subscript expression in math expression.
2930 * \li Syntax: math-subscript
2931 * \li Origin: vermeer, 12 Dec 2001
2934 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
2937 * \var lyx::FuncCode lyx::LFUN_MATH_SUPERSCRIPT
2938 * \li Action: Enters superscript expression in math expression.
2939 * \li Syntax: math-superscript
2940 * \li Origin: vermeer, 12 Dec 2001
2943 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
2946 * \var lyx::FuncCode lyx::LFUN_MENU_OPEN
2947 * \li Action: Opens the menu given by its name.
2948 * \li Syntax: menu-open <NAME>
2949 * \li Params: <NAME>: menu name. See various .inc files in lib/ui for candidates.
2952 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
2955 * \var lyx::FuncCode lyx::LFUN_MESSAGE
2956 * \li Action: Shows message in statusbar (for script purposes).
2957 * \li Syntax: message <STRING>
2958 * \li Origin: Lgb, 8 Apr 2001
2961 { LFUN_MESSAGE, "message", NoBuffer, System },
2964 * \var lyx::FuncCode lyx::LFUN_META_PREFIX
2965 * \li Action: Simulate halting Meta key (Alt key on PCs).
2966 * \li Notion: Used for buffer edition not for GUI control.
2967 * \li Syntax: meta-prefix
2970 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
2973 * \var lyx::FuncCode lyx::LFUN_MOUSE_DOUBLE
2974 * \li Action: This function is called when double click on mouse button is
2975 pressed (inside workarea). Action depends on the context.
2976 * \li Notion: This is an internal LFUN, not to be used by users.
2977 * \li Origin: Andre, 9 Aug 2002
2980 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
2983 * \var lyx::FuncCode lyx::LFUN_MOUSE_MOTION
2984 * \li Action: This function is called when mouse cursor is moving over the text.
2985 Action depends on the context.
2986 * \li Notion: This is an internal LFUN, not to be used by users.
2987 * \li Origin: Andre, 9 Aug 2002
2990 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
2993 * \var lyx::FuncCode lyx::LFUN_MOUSE_PRESS
2994 * \li Action: This function is called when mouse button is pressed (inside workarea).
2995 Action depends on the context.
2996 * \li Notion: This is an internal LFUN, not to be used by users.
2997 * \li Origin: Andre, 9 Aug 2002
3000 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
3003 * \var lyx::FuncCode lyx::LFUN_MOUSE_RELEASE
3004 * \li Action: This function is called when mouse button is released (inside workarea).
3005 Action depends on the context.
3006 * \li Notion: This is an internal LFUN, not to be used by users.
3007 * \li Origin: Andre, 9 Aug 2002
3010 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
3014 * \var lyx::FuncCode lyx::LFUN_MOUSE_TRIPLE
3015 * \li Action: This function is called when triple click on mouse button is
3016 pressed (inside workarea). Action depends on the context.
3017 * \li Notion: This is an internal LFUN, not to be used by users.
3018 * \li Origin: Andre, 9 Aug 2002
3021 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
3024 * \var lyx::FuncCode lyx::LFUN_NEWLINE_INSERT
3025 * \li Action: Inserts a line break or new line.
3026 * \li Syntax: newline-insert [<ARG>]
3027 * \li Params: <ARG>: <newline|linebreak> default: newline
3028 * \li Origin: spitz, 25 Mar 2008
3031 { LFUN_NEWLINE_INSERT, "newline-insert", Noop, Edit },
3034 * \var lyx::FuncCode lyx::LFUN_NEWPAGE_INSERT
3035 * \li Action: Inserts a new page.
3036 * \li Syntax: newpage-insert <ARG>
3037 * \li Params: <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
3038 * \li Origin: uwestoehr, 24 Nov 2007
3041 { LFUN_NEWPAGE_INSERT, "newpage-insert", Noop, Edit },
3044 * \var lyx::FuncCode lyx::LFUN_NOMENCL_INSERT
3045 * \li Action: Inserts Nomenclature entry.
3046 * \li Notion: It automatically takes the word on the cursor position if no symbol is given.
3047 * \li Syntax: nomencl-insert [<SYMBOL>]
3048 * \li Origin: Ugras, 4 Nov 2006
3051 { LFUN_NOMENCL_INSERT, "nomencl-insert", Noop, Edit },
3054 * \var lyx::FuncCode lyx::LFUN_NOMENCLATURE_PRINT
3055 * \li Action: Inserts list of Nomenclature entries.
3056 * \li Syntax: nomenclature-print
3057 * \li Origin: Ugras, 4 Nov 2006
3060 { LFUN_NOMENCL_PRINT, "nomencl-print", Noop, Edit },
3064 * \var lyx::FuncCode lyx::LFUN_NOTE_INSERT
3065 * \li Action: Inserts Note on the current cursor position,
3066 move selection inside the inset.
3067 * \li Syntax: note-insert [<TYPE>]
3068 * \li Params: <TYPE>: <Note|Greyedout|Comment> default: Note
3071 { LFUN_NOTE_INSERT, "note-insert", Noop, Edit },
3074 * \var lyx::FuncCode lyx::LFUN_NOTE_NEXT
3075 * \li Action: Moves the cursor to the beginning of next Note inset.
3076 * \li Syntax: note-next
3079 { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
3082 * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
3083 * \li Action: Move the current group in the downward direction in the
3084 structure of the document.
3085 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
3086 the whole substructure of the group.
3087 * \li Syntax: outline-down
3088 * \li Origin: Vermeer, 23 Mar 2006
3091 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
3094 * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
3095 * \li Action: Moves the current group in the downward direction in the
3096 hierarchy of the document structure.
3097 * \li Notion: Part -> Chapter -> Section -> etc.
3098 * \li Syntax: outline-in
3099 * \li Origin: Vermeer, 23 Mar 2006
3102 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
3105 * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
3106 * \li Action: Moves the current group in the upward direction in the
3107 hierarchy of the document structure.
3108 * \li Notion: Part <- Chapter <- Section <- etc.
3109 * \li Syntax: outline-out
3110 * \li Origin: Vermeer, 23 Mar 2006
3113 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
3117 * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
3118 * \li Action: Move the current group in the upward direction in the
3119 structure of the document.
3120 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
3121 the whole substructure of the group.
3122 * \li Syntax: outline-up
3123 * \li Origin: Vermeer, 23 Mar 2006
3126 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
3129 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_BREAK
3130 * \li Action: Breaks the current paragraph at the current location.
3131 * \li Notion: Removes the selection.
3132 * \li Syntax: paragraph-break [<LAYOUT>] [ignoresep]
3133 * \li Params: <LAYOUT>: "inverse" - decreases depth by one (or change layout
3134 to default layout) when the cursor is at the end of
3136 ignoresep: Do not account for paragraph separators while breaking.
3139 { LFUN_PARAGRAPH_BREAK, "paragraph-break", Noop, Edit },
3142 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN
3143 * \li Action: Move the cursor to the next paragraph (or beginning of the current one)
3144 in downward direction.
3145 * \li Syntax: paragraph-down
3146 * \li Origin: Asger, 1 Oct 1996
3149 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
3152 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN_SELECT
3153 * \li Action: Move the cursor and select the text to the next paragraph (or
3154 beginning of the current one) in downward direction.
3155 * \li Syntax: paragraph-down-select
3156 * \li Origin: Asger, 1 Oct 1996
3159 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
3162 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
3163 * \li Action: Jump to a paragraph given by its id number and optionally the
3164 desired position within the paragraph.
3165 If given four arguments id_start, pos_start, id_end, pos_end,
3166 perform a selection from start to end.
3167 * \li Notion: Note that id number of paragraph is not the sequential number of
3168 paragraph seen on the screen. Moreover the id is unique for all
3169 opened buffers (documents). Both ids must belong to the same
3171 * \li Syntax: paragraph-goto <PAR_ID> <POS_IN_PAR> [<PAR_ID> <POS_IN_PAR>]
3172 * \li Params: <PAR_ID>: paragraph id \n
3173 <POS_IN_PAR>: desired position within the paragraph
3174 * \li Origin: Dekel, 26 Aug 2000
3178 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly | NoInternal, Edit },
3181 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
3182 * \li Action: Moves the current paragraph downwards in the document.
3183 * \li Syntax: paragraph-move-down
3184 * \li Origin: Edwin, 8 Apr 2006
3187 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
3190 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
3191 * \li Action: Moves the current paragraph upwards in the document.
3192 * \li Notion: Movement through the document will possibly break the paragraph-depth
3193 (e.g. itemize structure).
3194 * \li Syntax: paragraph-move-up
3195 * \li Origin: Edwin, 8 Apr 2006
3198 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
3202 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
3203 * \li Action: Change paragraph settings.
3204 * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
3205 This function only modifies, and does not override, existing settings.
3206 Note that the "leftindent" indent setting is deprecated.
3207 * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
3208 * \li Params: <INDENT>: \noindent|\indent|\indent-toggle|\leftindent LENGTH\n
3209 <SPACING>: \paragraph_spacing default|single|onehalf|double|other SIZE \n
3210 <ALIGN>: \align block|left|right|center|default\n
3211 <OTHERS>: \labelwidthstring WIDTH|\start_of_appendix
3212 * \li Origin: rgh, Aug 15 2007
3215 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
3218 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
3219 * \li Action: Change paragraph settings.
3220 * \li Notion: Overwrite all nonspecified settings to the default ones.
3221 Use paragraph-params lfun if you don't want to overwrite others settings.
3222 * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
3223 * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
3224 * \li Origin: leeming, 30 Mar 2004
3227 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
3230 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP
3231 * \li Action: Move the cursor to the next paragraph (or beginning of the current one)
3232 in upward direction.
3233 * \li Syntax: paragraph-up
3234 * \li Origin: Asger, 1 Oct 1996
3237 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
3240 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UPDATE
3241 * \li Action: Updates the values inside the paragraph dialog from the paragraph.
3242 * \li Notion: This is an internal LFUN, not to be used by users. Called internally
3243 by #LFUN_DIALOG_UPDATE.
3244 * \li Origin: leeming, 13 Mar 2003
3247 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
3251 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP_SELECT
3252 * \li Action: Move the cursor and select the text to the next paragraph (or
3253 beginning of the current one) in upward direction.
3254 * \li Syntax: paragraph-up-select
3255 * \li Origin: Asger, 1 Oct 1996
3258 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
3261 * \var lyx::FuncCode lyx::LFUN_PASTE
3262 * \li Action: Pastes material (text or picture) from the active clipboard.
3263 * \li Syntax: paste [<TYPE>|<NUM>]
3264 * \li Params: <TYPE>: emf|pdf|png|jpeg|linkback|wmf|latex|html \n
3265 <NUM>: number of the selection in the internal clipboard stack to be pasted.
3268 { LFUN_PASTE, "paste", Noop, Edit },
3271 * \var lyx::FuncCode lyx::LFUN_PHANTOM_INSERT
3272 * \li Action: Inserts phantom on the current cursor position,
3273 move selection inside the inset.
3274 * \li Syntax: phantom-insert [<TYPE>]
3275 * \li Params: <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
3276 * \li Origin: uwestoehr, 30 Jan 2009
3279 { LFUN_PHANTOM_INSERT, "phantom-insert", Noop, Edit },
3282 * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
3283 * \li Action: Save user preferences.
3284 * \li Syntax: preferences-save
3285 * \li Origin: Lgb, 27 Nov 1999
3288 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
3291 * \var lyx::FuncCode lyx::LFUN_PREVIEW_INSERT
3292 * \li Action: Inserts a new preview inset.
3293 * \li Syntax: preview-insert
3294 * \li Origin: vfr, 28 Mar 2010
3297 { LFUN_PREVIEW_INSERT, "preview-insert", Noop, Edit },
3300 * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
3301 * \li Action: Pastes the currently selected text.
3302 * \li Notion: Primary selection mechanism is linux-only thing.
3303 * \li Syntax: primary-selection-paste [<ARG>]
3304 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
3307 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
3310 * \var lyx::FuncCode lyx::LFUN_QUOTE_INSERT
3311 * \li Action: Inserts quotes according to the type and quote-language preference.
3312 * \li Notion: Currently 15 different quote styles are distinguished (see params).
3313 * \li Syntax: quote-insert [<LEVEL>] [<SIDE>] [<STYLE>]
3314 * \li Params: <LEVEL>: 'inner' for (i.e., secondary, usually single) quotes, otherwise
3315 * outer (i.e., primary, usually double) quotes will be used.\n
3316 * <SIDE>: 'opening' for opening quotes, 'closing' for closing quotes,
3317 * otherwise the side will be guessed from the context.\n
3318 * <STYLE>: 'british' for `British' quote style (with ``inner quotation'')\n
3319 * 'cjk' for Chinese/Japanese/Korean corner bracket quotation marks\n
3320 * 'cjk-angle' for Chinese/Japanese/Korean angle bracket quotation marks\n
3321 * 'danish' for >>Danish<< quote style (with >inner quotation<)\n
3322 * 'english' for ``English'' quote style (with `inner quotation')\n
3323 * 'french' for <<french>> quote style (with ``inner quotation'')\n
3324 * 'frenchin' for <<frenchin>> quote style (with <<inner quotation>>) ["in" = Imprimerie Nationale]\n
3325 * 'german' for ,,German`` quote style (with ,inner quotation`)\n
3326 * 'plain' for "Plain" quote style (with 'inner quotation')\n
3327 * 'polish' for ,,Polish'' quote style (with ,inner quotation')\n
3328 * 'swedish' for ''Swedish'' quote style (with 'inner quotation')\n
3329 * 'swedishg' for >>swedishg>> quote style (with 'inner quotation') ["g" = Guillemets]\n
3330 * 'swiss' for <<Swiss>> quote style (with <inner quotation>)\n
3331 * 'russian' for <<Russian>> quote style (with ,,inner quotation``)\n
3332 * 'dynamic' for Dynamic quotation marks which inherit the global
3334 * If no quote style is specified, the document-wide will be used.
3337 { LFUN_QUOTE_INSERT, "quote-insert", Noop, Edit },
3340 * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
3341 * \li Action: Reconfigure the automatic settings.
3342 * \li Syntax: reconfigure
3343 * \li Origin: Asger, 14 Feb 1997
3346 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
3349 * \var lyx::FuncCode lyx::LFUN_REDO
3350 * \li Action: Redoes the last thing undone.
3354 { LFUN_REDO, "redo", ReadOnly, Edit },
3357 * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
3358 * \li Action: Go to the next label or cross-reference.
3359 * \li Syntax: reference-next
3360 * \li Origin: Dekel, 14 Jan 2001
3363 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
3367 * \var lyx::FuncCode lyx::LFUN_REGEXP_MODE
3368 * \li Action: Enters regexp mode (i.e., puts regexp insets on the current
3369 cursor position). Used by the advanced search dialog.
3370 * \li Notion: If there is any selected text, then it is moved inside the created
3372 * \li Syntax: regexp-mode [<ARG>]
3373 * \li Params: <ARG>: eventual argument (regular expression).
3374 * \li Origin: Tommaso, 4 Oct 2008
3377 { LFUN_REGEXP_MODE, "regexp-mode", Noop, Math },
3380 * \var lyx::FuncCode lyx::LFUN_REPEAT
3381 * \li Action: Repeat the given command.
3382 * \li Notion: fails when the repeat count is greater than 10000.
3383 * \li Syntax: repeat <COUNT> <LFUN-COMMAND>
3384 * \li Origin: Andre, 27 Oct 2003
3387 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
3390 * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN
3391 * \li Action: Moves the cursor one page in downward direction.
3392 * \li Syntax: screen-down
3395 { LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit },
3398 * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN_SELECT
3399 * \li Action: Moves the cursor one screen in downward direction adding the current
3400 position to the selection.
3401 * \li Syntax: screen-down-select
3404 { LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit },
3407 * \var lyx::FuncCode lyx::LFUN_SCREEN_FONT_UPDATE
3408 * \li Action: Update fonts and its metrics.
3409 * \li Notion: Automatically called after zoom, dpi, font names, or norm change.
3410 * \li Syntax: screen-font-update
3411 * \li Origin: ARRae, 13 Aug 2000
3414 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
3417 * \var lyx::FuncCode lyx::LFUN_SCREEN_RECENTER
3418 * \li Action: Recenters the screen on the current cursor position.
3419 * \li Syntax: screen-recenter
3422 { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit },
3426 * \var lyx::FuncCode lyx::LFUN_SCREEN_SHOW_CURSOR
3427 * \li Action: Repositions the screen such that the cursor is visible.
3428 * \li Syntax: screen-show-cursor
3429 * \li Origin: vfr, 25 Mar 2009
3432 { LFUN_SCREEN_SHOW_CURSOR, "screen-show-cursor", ReadOnly, Edit },
3436 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP
3437 * \li Action: Moves the cursor one page in upward direction.
3438 * \li Syntax: screen-up
3441 { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit },
3444 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP_SELECT
3445 * \li Action: Moves the cursor one page in upward direction adding the current
3446 position to the selection.
3447 * \li Syntax: screen-up-select
3450 { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit },
3453 * \var lyx::FuncCode lyx::LFUN_SCRIPT_INSERT
3454 * \li Action: Inserts a subscript or superscript inset.
3455 * \li Syntax: script-insert <TYPE>
3456 * \li Params: <TYPE>: subscript|superscript
3457 * \li Origin: Georg, 23 Nov 2010
3460 { LFUN_SCRIPT_INSERT, "script-insert", Noop, Edit },
3463 * \var lyx::FuncCode lyx::LFUN_SCROLL
3464 * \li Action: Scroll the buffer view.
3465 * \li Notion: Only scrolls the screen up or down; does not move the cursor.
3466 * \li Syntax: scroll <TYPE> <QUANTITY>
3467 * \li Params: <TYPE>: line|page\n
3468 <QUANTITY>: up|down|<number>
3469 * \li Origin: Abdel, Dec 27 2007
3472 { LFUN_SCROLL, "scroll", ReadOnly, Edit },
3475 * \var lyx::FuncCode lyx::LFUN_SECTION_SELECT
3476 * \li Action: Select the whole section.
3477 * \li Notion: The cursor should be in a section heading
3478 before calling this lfun.
3479 * \li Syntax: section-select
3480 * \li Origin: vfr, 05 May 2009
3483 { LFUN_SECTION_SELECT, "section-select", ReadOnly, Edit },
3487 * \var lyx::FuncCode lyx::LFUN_SELECTION_PASTE
3488 * \li Action: Pastes the internal selection text in permanent selection.
3489 * \li Notion: Created in order to have middle mouse button pasting correct (bound to
3490 command-alternatives selection-paste ; primary-selection-paste paragraph).
3491 * \li Syntax: selection-paste
3492 * \li Origin: lasgouttes, 14 Jan 2009
3495 { LFUN_SELECTION_PASTE, "selection-paste", Noop, Edit },
3498 * \var lyx::FuncCode lyx::LFUN_SELF_INSERT
3499 * \li Action: Inserts the given string (accordingly to the correct keymap).
3500 * \li Notion: Automatically replace the currently selected text. Depends on lyxrc
3501 settings "auto_region_delete".
3502 * \li Syntax: self-insert <STRING>
3505 { LFUN_SELF_INSERT, "self-insert", SingleParUpdate, Hidden },
3508 * \var lyx::FuncCode lyx::LFUN_SEPARATOR_INSERT
3509 * \li Action: Inserts an environment separator or latex paragraph break.
3510 * \li Syntax: separator-insert [<ARG>]
3511 * \li Params: <ARG>: <plain|parbreak|latexpar> default: plain
3512 * \li Origin: ef, 2 May 2014
3515 { LFUN_SEPARATOR_INSERT, "separator-insert", Noop, Edit },
3518 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_FILENAME
3519 * \li Action: Returns path and file name of the currently edited document.
3520 * \li Syntax: server-get-filename
3523 { LFUN_SERVER_GET_FILENAME, "server-get-filename", ReadOnly, System },
3526 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_LAYOUT
3527 * \li Action: Returns the current layout (that is environment) name
3528 on the cursor position.
3529 * \li Syntax: server-get-layout
3532 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
3535 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_STATISTICS
3536 * \li Action: Returns the statistics (number of words and characters)
3537 in the document or in the given selection.
3538 * \li Notion: Note that this function gives the number of words/chars written,
3539 not the number of characters which will be typeset.
3540 * \li Syntax: server-get-statistics [<TYPE>]
3541 * \li Params: <TYPE>: <words|chars|chars-space> The requested count; if not
3542 specified, the three values are returned, separated
3544 words: count words.\n
3545 chars: count characters.\n
3546 chars-space: count characters and spaces.
3547 * \li Origin: brokenclock, Oct 10 2014
3550 { LFUN_SERVER_GET_STATISTICS, "server-get-statistics", ReadOnly, System },
3553 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
3554 * \li Action: Returns the coordinates of cursor position in the editing area.
3555 * \li Syntax: server-get-xy
3558 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
3562 * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
3563 * \li Action: Sets the cursor position in LyX based on the row number of generated TeX file.
3564 * \li Notion: This can be useful for DVI inverse-search or detection of the problematic
3565 line from LaTeX compilation. Note that before this function can be used
3566 export to LaTeX output must occur (in order to map the row numbers).
3567 * \li Syntax: server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
3568 * \li Params: <FILE>: the path and filename. Environment variables are expanded in the path.
3569 In case this LFUN does not work make sure you are giving correct
3571 If the file is located inside LyX temporary directory it will be
3572 mapped back into the appropriate opened buffer (e.g. for the case
3573 of generated .tex file).\n
3574 .ext: extensions will be automatically replaced by .lyx.\n
3575 <ROW_NUMBER> The row number of the LaTeX file to which to go.
3576 * \li Sample: server-goto-file-row /home/user/example.lyx 41\n
3577 server-goto-file-row /tmp/lyx_tmpdir.XM3088/lyx_tmpbuf0/example.tex 41
3578 * \li Origin: Edmar, 23 Dec 1998
3581 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly | NoBuffer, System },
3584 * \var lyx::FuncCode lyx::LFUN_SERVER_NOTIFY
3585 * \li Action: Sends notify message about the last key-sequence to client.
3586 * \li Notion: This can be used to grab last key-sequence used inside the LyX window.
3587 See also Debug extensions section in Additional features manual.
3588 * \li Syntax: server-notify
3591 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
3594 * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
3595 * \li Action: Sets the cursor position based on the editing area coordinates
3596 (similar to clicking on that point with left mouse button).
3597 * \li Syntax: server-set-xy <X> <Y>
3600 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
3603 * \var lyx::FuncCode lyx::LFUN_SET_COLOR
3604 * \li Action: Set the given LyX color to the color defined by the X11 name given.
3605 * \li Notion: A new color entry is created if the color is unknown.
3606 Color names can be stored as a part of user settings.
3607 * \li Syntax: set-color <LYX_NAME> <X11_NAME>
3608 * \li Origin: SLior, 11 Jun 2000
3611 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
3614 * \var lyx::FuncCode lyx::LFUN_GRAPHICS_SET_GROUP
3615 * \li Action: Set the group for the graphics inset on the cursor position.
3616 * \li Syntax: graphics-set-group [<GROUP>]
3617 * \li Params: <GROUP>: Id for an existing group. In case the Id is an empty string,
3618 the graphics inset is removed from the current group.
3619 * \li Origin: sanda, 6 May 2008
3622 { LFUN_GRAPHICS_SET_GROUP, "graphics-set-group", Noop, Edit },
3625 * \var lyx::FuncCode lyx::LFUN_GRAPHICS_UNIFY
3626 * \li Action: Set the same group for all graphics insets in the marked block.
3627 * \li Syntax: graphics-unify [<GROUP>]
3628 * \li Params: <GROUP>: Id for an existing group. In case the Id is an empty string,
3629 the group Id from the first graphics inset will be used.
3630 * \li Origin: sanda, 7 Feb 2018
3633 { LFUN_GRAPHICS_UNIFY, "graphics-unify", Noop, Edit },
3636 * \var lyx::FuncCode lyx::LFUN_GRAPHICS_RELOAD
3637 * \li Action: Reloads the image if necessary.
3638 * \li Syntax: graphics-reload
3639 * \li Origin: vfr, 10 Aug 2009
3642 { LFUN_GRAPHICS_RELOAD, "graphics-reload", ReadOnly | AtPoint, Edit },
3645 * \var lyx::FuncCode lyx::LFUN_SPACE_INSERT
3646 * \li Action: Inserts one of horizontal space insets.
3647 * \li Syntax: space-insert <NAME> [<LEN>]
3648 * \li Params: <NAME>: normal, protected, visible, thin, quad, qquad, enspace,
3649 enskip, negthinspace, negmedspace, negthickspace, hfill,
3650 hfill*, dotfill, hrulefill, hspace, hspace* \n
3651 Only in math mode: med and thick.\n
3652 <LEN>: length for custom spaces (hspace, hspace* for protected)
3653 * \li Origin: spitz, 20 May 2003, Mar 17 2008
3656 { LFUN_SPACE_INSERT, "space-insert", Noop, Edit },
3659 * \var lyx::FuncCode lyx::LFUN_SPECIALCHAR_INSERT
3660 * \li Action: Inserts various characters into the document.
3661 * \li Syntax: specialchar-insert <CHAR>
3662 * \li Params: <CHAR>: hyphenation, allowbreak, ligature-break, slash,
3663 nobreakdash, dots, end-of-sentence, menu-separator,
3664 lyx, tex, latex, latex2e.
3665 * \li Origin: spitz, 6 Dec 2007
3668 { LFUN_SPECIALCHAR_INSERT, "specialchar-insert", Noop, Edit },
3671 * \var lyx::FuncCode lyx::LFUN_SPELLING_ADD
3672 * \li Action: Add the word under the cursor to the respective
3673 * spell checker dictionary.
3674 * The default for the language is retrieved from the cursor position.
3675 * \li Syntax: spelling-add [<STRING>] [<LANG>]
3676 * \li Params: <WORD>: word to add
3677 <LANG>: language name (see file languages)
3678 * \li Origin: spitz, 18 Jan 2010
3681 { LFUN_SPELLING_ADD, "spelling-add", ReadOnly, Edit },
3684 * \var lyx::FuncCode lyx::LFUN_SPELLING_CONTINUOUSLY
3685 * \li Action: Toggle continuous spell checking.
3686 * \li Syntax: spelling-continuously
3687 * \li Origin: vfr, 24 March 2013
3690 { LFUN_SPELLING_CONTINUOUSLY, "spelling-continuously", ReadOnly, Edit },
3694 * \var lyx::FuncCode lyx::LFUN_SPELLING_IGNORE
3695 * \li Action: Let the spell checker ignore the word under the cursor
3696 * in the current session for the given language.
3697 * The default for the language is retrieved from the cursor position.
3698 * \li Syntax: spelling-ignore [<WORD>] [<LANG>]
3699 * \li Params: <WORD>: word to ignore
3700 <LANG>: language name (see file languages)
3701 * \li Origin: spitz, 18 Jan 2010
3704 { LFUN_SPELLING_IGNORE, "spelling-ignore", ReadOnly, Edit },
3707 * \var lyx::FuncCode lyx::LFUN_SPELLING_REMOVE
3708 * \li Action: Remove the word under the cursor from the respective
3709 * spell checker dictionary.
3710 * The default for the language is retrieved from the cursor position.
3711 * \li Syntax: spelling-remove [<STRING>] [<LANG>]
3712 * \li Params: <WORD>: word to remove
3713 * <LANG>: language name (see file languages)
3714 * \li Origin: SWitt, 28 July 2010
3717 { LFUN_SPELLING_REMOVE, "spelling-remove", ReadOnly, Edit },
3721 * \var lyx::FuncCode lyx::LFUN_STATISTICS
3722 * \li Action: Count the statistics (number of words and characters)
3723 in the document or in the given selection and display it
3725 * \li Notion: Note that this function gives the number of words/chars written,
3726 not the number of characters which will be typeset.
3727 * \li Syntax: statistics
3728 * \li Origin: lasgouttes, Jan 27 2004; sanda, Jan 8 2008
3731 { LFUN_STATISTICS, "statistics", ReadOnly, System },
3734 * \var lyx::FuncCode lyx::LFUN_TABULAR_FEATURE
3735 * \li Action: Modify properties of tabulars and table-like math environments.
3736 * \li Syntax: tabular-feature <FEATURE> [<ARG>]
3737 * \li Params: Generally see #LFUN_INSET_INSERT for further details.\n
3738 * <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|\n
3739 copy-column|move-column-right|move-column-left|move-row-down|move-row-up|\n
3740 toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|\n
3741 align-left|align-right|align-center|align-block|align-decimal|set-decimal-point|\n
3742 valign-top|valign-bottom|valign-middle|longtabular-align-left|\n
3743 longtabular-align-center|longtabular-align-right|m-align-left|m-align-right|\n
3744 m-align-center|m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|\n
3745 set-all-lines|unset-all-lines|toggle-longtabular|set-longtabular|unset-longtabular|set-pwidth|\n
3746 set-mpwidth|set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|\n
3747 set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|\n
3748 unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|\n
3749 set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|\n
3750 set-special-column|set-special-multicolumn|set-special-multirow|\n
3751 toggle-booktabs|set-booktabs|unset-booktabs|set-top-space|set-bottom-space|\n
3752 set-interline-space|set-border-lines|tabular-valign-top|\n
3753 tabular-valign-middle|tabular-valign-bottom|set-tabular-width|\n
3754 toggle-varwidth-column
3755 Various math-environment features are handled as well, e.g. add-vline-left/right for\n
3756 the Grid/Array environment.\n
3757 <ARG>: additional argument for some commands, use debug mode to explore its values.
3758 * \li Origin: gm, 10 Dec 2015
3761 { LFUN_TABULAR_FEATURE, "tabular-feature", Noop, Edit },
3764 * \var lyx::FuncCode lyx::LFUN_TABULAR_INSERT
3765 * \li Action: Inserts table into the document.
3766 * \li Notion: See #LFUN_TABULAR_FEATURE for some more details
3767 about tabular modifications.
3768 * \li Syntax: tabular-insert [<ROWS> <COLUMNS>]
3769 * \li Params: In case no arguments are given show insert dialog.
3770 * \li Origin: Jug, 12 Apr 2000
3773 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
3777 * \var lyx::FuncCode lyx::LFUN_TAB_DELETE
3778 * \li Action: Delete a tab or up to an equivalent amount of spaces from
3780 * \li Notion: It also works on a selection - it removes a tab or spaces from the
3781 beginning of each line spanned by the selection. This is useful if
3782 you want to indent/unindent multiple lines in one action.
3783 * \li Syntax: tab-delete
3784 * \li Origin: vfr, Sep 30 2008
3787 { LFUN_TAB_DELETE, "tab-delete", SingleParUpdate, Edit },
3790 * \var lyx::FuncCode lyx::LFUN_TAB_GROUP_CLOSE
3791 * \li Action: Close the current tab group.
3792 * \li Notion: This only closes the work areas, not the buffers themselves.
3793 The still opened buffers can be visualized in another tab group.
3794 * \li Syntax: tab-group-close
3795 * \li Origin: Abdel, 21 Feb 2008
3798 { LFUN_TAB_GROUP_CLOSE, "tab-group-close", ReadOnly, Buffer },
3802 * \var lyx::FuncCode lyx::LFUN_TAB_INSERT
3803 * \li Action: Insert a tab into a listings inset.
3804 * \li Notion: It also works on a selection.
3805 * \li Syntax: tab-insert
3806 * \li Origin: vfr, Sep 30 2008
3809 { LFUN_TAB_INSERT, "tab-insert", SingleParUpdate, Edit },
3812 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
3813 * \li Action: Sets the text class for the current buffer.
3814 * \li Syntax: textclass-apply <TEXTCLASS>
3815 * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
3816 the filename, minus the ".layout" extension.
3819 { LFUN_TEXTCLASS_APPLY, "textclass-apply", NoInternal, Layout },
3822 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
3823 * \li Action: Loads information for a textclass from disk.
3824 * \li Syntax: textclass-load <TEXTCLASS>
3825 * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
3826 the filename, minus the ".layout" extension.
3829 { LFUN_TEXTCLASS_LOAD, "textclass-load", NoInternal, Layout },
3833 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_APPLY
3834 * \li Action: Toggle user-defined (=last-time used) text style.
3835 * \li Notion: This style is set via #LFUN_TEXTSTYLE_UPDATE, which is
3836 automatically triggered when using Text Style dialog.
3837 * \li Syntax: textstyle-apply
3838 * \li Origin: leeming, 12 Mar 2003
3841 { LFUN_TEXTSTYLE_APPLY, "textstyle-apply", Noop, Layout },
3844 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_UPDATE
3845 * \li Action: Apply text style and update the settings to be used by #LFUN_TEXTSTYLE_APPLY.
3846 * \li Syntax: textstyle-update <FONT_INFO>
3847 * \li Params: <FONT_INFO>: specifies font attributes, e.g. family, series, shape,
3848 size, emph, noun, underbar, number, color, language,
3850 Use lyx -dbg action for exact syntax of text-style
3852 * \li Origin: leeming, 12 Mar 2003
3855 { LFUN_TEXTSTYLE_UPDATE, "textstyle-update", Noop, Layout },
3858 * \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
3859 * \li Action: Look up thesaurus entries with respect to the word under the cursor.
3860 * \li Syntax: thesaurus-entry [<STRING>] [lang=<LANG>]
3861 * \li Params: <STRING>: word to look up
3862 <LANG>: language (see file languages)
3863 * \li Origin: Levon, 20 Jul 2001
3866 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
3869 * \var lyx::FuncCode lyx::LFUN_TOOLBAR_MOVABLE
3870 * \li Action: Toggles movability of a given toolbar between true/false.
3871 * \li Syntax: toolbar-movable <NAME>
3872 * \li Params: <NAME>: *|standard|extra|table|math|mathmacrotemplate|
3873 minibuffer|review|view/update|math_panels|vcs|
3874 view-others|update-others
3875 * \li Origin: daniel, 12 July 2016
3878 { LFUN_TOOLBAR_MOVABLE, "toolbar-movable", NoBuffer, Buffer },
3881 * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
3882 * \li Action: Toggles visibility of a given toolbar between on/off/auto.
3883 * \li Notion: Skipping "auto" when allowauto is false.
3884 * \li Syntax: toolbar-toggle <NAME> [allowauto]
3885 * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|\n
3886 minibuffer|review|view/update|math_panels|vcs|
3887 view-others|update-others
3888 * \li Origin: Edwin, 21 May 2007
3891 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
3894 * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
3895 * \li Action: Various UI visibility-toggling actions.
3896 * \li Syntax: ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
3897 * \li Params: statusbar : Toggle visibility of the statusbar.\n
3898 menubar : Toggle visibility of the menubar.\n
3899 scrollbar : Toggle visibility of the scrollbar.\n
3900 frame : Toggle visibility of the frames around editing window.\n
3901 fullscreen : Toggle fullscreen mode. This also covers calling the
3902 previous functions. However #LFUN_TOOLBAR_TOGGLE for the
3903 custom tweaks of the toolbars should be used.
3904 * \li Origin: sanda, 9 Feb 2007
3907 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
3911 * \var lyx::FuncCode lyx::LFUN_UNDO
3912 * \li Action: Undoes the last edit.
3916 { LFUN_UNDO, "undo", ReadOnly, Edit },
3919 * \var lyx::FuncCode lyx::LFUN_UNICODE_INSERT
3920 * \li Action: Inserts a single unicode character.
3921 * \li Syntax: unicode-insert <CHAR1> <CHAR2> ...
3922 * \li Params: <CHARn>: The character to insert, given as its code
3923 point, in hexadecimal.
3924 * \li Sample: unicode-insert 0x0100 0x0259
3925 * \li Origin: Lgb, 22 Oct 2006
3928 { LFUN_UNICODE_INSERT, "unicode-insert", Noop, Edit },
3931 * \var lyx::FuncCode lyx::LFUN_UP
3932 * \li Action: Moves the cursor one line in upward direction.
3936 { LFUN_UP, "up", ReadOnly | NoUpdate, Edit },
3939 * \var lyx::FuncCode lyx::LFUN_UP_SELECT
3940 * \li Action: Moves the cursor one line in upward direction adding the current
3941 position to the selection.
3942 * \li Syntax: up-select
3945 { LFUN_UP_SELECT, "up-select", ReadOnly | SingleParUpdate, Edit },
3948 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_IN
3949 * \li Action: Checks-in/commits the changes of the registered file to the repository.
3950 * \li Notion: In RCS case this also unlocks the file.
3951 * \li Syntax: vc-check-in
3952 * \li Origin: Lgb, 1 Jul 1997
3955 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
3958 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_OUT
3959 * \li Action: Checks-out the document for edit (and locks it in some cases).
3960 * \li Syntax: vc-check-out
3961 * \li Origin: Lgb, 1 Jul 1997
3964 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
3967 * \var lyx::FuncCode lyx::LFUN_VC_COMMAND
3968 * \li Action: Executes external command. This command is intended to support
3969 additional VCS commands.
3970 * \li Syntax: vc-command <FLAG> <PATH> <COMMAND>
3971 * \li Params: <FLAG>: Flags for the command can be combined together.\n
3972 U - dUmmy - no flags \n
3973 D - Doc - need document loaded to proceed \n
3974 I - dIrty - mark document dirty \n
3975 R - Reload - ensure that the document is saved and reload it after command execution \n
3976 M - Message - ask for input string (commit message)\n
3977 <PATH>: path where to start. $$p will be replaced by the current document path.\n
3978 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current
3979 document(with absolute path)/path/message.
3980 * \li Sample: vc-command DR $$p "svn up"
3981 * \li Origin: sanda, 13 Jan 2009
3984 { LFUN_VC_COMMAND, "vc-command", NoBuffer | ReadOnly, System },
3987 * \var lyx::FuncCode lyx::LFUN_VC_COMPARE
3988 * \li Action: Compares two revisions of the same file under version control.
3989 * \li Syntax: vc-compare [<REV1>] [<REV2>]
3990 * \li Params: Revision number either points directly to commit in history
3991 or if negative number -x it points to (last commit - x).\n
3992 In RCS we subtract only in the last number of revision specification.
3993 Special case "0" is reserved for the last committed revision.\n
3994 <REV1>: Older file.\n
3995 <REV2>: Newer file. Used only if REV1 > 0.\n
3996 If no parameter is given, interactive dialog will be shown.
3997 * \li Sample: Compare current document against last commit\n
3999 Compare current document against current revision - 5 commits\n
4001 Compare revisions 120 and 155\n
4003 * \li Origin: sanda, 12 Feb 2010
4006 { LFUN_VC_COMPARE, "vc-compare", ReadOnly, System },
4010 * \var lyx::FuncCode lyx::LFUN_VC_COPY
4011 * \li Action: Copies the document to another name.
4012 * \li Notion: Copying with revision history is only supported by SVN.
4013 For RCS and CVS it is simulated by adding the document
4015 Disabled if uncommitted changes exist.
4016 * \li Syntax: vc-copy <FILENAME>
4017 * \li Params: <FILENAME>: New name of the document.\n
4018 * A file dialog is opened if no filename is given.
4019 * \li Origin: gb, 05 Feb 2013
4022 { LFUN_VC_COPY, "vc-copy", ReadOnly, System },
4025 * \var lyx::FuncCode lyx::LFUN_VC_LOCKING_TOGGLE
4026 * \li Action: Toggles the locking property of the edited file.
4027 * \li Notion: This is currently implemented only for SVN.
4028 * \li Syntax: vc-locking-toggle
4029 * \li Origin: sanda, 25 Jun 2009
4032 { LFUN_VC_LOCKING_TOGGLE, "vc-locking-toggle", ReadOnly, System },
4035 * \var lyx::FuncCode lyx::LFUN_VC_REGISTER
4036 * \li Action: Register the document as an file inside version control system.
4037 * \li Notion: File is registered inside cvs, svn or rcs repository acording to the existence
4038 of cvs/svn/rcs entries in the document's directory. \n
4039 See LyX Additional Features Manual (Version Control Chapter) for additional
4041 * \li Syntax: vc-register
4042 * \li Origin: Lgb, 1 Jul 1997
4045 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
4048 * \var lyx::FuncCode lyx::LFUN_VC_RENAME
4049 * \li Action: Renames the document to another name.
4050 * \li Notion: Renaming with revision history is only supported by SVN.
4051 For CVS it is simulated by adding the document under a new
4052 name and deleting the old one. For RCS it is not supported.
4053 Disabled if uncommitted changes exist.
4054 * \li Syntax: vc-rename <FILENAME>
4055 * \li Params: <FILENAME>: New name of the document.\n
4056 * A file dialog is opened if no filename is given.
4057 * \li Origin: gb, 05 Feb 2013
4060 { LFUN_VC_RENAME, "vc-rename", ReadOnly, System },
4063 * \var lyx::FuncCode lyx::LFUN_VC_REPO_UPDATE
4064 * \li Action: Update the local archive directory in which resides
4065 the current document with the remote repository.
4066 * \li Syntax: vc-repo-update
4067 * \li Origin: sanda, 16 Oct 2009
4070 { LFUN_VC_REPO_UPDATE, "vc-repo-update", ReadOnly, System },
4073 * \var lyx::FuncCode lyx::LFUN_VC_REVERT
4074 * \li Action: Reverts the document to the last check-in/commit in VCS.
4075 * \li Syntax: vc-revert
4076 * \li Origin: Lgb, 1 Jul 1997
4079 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
4082 * \var lyx::FuncCode lyx::LFUN_VC_UNDO_LAST
4083 * \li Action: Undo last check-in.
4084 * \li Notion: This is currently implemented only for RCS.
4085 * \li Syntax: vc-check-out
4086 * \li Origin: Lgb, 1 Jul 1997
4089 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
4092 * \var lyx::FuncCode lyx::LFUN_VIEW_CLOSE
4093 * \li Action: Close the current document work area.
4094 * \li Notion: Close the current work area. If no other work areas are showing the buffer,
4095 then close the associated buffer as well.
4096 * \li Syntax: view-close
4097 * \li Origin: Tommaso, 15 Sep 2012
4100 { LFUN_VIEW_CLOSE, "view-close", ReadOnly, Buffer },
4104 * \var lyx::FuncCode lyx::LFUN_VIEW_SPLIT
4105 * \li Action: Creates another split view of current buffer.
4106 * \li Notion: All split views act in the same way independently.
4107 * \li Syntax: view-split <vertical|horizontal>
4108 * \li Params: horizontal : The work areas are laid out side by side.\n
4109 vertical : The work areas laid out vertically.
4110 * \li Origin: Abdel, 20 Feb 2008
4113 { LFUN_VIEW_SPLIT, "view-split", ReadOnly, Buffer },
4117 * \var lyx::FuncCode lyx::LFUN_WINDOW_CLOSE
4118 * \li Action: Closes the current LyX window.
4119 * \li Syntax: window-close
4120 * \li Origin: Abdel, 23 Oct 2006
4123 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
4127 * \var lyx::FuncCode lyx::LFUN_WINDOW_NEW
4128 * \li Action: Creates new empty LyX window.
4129 * \li Notion: Already opened documents from the previous window can be found under View menu.
4130 * \li Syntax: window-new [<GEOMETRY>]
4131 * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently
4132 accepted only on Windows platform.
4133 * \li Origin: Abdel, 21 Oct 2006
4136 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
4139 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD
4140 * \li Action: Moves the cursor to the logically previous beginning of a word.
4141 * \li Notion: This is not the action which should be bound to the arrow keys,
4142 because backwards may be left or right, depending on the
4143 language. The arrow keys should be bound to #LFUN_WORD_LEFT or
4144 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
4145 * \li Syntax: word-backward
4148 { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit },
4151 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD_SELECT
4152 * \li Action: Moves the cursor to the logically previous beginning of a word,
4153 adding the logically traversed text to the selection.
4154 * \li Notion: See also #LFUN_WORD_BACKWARD.
4155 * \li Syntax: word-backward-select
4158 { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
4161 * \var lyx::FuncCode lyx::LFUN_WORD_CAPITALIZE
4162 * \li Action: Capitalizes the words in the selection (i.e. the first letters)
4163 or the first letter of word at cursor position.
4164 * \li Syntax: word-capitalize [<SEL_TYPE>]
4165 * \li Params: <SEL_TYPE>: if this is equal to "partial", then the
4166 * default word starts at cursor position (emacs-style).
4167 * Otherwise, the whole word is considered.
4170 { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
4173 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_BACKWARD
4174 * \li Action: Deletes characters to the beginning of the word (usually the "C+BackSpace" key).
4175 * \li Syntax: word-delete-backward [force]
4176 * \li Params: force: Delete big insets, do not only select them.
4179 { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
4182 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_FORWARD
4183 * \li Action: Deletes characters to the end of the word (usually the "C+Delete" key).
4184 * \li Syntax: word-delete-forward [force]
4185 * \li Params: force: Delete big insets, do not only select them.
4188 { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
4191 * \var lyx::FuncCode lyx::LFUN_WORD_FIND
4192 * \li Action: Search for next occurrence of a string.
4193 * \li Syntax: word-find [<DATA>]
4194 * \li Params: <DATA>: data encoded from Find dialog (see #lyx::find2string()).
4195 If no parameter is given, search with last find-dialog
4196 data is used for search (i.e. find-next).
4197 * \li Origin: Andre, Jan 7 2004
4200 { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
4203 * \var lyx::FuncCode lyx::LFUN_WORD_FINDADV
4204 * \li Action: Search for next occurrence of a pattern.
4205 * \li Syntax: word-findadv [<DATA>]
4206 * \li Params: <DATA>: data encoded from FindAdv dialog (see #lyx::findadv2string()).
4207 If no parameter is given, search with last find-dialog
4208 data is used for search (i.e. find-next).
4209 * \li Origin: Tommaso, Nov 15 2007
4212 { LFUN_WORD_FINDADV, "word-findadv", ReadOnly | NoBuffer, Edit },
4215 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_BACKWARD
4216 * \li Action: Search for a given string in backward direction.
4217 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
4218 * \li Syntax: word-find-backward [<STRING>]
4219 * \li Origin: Etienne, 20 Feb 1998
4222 { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
4225 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_FORWARD
4226 * \li Action: Search for a given string in forward direction.
4227 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
4228 * \li Syntax: word-find-forward [<STRING>]
4229 * \li Origin: Etienne, 16 Feb 1998
4232 { LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit },
4235 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD
4236 * \li Action: Moves the cursor to the logically next beginning of a word.
4237 * \li Notion: This is not the action which should be bound to the arrow keys,
4238 because forward may be left or right, depending on the language.
4239 The arrow keys should be bound to #LFUN_WORD_LEFT or
4240 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
4241 * \li Syntax: word-forward
4244 { LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
4247 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD_SELECT
4248 * \li Action: Moves the cursor to the logically next beginning of a word,
4249 adding the logically traversed text to the selection.
4250 * \li Notion: See also #LFUN_WORD_FORWARD.
4251 * \li Syntax: word-forward-select
4254 { LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
4257 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT
4258 * \li Action: Moves the cursor to the next beginning of a word "on the left".
4259 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
4260 "left" key is pressed. Generally, it moves the cursor to the
4261 next beginning of a word on the left. However, in Bidi text this
4262 become slightly more complicated, and there are different modes
4263 of cursor movement. In "visual mode", this moves left, plain and
4264 simple. In "logical mode", movement is logically forward in RTL
4265 paragraphs, and logically backwards in LTR paragraphs.
4266 * \li Syntax: word-left
4267 * \li Origin: dov, 28 Oct 2007
4270 { LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
4273 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT_SELECT
4274 * \li Action: Moves the cursor to the next beginning of a word "on the left",
4275 adding *logically* traversed text to the selection.
4276 * \li Notion: See also #LFUN_WORD_LEFT for exact details of the movement.
4277 * \li Syntax: word-left-select
4278 * \li Origin: dov, 28 Oct 2007
4281 { LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit },
4284 * \var lyx::FuncCode lyx::LFUN_WORD_LOWCASE
4285 * \li Action: Change the words in the selection or word at cursor position
4287 * \li Syntax: word-lowcase [<SEL_TYPE>]
4288 * \li Params: <SEL_TYPE>: if this is equal to "partial", then the
4289 * default word starts at cursor position (emacs-style).
4290 * Otherwise, the whole word is considered.
4293 { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
4296 * \var lyx::FuncCode lyx::LFUN_WORD_REPLACE
4297 * \li Action: Replace a string in the document.
4298 * \li Syntax: word-replace [<DATA>]
4299 * \li Params: <DATA>: data is of the form
4302 <casesensitive> <matchword> <all> <forward> <findnext>"
4303 * \li Origin: Andre, Jan 7 2004
4306 { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
4309 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT
4310 * \li Action: Moves the cursor to the next beginning of a word "on the right".
4311 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
4312 "right" key is pressed. Generally, it moves the cursor to the
4313 next beginning of a word on the right. However, in Bidi text
4314 this become slightly more complicated, and there are different
4315 modes of cursor movement. In "visual mode", this moves right,
4316 plain and simple. In "logical mode", movement is logically
4317 forward in LTR paragraphs, and logically backwards in RTL
4319 * \li Syntax: word-right
4320 * \li Origin: dov, 28 Oct 2007
4323 { LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit },
4326 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT_SELECT
4327 * \li Action: Moves the cursor to the next beginning of a word "on the right",
4328 adding *logically* traversed text to the selection.
4329 * \li Notion: See also #LFUN_WORD_RIGHT for exact details of the movement.
4330 * \li Syntax: word-right-select
4331 * \li Origin: dov, 28 Oct 2007
4334 { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
4337 * \var lyx::FuncCode lyx::LFUN_WORD_SELECT
4338 * \li Action: Puts the word where the cursor stands into the selection.
4339 * \li Syntax: word-select
4340 * \li Origin: Andre, 11 Sep 2002
4343 { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
4346 * \var lyx::FuncCode lyx::LFUN_WORD_UPCASE
4347 * \li Action: Change the words in the selection or word at cursor position
4349 * \li Syntax: word-upcase [<SEL_TYPE>]
4350 * \li Params: <SEL_TYPE>: if this is equal to "partial", then the
4351 * default word starts at cursor position (emacs-style).
4352 * Otherwise, the whole word is considered.
4355 { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
4358 * \var lyx::FuncCode lyx::LFUN_WRAP_INSERT
4359 * \li Action: Inserts floats wrapped by the text around.
4360 * \li Syntax: wrap-insert <TYPE>
4361 * \li Params: <TYPE>: table|figure
4362 * \li Origin: Dekel, 7 Apr 2002
4365 { LFUN_WRAP_INSERT, "wrap-insert", Noop, Edit },
4367 { LFUN_NOACTION, "", Noop, Hidden }
4368 #ifndef DOXYGEN_SHOULD_SKIP_THIS
4371 for (int i = 0; items[i].action != LFUN_NOACTION; ++i)
4372 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
4378 LyXAction::LyXAction()
4384 FuncRequest LyXAction::lookupFunc(string const & func) const
4386 string const func2 = trim(func);
4389 return FuncRequest(LFUN_NOACTION);
4392 string const arg = split(func2, cmd, ' ');
4394 FuncMap::const_iterator const fit = lyx_func_map.find(cmd);
4396 return fit != lyx_func_map.end()
4397 ? FuncRequest(fit->second, arg)
4398 : FuncRequest(LFUN_UNKNOWN_ACTION);
4402 string const LyXAction::getActionName(FuncCode action) const
4404 InfoMap::const_iterator const it = lyx_info_map.find(action);
4405 return it != lyx_info_map.end() ? it->second.name : string();
4409 LyXAction::FuncType LyXAction::getActionType(FuncCode action) const
4411 InfoMap::const_iterator const it = lyx_info_map.find(action);
4412 return it != lyx_info_map.end() ? it->second.type : Hidden;
4416 bool LyXAction::funcHasFlag(FuncCode action,
4417 LyXAction::FuncAttribs flag) const
4419 InfoMap::const_iterator ici = lyx_info_map.find(action);
4421 if (ici == lyx_info_map.end()) {
4422 LYXERR0("action: " << action << " is not known.");
4423 LASSERT(false, return false);
4426 return ici->second.attrib & flag;
4430 LyXAction::const_iterator LyXAction::func_begin() const
4432 return lyx_func_map.begin();
4436 LyXAction::const_iterator LyXAction::func_end() const
4438 return lyx_func_map.end();
4442 LyXErr & operator<<(LyXErr & l, FuncCode code)
4445 l.stream() << lyxaction.getActionName(code);