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> [force]
306 * \li Params: <argument nr>: see layout declarations
307 * force: Insert argument even if already there.
308 * \li Origin: vermeer, 12 Aug 2002
311 { LFUN_ARGUMENT_INSERT, "argument-insert", Noop, Edit },
314 * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_ADD
315 * \li Action: Adds database, which will be used for bibtex citations.
316 * \li Notion: Databases are added to the first BibTeX inset
317 (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
318 * \li Syntax: bibtex-database-add <DATABASE-NAME>
319 * \li Origin: Ale, 30 May 1997
322 { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit },
325 * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_DEL
326 * \li Action: Adds database, which will be used for bibtex citations.
327 * \li Notion: Databases are deleted from the first BibTeX inset
328 (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
329 * \li Syntax: bibtex-database-del <DATABASE-NAME>
330 * \li Origin: Ale, 30 May 1997
333 { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
337 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
338 * \li Action: Clears the list of saved bookmarks.
339 * \li Syntax: bookmark-clear
340 * \li Origin: bpeng, 31 October 2006
343 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
347 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
348 * \li Action: Moves the cursor to the numbered bookmark, opening the file
349 if necessary. Note that bookmarks are saved per-session, not
351 * \li Notion: Bookmark 0 has a special purpose. It is automatically set \n
352 1. to the paragraph you are currently editing \n
353 2. to the paragraph from where you are jumping to the last-edited
354 position (jump-back feature) \n
355 3. when jumping from crossreference to the requested label by
357 * \li Syntax: bookmark-goto <NUMBER>
358 * \li Params: <NUMBER>: the number of the bookmark to restore.
359 * \li Origin: Dekel, 27 January 2001
362 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
365 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
366 * \li Action: Save a bookmark.
367 * \li Notion: Saves a numbered bookmark to the sessions file. The number
368 must be between 1 and 9, inclusive. Note that bookmarks are
369 saved per-session, not per file.
370 * \li Syntax: bookmark-save <NUMBER>
371 * \li Params: <NUMBER>: the number of the bookmark to save.
372 * \li Origin: Dekel, 27 January 2001
375 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
378 * \var lyx::FuncCode lyx::LFUN_BOX_INSERT
379 * \li Action: Inserts Box inset.
380 * \li Syntax: box-insert [<TYPE>]
381 * \li Params: <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox \n
382 Framed is the default one.
383 * \li Origin: vermeer, 7 Oct 2003
386 { LFUN_BOX_INSERT, "box-insert", Noop, Edit },
389 * \var lyx::FuncCode lyx::LFUN_BRANCHES_RENAME
390 * \li Action: Rename all branches of a given name in a document.
391 * \li Syntax: branches-rename <OLDNAME> <NEWNAME>
392 * \li Params: <OLDNAME>: Current name of the branch to be renamed
393 * <NEWNAME>: New name of the branch
394 * \li Origin: spitz, 9 Jul 2009
397 { LFUN_BRANCHES_RENAME, "branches-rename", Noop, Buffer },
400 * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
401 * \li Action: Activate the branch.
402 * \li Syntax: branch-activate <BRANCH>
403 * \li Params: <BRANCH>: The branch to activate
404 * \li Sample: lyx -x "branch-activate answers" -e pdf2 finalexam.lyx \n
405 could be used to export a pdf with the answers branch included
406 without one's having to open LyX and activate the branch manually.
407 * \li Origin: rgh, 27 May 2008
410 { LFUN_BRANCH_ACTIVATE, "branch-activate", AtPoint, Buffer },
413 * \var lyx::FuncCode lyx::LFUN_BRANCH_ADD
414 * \li Action: Add a branch to the buffer's BranchList.
415 * \li Syntax: branch-add <BRANCH>
416 * \li Params: <BRANCH>: Name of the branch to add
417 * \li Origin: spitz, 7 Jul 2009
420 { LFUN_BRANCH_ADD, "branch-add", AtPoint, Buffer },
425 * \var lyx::FuncCode lyx::LFUN_BRANCH_ADD_INSERT
426 * \li Action: Create new branch and directly put the branch inset into
428 * \li Syntax: branch-add-insert [<NAME>]
429 * \li Params: <NAME>: Branch name. If it is not specified, you will be asked.
430 * \li Origin: sanda, 10 Jul 2009
433 { LFUN_BRANCH_ADD_INSERT, "branch-add-insert", Noop, Buffer },
438 * \var lyx::FuncCode lyx::LFUN_BRANCH_DEACTIVATE
439 * \li Action: De-activate the branch.
440 * \li Syntax: branch-deactivate <BRANCH>
441 * \li Params: <BRANCH>: The branch to deactivate
442 * \li Origin: rgh, 27 May 2008
445 { LFUN_BRANCH_DEACTIVATE, "branch-deactivate", AtPoint, Buffer },
448 * \var lyx::FuncCode lyx::LFUN_BRANCH_INSERT
449 * \li Action: Inserts branch inset.
450 * \li Syntax: branch-insert <BRANCH-NAME>
451 * \li Origin: vermeer, 17 Aug 2003
454 { LFUN_BRANCH_INSERT, "branch-insert", Noop, Edit },
457 * \var lyx::FuncCode lyx::LFUN_BRANCH_INVERT
458 * \li Action: Toggles inversion status of branch inset.
459 * \li Syntax: branch-invert
460 * \li Origin: rgheck, 12 July 2016
463 { LFUN_BRANCH_INVERT, "branch-invert", AtPoint, Buffer },
467 * \var lyx::FuncCode lyx::LFUN_BRANCH_MASTER_ACTIVATE
468 * \li Action: Activate the branch in the master buffer.
469 * \li Syntax: branch-master-activate <BRANCH>
470 * \li Params: <BRANCH>: The branch to activate
471 * \li Sample: lyx -x "branch-activate answers" -e pdf2 finalexam.lyx \n
472 could be used to export a pdf with the answers branch included
473 without one's having to open LyX and activate the branch manually.
474 * \li Origin: spitz, 30 Sep 2012
477 { LFUN_BRANCH_MASTER_ACTIVATE, "branch-master-activate", AtPoint, Buffer },
480 * \var lyx::FuncCode lyx::LFUN_BRANCH_MASTER_DEACTIVATE
481 * \li Action: De-activate the branch in the master buffer.
482 * \li Syntax: branch-master-deactivate <BRANCH>
483 * \li Params: <BRANCH>: The branch to deactivate
484 * \li Origin: spitz, 30 Sep 2012
487 { LFUN_BRANCH_MASTER_DEACTIVATE, "branch-master-deactivate", AtPoint, Buffer },
491 * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
492 * \li Action: Saves the current buffer to a temporary file.
493 * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
494 is called automatically by LyX, to "autosave" the current buffer.
495 * \li Syntax: buffer-auto-save
498 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
501 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN
502 * \li Action: Move the cursor to the beginning of the document.
503 * \li Syntax: buffer-begin
506 { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
509 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN_SELECT
510 * \li Action: Move the cursor to the beginning of the document adding the
511 traversed text to the selection.
512 * \li Syntax: buffer-begin-select
515 { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
518 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHILD_OPEN
519 * \li Action: Loads the given child document.
520 * \li Notion: The current document is treated as a parent.
521 * \li Syntax: buffer-child-open <FILE>
522 * \li Params: <FILE>: Filename of the child. The directory of the parent is assumed by default.
523 * \li Origin: Ale, 28 May 1997
526 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
529 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHKTEX
530 * \li Action: Runs chktex for the current document.
531 * \li Syntax: buffer-chktex
532 * \li Origin: Asger, 30 Oct 1997
535 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
538 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
539 * \li Action: Closes the current buffer.
540 * \li Notion: Closes the current buffer, asking whether to save it, etc,
541 if the buffer has been modified.
542 * \li Syntax: buffer-close
545 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
548 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE_ALL
549 * \li Action: Closes all buffers.
550 * \li Notion: Closes all buffers, asking whether to save it, etc,
551 if a buffer has been modified.
552 * \li Syntax: buffer-close-all
555 { LFUN_BUFFER_CLOSE_ALL, "buffer-close-all", ReadOnly, Buffer },
558 * \var lyx::FuncCode lyx::LFUN_BUFFER_END
559 * \li Action: Move the cursor to the end of the document.
560 * \li Syntax: buffer-end
563 { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
566 * \var lyx::FuncCode lyx::LFUN_BUFFER_END_SELECT
567 * \li Action: Move the cursor to the end of the document adding the
568 traversed text to the selection.
569 * \li Syntax: buffer-end-select
572 { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
576 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
577 * \li Action: Exports the current buffer (document) to the given format.
578 * \li Syntax: buffer-export [<FORMAT>] [<DEST>]
579 * \li Params: <FORMAT> is either "custom" or one of the formats which you
580 can find in Tools->Preferences->File formats->Format.
581 Usual format you will enter is "pdf2" (pdflatex),
582 "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
583 In case of "custom" you will be asked for a format you
584 want to start from and for the command that you want to
585 apply to this format. Internally the control is then passed
586 to #LFUN_BUFFER_EXPORT_CUSTOM.\n
587 If absent or "default", then the default output format of the
589 <DEST> If present, this argument provides the export destination
590 filename. Its containing folder will also be the destination
591 folder, where all the needed external files will be copied.
592 * \li Origin: Lgb, 29 Jul 1997
595 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
598 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_AS
599 * \li Action: Opens a dialog for exporting the current buffer.
600 * \li Syntax: buffer-export-as [<FORMAT>]
601 * \li Params: <FORMAT> is the export format initially selected in the dialog.
602 * You can pass any of the formats which you can find in
603 * Tools->Preferences->File formats->Format, provided it
604 * has the "document" flag set. If no format is specified
605 * the dialog will start with the default output format of
606 * the current document.
607 * \li Sample: buffer-export-as pdf2
608 * \li Origin: tommaso, 6 Oct 2011
611 { LFUN_BUFFER_EXPORT_AS, "buffer-export-as", ReadOnly, Buffer },
614 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
615 * \li Action: Exports the current buffer (document) from the given format using
616 the given command on it.
617 * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
618 * \li Params: <FORMAT> format to start from (LyX will care to produce such
619 intermediate file).\n
620 <COMMAND> this command will be launched on the file. Note that you can
621 use "$$FName" string to qualify the intermediate file.
622 * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
623 * \li Origin: leeming, 27 Mar 2004
626 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
629 * \var lyx::FuncCode lyx::LFUN_BUFFER_FORALL
630 * \li Action: Applies a command to all non-hidden buffers.
631 * \li Notion: a buffer is `hidden' if it is internally open in LyX, but not
632 visible in any window.
633 * \li Syntax: buffer-forall <LFUN-COMMAND>
634 * \li Params: <LFUN-COMMAND>: The command to be applied to the buffers.
635 * \li Sample: Close all Notes in buffers: \n
636 buffer-forall inset-forall Note inset-toggle close \n
637 Toggle change tracking on buffers: \n
638 buffer-forall changes-track \n
639 Toggle read-only for buffers: \n
640 buffer-forall buffer-toggle-read-only \n
641 Show statistics for individual buffers: \n
642 buffer-forall statistics \n
643 Activate the branch named "Solutions" in buffers: \n
644 buffer-forall branch-activate Solutions \n
645 Export buffers to PDF (pdflatex): \n
646 buffer-forall buffer-export pdf2 \n
647 * \li Origin: skostysh, 20 Jul 2012
650 { LFUN_BUFFER_FORALL, "buffer-forall", ReadOnly | Argument, Buffer },
653 * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
654 * \li Action: Import a given file as a lyx document.
655 * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
656 defined converters in preferences. Look in the File->Import menu to get
657 an idea of the currently active import formats.
658 * \li Syntax: buffer-import <FORMAT> [<FILE>]
659 * \li Origin: Asger, 24 Jul 1998
662 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
665 * \var lyx::FuncCode lyx::LFUN_BUFFER_LANGUAGE
666 * \li Action: Set language of the current document.
667 * \li Syntax: buffer-language <LANG>
668 * \li Params: <LANG>: language name. See lib/languages for list.
669 * \li Origin: leeming, 30 Mar 2004
672 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
675 * \var lyx::FuncCode lyx::LFUN_BUFFER_MOVE_NEXT
676 * \li Action: Moves the current tab one spot to the right.
677 * \li Syntax: buffer-move-next
678 * \li Origin: skostysh, 7 Apr 2015
681 { LFUN_BUFFER_MOVE_NEXT, "buffer-move-next", ReadOnly, Buffer },
684 * \var lyx::FuncCode lyx::LFUN_BUFFER_MOVE_PREVIOUS
685 * \li Action: Moves the current tab one spot to the left.
686 * \li Syntax: buffer-move-previous
687 * \li Origin: skostysh, 7 Apr 2015
690 { LFUN_BUFFER_MOVE_PREVIOUS, "buffer-move-previous", ReadOnly, Buffer },
693 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
694 * \li Action: Creates a new buffer (that is, document) and switches to it.
695 * \li Notion: Implicit path can be set in Preferences dialog.
696 * \li Syntax: buffer-new [<FILE>]
697 * \li Params: <FILE>: filename of created file with absolute path.
700 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
703 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
704 * \li Action: Creates a new buffer (that is, document) from a template.
705 * \li Notion: Path for new files and templates can be set in Preferences dialog.
706 Template will be asked for via Open-dialog.
707 * \li Syntax: buffer-new-template [<FILE>]
708 * \li Params: <FILE>: filename of created file with absolute path.
711 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
714 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEXT
715 * \li Action: Switch to the next opened document.
716 * \li Notion: Note that this does not necessarily mean next in tabbar
717 (for full list see View menu).
718 * \li Syntax: buffer-next
721 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
724 * \var lyx::FuncCode lyx::LFUN_BUFFER_PARAMS_APPLY
725 * \li Action: Apply the given settings to the current document.
726 * \li Syntax: buffer-params-apply [<ARGS>]
727 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
728 you can find in document header of usual .lyx file.
729 * \li Origin: leeming, 30 Mar 2004
732 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", NoInternal, Buffer },
736 * \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS
737 * \li Action: Switch to the previous opened document.
738 * \li Syntax: buffer-previous
741 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
744 * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
745 * \li Action: Reverts opened document.
746 * \li Syntax: buffer-reload
747 * \li Origin: Asger, 2 Feb 1997
750 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
753 * \var lyx::FuncCode lyx::LFUN_BUFFER_SAVE_AS_DEFAULT
754 * \li Action: Save the current document settings as default.
755 * \li Notion: The file will will be saved into ~/.lyx/templates/defaults.lyx .
756 * \li Syntax: buffer-save-as-default [<ARGS>]
757 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
758 you can find in document header of usual .lyx file.
759 * \li Origin: leeming, 30 Mar 2004
762 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
765 * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
766 * \li Action: Display and switch to the given buffer.
767 * \li Syntax: buffer-switch <BUFFER>
768 * \li Params: <BUFFER>: path and filename of already opened (but possibly hidden)
769 document which is to be shown.
772 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
775 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
776 * \li Action: Toggles compression of the current document on/off.
777 * \li Syntax: buffer-toggle-compression
778 * \li Origin: bpeng, 27 Apr 2006
781 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
784 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_OUTPUT_SYNC
785 * \li Action: Toggles including of resources for forward/reverse search of the given document.
786 * \li Notion: When toggled on, SyncTeX is invoked for PDF, while srcltx package
787 is used for DVI. Custom LaTeX macro can be defined in preferences.
788 * \li Syntax: buffer-toggle-output-sync
789 * \li Origin: sanda, 25 May 2010
792 { LFUN_BUFFER_TOGGLE_OUTPUT_SYNC, "buffer-toggle-output-sync", Noop, System },
795 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
796 * \li Action: Toggle editing mode of the current document between read/write and read-only.
797 * \li Notion: This function is not allowed if the file is under version control, since
798 read-only flag is often used in version control file locking.
799 * \li Syntax: buffer-toggle-read-only
800 * \li Origin: Lgb, 27 May 1997
803 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
806 * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
807 * \li Action: Exports the current document and put the result into the
809 * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
810 the output will be rewritten - updated. This is useful in case your viewer
811 is able to detect such changes (e.g. ghostview for postscript).
812 * \li Syntax: buffer-update [<FORMAT>]
813 * \li Params: <FORMAT>: The format to display, where this is one of the
814 formats defined (in the current GUI) in the
815 Tools>Preferences>File Formats dialog.
816 If no format is given, the default format as
817 specified in the same dialog is used.
818 * \li Origin: Dekel, 5 Aug 2000
821 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
825 * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
826 * \li Action: Displays current buffer in chosen format.
827 * \li Notion: Displays the contents of the current buffer in the chosen
828 format, for example, PDF or DVI. This runs the necessary
829 converter, calls the defined viewer, and so forth.
830 * \li Syntax: buffer-view [<FORMAT>]
831 * \li Params: <FORMAT>: The format to display, where this is one of the
832 formats defined (in the current GUI) in the
833 Tools>Preferences>File Formats dialog.
834 If no format is given, the default format as
835 specified in the same dialog is used.
838 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
841 * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW_CACHE
842 * \li Action: Opens the file that was created from last preview of this buffer.
843 * \li Notion: This LFUN is called by the "Show Output Anyway" button in the LaTeX
844 * Errors dialog. It can also be called by the user, which is useful
845 * if the document takes a long time to compile, and you just
846 * want to see the last previewed version.
847 * \li Syntax: buffer-view-cache
850 { LFUN_BUFFER_VIEW_CACHE, "buffer-view-cache", ReadOnly, Buffer },
853 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
854 * \li Action: Saves the current buffer.
855 * \li Notion: Saves the current buffer to disk, using the filename that
856 is already associated with the buffer, asking for one if
857 none is yet assigned.
858 * \li Syntax: buffer-write
861 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
864 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
865 * \li Action: Save all changed documents.
866 * \li Syntax: buffer-write-all
867 * \li Origin: rgh, gpothier 6 Aug 2007
870 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
873 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
874 * \li Action: Rename and save current buffer.
875 * \li Syntax: buffer-write-as <FILENAME>
876 * \li Params: <FILENAME>: New name of the buffer/file. A relative path
877 is with respect to the original location of the buffer/file.
880 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
883 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXTERNAL_MODIFICATION_CLEAR
884 * \li Action: Clear the external modification flag on the current buffer.
885 * \li Syntax: buffer-external-modification-clear
886 * \li Origin: gm, 2 March 2017
889 { LFUN_BUFFER_EXTERNAL_MODIFICATION_CLEAR,
890 "buffer-external-modification-clear", ReadOnly, Buffer },
893 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM
894 * \li Action: Sets the zoom of the screen fonts.
895 * \li Syntax: buffer-zoom [<ZOOM>]
896 * \li Params: <ZOOM>: The target zoom value in %;
897 * the default is the default zoom as saved in preferences.
898 * \li Origin: daniel, 28 Oct 2016
901 { LFUN_BUFFER_ZOOM, "buffer-zoom", ReadOnly, Buffer },
904 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_IN
905 * \li Action: Increases the zoom of the screen fonts.
906 * \li Syntax: buffer-zoom-in [<ZOOM>]
907 * \li Params: <ZOOM>: The zoom value addition in % (neg. or pos.);
908 * the default is 10% of the default zoom as saved in preferences.
909 * \li Origin: vfr, 30 Mar 2009
912 { LFUN_BUFFER_ZOOM_IN, "buffer-zoom-in", ReadOnly, Buffer },
916 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_OUT
917 * \li Action: Decreases the zoom of the screen fonts.
918 * \li Syntax: buffer-zoom-out [<ZOOM>]
919 * \li Params: <ZOOM>: The zoom value abstraction in % (neg. or pos.);
920 * the default is 10% of the default zoom as saved in preferences.
921 * \li Origin: vfr, 30 Mar 2009
924 { LFUN_BUFFER_ZOOM_OUT, "buffer-zoom-out", ReadOnly, Buffer },
928 * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
929 * \li Action: Generates the code (literate programming).
930 * \li Notion: Latex file with extension \literate_extension is generated.
931 Then LyX invokes \build_command (with a default of ``make'') to generate the code and
932 \build_error_filter to process the compilation error messages. \n
933 In case you want to process your literate file with a script, or some other program,
934 just insert in your lyxrc file an entry with:\n
935 \build_command "my_script my_arguments" \n
936 The \build_error_filter differs from the \literate_error_filter only in that the
937 former will identify error messages from your compiler.
938 * \li Syntax: build-program
941 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
945 * \var lyx::FuncCode lyx::LFUN_CALL
946 * \li Action: Executes a command defined in a .def file.
947 * \li Notion: The definitions are by default read from lib/commands/default.def.\n
948 A .def file allows to define a command with \define "<NAME>" "<LFUN>"
949 where <NAME> is the name of the new command and <LFUN> is the lfun code
950 to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
951 \def_file "FileName" allows to include another .def file. \n
952 This is particularly useful in connection with toolbar buttons:
953 Since the name of the button image for this lfun is
954 lib/images/commands/<NAME>.png this is the way to assign an image
955 to a complex command-sequence.
956 * \li Syntax: call <NAME>
957 * \li Params: <NAME>: Name of the command that must be called.
958 * \li Origin: broider, 2 Oct 2007
961 { LFUN_CALL, "call", NoBuffer, System },
964 * \var lyx::FuncCode lyx::LFUN_CANCEL
965 * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
969 { LFUN_CANCEL, "cancel", NoBuffer, System },
973 * \var lyx::FuncCode lyx::LFUN_CAPTION_INSERT
974 * \li Action: Inserts a caption inset.
975 * \li Syntax: caption-insert
976 * \li Origin: Lgb, 18 Jul 2000
979 { LFUN_CAPTION_INSERT, "caption-insert", Noop, Edit },
982 * \var lyx::FuncCode lyx::LFUN_CELL_BACKWARD
983 * \li Action: Moves the cursor to the previous cell inside the table.
984 * \li Syntax: cell-backward
985 * \li Origin: Jug, 22 May 2000
988 { LFUN_CELL_BACKWARD, "cell-backward", ReadOnly | NoUpdate, Edit },
991 * \var lyx::FuncCode lyx::LFUN_CELL_FORWARD
992 * \li Action: Moves the cursor to the next cell inside the table.
993 * \li Syntax: cell-forward
996 { LFUN_CELL_FORWARD, "cell-forward", ReadOnly | NoUpdate, Edit },
999 * \var lyx::FuncCode lyx::LFUN_CELL_SPLIT
1000 * \li Action: Splits cell and shifts right part to the next cell (inside the math grid).
1001 * \li Syntax: cell-split
1002 * \li Origin: Ale, 15 May 1997
1005 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
1009 * \var lyx::FuncCode lyx::LFUN_CHANGES_MERGE
1010 * \li Action: Open change tracking dialog for merging and moves the cursor
1011 to the position of the next change.
1012 * \li Syntax: changes-merge
1013 * \li Origin: Levon, 16 Oct 2002
1016 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
1019 * \var lyx::FuncCode lyx::LFUN_CHANGES_OUTPUT
1020 * \li Action: Toggles showing of change tracking in typeset output.
1021 * \li Syntax: changes-output
1022 * \li Origin: jspitzm, 21 Jan 2005
1025 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
1028 * \var lyx::FuncCode lyx::LFUN_CHANGES_TRACK
1029 * \li Action: Toggles change tracking to on/off.
1030 * \li Syntax: changes-track
1031 * \li Origin: levon, 1 Oct 2002
1034 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
1037 * \var lyx::FuncCode lyx::LFUN_CHANGE_ACCEPT
1038 * \li Action: Accepts tracked change inside the selection.
1039 * \li Syntax: change-accept
1040 * \li Origin: Levon, 16 Oct 2002
1043 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
1046 * \var lyx::FuncCode lyx::LFUN_CHANGE_NEXT
1047 * \li Action: Moves the cursor to the position of the next change
1048 of the change tracking records.
1049 * \li Syntax: change-next
1050 * \li Origin: schmitt, 4 Oct 2006
1053 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
1056 * \var lyx::FuncCode lyx::LFUN_CHANGE_PREVIOUS
1057 * \li Action: Moves the cursor to the position of the previous change
1058 of the change tracking records.
1059 * \li Syntax: change-previous
1060 * \li Origin: vfr, 4 Apr 2009
1063 { LFUN_CHANGE_PREVIOUS, "change-previous", ReadOnly, Edit },
1066 * \var lyx::FuncCode lyx::LFUN_CHANGE_REJECT
1067 * \li Action: Rejects tracked change inside the selection.
1068 * \li Syntax: change-reject
1069 * \li Origin: Levon, 16 Oct 2002
1072 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
1075 * \var lyx::FuncCode lyx::LFUN_CHARS_TRANSPOSE
1076 * \li Action: Transposes the character at the cursor with the one before it.
1077 * \li Syntax: chars-transpose
1078 * \li Origin: Lgb, 25 Apr 2001
1081 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
1085 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD
1086 * \li Action: Moves the cursor one position logically backwards.
1087 * \li Notion: This is not the action which should be bound to the arrow keys,
1088 because backwards may be left or right, depending on the
1089 language. The arrow keys should be bound to #LFUN_CHAR_LEFT or
1090 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
1091 * \li Syntax: char-backward
1094 { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit },
1097 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD_SELECT
1098 * \li Action: Moves the cursor one position logically backwards, adding
1099 traversed position to the selection.
1100 * \li Notion: See also #LFUN_CHAR_BACKWARD.
1101 * \li Syntax: char-backward-select
1104 { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit },
1107 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_BACKWARD
1108 * \li Action: Deletes one character in the backward direction (usually the "BackSpace" key).
1109 * \li Syntax: char-delete-backward [force]
1110 * \li Params: force: Delete big insets, do not only select them.
1113 { LFUN_CHAR_DELETE_BACKWARD, "char-delete-backward", SingleParUpdate, Edit },
1116 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_FORWARD
1117 * \li Action: Deletes one character in the backward direction (usually the "Delete" key).
1118 * \li Syntax: char-delete-forward [force]
1119 * \li Params: force: Delete big insets, do not only select them.
1122 { LFUN_CHAR_DELETE_FORWARD, "char-delete-forward", SingleParUpdate, Edit },
1125 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD
1126 * \li Action: Moves the cursor one position logically forward.
1127 * \li Notion: This is not the action which should be bound to the arrow keys,
1128 because forward may be left or right, depending on the language.
1129 The arrow keys should be bound to #LFUN_CHAR_LEFT or
1130 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
1131 * \li Syntax: char-forward
1134 { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit },
1137 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD_SELECT
1138 * \li Action: Moves the cursor one position logically forward, adding
1139 traversed position to the selection.
1140 * \li Notion: See also #LFUN_CHAR_FORWARD.
1141 * \li Syntax: char-forward-select
1144 { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit },
1147 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT
1148 * \li Action: Moves the cursor one position "to the left".
1149 * \li Notion: This is the action which should be taken when the "left" key
1150 is pressed. Generally, it moves the cursor one position to the
1151 left. However, in Bidi text this become slightly more
1152 complicated, and there are different modes of cursor movement.
1153 In "visual mode", this moves left, plain and simple. In "logical
1154 mode", movement is logically forward in RTL paragraphs, and
1155 logically backwards in LTR paragraphs.
1156 * \li Syntax: char-left
1159 { LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit },
1162 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT_SELECT
1163 * \li Action: Moves the cursor one position "to the left", adding
1164 traversed position to the selection.
1165 * \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement.
1166 * \li Syntax: char-left-select
1169 { LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit },
1172 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT
1173 * \li Action: Moves the cursor one position "to the right".
1174 * \li Notion: This is the action which should be taken when the "right" key
1175 is pressed. Generally, it moves the cursor one position to the
1176 right. However, in Bidi text this become slightly more
1177 complicated, and there are different modes of cursor movement.
1178 In "visual mode", this moves right, plain and simple. In "logical
1179 mode", movement is logically forward in LTR paragraphs, and
1180 logically backwards in RTL paragraphs.
1181 * \li Syntax: char-right
1184 { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit },
1187 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT_SELECT
1188 * \li Action: Moves the cursor one position "to the right", adding
1189 traversed position to the selection.
1190 * \li Notion: See also #LFUN_CHAR_RIGHT for exact details of the movement.
1191 * \li Syntax: char-right-select
1194 { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit },
1198 * \var lyx::FuncCode lyx::LFUN_CITATION_INSERT
1199 * \li Action: Inserts citation from loaded citation database.
1200 * \li Syntax: citation-insert [<KEY>[|<TEXT_BEFORE>]]
1201 * \li Params: <KEY>: Citation (shortcut listed in available citations). \n
1202 <TEXT_BEFORE>: text which should appear before citation.
1203 * \li Origin: AAS, 97-02-23
1206 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
1209 * \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE
1210 * \li Action: Pastes text from the active clipboard (retains formatting if the
1211 clipboard contains formatted text). Pastes plain text if plain text is
1212 on the clipboard, but tries to interpret it in special ways for certain
1213 insets, e.g. converting csv data to rows and columns if the paste happens
1215 * \li Notion: Historically, LFUN_CLIPBOARD_PASTE was introduced as a counterpart of
1216 LFUN_PRIMARY_SELECTION_PASTE: It behaved exactly the same, but the source
1217 is the clipboard, not the selection.
1218 * \li Syntax: clipboard-paste [<ARG>]
1219 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1220 * \li Origin: Georg, 10 Jul 2006
1223 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
1226 * \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE_SIMPLE
1227 * \li Action: Pastes plain text from the active clipboard even if formatted
1228 LyX content is in the clipboard. Pastes plain text if plain text
1229 is on the clipboard, without trying to interpret it in special
1230 ways for certain insets, e.g. converting csv data to rows and
1231 columns if the paste happens in a tabular inset.
1232 * \li Syntax: clipboard-paste-simple [<ARG>]
1233 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1236 { LFUN_CLIPBOARD_PASTE_SIMPLE, "clipboard-paste-simple", Noop, Edit },
1239 * \var lyx::FuncCode lyx::LFUN_COMMAND_ALTERNATIVES
1240 * \li Action: Runs the first listed command that is enabled.
1241 * \li Notion: This can be used to bind multiple functions to a single key,
1242 and then which one is used will depend upon the context.
1243 * \li Syntax: command-alternatives <CMDS>
1244 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
1245 * \li Sample: command-alternatives completion-accept;cell-forward
1246 * \li Origin: rgh, 24 September 2008
1249 { LFUN_COMMAND_ALTERNATIVES, "command-alternatives", NoBuffer, System },
1252 * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
1253 * \li Action: Switches the focus to the minibuffer so that the user can type
1254 in there. If necessary, it opens the minibuffer toolbar.
1255 * \li Notion: Usually bound to M-x shortcut.
1256 * \li Syntax: command-execute
1259 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
1263 * \var lyx::FuncCode lyx::LFUN_COMMAND_PREFIX
1264 * \li Action: Return the current key sequence and available options as a string.
1265 * \li Notion: No options are added if no current map exists. \n
1266 This is probably usable only with connection to lyxserver.
1267 * \li Syntax: command-prefix
1270 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
1273 * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
1274 * \li Action: Run more commands (LFUN and its parameters) in a sequence.
1275 * \li Syntax: command-sequence <CMDS>
1276 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
1277 * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
1278 * \li Origin: Andre, 11 Nov 1999
1281 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
1284 * \var lyx::FuncCode lyx::LFUN_COMPLETE
1285 * \li Action: Try to complete the word or command at the cursor position.
1286 * \li Syntax: complete
1287 * \li Origin: sts, Feb 19 2008
1290 { LFUN_COMPLETE, "complete", SingleParUpdate, Edit },
1294 * \var lyx::FuncCode lyx::LFUN_COMPLETION_ACCEPT
1295 * \li Action: Accept suggested completion.
1296 * \li Syntax: completion-accept
1297 * \li Origin: sanda, Sep 08 2008
1300 { LFUN_COMPLETION_ACCEPT, "completion-accept", SingleParUpdate, Edit },
1305 * \var lyx::FuncCode lyx::LFUN_COMPLETION_CANCEL
1306 * \li Action: Try to cancel completion, either the popup or the inline completion.
1307 * \li Syntax: completion-cancel
1308 * \li Origin: sts, Sep 07 2008
1311 { LFUN_COMPLETION_CANCEL, "completion-cancel", SingleParUpdate, Edit },
1314 * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
1315 * \li Action: Show the inline completion at the cursor position.
1316 * \li Syntax: completion-inline
1317 * \li Origin: sts, Feb 19 2008
1320 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
1323 * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
1324 * \li Action: Show the completion popup at the cursor position.
1325 * \li Syntax: completion-popup
1326 * \li Origin: sts, Feb 19 2008
1329 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
1332 * \var lyx::FuncCode lyx::LFUN_COPY
1333 * \li Action: Copies the current selection to the clipboard.
1337 { LFUN_COPY, "copy", ReadOnly, Edit },
1340 * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
1341 * \li Action: Determine whether to keep cursor inside the editing window regardless
1342 of the scrollbar movement.
1343 * \li Syntax: toggle-cursor-follows-scrollbar
1344 * \li Origin: ARRae, 2 Dec 1997
1347 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
1350 * \var lyx::FuncCode lyx::LFUN_CUT
1351 * \li Action: Cuts to the clipboard.
1355 { LFUN_CUT, "cut", Noop, Edit },
1358 * \var lyx::FuncCode lyx::LFUN_DATE_INSERT
1359 * \li Action: Inserts the current date.
1360 * \li Syntax: date-insert [<ARG>]
1361 * \li Params: <ARG>: Format of date. The default value (%x) can be set
1362 in Preferences->Date format. For possible formats
1363 see manual page of strftime function.
1364 * \li Origin: jdblair, 31 Jan 2000
1367 { LFUN_DATE_INSERT, "date-insert", Noop, Edit },
1370 * \var lyx::FuncCode lyx::LFUN_DEBUG_LEVEL_SET
1371 * \li Action: Set debug output level.
1372 * \li Syntax: debug-level-set <LEVEL>
1373 * \li Params: <LEVEL>: comma separated list of levels or the correspondent number
1374 of their combination. 0 is equivalent to disabling all debug
1375 events. See lyx -dbg for the current list of debug levels
1377 * \li Origin: sanda, 28 Dec 2009
1380 { LFUN_DEBUG_LEVEL_SET, "debug-level-set", NoBuffer, System },
1384 * \var lyx::FuncCode lyx::LFUN_DEPTH_DECREMENT
1385 * \li Action: Decrease the nesting depth of the (selected) paragraph(s)
1387 * \li Syntax: depth-decrement
1390 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
1393 * \var lyx::FuncCode lyx::LFUN_DEPTH_INCREMENT
1394 * \li Action: Increase the nesting depth of the (selected) paragraph(s)
1396 * \li Syntax: depth-increment
1399 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
1403 * \var lyx::FuncCode lyx::LFUN_DEVEL_MODE_TOGGLE
1404 * \li Action: toggle a mode where more information is given in UI
1405 * \li Syntax: devel-mode-toggle
1406 * \li Notion: in so called "devel" mode, the information given in the
1407 * status bar is more precise, and the help documents are
1408 * open in editing mode.
1409 * \li Origin: lasgouttes, 23 Jul 2017
1412 { LFUN_DEVEL_MODE_TOGGLE, "devel-mode-toggle", NoBuffer, System },
1416 * \var lyx::FuncCode lyx::LFUN_DIALOG_DISCONNECT_INSET
1417 * \li Action: Closes opened connection to opened inset.
1418 * \li Notion: Connection is used for apply functions.
1419 * \li Syntax: dialog-disconnect-inset <INSET-NAME>
1420 * \li Origin: leeming, 25 Feb 2003
1423 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
1427 * \var lyx::FuncCode lyx::LFUN_DIALOG_HIDE
1428 * \li Action: Hides showed dialog. Counterpart to #LFUN_DIALOG_SHOW .
1429 * \li Syntax: dialog-hide <NAME>
1430 * \li Params: See #LFUN_DIALOG_SHOW .
1431 * \li Origin: leeming, 25 Feb 2003
1434 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
1437 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW
1438 * \li Action: Shows hidden dialog or creates new one for a given function/inset settings etc.
1439 * \li Syntax: dialog-show <NAME> [<DATA>]
1440 * \li Params: <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|\n
1441 compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|\n
1442 graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimiter|\n
1443 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|\n
1444 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|\n
1445 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL> \n
1446 <SPECIAL>: latexlog|vclog \n
1447 <DATA>: data, usually settings for the given dialog. Use debug mode for the
1449 * \li Origin: leeming, 17 Jun 2003
1452 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
1455 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW_NEW_INSET
1456 * \li Action: Shows hidden dialog or create new one for a given inset settings etc.
1457 * \li Notion: Internally uses #LFUN_DIALOG_SHOW with processed data for a given inset.
1458 * \li Syntax: dialog-show-new-inset <NAME> [<DATA>]
1459 * \li Params: See #LFUN_DIALOG_SHOW .
1460 * \li Origin: leeming, 25 Feb 2003
1463 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
1466 * \var lyx::FuncCode lyx::LFUN_DIALOG_TOGGLE
1467 * \li Action: Toggles dialog between showed/hidden state.
1468 * \li Notion: Internally uses #LFUN_DIALOG_SHOW , #LFUN_DIALOG_HIDE .
1469 * \li Syntax: dialog-toggle <NAME> [<DATA>]
1470 * \li Params: See #LFUN_DIALOG_SHOW .
1471 * \li Origin: JSpitzm, 30 Apr 2007
1474 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
1477 * \var lyx::FuncCode lyx::LFUN_DIALOG_UPDATE
1478 * \li Action: Updates the dialog values from the inset/paragraph/document.
1479 * \li Syntax: dialog-update <NAME>
1480 * \li Params: <NAME>: paragraph|prefs|<INSET> \n
1482 * \li Origin: leeming, 25 Feb 2003
1485 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
1488 * \var lyx::FuncCode lyx::LFUN_DOWN
1489 * \li Action: Moves the cursor one line in downward direction.
1493 { LFUN_DOWN, "down", ReadOnly | NoUpdate, Edit },
1496 * \var lyx::FuncCode lyx::LFUN_DOWN_SELECT
1497 * \li Action: Moves the cursor one line in downward direction adding the current
1498 position to the selection.
1499 * \li Syntax: down-select
1502 { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, Edit },
1505 * \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE
1506 * \li Action: Displays list of layout choices.
1507 * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
1508 dropbox allowing for choice of layout.
1509 * \li Syntax: drop-layouts-choice
1512 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
1515 * \var lyx::FuncCode lyx::LFUN_ENVIRONMENT_SPLIT
1516 * \li Action: Splits the current environment with a Separator.
1517 * \li Syntax: environment-split [outer|previous]
1518 * \li Params: outer: If this is given, LyX will split the outermost environment in
1519 the current nesting hierarchy.
1520 previous: If this is given, LyX will split the environment in the previous
1521 paragraph (is there is one).
1522 before: If this is given, the new environment will be appended rather than
1524 * \li Origin: spitz, 23 Dec 2012
1527 { LFUN_ENVIRONMENT_SPLIT, "environment-split", Noop, Layout },
1531 * \var lyx::FuncCode lyx::LFUN_ERT_INSERT
1532 * \li Action: Inserts an ERT inset.
1533 * \li Syntax: ert-insert
1534 * \li Origin: Jug, 18 Feb 2000
1537 { LFUN_ERT_INSERT, "ert-insert", Noop, Edit },
1540 * \var lyx::FuncCode lyx::LFUN_ESCAPE
1541 * \li Action: Clears the selection. If no text is selected call #LFUN_FINISHED_FORWARD.
1542 Inside math mode jumps out of the math inset.
1543 * \li Syntax: escape
1544 * \li Origin: Lgb, 17 May 2001
1547 { LFUN_ESCAPE, "escape", ReadOnly, Edit },
1550 * \var lyx::FuncCode lyx::LFUN_EXPORT_CANCEL
1551 * \li Action: Cancel background export process.
1552 * \li Syntax: export-cancel
1553 * \li Origin: rgh, 10 December 2017
1556 { LFUN_EXPORT_CANCEL, "export-cancel", ReadOnly | NoUpdate | NoInternal, Edit },
1559 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
1560 * \li Action: Inserts another LyX file.
1561 * \li Syntax: file-insert [<FILE>]
1562 * \li Params: <FILE>: Filename to be inserted.
1565 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
1568 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
1569 * \li Action: Inserts plain text file.
1570 * \li Syntax: file-insert-plaintext [<FILE>]
1571 * \li Params: <FILE>: Filename to be inserted.
1572 * \li Origin: CFO-G, 19 Nov 1997
1575 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
1578 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
1579 * \li Action: Inserts plain text file as paragraph (i.e. join lines).
1580 * \li Syntax: file-insert-plaintext-para [<FILE>]
1581 * \li Params: <FILE>: Filename to be inserted.
1582 * \li Origin: Levon, 14 Feb 2001
1585 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
1588 * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
1589 * \li Action: Open LyX document.
1590 * \li Syntax: file-open [<FILE>]
1591 * \li Params: <FILE>: Filename to be opened.
1594 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
1598 * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
1599 * \li Action: Moves the cursor out of the current slice, going backwards.
1600 * \li Notion: See also #LFUN_FINISHED_FORWARD.
1603 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
1606 * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
1607 * \li Action: Moves the cursor out of the current slice, going forward.
1608 * \li Notion: Cursor movement within an inset may be different than cursor
1609 movement in the surrounding text. This action should be called
1610 automatically by the cursor movement within the inset, when
1611 movement within the inset has ceased (reached the end of the
1612 last paragraph, for example), in order to move correctly
1613 back into the surrounding text.
1616 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
1619 * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
1620 * \li Action: Moves the cursor out of the current slice, going left.
1621 * \li Notion: See also #LFUN_FINISHED_FORWARD.
1624 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
1628 * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
1629 * \li Action: Moves the cursor out of the current slice, going right.
1630 * \li Notion: See also #LFUN_FINISHED_FORWARD
1633 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
1636 * \var lyx::FuncCode lyx::LFUN_FLEX_INSERT
1637 * \li Action: Inserts CharStyle, Custom inset or XML short element.
1638 * \li Notion: Look into the Customization manual for more information about
1640 To make this command enabled the layout file for the document
1641 class you're using has to load the character styles. There are
1642 a few contained in the Logical Markup module. You can also of
1643 course create some yourself. \n
1644 For dissolving the element see #LFUN_INSET_DISSOLVE.
1645 * \li Syntax: flex-insert Name
1646 * \li Params: Name: This name must be defined either in your layout file
1647 or imported by some module. The definition is
1648 InsetLayout Name or InsetLayout <Flex:Name>. The Flex:
1650 * \li Sample: flex-insert Code
1653 { LFUN_FLEX_INSERT, "flex-insert", Noop, Edit },
1656 * \var lyx::FuncCode lyx::LFUN_FLOAT_INSERT
1657 * \li Action: Inserts a float inset.
1658 * \li Syntax: float-insert <TYPE>
1659 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
1660 "algorithm", "table", "figure" parameters can be given.
1661 * \li Origin: Lgb, 27 Jun 2000
1664 { LFUN_FLOAT_INSERT, "float-insert", Noop, Edit },
1667 * \var lyx::FuncCode lyx::LFUN_FLOAT_LIST_INSERT
1668 * \li Action: Inserts the list of floats in the document.
1669 * \li Syntax: float-list-insert <TYPE>
1670 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
1671 "algorithm", "table", "figure" parameters can be given.
1672 * \li Origin: Lgb, 3 May 2001
1675 { LFUN_FLOAT_LIST_INSERT, "float-list-insert", Noop, Edit },
1678 * \var lyx::FuncCode lyx::LFUN_FLOAT_WIDE_INSERT
1679 * \li Action: Inserts float insets as in #LFUN_FLOAT_INSERT but span multiple columns.
1680 * \li Notion: Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
1681 * \li Syntax: float-wide-insert <TYPE>
1682 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
1683 "algorithm", "table", "figure" parameters can be given.
1684 * \li Origin: Lgb, 31 Oct 2001
1687 { LFUN_FLOAT_WIDE_INSERT, "float-wide-insert", Noop, Edit },
1690 * \var lyx::FuncCode lyx::LFUN_FONT_BOLD
1691 * \li Action: Toggles the bold font (selection-wise) using mathbf in math.
1692 * \li Syntax: font-bold
1695 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
1699 * \var lyx::FuncCode lyx::LFUN_FONT_BOLDSYMBOL
1700 * \li Action: Toggles the bold font (selection-wise) using boldsymbol in math.
1701 * \li Syntax: font-boldsymbol
1704 { LFUN_FONT_BOLDSYMBOL, "font-boldsymbol", Noop, Layout },
1707 * \var lyx::FuncCode lyx::LFUN_FONT_DEFAULT
1708 * \li Action: Reverts the settings of the font to the default values (selection-wise).
1709 * \li Syntax: font-default
1712 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
1715 * \var lyx::FuncCode lyx::LFUN_FONT_EMPH
1716 * \li Action: Toggles the emphasis font style (selection-wise).
1717 * \li Syntax: font-emph
1720 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
1723 * \var lyx::FuncCode lyx::LFUN_FONT_FRAK
1724 * \li Action: Toggles Fraktur family font (math-mode, selection-wise).
1725 * \li Syntax: font-frak
1726 * \li Origin: vermeer, 10 Jan 2002
1729 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
1732 * \var lyx::FuncCode lyx::LFUN_FONT_ITAL
1733 * \li Action: Toggles Italics font shape (math-mode, selection-wise).
1734 * \li Syntax: font-ital
1735 * \li Origin: vermeer, 10 Jan 2002
1738 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
1741 * \var lyx::FuncCode lyx::LFUN_FONT_NOUN
1742 * \li Action: Toggles Noun text style font (selection-wise).
1743 * \li Syntax: font-noun
1746 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
1749 * \var lyx::FuncCode lyx::LFUN_FONT_ROMAN
1750 * \li Action: Toggles Roman family font (selection-wise).
1751 * \li Syntax: font-roman
1754 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
1757 * \var lyx::FuncCode lyx::LFUN_FONT_SANS
1758 * \li Action: Toggles Sans Serif family font (selection-wise).
1759 * \li Syntax: font-sans
1762 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
1765 * \var lyx::FuncCode lyx::LFUN_FONT_SIZE
1766 * \li Action: Sets font size according to lyx format string.
1767 * \li Syntax: font-size <SIZE>
1768 * \li Params: <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|\n
1769 largest|huge|giant|increase|decrease|default
1772 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
1775 * \var lyx::FuncCode lyx::LFUN_FONT_STATE
1776 * \li Action: Returns the info about the current font.
1777 * \li Syntax: font-state
1780 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
1784 * \var lyx::FuncCode lyx::LFUN_FONT_STRIKEOUT
1785 * \li Action: Toggles strikeout (strike-through) in the font (selection-wise).
1786 * \li Syntax: font-strikeout
1787 * \li Origin: sanda, 3 May 2009
1790 { LFUN_FONT_STRIKEOUT, "font-strikeout", Noop, Layout },
1793 * \var lyx::FuncCode lyx::LFUN_FONT_CROSSOUT
1794 * \li Action: Toggles xout (cross-through) in the font (selection-wise).
1795 * \li Syntax: font-crossout
1796 * \li Origin: uwestoehr, 4 April 2017
1799 { LFUN_FONT_CROSSOUT, "font-crossout", Noop, Layout },
1802 * \var lyx::FuncCode lyx::LFUN_FONT_TYPEWRITER
1803 * \li Action: Toggles the typewriter family font (selection-wise).
1804 * \li Syntax: font-typewriter
1807 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
1810 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERLINE
1811 * \li Action: Toggles underline in the font (selection-wise).
1812 * \li Syntax: font-underline
1815 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
1818 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERUNDERLINE
1819 * \li Action: Toggles double underline in the font (selection-wise).
1820 * \li Syntax: font-underunderline
1821 * \li Origin: sanda, 5 May 2009
1824 { LFUN_FONT_UNDERUNDERLINE, "font-underunderline", Noop, Layout },
1827 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERWAVE
1828 * \li Action: Toggles wavy underline in the font (selection-wise).
1829 * \li Syntax: font-underwave
1830 * \li Origin: sanda, 5 May 2009
1833 { LFUN_FONT_UNDERWAVE, "font-underwave", Noop, Layout },
1836 * \var lyx::FuncCode lyx::LFUN_FOOTNOTE_INSERT
1837 * \li Action: Inserts a footnote inset.
1838 * \li Syntax: footnote-insert
1839 * \li Origin: Jug, 7 Mar 2000
1842 { LFUN_FOOTNOTE_INSERT, "footnote-insert", Noop, Edit },
1845 * \var lyx::FuncCode lyx::LFUN_FORWARD_SEARCH
1846 * \li Action: Sets the cursor position in the previewed (dvi/pdf) file based on the row
1847 number in LyX window.
1848 * \li Notion: The external program used for forward search call can be specified in
1849 LyX Output preferences. See Additional manual for details of these
1851 * \li Syntax: forward-search
1852 * \li Origin: sanda, 14 Apr 2010
1855 { LFUN_FORWARD_SEARCH, "forward-search", ReadOnly, System },
1858 * \var lyx::FuncCode lyx::LFUN_GRAPHICS_RELOAD
1859 * \li Action: Reloads the image if necessary.
1860 * \li Syntax: graphics-reload
1861 * \li Origin: vfr, 10 Aug 2009
1864 { LFUN_GRAPHICS_RELOAD, "graphics-reload", ReadOnly | AtPoint, Edit },
1867 * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
1868 * \li Action: Open the given help file according to the language setting.
1869 * \li Syntax: help-open <FILE>[.lyx]
1870 * \li Params: <FILE>: any document from (/usr/share/)doc directory.
1871 * \li Origin: Jug, 27 Jun 1999
1874 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
1877 * \var lyx::FuncCode lyx::LFUN_HREF_INSERT
1878 * \li Action: Inserts hyperlinks into the document (clickable in pdf output).
1879 * \li Notion: Hyperlink target can be set via selection + hyperlink-insert function.
1880 * \li Syntax: href-insert [<TARGET>]
1881 * \li Origin: CFO-G, 21 Nov 1997
1884 { LFUN_HREF_INSERT, "href-insert", Noop, Edit },
1887 * \var lyx::FuncCode lyx::LFUN_ICON_SIZE
1888 * \li Action: Sets icon size of toolbars.
1889 * \li Syntax: icon-size [<SIZE>]
1890 * \li Params: <SIZE> : the icon size in px or one of the logical settings
1891 small|normal|big|huge|giant, the default is normal
1892 (whose size in px is icon set dependent).
1893 * \li Origin: 11 July 2016
1896 { LFUN_ICON_SIZE, "icon-size", NoBuffer, Buffer },
1899 * \var lyx::FuncCode lyx::LFUN_INDEX_INSERT
1900 * \li Action: Inserts Index entry.
1901 * \li Notion: It automatically takes the word on the cursor position.
1902 * \li Syntax: index-insert [<TYPE:Name>]
1903 * \li Params: <TYPE:Name>: name of the index, if multiple indices are defined.
1904 With an empty argument, the default index is selected.
1905 * \li Origin: leeming, 3 Aug 2000
1908 { LFUN_INDEX_INSERT, "index-insert", Noop, Edit },
1911 * \var lyx::FuncCode lyx::LFUN_INDEX_PRINT
1912 * \li Action: Inserts list of Index entries on a new page.
1913 * \li Syntax: index-print [<TYPE:Name>]
1914 * \li Params: <TYPE:Name>: name of the index, if multiple indices are defined.
1915 With an empty argument, the default index is selected.
1916 * \li Origin: Lgb, 27 Feb 1997
1919 { LFUN_INDEX_PRINT, "index-print", Noop, Edit },
1922 * \var lyx::FuncCode lyx::LFUN_INFO_INSERT
1923 * \li Action: Displays shortcuts, lyxrc, package and textclass availability and menu
1924 information in a non-editable boxed InsetText.
1925 * \li Notion: Apart from lfun arguments you can use the following method: \n
1926 1. input the type and argument of this inset, e.g. "menu paste", in
1928 2. select the text and run info-insert lfun.
1929 * \li Syntax: info-insert <TYPE> <ARG>
1930 * \li Params: <TYPE>: shortcut[s]|lyxrc|lyxinfo|package|textclass|menu|icon|buffer \n
1931 <ARG>: argument for a given type. Look into InsetInfo.h for detailed
1933 shortcut[s]: name of lfun (e.g math-insert \alpha) \n
1934 lyxrc: name of rc_entry (e.g. bind_file) \n
1935 lyxinfo: "version" - used version of LyX \n
1936 package: name of latex package (e.g. listings) \n
1937 textclass: name of textclass (e.g. article) \n
1938 menu: name of lfun used in menu \n
1939 icon: icon of lfun used in toolbar or direct icon name\n
1940 buffer: "name"|"path"|"class"|"vcs-tree-revision"|
1941 "vcs-revision"|"vcs-author"|"vcs-date"|"vcs-time"
1942 * \li Sample: command-sequence info-insert buffer path; info-insert buffer name
1943 * \li Origin: bpeng, 7 Oct 2007
1946 { LFUN_INFO_INSERT, "info-insert", Noop, Edit },
1949 * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
1950 * \li Action: Apply data for an inset.
1951 * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
1952 be applied. This is either changed to #LFUN_INSET_MODIFY or
1953 #LFUN_INSET_INSERT depending on the context where it is called.
1954 * \li Syntax: inset-apply <ARGS>
1955 * \li Params: See #LFUN_INSET_INSERT .
1958 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
1961 * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN
1962 * \li Action: Move the cursor to the beginning of the current inset
1963 if it is not already there, or at the beginning of the
1964 enclosing inset otherwise
1965 * \li Syntax: inset-begin
1966 * \li Origin: lasgouttes, 16 Mar 2009
1969 { LFUN_INSET_BEGIN, "inset-begin", ReadOnly, Edit },
1972 * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN_SELECT
1973 * \li Action: Move the cursor to the beginning of the current inset
1974 if it is not already there, or at the beginning of the
1975 enclosing inset otherwise (adding the
1976 traversed text to the selection).
1977 * \li Syntax: inset-begin-select
1978 * \li Origin: lasgouttes, 16 Mar 2009
1981 { LFUN_INSET_BEGIN_SELECT, "inset-begin-select", ReadOnly, Edit },
1984 * \var lyx::FuncCode lyx::LFUN_INSET_COPY_AS
1985 * \li Action: Copies the inset to the clipboard as a certain type.
1986 * \li Notion: Currently used only for InsetInfo where its content is copied as a text.
1987 * \li Syntax: inset-copy-as
1988 * \li Origin: vfr, 18 Apr 2010
1991 { LFUN_INSET_COPY_AS, "inset-copy-as", ReadOnly | NoUpdate | AtPoint, Edit },
1995 * \var lyx::FuncCode lyx::LFUN_INSET_DIALOG_UPDATE
1996 * \li Action: Updates the values inside the dialog from the inset.
1997 * \li Notion: This is an internal LFUN, not to be used by users. Called internally
1998 by #LFUN_DIALOG_UPDATE
1999 * \li Params: <DIALOG-NAME>
2000 * \li Origin: leeming, 25 Feb 2003
2003 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
2006 * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE
2007 * \li Action: Dissolve the current inset into text.
2008 * \li Syntax: inset-dissolve [<INSET>]
2009 * \li Params: <INSET>: this can be used to make sure the right kind of inset
2010 is dissolved. For example "dissolve" entry in the charstyles
2011 sub-menu should only dissolve the charstyle inset, even if the
2012 cursor is inside several nested insets of different type.\n
2013 For values see #lyx::InsetLayout::lyxtype_ .
2014 * \li Origin: JSpitz, 7 Aug 2006
2017 { LFUN_INSET_DISSOLVE, "inset-dissolve", AtPoint, Edit },
2020 * \var lyx::FuncCode lyx::LFUN_INSET_EDIT
2021 * \li Action: Edit the inset at cursor with an external application,
2022 if one is attributed.
2023 * \li Syntax: inset-edit [<INSET_PARAMS>]
2024 * \li Params: <INSET_PARAMS>: Parameters for the inset. \n
2025 Currently only the filename will be considered.
2026 * \li Origin: JSpitzm, 27 Apr 2006
2029 { LFUN_INSET_EDIT, "inset-edit", ReadOnly | AtPoint, Edit },
2033 * \var lyx::FuncCode lyx::LFUN_INSET_END
2034 * \li Action: Move the cursor to the end of the current inset
2035 if it is not already there, or at the end of the
2036 enclosing inset otherwise
2037 * \li Syntax: inset-end
2038 * \li Origin: lasgouttes, 16 Mar 2009
2041 { LFUN_INSET_END, "inset-end", ReadOnly, Edit },
2044 * \var lyx::FuncCode lyx::LFUN_INSET_END_SELECT
2045 * \li Action: Move the cursor to the end of the current inset
2046 if it is not already there, or at the end of the
2047 enclosing inset otherwise (adding the
2048 traversed text to the selection).
2049 * \li Syntax: inset-end-select
2050 * \li Origin: lasgouttes, 16 Mar 2009
2053 { LFUN_INSET_END_SELECT, "inset-end-select", ReadOnly, Edit },
2057 * \var lyx::FuncCode lyx::LFUN_INSET_FORALL
2058 * \li Action: Apply the given commands on insets of a given name.
2059 * \li Notion: WARNING: use at your own risks; this function gives
2060 you too many ways of shooting yourself in the foot.
2061 A typical example is
2062 inset-forall Note note-insert
2063 which starts an infinite loop. This is mitigated by the fact
2064 that the number of actions is arbitrarily limited to 100000.
2065 Note also that inset-forall does not update metrics between
2066 iterations, which can lead to bugs. This has to be eventually
2068 * \li Syntax: inset-forall <NAME> <LFUN-COMMAND> \n
2069 <NAME>: Type of Inset. If <NAME> is *, all insets are matched.
2070 The name is used like for InsetLayout in layout files: "Note"
2071 matches all note insets, while "Note:Note" only matches LyX
2073 * \li Sample: Remove all index insets: \n
2074 inset-forall Index char-delete-forward force \n
2075 Close all Notes (also works for a particular branch, for example): \n
2076 inset-forall Note inset-toggle close \n
2077 Transform all yellow notes to comments \n
2078 inset-forall Note:Note inset-modify note Note Comment \n
2079 Try to put LyX in an infinite loop if there is at least a Note: \n
2080 inset-forall Note char-backward
2081 * \li Origin: lasgouttes, 27 Nov 2009
2084 { LFUN_INSET_FORALL, "inset-forall", ReadOnly, Edit },
2088 * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
2089 * \li Action: Insert new inset (type given by the parameters).
2090 * \li Syntax: inset-insert <INSET> <ARGS>
2091 * \li Params: <INSET>: <bibitem|bibtex|citation|ert|listings|external|graphics|tabular|\n
2092 hyperlink|include|index|label|line|nomencl|vspace|ref|toc|script>\n
2093 <ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
2094 * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
2095 where <label name> is the name of the referenced label and
2096 <Format> is one of the following: \n
2097 ref -- <reference> \n
2098 eqref -- (<reference>) \n
2099 pageref -- <page> \n
2100 vpageref -- on <page> \n
2101 vref -- <reference> on <page> \n
2102 formatted -- Formatted reference
2105 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
2108 * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
2109 * \li Action: Modify some properties of an inset.
2110 * \li Notion: Used for argument, bibitem, bibtex, box, branch, caption, citation,
2111 command, ert, external, float, graphics, include, index,
2112 info, label, line, listings, newline, newpage, nomencl,
2113 note, phantom, quotes, ref, script, separator, space,
2114 tabular, vspace and wrap insets.
2115 * \li Syntax: inset-modify <INSET> <ARGS> \n
2116 inset-modify changetype <TYPE>
2117 * \li Sample: Change a Note inset into a Comment inset: \n
2118 inset-modify note Note Comment \n
2119 Change a Box into an Ovalbox: \n
2120 inset-modify changetype Ovalbox \n
2121 Change a quotation mark to e[nglish style], l[eft side = opening], s[ingle = inner, secondary] \n
2122 inset-modify changetype els \n
2123 Change only the style of a quotation mark, maintaining the other aspects (. = wildcard) \n
2124 inset-modify changetype e.. \n
2127 { LFUN_INSET_MODIFY, "inset-modify", AtPoint, Edit },
2130 * \var lyx::FuncCode lyx::LFUN_INSET_SELECT_ALL
2131 * \li Action: Select all contents of an inset.
2132 * \li Notion: There are 3 successive levels: select current cell,
2133 * select all cells of inset, select the inset from outside
2134 * (in the enclosing inset).
2135 * \li Syntax: inset-select-all
2136 * \li Origin: vfr, 22 Aug 2009; lasgouttes 1 Nov 2014
2139 { LFUN_INSET_SELECT_ALL, "inset-select-all", ReadOnly, Edit },
2143 * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
2144 * \li Action: Open the inset's properties dialog.
2145 * \li Notion: Used for bibitem, bibtex, box, branch, citation, ert, external,
2146 float, graphics, href, include, index, index_print, label, line,
2147 listings, note, phantom, ref, space, tabular, vspace, wrap insets.
2148 * \li Syntax: inset-settings <INSET>
2149 * \li Params: <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|\n
2150 graphics|href|include|index|index_print|label|line|\n
2151 listings|note|phantom|ref|space|tabular|vspace|wrap>.
2154 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly | AtPoint, Edit },
2157 * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
2158 * \li Action: Toggles the collapsible inset at cursor position,
2159 or the inset we are currently in.
2160 * \li Syntax: inset-toggle [<ARG>]
2161 * \li Params: <ARG>: <open|close|toggle|assign>. \n
2162 open/close/toggle are for collapsible insets. toggle is used when no argument is given.\n
2163 assign synchronize the branch-inset with activation status of the branch.
2164 Used for global toggling when changed activation.
2165 * \li Origin: lasgouttes, 19 Jul 2001
2168 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly | AtPoint, Edit },
2171 * \var lyx::FuncCode lyx::LFUN_IN_IPA
2172 * \li Action: Only active in IPA inset.
2173 * \li Notion: Dummy function which is only active in a IPA inset.
2174 It's used to toggle the IPA toolbar if the cursor moves
2176 * \li Syntax: in-ipa
2177 * \li Origin: spitz, 20 May 2012
2180 { LFUN_IN_IPA, "in-ipa", Noop, Edit },
2183 * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
2184 * \li Action: Only active in Math Macro definition.
2185 * \li Notion: Dummy function which is only active in a Math Macro definition.
2186 It's used to toggle the Math Macro toolbar if the cursor moves
2187 into a Math Macro definition.
2188 * \li Syntax: in-mathmacrotemplate
2189 * \li Origin: sts, 06 January 2008
2192 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
2196 * \var lyx::FuncCode lyx::LFUN_IPAMACRO_INSERT
2197 * \li Action: Inserts special IPA macros into the document.
2198 * \li Syntax: ipamacro-insert <CHAR>
2199 * \li Params: <CHAR>: tone-falling, tone-rising, tone-high-rising, tone-low-rising,
2200 * tone-high-rising-falling, deco bottomtiebar, deco toptiebar.
2201 * \li Origin: JSpitzm, 22 Aug 2012
2204 { LFUN_IPAMACRO_INSERT, "ipamacro-insert", Noop, Edit },
2207 * \var lyx::FuncCode lyx::LFUN_IPA_INSERT
2208 * \li Action: Inserts an IPA inset.
2209 * \li Syntax: ipa-insert
2210 * \li Origin: spitz, 05 Mar 2012
2213 { LFUN_IPA_INSERT, "ipa-insert", Noop, Edit },
2216 * \var lyx::FuncCode lyx::LFUN_KEYMAP_OFF
2217 * \li Action: Turn off the loaded keyboard map.
2218 * \li Syntax: keymap-off
2221 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
2224 * \var lyx::FuncCode lyx::LFUN_KEYMAP_PRIMARY
2225 * \li Action: Turn on the primary keyboard map.
2226 * \li Notion: Maps were widely used in past, when X-windows didn't have nowadays
2227 keyboard support. They can be still used to maintain uniform keyboard
2228 layout across the various platforms.\n
2229 The language is to be set in the Preferences dialog.
2230 * \li Syntax: keymap-primary
2233 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
2236 * \var lyx::FuncCode lyx::LFUN_KEYMAP_SECONDARY
2237 * \li Action: Turn on the secondary keyboard map.
2238 * \li Syntax: keymap-secondary
2241 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
2244 * \var lyx::FuncCode lyx::LFUN_KEYMAP_TOGGLE
2245 * \li Action: Toggles keyboard maps (first/second/off).
2246 * \li Syntax: keymap-toggle
2247 * \li Origin: leeming, 30 Mar 2004
2250 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
2254 * \var lyx::FuncCode lyx::LFUN_LABEL_COPY_AS_REF
2255 * \li Action: Copies the label at the cursor as a cross-reference to be pasted elsewhere.
2256 * \li Syntax: copy-label-as-reference <LABEL>
2257 * \li Params: <LABEL>: The label to copy (for multi-line math)
2258 * \li Origin: sts, 16 Nov 2008
2261 { LFUN_LABEL_COPY_AS_REFERENCE, "label-copy-as-reference",
2262 ReadOnly | NoUpdate | AtPoint, Edit },
2266 * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
2267 * \li Action: Goto a label.
2268 * \li Syntax: label-goto [<LABEL>]
2269 * \li Params: <LABEL>: Requested label. If no label is given and reference
2270 is on cursor position, Bookmark 0 is saved and
2271 cursor moves to the position of referenced label.
2272 * \li Origin: Ale, 6 Aug 1997
2275 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
2278 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT
2279 * \li Action: Inserts label to text or displayed formula.
2280 * \li Syntax: label-insert [<LABEL>]
2281 * \li Params: <LABEL>: Requested label. If no label is given dialog requesting
2282 name will be opened.
2285 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
2288 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT_AS_REFERENCE
2289 * \li Action: Inserts the label (in ToC pane) as a cross-reference at the position of the cursor.
2290 * \li Syntax: label-insert-as-reference
2291 * \li Origin: vfr, 7 Apr 2009
2294 { LFUN_LABEL_INSERT_AS_REFERENCE, "label-insert-as-reference", Noop, Edit},
2298 * \var lyx::FuncCode lyx::LFUN_LANGUAGE
2299 * \li Action: Set language from the current cursor position.
2300 * \li Syntax: language <LANG> [set]
2301 * \li Params: <LANG>: Requested language. Look in lib/languages for
2302 the list. "language reset" or "language" (without param)
2303 reset to the document language.
2304 set: If used, the language will be set to the specified
2305 language. Otherwise, the language will be toggled (i.e., if
2306 the current language is LANG, switch to the document language
2307 or the default language, if LANG is the document language).
2308 * \li Origin: Dekel, 2 Mar 2000
2311 { LFUN_LANGUAGE, "language", Noop, Edit },
2315 * \var lyx::FuncCode lyx::LFUN_LAYOUT
2316 * \li Action: Sets the layout (that is, environment) for the current paragraph.
2317 * \li Syntax: layout <LAYOUT> [ignorenests]
2318 * \li Params: <LAYOUT>: the layout to use
2319 ignorenests: If specified, nesting advices will be ignored.
2322 { LFUN_LAYOUT, "layout", Noop, Layout },
2325 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
2326 * \li Action: Clears the module list.
2327 * \li Notion: Clears the list of included modules for the current buffer.
2328 * \li Syntax: layout-modules-clear
2329 * \li Origin: rgh, 25 August 2007
2332 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", NoInternal, Layout },
2335 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULE_ADD
2336 * \li Action: Adds a module.
2337 * \li Notion: Adds a module to the list of included modules for the current buffer.
2338 * \li Syntax: layout-module-add <MODULE>
2339 * \li Params: <MODULE>: the module to be added
2340 * \li Origin: rgh, 25 August 2007
2343 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", NoInternal, Layout },
2346 * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH
2347 * \li Action: Launches the paragraph settings dialog.
2348 * \li Syntax: layout-paragraph
2351 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
2354 * \var lyx::FuncCode lyx::LFUN_LAYOUT_RELOAD
2355 * \li Action: Reloads layout information.
2356 * \li Notion: Reloads all layout information for the current buffer from disk, thus
2357 recognizing any changes that have been made to layout files on the fly.
2358 This is intended to be used only by layout developers and should not be
2359 used when one is trying to do actual work.
2360 * \li Syntax: layout-reload
2361 * \li Origin: rgh, 3 September 2007
2364 { LFUN_LAYOUT_RELOAD, "layout-reload", NoInternal, Layout },
2367 * \var lyx::FuncCode lyx::LFUN_LAYOUT_TABULAR
2368 * \li Action: Launches the tabular settings dialog.
2369 * \li Syntax: layout-tabular
2370 * \li Origin: Jug, 31 Jul 2000
2373 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
2376 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN
2377 * \li Action: Move the cursor to the beginning of the (screen) line.
2378 * \li Syntax: line-begin
2381 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
2384 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN_SELECT
2385 * \li Action: Move the cursor to the beginning of the (screen) line adding the
2386 traversed text to the selection.
2387 * \li Syntax: line-begin-select
2390 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
2393 * \var lyx::FuncCode lyx::LFUN_LINE_DELETE_FORWARD
2394 * \li Action: Deletes the letters to the end of the (screen) line or
2395 deletes the selection.
2396 * \li Syntax: line-delete-forward
2399 { LFUN_LINE_DELETE_FORWARD, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
2402 * \var lyx::FuncCode lyx::LFUN_LINE_END
2403 * \li Action: Move the cursor to the end of the (screen) line.
2404 * \li Syntax: line-end
2407 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
2410 * \var lyx::FuncCode lyx::LFUN_LINE_END_SELECT
2411 * \li Action: Move the cursor to the end of the (screen) line adding the
2412 traversed text to the selection.
2413 * \li Syntax: line-end-select
2416 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
2419 * \var lyx::FuncCode lyx::LFUN_LISTING_INSERT
2420 * \li Action: Inserts a new listings inset.
2421 * \li Syntax: listing-insert
2422 * \li Origin: Herbert, 10 Nov 2001; bpeng, 2 May 2007
2425 { LFUN_LISTING_INSERT, "listing-insert", Noop, Edit },
2428 * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
2429 * \li Action: Apply the given settings to user preferences.
2430 * \li Syntax: lyxrc-apply <SETTINGS>
2431 * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
2432 to get an idea which commands to use and their syntax.
2433 #lyx::LyXRC::LyXRCTags has the list of possible commands.
2436 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
2439 * \var lyx::FuncCode lyx::LFUN_LYX_ACTIVATE
2440 * \li Action: Activates the LyX window.
2441 * \li Notion: On Linux and Mac OS, this action brings the LyX window
2442 into focus. Such behavior is not allowed by Windows OS
2443 so instead the color of the taskbar entry is changed to
2444 indicate that the window has changed in some way.
2445 This action is useful in combination with reverse search.
2446 * \li Syntax: lyx-activate
2447 * \li Origin: skostysh, 4 Aug 2016
2450 { LFUN_LYX_ACTIVATE, "lyx-activate", ReadOnly | NoBuffer, Hidden },
2453 * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
2454 * \li Action: Terminates the current LyX instance.
2455 * \li Notion: Terminates the current LyX instance, asking whether to save
2456 modified documents, etc.
2457 * \li Syntax: lyx-quit
2460 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
2463 * \var lyx::FuncCode lyx::LFUN_MARGINALNOTE_INSERT
2464 * \li Action: Inserts a marginal note.
2465 * \li Syntax: marginalnote-insert
2466 * \li Origin: Lgb, 26 Jun 2000
2469 { LFUN_MARGINALNOTE_INSERT, "marginalnote-insert", Noop, Edit },
2472 * \var lyx::FuncCode lyx::LFUN_MARK_OFF
2473 * \li Action: Disable selecting of text-region.
2474 * \li Syntax: mark-off
2477 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
2480 * \var lyx::FuncCode lyx::LFUN_MARK_ON
2481 * \li Action: Enable selecting of text-region.
2482 * \li Notion: After enabling you can simply move arrow keys to get selected region.
2483 * \li Syntax: mark-on
2486 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
2489 * \var lyx::FuncCode lyx::LFUN_MARK_TOGGLE
2490 * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
2491 * \li Syntax: mark-toggle
2492 * \li Origin: Andre, May 5 2006
2495 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
2499 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
2500 * \li Action: Update (export) the document built from the master buffer,
2501 if the current buffer is part of a master/child document.
2502 * \li Syntax: master-buffer-update [<FORMAT>]
2503 * \li Params: <FORMAT>: The format to display, where this is one of the
2504 formats defined (in the current GUI) in the
2505 Tools>Preferences>File Formats dialog.
2506 If no format is given, the default format as
2507 specified in the same dialog is used.
2508 * \li Origin: Tommaso, 20 Sep 2007
2511 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
2514 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
2515 * \li Action: Show a preview built from the master buffer, if available.
2516 if the current buffer is part of a master/child document.
2517 * \li Syntax: master-buffer-view [<FORMAT>]
2518 * \li Params: <FORMAT>: The format to display, where this is one of the
2519 formats defined (in the current GUI) in the
2520 Tools>Preferences>File Formats dialog.
2521 If no format is given, the default format as
2522 specified in the same dialog is used.
2523 * \li Origin: Tommaso, 20 Sep 2007
2526 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
2529 * \var lyx::FuncCode lyx::LFUN_MATH_AMS_MATRIX
2530 * \li Action: Inserts an extended matrix as provided by the amsmath package.
2531 * \li Syntax: math-matrix <COLS> <ROWS> [<DECORATION>]
2532 * \li Params: <DECORATION>: Decoration determines the LaTeX name of the matrix
2533 that should be created. Possible values include
2534 pmatrix, bmatrix, Bmatrix, vmatrix, Vmatrix and
2535 matrix. The default is 'matrix'.
2536 * \li Sample: math-ams-matrix 3 3 bmatrix
2539 { LFUN_MATH_AMS_MATRIX, "math-ams-matrix", Noop, Math },
2542 * \var lyx::FuncCode lyx::LFUN_MATH_BIGDELIM
2543 * \li Action: Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
2544 * \li Syntax: math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
2545 * \li Params: <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r \n
2546 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
2547 * \li Sample: math-bigdelim "Bigl" "\Downarrow" "Bigr" "\}"
2548 * \li Origin: Enrico & Georg, 7 May 2006
2551 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
2554 * \var lyx::FuncCode lyx::LFUN_MATH_DELIM
2555 * \li Action: Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
2556 * \li Syntax: math-delim [<LEFT>] [<RIGHT>]
2557 * \li Params: <LEFT/RIGHT>: Delimiters to be used. Each delimiter can be specified by
2558 either a LaTeX name or a valid character.
2559 ( is the default letter.
2560 * \li Sample: math-delim { rangle
2561 * \li Origin: Alejandro, 18 Jun 1996
2564 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
2567 * \var lyx::FuncCode lyx::LFUN_MATH_DISPLAY
2568 * \li Action: Creates a new displayed equation in text mode.
2569 Toggles inlined/display formula in math mode.
2570 * \li Syntax: math-display [<ARG>]
2571 * \li Params: <ARG>: this argument will be passed to #LFUN_MATH_INSERT when creating
2572 new equation from the text mode.
2573 * \li Origin: Alejandro, 18 Jun 1996
2576 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
2579 * \var lyx::FuncCode lyx::LFUN_MATH_EXTERN
2580 * \li Action: Calls external program and passes the current expression/equation
2581 as an argument for the calculation in the format appropriate to the
2583 * \li Notion: Selection can be used to determine the input for the external program.
2584 * \li Syntax: math-extern <LANG> [<COMMAND>]
2585 * \li Params: <LANG>: octave|maxima|maple|mathematica|script \n
2586 where "script" stands for the external script (normalized
2587 expression will be passed)
2588 * \li Origin: Andre, 24 Apr 2001
2589 * \li Sample: math-extern maple simplify
2592 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
2595 * \var lyx::FuncCode lyx::LFUN_MATH_FONT_STYLE
2596 * \li Action: Changes the text style used in math.
2597 * \li Syntax: math-font-style <STYLE>
2598 * \li Params: <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf|textnormal\n
2599 |textrm|textsf|texttt|textbf|textmd|textit|textsc|textsl|textup
2600 * \li Origin: vfr, 9 jan 2009
2603 { LFUN_MATH_FONT_STYLE, "math-font-style", Noop, Math },
2606 * \var lyx::FuncCode lyx::LFUN_MATH_INSERT
2607 * \li Action: Inserts math objects and symbols.
2608 * \li Syntax: math-insert <ARG>
2609 * \li Params: <ARG>: Symbol or LaTeX code to be inserted.
2610 * \li Notion: When <ARG> is a _single_ math inset with more than one cell
2611 (such as "x_y^z" or "\frac{x}{y}"), the content of cell(0) is
2612 replaced by the current selection (only works if the selection
2613 is in mathed). As an example, if "abc" is selected in mathed,
2614 "math-insert \frac{x}{y}" replaces "abc" with "\frac{abc}{y}",
2615 and "math-insert x_y^z" replaces "abc" with "abc_y^z".
2616 If nothing is selected (or the selection is not in mathed),
2617 math-insert works as expected.
2620 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
2623 * \var lyx::FuncCode lyx::LFUN_MATH_LIMITS
2624 * \li Action: Toggles the position of the limits from above/below to the right
2625 side an vice versa in integral symbol, a limit, a summation, etc.
2626 * \li Notion: Put the cursor before the symbol with the limits and then invoke
2628 * \li Syntax: math-limits [<STATE>]
2629 * \li Params: <STATE>: limits|nolimits
2632 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
2635 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO
2636 * \li Action: Inserts a math macro definition at the cursor position in the text.
2637 * \li Syntax: math-macro <NAME> [<NARGS>] [def]
2638 * \li Params: <NAME>: The name of the macro, e.g. "mymacro".\n
2639 <NARGS>: The number of parameters of the macro. Default is 0.
2640 "def": Has no effect anymore, just for compatibility with former LyX versions.
2641 * \li Origin: ale, 10 May 1997; sts, 21 Dec 2007
2644 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
2647 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
2648 * \li Action: Add a greedy optional parameter.
2649 * \li Notion: Add a greedy optional parameter which eats the value
2650 from the following cells in mathed which are in the [value]
2652 * \li Syntax: math-macro-add-greedy-optional-param
2653 * \li Origin: sts, 06 January 2008
2656 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
2659 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
2660 * \li Action: Add an optional parameter.
2661 * \li Notion: Insert an optional parameter just behind the
2662 already existing optional parameters.
2663 * \li Syntax: math-macro-add-optional-param
2664 * \li Origin: sts, 06 January 2008
2667 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
2670 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
2671 * \li Action: Add a parameter.
2672 * \li Notion: Add a parameter to a Math Macro.
2673 * \li Params: <NUM>: The number of the parameter behind which the new one
2674 will be added (1 for the first, i.e. use 0 for add a
2675 parameter at the left), defaults to the last one.
2676 * \li Syntax: math-macro-add-param <NUM>
2677 * \li Origin: sts, 06 January 2008
2680 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
2683 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
2684 * \li Action: Append a greedy parameter.
2685 * \li Notion: Append a greedy parameter to a Math Macro which
2686 eats the following mathed cell in every instance of
2687 the macro in the buffer.
2688 * \li Syntax: math-macro-append-greedy-param
2689 * \li Origin: sts, 06 January 2008
2692 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
2695 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
2696 * \li Action: Fold a Math Macro.
2697 * \li Notion: Fold the Math Macro the cursor is in if it was
2698 unfolded, i.e. displayed as \foo before.
2699 * \li Syntax: math-macro-fold
2700 * \li Origin: sts, 06 January 2008
2703 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
2706 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
2707 * \li Action: Make a parameter non-optional.
2708 * \li Notion: Turn the last optional parameter of a Math Macro
2709 into a non-optional parameter. The default value is
2710 remembered to be reused later if the user changes his mind.
2711 * \li Syntax: math-macro-make-nonoptional
2712 * \li Origin: sts, 06 January 2008
2715 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
2718 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
2719 * \li Action: Make a parameter optional.
2720 * \li Notion: Turn the first non-optional parameter of a Math Macro
2721 into an optional parameter with a default value.
2722 * \li Syntax: math-macro-make-optional
2723 * \li Origin: sts, 06 January 2008
2726 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
2729 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
2730 * \li Action: Remove a greedy parameter.
2731 * \li Notion: Remove a greedy parameter of a Math Macro and spit
2732 out the values of it in every instance of the macro
2733 in the buffer. If it is an optional parameter the [valud]
2735 * \li Syntax: math-macro-remove-greedy-param
2736 * \li Origin: sts, 06 January 2008
2739 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
2742 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
2743 * \li Action: Remove the last optional parameter.
2744 * \li Notion: Remove the last optional parameter of a Math Macro and
2745 remove it in all the instances of the macro in the buffer.
2746 * \li Syntax: math-macro-remove-optional-param
2747 * \li Origin: sts, 06 January 2008
2750 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
2753 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
2754 * \li Action: Remove the last parameter.
2755 * \li Notion: Remove the last parameter of a Math Macro and
2756 remove its value in all instances of the macro
2758 * \li Params: <NUM>: The number of the parameter to be deleted (1 for
2759 the first), defaults to the last one.
2760 * \li Syntax: math-macro-remove-param <NUM>
2761 * \li Origin: sts, 06 January 2008
2764 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
2767 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
2768 * \li Action: Unfold a Math Macro.
2769 * \li Notion: Unfold the Math Macro the cursor is in, i.e.
2771 * \li Syntax: math-macro-unfold
2772 * \li Origin: sts, 06 January 2008
2775 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
2778 * \var lyx::FuncCode lyx::LFUN_MATH_MATRIX
2779 * \li Action: Inserts a matrix.
2780 * \li Syntax: math-matrix <COLS> <ROWS> [<ALIGN>]
2781 * \li Params: <ALIGN>: Alignment is a word composed of the vertical alignment
2782 (b, c or t) (i.e. 1 char) and the horizontal alignments
2783 (l, c or r) (i.e. <COL> chars).
2784 * \li Sample: math-matrix 3 3 bccc
2787 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
2790 * \var lyx::FuncCode lyx::LFUN_MATH_MODE
2791 * \li Action: In text mode enters math mode (i.e. puts math insets on the current
2792 cursor position), in math mode enters text mode inside math expression.
2793 * \li Notion: If there is some selected text, it puts the text inside created math box.
2794 * \li Syntax: math-mode [on|<ARG>]
2795 * \li Params: <ARG>: eventual argument (LaTeX code) is passed to #LFUN_MATH_INSERT .\n
2796 "on": allow only entering of math mode from text mode.
2797 * \li Origin: Alejandro, 4 Jun 1996
2800 { LFUN_MATH_MODE, "math-mode", Noop, Math },
2803 * \var lyx::FuncCode lyx::LFUN_MATH_MUTATE
2804 * \li Action: Mutates the type of math inset to the newly selected one.
2805 * \li Syntax: math-mutate <TYPE>
2806 * \li Params: <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
2807 multline|gather|flalign
2808 * \li Origin: Andre, 23 May 2001
2811 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
2814 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
2815 * \li Action: Toggles numbering of the current formula line.
2816 * \li Notion: Must be in display formula mode.
2817 * \li Syntax: math-number-line-toggle
2818 * \li Origin: Alejandro, 18 Jun 1996
2821 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
2824 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
2825 * \li Action: Toggles numbering/labeling of the current formula.
2826 * \li Notion: Must be in display formula mode.
2827 * \li Syntax: math-number-toggle
2828 * \li Origin: Alejandro, 4 Jun 1996
2831 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
2834 * \var lyx::FuncCode lyx::LFUN_MATH_SIZE
2835 * \li Action: Changes arbitrarily the size used by math fonts inside a context.
2836 * \li Notion: Provides an interface to the LaTeX math mode font size commands.
2837 * \li Syntax: math-size <STYLE>
2838 * \li Params: <STYLE>: \displaystyle|\textstyle|\scriptstyle|\scriptscriptstyle
2839 * \li Origin: Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
2842 { LFUN_MATH_SIZE, "math-size", Noop, Math },
2845 * \var lyx::FuncCode lyx::LFUN_MATH_SPACE
2846 * \li Action: Inserts space into math expression.
2847 * \li Notion: Use spacebar after entering this space to change type of space.
2848 * \li Syntax: math-space [<TYPE>] [<LEN>]
2849 * \li Params: <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace \n
2850 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad \n
2851 custom space: hspace \n
2852 "," used by default.\n
2853 Note that ! is equivalent to negthinspace, , = thinspace,
2854 : = medspace, and ; = thickspace.\n
2855 <LEN>: length for custom spaces (hspace)
2856 * \li Origin: Andre, 25 Jul 2001; sanda, 16 Jun 2008
2859 { LFUN_MATH_SPACE, "math-space", Noop, Math },
2862 * \var lyx::FuncCode lyx::LFUN_MATH_SUBSCRIPT
2863 * \li Action: Enters subscript expression in math expression.
2864 * \li Syntax: math-subscript
2865 * \li Origin: vermeer, 12 Dec 2001
2868 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
2871 * \var lyx::FuncCode lyx::LFUN_MATH_SUPERSCRIPT
2872 * \li Action: Enters superscript expression in math expression.
2873 * \li Syntax: math-superscript
2874 * \li Origin: vermeer, 12 Dec 2001
2877 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
2880 * \var lyx::FuncCode lyx::LFUN_MENU_OPEN
2881 * \li Action: Opens the menu given by its name.
2882 * \li Syntax: menu-open <NAME>
2883 * \li Params: <NAME>: menu name. See various .inc files in lib/ui for candidates.
2886 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
2889 * \var lyx::FuncCode lyx::LFUN_MESSAGE
2890 * \li Action: Shows message in statusbar (for script purposes).
2891 * \li Syntax: message <STRING>
2892 * \li Origin: Lgb, 8 Apr 2001
2895 { LFUN_MESSAGE, "message", NoBuffer, System },
2898 * \var lyx::FuncCode lyx::LFUN_META_PREFIX
2899 * \li Action: Simulate halting Meta key (Alt key on PCs).
2900 * \li Notion: Used for buffer edition not for GUI control.
2901 * \li Syntax: meta-prefix
2904 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
2907 * \var lyx::FuncCode lyx::LFUN_MOUSE_DOUBLE
2908 * \li Action: This function is called when double click on mouse button is
2909 pressed (inside workarea). Action depends on the context.
2910 * \li Notion: This is an internal LFUN, not to be used by users.
2911 * \li Origin: Andre, 9 Aug 2002
2914 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
2917 * \var lyx::FuncCode lyx::LFUN_MOUSE_MOTION
2918 * \li Action: This function is called when mouse cursor is moving over the text.
2919 Action depends on the context.
2920 * \li Notion: This is an internal LFUN, not to be used by users.
2921 * \li Origin: Andre, 9 Aug 2002
2924 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
2927 * \var lyx::FuncCode lyx::LFUN_MOUSE_PRESS
2928 * \li Action: This function is called when mouse button is pressed (inside workarea).
2929 Action depends on the context.
2930 * \li Notion: This is an internal LFUN, not to be used by users.
2931 * \li Origin: Andre, 9 Aug 2002
2934 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
2937 * \var lyx::FuncCode lyx::LFUN_MOUSE_RELEASE
2938 * \li Action: This function is called when mouse button is released (inside workarea).
2939 Action depends on the context.
2940 * \li Notion: This is an internal LFUN, not to be used by users.
2941 * \li Origin: Andre, 9 Aug 2002
2944 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
2948 * \var lyx::FuncCode lyx::LFUN_MOUSE_TRIPLE
2949 * \li Action: This function is called when triple click on mouse button is
2950 pressed (inside workarea). Action depends on the context.
2951 * \li Notion: This is an internal LFUN, not to be used by users.
2952 * \li Origin: Andre, 9 Aug 2002
2955 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
2958 * \var lyx::FuncCode lyx::LFUN_NEWLINE_INSERT
2959 * \li Action: Inserts a line break or new line.
2960 * \li Syntax: newline-insert [<ARG>]
2961 * \li Params: <ARG>: <newline|linebreak> default: newline
2962 * \li Origin: JSpitzm, 25 Mar 2008
2965 { LFUN_NEWLINE_INSERT, "newline-insert", Noop, Edit },
2968 * \var lyx::FuncCode lyx::LFUN_NEWPAGE_INSERT
2969 * \li Action: Inserts a new page.
2970 * \li Syntax: newpage-insert <ARG>
2971 * \li Params: <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
2972 * \li Origin: uwestoehr, 24 Nov 2007
2975 { LFUN_NEWPAGE_INSERT, "newpage-insert", Noop, Edit },
2978 * \var lyx::FuncCode lyx::LFUN_NOMENCL_INSERT
2979 * \li Action: Inserts Nomenclature entry.
2980 * \li Notion: It automatically takes the word on the cursor position if no symbol is given.
2981 * \li Syntax: nomencl-insert [<SYMBOL>]
2982 * \li Origin: Ugras, 4 Nov 2006
2985 { LFUN_NOMENCL_INSERT, "nomencl-insert", Noop, Edit },
2988 * \var lyx::FuncCode lyx::LFUN_NOMENCLATURE_PRINT
2989 * \li Action: Inserts list of Nomenclature entries.
2990 * \li Syntax: nomenclature-print
2991 * \li Origin: Ugras, 4 Nov 2006
2994 { LFUN_NOMENCL_PRINT, "nomencl-print", Noop, Edit },
2998 * \var lyx::FuncCode lyx::LFUN_NOTE_INSERT
2999 * \li Action: Inserts Note on the current cursor position,
3000 move selection inside the inset.
3001 * \li Syntax: note-insert [<TYPE>]
3002 * \li Params: <TYPE>: <Note|Greyedout|Comment> default: Note
3005 { LFUN_NOTE_INSERT, "note-insert", Noop, Edit },
3008 * \var lyx::FuncCode lyx::LFUN_NOTE_NEXT
3009 * \li Action: Moves the cursor to the beginning of next Note inset.
3010 * \li Syntax: note-next
3013 { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
3016 * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
3017 * \li Action: Move the current group in the downward direction in the
3018 structure of the document.
3019 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
3020 the whole substructure of the group.
3021 * \li Syntax: outline-down
3022 * \li Origin: Vermeer, 23 Mar 2006
3025 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
3028 * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
3029 * \li Action: Moves the current group in the downward direction in the
3030 hierarchy of the document structure.
3031 * \li Notion: Part -> Chapter -> Section -> etc.
3032 * \li Syntax: outline-in
3033 * \li Origin: Vermeer, 23 Mar 2006
3036 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
3039 * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
3040 * \li Action: Moves the current group in the upward direction in the
3041 hierarchy of the document structure.
3042 * \li Notion: Part <- Chapter <- Section <- etc.
3043 * \li Syntax: outline-out
3044 * \li Origin: Vermeer, 23 Mar 2006
3047 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
3051 * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
3052 * \li Action: Move the current group in the upward direction in the
3053 structure of the document.
3054 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
3055 the whole substructure of the group.
3056 * \li Syntax: outline-up
3057 * \li Origin: Vermeer, 23 Mar 2006
3060 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
3063 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_BREAK
3064 * \li Action: Breaks the current paragraph at the current location.
3065 * \li Notion: Removes the selection.
3066 * \li Syntax: paragraph-break [<LAYOUT>] [ignoresep]
3067 * \li Params: <LAYOUT>: "inverse" - decreases depth by one (or change layout
3068 to default layout) when the cursor is at the end of
3070 ignoresep: Do not account for paragraph separators while breaking.
3073 { LFUN_PARAGRAPH_BREAK, "paragraph-break", Noop, Edit },
3076 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN
3077 * \li Action: Move the cursor to the next paragraph (or beginning of the current one)
3078 in downward direction.
3079 * \li Syntax: paragraph-down
3080 * \li Origin: Asger, 1 Oct 1996
3083 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
3086 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN_SELECT
3087 * \li Action: Move the cursor and select the text to the next paragraph (or
3088 beginning of the current one) in downward direction.
3089 * \li Syntax: paragraph-down-select
3090 * \li Origin: Asger, 1 Oct 1996
3093 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
3096 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
3097 * \li Action: Jump to a paragraph given by its id number and optionally the
3098 desired position within the paragraph.
3099 If given four arguments id_start, pos_start, id_end, pos_end,
3100 perform a selection from start to end.
3101 * \li Notion: Note that id number of paragraph is not the sequential number of
3102 paragraph seen on the screen. Moreover the id is unique for all
3103 opened buffers (documents). Both ids must belong to the same
3105 * \li Syntax: paragraph-goto <PAR_ID> <POS_IN_PAR> [<PAR_ID> <POS_IN_PAR>]
3106 * \li Params: <PAR_ID>: paragraph id \n
3107 <POS_IN_PAR>: desired position within the paragraph
3108 * \li Origin: Dekel, 26 Aug 2000
3112 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly | NoInternal, Edit },
3115 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
3116 * \li Action: Moves the current paragraph downwards in the document.
3117 * \li Syntax: paragraph-move-down
3118 * \li Origin: Edwin, 8 Apr 2006
3121 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
3124 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
3125 * \li Action: Moves the current paragraph upwards in the document.
3126 * \li Notion: Movement through the document will possibly break the paragraph-depth
3127 (e.g. itemize structure).
3128 * \li Syntax: paragraph-move-up
3129 * \li Origin: Edwin, 8 Apr 2006
3132 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
3136 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
3137 * \li Action: Change paragraph settings.
3138 * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
3139 This function only modifies, and does not override, existing settings.
3140 Note that the "leftindent" indent setting is deprecated.
3141 * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
3142 * \li Params: <INDENT>: \noindent|\indent|\indent-toggle|\leftindent LENGTH\n
3143 <SPACING>: \paragraph_spacing default|single|onehalf|double|other SIZE \n
3144 <ALIGN>: \align block|left|right|center|default\n
3145 <OTHERS>: \labelwidthstring WIDTH|\start_of_appendix
3146 * \li Origin: rgh, Aug 15 2007
3149 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
3152 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
3153 * \li Action: Change paragraph settings.
3154 * \li Notion: Overwrite all nonspecified settings to the default ones.
3155 Use paragraph-params lfun if you don't want to overwrite others settings.
3156 * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
3157 * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
3158 * \li Origin: leeming, 30 Mar 2004
3161 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
3164 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP
3165 * \li Action: Move the cursor to the next paragraph (or beginning of the current one)
3166 in upward direction.
3167 * \li Syntax: paragraph-up
3168 * \li Origin: Asger, 1 Oct 1996
3171 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
3174 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UPDATE
3175 * \li Action: Updates the values inside the paragraph dialog from the paragraph.
3176 * \li Notion: This is an internal LFUN, not to be used by users. Called internally
3177 by #LFUN_DIALOG_UPDATE.
3178 * \li Origin: leeming, 13 Mar 2003
3181 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
3185 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP_SELECT
3186 * \li Action: Move the cursor and select the text to the next paragraph (or
3187 beginning of the current one) in upward direction.
3188 * \li Syntax: paragraph-up-select
3189 * \li Origin: Asger, 1 Oct 1996
3192 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
3195 * \var lyx::FuncCode lyx::LFUN_PASTE
3196 * \li Action: Pastes material (text or picture) from the active clipboard.
3197 * \li Syntax: paste [<TYPE>|<NUM>]
3198 * \li Params: <TYPE>: emf|pdf|png|jpeg|linkback|wmf|latex|html \n
3199 <NUM>: number of the selection in the internal clipboard stack to be pasted.
3202 { LFUN_PASTE, "paste", Noop, Edit },
3205 * \var lyx::FuncCode lyx::LFUN_PHANTOM_INSERT
3206 * \li Action: Inserts phantom on the current cursor position,
3207 move selection inside the inset.
3208 * \li Syntax: phantom-insert [<TYPE>]
3209 * \li Params: <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
3210 * \li Origin: uwestoehr, 30 Jan 2009
3213 { LFUN_PHANTOM_INSERT, "phantom-insert", Noop, Edit },
3216 * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
3217 * \li Action: Save user preferences.
3218 * \li Syntax: preferences-save
3219 * \li Origin: Lgb, 27 Nov 1999
3222 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
3225 * \var lyx::FuncCode lyx::LFUN_PREVIEW_INSERT
3226 * \li Action: Inserts a new preview inset.
3227 * \li Syntax: preview-insert
3228 * \li Origin: vfr, 28 Mar 2010
3231 { LFUN_PREVIEW_INSERT, "preview-insert", Noop, Edit },
3234 * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
3235 * \li Action: Pastes the currently selected text.
3236 * \li Notion: Primary selection mechanism is linux-only thing.
3237 * \li Syntax: primary-selection-paste [<ARG>]
3238 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
3241 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
3244 * \var lyx::FuncCode lyx::LFUN_QUOTE_INSERT
3245 * \li Action: Inserts quotes according to the type and quote-language preference.
3246 * \li Notion: Currently 15 different quote styles are distinguished (see params).
3247 * \li Syntax: quote-insert [<LEVEL>] [<SIDE>] [<STYLE>]
3248 * \li Params: <LEVEL>: 'inner' for (i.e., secondary, usually single) quotes, otherwise
3249 * outer (i.e., primary, usually double) quotes will be used.\n
3250 * <SIDE>: 'opening' for opening quotes, 'closing' for closing quotes,
3251 * otherwise the side will be guessed from the context.\n
3252 * <STYLE>: 'british' for `British' quote style (with ``inner quotation'')\n
3253 * 'cjk' for Chinese/Japanese/Korean corner bracket quotation marks\n
3254 * 'cjk-angle' for Chinese/Japanese/Korean angle bracket quotation marks\n
3255 * 'danish' for >>Danish<< quote style (with >inner quotation<)\n
3256 * 'english' for ``English'' quote style (with `inner quotation')\n
3257 * 'french' for <<french>> quote style (with ``inner quotation'')\n
3258 * 'frenchin' for <<frenchin>> quote style (with <<inner quotation>>) ["in" = Imprimerie Nationale]\n
3259 * 'german' for ,,German`` quote style (with ,inner quotation`)\n
3260 * 'plain' for "Plain" quote style (with 'inner quotation')\n
3261 * 'polish' for ,,Polish'' quote style (with ,inner quotation')\n
3262 * 'swedish' for ''Swedish'' quote style (with 'inner quotation')\n
3263 * 'swedishg' for >>swedishg>> quote style (with 'inner quotation') ["g" = Guillemets]\n
3264 * 'swiss' for <<Swiss>> quote style (with <inner quotation>)\n
3265 * 'russian' for <<Russian>> quote style (with ,,inner quotation``)\n
3266 * 'dynamic' for Dynamic quotation marks which inherit the global
3268 * If no quote style is specified, the document-wide will be used.
3271 { LFUN_QUOTE_INSERT, "quote-insert", Noop, Edit },
3274 * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
3275 * \li Action: Reconfigure the automatic settings.
3276 * \li Syntax: reconfigure
3277 * \li Origin: Asger, 14 Feb 1997
3280 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
3283 * \var lyx::FuncCode lyx::LFUN_REDO
3284 * \li Action: Redoes the last thing undone.
3288 { LFUN_REDO, "redo", ReadOnly, Edit },
3291 * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
3292 * \li Action: Go to the next label or cross-reference.
3293 * \li Syntax: reference-next
3294 * \li Origin: Dekel, 14 Jan 2001
3297 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
3301 * \var lyx::FuncCode lyx::LFUN_REGEXP_MODE
3302 * \li Action: Enters regexp mode (i.e., puts regexp insets on the current
3303 cursor position). Used by the advanced search dialog.
3304 * \li Notion: If there is any selected text, then it is moved inside the created
3306 * \li Syntax: regexp-mode [<ARG>]
3307 * \li Params: <ARG>: eventual argument (regular expression).
3308 * \li Origin: Tommaso, 4 Oct 2008
3311 { LFUN_REGEXP_MODE, "regexp-mode", Noop, Math },
3314 * \var lyx::FuncCode lyx::LFUN_REPEAT
3315 * \li Action: Repeat the given command.
3316 * \li Notion: fails when the repeat count is greater than 10000.
3317 * \li Syntax: repeat <COUNT> <LFUN-COMMAND>
3318 * \li Origin: Andre, 27 Oct 2003
3321 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
3324 * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN
3325 * \li Action: Moves the cursor one page in downward direction.
3326 * \li Syntax: screen-down
3329 { LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit },
3332 * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN_SELECT
3333 * \li Action: Moves the cursor one screen in downward direction adding the current
3334 position to the selection.
3335 * \li Syntax: screen-down-select
3338 { LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit },
3341 * \var lyx::FuncCode lyx::LFUN_SCREEN_FONT_UPDATE
3342 * \li Action: Update fonts and its metrics.
3343 * \li Notion: Automatically called after zoom, dpi, font names, or norm change.
3344 * \li Syntax: screen-font-update
3345 * \li Origin: ARRae, 13 Aug 2000
3348 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
3351 * \var lyx::FuncCode lyx::LFUN_SCREEN_RECENTER
3352 * \li Action: Recenters the screen on the current cursor position.
3353 * \li Syntax: screen-recenter
3356 { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit },
3360 * \var lyx::FuncCode lyx::LFUN_SCREEN_SHOW_CURSOR
3361 * \li Action: Repositions the screen such that the cursor is visible.
3362 * \li Syntax: screen-show-cursor
3363 * \li Origin: vfr, 25 Mar 2009
3366 { LFUN_SCREEN_SHOW_CURSOR, "screen-show-cursor", ReadOnly, Edit },
3370 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP
3371 * \li Action: Moves the cursor one page in upward direction.
3372 * \li Syntax: screen-up
3375 { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit },
3378 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP_SELECT
3379 * \li Action: Moves the cursor one page in upward direction adding the current
3380 position to the selection.
3381 * \li Syntax: screen-up-select
3384 { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit },
3387 * \var lyx::FuncCode lyx::LFUN_SCRIPT_INSERT
3388 * \li Action: Inserts a subscript or superscript inset.
3389 * \li Syntax: script-insert <TYPE>
3390 * \li Params: <TYPE>: subscript|superscript
3391 * \li Origin: Georg, 23 Nov 2010
3394 { LFUN_SCRIPT_INSERT, "script-insert", Noop, Edit },
3397 * \var lyx::FuncCode lyx::LFUN_SCROLL
3398 * \li Action: Scroll the buffer view.
3399 * \li Notion: Only scrolls the screen up or down; does not move the cursor.
3400 * \li Syntax: scroll <TYPE> <QUANTITY>
3401 * \li Params: <TYPE>: line|page\n
3402 <QUANTITY>: up|down|<number>
3403 * \li Origin: Abdel, Dec 27 2007
3406 { LFUN_SCROLL, "scroll", ReadOnly, Edit },
3409 * \var lyx::FuncCode lyx::LFUN_SECTION_SELECT
3410 * \li Action: Select the whole section.
3411 * \li Notion: The cursor should be in a section heading
3412 before calling this lfun.
3413 * \li Syntax: section-select
3414 * \li Origin: vfr, 05 May 2009
3417 { LFUN_SECTION_SELECT, "section-select", ReadOnly, Edit },
3421 * \var lyx::FuncCode lyx::LFUN_SELECTION_PASTE
3422 * \li Action: Pastes the internal selection text in permanent selection.
3423 * \li Notion: Created in order to have middle mouse button pasting correct (bound to
3424 command-alternatives selection-paste ; primary-selection-paste paragraph).
3425 * \li Syntax: selection-paste
3426 * \li Origin: lasgouttes, 14 Jan 2009
3429 { LFUN_SELECTION_PASTE, "selection-paste", Noop, Edit },
3432 * \var lyx::FuncCode lyx::LFUN_SELF_INSERT
3433 * \li Action: Inserts the given string (accordingly to the correct keymap).
3434 * \li Notion: Automatically replace the currently selected text. Depends on lyxrc
3435 settings "auto_region_delete".
3436 * \li Syntax: self-insert <STRING>
3439 { LFUN_SELF_INSERT, "self-insert", SingleParUpdate, Hidden },
3442 * \var lyx::FuncCode lyx::LFUN_SEPARATOR_INSERT
3443 * \li Action: Inserts an environment separator or latex paragraph break.
3444 * \li Syntax: separator-insert [<ARG>]
3445 * \li Params: <ARG>: <plain|parbreak|latexpar> default: plain
3446 * \li Origin: ef, 2 May 2014
3449 { LFUN_SEPARATOR_INSERT, "separator-insert", Noop, Edit },
3452 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_FILENAME
3453 * \li Action: Returns path and file name of the currently edited document.
3454 * \li Syntax: server-get-filename
3457 { LFUN_SERVER_GET_FILENAME, "server-get-filename", ReadOnly, System },
3460 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_LAYOUT
3461 * \li Action: Returns the current layout (that is environment) name
3462 on the cursor position.
3463 * \li Syntax: server-get-layout
3466 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
3469 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_STATISTICS
3470 * \li Action: Returns the statistics (number of words and characters)
3471 in the document or in the given selection.
3472 * \li Notion: Note that this function gives the number of words/chars written,
3473 not the number of characters which will be typeset.
3474 * \li Syntax: server-get-statistics [<TYPE>]
3475 * \li Params: <TYPE>: <words|chars|chars-space> The requested count; if not
3476 specified, the three values are returned, separated
3478 words: count words.\n
3479 chars: count characters.\n
3480 chars-space: count characters and spaces.
3481 * \li Origin: brokenclock, Oct 10 2014
3484 { LFUN_SERVER_GET_STATISTICS, "server-get-statistics", ReadOnly, System },
3487 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
3488 * \li Action: Returns the coordinates of cursor position in the editing area.
3489 * \li Syntax: server-get-xy
3492 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
3496 * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
3497 * \li Action: Sets the cursor position in LyX based on the row number of generated TeX file.
3498 * \li Notion: This can be useful for DVI inverse-search or detection of the problematic
3499 line from LaTeX compilation. Note that before this function can be used
3500 export to LaTeX output must occur (in order to map the row numbers).
3501 * \li Syntax: server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
3502 * \li Params: <FILE>: the path and filename. Environment variables are expanded in the path.
3503 In case this LFUN does not work make sure you are giving correct
3505 If the file is located inside LyX temporary directory it will be
3506 mapped back into the appropriate opened buffer (e.g. for the case
3507 of generated .tex file).\n
3508 .ext: extensions will be automatically replaced by .lyx.\n
3509 <ROW_NUMBER> The row number of the LaTeX file to which to go.
3510 * \li Sample: server-goto-file-row /home/user/example.lyx 41\n
3511 server-goto-file-row /tmp/lyx_tmpdir.XM3088/lyx_tmpbuf0/example.tex 41
3512 * \li Origin: Edmar, 23 Dec 1998
3515 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly | NoBuffer, System },
3518 * \var lyx::FuncCode lyx::LFUN_SERVER_NOTIFY
3519 * \li Action: Sends notify message about the last key-sequence to client.
3520 * \li Notion: This can be used to grab last key-sequence used inside the LyX window.
3521 See also Debug extensions section in Additional features manual.
3522 * \li Syntax: server-notify
3525 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
3528 * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
3529 * \li Action: Sets the cursor position based on the editing area coordinates
3530 (similar to clicking on that point with left mouse button).
3531 * \li Syntax: server-set-xy <X> <Y>
3534 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
3537 * \var lyx::FuncCode lyx::LFUN_SET_COLOR
3538 * \li Action: Set the given LyX color to the color defined by the X11 name given.
3539 * \li Notion: A new color entry is created if the color is unknown.
3540 Color names can be stored as a part of user settings.
3541 * \li Syntax: set-color <LYX_NAME> <X11_NAME>
3542 * \li Origin: SLior, 11 Jun 2000
3545 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
3548 * \var lyx::FuncCode lyx::LFUN_SET_GRAPHICS_GROUP
3549 * \li Action: Set the group for the graphics inset on the cursor position.
3550 * \li Syntax: set-graphics-group [<GROUP>]
3551 * \li Params: <GROUP>: Id for an existing group. In case the Id is an empty string,
3552 the graphics inset is removed from the current group.
3553 * \li Origin: sanda, 6 May 2008
3556 { LFUN_SET_GRAPHICS_GROUP, "set-graphics-group", Noop, Edit },
3560 * \var lyx::FuncCode lyx::LFUN_SPACE_INSERT
3561 * \li Action: Inserts one of horizontal space insets.
3562 * \li Syntax: space-insert <NAME> [<LEN>]
3563 * \li Params: <NAME>: normal, protected, visible, thin, quad, qquad, enspace,
3564 enskip, negthinspace, negmedspace, negthickspace, hfill,
3565 hfill*, dotfill, hrulefill, hspace, hspace* \n
3566 Only in math mode: med and thick.\n
3567 <LEN>: length for custom spaces (hspace, hspace* for protected)
3568 * \li Origin: JSpitzm, 20 May 2003, Mar 17 2008
3571 { LFUN_SPACE_INSERT, "space-insert", Noop, Edit },
3574 * \var lyx::FuncCode lyx::LFUN_SPECIALCHAR_INSERT
3575 * \li Action: Inserts various characters into the document.
3576 * \li Syntax: specialchar-insert <CHAR>
3577 * \li Params: <CHAR>: hyphenation, allowbreak, ligature-break, slash,
3578 nobreakdash, dots, end-of-sentence, menu-separator,
3579 lyx, tex, latex, latex2e.
3580 * \li Origin: JSpitzm, 6 Dec 2007
3583 { LFUN_SPECIALCHAR_INSERT, "specialchar-insert", Noop, Edit },
3586 * \var lyx::FuncCode lyx::LFUN_SPELLING_ADD
3587 * \li Action: Add the word under the cursor to the respective
3588 * spell checker dictionary.
3589 * The default for the language is retrieved from the cursor position.
3590 * \li Syntax: spelling-add [<STRING>] [<LANG>]
3591 * \li Params: <WORD>: word to add
3592 <LANG>: language name (see file languages)
3593 * \li Origin: JSpitzm, 18 Jan 2010
3596 { LFUN_SPELLING_ADD, "spelling-add", ReadOnly, Edit },
3599 * \var lyx::FuncCode lyx::LFUN_SPELLING_CONTINUOUSLY
3600 * \li Action: Toggle continuous spell checking.
3601 * \li Syntax: spelling-continuously
3602 * \li Origin: vfr, 24 March 2013
3605 { LFUN_SPELLING_CONTINUOUSLY, "spelling-continuously", ReadOnly, Edit },
3609 * \var lyx::FuncCode lyx::LFUN_SPELLING_IGNORE
3610 * \li Action: Let the spell checker ignore the word under the cursor
3611 * in the current session for the given language.
3612 * The default for the language is retrieved from the cursor position.
3613 * \li Syntax: spelling-ignore [<WORD>] [<LANG>]
3614 * \li Params: <WORD>: word to ignore
3615 <LANG>: language name (see file languages)
3616 * \li Origin: JSpitzm, 18 Jan 2010
3619 { LFUN_SPELLING_IGNORE, "spelling-ignore", ReadOnly, Edit },
3622 * \var lyx::FuncCode lyx::LFUN_SPELLING_REMOVE
3623 * \li Action: Remove the word under the cursor from the respective
3624 * spell checker dictionary.
3625 * The default for the language is retrieved from the cursor position.
3626 * \li Syntax: spelling-remove [<STRING>] [<LANG>]
3627 * \li Params: <WORD>: word to remove
3628 * <LANG>: language name (see file languages)
3629 * \li Origin: SWitt, 28 July 2010
3632 { LFUN_SPELLING_REMOVE, "spelling-remove", ReadOnly, Edit },
3636 * \var lyx::FuncCode lyx::LFUN_STATISTICS
3637 * \li Action: Count the statistics (number of words and characters)
3638 in the document or in the given selection and display it
3640 * \li Notion: Note that this function gives the number of words/chars written,
3641 not the number of characters which will be typeset.
3642 * \li Syntax: statistics
3643 * \li Origin: lasgouttes, Jan 27 2004; sanda, Jan 8 2008
3646 { LFUN_STATISTICS, "statistics", ReadOnly, System },
3649 * \var lyx::FuncCode lyx::LFUN_TABULAR_FEATURE
3650 * \li Action: Modify properties of tabulars and table-like math environments.
3651 * \li Syntax: tabular-feature <FEATURE> [<ARG>]
3652 * \li Params: Generally see #LFUN_INSET_INSERT for further details.\n
3653 * <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|\n
3654 copy-column|move-column-right|move-column-left|move-row-down|move-row-up|\n
3655 toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|\n
3656 align-left|align-right|align-center|align-block|align-decimal|set-decimal-point|\n
3657 valign-top|valign-bottom|valign-middle|longtabular-align-left|\n
3658 longtabular-align-center|longtabular-align-right|m-align-left|m-align-right|\n
3659 m-align-center|m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|\n
3660 set-all-lines|unset-all-lines|toggle-longtabular|set-longtabular|unset-longtabular|set-pwidth|\n
3661 set-mpwidth|set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|\n
3662 set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|\n
3663 unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|\n
3664 set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|\n
3665 set-special-column|set-special-multicolumn|set-special-multirow|\n
3666 toggle-booktabs|set-booktabs|unset-booktabs|set-top-space|set-bottom-space|\n
3667 set-interline-space|set-border-lines|tabular-valign-top|\n
3668 tabular-valign-middle|tabular-valign-bottom|set-tabular-width\n
3669 Various math-environment features are handled as well, e.g. add-vline-left/right for\n
3670 the Grid/Array environment.\n
3671 <ARG>: additional argument for some commands, use debug mode to explore its values.
3672 * \li Origin: gm, 10 Dec 2015
3675 { LFUN_TABULAR_FEATURE, "tabular-feature", Noop, Edit },
3678 * \var lyx::FuncCode lyx::LFUN_TABULAR_INSERT
3679 * \li Action: Inserts table into the document.
3680 * \li Notion: See #LFUN_TABULAR_FEATURE for some more details
3681 about tabular modifications.
3682 * \li Syntax: tabular-insert [<ROWS> <COLUMNS>]
3683 * \li Params: In case no arguments are given show insert dialog.
3684 * \li Origin: Jug, 12 Apr 2000
3687 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
3691 * \var lyx::FuncCode lyx::LFUN_TAB_DELETE
3692 * \li Action: Delete a tab or up to an equivalent amount of spaces from
3694 * \li Notion: It also works on a selection - it removes a tab or spaces from the
3695 beginning of each line spanned by the selection. This is useful if
3696 you want to indent/unindent multiple lines in one action.
3697 * \li Syntax: tab-delete
3698 * \li Origin: vfr, Sep 30 2008
3701 { LFUN_TAB_DELETE, "tab-delete", SingleParUpdate, Edit },
3704 * \var lyx::FuncCode lyx::LFUN_TAB_GROUP_CLOSE
3705 * \li Action: Close the current tab group.
3706 * \li Notion: This only closes the work areas, not the buffers themselves.
3707 The still opened buffers can be visualized in another tab group.
3708 * \li Syntax: tab-group-close
3709 * \li Origin: Abdel, 21 Feb 2008
3712 { LFUN_TAB_GROUP_CLOSE, "tab-group-close", ReadOnly, Buffer },
3716 * \var lyx::FuncCode lyx::LFUN_TAB_INSERT
3717 * \li Action: Insert a tab into a listings inset.
3718 * \li Notion: It also works on a selection.
3719 * \li Syntax: tab-insert
3720 * \li Origin: vfr, Sep 30 2008
3723 { LFUN_TAB_INSERT, "tab-insert", SingleParUpdate, Edit },
3726 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
3727 * \li Action: Sets the text class for the current buffer.
3728 * \li Syntax: textclass-apply <TEXTCLASS>
3729 * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
3730 the filename, minus the ".layout" extension.
3733 { LFUN_TEXTCLASS_APPLY, "textclass-apply", NoInternal, Layout },
3736 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
3737 * \li Action: Loads information for a textclass from disk.
3738 * \li Syntax: textclass-load <TEXTCLASS>
3739 * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
3740 the filename, minus the ".layout" extension.
3743 { LFUN_TEXTCLASS_LOAD, "textclass-load", NoInternal, Layout },
3747 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_APPLY
3748 * \li Action: Toggle user-defined (=last-time used) text style.
3749 * \li Notion: This style is set via #LFUN_TEXTSTYLE_UPDATE, which is
3750 automatically triggered when using Text Style dialog.
3751 * \li Syntax: textstyle-apply
3752 * \li Origin: leeming, 12 Mar 2003
3755 { LFUN_TEXTSTYLE_APPLY, "textstyle-apply", Noop, Layout },
3758 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_UPDATE
3759 * \li Action: Apply text style and update the settings to be used by #LFUN_TEXTSTYLE_APPLY.
3760 * \li Syntax: textstyle-update <FONT_INFO>
3761 * \li Params: <FONT_INFO>: specifies font atributes, e.g. family, series, shape,
3762 size, emph, noun, underbar, number, color, language,
3764 Use lyx -dbg action for exact syntax of text-style
3766 * \li Origin: leeming, 12 Mar 2003
3769 { LFUN_TEXTSTYLE_UPDATE, "textstyle-update", Noop, Layout },
3772 * \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
3773 * \li Action: Look up thesaurus entries with respect to the word under the cursor.
3774 * \li Syntax: thesaurus-entry [<STRING>] [lang=<LANG>]
3775 * \li Params: <STRING>: word to look up
3776 <LANG>: language (see file languages)
3777 * \li Origin: Levon, 20 Jul 2001
3780 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
3783 * \var lyx::FuncCode lyx::LFUN_TOOLBAR_MOVABLE
3784 * \li Action: Toggles movability of a given toolbar between true/false.
3785 * \li Syntax: toolbar-movable <NAME>
3786 * \li Params: <NAME>: *|standard|extra|table|math|mathmacrotemplate|\n
3787 minibuffer|review|view/update|math_panels|vcs|
3788 view-others|update-others
3789 * \li Origin: daniel, 12 July 2016
3792 { LFUN_TOOLBAR_MOVABLE, "toolbar-movable", NoBuffer, Buffer },
3795 * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
3796 * \li Action: Toggles visibility of a given toolbar between on/off/auto.
3797 * \li Notion: Skipping "auto" when allowauto is false.
3798 * \li Syntax: toolbar-toggle <NAME> [allowauto]
3799 * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|\n
3800 minibuffer|review|view/update|math_panels|vcs|
3801 view-others|update-others
3802 * \li Origin: Edwin, 21 May 2007
3805 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
3808 * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
3809 * \li Action: Various UI visibility-toggling actions.
3810 * \li Syntax: ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
3811 * \li Params: statusbar : Toggle visibility of the statusbar.\n
3812 menubar : Toggle visibility of the menubar.\n
3813 scrollbar : Toggle visibility of the scrollbar.\n
3814 frame : Toggle visibility of the frames around editing window.\n
3815 fullscreen : Toggle fullscreen mode. This also covers calling the
3816 previous functions. However #LFUN_TOOLBAR_TOGGLE for the
3817 custom tweaks of the toolbars should be used.
3818 * \li Origin: sanda, 9 Feb 2007
3821 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
3825 * \var lyx::FuncCode lyx::LFUN_UNDO
3826 * \li Action: Undoes the last edit.
3830 { LFUN_UNDO, "undo", ReadOnly, Edit },
3833 * \var lyx::FuncCode lyx::LFUN_UNICODE_INSERT
3834 * \li Action: Inserts a single unicode character.
3835 * \li Syntax: unicode-insert <CHAR>
3836 * \li Params: <CHAR>: The character to insert, given as its code
3837 point, in hexadecimal.
3838 * \li Sample: unicode-insert 0x0100
3839 * \li Origin: Lgb, 22 Oct 2006
3842 { LFUN_UNICODE_INSERT, "unicode-insert", Noop, Edit },
3845 * \var lyx::FuncCode lyx::LFUN_UP
3846 * \li Action: Moves the cursor one line in upward direction.
3850 { LFUN_UP, "up", ReadOnly | NoUpdate, Edit },
3853 * \var lyx::FuncCode lyx::LFUN_UP_SELECT
3854 * \li Action: Moves the cursor one line in upward direction adding the current
3855 position to the selection.
3856 * \li Syntax: up-select
3859 { LFUN_UP_SELECT, "up-select", ReadOnly | SingleParUpdate, Edit },
3862 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_IN
3863 * \li Action: Checks-in/commits the changes of the registered file to the repository.
3864 * \li Notion: In RCS case this also unlocks the file.
3865 * \li Syntax: vc-check-in
3866 * \li Origin: Lgb, 1 Jul 1997
3869 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
3872 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_OUT
3873 * \li Action: Checks-out the document for edit (and locks it in some cases).
3874 * \li Syntax: vc-check-out
3875 * \li Origin: Lgb, 1 Jul 1997
3878 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
3881 * \var lyx::FuncCode lyx::LFUN_VC_COMMAND
3882 * \li Action: Executes external command. This command is intended to support
3883 additional VCS commands.
3884 * \li Syntax: vc-command <FLAG> <PATH> <COMMAND>
3885 * \li Params: <FLAG>: Flags for the command can be combined together.\n
3886 U - dUmmy - no flags \n
3887 D - Doc - need document loaded to proceed \n
3888 I - dIrty - mark document dirty \n
3889 R - Reload - ensure that the document is saved and reload it after command execution \n
3890 M - Message - ask for input string (commit message)\n
3891 <PATH>: path where to start. $$p will be replaced by the current document path.\n
3892 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current
3893 document(with absolute path)/path/message.
3894 * \li Sample: vc-command DR $$p "svn up"
3895 * \li Origin: sanda, 13 Jan 2009
3898 { LFUN_VC_COMMAND, "vc-command", NoBuffer | ReadOnly, System },
3901 * \var lyx::FuncCode lyx::LFUN_VC_COMPARE
3902 * \li Action: Compares two revisions of the same file under version control.
3903 * \li Syntax: vc-compare [<REV1>] [<REV2>]
3904 * \li Params: Revision number either points directly to commit in history
3905 or if negative number -x it points to (last commit - x).\n
3906 In RCS we subtract only in the last number of revision specification.
3907 Special case "0" is reserved for the last committed revision.\n
3908 <REV1>: Older file.\n
3909 <REV2>: Newer file. Used only if REV1 > 0.\n
3910 If no parameter is given, interactive dialog will be shown.
3911 * \li Sample: Compare current document against last commit\n
3913 Compare current document against current revision - 5 commits\n
3915 Compare revisions 120 and 155\n
3917 * \li Origin: sanda, 12 Feb 2010
3920 { LFUN_VC_COMPARE, "vc-compare", ReadOnly, System },
3924 * \var lyx::FuncCode lyx::LFUN_VC_COPY
3925 * \li Action: Copies the document to another name.
3926 * \li Notion: Copying with revision history is only supported by SVN.
3927 For RCS and CVS it is simulated by adding the document
3929 Disabled if uncommitted changes exist.
3930 * \li Syntax: vc-copy <FILENAME>
3931 * \li Params: <FILENAME>: New name of the document.\n
3932 * A file dialog is opened if no filename is given.
3933 * \li Origin: gb, 05 Feb 2013
3936 { LFUN_VC_COPY, "vc-copy", ReadOnly, System },
3939 * \var lyx::FuncCode lyx::LFUN_VC_LOCKING_TOGGLE
3940 * \li Action: Toggles the locking property of the edited file.
3941 * \li Notion: This is currently implemented only for SVN.
3942 * \li Syntax: vc-locking-toggle
3943 * \li Origin: sanda, 25 Jun 2009
3946 { LFUN_VC_LOCKING_TOGGLE, "vc-locking-toggle", ReadOnly, System },
3949 * \var lyx::FuncCode lyx::LFUN_VC_REGISTER
3950 * \li Action: Register the document as an file inside version control system.
3951 * \li Notion: File is registered inside cvs, svn or rcs repository acording to the existence
3952 of cvs/svn/rcs entries in the document's directory. \n
3953 See LyX Additional Features Manual (Version Control Chapter) for additional
3955 * \li Syntax: vc-register
3956 * \li Origin: Lgb, 1 Jul 1997
3959 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
3962 * \var lyx::FuncCode lyx::LFUN_VC_RENAME
3963 * \li Action: Renames the document to another name.
3964 * \li Notion: Renaming with revision history is only supported by SVN.
3965 For CVS it is simulated by adding the document under a new
3966 name and deleting the old one. For RCS it is not supported.
3967 Disabled if uncommitted changes exist.
3968 * \li Syntax: vc-rename <FILENAME>
3969 * \li Params: <FILENAME>: New name of the document.\n
3970 * A file dialog is opened if no filename is given.
3971 * \li Origin: gb, 05 Feb 2013
3974 { LFUN_VC_RENAME, "vc-rename", ReadOnly, System },
3977 * \var lyx::FuncCode lyx::LFUN_VC_REPO_UPDATE
3978 * \li Action: Update the local archive directory in which resides
3979 the current document with the remote repository.
3980 * \li Syntax: vc-repo-update
3981 * \li Origin: sanda, 16 Oct 2009
3984 { LFUN_VC_REPO_UPDATE, "vc-repo-update", ReadOnly, System },
3987 * \var lyx::FuncCode lyx::LFUN_VC_REVERT
3988 * \li Action: Reverts the document to the last check-in/commit in VCS.
3989 * \li Syntax: vc-revert
3990 * \li Origin: Lgb, 1 Jul 1997
3993 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
3996 * \var lyx::FuncCode lyx::LFUN_VC_UNDO_LAST
3997 * \li Action: Undo last check-in.
3998 * \li Notion: This is currently implemented only for RCS.
3999 * \li Syntax: vc-check-out
4000 * \li Origin: Lgb, 1 Jul 1997
4003 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
4006 * \var lyx::FuncCode lyx::LFUN_VIEW_CLOSE
4007 * \li Action: Close the current document work area.
4008 * \li Notion: Close the current work area. If no other work areas are showing the buffer,
4009 then close the associated buffer as well.
4010 * \li Syntax: view-close
4011 * \li Origin: Tommaso, 15 Sep 2012
4014 { LFUN_VIEW_CLOSE, "view-close", ReadOnly, Buffer },
4018 * \var lyx::FuncCode lyx::LFUN_VIEW_SPLIT
4019 * \li Action: Creates another split view of current buffer.
4020 * \li Notion: All split views act in the same way independently.
4021 * \li Syntax: view-split <vertical|horizontal>
4022 * \li Params: horizontal : The work areas are laid out side by side.\n
4023 vertical : The work areas laid out vertically.
4024 * \li Origin: Abdel, 20 Feb 2008
4027 { LFUN_VIEW_SPLIT, "view-split", ReadOnly, Buffer },
4031 * \var lyx::FuncCode lyx::LFUN_WINDOW_CLOSE
4032 * \li Action: Closes the current LyX window.
4033 * \li Syntax: window-close
4034 * \li Origin: Abdel, 23 Oct 2006
4037 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
4041 * \var lyx::FuncCode lyx::LFUN_WINDOW_NEW
4042 * \li Action: Creates new empty LyX window.
4043 * \li Notion: Already opened documents from the previous window can be found under View menu.
4044 * \li Syntax: window-new [<GEOMETRY>]
4045 * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently
4046 accepted only on Windows platform.
4047 * \li Origin: Abdel, 21 Oct 2006
4050 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
4053 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD
4054 * \li Action: Moves the cursor to the logically previous beginning of a word.
4055 * \li Notion: This is not the action which should be bound to the arrow keys,
4056 because backwards may be left or right, depending on the
4057 language. The arrow keys should be bound to #LFUN_WORD_LEFT or
4058 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
4059 * \li Syntax: word-backward
4062 { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit },
4065 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD_SELECT
4066 * \li Action: Moves the cursor to the logically previous beginning of a word,
4067 adding the logically traversed text to the selection.
4068 * \li Notion: See also #LFUN_WORD_BACKWARD.
4069 * \li Syntax: word-backward-select
4072 { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
4075 * \var lyx::FuncCode lyx::LFUN_WORD_CAPITALIZE
4076 * \li Action: Capitalizes the words in the selection (i.e. the first letters)
4077 or the first letter of word at cursor position.
4078 * \li Syntax: word-capitalize [<SEL_TYPE>]
4079 * \li Params: <SEL_TYPE>: if this is equal to "partial", then the
4080 * default word starts at cursor position (emacs-style).
4081 * Otherwise, the whole word is considered.
4084 { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
4087 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_BACKWARD
4088 * \li Action: Deletes characters to the beginning of the word (usually the "C+BackSpace" key).
4089 * \li Syntax: word-delete-backward [force]
4090 * \li Params: force: Delete big insets, do not only select them.
4093 { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
4096 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_FORWARD
4097 * \li Action: Deletes characters to the end of the word (usually the "C+Delete" key).
4098 * \li Syntax: word-delete-forward [force]
4099 * \li Params: force: Delete big insets, do not only select them.
4102 { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
4105 * \var lyx::FuncCode lyx::LFUN_WORD_FIND
4106 * \li Action: Search for next occurrence of a string.
4107 * \li Syntax: word-find [<DATA>]
4108 * \li Params: <DATA>: data encoded from Find dialog (see #lyx::find2string()).
4109 If no parameter is given, search with last find-dialog
4110 data is used for search (i.e. find-next).
4111 * \li Origin: Andre, Jan 7 2004
4114 { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
4117 * \var lyx::FuncCode lyx::LFUN_WORD_FINDADV
4118 * \li Action: Search for next occurrence of a pattern.
4119 * \li Syntax: word-findadv [<DATA>]
4120 * \li Params: <DATA>: data encoded from FindAdv dialog (see #lyx::findadv2string()).
4121 If no parameter is given, search with last find-dialog
4122 data is used for search (i.e. find-next).
4123 * \li Origin: Tommaso, Nov 15 2007
4126 { LFUN_WORD_FINDADV, "word-findadv", ReadOnly | NoBuffer, Edit },
4129 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_BACKWARD
4130 * \li Action: Search for a given string in backward direction.
4131 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
4132 * \li Syntax: word-find-backward [<STRING>]
4133 * \li Origin: Etienne, 20 Feb 1998
4136 { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
4139 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_FORWARD
4140 * \li Action: Search for a given string in forward direction.
4141 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
4142 * \li Syntax: word-find-forward [<STRING>]
4143 * \li Origin: Etienne, 16 Feb 1998
4146 { LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit },
4149 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD
4150 * \li Action: Moves the cursor to the logically next beginning of a word.
4151 * \li Notion: This is not the action which should be bound to the arrow keys,
4152 because forward may be left or right, depending on the language.
4153 The arrow keys should be bound to #LFUN_WORD_LEFT or
4154 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
4155 * \li Syntax: word-forward
4158 { LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
4161 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD_SELECT
4162 * \li Action: Moves the cursor to the logically next beginning of a word,
4163 adding the logically traversed text to the selection.
4164 * \li Notion: See also #LFUN_WORD_FORWARD.
4165 * \li Syntax: word-forward-select
4168 { LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
4171 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT
4172 * \li Action: Moves the cursor to the next beginning of a word "on the left".
4173 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
4174 "left" key is pressed. Generally, it moves the cursor to the
4175 next beginning of a word on the left. However, in Bidi text this
4176 become slightly more complicated, and there are different modes
4177 of cursor movement. In "visual mode", this moves left, plain and
4178 simple. In "logical mode", movement is logically forward in RTL
4179 paragraphs, and logically backwards in LTR paragraphs.
4180 * \li Syntax: word-left
4181 * \li Origin: dov, 28 Oct 2007
4184 { LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
4187 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT_SELECT
4188 * \li Action: Moves the cursor to the next beginning of a word "on the left",
4189 adding *logically* traversed text to the selection.
4190 * \li Notion: See also #LFUN_WORD_LEFT for exact details of the movement.
4191 * \li Syntax: word-left-select
4192 * \li Origin: dov, 28 Oct 2007
4195 { LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit },
4198 * \var lyx::FuncCode lyx::LFUN_WORD_LOWCASE
4199 * \li Action: Change the words in the selection or word at cursor position
4201 * \li Syntax: word-lowcase [<SEL_TYPE>]
4202 * \li Params: <SEL_TYPE>: if this is equal to "partial", then the
4203 * default word starts at cursor position (emacs-style).
4204 * Otherwise, the whole word is considered.
4207 { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
4210 * \var lyx::FuncCode lyx::LFUN_WORD_REPLACE
4211 * \li Action: Replace a string in the document.
4212 * \li Syntax: word-replace [<DATA>]
4213 * \li Params: <DATA>: data is of the form
4216 <casesensitive> <matchword> <all> <forward> <findnext>"
4217 * \li Origin: Andre, Jan 7 2004
4220 { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
4223 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT
4224 * \li Action: Moves the cursor to the next beginning of a word "on the right".
4225 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
4226 "right" key is pressed. Generally, it moves the cursor to the
4227 next beginning of a word on the right. However, in Bidi text
4228 this become slightly more complicated, and there are different
4229 modes of cursor movement. In "visual mode", this moves right,
4230 plain and simple. In "logical mode", movement is logically
4231 forward in LTR paragraphs, and logically backwards in RTL
4233 * \li Syntax: word-right
4234 * \li Origin: dov, 28 Oct 2007
4237 { LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit },
4240 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT_SELECT
4241 * \li Action: Moves the cursor to the next beginning of a word "on the right",
4242 adding *logically* traversed text to the selection.
4243 * \li Notion: See also #LFUN_WORD_RIGHT for exact details of the movement.
4244 * \li Syntax: word-right-select
4245 * \li Origin: dov, 28 Oct 2007
4248 { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
4251 * \var lyx::FuncCode lyx::LFUN_WORD_SELECT
4252 * \li Action: Puts the word where the cursor stands into the selection.
4253 * \li Syntax: word-select
4254 * \li Origin: Andre, 11 Sep 2002
4257 { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
4260 * \var lyx::FuncCode lyx::LFUN_WORD_UPCASE
4261 * \li Action: Change the words in the selection or word at cursor position
4263 * \li Syntax: word-upcase [<SEL_TYPE>]
4264 * \li Params: <SEL_TYPE>: if this is equal to "partial", then the
4265 * default word starts at cursor position (emacs-style).
4266 * Otherwise, the whole word is considered.
4269 { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
4272 * \var lyx::FuncCode lyx::LFUN_WRAP_INSERT
4273 * \li Action: Inserts floats wrapped by the text around.
4274 * \li Syntax: wrap-insert <TYPE>
4275 * \li Params: <TYPE>: table|figure
4276 * \li Origin: Dekel, 7 Apr 2002
4279 { LFUN_WRAP_INSERT, "wrap-insert", Noop, Edit },
4281 { LFUN_NOACTION, "", Noop, Hidden }
4282 #ifndef DOXYGEN_SHOULD_SKIP_THIS
4285 for (int i = 0; items[i].action != LFUN_NOACTION; ++i)
4286 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
4292 LyXAction::LyXAction()
4298 FuncRequest LyXAction::lookupFunc(string const & func) const
4300 string const func2 = trim(func);
4303 return FuncRequest(LFUN_NOACTION);
4306 string const arg = split(func2, cmd, ' ');
4308 FuncMap::const_iterator const fit = lyx_func_map.find(cmd);
4310 return fit != lyx_func_map.end()
4311 ? FuncRequest(fit->second, arg)
4312 : FuncRequest(LFUN_UNKNOWN_ACTION);
4316 string const LyXAction::getActionName(FuncCode action) const
4318 InfoMap::const_iterator const it = lyx_info_map.find(action);
4319 return it != lyx_info_map.end() ? it->second.name : string();
4323 LyXAction::FuncType LyXAction::getActionType(FuncCode action) const
4325 InfoMap::const_iterator const it = lyx_info_map.find(action);
4326 return it != lyx_info_map.end() ? it->second.type : Hidden;
4330 bool LyXAction::funcHasFlag(FuncCode action,
4331 LyXAction::FuncAttribs flag) const
4333 InfoMap::const_iterator ici = lyx_info_map.find(action);
4335 if (ici == lyx_info_map.end()) {
4336 LYXERR0("action: " << action << " is not known.");
4337 LASSERT(false, return false);
4340 return ici->second.attrib & flag;
4344 LyXAction::const_iterator LyXAction::func_begin() const
4346 return lyx_func_map.begin();
4350 LyXAction::const_iterator LyXAction::func_end() const
4352 return lyx_func_map.end();
4356 LyXErr & operator<<(LyXErr & l, FuncCode code)
4359 l.stream() << lyxaction.getActionName(code);