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_AUTO_SAVE
491 * \li Action: Saves the current buffer to a temporary file.
492 * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
493 is called automatically by LyX, to "autosave" the current buffer.
494 * \li Syntax: buffer-auto-save
497 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
500 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN
501 * \li Action: Move the cursor to the beginning of the document.
502 * \li Syntax: buffer-begin
505 { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
508 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN_SELECT
509 * \li Action: Move the cursor to the beginning of the document adding the
510 traversed text to the selection.
511 * \li Syntax: buffer-begin-select
514 { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
517 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHILD_OPEN
518 * \li Action: Loads the given child document.
519 * \li Notion: The current document is treated as a parent.
520 * \li Syntax: buffer-child-open <FILE>
521 * \li Params: <FILE>: Filename of the child. The directory of the parent is assumed by default.
522 * \li Origin: Ale, 28 May 1997
525 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
528 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHKTEX
529 * \li Action: Runs chktex for the current document.
530 * \li Syntax: buffer-chktex
531 * \li Origin: Asger, 30 Oct 1997
534 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
537 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
538 * \li Action: Closes the current buffer.
539 * \li Notion: Closes the current buffer, asking whether to save it, etc,
540 if the buffer has been modified.
541 * \li Syntax: buffer-close
544 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
547 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE_ALL
548 * \li Action: Closes all buffers.
549 * \li Notion: Closes all buffers, asking whether to save it, etc,
550 if a buffer has been modified.
551 * \li Syntax: buffer-close-all
554 { LFUN_BUFFER_CLOSE_ALL, "buffer-close-all", ReadOnly, Buffer },
557 * \var lyx::FuncCode lyx::LFUN_BUFFER_END
558 * \li Action: Move the cursor to the end of the document.
559 * \li Syntax: buffer-end
562 { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
565 * \var lyx::FuncCode lyx::LFUN_BUFFER_END_SELECT
566 * \li Action: Move the cursor to the end of the document adding the
567 traversed text to the selection.
568 * \li Syntax: buffer-end-select
571 { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
575 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
576 * \li Action: Exports the current buffer (document) to the given format.
577 * \li Syntax: buffer-export [<FORMAT>] [<DEST>]
578 * \li Params: <FORMAT> is either "custom" or one of the formats which you
579 can find in Tools->Preferences->File formats->Format.
580 Usual format you will enter is "pdf2" (pdflatex),
581 "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
582 In case of "custom" you will be asked for a format you
583 want to start from and for the command that you want to
584 apply to this format. Internally the control is then passed
585 to #LFUN_BUFFER_EXPORT_CUSTOM.\n
586 If absent or "default", then the default output format of the
588 <DEST> If present, this argument provides the export destination
589 filename. Its containing folder will also be the destination
590 folder, where all the needed external files will be copied.
591 * \li Origin: Lgb, 29 Jul 1997
594 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
597 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_AS
598 * \li Action: Opens a dialog for exporting the current buffer.
599 * \li Syntax: buffer-export-as [<FORMAT>]
600 * \li Params: <FORMAT> is the export format initially selected in the dialog.
601 * You can pass any of the formats which you can find in
602 * Tools->Preferences->File formats->Format, provided it
603 * has the "document" flag set. If no format is specified
604 * the dialog will start with the default output format of
605 * the current document.
606 * \li Sample: buffer-export-as pdf2
607 * \li Origin: tommaso, 6 Oct 2011
610 { LFUN_BUFFER_EXPORT_AS, "buffer-export-as", ReadOnly, Buffer },
613 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
614 * \li Action: Exports the current buffer (document) from the given format using
615 the given command on it.
616 * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
617 * \li Params: <FORMAT> format to start from (LyX will care to produce such
618 intermediate file).\n
619 <COMMAND> this command will be launched on the file. Note that you can
620 use "$$FName" string to qualify the intermediate file.
621 * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
622 * \li Origin: leeming, 27 Mar 2004
625 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
628 * \var lyx::FuncCode lyx::LFUN_BUFFER_FORALL
629 * \li Action: Applies a command to all non-hidden buffers.
630 * \li Notion: a buffer is `hidden' if it is internally open in LyX, but not
631 visible in any window.
632 * \li Syntax: buffer-forall <LFUN-COMMAND>
633 * \li Params: <LFUN-COMMAND>: The command to be applied to the buffers.
634 * \li Sample: Close all Notes in buffers: \n
635 buffer-forall inset-forall Note inset-toggle close \n
636 Toggle change tracking on buffers: \n
637 buffer-forall changes-track \n
638 Toggle read-only for buffers: \n
639 buffer-forall buffer-toggle-read-only \n
640 Show statistics for individual buffers: \n
641 buffer-forall statistics \n
642 Activate the branch named "Solutions" in buffers: \n
643 buffer-forall branch-activate Solutions \n
644 Export buffers to PDF (pdflatex): \n
645 buffer-forall buffer-export pdf2 \n
646 * \li Origin: skostysh, 20 Jul 2012
649 { LFUN_BUFFER_FORALL, "buffer-forall", ReadOnly | Argument, Buffer },
652 * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
653 * \li Action: Import a given file as a lyx document.
654 * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
655 defined converters in preferences. Look in the File->Import menu to get
656 an idea of the currently active import formats.
657 * \li Syntax: buffer-import <FORMAT> [<FILE>]
658 * \li Origin: Asger, 24 Jul 1998
661 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
664 * \var lyx::FuncCode lyx::LFUN_BUFFER_LANGUAGE
665 * \li Action: Set language of the current document.
666 * \li Syntax: buffer-language <LANG>
667 * \li Params: <LANG>: language name. See lib/languages for list.
668 * \li Origin: leeming, 30 Mar 2004
671 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
674 * \var lyx::FuncCode lyx::LFUN_BUFFER_MOVE_NEXT
675 * \li Action: Moves the current tab one spot to the right.
676 * \li Syntax: buffer-move-next
677 * \li Origin: skostysh, 7 Apr 2015
680 { LFUN_BUFFER_MOVE_NEXT, "buffer-move-next", ReadOnly, Buffer },
683 * \var lyx::FuncCode lyx::LFUN_BUFFER_MOVE_PREVIOUS
684 * \li Action: Moves the current tab one spot to the left.
685 * \li Syntax: buffer-move-previous
686 * \li Origin: skostysh, 7 Apr 2015
689 { LFUN_BUFFER_MOVE_PREVIOUS, "buffer-move-previous", ReadOnly, Buffer },
692 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
693 * \li Action: Creates a new buffer (that is, document) and switches to it.
694 * \li Notion: Implicit path can be set in Preferences dialog.
695 * \li Syntax: buffer-new [<FILE>]
696 * \li Params: <FILE>: filename of created file with absolute path.
699 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
702 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
703 * \li Action: Creates a new buffer (that is, document) from a template.
704 * \li Notion: Path for new files and templates can be set in Preferences dialog.
705 Template will be asked for via Open-dialog.
706 * \li Syntax: buffer-new-template [<FILE>]
707 * \li Params: <FILE>: filename of created file with absolute path.
710 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
713 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEXT
714 * \li Action: Switch to the next opened document.
715 * \li Notion: Note that this does not necessarily mean next in tabbar
716 (for full list see View menu).
717 * \li Syntax: buffer-next
720 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
723 * \var lyx::FuncCode lyx::LFUN_BUFFER_PARAMS_APPLY
724 * \li Action: Apply the given settings to the current document.
725 * \li Syntax: buffer-params-apply [<ARGS>]
726 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
727 you can find in document header of usual .lyx file.
728 * \li Origin: leeming, 30 Mar 2004
731 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", NoInternal, Buffer },
735 * \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS
736 * \li Action: Switch to the previous opened document.
737 * \li Syntax: buffer-previous
740 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
743 * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
744 * \li Action: Reverts opened document.
745 * \li Syntax: buffer-reload
746 * \li Origin: Asger, 2 Feb 1997
749 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
752 * \var lyx::FuncCode lyx::LFUN_BUFFER_SAVE_AS_DEFAULT
753 * \li Action: Save the current document settings as default.
754 * \li Notion: The file will will be saved into ~/.lyx/templates/defaults.lyx .
755 * \li Syntax: buffer-save-as-default [<ARGS>]
756 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
757 you can find in document header of usual .lyx file.
758 * \li Origin: leeming, 30 Mar 2004
761 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
764 * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
765 * \li Action: Display and switch to the given buffer.
766 * \li Syntax: buffer-switch <BUFFER>
767 * \li Params: <BUFFER>: path and filename of already opened (but possibly hidden)
768 document which is to be shown.
771 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
774 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
775 * \li Action: Toggles compression of the current document on/off.
776 * \li Syntax: buffer-toggle-compression
777 * \li Origin: bpeng, 27 Apr 2006
780 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
783 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_OUTPUT_SYNC
784 * \li Action: Toggles including of resources for forward/reverse search of the given document.
785 * \li Notion: When toggled on, SyncTeX is invoked for PDF, while srcltx package
786 is used for DVI. Custom LaTeX macro can be defined in preferences.
787 * \li Syntax: buffer-toggle-output-sync
788 * \li Origin: sanda, 25 May 2010
791 { LFUN_BUFFER_TOGGLE_OUTPUT_SYNC, "buffer-toggle-output-sync", Noop, System },
794 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
795 * \li Action: Toggle editing mode of the current document between read/write and read-only.
796 * \li Notion: This function is not allowed if the file is under version control, since
797 read-only flag is often used in version control file locking.
798 * \li Syntax: buffer-toggle-read-only
799 * \li Origin: Lgb, 27 May 1997
802 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
805 * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
806 * \li Action: Exports the current document and put the result into the
808 * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
809 the output will be rewritten - updated. This is useful in case your viewer
810 is able to detect such changes (e.g. ghostview for postscript).
811 * \li Syntax: buffer-update [<FORMAT>]
812 * \li Params: <FORMAT>: The format to display, where this is one of the
813 formats defined (in the current GUI) in the
814 Tools>Preferences>File Formats dialog.
815 If no format is given, the default format as
816 specified in the same dialog is used.
817 * \li Origin: Dekel, 5 Aug 2000
820 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
824 * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
825 * \li Action: Displays current buffer in chosen format.
826 * \li Notion: Displays the contents of the current buffer in the chosen
827 format, for example, PDF or DVI. This runs the necessary
828 converter, calls the defined viewer, and so forth.
829 * \li Syntax: buffer-view [<FORMAT>]
830 * \li Params: <FORMAT>: The format to display, where this is one of the
831 formats defined (in the current GUI) in the
832 Tools>Preferences>File Formats dialog.
833 If no format is given, the default format as
834 specified in the same dialog is used.
837 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
840 * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW_CACHE
841 * \li Action: Opens the file that was created from last preview of this buffer.
842 * \li Notion: This LFUN is called by the "Show Output Anyway" button in the LaTeX
843 * Errors dialog. It can also be called by the user, which is useful
844 * if the document takes a long time to compile, and you just
845 * want to see the last previewed version.
846 * \li Syntax: buffer-view-cache
849 { LFUN_BUFFER_VIEW_CACHE, "buffer-view-cache", ReadOnly, Buffer },
852 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
853 * \li Action: Saves the current buffer.
854 * \li Notion: Saves the current buffer to disk, using the filename that
855 is already associated with the buffer, asking for one if
856 none is yet assigned.
857 * \li Syntax: buffer-write
860 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
863 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
864 * \li Action: Save all changed documents.
865 * \li Syntax: buffer-write-all
866 * \li Origin: rgh, gpothier 6 Aug 2007
869 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
872 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
873 * \li Action: Rename and save current buffer.
874 * \li Syntax: buffer-write-as <FILENAME>
875 * \li Params: <FILENAME>: New name of the buffer/file. A relative path
876 is with respect to the original location of the buffer/file.
879 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
882 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXTERNAL_MODIFICATION_CLEAR
883 * \li Action: Clear the external modification flag on the current buffer.
884 * \li Syntax: buffer-external-modification-clear
885 * \li Origin: gm, 2 March 2017
888 { LFUN_BUFFER_EXTERNAL_MODIFICATION_CLEAR,
889 "buffer-external-modification-clear", ReadOnly, Buffer },
892 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM
893 * \li Action: Sets the zoom of the screen fonts.
894 * \li Syntax: buffer-zoom [<ZOOM>]
895 * \li Params: <ZOOM>: The zoom in % points (neg. or pos.), the default is to reset to zoom savd in preferences.
896 * \li Origin: daniel, 28 Oct 2016
899 { LFUN_BUFFER_ZOOM, "buffer-zoom", ReadOnly, Buffer },
902 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_IN
903 * \li Action: Increases the zoom of the screen fonts.
904 * \li Syntax: buffer-zoom-in [<ZOOM>]
905 * \li Params: <ZOOM>: The zoom in % points (neg. or pos.), the default is 20.
906 * \li Origin: vfr, 30 Mar 2009
909 { LFUN_BUFFER_ZOOM_IN, "buffer-zoom-in", ReadOnly, Buffer },
913 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_OUT
914 * \li Action: Decreases the zoom of the screen fonts.
915 * \li Syntax: buffer-zoom-out [<ZOOM>]
916 * \li Params: <ZOOM>: The zoom in % points (neg. or pos.), the default is -20.
917 * \li Origin: vfr, 30 Mar 2009
920 { LFUN_BUFFER_ZOOM_OUT, "buffer-zoom-out", ReadOnly, Buffer },
924 * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
925 * \li Action: Generates the code (literate programming).
926 * \li Notion: Latex file with extension \literate_extension is generated.
927 Then LyX invokes \build_command (with a default of ``make'') to generate the code and
928 \build_error_filter to process the compilation error messages. \n
929 In case you want to process your literate file with a script, or some other program,
930 just insert in your lyxrc file an entry with:\n
931 \build_command "my_script my_arguments" \n
932 The \build_error_filter differs from the \literate_error_filter only in that the
933 former will identify error messages from your compiler.
934 * \li Syntax: build-program
937 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
941 * \var lyx::FuncCode lyx::LFUN_CALL
942 * \li Action: Executes a command defined in a .def file.
943 * \li Notion: The definitions are by default read from lib/commands/default.def.\n
944 A .def file allows to define a command with \define "<NAME>" "<LFUN>"
945 where <NAME> is the name of the new command and <LFUN> is the lfun code
946 to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
947 \def_file "FileName" allows to include another .def file. \n
948 This is particularly useful in connection with toolbar buttons:
949 Since the name of the button image for this lfun is
950 lib/images/commands/<NAME>.png this is the way to assign an image
951 to a complex command-sequence.
952 * \li Syntax: call <NAME>
953 * \li Params: <NAME>: Name of the command that must be called.
954 * \li Origin: broider, 2 Oct 2007
957 { LFUN_CALL, "call", NoBuffer, System },
960 * \var lyx::FuncCode lyx::LFUN_CANCEL
961 * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
965 { LFUN_CANCEL, "cancel", NoBuffer, System },
969 * \var lyx::FuncCode lyx::LFUN_CAPTION_INSERT
970 * \li Action: Inserts a caption inset.
971 * \li Syntax: caption-insert
972 * \li Origin: Lgb, 18 Jul 2000
975 { LFUN_CAPTION_INSERT, "caption-insert", Noop, Edit },
978 * \var lyx::FuncCode lyx::LFUN_CELL_BACKWARD
979 * \li Action: Moves the cursor to the previous cell inside the table.
980 * \li Syntax: cell-backward
981 * \li Origin: Jug, 22 May 2000
984 { LFUN_CELL_BACKWARD, "cell-backward", ReadOnly | NoUpdate, Edit },
987 * \var lyx::FuncCode lyx::LFUN_CELL_FORWARD
988 * \li Action: Moves the cursor to the next cell inside the table.
989 * \li Syntax: cell-forward
992 { LFUN_CELL_FORWARD, "cell-forward", ReadOnly | NoUpdate, Edit },
995 * \var lyx::FuncCode lyx::LFUN_CELL_SPLIT
996 * \li Action: Splits cell and shifts right part to the next cell (inside the math grid).
997 * \li Syntax: cell-split
998 * \li Origin: Ale, 15 May 1997
1001 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
1005 * \var lyx::FuncCode lyx::LFUN_CHANGES_MERGE
1006 * \li Action: Open change tracking dialog for merging and moves the cursor
1007 to the position of the next change.
1008 * \li Syntax: changes-merge
1009 * \li Origin: Levon, 16 Oct 2002
1012 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
1015 * \var lyx::FuncCode lyx::LFUN_CHANGES_OUTPUT
1016 * \li Action: Toggles showing of change tracking in typeset output.
1017 * \li Syntax: changes-output
1018 * \li Origin: jspitzm, 21 Jan 2005
1021 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
1024 * \var lyx::FuncCode lyx::LFUN_CHANGES_TRACK
1025 * \li Action: Toggles change tracking to on/off.
1026 * \li Syntax: changes-track
1027 * \li Origin: levon, 1 Oct 2002
1030 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
1033 * \var lyx::FuncCode lyx::LFUN_CHANGE_ACCEPT
1034 * \li Action: Accepts tracked change inside the selection.
1035 * \li Syntax: change-accept
1036 * \li Origin: Levon, 16 Oct 2002
1039 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
1042 * \var lyx::FuncCode lyx::LFUN_CHANGE_NEXT
1043 * \li Action: Moves the cursor to the position of the next change
1044 of the change tracking records.
1045 * \li Syntax: change-next
1046 * \li Origin: schmitt, 4 Oct 2006
1049 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
1052 * \var lyx::FuncCode lyx::LFUN_CHANGE_PREVIOUS
1053 * \li Action: Moves the cursor to the position of the previous change
1054 of the change tracking records.
1055 * \li Syntax: change-previous
1056 * \li Origin: vfr, 4 Apr 2009
1059 { LFUN_CHANGE_PREVIOUS, "change-previous", ReadOnly, Edit },
1062 * \var lyx::FuncCode lyx::LFUN_CHANGE_REJECT
1063 * \li Action: Rejects tracked change inside the selection.
1064 * \li Syntax: change-reject
1065 * \li Origin: Levon, 16 Oct 2002
1068 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
1071 * \var lyx::FuncCode lyx::LFUN_CHARS_TRANSPOSE
1072 * \li Action: Transposes the character at the cursor with the one before it.
1073 * \li Syntax: chars-transpose
1074 * \li Origin: Lgb, 25 Apr 2001
1077 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
1081 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD
1082 * \li Action: Moves the cursor one position logically backwards.
1083 * \li Notion: This is not the action which should be bound to the arrow keys,
1084 because backwards may be left or right, depending on the
1085 language. The arrow keys should be bound to #LFUN_CHAR_LEFT or
1086 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
1087 * \li Syntax: char-backward
1090 { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit },
1093 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD_SELECT
1094 * \li Action: Moves the cursor one position logically backwards, adding
1095 traversed position to the selection.
1096 * \li Notion: See also #LFUN_CHAR_BACKWARD.
1097 * \li Syntax: char-backward-select
1100 { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit },
1103 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_BACKWARD
1104 * \li Action: Deletes one character in the backward direction (usually the "BackSpace" key).
1105 * \li Syntax: char-delete-backward [force]
1106 * \li Params: force: Delete big insets, do not only select them.
1109 { LFUN_CHAR_DELETE_BACKWARD, "char-delete-backward", SingleParUpdate, Edit },
1112 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_FORWARD
1113 * \li Action: Deletes one character in the backward direction (usually the "Delete" key).
1114 * \li Syntax: char-delete-forward [force]
1115 * \li Params: force: Delete big insets, do not only select them.
1118 { LFUN_CHAR_DELETE_FORWARD, "char-delete-forward", SingleParUpdate, Edit },
1121 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD
1122 * \li Action: Moves the cursor one position logically forward.
1123 * \li Notion: This is not the action which should be bound to the arrow keys,
1124 because forward may be left or right, depending on the language.
1125 The arrow keys should be bound to #LFUN_CHAR_LEFT or
1126 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
1127 * \li Syntax: char-forward
1130 { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit },
1133 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD_SELECT
1134 * \li Action: Moves the cursor one position logically forward, adding
1135 traversed position to the selection.
1136 * \li Notion: See also #LFUN_CHAR_FORWARD.
1137 * \li Syntax: char-forward-select
1140 { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit },
1143 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT
1144 * \li Action: Moves the cursor one position "to the left".
1145 * \li Notion: This is the action which should be taken when the "left" key
1146 is pressed. Generally, it moves the cursor one position to the
1147 left. However, in Bidi text this become slightly more
1148 complicated, and there are different modes of cursor movement.
1149 In "visual mode", this moves left, plain and simple. In "logical
1150 mode", movement is logically forward in RTL paragraphs, and
1151 logically backwards in LTR paragraphs.
1152 * \li Syntax: char-left
1155 { LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit },
1158 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT_SELECT
1159 * \li Action: Moves the cursor one position "to the left", adding
1160 traversed position to the selection.
1161 * \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement.
1162 * \li Syntax: char-left-select
1165 { LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit },
1168 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT
1169 * \li Action: Moves the cursor one position "to the right".
1170 * \li Notion: This is the action which should be taken when the "right" key
1171 is pressed. Generally, it moves the cursor one position to the
1172 right. However, in Bidi text this become slightly more
1173 complicated, and there are different modes of cursor movement.
1174 In "visual mode", this moves right, plain and simple. In "logical
1175 mode", movement is logically forward in LTR paragraphs, and
1176 logically backwards in RTL paragraphs.
1177 * \li Syntax: char-right
1180 { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit },
1183 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT_SELECT
1184 * \li Action: Moves the cursor one position "to the right", adding
1185 traversed position to the selection.
1186 * \li Notion: See also #LFUN_CHAR_RIGHT for exact details of the movement.
1187 * \li Syntax: char-right-select
1190 { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit },
1194 * \var lyx::FuncCode lyx::LFUN_CITATION_INSERT
1195 * \li Action: Inserts citation from loaded citation database.
1196 * \li Syntax: citation-insert [<KEY>[|<TEXT_BEFORE>]]
1197 * \li Params: <KEY>: Citation (shortcut listed in available citations). \n
1198 <TEXT_BEFORE>: text which should appear before citation.
1199 * \li Origin: AAS, 97-02-23
1202 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
1205 * \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE
1206 * \li Action: Pastes text from the active clipboard (retains formatting if the
1207 clipboard contains formatted text). Pastes plain text if plain text is
1208 on the clipboard, but tries to interpret it in special ways for certain
1209 insets, e.g. converting csv data to rows and columns if the paste happens
1211 * \li Notion: Historically, LFUN_CLIPBOARD_PASTE was introduced as a counterpart of
1212 LFUN_PRIMARY_SELECTION_PASTE: It behaved exactly the same, but the source
1213 is the clipboard, not the selection.
1214 * \li Syntax: clipboard-paste [<ARG>]
1215 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1216 * \li Origin: Georg, 10 Jul 2006
1219 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
1222 * \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE_SIMPLE
1223 * \li Action: Pastes plain text from the active clipboard even if formatted
1224 LyX content is in the clipboard. Pastes plain text if plain text
1225 is on the clipboard, without trying to interpret it in special
1226 ways for certain insets, e.g. converting csv data to rows and
1227 columns if the paste happens in a tabular inset.
1228 * \li Syntax: clipboard-paste-simple [<ARG>]
1229 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1232 { LFUN_CLIPBOARD_PASTE_SIMPLE, "clipboard-paste-simple", Noop, Edit },
1235 * \var lyx::FuncCode lyx::LFUN_COMMAND_ALTERNATIVES
1236 * \li Action: Runs the first listed command that is enabled.
1237 * \li Notion: This can be used to bind multiple functions to a single key,
1238 and then which one is used will depend upon the context.
1239 * \li Syntax: command-alternatives <CMDS>
1240 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
1241 * \li Sample: command-alternatives completion-accept;cell-forward
1242 * \li Origin: rgh, 24 September 2008
1245 { LFUN_COMMAND_ALTERNATIVES, "command-alternatives", NoBuffer, System },
1248 * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
1249 * \li Action: Switches the focus to the minibuffer so that the user can type
1250 in there. If necessary, it opens the minibuffer toolbar.
1251 * \li Notion: Usually bound to M-x shortcut.
1252 * \li Syntax: command-execute
1255 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
1259 * \var lyx::FuncCode lyx::LFUN_COMMAND_PREFIX
1260 * \li Action: Return the current key sequence and available options as a string.
1261 * \li Notion: No options are added if no current map exists. \n
1262 This is probably usable only with connection to lyxserver.
1263 * \li Syntax: command-prefix
1266 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
1269 * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
1270 * \li Action: Run more commands (LFUN and its parameters) in a sequence.
1271 * \li Syntax: command-sequence <CMDS>
1272 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
1273 * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
1274 * \li Origin: Andre, 11 Nov 1999
1277 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
1280 * \var lyx::FuncCode lyx::LFUN_COMPLETE
1281 * \li Action: Try to complete the word or command at the cursor position.
1282 * \li Syntax: complete
1283 * \li Origin: sts, Feb 19 2008
1286 { LFUN_COMPLETE, "complete", SingleParUpdate, Edit },
1290 * \var lyx::FuncCode lyx::LFUN_COMPLETION_ACCEPT
1291 * \li Action: Accept suggested completion.
1292 * \li Syntax: completion-accept
1293 * \li Origin: sanda, Sep 08 2008
1296 { LFUN_COMPLETION_ACCEPT, "completion-accept", SingleParUpdate, Edit },
1301 * \var lyx::FuncCode lyx::LFUN_COMPLETION_CANCEL
1302 * \li Action: Try to cancel completion, either the popup or the inline completion.
1303 * \li Syntax: completion-cancel
1304 * \li Origin: sts, Sep 07 2008
1307 { LFUN_COMPLETION_CANCEL, "completion-cancel", SingleParUpdate, Edit },
1310 * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
1311 * \li Action: Show the inline completion at the cursor position.
1312 * \li Syntax: completion-inline
1313 * \li Origin: sts, Feb 19 2008
1316 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
1319 * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
1320 * \li Action: Show the completion popup at the cursor position.
1321 * \li Syntax: completion-popup
1322 * \li Origin: sts, Feb 19 2008
1325 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
1328 * \var lyx::FuncCode lyx::LFUN_COPY
1329 * \li Action: Copies the current selection to the clipboard.
1333 { LFUN_COPY, "copy", ReadOnly, Edit },
1336 * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
1337 * \li Action: Determine whether to keep cursor inside the editing window regardless
1338 of the scrollbar movement.
1339 * \li Syntax: toggle-cursor-follows-scrollbar
1340 * \li Origin: ARRae, 2 Dec 1997
1343 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
1346 * \var lyx::FuncCode lyx::LFUN_CUT
1347 * \li Action: Cuts to the clipboard.
1351 { LFUN_CUT, "cut", Noop, Edit },
1354 * \var lyx::FuncCode lyx::LFUN_DATE_INSERT
1355 * \li Action: Inserts the current date.
1356 * \li Syntax: date-insert [<ARG>]
1357 * \li Params: <ARG>: Format of date. The default value (%x) can be set
1358 in Preferences->Date format. For possible formats
1359 see manual page of strftime function.
1360 * \li Origin: jdblair, 31 Jan 2000
1363 { LFUN_DATE_INSERT, "date-insert", Noop, Edit },
1366 * \var lyx::FuncCode lyx::LFUN_DEBUG_LEVEL_SET
1367 * \li Action: Set debug output level.
1368 * \li Syntax: debug-level-set <LEVEL>
1369 * \li Params: <LEVEL>: comma separated list of levels or the correspondent number
1370 of their combination. 0 is equivalent to disabling all debug
1371 events. See lyx -dbg for the current list of debug levels
1373 * \li Origin: sanda, 28 Dec 2009
1376 { LFUN_DEBUG_LEVEL_SET, "debug-level-set", NoBuffer, System },
1380 * \var lyx::FuncCode lyx::LFUN_DEPTH_DECREMENT
1381 * \li Action: Decrease the nesting depth of the (selected) paragraph(s)
1383 * \li Syntax: depth-decrement
1386 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
1389 * \var lyx::FuncCode lyx::LFUN_DEPTH_INCREMENT
1390 * \li Action: Increase the nesting depth of the (selected) paragraph(s)
1392 * \li Syntax: depth-increment
1395 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
1399 * \var lyx::FuncCode lyx::LFUN_DEVEL_MODE_TOGGLE
1400 * \li Action: toggle a mode where more information is given in UI
1401 * \li Syntax: devel-mode-toggle
1402 * \li Notion: in so called "devel" mode, the information given in the
1403 * status bar is more precise, and the help documents are
1404 * open in editing mode.
1405 * \li Origin: lasgouttes, 23 Jul 2017
1408 { LFUN_DEVEL_MODE_TOGGLE, "devel-mode-toggle", NoBuffer, System },
1412 * \var lyx::FuncCode lyx::LFUN_DIALOG_DISCONNECT_INSET
1413 * \li Action: Closes opened connection to opened inset.
1414 * \li Notion: Connection is used for apply functions.
1415 * \li Syntax: dialog-disconnect-inset <INSET-NAME>
1416 * \li Origin: leeming, 25 Feb 2003
1419 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
1423 * \var lyx::FuncCode lyx::LFUN_DIALOG_HIDE
1424 * \li Action: Hides showed dialog. Counterpart to #LFUN_DIALOG_SHOW .
1425 * \li Syntax: dialog-hide <NAME>
1426 * \li Params: See #LFUN_DIALOG_SHOW .
1427 * \li Origin: leeming, 25 Feb 2003
1430 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
1433 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW
1434 * \li Action: Shows hidden dialog or creates new one for a given function/inset settings etc.
1435 * \li Syntax: dialog-show <NAME> [<DATA>]
1436 * \li Params: <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|\n
1437 compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|\n
1438 graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimiter|\n
1439 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|\n
1440 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|\n
1441 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL> \n
1442 <SPECIAL>: latexlog|vclog \n
1443 <DATA>: data, usually settings for the given dialog. Use debug mode for the
1445 * \li Origin: leeming, 17 Jun 2003
1448 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
1451 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW_NEW_INSET
1452 * \li Action: Shows hidden dialog or create new one for a given inset settings etc.
1453 * \li Notion: Internally uses #LFUN_DIALOG_SHOW with processed data for a given inset.
1454 * \li Syntax: dialog-show-new-inset <NAME> [<DATA>]
1455 * \li Params: See #LFUN_DIALOG_SHOW .
1456 * \li Origin: leeming, 25 Feb 2003
1459 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
1462 * \var lyx::FuncCode lyx::LFUN_DIALOG_TOGGLE
1463 * \li Action: Toggles dialog between showed/hidden state.
1464 * \li Notion: Internally uses #LFUN_DIALOG_SHOW , #LFUN_DIALOG_HIDE .
1465 * \li Syntax: dialog-toggle <NAME> [<DATA>]
1466 * \li Params: See #LFUN_DIALOG_SHOW .
1467 * \li Origin: JSpitzm, 30 Apr 2007
1470 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
1473 * \var lyx::FuncCode lyx::LFUN_DIALOG_UPDATE
1474 * \li Action: Updates the dialog values from the inset/paragraph/document.
1475 * \li Syntax: dialog-update <NAME>
1476 * \li Params: <NAME>: paragraph|prefs|<INSET> \n
1478 * \li Origin: leeming, 25 Feb 2003
1481 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
1484 * \var lyx::FuncCode lyx::LFUN_DOWN
1485 * \li Action: Moves the cursor one line in downward direction.
1489 { LFUN_DOWN, "down", ReadOnly | NoUpdate, Edit },
1492 * \var lyx::FuncCode lyx::LFUN_DOWN_SELECT
1493 * \li Action: Moves the cursor one line in downward direction adding the current
1494 position to the selection.
1495 * \li Syntax: down-select
1498 { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, Edit },
1501 * \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE
1502 * \li Action: Displays list of layout choices.
1503 * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
1504 dropbox allowing for choice of layout.
1505 * \li Syntax: drop-layouts-choice
1508 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
1511 * \var lyx::FuncCode lyx::LFUN_ENVIRONMENT_SPLIT
1512 * \li Action: Splits the current environment with a Separator.
1513 * \li Syntax: environment-split [outer]
1514 * \li Params: outer: If this is given, LyX will split the outermost environment in
1515 * the current nesting hierarchy.
1516 * \li Origin: spitz, 23 Dec 2012
1519 { LFUN_ENVIRONMENT_SPLIT, "environment-split", Noop, Layout },
1523 * \var lyx::FuncCode lyx::LFUN_ERT_INSERT
1524 * \li Action: Inserts an ERT inset.
1525 * \li Syntax: ert-insert
1526 * \li Origin: Jug, 18 Feb 2000
1529 { LFUN_ERT_INSERT, "ert-insert", Noop, Edit },
1532 * \var lyx::FuncCode lyx::LFUN_ESCAPE
1533 * \li Action: Clears the selection. If no text is selected call #LFUN_FINISHED_FORWARD.
1534 Inside math mode jumps out of the math inset.
1535 * \li Syntax: escape
1536 * \li Origin: Lgb, 17 May 2001
1539 { LFUN_ESCAPE, "escape", ReadOnly, Edit },
1542 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
1543 * \li Action: Inserts another LyX file.
1544 * \li Syntax: file-insert [<FILE>]
1545 * \li Params: <FILE>: Filename to be inserted.
1548 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
1551 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
1552 * \li Action: Inserts plain text file.
1553 * \li Syntax: file-insert-plaintext [<FILE>]
1554 * \li Params: <FILE>: Filename to be inserted.
1555 * \li Origin: CFO-G, 19 Nov 1997
1558 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
1561 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
1562 * \li Action: Inserts plain text file as paragraph (i.e. join lines).
1563 * \li Syntax: file-insert-plaintext-para [<FILE>]
1564 * \li Params: <FILE>: Filename to be inserted.
1565 * \li Origin: Levon, 14 Feb 2001
1568 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
1571 * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
1572 * \li Action: Open LyX document.
1573 * \li Syntax: file-open [<FILE>]
1574 * \li Params: <FILE>: Filename to be opened.
1577 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
1581 * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
1582 * \li Action: Moves the cursor out of the current slice, going backwards.
1583 * \li Notion: See also #LFUN_FINISHED_FORWARD.
1586 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
1589 * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
1590 * \li Action: Moves the cursor out of the current slice, going forward.
1591 * \li Notion: Cursor movement within an inset may be different than cursor
1592 movement in the surrounding text. This action should be called
1593 automatically by the cursor movement within the inset, when
1594 movement within the inset has ceased (reached the end of the
1595 last paragraph, for example), in order to move correctly
1596 back into the surrounding text.
1599 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
1602 * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
1603 * \li Action: Moves the cursor out of the current slice, going left.
1604 * \li Notion: See also #LFUN_FINISHED_FORWARD.
1607 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
1611 * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
1612 * \li Action: Moves the cursor out of the current slice, going right.
1613 * \li Notion: See also #LFUN_FINISHED_FORWARD
1616 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
1619 * \var lyx::FuncCode lyx::LFUN_FLEX_INSERT
1620 * \li Action: Inserts CharStyle, Custom inset or XML short element.
1621 * \li Notion: Look into the Customization manual for more information about
1623 To make this command enabled the layout file for the document
1624 class you're using has to load the character styles. There are
1625 a few contained in the Logical Markup module. You can also of
1626 course create some yourself. \n
1627 For dissolving the element see #LFUN_INSET_DISSOLVE.
1628 * \li Syntax: flex-insert Name
1629 * \li Params: Name: This name must be defined either in your layout file
1630 or imported by some module. The definition is
1631 InsetLayout Name or InsetLayout <Flex:Name>. The Flex:
1633 * \li Sample: flex-insert Code
1636 { LFUN_FLEX_INSERT, "flex-insert", Noop, Edit },
1639 * \var lyx::FuncCode lyx::LFUN_FLOAT_INSERT
1640 * \li Action: Inserts a float inset.
1641 * \li Syntax: float-insert <TYPE>
1642 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
1643 "algorithm", "table", "figure" parameters can be given.
1644 * \li Origin: Lgb, 27 Jun 2000
1647 { LFUN_FLOAT_INSERT, "float-insert", Noop, Edit },
1650 * \var lyx::FuncCode lyx::LFUN_FLOAT_LIST_INSERT
1651 * \li Action: Inserts the list of floats in the document.
1652 * \li Syntax: float-list-insert <TYPE>
1653 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
1654 "algorithm", "table", "figure" parameters can be given.
1655 * \li Origin: Lgb, 3 May 2001
1658 { LFUN_FLOAT_LIST_INSERT, "float-list-insert", Noop, Edit },
1661 * \var lyx::FuncCode lyx::LFUN_FLOAT_WIDE_INSERT
1662 * \li Action: Inserts float insets as in #LFUN_FLOAT_INSERT but span multiple columns.
1663 * \li Notion: Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
1664 * \li Syntax: float-wide-insert <TYPE>
1665 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
1666 "algorithm", "table", "figure" parameters can be given.
1667 * \li Origin: Lgb, 31 Oct 2001
1670 { LFUN_FLOAT_WIDE_INSERT, "float-wide-insert", Noop, Edit },
1673 * \var lyx::FuncCode lyx::LFUN_FONT_BOLD
1674 * \li Action: Toggles the bold font (selection-wise) using mathbf in math.
1675 * \li Syntax: font-bold
1678 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
1682 * \var lyx::FuncCode lyx::LFUN_FONT_BOLDSYMBOL
1683 * \li Action: Toggles the bold font (selection-wise) using boldsymbol in math.
1684 * \li Syntax: font-boldsymbol
1687 { LFUN_FONT_BOLDSYMBOL, "font-boldsymbol", Noop, Layout },
1690 * \var lyx::FuncCode lyx::LFUN_FONT_DEFAULT
1691 * \li Action: Reverts the settings of the font to the default values (selection-wise).
1692 * \li Syntax: font-default
1695 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
1698 * \var lyx::FuncCode lyx::LFUN_FONT_EMPH
1699 * \li Action: Toggles the emphasis font style (selection-wise).
1700 * \li Syntax: font-emph
1703 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
1706 * \var lyx::FuncCode lyx::LFUN_FONT_FRAK
1707 * \li Action: Toggles Fraktur family font (math-mode, selection-wise).
1708 * \li Syntax: font-frak
1709 * \li Origin: vermeer, 10 Jan 2002
1712 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
1715 * \var lyx::FuncCode lyx::LFUN_FONT_ITAL
1716 * \li Action: Toggles Italics font shape (math-mode, selection-wise).
1717 * \li Syntax: font-ital
1718 * \li Origin: vermeer, 10 Jan 2002
1721 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
1724 * \var lyx::FuncCode lyx::LFUN_FONT_NOUN
1725 * \li Action: Toggles Noun text style font (selection-wise).
1726 * \li Syntax: font-noun
1729 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
1732 * \var lyx::FuncCode lyx::LFUN_FONT_ROMAN
1733 * \li Action: Toggles Roman family font (selection-wise).
1734 * \li Syntax: font-roman
1737 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
1740 * \var lyx::FuncCode lyx::LFUN_FONT_SANS
1741 * \li Action: Toggles Sans Serif family font (selection-wise).
1742 * \li Syntax: font-sans
1745 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
1748 * \var lyx::FuncCode lyx::LFUN_FONT_SIZE
1749 * \li Action: Sets font size according to lyx format string.
1750 * \li Syntax: font-size <SIZE>
1751 * \li Params: <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|\n
1752 largest|huge|giant|increase|decrease|default
1755 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
1758 * \var lyx::FuncCode lyx::LFUN_FONT_STATE
1759 * \li Action: Returns the info about the current font.
1760 * \li Syntax: font-state
1763 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
1767 * \var lyx::FuncCode lyx::LFUN_FONT_STRIKEOUT
1768 * \li Action: Toggles strikeout (strike-through) in the font (selection-wise).
1769 * \li Syntax: font-strikeout
1770 * \li Origin: sanda, 3 May 2009
1773 { LFUN_FONT_STRIKEOUT, "font-strikeout", Noop, Layout },
1776 * \var lyx::FuncCode lyx::LFUN_FONT_CROSSOUT
1777 * \li Action: Toggles xout (cross-through) in the font (selection-wise).
1778 * \li Syntax: font-crossout
1779 * \li Origin: uwestoehr, 4 April 2017
1782 { LFUN_FONT_CROSSOUT, "font-crossout", Noop, Layout },
1785 * \var lyx::FuncCode lyx::LFUN_FONT_TYPEWRITER
1786 * \li Action: Toggles the typewriter family font (selection-wise).
1787 * \li Syntax: font-typewriter
1790 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
1793 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERLINE
1794 * \li Action: Toggles underline in the font (selection-wise).
1795 * \li Syntax: font-underline
1798 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
1801 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERUNDERLINE
1802 * \li Action: Toggles double underline in the font (selection-wise).
1803 * \li Syntax: font-underunderline
1804 * \li Origin: sanda, 5 May 2009
1807 { LFUN_FONT_UNDERUNDERLINE, "font-underunderline", Noop, Layout },
1810 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERWAVE
1811 * \li Action: Toggles wavy underline in the font (selection-wise).
1812 * \li Syntax: font-underwave
1813 * \li Origin: sanda, 5 May 2009
1816 { LFUN_FONT_UNDERWAVE, "font-underwave", Noop, Layout },
1819 * \var lyx::FuncCode lyx::LFUN_FOOTNOTE_INSERT
1820 * \li Action: Inserts a footnote inset.
1821 * \li Syntax: footnote-insert
1822 * \li Origin: Jug, 7 Mar 2000
1825 { LFUN_FOOTNOTE_INSERT, "footnote-insert", Noop, Edit },
1828 * \var lyx::FuncCode lyx::LFUN_FORWARD_SEARCH
1829 * \li Action: Sets the cursor position in the previewed (dvi/pdf) file based on the row
1830 number in LyX window.
1831 * \li Notion: The external program used for forward search call can be specified in
1832 LyX Output preferences. See Additional manual for details of these
1834 * \li Syntax: forward-search
1835 * \li Origin: sanda, 14 Apr 2010
1838 { LFUN_FORWARD_SEARCH, "forward-search", ReadOnly, System },
1841 * \var lyx::FuncCode lyx::LFUN_GRAPHICS_RELOAD
1842 * \li Action: Reloads the image if necessary.
1843 * \li Syntax: graphics-reload
1844 * \li Origin: vfr, 10 Aug 2009
1847 { LFUN_GRAPHICS_RELOAD, "graphics-reload", ReadOnly | AtPoint, Edit },
1850 * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
1851 * \li Action: Open the given help file according to the language setting.
1852 * \li Syntax: help-open <FILE>[.lyx]
1853 * \li Params: <FILE>: any document from (/usr/share/)doc directory.
1854 * \li Origin: Jug, 27 Jun 1999
1857 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
1860 * \var lyx::FuncCode lyx::LFUN_HREF_INSERT
1861 * \li Action: Inserts hyperlinks into the document (clickable in pdf output).
1862 * \li Notion: Hyperlink target can be set via selection + hyperlink-insert function.
1863 * \li Syntax: href-insert [<TARGET>]
1864 * \li Origin: CFO-G, 21 Nov 1997
1867 { LFUN_HREF_INSERT, "href-insert", Noop, Edit },
1870 * \var lyx::FuncCode lyx::LFUN_ICON_SIZE
1871 * \li Action: Sets icon size of toolbars.
1872 * \li Syntax: icon-size [<SIZE>]
1873 * \li Params: <SIZE> : the icon size in px or one of the logical settings
1874 small|normal|big|huge|giant, the default is normal
1875 (whose size in px is icon set dependent).
1876 * \li Origin: 11 July 2016
1879 { LFUN_ICON_SIZE, "icon-size", NoBuffer, Buffer },
1882 * \var lyx::FuncCode lyx::LFUN_INDEX_INSERT
1883 * \li Action: Inserts Index entry.
1884 * \li Notion: It automatically takes the word on the cursor position.
1885 * \li Syntax: index-insert [<TYPE:Name>]
1886 * \li Params: <TYPE:Name>: name of the index, if multiple indices are defined.
1887 With an empty argument, the default index is selected.
1888 * \li Origin: leeming, 3 Aug 2000
1891 { LFUN_INDEX_INSERT, "index-insert", Noop, Edit },
1894 * \var lyx::FuncCode lyx::LFUN_INDEX_PRINT
1895 * \li Action: Inserts list of Index entries on a new page.
1896 * \li Syntax: index-print [<TYPE:Name>]
1897 * \li Params: <TYPE:Name>: name of the index, if multiple indices are defined.
1898 With an empty argument, the default index is selected.
1899 * \li Origin: Lgb, 27 Feb 1997
1902 { LFUN_INDEX_PRINT, "index-print", Noop, Edit },
1905 * \var lyx::FuncCode lyx::LFUN_INFO_INSERT
1906 * \li Action: Displays shortcuts, lyxrc, package and textclass availability and menu
1907 information in a non-editable boxed InsetText.
1908 * \li Notion: Apart from lfun arguments you can use the following method: \n
1909 1. input the type and argument of this inset, e.g. "menu paste", in
1911 2. select the text and run info-insert lfun.
1912 * \li Syntax: info-insert <TYPE> <ARG>
1913 * \li Params: <TYPE>: shortcut[s]|lyxrc|lyxinfo|package|textclass|menu|buffer \n
1914 <ARG>: argument for a given type. Look into InsetInfo.h for detailed
1916 shortcut[s]: name of lfun (e.g math-insert \alpha) \n
1917 lyxrc: name of rc_entry (e.g. bind_file) \n
1918 lyxinfo: "version" - used version of LyX \n
1919 package: name of latex package (e.g. listings) \n
1920 textclass: name of textclass (e.g. article) \n
1921 menu: name of lfun used in menu \n
1922 icon: icon of lfun used in toolbar or direct icon name\n
1923 buffer: "name"|"path"|"class"|"vcs-tree-revision"|
1924 "vcs-revision"|"vcs-author"|"vcs-date"|"vcs-time"
1925 * \li Sample: command-sequence info-insert buffer path; info-insert buffer name
1926 * \li Origin: bpeng, 7 Oct 2007
1929 { LFUN_INFO_INSERT, "info-insert", Noop, Edit },
1932 * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
1933 * \li Action: Apply data for an inset.
1934 * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
1935 be applied. This is either changed to #LFUN_INSET_MODIFY or
1936 #LFUN_INSET_INSERT depending on the context where it is called.
1937 * \li Syntax: inset-apply <ARGS>
1938 * \li Params: See #LFUN_INSET_INSERT .
1941 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
1944 * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN
1945 * \li Action: Move the cursor to the beginning of the current inset
1946 if it is not already there, or at the beginning of the
1947 enclosing inset otherwise
1948 * \li Syntax: inset-begin
1949 * \li Origin: lasgouttes, 16 Mar 2009
1952 { LFUN_INSET_BEGIN, "inset-begin", ReadOnly, Edit },
1955 * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN_SELECT
1956 * \li Action: Move the cursor to the beginning of the current inset
1957 if it is not already there, or at the beginning of the
1958 enclosing inset otherwise (adding the
1959 traversed text to the selection).
1960 * \li Syntax: inset-begin-select
1961 * \li Origin: lasgouttes, 16 Mar 2009
1964 { LFUN_INSET_BEGIN_SELECT, "inset-begin-select", ReadOnly, Edit },
1967 * \var lyx::FuncCode lyx::LFUN_INSET_COPY_AS
1968 * \li Action: Copies the inset to the clipboard as a certain type.
1969 * \li Notion: Currently used only for InsetInfo where its content is copied as a text.
1970 * \li Syntax: inset-copy-as
1971 * \li Origin: vfr, 18 Apr 2010
1974 { LFUN_INSET_COPY_AS, "inset-copy-as", ReadOnly | NoUpdate | AtPoint, Edit },
1978 * \var lyx::FuncCode lyx::LFUN_INSET_DIALOG_UPDATE
1979 * \li Action: Updates the values inside the dialog from the inset.
1980 * \li Notion: This is an internal LFUN, not to be used by users. Called internally
1981 by #LFUN_DIALOG_UPDATE
1982 * \li Params: <DIALOG-NAME>
1983 * \li Origin: leeming, 25 Feb 2003
1986 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
1989 * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE
1990 * \li Action: Dissolve the current inset into text.
1991 * \li Syntax: inset-dissolve [<INSET>]
1992 * \li Params: <INSET>: this can be used to make sure the right kind of inset
1993 is dissolved. For example "dissolve" entry in the charstyles
1994 sub-menu should only dissolve the charstyle inset, even if the
1995 cursor is inside several nested insets of different type.\n
1996 For values see #lyx::InsetLayout::lyxtype_ .
1997 * \li Origin: JSpitz, 7 Aug 2006
2000 { LFUN_INSET_DISSOLVE, "inset-dissolve", AtPoint, Edit },
2003 * \var lyx::FuncCode lyx::LFUN_INSET_EDIT
2004 * \li Action: Edit the inset at cursor with an external application,
2005 if one is attributed.
2006 * \li Syntax: inset-edit [<INSET_PARAMS>]
2007 * \li Params: <INSET_PARAMS>: Parameters for the inset. \n
2008 Currently only the filename will be considered.
2009 * \li Origin: JSpitzm, 27 Apr 2006
2012 { LFUN_INSET_EDIT, "inset-edit", ReadOnly | AtPoint, Edit },
2016 * \var lyx::FuncCode lyx::LFUN_INSET_END
2017 * \li Action: Move the cursor to the end of the current inset
2018 if it is not already there, or at the end of the
2019 enclosing inset otherwise
2020 * \li Syntax: inset-end
2021 * \li Origin: lasgouttes, 16 Mar 2009
2024 { LFUN_INSET_END, "inset-end", ReadOnly, Edit },
2027 * \var lyx::FuncCode lyx::LFUN_INSET_END_SELECT
2028 * \li Action: Move the cursor to the end of the current inset
2029 if it is not already there, or at the end of the
2030 enclosing inset otherwise (adding the
2031 traversed text to the selection).
2032 * \li Syntax: inset-end-select
2033 * \li Origin: lasgouttes, 16 Mar 2009
2036 { LFUN_INSET_END_SELECT, "inset-end-select", ReadOnly, Edit },
2040 * \var lyx::FuncCode lyx::LFUN_INSET_FORALL
2041 * \li Action: Apply the given commands on insets of a given name.
2042 * \li Notion: WARNING: use at your own risks; this function gives
2043 you too many ways of shooting yourself in the foot.
2044 A typical example is
2045 inset-forall Note note-insert
2046 which starts an infinite loop. This is mitigated by the fact
2047 that the number of actions is arbitrarily limited to 100000.
2048 Note also that inset-forall does not update metrics between
2049 iterations, which can lead to bugs. This has to be eventually
2051 * \li Syntax: inset-forall <NAME> <LFUN-COMMAND> \n
2052 <NAME>: Type of Inset. If <NAME> is *, all insets are matched.
2053 The name is used like for InsetLayout in layout files: "Note"
2054 matches all note insets, while "Note:Note" only matches LyX
2056 * \li Sample: Remove all index insets: \n
2057 inset-forall Index char-delete-forward force \n
2058 Close all Notes (also works for a particular branch, for example): \n
2059 inset-forall Note inset-toggle close \n
2060 Transform all yellow notes to comments \n
2061 inset-forall Note:Note inset-modify note Note Comment \n
2062 Try to put LyX in an infinite loop if there is at least a Note: \n
2063 inset-forall Note char-backward
2064 * \li Origin: lasgouttes, 27 Nov 2009
2067 { LFUN_INSET_FORALL, "inset-forall", ReadOnly, Edit },
2071 * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
2072 * \li Action: Insert new inset (type given by the parameters).
2073 * \li Syntax: inset-insert <INSET> <ARGS>
2074 * \li Params: <INSET>: <bibitem|bibtex|citation|ert|listings|external|graphics|tabular|\n
2075 hyperlink|include|index|label|line|nomencl|vspace|ref|toc|script>\n
2076 <ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
2077 * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
2078 where <label name> is the name of the referenced label and
2079 <Format> is one of the following: \n
2080 ref -- <reference> \n
2081 eqref -- (<reference>) \n
2082 pageref -- <page> \n
2083 vpageref -- on <page> \n
2084 vref -- <reference> on <page> \n
2085 formatted -- Formatted reference
2088 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
2091 * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
2092 * \li Action: Modify some properties of an inset.
2093 * \li Notion: Used for argument, bibitem, bibtex, box, branch, caption, citation,
2094 command, ert, external, float, graphics, include, index,
2095 info, label, line, listings, newline, newpage, nomencl,
2096 note, phantom, quotes, ref, script, separator, space,
2097 tabular, vspace and wrap insets.
2098 * \li Syntax: inset-modify <INSET> <ARGS> \n
2099 inset-modify changetype <TYPE>
2100 * \li Sample: Change a Note inset into a Comment inset: \n
2101 inset-modify note Note Comment \n
2102 Change a Box into an Ovalbox: \n
2103 inset-modify changetype Ovalbox \n
2104 Change a quotation mark to e[nglish style], l[eft side = opening], s[ingle = inner, secondary] \n
2105 inset-modify changetype els \n
2106 Change only the style of a quotation mark, maintaining the other aspects (. = wildcard) \n
2107 inset-modify changetype e.. \n
2110 { LFUN_INSET_MODIFY, "inset-modify", AtPoint, Edit },
2113 * \var lyx::FuncCode lyx::LFUN_INSET_SELECT_ALL
2114 * \li Action: Select all contents of an inset.
2115 * \li Notion: There are 3 successive levels: select current cell,
2116 * select all cells of inset, select the inset from outside
2117 * (in the enclosing inset).
2118 * \li Syntax: inset-select-all
2119 * \li Origin: vfr, 22 Aug 2009; lasgouttes 1 Nov 2014
2122 { LFUN_INSET_SELECT_ALL, "inset-select-all", ReadOnly, Edit },
2126 * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
2127 * \li Action: Open the inset's properties dialog.
2128 * \li Notion: Used for bibitem, bibtex, box, branch, citation, ert, external,
2129 float, graphics, href, include, index, index_print, label, line,
2130 listings, note, phantom, ref, space, tabular, vspace, wrap insets.
2131 * \li Syntax: inset-settings <INSET>
2132 * \li Params: <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|\n
2133 graphics|href|include|index|index_print|label|line|\n
2134 listings|note|phantom|ref|space|tabular|vspace|wrap>.
2137 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly | AtPoint, Edit },
2140 * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
2141 * \li Action: Toggles the collapsible inset at cursor position,
2142 or the inset we are currently in.
2143 * \li Syntax: inset-toggle [<ARG>]
2144 * \li Params: <ARG>: <open|close|toggle|assign>. \n
2145 open/close/toggle are for collapsible insets. toggle is used when no argument is given.\n
2146 assign synchronize the branch-inset with activation status of the branch.
2147 Used for global toggling when changed activation.
2148 * \li Origin: lasgouttes, 19 Jul 2001
2151 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly | AtPoint, Edit },
2154 * \var lyx::FuncCode lyx::LFUN_IN_IPA
2155 * \li Action: Only active in IPA inset.
2156 * \li Notion: Dummy function which is only active in a IPA inset.
2157 It's used to toggle the IPA toolbar if the cursor moves
2159 * \li Syntax: in-ipa
2160 * \li Origin: spitz, 20 May 2012
2163 { LFUN_IN_IPA, "in-ipa", Noop, Edit },
2166 * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
2167 * \li Action: Only active in Math Macro definition.
2168 * \li Notion: Dummy function which is only active in a Math Macro definition.
2169 It's used to toggle the Math Macro toolbar if the cursor moves
2170 into a Math Macro definition.
2171 * \li Syntax: in-mathmacrotemplate
2172 * \li Origin: sts, 06 January 2008
2175 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
2179 * \var lyx::FuncCode lyx::LFUN_IPAMACRO_INSERT
2180 * \li Action: Inserts special IPA macros into the document.
2181 * \li Syntax: ipamacro-insert <CHAR>
2182 * \li Params: <CHAR>: tone-falling, tone-rising, tone-high-rising, tone-low-rising,
2183 * tone-high-rising-falling, deco bottomtiebar, deco toptiebar.
2184 * \li Origin: JSpitzm, 22 Aug 2012
2187 { LFUN_IPAMACRO_INSERT, "ipamacro-insert", Noop, Edit },
2190 * \var lyx::FuncCode lyx::LFUN_IPA_INSERT
2191 * \li Action: Inserts an IPA inset.
2192 * \li Syntax: ipa-insert
2193 * \li Origin: spitz, 05 Mar 2012
2196 { LFUN_IPA_INSERT, "ipa-insert", Noop, Edit },
2199 * \var lyx::FuncCode lyx::LFUN_KEYMAP_OFF
2200 * \li Action: Turn off the loaded keyboard map.
2201 * \li Syntax: keymap-off
2204 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
2207 * \var lyx::FuncCode lyx::LFUN_KEYMAP_PRIMARY
2208 * \li Action: Turn on the primary keyboard map.
2209 * \li Notion: Maps were widely used in past, when X-windows didn't have nowadays
2210 keyboard support. They can be still used to maintain uniform keyboard
2211 layout across the various platforms.\n
2212 The language is to be set in the Preferences dialog.
2213 * \li Syntax: keymap-primary
2216 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
2219 * \var lyx::FuncCode lyx::LFUN_KEYMAP_SECONDARY
2220 * \li Action: Turn on the secondary keyboard map.
2221 * \li Syntax: keymap-secondary
2224 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
2227 * \var lyx::FuncCode lyx::LFUN_KEYMAP_TOGGLE
2228 * \li Action: Toggles keyboard maps (first/second/off).
2229 * \li Syntax: keymap-toggle
2230 * \li Origin: leeming, 30 Mar 2004
2233 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
2237 * \var lyx::FuncCode lyx::LFUN_LABEL_COPY_AS_REF
2238 * \li Action: Copies the label at the cursor as a cross-reference to be pasted elsewhere.
2239 * \li Syntax: copy-label-as-reference <LABEL>
2240 * \li Params: <LABEL>: The label to copy (for multi-line math)
2241 * \li Origin: sts, 16 Nov 2008
2244 { LFUN_LABEL_COPY_AS_REFERENCE, "label-copy-as-reference",
2245 ReadOnly | NoUpdate | AtPoint, Edit },
2249 * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
2250 * \li Action: Goto a label.
2251 * \li Syntax: label-goto [<LABEL>]
2252 * \li Params: <LABEL>: Requested label. If no label is given and reference
2253 is on cursor position, Bookmark 0 is saved and
2254 cursor moves to the position of referenced label.
2255 * \li Origin: Ale, 6 Aug 1997
2258 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
2261 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT
2262 * \li Action: Inserts label to text or displayed formula.
2263 * \li Syntax: label-insert [<LABEL>]
2264 * \li Params: <LABEL>: Requested label. If no label is given dialog requesting
2265 name will be opened.
2268 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
2271 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT_AS_REFERENCE
2272 * \li Action: Inserts the label (in ToC pane) as a cross-reference at the position of the cursor.
2273 * \li Syntax: label-insert-as-reference
2274 * \li Origin: vfr, 7 Apr 2009
2277 { LFUN_LABEL_INSERT_AS_REFERENCE, "label-insert-as-reference", Noop, Edit},
2281 * \var lyx::FuncCode lyx::LFUN_LANGUAGE
2282 * \li Action: Set language from the current cursor position.
2283 * \li Syntax: language <LANG> [set]
2284 * \li Params: <LANG>: Requested language. Look in lib/languages for
2285 the list. "language reset" or "language" (without param)
2286 reset to the document language.
2287 set: If used, the language will be set to the specified
2288 language. Otherwise, the language will be toggled (i.e., if
2289 the current language is LANG, switch to the document language
2290 or the default language, if LANG is the document language).
2291 * \li Origin: Dekel, 2 Mar 2000
2294 { LFUN_LANGUAGE, "language", Noop, Edit },
2298 * \var lyx::FuncCode lyx::LFUN_LAYOUT
2299 * \li Action: Sets the layout (that is, environment) for the current paragraph.
2300 * \li Syntax: layout <LAYOUT>
2301 * \li Params: <LAYOUT>: the layout to use
2304 { LFUN_LAYOUT, "layout", Noop, Layout },
2307 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
2308 * \li Action: Clears the module list.
2309 * \li Notion: Clears the list of included modules for the current buffer.
2310 * \li Syntax: layout-modules-clear
2311 * \li Origin: rgh, 25 August 2007
2314 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", NoInternal, Layout },
2317 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULE_ADD
2318 * \li Action: Adds a module.
2319 * \li Notion: Adds a module to the list of included modules for the current buffer.
2320 * \li Syntax: layout-module-add <MODULE>
2321 * \li Params: <MODULE>: the module to be added
2322 * \li Origin: rgh, 25 August 2007
2325 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", NoInternal, Layout },
2328 * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH
2329 * \li Action: Launches the paragraph settings dialog.
2330 * \li Syntax: layout-paragraph
2333 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
2336 * \var lyx::FuncCode lyx::LFUN_LAYOUT_RELOAD
2337 * \li Action: Reloads layout information.
2338 * \li Notion: Reloads all layout information for the current buffer from disk, thus
2339 recognizing any changes that have been made to layout files on the fly.
2340 This is intended to be used only by layout developers and should not be
2341 used when one is trying to do actual work.
2342 * \li Syntax: layout-reload
2343 * \li Origin: rgh, 3 September 2007
2346 { LFUN_LAYOUT_RELOAD, "layout-reload", NoInternal, Layout },
2349 * \var lyx::FuncCode lyx::LFUN_LAYOUT_TABULAR
2350 * \li Action: Launches the tabular settings dialog.
2351 * \li Syntax: layout-tabular
2352 * \li Origin: Jug, 31 Jul 2000
2355 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
2358 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN
2359 * \li Action: Move the cursor to the beginning of the (screen) line.
2360 * \li Syntax: line-begin
2363 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
2366 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN_SELECT
2367 * \li Action: Move the cursor to the beginning of the (screen) line adding the
2368 traversed text to the selection.
2369 * \li Syntax: line-begin-select
2372 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
2375 * \var lyx::FuncCode lyx::LFUN_LINE_DELETE_FORWARD
2376 * \li Action: Deletes the letters to the end of the (screen) line or
2377 deletes the selection.
2378 * \li Syntax: line-delete-forward
2381 { LFUN_LINE_DELETE_FORWARD, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
2384 * \var lyx::FuncCode lyx::LFUN_LINE_END
2385 * \li Action: Move the cursor to the end of the (screen) line.
2386 * \li Syntax: line-end
2389 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
2392 * \var lyx::FuncCode lyx::LFUN_LINE_END_SELECT
2393 * \li Action: Move the cursor to the end of the (screen) line adding the
2394 traversed text to the selection.
2395 * \li Syntax: line-end-select
2398 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
2401 * \var lyx::FuncCode lyx::LFUN_LISTING_INSERT
2402 * \li Action: Inserts a new listings inset.
2403 * \li Syntax: listing-insert
2404 * \li Origin: Herbert, 10 Nov 2001; bpeng, 2 May 2007
2407 { LFUN_LISTING_INSERT, "listing-insert", Noop, Edit },
2410 * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
2411 * \li Action: Apply the given settings to user preferences.
2412 * \li Syntax: lyxrc-apply <SETTINGS>
2413 * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
2414 to get an idea which commands to use and their syntax.
2415 #lyx::LyXRC::LyXRCTags has the list of possible commands.
2418 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
2421 * \var lyx::FuncCode lyx::LFUN_LYX_ACTIVATE
2422 * \li Action: Activates the LyX window.
2423 * \li Notion: On Linux and Mac OS, this action brings the LyX window
2424 into focus. Such behavior is not allowed by Windows OS
2425 so instead the color of the taskbar entry is changed to
2426 indicate that the window has changed in some way.
2427 This action is useful in combination with reverse search.
2428 * \li Syntax: lyx-activate
2429 * \li Origin: skostysh, 4 Aug 2016
2432 { LFUN_LYX_ACTIVATE, "lyx-activate", ReadOnly | NoBuffer, Hidden },
2435 * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
2436 * \li Action: Terminates the current LyX instance.
2437 * \li Notion: Terminates the current LyX instance, asking whether to save
2438 modified documents, etc.
2439 * \li Syntax: lyx-quit
2442 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
2445 * \var lyx::FuncCode lyx::LFUN_MARGINALNOTE_INSERT
2446 * \li Action: Inserts a marginal note.
2447 * \li Syntax: marginalnote-insert
2448 * \li Origin: Lgb, 26 Jun 2000
2451 { LFUN_MARGINALNOTE_INSERT, "marginalnote-insert", Noop, Edit },
2454 * \var lyx::FuncCode lyx::LFUN_MARK_OFF
2455 * \li Action: Disable selecting of text-region.
2456 * \li Syntax: mark-off
2459 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
2462 * \var lyx::FuncCode lyx::LFUN_MARK_ON
2463 * \li Action: Enable selecting of text-region.
2464 * \li Notion: After enabling you can simply move arrow keys to get selected region.
2465 * \li Syntax: mark-on
2468 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
2471 * \var lyx::FuncCode lyx::LFUN_MARK_TOGGLE
2472 * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
2473 * \li Syntax: mark-toggle
2474 * \li Origin: Andre, May 5 2006
2477 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
2481 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
2482 * \li Action: Update (export) the document built from the master buffer,
2483 if the current buffer is part of a master/child document.
2484 * \li Syntax: master-buffer-update [<FORMAT>]
2485 * \li Params: <FORMAT>: The format to display, where this is one of the
2486 formats defined (in the current GUI) in the
2487 Tools>Preferences>File Formats dialog.
2488 If no format is given, the default format as
2489 specified in the same dialog is used.
2490 * \li Origin: Tommaso, 20 Sep 2007
2493 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
2496 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
2497 * \li Action: Show a preview built from the master buffer, if available.
2498 if the current buffer is part of a master/child document.
2499 * \li Syntax: master-buffer-view [<FORMAT>]
2500 * \li Params: <FORMAT>: The format to display, where this is one of the
2501 formats defined (in the current GUI) in the
2502 Tools>Preferences>File Formats dialog.
2503 If no format is given, the default format as
2504 specified in the same dialog is used.
2505 * \li Origin: Tommaso, 20 Sep 2007
2508 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
2511 * \var lyx::FuncCode lyx::LFUN_MATH_AMS_MATRIX
2512 * \li Action: Inserts an extended matrix as provided by the amsmath package.
2513 * \li Syntax: math-matrix <COLS> <ROWS> [<DECORATION>]
2514 * \li Params: <DECORATION>: Decoration determines the LaTeX name of the matrix
2515 that should be created. Possible values include
2516 pmatrix, bmatrix, Bmatrix, vmatrix, Vmatrix and
2517 matrix. The default is 'matrix'.
2518 * \li Sample: math-ams-matrix 3 3 bmatrix
2521 { LFUN_MATH_AMS_MATRIX, "math-ams-matrix", Noop, Math },
2524 * \var lyx::FuncCode lyx::LFUN_MATH_BIGDELIM
2525 * \li Action: Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
2526 * \li Syntax: math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
2527 * \li Params: <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r \n
2528 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
2529 * \li Sample: math-bigdelim "Bigl" "\Downarrow" "Bigr" "\}"
2530 * \li Origin: Enrico & Georg, 7 May 2006
2533 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
2536 * \var lyx::FuncCode lyx::LFUN_MATH_DELIM
2537 * \li Action: Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
2538 * \li Syntax: math-delim [<LEFT>] [<RIGHT>]
2539 * \li Params: <LEFT/RIGHT>: Delimiters to be used. Each delimiter can be specified by
2540 either a LaTeX name or a valid character.
2541 ( is the default letter.
2542 * \li Sample: math-delim { rangle
2543 * \li Origin: Alejandro, 18 Jun 1996
2546 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
2549 * \var lyx::FuncCode lyx::LFUN_MATH_DISPLAY
2550 * \li Action: Creates a new displayed equation in text mode.
2551 Toggles inlined/display formula in math mode.
2552 * \li Syntax: math-display [<ARG>]
2553 * \li Params: <ARG>: this argument will be passed to #LFUN_MATH_INSERT when creating
2554 new equation from the text mode.
2555 * \li Origin: Alejandro, 18 Jun 1996
2558 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
2561 * \var lyx::FuncCode lyx::LFUN_MATH_EXTERN
2562 * \li Action: Calls external program and passes the current expression/equation
2563 as an argument for the calculation in the format appropriate to the
2565 * \li Notion: Selection can be used to determine the input for the external program.
2566 * \li Syntax: math-extern <LANG> [<COMMAND>]
2567 * \li Params: <LANG>: octave|maxima|maple|mathematica|script \n
2568 where "script" stands for the external script (normalized
2569 expression will be passed)
2570 * \li Origin: Andre, 24 Apr 2001
2571 * \li Sample: math-extern maple simplify
2574 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
2577 * \var lyx::FuncCode lyx::LFUN_MATH_FONT_STYLE
2578 * \li Action: Changes the text style used in math.
2579 * \li Syntax: math-font-style <STYLE>
2580 * \li Params: <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf|textnormal\n
2581 |textrm|textsf|texttt|textbf|textmd|textit|textsc|textsl|textup
2582 * \li Origin: vfr, 9 jan 2009
2585 { LFUN_MATH_FONT_STYLE, "math-font-style", Noop, Math },
2588 * \var lyx::FuncCode lyx::LFUN_MATH_INSERT
2589 * \li Action: Inserts math objects and symbols.
2590 * \li Syntax: math-insert <ARG>
2591 * \li Params: <ARG>: Symbol or LaTeX code to be inserted.
2592 * \li Notion: When <ARG> is a _single_ math inset with more than one cell
2593 (such as "x_y^z" or "\frac{x}{y}"), the content of cell(0) is
2594 replaced by the current selection (only works if the selection
2595 is in mathed). As an example, if "abc" is selected in mathed,
2596 "math-insert \frac{x}{y}" replaces "abc" with "\frac{abc}{y}",
2597 and "math-insert x_y^z" replaces "abc" with "abc_y^z".
2598 If nothing is selected (or the selection is not in mathed),
2599 math-insert works as expected.
2602 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
2605 * \var lyx::FuncCode lyx::LFUN_MATH_LIMITS
2606 * \li Action: Toggles the position of the limits from above/below to the right
2607 side an vice versa in integral symbol, a limit, a summation, etc.
2608 * \li Notion: Put the cursor before the symbol with the limits and then invoke
2610 * \li Syntax: math-limits [<STATE>]
2611 * \li Params: <STATE>: limits|nolimits
2614 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
2617 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO
2618 * \li Action: Inserts a math macro definition at the cursor position in the text.
2619 * \li Syntax: math-macro <NAME> [<NARGS>] [def]
2620 * \li Params: <NAME>: The name of the macro, e.g. "mymacro".\n
2621 <NARGS>: The number of parameters of the macro. Default is 0.
2622 "def": Has no effect anymore, just for compatibility with former LyX versions.
2623 * \li Origin: ale, 10 May 1997; sts, 21 Dec 2007
2626 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
2629 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
2630 * \li Action: Add a greedy optional parameter.
2631 * \li Notion: Add a greedy optional parameter which eats the value
2632 from the following cells in mathed which are in the [value]
2634 * \li Syntax: math-macro-add-greedy-optional-param
2635 * \li Origin: sts, 06 January 2008
2638 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
2641 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
2642 * \li Action: Add an optional parameter.
2643 * \li Notion: Insert an optional parameter just behind the
2644 already existing optional parameters.
2645 * \li Syntax: math-macro-add-optional-param
2646 * \li Origin: sts, 06 January 2008
2649 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
2652 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
2653 * \li Action: Add a parameter.
2654 * \li Notion: Add a parameter to a Math Macro.
2655 * \li Params: <NUM>: The number of the parameter behind which the new one
2656 will be added (1 for the first, i.e. use 0 for add a
2657 parameter at the left), defaults to the last one.
2658 * \li Syntax: math-macro-add-param <NUM>
2659 * \li Origin: sts, 06 January 2008
2662 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
2665 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
2666 * \li Action: Append a greedy parameter.
2667 * \li Notion: Append a greedy parameter to a Math Macro which
2668 eats the following mathed cell in every instance of
2669 the macro in the buffer.
2670 * \li Syntax: math-macro-append-greedy-param
2671 * \li Origin: sts, 06 January 2008
2674 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
2677 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
2678 * \li Action: Fold a Math Macro.
2679 * \li Notion: Fold the Math Macro the cursor is in if it was
2680 unfolded, i.e. displayed as \foo before.
2681 * \li Syntax: math-macro-fold
2682 * \li Origin: sts, 06 January 2008
2685 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
2688 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
2689 * \li Action: Make a parameter non-optional.
2690 * \li Notion: Turn the last optional parameter of a Math Macro
2691 into a non-optional parameter. The default value is
2692 remembered to be reused later if the user changes his mind.
2693 * \li Syntax: math-macro-make-nonoptional
2694 * \li Origin: sts, 06 January 2008
2697 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
2700 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
2701 * \li Action: Make a parameter optional.
2702 * \li Notion: Turn the first non-optional parameter of a Math Macro
2703 into an optional parameter with a default value.
2704 * \li Syntax: math-macro-make-optional
2705 * \li Origin: sts, 06 January 2008
2708 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
2711 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
2712 * \li Action: Remove a greedy parameter.
2713 * \li Notion: Remove a greedy parameter of a Math Macro and spit
2714 out the values of it in every instance of the macro
2715 in the buffer. If it is an optional parameter the [valud]
2717 * \li Syntax: math-macro-remove-greedy-param
2718 * \li Origin: sts, 06 January 2008
2721 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
2724 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
2725 * \li Action: Remove the last optional parameter.
2726 * \li Notion: Remove the last optional parameter of a Math Macro and
2727 remove it in all the instances of the macro in the buffer.
2728 * \li Syntax: math-macro-remove-optional-param
2729 * \li Origin: sts, 06 January 2008
2732 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
2735 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
2736 * \li Action: Remove the last parameter.
2737 * \li Notion: Remove the last parameter of a Math Macro and
2738 remove its value in all instances of the macro
2740 * \li Params: <NUM>: The number of the parameter to be deleted (1 for
2741 the first), defaults to the last one.
2742 * \li Syntax: math-macro-remove-param <NUM>
2743 * \li Origin: sts, 06 January 2008
2746 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
2749 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
2750 * \li Action: Unfold a Math Macro.
2751 * \li Notion: Unfold the Math Macro the cursor is in, i.e.
2753 * \li Syntax: math-macro-unfold
2754 * \li Origin: sts, 06 January 2008
2757 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
2760 * \var lyx::FuncCode lyx::LFUN_MATH_MATRIX
2761 * \li Action: Inserts a matrix.
2762 * \li Syntax: math-matrix <COLS> <ROWS> [<ALIGN>]
2763 * \li Params: <ALIGN>: Alignment is a word composed of the vertical alignment
2764 (b, c or t) (i.e. 1 char) and the horizontal alignments
2765 (l, c or r) (i.e. <COL> chars).
2766 * \li Sample: math-matrix 3 3 bccc
2769 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
2772 * \var lyx::FuncCode lyx::LFUN_MATH_MODE
2773 * \li Action: In text mode enters math mode (i.e. puts math insets on the current
2774 cursor position), in math mode enters text mode inside math expression.
2775 * \li Notion: If there is some selected text, it puts the text inside created math box.
2776 * \li Syntax: math-mode [on|<ARG>]
2777 * \li Params: <ARG>: eventual argument (LaTeX code) is passed to #LFUN_MATH_INSERT .\n
2778 "on": allow only entering of math mode from text mode.
2779 * \li Origin: Alejandro, 4 Jun 1996
2782 { LFUN_MATH_MODE, "math-mode", Noop, Math },
2785 * \var lyx::FuncCode lyx::LFUN_MATH_MUTATE
2786 * \li Action: Mutates the type of math inset to the newly selected one.
2787 * \li Syntax: math-mutate <TYPE>
2788 * \li Params: <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
2789 multline|gather|flalign
2790 * \li Origin: Andre, 23 May 2001
2793 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
2796 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
2797 * \li Action: Toggles numbering of the current formula line.
2798 * \li Notion: Must be in display formula mode.
2799 * \li Syntax: math-number-line-toggle
2800 * \li Origin: Alejandro, 18 Jun 1996
2803 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
2806 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
2807 * \li Action: Toggles numbering/labeling of the current formula.
2808 * \li Notion: Must be in display formula mode.
2809 * \li Syntax: math-number-toggle
2810 * \li Origin: Alejandro, 4 Jun 1996
2813 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
2816 * \var lyx::FuncCode lyx::LFUN_MATH_SIZE
2817 * \li Action: Changes arbitrarily the size used by math fonts inside a context.
2818 * \li Notion: Provides an interface to the LaTeX math mode font size commands.
2819 * \li Syntax: math-size <STYLE>
2820 * \li Params: <STYLE>: \displaystyle|\textstyle|\scriptstyle|\scriptscriptstyle
2821 * \li Origin: Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
2824 { LFUN_MATH_SIZE, "math-size", Noop, Math },
2827 * \var lyx::FuncCode lyx::LFUN_MATH_SPACE
2828 * \li Action: Inserts space into math expression.
2829 * \li Notion: Use spacebar after entering this space to change type of space.
2830 * \li Syntax: math-space [<TYPE>] [<LEN>]
2831 * \li Params: <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace \n
2832 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad \n
2833 custom space: hspace \n
2834 "," used by default.\n
2835 Note that ! is equivalent to negthinspace, , = thinspace,
2836 : = medspace, and ; = thickspace.\n
2837 <LEN>: length for custom spaces (hspace)
2838 * \li Origin: Andre, 25 Jul 2001; sanda, 16 Jun 2008
2841 { LFUN_MATH_SPACE, "math-space", Noop, Math },
2844 * \var lyx::FuncCode lyx::LFUN_MATH_SUBSCRIPT
2845 * \li Action: Enters subscript expression in math expression.
2846 * \li Syntax: math-subscript
2847 * \li Origin: vermeer, 12 Dec 2001
2850 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
2853 * \var lyx::FuncCode lyx::LFUN_MATH_SUPERSCRIPT
2854 * \li Action: Enters superscript expression in math expression.
2855 * \li Syntax: math-superscript
2856 * \li Origin: vermeer, 12 Dec 2001
2859 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
2862 * \var lyx::FuncCode lyx::LFUN_MENU_OPEN
2863 * \li Action: Opens the menu given by its name.
2864 * \li Syntax: menu-open <NAME>
2865 * \li Params: <NAME>: menu name. See various .inc files in lib/ui for candidates.
2868 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
2871 * \var lyx::FuncCode lyx::LFUN_MESSAGE
2872 * \li Action: Shows message in statusbar (for script purposes).
2873 * \li Syntax: message <STRING>
2874 * \li Origin: Lgb, 8 Apr 2001
2877 { LFUN_MESSAGE, "message", NoBuffer, System },
2880 * \var lyx::FuncCode lyx::LFUN_META_PREFIX
2881 * \li Action: Simulate halting Meta key (Alt key on PCs).
2882 * \li Notion: Used for buffer edition not for GUI control.
2883 * \li Syntax: meta-prefix
2886 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
2889 * \var lyx::FuncCode lyx::LFUN_MOUSE_DOUBLE
2890 * \li Action: This function is called when double click on mouse button is
2891 pressed (inside workarea). Action depends on the context.
2892 * \li Notion: This is an internal LFUN, not to be used by users.
2893 * \li Origin: Andre, 9 Aug 2002
2896 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
2899 * \var lyx::FuncCode lyx::LFUN_MOUSE_MOTION
2900 * \li Action: This function is called when mouse cursor is moving over the text.
2901 Action depends on the context.
2902 * \li Notion: This is an internal LFUN, not to be used by users.
2903 * \li Origin: Andre, 9 Aug 2002
2906 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
2909 * \var lyx::FuncCode lyx::LFUN_MOUSE_PRESS
2910 * \li Action: This function is called when mouse button is pressed (inside workarea).
2911 Action depends on the context.
2912 * \li Notion: This is an internal LFUN, not to be used by users.
2913 * \li Origin: Andre, 9 Aug 2002
2916 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
2919 * \var lyx::FuncCode lyx::LFUN_MOUSE_RELEASE
2920 * \li Action: This function is called when mouse button is released (inside workarea).
2921 Action depends on the context.
2922 * \li Notion: This is an internal LFUN, not to be used by users.
2923 * \li Origin: Andre, 9 Aug 2002
2926 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
2930 * \var lyx::FuncCode lyx::LFUN_MOUSE_TRIPLE
2931 * \li Action: This function is called when triple click on mouse button is
2932 pressed (inside workarea). Action depends on the context.
2933 * \li Notion: This is an internal LFUN, not to be used by users.
2934 * \li Origin: Andre, 9 Aug 2002
2937 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
2940 * \var lyx::FuncCode lyx::LFUN_NEWLINE_INSERT
2941 * \li Action: Inserts a line break or new line.
2942 * \li Syntax: newline-insert [<ARG>]
2943 * \li Params: <ARG>: <newline|linebreak> default: newline
2944 * \li Origin: JSpitzm, 25 Mar 2008
2947 { LFUN_NEWLINE_INSERT, "newline-insert", Noop, Edit },
2950 * \var lyx::FuncCode lyx::LFUN_NEWPAGE_INSERT
2951 * \li Action: Inserts a new page.
2952 * \li Syntax: newpage-insert <ARG>
2953 * \li Params: <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
2954 * \li Origin: uwestoehr, 24 Nov 2007
2957 { LFUN_NEWPAGE_INSERT, "newpage-insert", Noop, Edit },
2960 * \var lyx::FuncCode lyx::LFUN_NOMENCL_INSERT
2961 * \li Action: Inserts Nomenclature entry.
2962 * \li Notion: It automatically takes the word on the cursor position if no symbol is given.
2963 * \li Syntax: nomencl-insert [<SYMBOL>]
2964 * \li Origin: Ugras, 4 Nov 2006
2967 { LFUN_NOMENCL_INSERT, "nomencl-insert", Noop, Edit },
2970 * \var lyx::FuncCode lyx::LFUN_NOMENCLATURE_PRINT
2971 * \li Action: Inserts list of Nomenclature entries.
2972 * \li Syntax: nomenclature-print
2973 * \li Origin: Ugras, 4 Nov 2006
2976 { LFUN_NOMENCL_PRINT, "nomencl-print", Noop, Edit },
2980 * \var lyx::FuncCode lyx::LFUN_NOTE_INSERT
2981 * \li Action: Inserts Note on the current cursor position,
2982 move selection inside the inset.
2983 * \li Syntax: note-insert [<TYPE>]
2984 * \li Params: <TYPE>: <Note|Greyedout|Comment> default: Note
2987 { LFUN_NOTE_INSERT, "note-insert", Noop, Edit },
2990 * \var lyx::FuncCode lyx::LFUN_NOTE_NEXT
2991 * \li Action: Moves the cursor to the beginning of next Note inset.
2992 * \li Syntax: note-next
2995 { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
2998 * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
2999 * \li Action: Move the current group in the downward direction in the
3000 structure of the document.
3001 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
3002 the whole substructure of the group.
3003 * \li Syntax: outline-down
3004 * \li Origin: Vermeer, 23 Mar 2006
3007 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
3010 * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
3011 * \li Action: Moves the current group in the downward direction in the
3012 hierarchy of the document structure.
3013 * \li Notion: Part -> Chapter -> Section -> etc.
3014 * \li Syntax: outline-in
3015 * \li Origin: Vermeer, 23 Mar 2006
3018 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
3021 * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
3022 * \li Action: Moves the current group in the upward direction in the
3023 hierarchy of the document structure.
3024 * \li Notion: Part <- Chapter <- Section <- etc.
3025 * \li Syntax: outline-out
3026 * \li Origin: Vermeer, 23 Mar 2006
3029 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
3033 * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
3034 * \li Action: Move the current group in the upward direction in the
3035 structure of the document.
3036 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
3037 the whole substructure of the group.
3038 * \li Syntax: outline-up
3039 * \li Origin: Vermeer, 23 Mar 2006
3042 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
3045 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_BREAK
3046 * \li Action: Breaks the current paragraph at the current location.
3047 * \li Notion: Removes the selection.
3048 * \li Syntax: paragraph-break [<LAYOUT>]
3049 * \li Params: <LAYOUT>: "inverse" - decreases depth by one (or change layout
3050 to default layout) when the cursor is at the end of
3054 { LFUN_PARAGRAPH_BREAK, "paragraph-break", Noop, Edit },
3057 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN
3058 * \li Action: Move the cursor to the next paragraph (or beginning of the current one)
3059 in downward direction.
3060 * \li Syntax: paragraph-down
3061 * \li Origin: Asger, 1 Oct 1996
3064 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
3067 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN_SELECT
3068 * \li Action: Move the cursor and select the text to the next paragraph (or
3069 beginning of the current one) in downward direction.
3070 * \li Syntax: paragraph-down-select
3071 * \li Origin: Asger, 1 Oct 1996
3074 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
3077 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
3078 * \li Action: Jump to a paragraph given by its id number and optionally the
3079 desired position within the paragraph.
3080 If given four arguments id_start, pos_start, id_end, pos_end,
3081 perform a selection from start to end.
3082 * \li Notion: Note that id number of paragraph is not the sequential number of
3083 paragraph seen on the screen. Moreover the id is unique for all
3084 opened buffers (documents). Both ids must belong to the same
3086 * \li Syntax: paragraph-goto <PAR_ID> <POS_IN_PAR> [<PAR_ID> <POS_IN_PAR>]
3087 * \li Params: <PAR_ID>: paragraph id \n
3088 <POS_IN_PAR>: desired position within the paragraph
3089 * \li Origin: Dekel, 26 Aug 2000
3093 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly | NoInternal, Edit },
3096 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
3097 * \li Action: Moves the current paragraph downwards in the document.
3098 * \li Syntax: paragraph-move-down
3099 * \li Origin: Edwin, 8 Apr 2006
3102 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
3105 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
3106 * \li Action: Moves the current paragraph upwards in the document.
3107 * \li Notion: Movement through the document will possibly break the paragraph-depth
3108 (e.g. itemize structure).
3109 * \li Syntax: paragraph-move-up
3110 * \li Origin: Edwin, 8 Apr 2006
3113 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
3117 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
3118 * \li Action: Change paragraph settings.
3119 * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
3120 This function only modifies, and does not override, existing settings.
3121 Note that the "leftindent" indent setting is deprecated.
3122 * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
3123 * \li Params: <INDENT>: \noindent|\indent|\indent-toggle|\leftindent LENGTH\n
3124 <SPACING>: \paragraph_spacing default|single|onehalf|double|other SIZE \n
3125 <ALIGN>: \align block|left|right|center|default\n
3126 <OTHERS>: \labelwidthstring WIDTH|\start_of_appendix
3127 * \li Origin: rgh, Aug 15 2007
3130 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
3133 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
3134 * \li Action: Change paragraph settings.
3135 * \li Notion: Overwrite all nonspecified settings to the default ones.
3136 Use paragraph-params lfun if you don't want to overwrite others settings.
3137 * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
3138 * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
3139 * \li Origin: leeming, 30 Mar 2004
3142 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
3145 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP
3146 * \li Action: Move the cursor to the next paragraph (or beginning of the current one)
3147 in upward direction.
3148 * \li Syntax: paragraph-up
3149 * \li Origin: Asger, 1 Oct 1996
3152 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
3155 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UPDATE
3156 * \li Action: Updates the values inside the paragraph dialog from the paragraph.
3157 * \li Notion: This is an internal LFUN, not to be used by users. Called internally
3158 by #LFUN_DIALOG_UPDATE.
3159 * \li Origin: leeming, 13 Mar 2003
3162 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
3166 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP_SELECT
3167 * \li Action: Move the cursor and select the text to the next paragraph (or
3168 beginning of the current one) in upward direction.
3169 * \li Syntax: paragraph-up-select
3170 * \li Origin: Asger, 1 Oct 1996
3173 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
3176 * \var lyx::FuncCode lyx::LFUN_PASTE
3177 * \li Action: Pastes material (text or picture) from the active clipboard.
3178 * \li Syntax: paste [<TYPE>|<NUM>]
3179 * \li Params: <TYPE>: emf|pdf|png|jpeg|linkback|wmf|latex|html \n
3180 <NUM>: number of the selection in the internal clipboard stack to be pasted.
3183 { LFUN_PASTE, "paste", Noop, Edit },
3186 * \var lyx::FuncCode lyx::LFUN_PHANTOM_INSERT
3187 * \li Action: Inserts phantom on the current cursor position,
3188 move selection inside the inset.
3189 * \li Syntax: phantom-insert [<TYPE>]
3190 * \li Params: <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
3191 * \li Origin: uwestoehr, 30 Jan 2009
3194 { LFUN_PHANTOM_INSERT, "phantom-insert", Noop, Edit },
3197 * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
3198 * \li Action: Save user preferences.
3199 * \li Syntax: preferences-save
3200 * \li Origin: Lgb, 27 Nov 1999
3203 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
3206 * \var lyx::FuncCode lyx::LFUN_PREVIEW_INSERT
3207 * \li Action: Inserts a new preview inset.
3208 * \li Syntax: preview-insert
3209 * \li Origin: vfr, 28 Mar 2010
3212 { LFUN_PREVIEW_INSERT, "preview-insert", Noop, Edit },
3215 * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
3216 * \li Action: Pastes the currently selected text.
3217 * \li Notion: Primary selection mechanism is linux-only thing.
3218 * \li Syntax: primary-selection-paste [<ARG>]
3219 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
3222 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
3225 * \var lyx::FuncCode lyx::LFUN_QUOTE_INSERT
3226 * \li Action: Inserts quotes according to the type and quote-language preference.
3227 * \li Notion: Currently 15 different quote styles are distinguished (see params).
3228 * \li Syntax: quote-insert [<LEVEL>] [<SIDE>] [<STYLE>]
3229 * \li Params: <LEVEL>: 'inner' for (i.e., secondary, usually single) quotes, otherwise
3230 * outer (i.e., primary, usually double) quotes will be used.\n
3231 * <SIDE>: 'opening' for opening quotes, 'closing' for closing quotes,
3232 * otherwise the side will be guessed from the context.\n
3233 * <STYLE>: 'british' for `British' quote style (with ``inner quotation'')\n
3234 * 'cjk' for Chinese/Japanese/Korean corner bracket quotation marks\n
3235 * 'cjk-angle' for Chinese/Japanese/Korean angle bracket quotation marks\n
3236 * 'danish' for >>Danish<< quote style (with >inner quotation<)\n
3237 * 'english' for ``English'' quote style (with `inner quotation')\n
3238 * 'french' for <<french>> quote style (with ``inner quotation'')\n
3239 * 'frenchin' for <<frenchin>> quote style (with <<inner quotation>>) ["in" = Imprimerie Nationale]\n
3240 * 'german' for ,,German`` quote style (with ,inner quotation`)\n
3241 * 'plain' for "Plain" quote style (with 'inner quotation')\n
3242 * 'polish' for ,,Polish'' quote style (with ,inner quotation')\n
3243 * 'swedish' for ''Swedish'' quote style (with 'inner quotation')\n
3244 * 'swedishg' for >>swedishg>> quote style (with 'inner quotation') ["g" = Guillemets]\n
3245 * 'swiss' for <<Swiss>> quote style (with <inner quotation>)\n
3246 * 'russian' for <<Russian>> quote style (with ,,inner quotation``)\n
3247 * 'dynamic' for Dynamic quotation marks which inherit the global
3249 * If no quote style is specified, the document-wide will be used.
3252 { LFUN_QUOTE_INSERT, "quote-insert", Noop, Edit },
3255 * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
3256 * \li Action: Reconfigure the automatic settings.
3257 * \li Syntax: reconfigure
3258 * \li Origin: Asger, 14 Feb 1997
3261 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
3264 * \var lyx::FuncCode lyx::LFUN_REDO
3265 * \li Action: Redoes the last thing undone.
3269 { LFUN_REDO, "redo", ReadOnly, Edit },
3272 * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
3273 * \li Action: Go to the next label or cross-reference.
3274 * \li Syntax: reference-next
3275 * \li Origin: Dekel, 14 Jan 2001
3278 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
3282 * \var lyx::FuncCode lyx::LFUN_REGEXP_MODE
3283 * \li Action: Enters regexp mode (i.e., puts regexp insets on the current
3284 cursor position). Used by the advanced search dialog.
3285 * \li Notion: If there is any selected text, then it is moved inside the created
3287 * \li Syntax: regexp-mode [<ARG>]
3288 * \li Params: <ARG>: eventual argument (regular expression).
3289 * \li Origin: Tommaso, 4 Oct 2008
3292 { LFUN_REGEXP_MODE, "regexp-mode", Noop, Math },
3295 * \var lyx::FuncCode lyx::LFUN_REPEAT
3296 * \li Action: Repeat the given command.
3297 * \li Notion: fails when the repeat count is greater than 10000.
3298 * \li Syntax: repeat <COUNT> <LFUN-COMMAND>
3299 * \li Origin: Andre, 27 Oct 2003
3302 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
3305 * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN
3306 * \li Action: Moves the cursor one page in downward direction.
3307 * \li Syntax: screen-down
3310 { LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit },
3313 * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN_SELECT
3314 * \li Action: Moves the cursor one screen in downward direction adding the current
3315 position to the selection.
3316 * \li Syntax: screen-down-select
3319 { LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit },
3322 * \var lyx::FuncCode lyx::LFUN_SCREEN_FONT_UPDATE
3323 * \li Action: Update fonts and its metrics.
3324 * \li Notion: Automatically called after zoom, dpi, font names, or norm change.
3325 * \li Syntax: screen-font-update
3326 * \li Origin: ARRae, 13 Aug 2000
3329 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
3332 * \var lyx::FuncCode lyx::LFUN_SCREEN_RECENTER
3333 * \li Action: Recenters the screen on the current cursor position.
3334 * \li Syntax: screen-recenter
3337 { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit },
3341 * \var lyx::FuncCode lyx::LFUN_SCREEN_SHOW_CURSOR
3342 * \li Action: Repositions the screen such that the cursor is visible.
3343 * \li Syntax: screen-show-cursor
3344 * \li Origin: vfr, 25 Mar 2009
3347 { LFUN_SCREEN_SHOW_CURSOR, "screen-show-cursor", ReadOnly, Edit },
3351 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP
3352 * \li Action: Moves the cursor one page in upward direction.
3353 * \li Syntax: screen-up
3356 { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit },
3359 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP_SELECT
3360 * \li Action: Moves the cursor one page in upward direction adding the current
3361 position to the selection.
3362 * \li Syntax: screen-up-select
3365 { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit },
3368 * \var lyx::FuncCode lyx::LFUN_SCRIPT_INSERT
3369 * \li Action: Inserts a subscript or superscript inset.
3370 * \li Syntax: script-insert <TYPE>
3371 * \li Params: <TYPE>: subscript|superscript
3372 * \li Origin: Georg, 23 Nov 2010
3375 { LFUN_SCRIPT_INSERT, "script-insert", Noop, Edit },
3378 * \var lyx::FuncCode lyx::LFUN_SCROLL
3379 * \li Action: Scroll the buffer view.
3380 * \li Notion: Only scrolls the screen up or down; does not move the cursor.
3381 * \li Syntax: scroll <TYPE> <QUANTITY>
3382 * \li Params: <TYPE>: line|page\n
3383 <QUANTITY>: up|down|<number>
3384 * \li Origin: Abdel, Dec 27 2007
3387 { LFUN_SCROLL, "scroll", ReadOnly, Edit },
3390 * \var lyx::FuncCode lyx::LFUN_SECTION_SELECT
3391 * \li Action: Select the whole section.
3392 * \li Notion: The cursor should be in a section heading
3393 before calling this lfun.
3394 * \li Syntax: section-select
3395 * \li Origin: vfr, 05 May 2009
3398 { LFUN_SECTION_SELECT, "section-select", ReadOnly, Edit },
3402 * \var lyx::FuncCode lyx::LFUN_SELECTION_PASTE
3403 * \li Action: Pastes the internal selection text in permanent selection.
3404 * \li Notion: Created in order to have middle mouse button pasting correct (bound to
3405 command-alternatives selection-paste ; primary-selection-paste paragraph).
3406 * \li Syntax: selection-paste
3407 * \li Origin: lasgouttes, 14 Jan 2009
3410 { LFUN_SELECTION_PASTE, "selection-paste", Noop, Edit },
3413 * \var lyx::FuncCode lyx::LFUN_SELF_INSERT
3414 * \li Action: Inserts the given string (accordingly to the correct keymap).
3415 * \li Notion: Automatically replace the currently selected text. Depends on lyxrc
3416 settings "auto_region_delete".
3417 * \li Syntax: self-insert <STRING>
3420 { LFUN_SELF_INSERT, "self-insert", SingleParUpdate, Hidden },
3423 * \var lyx::FuncCode lyx::LFUN_SEPARATOR_INSERT
3424 * \li Action: Inserts an environment separator or latex paragraph break.
3425 * \li Syntax: separator-insert [<ARG>]
3426 * \li Params: <ARG>: <plain|parbreak|latexpar> default: plain
3427 * \li Origin: ef, 2 May 2014
3430 { LFUN_SEPARATOR_INSERT, "separator-insert", Noop, Edit },
3433 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_FILENAME
3434 * \li Action: Returns path and file name of the currently edited document.
3435 * \li Syntax: server-get-filename
3438 { LFUN_SERVER_GET_FILENAME, "server-get-filename", ReadOnly, System },
3441 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_LAYOUT
3442 * \li Action: Returns the current layout (that is environment) name
3443 on the cursor position.
3444 * \li Syntax: server-get-layout
3447 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
3450 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_STATISTICS
3451 * \li Action: Returns the statistics (number of words and characters)
3452 in the document or in the given selection.
3453 * \li Notion: Note that this function gives the number of words/chars written,
3454 not the number of characters which will be typeset.
3455 * \li Syntax: server-get-statistics [<TYPE>]
3456 * \li Params: <TYPE>: <words|chars|chars-space> The requested count; if not
3457 specified, the three values are returned, separated
3459 words: count words.\n
3460 chars: count characters.\n
3461 chars-space: count characters and spaces.
3462 * \li Origin: brokenclock, Oct 10 2014
3465 { LFUN_SERVER_GET_STATISTICS, "server-get-statistics", ReadOnly, System },
3468 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
3469 * \li Action: Returns the coordinates of cursor position in the editing area.
3470 * \li Syntax: server-get-xy
3473 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
3477 * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
3478 * \li Action: Sets the cursor position in LyX based on the row number of generated TeX file.
3479 * \li Notion: This can be useful for DVI inverse-search or detection of the problematic
3480 line from LaTeX compilation. Note that before this function can be used
3481 export to LaTeX output must occur (in order to map the row numbers).
3482 * \li Syntax: server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
3483 * \li Params: <FILE>: the path and filename. Environment variables are expanded in the path.
3484 In case this LFUN does not work make sure you are giving correct
3486 If the file is located inside LyX temporary directory it will be
3487 mapped back into the appropriate opened buffer (e.g. for the case
3488 of generated .tex file).\n
3489 .ext: extensions will be automatically replaced by .lyx.\n
3490 <ROW_NUMBER> The row number of the LaTeX file to which to go.
3491 * \li Sample: server-goto-file-row /home/user/example.lyx 41\n
3492 server-goto-file-row /tmp/lyx_tmpdir.XM3088/lyx_tmpbuf0/example.tex 41
3493 * \li Origin: Edmar, 23 Dec 1998
3496 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly | NoBuffer, System },
3499 * \var lyx::FuncCode lyx::LFUN_SERVER_NOTIFY
3500 * \li Action: Sends notify message about the last key-sequence to client.
3501 * \li Notion: This can be used to grab last key-sequence used inside the LyX window.
3502 See also Debug extensions section in Additional features manual.
3503 * \li Syntax: server-notify
3506 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
3509 * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
3510 * \li Action: Sets the cursor position based on the editing area coordinates
3511 (similar to clicking on that point with left mouse button).
3512 * \li Syntax: server-set-xy <X> <Y>
3515 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
3518 * \var lyx::FuncCode lyx::LFUN_SET_COLOR
3519 * \li Action: Set the given LyX color to the color defined by the X11 name given.
3520 * \li Notion: A new color entry is created if the color is unknown.
3521 Color names can be stored as a part of user settings.
3522 * \li Syntax: set-color <LYX_NAME> <X11_NAME>
3523 * \li Origin: SLior, 11 Jun 2000
3526 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
3529 * \var lyx::FuncCode lyx::LFUN_SET_GRAPHICS_GROUP
3530 * \li Action: Set the group for the graphics inset on the cursor position.
3531 * \li Syntax: set-graphics-group [<GROUP>]
3532 * \li Params: <GROUP>: Id for an existing group. In case the Id is an empty string,
3533 the graphics inset is removed from the current group.
3534 * \li Origin: sanda, 6 May 2008
3537 { LFUN_SET_GRAPHICS_GROUP, "set-graphics-group", Noop, Edit },
3541 * \var lyx::FuncCode lyx::LFUN_SPACE_INSERT
3542 * \li Action: Inserts one of horizontal space insets.
3543 * \li Syntax: space-insert <NAME> [<LEN>]
3544 * \li Params: <NAME>: normal, protected, visible, thin, quad, qquad, enspace,
3545 enskip, negthinspace, negmedspace, negthickspace, hfill,
3546 hfill*, dotfill, hrulefill, hspace, hspace* \n
3547 Only in math mode: med and thick.\n
3548 <LEN>: length for custom spaces (hspace, hspace* for protected)
3549 * \li Origin: JSpitzm, 20 May 2003, Mar 17 2008
3552 { LFUN_SPACE_INSERT, "space-insert", Noop, Edit },
3555 * \var lyx::FuncCode lyx::LFUN_SPECIALCHAR_INSERT
3556 * \li Action: Inserts various characters into the document.
3557 * \li Syntax: specialchar-insert <CHAR>
3558 * \li Params: <CHAR>: hyphenation, allowbreak, ligature-break, slash,
3559 nobreakdash, dots, end-of-sentence, menu-separator,
3560 lyx, tex, latex, latex2e.
3561 * \li Origin: JSpitzm, 6 Dec 2007
3564 { LFUN_SPECIALCHAR_INSERT, "specialchar-insert", Noop, Edit },
3567 * \var lyx::FuncCode lyx::LFUN_SPELLING_ADD
3568 * \li Action: Add the word under the cursor to the respective
3569 * spell checker dictionary.
3570 * The default for the language is retrieved from the cursor position.
3571 * \li Syntax: spelling-add [<STRING>] [<LANG>]
3572 * \li Params: <WORD>: word to add
3573 <LANG>: language name (see file languages)
3574 * \li Origin: JSpitzm, 18 Jan 2010
3577 { LFUN_SPELLING_ADD, "spelling-add", ReadOnly, Edit },
3580 * \var lyx::FuncCode lyx::LFUN_SPELLING_CONTINUOUSLY
3581 * \li Action: Toggle continuous spell checking.
3582 * \li Syntax: spelling-continuously
3583 * \li Origin: vfr, 24 March 2013
3586 { LFUN_SPELLING_CONTINUOUSLY, "spelling-continuously", ReadOnly, Edit },
3590 * \var lyx::FuncCode lyx::LFUN_SPELLING_IGNORE
3591 * \li Action: Let the spell checker ignore the word under the cursor
3592 * in the current session for the given language.
3593 * The default for the language is retrieved from the cursor position.
3594 * \li Syntax: spelling-ignore [<WORD>] [<LANG>]
3595 * \li Params: <WORD>: word to ignore
3596 <LANG>: language name (see file languages)
3597 * \li Origin: JSpitzm, 18 Jan 2010
3600 { LFUN_SPELLING_IGNORE, "spelling-ignore", ReadOnly, Edit },
3603 * \var lyx::FuncCode lyx::LFUN_SPELLING_REMOVE
3604 * \li Action: Remove the word under the cursor from the respective
3605 * spell checker dictionary.
3606 * The default for the language is retrieved from the cursor position.
3607 * \li Syntax: spelling-remove [<STRING>] [<LANG>]
3608 * \li Params: <WORD>: word to remove
3609 * <LANG>: language name (see file languages)
3610 * \li Origin: SWitt, 28 July 2010
3613 { LFUN_SPELLING_REMOVE, "spelling-remove", ReadOnly, Edit },
3617 * \var lyx::FuncCode lyx::LFUN_STATISTICS
3618 * \li Action: Count the statistics (number of words and characters)
3619 in the document or in the given selection and display it
3621 * \li Notion: Note that this function gives the number of words/chars written,
3622 not the number of characters which will be typeset.
3623 * \li Syntax: statistics
3624 * \li Origin: lasgouttes, Jan 27 2004; sanda, Jan 8 2008
3627 { LFUN_STATISTICS, "statistics", ReadOnly, System },
3630 * \var lyx::FuncCode lyx::LFUN_TABULAR_FEATURE
3631 * \li Action: Modify properties of tabulars and table-like math environments.
3632 * \li Syntax: tabular-feature <FEATURE> [<ARG>]
3633 * \li Params: Generally see #LFUN_INSET_INSERT for further details.\n
3634 * <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|\n
3635 copy-column|move-column-right|move-column-left|move-row-down|move-row-up|\n
3636 toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|\n
3637 align-left|align-right|align-center|align-block|align-decimal|set-decimal-point|\n
3638 valign-top|valign-bottom|valign-middle|longtabular-align-left|\n
3639 longtabular-align-center|longtabular-align-right|m-align-left|m-align-right|\n
3640 m-align-center|m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|\n
3641 set-all-lines|unset-all-lines|toggle-longtabular|set-longtabular|unset-longtabular|set-pwidth|\n
3642 set-mpwidth|set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|\n
3643 set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|\n
3644 unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|\n
3645 set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|\n
3646 set-special-column|set-special-multicolumn|set-special-multirow|\n
3647 toggle-booktabs|set-booktabs|unset-booktabs|set-top-space|set-bottom-space|\n
3648 set-interline-space|set-border-lines|tabular-valign-top|\n
3649 tabular-valign-middle|tabular-valign-bottom|set-tabular-width\n
3650 Various math-environment features are handled as well, e.g. add-vline-left/right for\n
3651 the Grid/Array environment.\n
3652 <ARG>: additional argument for some commands, use debug mode to explore its values.
3653 * \li Origin: gm, 10 Dec 2015
3656 { LFUN_TABULAR_FEATURE, "tabular-feature", Noop, Edit },
3659 * \var lyx::FuncCode lyx::LFUN_TABULAR_INSERT
3660 * \li Action: Inserts table into the document.
3661 * \li Notion: See #LFUN_TABULAR_FEATURE for some more details
3662 about tabular modifications.
3663 * \li Syntax: tabular-insert [<ROWS> <COLUMNS>]
3664 * \li Params: In case no arguments are given show insert dialog.
3665 * \li Origin: Jug, 12 Apr 2000
3668 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
3672 * \var lyx::FuncCode lyx::LFUN_TAB_DELETE
3673 * \li Action: Delete a tab or up to an equivalent amount of spaces from
3675 * \li Notion: It also works on a selection - it removes a tab or spaces from the
3676 beginning of each line spanned by the selection. This is useful if
3677 you want to indent/unindent multiple lines in one action.
3678 * \li Syntax: tab-delete
3679 * \li Origin: vfr, Sep 30 2008
3682 { LFUN_TAB_DELETE, "tab-delete", SingleParUpdate, Edit },
3685 * \var lyx::FuncCode lyx::LFUN_TAB_GROUP_CLOSE
3686 * \li Action: Close the current tab group.
3687 * \li Notion: This only closes the work areas, not the buffers themselves.
3688 The still opened buffers can be visualized in another tab group.
3689 * \li Syntax: tab-group-close
3690 * \li Origin: Abdel, 21 Feb 2008
3693 { LFUN_TAB_GROUP_CLOSE, "tab-group-close", ReadOnly, Buffer },
3697 * \var lyx::FuncCode lyx::LFUN_TAB_INSERT
3698 * \li Action: Insert a tab into a listings inset.
3699 * \li Notion: It also works on a selection.
3700 * \li Syntax: tab-insert
3701 * \li Origin: vfr, Sep 30 2008
3704 { LFUN_TAB_INSERT, "tab-insert", SingleParUpdate, Edit },
3707 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
3708 * \li Action: Sets the text class for the current buffer.
3709 * \li Syntax: textclass-apply <TEXTCLASS>
3710 * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
3711 the filename, minus the ".layout" extension.
3714 { LFUN_TEXTCLASS_APPLY, "textclass-apply", NoInternal, Layout },
3717 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
3718 * \li Action: Loads information for a textclass from disk.
3719 * \li Syntax: textclass-load <TEXTCLASS>
3720 * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
3721 the filename, minus the ".layout" extension.
3724 { LFUN_TEXTCLASS_LOAD, "textclass-load", NoInternal, Layout },
3728 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_APPLY
3729 * \li Action: Toggle user-defined (=last-time used) text style.
3730 * \li Notion: This style is set via #LFUN_TEXTSTYLE_UPDATE, which is
3731 automatically triggered when using Text Style dialog.
3732 * \li Syntax: textstyle-apply
3733 * \li Origin: leeming, 12 Mar 2003
3736 { LFUN_TEXTSTYLE_APPLY, "textstyle-apply", Noop, Layout },
3739 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_UPDATE
3740 * \li Action: Apply text style and update the settings to be used by #LFUN_TEXTSTYLE_APPLY.
3741 * \li Syntax: textstyle-update <FONT_INFO>
3742 * \li Params: <FONT_INFO>: specifies font atributes, e.g. family, series, shape,
3743 size, emph, noun, underbar, number, color, language,
3745 Use lyx -dbg action for exact syntax of text-style
3747 * \li Origin: leeming, 12 Mar 2003
3750 { LFUN_TEXTSTYLE_UPDATE, "textstyle-update", Noop, Layout },
3753 * \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
3754 * \li Action: Look up thesaurus entries with respect to the word under the cursor.
3755 * \li Syntax: thesaurus-entry [<STRING>] [lang=<LANG>]
3756 * \li Params: <STRING>: word to look up
3757 <LANG>: language (see file languages)
3758 * \li Origin: Levon, 20 Jul 2001
3761 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
3764 * \var lyx::FuncCode lyx::LFUN_TOOLBAR_MOVABLE
3765 * \li Action: Toggles movability of a given toolbar between true/false.
3766 * \li Syntax: toolbar-movable <NAME>
3767 * \li Params: <NAME>: *|standard|extra|table|math|mathmacrotemplate|\n
3768 minibuffer|review|view/update|math_panels|vcs|
3769 view-others|update-others
3770 * \li Origin: daniel, 12 July 2016
3773 { LFUN_TOOLBAR_MOVABLE, "toolbar-movable", NoBuffer, Buffer },
3776 * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
3777 * \li Action: Toggles visibility of a given toolbar between on/off/auto.
3778 * \li Notion: Skipping "auto" when allowauto is false.
3779 * \li Syntax: toolbar-toggle <NAME> [allowauto]
3780 * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|\n
3781 minibuffer|review|view/update|math_panels|vcs|
3782 view-others|update-others
3783 * \li Origin: Edwin, 21 May 2007
3786 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
3789 * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
3790 * \li Action: Various UI visibility-toggling actions.
3791 * \li Syntax: ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
3792 * \li Params: statusbar : Toggle visibility of the statusbar.\n
3793 menubar : Toggle visibility of the menubar.\n
3794 scrollbar : Toggle visibility of the scrollbar.\n
3795 frame : Toggle visibility of the frames around editing window.\n
3796 fullscreen : Toggle fullscreen mode. This also covers calling the
3797 previous functions. However #LFUN_TOOLBAR_TOGGLE for the
3798 custom tweaks of the toolbars should be used.
3799 * \li Origin: sanda, 9 Feb 2007
3802 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
3806 * \var lyx::FuncCode lyx::LFUN_UNDO
3807 * \li Action: Undoes the last edit.
3811 { LFUN_UNDO, "undo", ReadOnly, Edit },
3814 * \var lyx::FuncCode lyx::LFUN_UNICODE_INSERT
3815 * \li Action: Inserts a single unicode character.
3816 * \li Syntax: unicode-insert <CHAR>
3817 * \li Params: <CHAR>: The character to insert, given as its code
3818 point, in hexadecimal.
3819 * \li Sample: unicode-insert 0x0100
3820 * \li Origin: Lgb, 22 Oct 2006
3823 { LFUN_UNICODE_INSERT, "unicode-insert", Noop, Edit },
3826 * \var lyx::FuncCode lyx::LFUN_UP
3827 * \li Action: Moves the cursor one line in upward direction.
3831 { LFUN_UP, "up", ReadOnly | NoUpdate, Edit },
3834 * \var lyx::FuncCode lyx::LFUN_UP_SELECT
3835 * \li Action: Moves the cursor one line in upward direction adding the current
3836 position to the selection.
3837 * \li Syntax: up-select
3840 { LFUN_UP_SELECT, "up-select", ReadOnly | SingleParUpdate, Edit },
3843 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_IN
3844 * \li Action: Checks-in/commits the changes of the registered file to the repository.
3845 * \li Notion: In RCS case this also unlocks the file.
3846 * \li Syntax: vc-check-in
3847 * \li Origin: Lgb, 1 Jul 1997
3850 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
3853 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_OUT
3854 * \li Action: Checks-out the document for edit (and locks it in some cases).
3855 * \li Syntax: vc-check-out
3856 * \li Origin: Lgb, 1 Jul 1997
3859 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
3862 * \var lyx::FuncCode lyx::LFUN_VC_COMMAND
3863 * \li Action: Executes external command. This command is intended to support
3864 additional VCS commands.
3865 * \li Syntax: vc-command <FLAG> <PATH> <COMMAND>
3866 * \li Params: <FLAG>: Flags for the command can be combined together.\n
3867 U - dUmmy - no flags \n
3868 D - Doc - need document loaded to proceed \n
3869 I - dIrty - mark document dirty \n
3870 R - Reload - ensure that the document is saved and reload it after command execution \n
3871 M - Message - ask for input string (commit message)\n
3872 <PATH>: path where to start. $$p will be replaced by the current document path.\n
3873 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current
3874 document(with absolute path)/path/message.
3875 * \li Sample: vc-command DR $$p "svn up"
3876 * \li Origin: sanda, 13 Jan 2009
3879 { LFUN_VC_COMMAND, "vc-command", NoBuffer | ReadOnly, System },
3882 * \var lyx::FuncCode lyx::LFUN_VC_COMPARE
3883 * \li Action: Compares two revisions of the same file under version control.
3884 * \li Syntax: vc-compare [<REV1>] [<REV2>]
3885 * \li Params: Revision number either points directly to commit in history
3886 or if negative number -x it points to (last commit - x).\n
3887 In RCS we subtract only in the last number of revision specification.
3888 Special case "0" is reserved for the last committed revision.\n
3889 <REV1>: Older file.\n
3890 <REV2>: Newer file. Used only if REV1 > 0.\n
3891 If no parameter is given, interactive dialog will be shown.
3892 * \li Sample: Compare current document against last commit\n
3894 Compare current document against current revision - 5 commits\n
3896 Compare revisions 120 and 155\n
3898 * \li Origin: sanda, 12 Feb 2010
3901 { LFUN_VC_COMPARE, "vc-compare", ReadOnly, System },
3905 * \var lyx::FuncCode lyx::LFUN_VC_COPY
3906 * \li Action: Copies the document to another name.
3907 * \li Notion: Copying with revision history is only supported by SVN.
3908 For RCS and CVS it is simulated by adding the document
3910 Disabled if uncommitted changes exist.
3911 * \li Syntax: vc-copy <FILENAME>
3912 * \li Params: <FILENAME>: New name of the document.\n
3913 * A file dialog is opened if no filename is given.
3914 * \li Origin: gb, 05 Feb 2013
3917 { LFUN_VC_COPY, "vc-copy", ReadOnly, System },
3920 * \var lyx::FuncCode lyx::LFUN_VC_LOCKING_TOGGLE
3921 * \li Action: Toggles the locking property of the edited file.
3922 * \li Notion: This is currently implemented only for SVN.
3923 * \li Syntax: vc-locking-toggle
3924 * \li Origin: sanda, 25 Jun 2009
3927 { LFUN_VC_LOCKING_TOGGLE, "vc-locking-toggle", ReadOnly, System },
3930 * \var lyx::FuncCode lyx::LFUN_VC_REGISTER
3931 * \li Action: Register the document as an file inside version control system.
3932 * \li Notion: File is registered inside cvs, svn or rcs repository acording to the existence
3933 of cvs/svn/rcs entries in the document's directory. \n
3934 See LyX Additional Features Manual (Version Control Chapter) for additional
3936 * \li Syntax: vc-register
3937 * \li Origin: Lgb, 1 Jul 1997
3940 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
3943 * \var lyx::FuncCode lyx::LFUN_VC_RENAME
3944 * \li Action: Renames the document to another name.
3945 * \li Notion: Renaming with revision history is only supported by SVN.
3946 For CVS it is simulated by adding the document under a new
3947 name and deleting the old one. For RCS it is not supported.
3948 Disabled if uncommitted changes exist.
3949 * \li Syntax: vc-rename <FILENAME>
3950 * \li Params: <FILENAME>: New name of the document.\n
3951 * A file dialog is opened if no filename is given.
3952 * \li Origin: gb, 05 Feb 2013
3955 { LFUN_VC_RENAME, "vc-rename", ReadOnly, System },
3958 * \var lyx::FuncCode lyx::LFUN_VC_REPO_UPDATE
3959 * \li Action: Update the local archive directory in which resides
3960 the current document with the remote repository.
3961 * \li Syntax: vc-repo-update
3962 * \li Origin: sanda, 16 Oct 2009
3965 { LFUN_VC_REPO_UPDATE, "vc-repo-update", ReadOnly, System },
3968 * \var lyx::FuncCode lyx::LFUN_VC_REVERT
3969 * \li Action: Reverts the document to the last check-in/commit in VCS.
3970 * \li Syntax: vc-revert
3971 * \li Origin: Lgb, 1 Jul 1997
3974 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
3977 * \var lyx::FuncCode lyx::LFUN_VC_UNDO_LAST
3978 * \li Action: Undo last check-in.
3979 * \li Notion: This is currently implemented only for RCS.
3980 * \li Syntax: vc-check-out
3981 * \li Origin: Lgb, 1 Jul 1997
3984 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
3987 * \var lyx::FuncCode lyx::LFUN_VIEW_CLOSE
3988 * \li Action: Close the current document work area.
3989 * \li Notion: Close the current work area. If no other work areas are showing the buffer,
3990 then close the associated buffer as well.
3991 * \li Syntax: view-close
3992 * \li Origin: Tommaso, 15 Sep 2012
3995 { LFUN_VIEW_CLOSE, "view-close", ReadOnly, Buffer },
3999 * \var lyx::FuncCode lyx::LFUN_VIEW_SPLIT
4000 * \li Action: Creates another split view of current buffer.
4001 * \li Notion: All split views act in the same way independently.
4002 * \li Syntax: view-split <vertical|horizontal>
4003 * \li Params: horizontal : The work areas are laid out side by side.\n
4004 vertical : The work areas laid out vertically.
4005 * \li Origin: Abdel, 20 Feb 2008
4008 { LFUN_VIEW_SPLIT, "view-split", ReadOnly, Buffer },
4012 * \var lyx::FuncCode lyx::LFUN_WINDOW_CLOSE
4013 * \li Action: Closes the current LyX window.
4014 * \li Syntax: window-close
4015 * \li Origin: Abdel, 23 Oct 2006
4018 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
4022 * \var lyx::FuncCode lyx::LFUN_WINDOW_NEW
4023 * \li Action: Creates new empty LyX window.
4024 * \li Notion: Already opened documents from the previous window can be found under View menu.
4025 * \li Syntax: window-new [<GEOMETRY>]
4026 * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently
4027 accepted only on Windows platform.
4028 * \li Origin: Abdel, 21 Oct 2006
4031 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
4034 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD
4035 * \li Action: Moves the cursor to the logically previous beginning of a word.
4036 * \li Notion: This is not the action which should be bound to the arrow keys,
4037 because backwards may be left or right, depending on the
4038 language. The arrow keys should be bound to #LFUN_WORD_LEFT or
4039 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
4040 * \li Syntax: word-backward
4043 { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit },
4046 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD_SELECT
4047 * \li Action: Moves the cursor to the logically previous beginning of a word,
4048 adding the logically traversed text to the selection.
4049 * \li Notion: See also #LFUN_WORD_BACKWARD.
4050 * \li Syntax: word-backward-select
4053 { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
4056 * \var lyx::FuncCode lyx::LFUN_WORD_CAPITALIZE
4057 * \li Action: Capitalizes the words in the selection (i.e. the first letters)
4058 or the first letter of word at cursor position.
4059 * \li Syntax: word-capitalize [<SEL_TYPE>]
4060 * \li Params: <SEL_TYPE>: if this is equal to "partial", then the
4061 * default word starts at cursor position (emacs-style).
4062 * Otherwise, the whole word is considered.
4065 { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
4068 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_BACKWARD
4069 * \li Action: Deletes characters to the beginning of the word (usually the "C+BackSpace" key).
4070 * \li Syntax: word-delete-backward [force]
4071 * \li Params: force: Delete big insets, do not only select them.
4074 { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
4077 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_FORWARD
4078 * \li Action: Deletes characters to the end of the word (usually the "C+Delete" key).
4079 * \li Syntax: word-delete-forward [force]
4080 * \li Params: force: Delete big insets, do not only select them.
4083 { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
4086 * \var lyx::FuncCode lyx::LFUN_WORD_FIND
4087 * \li Action: Search for next occurrence of a string.
4088 * \li Syntax: word-find [<DATA>]
4089 * \li Params: <DATA>: data encoded from Find dialog (see #lyx::find2string()).
4090 If no parameter is given, search with last find-dialog
4091 data is used for search (i.e. find-next).
4092 * \li Origin: Andre, Jan 7 2004
4095 { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
4098 * \var lyx::FuncCode lyx::LFUN_WORD_FINDADV
4099 * \li Action: Search for next occurrence of a pattern.
4100 * \li Syntax: word-findadv [<DATA>]
4101 * \li Params: <DATA>: data encoded from FindAdv dialog (see #lyx::findadv2string()).
4102 If no parameter is given, search with last find-dialog
4103 data is used for search (i.e. find-next).
4104 * \li Origin: Tommaso, Nov 15 2007
4107 { LFUN_WORD_FINDADV, "word-findadv", ReadOnly | NoBuffer, Edit },
4110 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_BACKWARD
4111 * \li Action: Search for a given string in backward direction.
4112 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
4113 * \li Syntax: word-find-backward [<STRING>]
4114 * \li Origin: Etienne, 20 Feb 1998
4117 { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
4120 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_FORWARD
4121 * \li Action: Search for a given string in forward direction.
4122 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
4123 * \li Syntax: word-find-forward [<STRING>]
4124 * \li Origin: Etienne, 16 Feb 1998
4127 { LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit },
4130 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD
4131 * \li Action: Moves the cursor to the logically next beginning of a word.
4132 * \li Notion: This is not the action which should be bound to the arrow keys,
4133 because forward may be left or right, depending on the language.
4134 The arrow keys should be bound to #LFUN_WORD_LEFT or
4135 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
4136 * \li Syntax: word-forward
4139 { LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
4142 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD_SELECT
4143 * \li Action: Moves the cursor to the logically next beginning of a word,
4144 adding the logically traversed text to the selection.
4145 * \li Notion: See also #LFUN_WORD_FORWARD.
4146 * \li Syntax: word-forward-select
4149 { LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
4152 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT
4153 * \li Action: Moves the cursor to the next beginning of a word "on the left".
4154 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
4155 "left" key is pressed. Generally, it moves the cursor to the
4156 next beginning of a word on the left. However, in Bidi text this
4157 become slightly more complicated, and there are different modes
4158 of cursor movement. In "visual mode", this moves left, plain and
4159 simple. In "logical mode", movement is logically forward in RTL
4160 paragraphs, and logically backwards in LTR paragraphs.
4161 * \li Syntax: word-left
4162 * \li Origin: dov, 28 Oct 2007
4165 { LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
4168 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT_SELECT
4169 * \li Action: Moves the cursor to the next beginning of a word "on the left",
4170 adding *logically* traversed text to the selection.
4171 * \li Notion: See also #LFUN_WORD_LEFT for exact details of the movement.
4172 * \li Syntax: word-left-select
4173 * \li Origin: dov, 28 Oct 2007
4176 { LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit },
4179 * \var lyx::FuncCode lyx::LFUN_WORD_LOWCASE
4180 * \li Action: Change the words in the selection or word at cursor position
4182 * \li Syntax: word-lowcase [<SEL_TYPE>]
4183 * \li Params: <SEL_TYPE>: if this is equal to "partial", then the
4184 * default word starts at cursor position (emacs-style).
4185 * Otherwise, the whole word is considered.
4188 { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
4191 * \var lyx::FuncCode lyx::LFUN_WORD_REPLACE
4192 * \li Action: Replace a string in the document.
4193 * \li Syntax: word-replace [<DATA>]
4194 * \li Params: <DATA>: data is of the form
4197 <casesensitive> <matchword> <all> <forward> <findnext>"
4198 * \li Origin: Andre, Jan 7 2004
4201 { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
4204 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT
4205 * \li Action: Moves the cursor to the next beginning of a word "on the right".
4206 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
4207 "right" key is pressed. Generally, it moves the cursor to the
4208 next beginning of a word on the right. However, in Bidi text
4209 this become slightly more complicated, and there are different
4210 modes of cursor movement. In "visual mode", this moves right,
4211 plain and simple. In "logical mode", movement is logically
4212 forward in LTR paragraphs, and logically backwards in RTL
4214 * \li Syntax: word-right
4215 * \li Origin: dov, 28 Oct 2007
4218 { LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit },
4221 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT_SELECT
4222 * \li Action: Moves the cursor to the next beginning of a word "on the right",
4223 adding *logically* traversed text to the selection.
4224 * \li Notion: See also #LFUN_WORD_RIGHT for exact details of the movement.
4225 * \li Syntax: word-right-select
4226 * \li Origin: dov, 28 Oct 2007
4229 { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
4232 * \var lyx::FuncCode lyx::LFUN_WORD_SELECT
4233 * \li Action: Puts the word where the cursor stands into the selection.
4234 * \li Syntax: word-select
4235 * \li Origin: Andre, 11 Sep 2002
4238 { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
4241 * \var lyx::FuncCode lyx::LFUN_WORD_UPCASE
4242 * \li Action: Change the words in the selection or word at cursor position
4244 * \li Syntax: word-upcase [<SEL_TYPE>]
4245 * \li Params: <SEL_TYPE>: if this is equal to "partial", then the
4246 * default word starts at cursor position (emacs-style).
4247 * Otherwise, the whole word is considered.
4250 { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
4253 * \var lyx::FuncCode lyx::LFUN_WRAP_INSERT
4254 * \li Action: Inserts floats wrapped by the text around.
4255 * \li Syntax: wrap-insert <TYPE>
4256 * \li Params: <TYPE>: table|figure
4257 * \li Origin: Dekel, 7 Apr 2002
4260 { LFUN_WRAP_INSERT, "wrap-insert", Noop, Edit },
4262 { LFUN_NOACTION, "", Noop, Hidden }
4263 #ifndef DOXYGEN_SHOULD_SKIP_THIS
4266 for (int i = 0; items[i].action != LFUN_NOACTION; ++i)
4267 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
4273 LyXAction::LyXAction()
4279 FuncRequest LyXAction::lookupFunc(string const & func) const
4281 string const func2 = trim(func);
4284 return FuncRequest(LFUN_NOACTION);
4287 string const arg = split(func2, cmd, ' ');
4289 FuncMap::const_iterator const fit = lyx_func_map.find(cmd);
4291 return fit != lyx_func_map.end()
4292 ? FuncRequest(fit->second, arg)
4293 : FuncRequest(LFUN_UNKNOWN_ACTION);
4297 string const LyXAction::getActionName(FuncCode action) const
4299 InfoMap::const_iterator const it = lyx_info_map.find(action);
4300 return it != lyx_info_map.end() ? it->second.name : string();
4304 LyXAction::FuncType LyXAction::getActionType(FuncCode action) const
4306 InfoMap::const_iterator const it = lyx_info_map.find(action);
4307 return it != lyx_info_map.end() ? it->second.type : Hidden;
4311 bool LyXAction::funcHasFlag(FuncCode action,
4312 LyXAction::FuncAttribs flag) const
4314 InfoMap::const_iterator ici = lyx_info_map.find(action);
4316 if (ici == lyx_info_map.end()) {
4317 LYXERR0("action: " << action << " is not known.");
4318 LASSERT(false, return false);
4321 return ici->second.attrib & flag;
4325 LyXAction::const_iterator LyXAction::func_begin() const
4327 return lyx_func_map.begin();
4331 LyXAction::const_iterator LyXAction::func_end() const
4333 return lyx_func_map.end();
4337 LyXErr & operator<<(LyXErr & l, FuncCode code)
4340 l.stream() << lyxaction.getActionName(code);