3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Lars Gullik Bjønnes
7 * \author Jean-Marc Lasgouttes
12 * Full author contact details are available in file CREDITS.
17 #include "LyXAction.h"
19 #include "FuncRequest.h"
21 #include "support/debug.h"
22 #include "support/lstrings.h"
24 #include "support/lassert.h"
29 using namespace lyx::support;
34 NAMING RULES FOR USER-COMMANDS
35 Here's the set of rules to apply when a new command name is introduced:
37 1) Use the object.event order. That is, use `word-forward'
38 instead of `forward-word'.
39 2) Don't introduce an alias for an already named object. Same for events.
40 3) Forward movement or focus is called `forward' (not `right').
41 4) Backward movement or focus is called `backward' (not `left').
42 5) Upward movement of focus is called `up'.
43 6) Downward movement is called `down'.
44 7) The begin of an object is called `begin' (not `start').
45 8) The end of an object is called `end'.
47 (May 19 1996, 12:04, RvdK)
52 * The documentation below primarily describes the purpose and syntax
53 * of the various LFUNs.
55 * The list is alphabetized. Try to keep it that way, and don't forget to add
56 * doxygen commentary. This allows the file LFUNs.lyx to be auto-generated.
57 * (If you should want to do that, see the gen_lfuns.py script, which is in
58 * the development/tools/ directory.)
60 * Doxygen template below. Some notes: Parameters should be set in uppercase
61 * and put in <BRACKETS>, [<PARAM>] means optional one.
63 * Use spaces for indentation (doxy -> .lyx generator is tab-sensitive).
67 * \var lyx::FuncCode lyx::LFUN_
80 void LyXAction::newFunc(FuncCode action, string const & name,
81 unsigned int attrib, LyXAction::FuncType type)
83 lyx_func_map[name] = action;
86 tmpinfo.attrib = attrib;
88 lyx_info_map[action] = tmpinfo;
92 // Needed for LFUNs documentation to be accepted, since doxygen won't take
93 // \var inside functions.
94 #ifndef DOXYGEN_SHOULD_SKIP_THIS
95 void LyXAction::init()
97 // This function was changed to use the array below in initalization
98 // instead of calling newFunc numerous times because of compilation
99 // times. Since the array is not static we get back the memory it
100 // occupies after the init is completed. It compiles several
101 // magnitudes faster.
114 ev_item const items[] = {
118 * \var lyx::FuncCode lyx::LFUN_ACCENT_ACUTE
119 * \li Action: Adds an acute accent \htmlonly (á)\endhtmlonly
120 to the next character typed.
121 * \li Syntax: accent-acute
124 { LFUN_ACCENT_ACUTE, "accent-acute", Noop, Edit },
127 * \var lyx::FuncCode lyx::LFUN_ACCENT_BREVE
128 * \li Action: Adds a breve accent \htmlonly (ă)\endhtmlonly
129 to the next character typed.
130 * \li Syntax: accent-breve
133 { LFUN_ACCENT_BREVE, "accent-breve", Noop, Edit },
136 * \var lyx::FuncCode lyx::LFUN_ACCENT_CARON
137 * \li Action: Adds a caron \htmlonly (ǎ)\endhtmlonly
138 to the next character typed.
139 * \li Syntax: accent-caron
142 { LFUN_ACCENT_CARON, "accent-caron", Noop, Edit },
145 * \var lyx::FuncCode lyx::LFUN_ACCENT_CEDILLA
146 * \li Action: Adds a cedilla \htmlonly (ç)\endhtmlonly
147 to the next character typed.
148 * \li Syntax: accent-cedilla
151 { LFUN_ACCENT_CEDILLA, "accent-cedilla", Noop, Edit },
154 * \var lyx::FuncCode lyx::LFUN_ACCENT_CIRCLE
155 * \li Action: Adds a circle accent \htmlonly (å)\endhtmlonly
156 to the next character typed.
157 * \li Syntax: accent-circle
160 { LFUN_ACCENT_CIRCLE, "accent-circle", Noop, Edit },
163 * \var lyx::FuncCode lyx::LFUN_ACCENT_CIRCUMFLEX
164 * \li Action: Adds a circumflex \htmlonly (ê)\endhtmlonly
165 to the next character typed.
166 * \li Syntax: accent-circumflex
169 { LFUN_ACCENT_CIRCUMFLEX, "accent-circumflex", Noop, Edit },
172 * \var lyx::FuncCode lyx::LFUN_ACCENT_DOT
173 * \li Action: Adds a dot accent \htmlonly (ż)\endhtmlonly
174 to the next character typed.
175 * \li Syntax: accent-dot
178 { LFUN_ACCENT_DOT, "accent-dot", Noop, Edit },
181 * \var lyx::FuncCode lyx::LFUN_ACCENT_GRAVE
182 * \li Action: Adds a grave accent \htmlonly (è)\endhtmlonly
183 to the next character typed.
184 * \li Syntax: accent-grave
187 { LFUN_ACCENT_GRAVE, "accent-grave", Noop, Edit },
190 * \var lyx::FuncCode lyx::LFUN_ACCENT_HUNGARIAN_UMLAUT
191 * \li Action: Adds a Hungarian umlaut \htmlonly (ő)\endhtmlonly
192 to the next character typed.
193 * \li Syntax: accent-grave
196 { LFUN_ACCENT_HUNGARIAN_UMLAUT, "accent-hungarian-umlaut", Noop, Edit },
199 * \var lyx::FuncCode lyx::LFUN_ACCENT_MACRON
200 * \li Action: Adds a macron \htmlonly (ā)\endhtmlonly
201 to the next character typed.
202 * \li Syntax: accent-macron
205 { LFUN_ACCENT_MACRON, "accent-macron", Noop, Edit },
208 * \var lyx::FuncCode lyx::LFUN_ACCENT_OGONEK
209 * \li Action: Adds an ogonek accent \htmlonly (ą)\endhtmlonly
210 to the next character typed.
211 * \li Syntax: accent-ogonek
214 { LFUN_ACCENT_OGONEK, "accent-ogonek", Noop, Edit },
217 * \var lyx::FuncCode lyx::LFUN_ACCENT_PERISPOMENI
218 * \li Action: Adds a perispomeni (Greek circumflex)
219 over the next character typed.
220 * \li Syntax: accent-perispomeni
223 { LFUN_ACCENT_PERISPOMENI, "accent-perispomeni", Noop, Edit },
226 * \var lyx::FuncCode lyx::LFUN_ACCENT_TIE
227 * \li Action: Adds a tie \htmlonly (a͡)\endhtmlonly
228 over the next two character typed.
229 * \li Notion: The following char will finish the tie.
230 * \li Syntax: accent-tie
233 { LFUN_ACCENT_TIE, "accent-tie", Noop, Edit },
236 * \var lyx::FuncCode lyx::LFUN_ACCENT_TILDE
237 * \li Action: Adds a tilde \htmlonly (ã)\endhtmlonly
238 over the next character typed.
239 * \li Syntax: accent-tilde
242 { LFUN_ACCENT_TILDE, "accent-tilde", Noop, Edit },
245 * \var lyx::FuncCode lyx::LFUN_ACCENT_UMLAUT
246 * \li Action: Adds an umlaut \htmlonly (ä)\endhtmlonly
247 over the next character typed.
248 * \li Syntax: accent-umlaut
251 { LFUN_ACCENT_UMLAUT, "accent-umlaut", Noop, Edit },
254 * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERBAR
255 * \li Action: Adds a bar \htmlonly (a̠)\endhtmlonly
256 under the next character typed.
257 * \li Syntax: accent-underbar
260 { LFUN_ACCENT_UNDERBAR, "accent-underbar", Noop, Edit },
263 * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERDOT
264 * \li Action: Adds a dot \htmlonly (ạ)\endhtmlonly
265 under the next character typed.
266 * \li Syntax: accent-underdot
269 { LFUN_ACCENT_UNDERDOT, "accent-underdot", Noop, Edit },
273 * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_ACCEPT
274 * \li Action: Accepts all tracked changes in the document.
275 * \li Syntax: all-changes-accept
276 * \li Origin: Levon, 16 Oct 2002
279 { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
282 * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_REJECT
283 * \li Action: Rejects all tracked changes in the document.
284 * \li Notion: Reject does not work recursively; the user may have to repeat the operation.
285 * \li Syntax: all-changes-reject
286 * \li Origin: Levon, 16 Oct 2002
289 { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
293 * \var lyx::FuncCode lyx::LFUN_APPENDIX
294 * \li Action: Start (or remove) Appendix on the given cursor position.
295 * \li Syntax: appendix
296 * \li Origin: ettrich, 5 May 1998
299 { LFUN_APPENDIX, "appendix", Noop, Edit },
303 * \var lyx::FuncCode lyx::LFUN_ARGUMENT_INSERT
304 * \li Action: Inserts an argument (short title) inset.
305 * \li Syntax: argument-insert <argument nr>
306 * \li Params: <argument nr>: see layout declarations
307 * \li Origin: vermeer, 12 Aug 2002
310 { LFUN_ARGUMENT_INSERT, "argument-insert", Noop, Edit },
313 * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_ADD
314 * \li Action: Adds database, which will be used for bibtex citations.
315 * \li Notion: Databases are added to the first BibTeX inset
316 (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
317 * \li Syntax: bibtex-database-add <DATABASE-NAME>
318 * \li Origin: Ale, 30 May 1997
321 { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit },
324 * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_DEL
325 * \li Action: Adds database, which will be used for bibtex citations.
326 * \li Notion: Databases are deleted from the first BibTeX inset
327 (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
328 * \li Syntax: bibtex-database-del <DATABASE-NAME>
329 * \li Origin: Ale, 30 May 1997
332 { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
336 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
337 * \li Action: Clears the list of saved bookmarks.
338 * \li Syntax: bookmark-clear
339 * \li Origin: bpeng, 31 October 2006
342 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
346 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
347 * \li Action: Moves the cursor to the numbered bookmark, opening the file
348 if necessary. Note that bookmarks are saved per-session, not
350 * \li Notion: Bookmark 0 has a special purpose. It is automatically set \n
351 1. to the paragraph you are currently editing \n
352 2. to the paragraph from where you are jumping to the last-edited
353 position (jump-back feature) \n
354 3. when jumping from crossreference to the requested label by
356 * \li Syntax: bookmark-goto <NUMBER>
357 * \li Params: <NUMBER>: the number of the bookmark to restore.
358 * \li Origin: Dekel, 27 January 2001
361 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
364 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
365 * \li Action: Save a bookmark.
366 * \li Notion: Saves a numbered bookmark to the sessions file. The number
367 must be between 1 and 9, inclusive. Note that bookmarks are
368 saved per-session, not per file.
369 * \li Syntax: bookmark-save <NUMBER>
370 * \li Params: <NUMBER>: the number of the bookmark to save.
371 * \li Origin: Dekel, 27 January 2001
374 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
377 * \var lyx::FuncCode lyx::LFUN_BOX_INSERT
378 * \li Action: Inserts Box inset.
379 * \li Syntax: box-insert [<TYPE>]
380 * \li Params: <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox \n
381 Framed is the default one.
382 * \li Origin: vermeer, 7 Oct 2003
385 { LFUN_BOX_INSERT, "box-insert", Noop, Edit },
388 * \var lyx::FuncCode lyx::LFUN_BRANCHES_RENAME
389 * \li Action: Rename all branches of a given name in a document.
390 * \li Syntax: branches-rename <OLDNAME> <NEWNAME>
391 * \li Params: <OLDNAME>: Current name of the branch to be renamed
392 * <NEWNAME>: New name of the branch
393 * \li Origin: spitz, 9 Jul 2009
396 { LFUN_BRANCHES_RENAME, "branches-rename", Noop, Buffer },
399 * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
400 * \li Action: Activate the branch.
401 * \li Syntax: branch-activate <BRANCH>
402 * \li Params: <BRANCH>: The branch to activate
403 * \li Sample: lyx -x "branch-activate answers" -e pdf2 finalexam.lyx \n
404 could be used to export a pdf with the answers branch included
405 without one's having to open LyX and activate the branch manually.
406 * \li Origin: rgh, 27 May 2008
409 { LFUN_BRANCH_ACTIVATE, "branch-activate", AtPoint, Buffer },
412 * \var lyx::FuncCode lyx::LFUN_BRANCH_ADD
413 * \li Action: Add a branch to the buffer's BranchList.
414 * \li Syntax: branch-add <BRANCH>
415 * \li Params: <BRANCH>: Name of the branch to add
416 * \li Origin: spitz, 7 Jul 2009
419 { LFUN_BRANCH_ADD, "branch-add", AtPoint, Buffer },
424 * \var lyx::FuncCode lyx::LFUN_BRANCH_ADD_INSERT
425 * \li Action: Create new branch and directly put the branch inset into
427 * \li Syntax: branch-add-insert [<NAME>]
428 * \li Params: <NAME>: Branch name. If it is not specified, you will be asked.
429 * \li Origin: sanda, 10 Jul 2009
432 { LFUN_BRANCH_ADD_INSERT, "branch-add-insert", Noop, Buffer },
437 * \var lyx::FuncCode lyx::LFUN_BRANCH_DEACTIVATE
438 * \li Action: De-activate the branch.
439 * \li Syntax: branch-deactivate <BRANCH>
440 * \li Params: <BRANCH>: The branch to deactivate
441 * \li Origin: rgh, 27 May 2008
444 { LFUN_BRANCH_DEACTIVATE, "branch-deactivate", AtPoint, Buffer },
447 * \var lyx::FuncCode lyx::LFUN_BRANCH_INSERT
448 * \li Action: Inserts branch inset.
449 * \li Syntax: branch-insert <BRANCH-NAME>
450 * \li Origin: vermeer, 17 Aug 2003
453 { LFUN_BRANCH_INSERT, "branch-insert", Noop, Edit },
456 * \var lyx::FuncCode lyx::LFUN_BRANCH_INVERT
457 * \li Action: Toggles inversion status of branch inset.
458 * \li Syntax: branch-invert
459 * \li Origin: rgheck, 12 July 2016
462 { LFUN_BRANCH_INVERT, "branch-invert", AtPoint, Buffer },
466 * \var lyx::FuncCode lyx::LFUN_BRANCH_MASTER_ACTIVATE
467 * \li Action: Activate the branch in the master buffer.
468 * \li Syntax: branch-master-activate <BRANCH>
469 * \li Params: <BRANCH>: The branch to activate
470 * \li Sample: lyx -x "branch-activate answers" -e pdf2 finalexam.lyx \n
471 could be used to export a pdf with the answers branch included
472 without one's having to open LyX and activate the branch manually.
473 * \li Origin: spitz, 30 Sep 2012
476 { LFUN_BRANCH_MASTER_ACTIVATE, "branch-master-activate", AtPoint, Buffer },
479 * \var lyx::FuncCode lyx::LFUN_BRANCH_MASTER_DEACTIVATE
480 * \li Action: De-activate the branch in the master buffer.
481 * \li Syntax: branch-master-deactivate <BRANCH>
482 * \li Params: <BRANCH>: The branch to deactivate
483 * \li Origin: spitz, 30 Sep 2012
486 { LFUN_BRANCH_MASTER_DEACTIVATE, "branch-master-deactivate", AtPoint, Buffer },
490 * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
491 * \li Action: Saves the current buffer to a temporary file.
492 * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
493 is called automatically by LyX, to "autosave" the current buffer.
494 * \li Syntax: buffer-auto-save
497 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
500 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN
501 * \li Action: Move the cursor to the beginning of the document.
502 * \li Syntax: buffer-begin
505 { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
508 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN_SELECT
509 * \li Action: Move the cursor to the beginning of the document adding the
510 traversed text to the selection.
511 * \li Syntax: buffer-begin-select
514 { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
517 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHILD_OPEN
518 * \li Action: Loads the given child document.
519 * \li Notion: The current document is treated as a parent.
520 * \li Syntax: buffer-child-open <FILE>
521 * \li Params: <FILE>: Filename of the child. The directory of the parent is assumed by default.
522 * \li Origin: Ale, 28 May 1997
525 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
528 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHKTEX
529 * \li Action: Runs chktex for the current document.
530 * \li Syntax: buffer-chktex
531 * \li Origin: Asger, 30 Oct 1997
534 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
537 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
538 * \li Action: Closes the current buffer.
539 * \li Notion: Closes the current buffer, asking whether to save it, etc,
540 if the buffer has been modified.
541 * \li Syntax: buffer-close
544 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
547 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE_ALL
548 * \li Action: Closes all buffers.
549 * \li Notion: Closes all buffers, asking whether to save it, etc,
550 if a buffer has been modified.
551 * \li Syntax: buffer-close-all
554 { LFUN_BUFFER_CLOSE_ALL, "buffer-close-all", ReadOnly, Buffer },
557 * \var lyx::FuncCode lyx::LFUN_BUFFER_END
558 * \li Action: Move the cursor to the end of the document.
559 * \li Syntax: buffer-end
562 { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
565 * \var lyx::FuncCode lyx::LFUN_BUFFER_END_SELECT
566 * \li Action: Move the cursor to the end of the document adding the
567 traversed text to the selection.
568 * \li Syntax: buffer-end-select
571 { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
575 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
576 * \li Action: Exports the current buffer (document) to the given format.
577 * \li Syntax: buffer-export [<FORMAT>] [<DEST>]
578 * \li Params: <FORMAT> is either "custom" or one of the formats which you
579 can find in Tools->Preferences->File formats->Format.
580 Usual format you will enter is "pdf2" (pdflatex),
581 "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
582 In case of "custom" you will be asked for a format you
583 want to start from and for the command that you want to
584 apply to this format. Internally the control is then passed
585 to #LFUN_BUFFER_EXPORT_CUSTOM.\n
586 If absent or "default", then the default output format of the
588 <DEST> If present, this argument provides the export destination
589 filename. Its containing folder will also be the destination
590 folder, where all the needed external files will be copied.
591 * \li Origin: Lgb, 29 Jul 1997
594 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
597 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_AS
598 * \li Action: Opens a dialog for exporting the current buffer.
599 * \li Syntax: buffer-export-as [<FORMAT>]
600 * \li Params: <FORMAT> is the export format initially selected in the dialog.
601 * You can pass any of the formats which you can find in
602 * Tools->Preferences->File formats->Format, provided it
603 * has the "document" flag set. If no format is specified
604 * the dialog will start with the default output format of
605 * the current document.
606 * \li Sample: buffer-export-as pdf2
607 * \li Origin: tommaso, 6 Oct 2011
610 { LFUN_BUFFER_EXPORT_AS, "buffer-export-as", ReadOnly, Buffer },
613 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
614 * \li Action: Exports the current buffer (document) from the given format using
615 the given command on it.
616 * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
617 * \li Params: <FORMAT> format to start from (LyX will care to produce such
618 intermediate file).\n
619 <COMMAND> this command will be launched on the file. Note that you can
620 use "$$FName" string to qualify the intermediate file.
621 * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
622 * \li Origin: leeming, 27 Mar 2004
625 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
628 * \var lyx::FuncCode lyx::LFUN_BUFFER_FORALL
629 * \li Action: Applies a command to all non-hidden buffers.
630 * \li Notion: a buffer is `hidden' if it is internally open in LyX, but not
631 visible in any window.
632 * \li Syntax: buffer-forall <LFUN-COMMAND>
633 * \li Params: <LFUN-COMMAND>: The command to be applied to the buffers.
634 * \li Sample: Close all Notes in buffers: \n
635 buffer-forall inset-forall Note inset-toggle close \n
636 Toggle change tracking on buffers: \n
637 buffer-forall changes-track \n
638 Toggle read-only for buffers: \n
639 buffer-forall buffer-toggle-read-only \n
640 Show statistics for individual buffers: \n
641 buffer-forall statistics \n
642 Activate the branch named "Solutions" in buffers: \n
643 buffer-forall branch-activate Solutions \n
644 Export buffers to PDF (pdflatex): \n
645 buffer-forall buffer-export pdf2 \n
646 * \li Origin: skostysh, 20 Jul 2012
649 { LFUN_BUFFER_FORALL, "buffer-forall", ReadOnly | Argument, Buffer },
652 * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
653 * \li Action: Import a given file as a lyx document.
654 * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
655 defined converters in preferences. Look in the File->Import menu to get
656 an idea of the currently active import formats.
657 * \li Syntax: buffer-import <FORMAT> [<FILE>]
658 * \li Origin: Asger, 24 Jul 1998
661 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
664 * \var lyx::FuncCode lyx::LFUN_BUFFER_LANGUAGE
665 * \li Action: Set language of the current document.
666 * \li Syntax: buffer-language <LANG>
667 * \li Params: <LANG>: language name. See lib/languages for list.
668 * \li Origin: leeming, 30 Mar 2004
671 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
674 * \var lyx::FuncCode lyx::LFUN_BUFFER_MOVE_NEXT
675 * \li Action: Moves the current tab one spot to the right.
676 * \li Syntax: buffer-move-next
677 * \li Origin: skostysh, 7 Apr 2015
680 { LFUN_BUFFER_MOVE_NEXT, "buffer-move-next", ReadOnly, Buffer },
683 * \var lyx::FuncCode lyx::LFUN_BUFFER_MOVE_PREVIOUS
684 * \li Action: Moves the current tab one spot to the left.
685 * \li Syntax: buffer-move-previous
686 * \li Origin: skostysh, 7 Apr 2015
689 { LFUN_BUFFER_MOVE_PREVIOUS, "buffer-move-previous", ReadOnly, Buffer },
692 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
693 * \li Action: Creates a new buffer (that is, document) and switches to it.
694 * \li Notion: Implicit path can be set in Preferences dialog.
695 * \li Syntax: buffer-new [<FILE>]
696 * \li Params: <FILE>: filename of created file with absolute path.
699 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
702 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
703 * \li Action: Creates a new buffer (that is, document) from a template.
704 * \li Notion: Path for new files and templates can be set in Preferences dialog.
705 Template will be asked for via Open-dialog.
706 * \li Syntax: buffer-new-template [<FILE>]
707 * \li Params: <FILE>: filename of created file with absolute path.
710 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
713 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEXT
714 * \li Action: Switch to the next opened document.
715 * \li Notion: Note that this does not necessarily mean next in tabbar
716 (for full list see View menu).
717 * \li Syntax: buffer-next
720 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
723 * \var lyx::FuncCode lyx::LFUN_BUFFER_PARAMS_APPLY
724 * \li Action: Apply the given settings to the current document.
725 * \li Syntax: buffer-params-apply [<ARGS>]
726 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
727 you can find in document header of usual .lyx file.
728 * \li Origin: leeming, 30 Mar 2004
731 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", NoInternal, Buffer },
735 * \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS
736 * \li Action: Switch to the previous opened document.
737 * \li Syntax: buffer-previous
740 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
743 * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
744 * \li Action: Reverts opened document.
745 * \li Syntax: buffer-reload
746 * \li Origin: Asger, 2 Feb 1997
749 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
752 * \var lyx::FuncCode lyx::LFUN_BUFFER_SAVE_AS_DEFAULT
753 * \li Action: Save the current document settings as default.
754 * \li Notion: The file will will be saved into ~/.lyx/templates/defaults.lyx .
755 * \li Syntax: buffer-save-as-default [<ARGS>]
756 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
757 you can find in document header of usual .lyx file.
758 * \li Origin: leeming, 30 Mar 2004
761 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
764 * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
765 * \li Action: Display and switch to the given buffer.
766 * \li Syntax: buffer-switch <BUFFER>
767 * \li Params: <BUFFER>: path and filename of already opened (but possibly hidden)
768 document which is to be shown.
771 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
774 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
775 * \li Action: Toggles compression of the current document on/off.
776 * \li Syntax: buffer-toggle-compression
777 * \li Origin: bpeng, 27 Apr 2006
780 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
783 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_OUTPUT_SYNC
784 * \li Action: Toggles including of resources for forward/reverse search of the given document.
785 * \li Notion: When toggled on, SyncTeX is invoked for PDF, while srcltx package
786 is used for DVI. Custom LaTeX macro can be defined in preferences.
787 * \li Syntax: buffer-toggle-output-sync
788 * \li Origin: sanda, 25 May 2010
791 { LFUN_BUFFER_TOGGLE_OUTPUT_SYNC, "buffer-toggle-output-sync", Noop, System },
794 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
795 * \li Action: Toggle editing mode of the current document between read/write and read-only.
796 * \li Notion: This function is not allowed if the file is under version control, since
797 read-only flag is often used in version control file locking.
798 * \li Syntax: buffer-toggle-read-only
799 * \li Origin: Lgb, 27 May 1997
802 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
805 * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
806 * \li Action: Exports the current document and put the result into the
808 * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
809 the output will be rewritten - updated. This is useful in case your viewer
810 is able to detect such changes (e.g. ghostview for postscript).
811 * \li Syntax: buffer-update [<FORMAT>]
812 * \li Params: <FORMAT>: The format to display, where this is one of the
813 formats defined (in the current GUI) in the
814 Tools>Preferences>File Formats dialog.
815 If no format is given, the default format as
816 specified in the same dialog is used.
817 * \li Origin: Dekel, 5 Aug 2000
820 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
824 * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
825 * \li Action: Displays current buffer in chosen format.
826 * \li Notion: Displays the contents of the current buffer in the chosen
827 format, for example, PDF or DVI. This runs the necessary
828 converter, calls the defined viewer, and so forth.
829 * \li Syntax: buffer-view [<FORMAT>]
830 * \li Params: <FORMAT>: The format to display, where this is one of the
831 formats defined (in the current GUI) in the
832 Tools>Preferences>File Formats dialog.
833 If no format is given, the default format as
834 specified in the same dialog is used.
837 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
840 * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW_CACHE
841 * \li Action: Opens the file that was created from last preview of this buffer.
842 * \li Notion: This LFUN is called by the "Show Output Anyway" button in the LaTeX
843 * Errors dialog. It can also be called by the user, which is useful
844 * if the document takes a long time to compile, and you just
845 * want to see the last previewed version.
846 * \li Syntax: buffer-view-cache
849 { LFUN_BUFFER_VIEW_CACHE, "buffer-view-cache", ReadOnly, Buffer },
852 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
853 * \li Action: Saves the current buffer.
854 * \li Notion: Saves the current buffer to disk, using the filename that
855 is already associated with the buffer, asking for one if
856 none is yet assigned.
857 * \li Syntax: buffer-write
860 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
863 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
864 * \li Action: Save all changed documents.
865 * \li Syntax: buffer-write-all
866 * \li Origin: rgh, gpothier 6 Aug 2007
869 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
872 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
873 * \li Action: Rename and save current buffer.
874 * \li Syntax: buffer-write-as <FILENAME>
875 * \li Params: <FILENAME>: New name of the buffer/file. A relative path
876 is with respect to the original location of the buffer/file.
879 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
882 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXTERNAL_MODIFICATION_CLEAR
883 * \li Action: Clear the external modification flag on the current buffer.
884 * \li Syntax: buffer-external-modification-clear
885 * \li Origin: gm, 2 March 2017
888 { LFUN_BUFFER_EXTERNAL_MODIFICATION_CLEAR,
889 "buffer-external-modification-clear", ReadOnly, Buffer },
892 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_IN
893 * \li Action: Increases the zoom of the screen fonts.
894 * \li Syntax: buffer-zoom-in [<ZOOM>]
895 * \li Params: <ZOOM>: The zoom in % points (neg. or pos.), the default is 20.
896 * \li Origin: vfr, 30 Mar 2009
899 { LFUN_BUFFER_ZOOM_IN, "buffer-zoom-in", ReadOnly, Buffer },
903 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_OUT
904 * \li Action: Decreases the zoom of the screen fonts.
905 * \li Syntax: buffer-zoom-out [<ZOOM>]
906 * \li Params: <ZOOM>: The zoom in % points (neg. or pos.), the default is -20.
907 * \li Origin: vfr, 30 Mar 2009
910 { LFUN_BUFFER_ZOOM_OUT, "buffer-zoom-out", ReadOnly, Buffer },
914 * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
915 * \li Action: Generates the code (literate programming).
916 * \li Notion: Latex file with extension \literate_extension is generated.
917 Then LyX invokes \build_command (with a default of ``make'') to generate the code and
918 \build_error_filter to process the compilation error messages. \n
919 In case you want to process your literate file with a script, or some other program,
920 just insert in your lyxrc file an entry with:\n
921 \build_command "my_script my_arguments" \n
922 The \build_error_filter differs from the \literate_error_filter only in that the
923 former will identify error messages from your compiler.
924 * \li Syntax: build-program
927 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
931 * \var lyx::FuncCode lyx::LFUN_CALL
932 * \li Action: Executes a command defined in a .def file.
933 * \li Notion: The definitions are by default read from lib/commands/default.def.\n
934 A .def file allows to define a command with \define "<NAME>" "<LFUN>"
935 where <NAME> is the name of the new command and <LFUN> is the lfun code
936 to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
937 \def_file "FileName" allows to include another .def file. \n
938 This is particularly useful in connection with toolbar buttons:
939 Since the name of the button image for this lfun is
940 lib/images/commands/<NAME>.png this is the way to assign an image
941 to a complex command-sequence.
942 * \li Syntax: call <NAME>
943 * \li Params: <NAME>: Name of the command that must be called.
944 * \li Origin: broider, 2 Oct 2007
947 { LFUN_CALL, "call", NoBuffer, System },
950 * \var lyx::FuncCode lyx::LFUN_CANCEL
951 * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
955 { LFUN_CANCEL, "cancel", NoBuffer, System },
959 * \var lyx::FuncCode lyx::LFUN_CAPTION_INSERT
960 * \li Action: Inserts a caption inset.
961 * \li Syntax: caption-insert
962 * \li Origin: Lgb, 18 Jul 2000
965 { LFUN_CAPTION_INSERT, "caption-insert", Noop, Edit },
968 * \var lyx::FuncCode lyx::LFUN_CELL_BACKWARD
969 * \li Action: Moves the cursor to the previous cell inside the table.
970 * \li Syntax: cell-backward
971 * \li Origin: Jug, 22 May 2000
974 { LFUN_CELL_BACKWARD, "cell-backward", ReadOnly | NoUpdate, Edit },
977 * \var lyx::FuncCode lyx::LFUN_CELL_FORWARD
978 * \li Action: Moves the cursor to the next cell inside the table.
979 * \li Syntax: cell-forward
982 { LFUN_CELL_FORWARD, "cell-forward", ReadOnly | NoUpdate, Edit },
985 * \var lyx::FuncCode lyx::LFUN_CELL_SPLIT
986 * \li Action: Splits cell and shifts right part to the next cell (inside the math grid).
987 * \li Syntax: cell-split
988 * \li Origin: Ale, 15 May 1997
991 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
995 * \var lyx::FuncCode lyx::LFUN_CHANGES_MERGE
996 * \li Action: Open change tracking dialog for merging and moves the cursor
997 to the position of the next change.
998 * \li Syntax: changes-merge
999 * \li Origin: Levon, 16 Oct 2002
1002 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
1005 * \var lyx::FuncCode lyx::LFUN_CHANGES_OUTPUT
1006 * \li Action: Toggles showing of change tracking in typeset output.
1007 * \li Syntax: changes-output
1008 * \li Origin: jspitzm, 21 Jan 2005
1011 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
1014 * \var lyx::FuncCode lyx::LFUN_CHANGES_TRACK
1015 * \li Action: Toggles change tracking to on/off.
1016 * \li Syntax: changes-track
1017 * \li Origin: levon, 1 Oct 2002
1020 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
1023 * \var lyx::FuncCode lyx::LFUN_CHANGE_ACCEPT
1024 * \li Action: Accepts tracked change inside the selection.
1025 * \li Syntax: change-accept
1026 * \li Origin: Levon, 16 Oct 2002
1029 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
1032 * \var lyx::FuncCode lyx::LFUN_CHANGE_NEXT
1033 * \li Action: Moves the cursor to the position of the next change
1034 of the change tracking records.
1035 * \li Syntax: change-next
1036 * \li Origin: schmitt, 4 Oct 2006
1039 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
1042 * \var lyx::FuncCode lyx::LFUN_CHANGE_PREVIOUS
1043 * \li Action: Moves the cursor to the position of the previous change
1044 of the change tracking records.
1045 * \li Syntax: change-previous
1046 * \li Origin: vfr, 4 Apr 2009
1049 { LFUN_CHANGE_PREVIOUS, "change-previous", ReadOnly, Edit },
1052 * \var lyx::FuncCode lyx::LFUN_CHANGE_REJECT
1053 * \li Action: Rejects tracked change inside the selection.
1054 * \li Syntax: change-reject
1055 * \li Origin: Levon, 16 Oct 2002
1058 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
1061 * \var lyx::FuncCode lyx::LFUN_CHARS_TRANSPOSE
1062 * \li Action: Transposes the character at the cursor with the one before it.
1063 * \li Syntax: chars-transpose
1064 * \li Origin: Lgb, 25 Apr 2001
1067 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
1071 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD
1072 * \li Action: Moves the cursor one position logically backwards.
1073 * \li Notion: This is not the action which should be bound to the arrow keys,
1074 because backwards may be left or right, depending on the
1075 language. The arrow keys should be bound to #LFUN_CHAR_LEFT or
1076 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
1077 * \li Syntax: char-backward
1080 { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit },
1083 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD_SELECT
1084 * \li Action: Moves the cursor one position logically backwards, adding
1085 traversed position to the selection.
1086 * \li Notion: See also #LFUN_CHAR_BACKWARD.
1087 * \li Syntax: char-backward-select
1090 { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit },
1093 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_BACKWARD
1094 * \li Action: Deletes one character in the backward direction (usually the "BackSpace" key).
1095 * \li Syntax: char-delete-backward [force]
1096 * \li Params: force: Delete big insets, do no only select them.
1099 { LFUN_CHAR_DELETE_BACKWARD, "char-delete-backward", SingleParUpdate, Edit },
1102 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_FORWARD
1103 * \li Action: Deletes one character in the backward direction (usually the "Delete" key).
1104 * \li Syntax: char-delete-forward [force]
1105 * \li Params: force: Delete big insets, do no only select them.
1108 { LFUN_CHAR_DELETE_FORWARD, "char-delete-forward", SingleParUpdate, Edit },
1111 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD
1112 * \li Action: Moves the cursor one position logically forward.
1113 * \li Notion: This is not the action which should be bound to the arrow keys,
1114 because forward may be left or right, depending on the language.
1115 The arrow keys should be bound to #LFUN_CHAR_LEFT or
1116 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
1117 * \li Syntax: char-forward
1120 { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit },
1123 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD_SELECT
1124 * \li Action: Moves the cursor one position logically forward, adding
1125 traversed position to the selection.
1126 * \li Notion: See also #LFUN_CHAR_FORWARD.
1127 * \li Syntax: char-forward-select
1130 { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit },
1133 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT
1134 * \li Action: Moves the cursor one position "to the left".
1135 * \li Notion: This is the action which should be taken when the "left" key
1136 is pressed. Generally, it moves the cursor one position to the
1137 left. However, in Bidi text this become slightly more
1138 complicated, and there are different modes of cursor movement.
1139 In "visual mode", this moves left, plain and simple. In "logical
1140 mode", movement is logically forward in RTL paragraphs, and
1141 logically backwards in LTR paragraphs.
1142 * \li Syntax: char-left
1145 { LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit },
1148 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT_SELECT
1149 * \li Action: Moves the cursor one position "to the left", adding
1150 traversed position to the selection.
1151 * \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement.
1152 * \li Syntax: char-left-select
1155 { LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit },
1158 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT
1159 * \li Action: Moves the cursor one position "to the right".
1160 * \li Notion: This is the action which should be taken when the "right" key
1161 is pressed. Generally, it moves the cursor one position to the
1162 right. However, in Bidi text this become slightly more
1163 complicated, and there are different modes of cursor movement.
1164 In "visual mode", this moves right, plain and simple. In "logical
1165 mode", movement is logically forward in LTR paragraphs, and
1166 logically backwards in RTL paragraphs.
1167 * \li Syntax: char-right
1170 { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit },
1173 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT_SELECT
1174 * \li Action: Moves the cursor one position "to the right", adding
1175 traversed position to the selection.
1176 * \li Notion: See also #LFUN_CHAR_RIGHT for exact details of the movement.
1177 * \li Syntax: char-right-select
1180 { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit },
1184 * \var lyx::FuncCode lyx::LFUN_CITATION_INSERT
1185 * \li Action: Inserts citation from loaded citation database.
1186 * \li Syntax: citation-insert [<KEY>[|<TEXT_BEFORE>]]
1187 * \li Params: <KEY>: Citation (shortcut listed in available citations). \n
1188 <TEXT_BEFORE>: text which should appear before citation.
1189 * \li Origin: AAS, 97-02-23
1192 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
1195 * \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE
1196 * \li Action: Pastes text from the active clipboard (retains formatting if the
1197 clipboard contains formatted text). Pastes plain text if plain text is
1198 on the clipboard, but tries to interpret it in special ways for certain
1199 insets, e.g. converting csv data to rows and columns if the paste happens
1201 * \li Notion: Historically, LFUN_CLIPBOARD_PASTE was introduced as a counterpart of
1202 LFUN_PRIMARY_SELECTION_PASTE: It behaved exactly the same, but the source
1203 is the clipboard, not the selection.
1204 * \li Syntax: clipboard-paste [<ARG>]
1205 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1206 * \li Origin: Georg, 10 Jul 2006
1209 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
1212 * \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE_SIMPLE
1213 * \li Action: Pastes plain text from the active clipboard even if formatted
1214 LyX content is in the clipboard. Pastes plain text if plain text
1215 is on the clipboard, without trying to interpret it in special
1216 ways for certain insets, e.g. converting csv data to rows and
1217 columns if the paste happens in a tabular inset.
1218 * \li Syntax: clipboard-paste-simple [<ARG>]
1219 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1222 { LFUN_CLIPBOARD_PASTE_SIMPLE, "clipboard-paste-simple", Noop, Edit },
1225 * \var lyx::FuncCode lyx::LFUN_COMMAND_ALTERNATIVES
1226 * \li Action: Runs the first listed command that is enabled.
1227 * \li Notion: This can be used to bind multiple functions to a single key,
1228 and then which one is used will depend upon the context.
1229 * \li Syntax: command-alternatives <CMDS>
1230 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
1231 * \li Sample: command-alternatives completion-accept;cell-forward
1232 * \li Origin: rgh, 24 September 2008
1235 { LFUN_COMMAND_ALTERNATIVES, "command-alternatives", NoBuffer, System },
1238 * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
1239 * \li Action: Switches the focus to the minibuffer so that the user can type
1240 in there. If necessary, it opens the minibuffer toolbar.
1241 * \li Notion: Usually bound to M-x shortcut.
1242 * \li Syntax: command-execute
1245 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
1249 * \var lyx::FuncCode lyx::LFUN_COMMAND_PREFIX
1250 * \li Action: Return the current key sequence and available options as a string.
1251 * \li Notion: No options are added if no current map exists. \n
1252 This is probably usable only with connection to lyxserver.
1253 * \li Syntax: command-prefix
1256 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
1259 * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
1260 * \li Action: Run more commands (LFUN and its parameters) in a sequence.
1261 * \li Syntax: command-sequence <CMDS>
1262 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
1263 * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
1264 * \li Origin: Andre, 11 Nov 1999
1267 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
1270 * \var lyx::FuncCode lyx::LFUN_COMPLETE
1271 * \li Action: Try to complete the word or command at the cursor position.
1272 * \li Syntax: complete
1273 * \li Origin: sts, Feb 19 2008
1276 { LFUN_COMPLETE, "complete", SingleParUpdate, Edit },
1280 * \var lyx::FuncCode lyx::LFUN_COMPLETION_ACCEPT
1281 * \li Action: Accept suggested completion.
1282 * \li Syntax: completion-accept
1283 * \li Origin: sanda, Sep 08 2008
1286 { LFUN_COMPLETION_ACCEPT, "completion-accept", SingleParUpdate, Edit },
1291 * \var lyx::FuncCode lyx::LFUN_COMPLETION_CANCEL
1292 * \li Action: Try to cancel completion, either the popup or the inline completion.
1293 * \li Syntax: completion-cancel
1294 * \li Origin: sts, Sep 07 2008
1297 { LFUN_COMPLETION_CANCEL, "completion-cancel", SingleParUpdate, Edit },
1300 * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
1301 * \li Action: Show the inline completion at the cursor position.
1302 * \li Syntax: completion-inline
1303 * \li Origin: sts, Feb 19 2008
1306 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
1309 * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
1310 * \li Action: Show the completion popup at the cursor position.
1311 * \li Syntax: completion-popup
1312 * \li Origin: sts, Feb 19 2008
1315 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
1318 * \var lyx::FuncCode lyx::LFUN_COPY
1319 * \li Action: Copies the current selection to the clipboard.
1323 { LFUN_COPY, "copy", ReadOnly, Edit },
1326 * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
1327 * \li Action: Determine whether to keep cursor inside the editing window regardless
1328 of the scrollbar movement.
1329 * \li Syntax: toggle-cursor-follows-scrollbar
1330 * \li Origin: ARRae, 2 Dec 1997
1333 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
1336 * \var lyx::FuncCode lyx::LFUN_CUT
1337 * \li Action: Cuts to the clipboard.
1341 { LFUN_CUT, "cut", Noop, Edit },
1344 * \var lyx::FuncCode lyx::LFUN_DATE_INSERT
1345 * \li Action: Inserts the current date.
1346 * \li Syntax: date-insert [<ARG>]
1347 * \li Params: <ARG>: Format of date. The default value (%x) can be set
1348 in Preferences->Date format. For possible formats
1349 see manual page of strftime function.
1350 * \li Origin: jdblair, 31 Jan 2000
1353 { LFUN_DATE_INSERT, "date-insert", Noop, Edit },
1356 * \var lyx::FuncCode lyx::LFUN_DEBUG_LEVEL_SET
1357 * \li Action: Set debug output level.
1358 * \li Syntax: debug-level-set <LEVEL>
1359 * \li Params: <LEVEL>: comma separated list of levels or the correspondent number
1360 of their combination. 0 is equivalent to disabling all debug
1361 events. See lyx -dbg for the current list of debug levels
1363 * \li Origin: sanda, 28 Dec 2009
1366 { LFUN_DEBUG_LEVEL_SET, "debug-level-set", NoBuffer, System },
1370 * \var lyx::FuncCode lyx::LFUN_DEPTH_DECREMENT
1371 * \li Action: Decrease the nesting depth of the (selected) paragraph(s)
1373 * \li Syntax: depth-decrement
1376 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
1379 * \var lyx::FuncCode lyx::LFUN_DEPTH_INCREMENT
1380 * \li Action: Increase the nesting depth of the (selected) paragraph(s)
1382 * \li Syntax: depth-increment
1385 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
1389 * \var lyx::FuncCode lyx::LFUN_DIALOG_DISCONNECT_INSET
1390 * \li Action: Closes opened connection to opened inset.
1391 * \li Notion: Connection is used for apply functions.
1392 * \li Syntax: dialog-disconnect-inset <INSET-NAME>
1393 * \li Origin: leeming, 25 Feb 2003
1396 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
1400 * \var lyx::FuncCode lyx::LFUN_DIALOG_HIDE
1401 * \li Action: Hides showed dialog. Counterpart to #LFUN_DIALOG_SHOW .
1402 * \li Syntax: dialog-hide <NAME>
1403 * \li Params: See #LFUN_DIALOG_SHOW .
1404 * \li Origin: leeming, 25 Feb 2003
1407 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
1410 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW
1411 * \li Action: Shows hidden dialog or creates new one for a given function/inset settings etc.
1412 * \li Syntax: dialog-show <NAME> [<DATA>]
1413 * \li Params: <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|\n
1414 compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|\n
1415 graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimiter|\n
1416 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|\n
1417 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|\n
1418 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL> \n
1419 <SPECIAL>: latexlog|vclog \n
1420 <DATA>: data, usually settings for the given dialog. Use debug mode for the
1422 * \li Origin: leeming, 17 Jun 2003
1425 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
1428 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW_NEW_INSET
1429 * \li Action: Shows hidden dialog or create new one for a given inset settings etc.
1430 * \li Notion: Internally uses #LFUN_DIALOG_SHOW with processed data for a given inset.
1431 * \li Syntax: dialog-show-new-inset <NAME> [<DATA>]
1432 * \li Params: See #LFUN_DIALOG_SHOW .
1433 * \li Origin: leeming, 25 Feb 2003
1436 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
1439 * \var lyx::FuncCode lyx::LFUN_DIALOG_TOGGLE
1440 * \li Action: Toggles dialog between showed/hidden state.
1441 * \li Notion: Internally uses #LFUN_DIALOG_SHOW , #LFUN_DIALOG_HIDE .
1442 * \li Syntax: dialog-toggle <NAME> [<DATA>]
1443 * \li Params: See #LFUN_DIALOG_SHOW .
1444 * \li Origin: JSpitzm, 30 Apr 2007
1447 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
1450 * \var lyx::FuncCode lyx::LFUN_DIALOG_UPDATE
1451 * \li Action: Updates the dialog values from the inset/paragraph/document.
1452 * \li Syntax: dialog-update <NAME>
1453 * \li Params: <NAME>: paragraph|prefs|<INSET> \n
1455 * \li Origin: leeming, 25 Feb 2003
1458 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
1461 * \var lyx::FuncCode lyx::LFUN_DOWN
1462 * \li Action: Moves the cursor one line in downward direction.
1466 { LFUN_DOWN, "down", ReadOnly | NoUpdate, Edit },
1469 * \var lyx::FuncCode lyx::LFUN_DOWN_SELECT
1470 * \li Action: Moves the cursor one line in downward direction adding the current
1471 position to the selection.
1472 * \li Syntax: down-select
1475 { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, Edit },
1478 * \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE
1479 * \li Action: Displays list of layout choices.
1480 * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
1481 dropbox allowing for choice of layout.
1482 * \li Syntax: drop-layouts-choice
1485 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
1488 * \var lyx::FuncCode lyx::LFUN_ENVIRONMENT_SPLIT
1489 * \li Action: Splits the current environment with a Separator.
1490 * \li Syntax: environment-split [outer]
1491 * \li Params: outer: If this is given, LyX will split the outermost environment in
1492 * the current nesting hierarchy.
1493 * \li Origin: spitz, 23 Dec 2012
1496 { LFUN_ENVIRONMENT_SPLIT, "environment-split", Noop, Layout },
1500 * \var lyx::FuncCode lyx::LFUN_ERT_INSERT
1501 * \li Action: Inserts an ERT inset.
1502 * \li Syntax: ert-insert
1503 * \li Origin: Jug, 18 Feb 2000
1506 { LFUN_ERT_INSERT, "ert-insert", Noop, Edit },
1509 * \var lyx::FuncCode lyx::LFUN_ESCAPE
1510 * \li Action: Clears the selection. If no text is selected call #LFUN_FINISHED_FORWARD.
1511 Inside math mode jumps out of the math inset.
1512 * \li Syntax: escape
1513 * \li Origin: Lgb, 17 May 2001
1516 { LFUN_ESCAPE, "escape", ReadOnly, Edit },
1519 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
1520 * \li Action: Inserts another LyX file.
1521 * \li Syntax: file-insert [<FILE>]
1522 * \li Params: <FILE>: Filename to be inserted.
1525 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
1528 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
1529 * \li Action: Inserts plain text file.
1530 * \li Syntax: file-insert-plaintext [<FILE>]
1531 * \li Params: <FILE>: Filename to be inserted.
1532 * \li Origin: CFO-G, 19 Nov 1997
1535 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
1538 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
1539 * \li Action: Inserts plain text file as paragraph (i.e. join lines).
1540 * \li Syntax: file-insert-plaintext-para [<FILE>]
1541 * \li Params: <FILE>: Filename to be inserted.
1542 * \li Origin: Levon, 14 Feb 2001
1545 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
1548 * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
1549 * \li Action: Open LyX document.
1550 * \li Syntax: file-open [<FILE>]
1551 * \li Params: <FILE>: Filename to be opened.
1554 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
1558 * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
1559 * \li Action: Moves the cursor out of the current slice, going backwards.
1560 * \li Notion: See also #LFUN_FINISHED_FORWARD.
1563 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
1566 * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
1567 * \li Action: Moves the cursor out of the current slice, going forward.
1568 * \li Notion: Cursor movement within an inset may be different than cursor
1569 movement in the surrounding text. This action should be called
1570 automatically by the cursor movement within the inset, when
1571 movement within the inset has ceased (reached the end of the
1572 last paragraph, for example), in order to move correctly
1573 back into the surrounding text.
1576 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
1579 * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
1580 * \li Action: Moves the cursor out of the current slice, going left.
1581 * \li Notion: See also #LFUN_FINISHED_FORWARD.
1584 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
1588 * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
1589 * \li Action: Moves the cursor out of the current slice, going right.
1590 * \li Notion: See also #LFUN_FINISHED_FORWARD
1593 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
1596 * \var lyx::FuncCode lyx::LFUN_FLEX_INSERT
1597 * \li Action: Inserts CharStyle, Custom inset or XML short element.
1598 * \li Notion: Look into the Customization manual for more information about
1600 To make this command enabled the layout file for the document
1601 class you're using has to load the character styles. There are
1602 a few contained in the Logical Markup module. You can also of
1603 course create some yourself. \n
1604 For dissolving the element see #LFUN_INSET_DISSOLVE.
1605 * \li Syntax: flex-insert Name
1606 * \li Params: Name: This name must be defined either in your layout file
1607 or imported by some module. The definition is
1608 InsetLayout Name or InsetLayout <Flex:Name>. The Flex:
1610 * \li Sample: flex-insert Code
1613 { LFUN_FLEX_INSERT, "flex-insert", Noop, Edit },
1616 * \var lyx::FuncCode lyx::LFUN_FLOAT_INSERT
1617 * \li Action: Inserts a float inset.
1618 * \li Syntax: float-insert <TYPE>
1619 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
1620 "algorithm", "table", "figure" parameters can be given.
1621 * \li Origin: Lgb, 27 Jun 2000
1624 { LFUN_FLOAT_INSERT, "float-insert", Noop, Edit },
1627 * \var lyx::FuncCode lyx::LFUN_FLOAT_LIST_INSERT
1628 * \li Action: Inserts the list of floats in the document.
1629 * \li Syntax: float-list-insert <TYPE>
1630 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
1631 "algorithm", "table", "figure" parameters can be given.
1632 * \li Origin: Lgb, 3 May 2001
1635 { LFUN_FLOAT_LIST_INSERT, "float-list-insert", Noop, Edit },
1638 * \var lyx::FuncCode lyx::LFUN_FLOAT_WIDE_INSERT
1639 * \li Action: Inserts float insets as in #LFUN_FLOAT_INSERT but span multiple columns.
1640 * \li Notion: Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
1641 * \li Syntax: float-wide-insert <TYPE>
1642 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
1643 "algorithm", "table", "figure" parameters can be given.
1644 * \li Origin: Lgb, 31 Oct 2001
1647 { LFUN_FLOAT_WIDE_INSERT, "float-wide-insert", Noop, Edit },
1650 * \var lyx::FuncCode lyx::LFUN_FONT_BOLD
1651 * \li Action: Toggles the bold font (selection-wise) using mathbf in math.
1652 * \li Syntax: font-bold
1655 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
1659 * \var lyx::FuncCode lyx::LFUN_FONT_BOLDSYMBOL
1660 * \li Action: Toggles the bold font (selection-wise) using boldsymbol in math.
1661 * \li Syntax: font-boldsymbol
1664 { LFUN_FONT_BOLDSYMBOL, "font-boldsymbol", Noop, Layout },
1667 * \var lyx::FuncCode lyx::LFUN_FONT_DEFAULT
1668 * \li Action: Reverts the settings of the font to the default values (selection-wise).
1669 * \li Syntax: font-default
1672 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
1675 * \var lyx::FuncCode lyx::LFUN_FONT_EMPH
1676 * \li Action: Toggles the emphasis font style (selection-wise).
1677 * \li Syntax: font-emph
1680 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
1683 * \var lyx::FuncCode lyx::LFUN_FONT_FRAK
1684 * \li Action: Toggles Fraktur family font (math-mode, selection-wise).
1685 * \li Syntax: font-frak
1686 * \li Origin: vermeer, 10 Jan 2002
1689 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
1692 * \var lyx::FuncCode lyx::LFUN_FONT_ITAL
1693 * \li Action: Toggles Italics font shape (math-mode, selection-wise).
1694 * \li Syntax: font-ital
1695 * \li Origin: vermeer, 10 Jan 2002
1698 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
1701 * \var lyx::FuncCode lyx::LFUN_FONT_NOUN
1702 * \li Action: Toggles Noun text style font (selection-wise).
1703 * \li Syntax: font-noun
1706 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
1709 * \var lyx::FuncCode lyx::LFUN_FONT_ROMAN
1710 * \li Action: Toggles Roman family font (selection-wise).
1711 * \li Syntax: font-roman
1714 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
1717 * \var lyx::FuncCode lyx::LFUN_FONT_SANS
1718 * \li Action: Toggles Sans Serif family font (selection-wise).
1719 * \li Syntax: font-sans
1722 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
1725 * \var lyx::FuncCode lyx::LFUN_FONT_SIZE
1726 * \li Action: Sets font size according to lyx format string.
1727 * \li Syntax: font-size <SIZE>
1728 * \li Params: <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|\n
1729 largest|huge|giant|increase|decrease|default
1732 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
1735 * \var lyx::FuncCode lyx::LFUN_FONT_STATE
1736 * \li Action: Returns the info about the current font.
1737 * \li Syntax: font-state
1740 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
1744 * \var lyx::FuncCode lyx::LFUN_FONT_STRIKEOUT
1745 * \li Action: Toggles strikeout (strike-through) in the font (selection-wise).
1746 * \li Syntax: font-strikeout
1747 * \li Origin: sanda, 3 May 2009
1750 { LFUN_FONT_STRIKEOUT, "font-strikeout", Noop, Layout },
1753 * \var lyx::FuncCode lyx::LFUN_FONT_TYPEWRITER
1754 * \li Action: Toggles the typewriter family font (selection-wise).
1755 * \li Syntax: font-typewriter
1758 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
1761 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERLINE
1762 * \li Action: Toggles underline in the font (selection-wise).
1763 * \li Syntax: font-underline
1766 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
1769 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERUNDERLINE
1770 * \li Action: Toggles double underline in the font (selection-wise).
1771 * \li Syntax: font-underunderline
1772 * \li Origin: sanda, 5 May 2009
1775 { LFUN_FONT_UNDERUNDERLINE, "font-underunderline", Noop, Layout },
1778 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERWAVE
1779 * \li Action: Toggles wavy underline in the font (selection-wise).
1780 * \li Syntax: font-underwave
1781 * \li Origin: sanda, 5 May 2009
1784 { LFUN_FONT_UNDERWAVE, "font-underwave", Noop, Layout },
1787 * \var lyx::FuncCode lyx::LFUN_FOOTNOTE_INSERT
1788 * \li Action: Inserts a footnote inset.
1789 * \li Syntax: footnote-insert
1790 * \li Origin: Jug, 7 Mar 2000
1793 { LFUN_FOOTNOTE_INSERT, "footnote-insert", Noop, Edit },
1796 * \var lyx::FuncCode lyx::LFUN_FORWARD_SEARCH
1797 * \li Action: Sets the cursor position in the previewed (dvi/pdf) file based on the row
1798 number in LyX window.
1799 * \li Notion: The external program used for forward search call can be specified in
1800 LyX Output preferences. See Additional manual for details of these
1802 * \li Syntax: forward-search
1803 * \li Origin: sanda, 14 Apr 2010
1806 { LFUN_FORWARD_SEARCH, "forward-search", ReadOnly, System },
1809 * \var lyx::FuncCode lyx::LFUN_GRAPHICS_RELOAD
1810 * \li Action: Reloads the image if necessary.
1811 * \li Syntax: graphics-reload
1812 * \li Origin: vfr, 10 Aug 2009
1815 { LFUN_GRAPHICS_RELOAD, "graphics-reload", ReadOnly | AtPoint, Edit },
1818 * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
1819 * \li Action: Open the given help file according to the language setting.
1820 * \li Syntax: help-open <FILE>[.lyx]
1821 * \li Params: <FILE>: any document from (/usr/share/)doc directory.
1822 * \li Origin: Jug, 27 Jun 1999
1825 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
1828 * \var lyx::FuncCode lyx::LFUN_HREF_INSERT
1829 * \li Action: Inserts hyperlinks into the document (clickable in pdf output).
1830 * \li Notion: Hyperlink target can be set via selection + hyperlink-insert function.
1831 * \li Syntax: href-insert [<TARGET>]
1832 * \li Origin: CFO-G, 21 Nov 1997
1835 { LFUN_HREF_INSERT, "href-insert", Noop, Edit },
1838 * \var lyx::FuncCode lyx::LFUN_ICON_SIZE
1839 * \li Action: Sets icon size of toolbars.
1840 * \li Syntax: icon-size [<SIZE>]
1841 * \li Params: <SIZE> : the icon size in px or one of the logical settings
1842 small|normal|big|huge|giant, the default is normal
1843 (whose size in px is icon set dependent).
1844 * \li Origin: 11 July 2016
1847 { LFUN_ICON_SIZE, "icon-size", NoBuffer, Buffer },
1850 * \var lyx::FuncCode lyx::LFUN_INDEX_INSERT
1851 * \li Action: Inserts Index entry.
1852 * \li Notion: It automatically takes the word on the cursor position.
1853 * \li Syntax: index-insert [<TYPE:Name>]
1854 * \li Params: <TYPE:Name>: name of the index, if multiple indices are defined.
1855 With an empty argument, the default index is selected.
1856 * \li Origin: leeming, 3 Aug 2000
1859 { LFUN_INDEX_INSERT, "index-insert", Noop, Edit },
1862 * \var lyx::FuncCode lyx::LFUN_INDEX_PRINT
1863 * \li Action: Inserts list of Index entries on a new page.
1864 * \li Syntax: index-print [<TYPE:Name>]
1865 * \li Params: <TYPE:Name>: name of the index, if multiple indices are defined.
1866 With an empty argument, the default index is selected.
1867 * \li Origin: Lgb, 27 Feb 1997
1870 { LFUN_INDEX_PRINT, "index-print", Noop, Edit },
1873 * \var lyx::FuncCode lyx::LFUN_INFO_INSERT
1874 * \li Action: Displays shortcuts, lyxrc, package and textclass availability and menu
1875 information in a non-editable boxed InsetText.
1876 * \li Notion: Apart from lfun arguments you can use the following method: \n
1877 1. input the type and argument of this inset, e.g. "menu paste", in
1879 2. select the text and run info-insert lfun.
1880 * \li Syntax: info-insert <TYPE> <ARG>
1881 * \li Params: <TYPE>: shortcut[s]|lyxrc|lyxinfo|package|textclass|menu|buffer \n
1882 <ARG>: argument for a given type. Look into InsetInfo.h for detailed
1884 shortcut[s]: name of lfun (e.g math-insert \alpha) \n
1885 lyxrc: name of rc_entry (e.g. bind_file) \n
1886 lyxinfo: "version" - used version of LyX \n
1887 package: name of latex package (e.g. listings) \n
1888 textclass: name of textclass (e.g. article) \n
1889 menu: name of lfun used in menu \n
1890 icon: icon of lfun used in toolbar or direct icon name\n
1891 buffer: "name"|"path"|"class"|"vcs-tree-revision"|
1892 "vcs-revision"|"vcs-author"|"vcs-date"|"vcs-time"
1893 * \li Sample: command-sequence info-insert buffer path; info-insert buffer name
1894 * \li Origin: bpeng, 7 Oct 2007
1897 { LFUN_INFO_INSERT, "info-insert", Noop, Edit },
1900 * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
1901 * \li Action: Apply data for an inset.
1902 * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
1903 be applied. This is either changed to #LFUN_INSET_MODIFY or
1904 #LFUN_INSET_INSERT depending on the context where it is called.
1905 * \li Syntax: inset-apply <ARGS>
1906 * \li Params: See #LFUN_INSET_INSERT .
1909 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
1912 * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN
1913 * \li Action: Move the cursor to the beginning of the current inset
1914 if it is not already there, or at the beginning of the
1915 enclosing inset otherwise
1916 * \li Syntax: inset-begin
1917 * \li Origin: lasgouttes, 16 Mar 2009
1920 { LFUN_INSET_BEGIN, "inset-begin", ReadOnly, Edit },
1923 * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN_SELECT
1924 * \li Action: Move the cursor to the beginning of the current inset
1925 if it is not already there, or at the beginning of the
1926 enclosing inset otherwise (adding the
1927 traversed text to the selection).
1928 * \li Syntax: inset-begin-select
1929 * \li Origin: lasgouttes, 16 Mar 2009
1932 { LFUN_INSET_BEGIN_SELECT, "inset-begin-select", ReadOnly, Edit },
1935 * \var lyx::FuncCode lyx::LFUN_INSET_COPY_AS
1936 * \li Action: Copies the inset to the clipboard as a certain type.
1937 * \li Notion: Currently used only for InsetInfo where its content is copied as a text.
1938 * \li Syntax: inset-copy-as
1939 * \li Origin: vfr, 18 Apr 2010
1942 { LFUN_INSET_COPY_AS, "inset-copy-as", ReadOnly | NoUpdate | AtPoint, Edit },
1946 * \var lyx::FuncCode lyx::LFUN_INSET_DIALOG_UPDATE
1947 * \li Action: Updates the values inside the dialog from the inset.
1948 * \li Notion: This is an internal LFUN, not to be used by users. Called internally
1949 by #LFUN_DIALOG_UPDATE
1950 * \li Params: <DIALOG-NAME>
1951 * \li Origin: leeming, 25 Feb 2003
1954 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
1957 * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE
1958 * \li Action: Dissolve the current inset into text.
1959 * \li Syntax: inset-dissolve [<INSET>]
1960 * \li Params: <INSET>: this can be used to make sure the right kind of inset
1961 is dissolved. For example "dissolve" entry in the charstyles
1962 sub-menu should only dissolve the charstyle inset, even if the
1963 cursor is inside several nested insets of different type.\n
1964 For values see #lyx::InsetLayout::lyxtype_ .
1965 * \li Origin: JSpitz, 7 Aug 2006
1968 { LFUN_INSET_DISSOLVE, "inset-dissolve", AtPoint, Edit },
1971 * \var lyx::FuncCode lyx::LFUN_INSET_EDIT
1972 * \li Action: Edit the inset at cursor with an external application,
1973 if one is attributed.
1974 * \li Syntax: inset-edit [<INSET_PARAMS>]
1975 * \li Params: <INSET_PARAMS>: Parameters for the inset. \n
1976 Currently only the filename will be considered.
1977 * \li Origin: JSpitzm, 27 Apr 2006
1980 { LFUN_INSET_EDIT, "inset-edit", ReadOnly | AtPoint, Edit },
1984 * \var lyx::FuncCode lyx::LFUN_INSET_END
1985 * \li Action: Move the cursor to the end of the current inset
1986 if it is not already there, or at the end of the
1987 enclosing inset otherwise
1988 * \li Syntax: inset-end
1989 * \li Origin: lasgouttes, 16 Mar 2009
1992 { LFUN_INSET_END, "inset-end", ReadOnly, Edit },
1995 * \var lyx::FuncCode lyx::LFUN_INSET_END_SELECT
1996 * \li Action: Move the cursor to the end of the current inset
1997 if it is not already there, or at the end of the
1998 enclosing inset otherwise (adding the
1999 traversed text to the selection).
2000 * \li Syntax: inset-end-select
2001 * \li Origin: lasgouttes, 16 Mar 2009
2004 { LFUN_INSET_END_SELECT, "inset-end-select", ReadOnly, Edit },
2008 * \var lyx::FuncCode lyx::LFUN_INSET_FORALL
2009 * \li Action: Apply the given commands on insets of a given name.
2010 * \li Notion: WARNING: use at your own risks; this function gives
2011 you too many ways of shooting yourself in the foot.
2012 A typical example is
2013 inset-forall Note note-insert
2014 which starts an infinite loop. This is mitigated by the fact
2015 that the number of actions is arbitrarily limited to 100000.
2016 Note also that inset-forall does not update metrics between
2017 iterations, which can lead to bugs. This has to be eventually
2019 * \li Syntax: inset-forall <NAME> <LFUN-COMMAND> \n
2020 <NAME>: Type of Inset. If <NAME> is *, all insets are matched.
2021 The name is used like for InsetLayout in layout files: "Note"
2022 matches all note insets, while "Note:Note" only matches LyX
2024 * \li Sample: Remove all index insets: \n
2025 inset-forall Index char-delete-forward \n
2026 Close all Notes (also works for a particular branch, for example): \n
2027 inset-forall Note inset-toggle close \n
2028 Transform all yellow notes to comments \n
2029 inset-forall Note:Note inset-modify note Note Comment \n
2030 Try to put LyX in an infinite loop if there is at least a Note: \n
2031 inset-forall Note char-backward
2032 * \li Origin: lasgouttes, 27 Nov 2009
2035 { LFUN_INSET_FORALL, "inset-forall", ReadOnly, Edit },
2039 * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
2040 * \li Action: Insert new inset (type given by the parameters).
2041 * \li Syntax: inset-insert <INSET> <ARGS>
2042 * \li Params: <INSET>: <bibitem|bibtex|citation|ert|listings|external|graphics|tabular|\n
2043 hyperlink|include|index|label|line|nomencl|vspace|ref|toc|script>\n
2044 <ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
2045 * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
2046 where <label name> is the name of the referenced label and
2047 <Format> is one of the following: \n
2048 ref -- <reference> \n
2049 eqref -- (<reference>) \n
2050 pageref -- <page> \n
2051 vpageref -- on <page> \n
2052 vref -- <reference> on <page> \n
2053 formatted -- Formatted reference
2056 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
2059 * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
2060 * \li Action: Modify some properties of an inset.
2061 * \li Notion: Used for argument, bibitem, bibtex, box, branch, caption, citation,
2062 command, ert, external, float, graphics, include, index,
2063 info, label, line, listings, newline, newpage, nomencl,
2064 note, phantom, quotes, ref, script, separator, space,
2065 tabular, vspace and wrap insets.
2066 * \li Syntax: inset-modify <INSET> <ARGS> \n
2067 inset-modify changetype <TYPE>
2068 * \li Sample: Change a Note inset into a Comment inset: \n
2069 inset-modify note Note Comment \n
2070 Change a Box into an Ovalbox: \n
2071 inset-modify changetype Ovalbox \n
2072 Change a quotation mark to e[nglish style], l[eft side = opening], s[ingle = inner, secondary] \n
2073 inset-modify changetype els \n
2074 Change only the style of a quotation mark, maintaining the other aspects (. = wildcard) \n
2075 inset-modify changetype e.. \n
2078 { LFUN_INSET_MODIFY, "inset-modify", AtPoint, Edit },
2081 * \var lyx::FuncCode lyx::LFUN_INSET_SELECT_ALL
2082 * \li Action: Select all contents of an inset.
2083 * \li Notion: There are 3 successive levels: select current cell,
2084 * select all cells of inset, select the inset from outside
2085 * (in the enclosing inset).
2086 * \li Syntax: inset-select-all
2087 * \li Origin: vfr, 22 Aug 2009; lasgouttes 1 Nov 2014
2090 { LFUN_INSET_SELECT_ALL, "inset-select-all", ReadOnly, Edit },
2094 * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
2095 * \li Action: Open the inset's properties dialog.
2096 * \li Notion: Used for bibitem, bibtex, box, branch, citation, ert, external,
2097 float, graphics, href, include, index, index_print, label, line,
2098 listings, note, phantom, ref, space, tabular, vspace, wrap insets.
2099 * \li Syntax: inset-settings <INSET>
2100 * \li Params: <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|\n
2101 graphics|href|include|index|index_print|label|line|\n
2102 listings|note|phantom|ref|space|tabular|vspace|wrap>.
2105 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly | AtPoint, Edit },
2108 * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
2109 * \li Action: Toggles the collapsible inset at cursor position,
2110 or the inset we are currently in.
2111 * \li Syntax: inset-toggle [<ARG>]
2112 * \li Params: <ARG>: <open|close|toggle|assign>. \n
2113 open/close/toggle are for collapsible insets. toggle is used when no argument is given.\n
2114 assign synchronize the branch-inset with activation status of the branch.
2115 Used for global toggling when changed activation.
2116 * \li Origin: lasgouttes, 19 Jul 2001
2119 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly | AtPoint, Edit },
2122 * \var lyx::FuncCode lyx::LFUN_IN_IPA
2123 * \li Action: Only active in IPA inset.
2124 * \li Notion: Dummy function which is only active in a IPA inset.
2125 It's used to toggle the IPA toolbar if the cursor moves
2127 * \li Syntax: in-ipa
2128 * \li Origin: spitz, 20 May 2012
2131 { LFUN_IN_IPA, "in-ipa", Noop, Edit },
2134 * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
2135 * \li Action: Only active in Math Macro definition.
2136 * \li Notion: Dummy function which is only active in a Math Macro definition.
2137 It's used to toggle the Math Macro toolbar if the cursor moves
2138 into a Math Macro definition.
2139 * \li Syntax: in-mathmacrotemplate
2140 * \li Origin: sts, 06 January 2008
2143 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
2147 * \var lyx::FuncCode lyx::LFUN_IPAMACRO_INSERT
2148 * \li Action: Inserts special IPA macros into the document.
2149 * \li Syntax: ipamacro-insert <CHAR>
2150 * \li Params: <CHAR>: tone-falling, tone-rising, tone-high-rising, tone-low-rising,
2151 * tone-high-rising-falling, deco bottomtiebar, deco toptiebar.
2152 * \li Origin: JSpitzm, 22 Aug 2012
2155 { LFUN_IPAMACRO_INSERT, "ipamacro-insert", Noop, Edit },
2158 * \var lyx::FuncCode lyx::LFUN_IPA_INSERT
2159 * \li Action: Inserts an IPA inset.
2160 * \li Syntax: ipa-insert
2161 * \li Origin: spitz, 05 Mar 2012
2164 { LFUN_IPA_INSERT, "ipa-insert", Noop, Edit },
2167 * \var lyx::FuncCode lyx::LFUN_KEYMAP_OFF
2168 * \li Action: Turn off the loaded keyboard map.
2169 * \li Syntax: keymap-off
2172 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
2175 * \var lyx::FuncCode lyx::LFUN_KEYMAP_PRIMARY
2176 * \li Action: Turn on the primary keyboard map.
2177 * \li Notion: Maps were widely used in past, when X-windows didn't have nowadays
2178 keyboard support. They can be still used to maintain uniform keyboard
2179 layout across the various platforms.\n
2180 The language is to be set in the Preferences dialog.
2181 * \li Syntax: keymap-primary
2184 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
2187 * \var lyx::FuncCode lyx::LFUN_KEYMAP_SECONDARY
2188 * \li Action: Turn on the secondary keyboard map.
2189 * \li Syntax: keymap-secondary
2192 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
2195 * \var lyx::FuncCode lyx::LFUN_KEYMAP_TOGGLE
2196 * \li Action: Toggles keyboard maps (first/second/off).
2197 * \li Syntax: keymap-toggle
2198 * \li Origin: leeming, 30 Mar 2004
2201 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
2205 * \var lyx::FuncCode lyx::LFUN_LABEL_COPY_AS_REF
2206 * \li Action: Copies the label at the cursor as a cross-reference to be pasted elsewhere.
2207 * \li Syntax: copy-label-as-reference <LABEL>
2208 * \li Params: <LABEL>: The label to copy (for multi-line math)
2209 * \li Origin: sts, 16 Nov 2008
2212 { LFUN_LABEL_COPY_AS_REFERENCE, "label-copy-as-reference",
2213 ReadOnly | NoUpdate | AtPoint, Edit },
2217 * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
2218 * \li Action: Goto a label.
2219 * \li Syntax: label-goto [<LABEL>]
2220 * \li Params: <LABEL>: Requested label. If no label is given and reference
2221 is on cursor position, Bookmark 0 is saved and
2222 cursor moves to the position of referenced label.
2223 * \li Origin: Ale, 6 Aug 1997
2226 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
2229 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT
2230 * \li Action: Inserts label to text or displayed formula.
2231 * \li Syntax: label-insert [<LABEL>]
2232 * \li Params: <LABEL>: Requested label. If no label is given dialog requesting
2233 name will be opened.
2236 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
2239 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT_AS_REFERENCE
2240 * \li Action: Inserts the label (in ToC pane) as a cross-reference at the position of the cursor.
2241 * \li Syntax: label-insert-as-reference
2242 * \li Origin: vfr, 7 Apr 2009
2245 { LFUN_LABEL_INSERT_AS_REFERENCE, "label-insert-as-reference", Noop, Edit},
2249 * \var lyx::FuncCode lyx::LFUN_LANGUAGE
2250 * \li Action: Set language from the current cursor position.
2251 * \li Syntax: language <LANG> [set]
2252 * \li Params: <LANG>: Requested language. Look in lib/languages for
2253 the list. "language reset" or "language" (without param)
2254 reset to the document language.
2255 set: If used, the language will be set to the specified
2256 language. Otherwise, the language will be toggled (i.e., if
2257 the current language is LANG, switch to the document language
2258 or the default language, if LANG is the document language).
2259 * \li Origin: Dekel, 2 Mar 2000
2262 { LFUN_LANGUAGE, "language", Noop, Edit },
2266 * \var lyx::FuncCode lyx::LFUN_LAYOUT
2267 * \li Action: Sets the layout (that is, environment) for the current paragraph.
2268 * \li Syntax: layout <LAYOUT>
2269 * \li Params: <LAYOUT>: the layout to use
2272 { LFUN_LAYOUT, "layout", Noop, Layout },
2275 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
2276 * \li Action: Clears the module list.
2277 * \li Notion: Clears the list of included modules for the current buffer.
2278 * \li Syntax: layout-modules-clear
2279 * \li Origin: rgh, 25 August 2007
2282 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", NoInternal, Layout },
2285 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULE_ADD
2286 * \li Action: Adds a module.
2287 * \li Notion: Adds a module to the list of included modules for the current buffer.
2288 * \li Syntax: layout-module-add <MODULE>
2289 * \li Params: <MODULE>: the module to be added
2290 * \li Origin: rgh, 25 August 2007
2293 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", NoInternal, Layout },
2296 * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH
2297 * \li Action: Launches the paragraph settings dialog.
2298 * \li Syntax: layout-paragraph
2301 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
2304 * \var lyx::FuncCode lyx::LFUN_LAYOUT_RELOAD
2305 * \li Action: Reloads layout information.
2306 * \li Notion: Reloads all layout information for the current buffer from disk, thus
2307 recognizing any changes that have been made to layout files on the fly.
2308 This is intended to be used only by layout developers and should not be
2309 used when one is trying to do actual work.
2310 * \li Syntax: layout-reload
2311 * \li Origin: rgh, 3 September 2007
2314 { LFUN_LAYOUT_RELOAD, "layout-reload", NoInternal, Layout },
2317 * \var lyx::FuncCode lyx::LFUN_LAYOUT_TABULAR
2318 * \li Action: Launches the tabular settings dialog.
2319 * \li Syntax: layout-tabular
2320 * \li Origin: Jug, 31 Jul 2000
2323 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
2326 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN
2327 * \li Action: Move the cursor to the beginning of the (screen) line.
2328 * \li Syntax: line-begin
2331 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
2334 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN_SELECT
2335 * \li Action: Move the cursor to the beginning of the (screen) line adding the
2336 traversed text to the selection.
2337 * \li Syntax: line-begin-select
2340 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
2343 * \var lyx::FuncCode lyx::LFUN_LINE_DELETE_FORWARD
2344 * \li Action: Deletes the letters to the end of the (screen) line or
2345 deletes the selection.
2346 * \li Syntax: line-delete-forward
2349 { LFUN_LINE_DELETE_FORWARD, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
2352 * \var lyx::FuncCode lyx::LFUN_LINE_END
2353 * \li Action: Move the cursor to the end of the (screen) line.
2354 * \li Syntax: line-end
2357 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
2360 * \var lyx::FuncCode lyx::LFUN_LINE_END_SELECT
2361 * \li Action: Move the cursor to the end of the (screen) line adding the
2362 traversed text to the selection.
2363 * \li Syntax: line-end-select
2366 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
2369 * \var lyx::FuncCode lyx::LFUN_LISTING_INSERT
2370 * \li Action: Inserts a new listings inset.
2371 * \li Syntax: listing-insert
2372 * \li Origin: Herbert, 10 Nov 2001; bpeng, 2 May 2007
2375 { LFUN_LISTING_INSERT, "listing-insert", Noop, Edit },
2378 * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
2379 * \li Action: Apply the given settings to user preferences.
2380 * \li Syntax: lyxrc-apply <SETTINGS>
2381 * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
2382 to get an idea which commands to use and their syntax.
2383 #lyx::LyXRC::LyXRCTags has the list of possible commands.
2386 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
2389 * \var lyx::FuncCode lyx::LFUN_LYX_ACTIVATE
2390 * \li Action: Activates the LyX window.
2391 * \li Notion: On Linux and Mac OS, this action brings the LyX window
2392 into focus. Such behavior is not allowed by Windows OS
2393 so instead the color of the taskbar entry is changed to
2394 indicate that the window has changed in some way.
2395 This action is useful in combination with reverse search.
2396 * \li Syntax: lyx-activate
2397 * \li Origin: skostysh, 4 Aug 2016
2400 { LFUN_LYX_ACTIVATE, "lyx-activate", ReadOnly | NoBuffer, Hidden },
2403 * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
2404 * \li Action: Terminates the current LyX instance.
2405 * \li Notion: Terminates the current LyX instance, asking whether to save
2406 modified documents, etc.
2407 * \li Syntax: lyx-quit
2410 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
2413 * \var lyx::FuncCode lyx::LFUN_MARGINALNOTE_INSERT
2414 * \li Action: Inserts a marginal note.
2415 * \li Syntax: marginalnote-insert
2416 * \li Origin: Lgb, 26 Jun 2000
2419 { LFUN_MARGINALNOTE_INSERT, "marginalnote-insert", Noop, Edit },
2422 * \var lyx::FuncCode lyx::LFUN_MARK_OFF
2423 * \li Action: Disable selecting of text-region.
2424 * \li Syntax: mark-off
2427 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
2430 * \var lyx::FuncCode lyx::LFUN_MARK_ON
2431 * \li Action: Enable selecting of text-region.
2432 * \li Notion: After enabling you can simply move arrow keys to get selected region.
2433 * \li Syntax: mark-on
2436 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
2439 * \var lyx::FuncCode lyx::LFUN_MARK_TOGGLE
2440 * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
2441 * \li Syntax: mark-toggle
2442 * \li Origin: Andre, May 5 2006
2445 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
2449 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
2450 * \li Action: Update (export) the document built from the master buffer,
2451 if the current buffer is part of a master/child document.
2452 * \li Syntax: master-buffer-update [<FORMAT>]
2453 * \li Params: <FORMAT>: The format to display, where this is one of the
2454 formats defined (in the current GUI) in the
2455 Tools>Preferences>File Formats dialog.
2456 If no format is given, the default format as
2457 specified in the same dialog is used.
2458 * \li Origin: Tommaso, 20 Sep 2007
2461 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
2464 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
2465 * \li Action: Show a preview built from the master buffer, if available.
2466 if the current buffer is part of a master/child document.
2467 * \li Syntax: master-buffer-view [<FORMAT>]
2468 * \li Params: <FORMAT>: The format to display, where this is one of the
2469 formats defined (in the current GUI) in the
2470 Tools>Preferences>File Formats dialog.
2471 If no format is given, the default format as
2472 specified in the same dialog is used.
2473 * \li Origin: Tommaso, 20 Sep 2007
2476 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
2479 * \var lyx::FuncCode lyx::LFUN_MATH_AMS_MATRIX
2480 * \li Action: Inserts an extended matrix as provided by the amsmath package.
2481 * \li Syntax: math-matrix <COLS> <ROWS> [<DECORATION>]
2482 * \li Params: <DECORATION>: Decoration determines the LaTeX name of the matrix
2483 that should be created. Possible values include
2484 pmatrix, bmatrix, Bmatrix, vmatrix, Vmatrix and
2485 matrix. The default is 'matrix'.
2486 * \li Sample: math-ams-matrix 3 3 bmatrix
2489 { LFUN_MATH_AMS_MATRIX, "math-ams-matrix", Noop, Math },
2492 * \var lyx::FuncCode lyx::LFUN_MATH_BIGDELIM
2493 * \li Action: Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
2494 * \li Syntax: math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
2495 * \li Params: <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r \n
2496 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
2497 * \li Sample: math-bigdelim "Bigl" "\Downarrow" "Bigr" "\}"
2498 * \li Origin: Enrico & Georg, 7 May 2006
2501 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
2504 * \var lyx::FuncCode lyx::LFUN_MATH_DELIM
2505 * \li Action: Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
2506 * \li Syntax: math-delim [<LEFT>] [<RIGHT>]
2507 * \li Params: <LEFT/RIGHT>: Delimiters to be used. Each delimiter can be specified by
2508 either a LaTeX name or a valid character.
2509 ( is the default letter.
2510 * \li Sample: math-delim { rangle
2511 * \li Origin: Alejandro, 18 Jun 1996
2514 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
2517 * \var lyx::FuncCode lyx::LFUN_MATH_DISPLAY
2518 * \li Action: Creates a new displayed equation in text mode.
2519 Toggles inlined/display formula in math mode.
2520 * \li Syntax: math-display [<ARG>]
2521 * \li Params: <ARG>: this argument will be passed to #LFUN_MATH_INSERT when creating
2522 new equation from the text mode.
2523 * \li Origin: Alejandro, 18 Jun 1996
2526 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
2529 * \var lyx::FuncCode lyx::LFUN_MATH_EXTERN
2530 * \li Action: Calls external program and passes the current expression/equation
2531 as an argument for the calculation in the format appropriate to the
2533 * \li Notion: Selection can be used to determine the input for the external program.
2534 * \li Syntax: math-extern <LANG> [<COMMAND>]
2535 * \li Params: <LANG>: octave|maxima|maple|mathematica|script \n
2536 where "script" stands for the external script (normalized
2537 expression will be passed)
2538 * \li Origin: Andre, 24 Apr 2001
2539 * \li Sample: math-extern maple simplify
2542 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
2545 * \var lyx::FuncCode lyx::LFUN_MATH_FONT_STYLE
2546 * \li Action: Changes the text style used in math.
2547 * \li Syntax: math-font-style <STYLE>
2548 * \li Params: <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf|textnormal\n
2549 |textrm|textsf|texttt|textbf|textmd|textit|textsc|textsl|textup
2550 * \li Origin: vfr, 9 jan 2009
2553 { LFUN_MATH_FONT_STYLE, "math-font-style", Noop, Math },
2556 * \var lyx::FuncCode lyx::LFUN_MATH_INSERT
2557 * \li Action: Inserts math objects and symbols.
2558 * \li Syntax: math-insert <ARG>
2559 * \li Params: <ARG>: Symbol or LaTeX code to be inserted.
2560 * \li Notion: When <ARG> is a _single_ math inset with more than one cell
2561 (such as "x_y^z" or "\frac{x}{y}"), the content of cell(0) is
2562 replaced by the current selection (only works if the selection
2563 is in mathed). As an example, if "abc" is selected in mathed,
2564 "math-insert \frac{x}{y}" replaces "abc" with "\frac{abc}{y}",
2565 and "math-insert x_y^z" replaces "abc" with "abc_y^z".
2566 If nothing is selected (or the selection is not in mathed),
2567 math-insert works as expected.
2570 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
2573 * \var lyx::FuncCode lyx::LFUN_MATH_LIMITS
2574 * \li Action: Toggles the position of the limits from above/below to the right
2575 side an vice versa in integral symbol, a limit, a summation, etc.
2576 * \li Notion: Put the cursor before the symbol with the limits and then invoke
2578 * \li Syntax: math-limits [<STATE>]
2579 * \li Params: <STATE>: limits|nolimits
2582 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
2585 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO
2586 * \li Action: Inserts a math macro definition at the cursor position in the text.
2587 * \li Syntax: math-macro <NAME> [<NARGS>] [def]
2588 * \li Params: <NAME>: The name of the macro, e.g. "mymacro".\n
2589 <NARGS>: The number of parameters of the macro. Default is 0.
2590 "def": Has no effect anymore, just for compatibility with former LyX versions.
2591 * \li Origin: ale, 10 May 1997; sts, 21 Dec 2007
2594 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
2597 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
2598 * \li Action: Add a greedy optional parameter.
2599 * \li Notion: Add a greedy optional parameter which eats the value
2600 from the following cells in mathed which are in the [value]
2602 * \li Syntax: math-macro-add-greedy-optional-param
2603 * \li Origin: sts, 06 January 2008
2606 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
2609 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
2610 * \li Action: Add an optional parameter.
2611 * \li Notion: Insert an optional parameter just behind the
2612 already existing optional parameters.
2613 * \li Syntax: math-macro-add-optional-param
2614 * \li Origin: sts, 06 January 2008
2617 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
2620 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
2621 * \li Action: Add a parameter.
2622 * \li Notion: Add a parameter to a Math Macro.
2623 * \li Params: <NUM>: The number of the parameter behind which the new one
2624 will be added (1 for the first, i.e. use 0 for add a
2625 parameter at the left), defaults to the last one.
2626 * \li Syntax: math-macro-add-param <NUM>
2627 * \li Origin: sts, 06 January 2008
2630 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
2633 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
2634 * \li Action: Append a greedy parameter.
2635 * \li Notion: Append a greedy parameter to a Math Macro which
2636 eats the following mathed cell in every instance of
2637 the macro in the buffer.
2638 * \li Syntax: math-macro-append-greedy-param
2639 * \li Origin: sts, 06 January 2008
2642 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
2645 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
2646 * \li Action: Fold a Math Macro.
2647 * \li Notion: Fold the Math Macro the cursor is in if it was
2648 unfolded, i.e. displayed as \foo before.
2649 * \li Syntax: math-macro-fold
2650 * \li Origin: sts, 06 January 2008
2653 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
2656 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
2657 * \li Action: Make a parameter non-optional.
2658 * \li Notion: Turn the last optional parameter of a Math Macro
2659 into a non-optional parameter. The default value is
2660 remembered to be reused later if the user changes his mind.
2661 * \li Syntax: math-macro-make-nonoptional
2662 * \li Origin: sts, 06 January 2008
2665 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
2668 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
2669 * \li Action: Make a parameter optional.
2670 * \li Notion: Turn the first non-optional parameter of a Math Macro
2671 into an optional parameter with a default value.
2672 * \li Syntax: math-macro-make-optional
2673 * \li Origin: sts, 06 January 2008
2676 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
2679 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
2680 * \li Action: Remove a greedy parameter.
2681 * \li Notion: Remove a greedy parameter of a Math Macro and spit
2682 out the values of it in every instance of the macro
2683 in the buffer. If it is an optional parameter the [valud]
2685 * \li Syntax: math-macro-remove-greedy-param
2686 * \li Origin: sts, 06 January 2008
2689 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
2692 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
2693 * \li Action: Remove the last optional parameter.
2694 * \li Notion: Remove the last optional parameter of a Math Macro and
2695 remove it in all the instances of the macro in the buffer.
2696 * \li Syntax: math-macro-remove-optional-param
2697 * \li Origin: sts, 06 January 2008
2700 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
2703 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
2704 * \li Action: Remove the last parameter.
2705 * \li Notion: Remove the last parameter of a Math Macro and
2706 remove its value in all instances of the macro
2708 * \li Params: <NUM>: The number of the parameter to be deleted (1 for
2709 the first), defaults to the last one.
2710 * \li Syntax: math-macro-remove-param <NUM>
2711 * \li Origin: sts, 06 January 2008
2714 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
2717 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
2718 * \li Action: Unfold a Math Macro.
2719 * \li Notion: Unfold the Math Macro the cursor is in, i.e.
2721 * \li Syntax: math-macro-unfold
2722 * \li Origin: sts, 06 January 2008
2725 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
2728 * \var lyx::FuncCode lyx::LFUN_MATH_MATRIX
2729 * \li Action: Inserts a matrix.
2730 * \li Syntax: math-matrix <COLS> <ROWS> [<ALIGN>]
2731 * \li Params: <ALIGN>: Alignment is a word composed of the vertical alignment
2732 (b, c or t) (i.e. 1 char) and the horizontal alignments
2733 (l, c or r) (i.e. <COL> chars).
2734 * \li Sample: math-matrix 3 3 bccc
2737 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
2740 * \var lyx::FuncCode lyx::LFUN_MATH_MODE
2741 * \li Action: In text mode enters math mode (i.e. puts math insets on the current
2742 cursor position), in math mode enters text mode inside math expression.
2743 * \li Notion: If there is some selected text, it puts the text inside created math box.
2744 * \li Syntax: math-mode [on|<ARG>]
2745 * \li Params: <ARG>: eventual argument (LaTeX code) is passed to #LFUN_MATH_INSERT .\n
2746 "on": allow only entering of math mode from text mode.
2747 * \li Origin: Alejandro, 4 Jun 1996
2750 { LFUN_MATH_MODE, "math-mode", Noop, Math },
2753 * \var lyx::FuncCode lyx::LFUN_MATH_MUTATE
2754 * \li Action: Mutates the type of math inset to the newly selected one.
2755 * \li Syntax: math-mutate <TYPE>
2756 * \li Params: <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
2757 multline|gather|flalign
2758 * \li Origin: Andre, 23 May 2001
2761 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
2764 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
2765 * \li Action: Toggles numbering of the current formula line.
2766 * \li Notion: Must be in display formula mode.
2767 * \li Syntax: math-number-line-toggle
2768 * \li Origin: Alejandro, 18 Jun 1996
2771 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
2774 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
2775 * \li Action: Toggles numbering/labeling of the current formula.
2776 * \li Notion: Must be in display formula mode.
2777 * \li Syntax: math-number-toggle
2778 * \li Origin: Alejandro, 4 Jun 1996
2781 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
2784 * \var lyx::FuncCode lyx::LFUN_MATH_SIZE
2785 * \li Action: Changes arbitrarily the size used by math fonts inside a context.
2786 * \li Notion: Provides an interface to the LaTeX math mode font size commands.
2787 * \li Syntax: math-size <STYLE>
2788 * \li Params: <STYLE>: \displaystyle|\textstyle|\scriptstyle|\scriptscriptstyle
2789 * \li Origin: Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
2792 { LFUN_MATH_SIZE, "math-size", Noop, Math },
2795 * \var lyx::FuncCode lyx::LFUN_MATH_SPACE
2796 * \li Action: Inserts space into math expression.
2797 * \li Notion: Use spacebar after entering this space to change type of space.
2798 * \li Syntax: math-space [<TYPE>] [<LEN>]
2799 * \li Params: <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace \n
2800 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad \n
2801 custom space: hspace \n
2802 "," used by default.\n
2803 Note that ! is equivalent to negthinspace, , = thinspace,
2804 : = medspace, and ; = thickspace.\n
2805 <LEN>: length for custom spaces (hspace)
2806 * \li Origin: Andre, 25 Jul 2001; sanda, 16 Jun 2008
2809 { LFUN_MATH_SPACE, "math-space", Noop, Math },
2812 * \var lyx::FuncCode lyx::LFUN_MATH_SUBSCRIPT
2813 * \li Action: Enters subscript expression in math expression.
2814 * \li Syntax: math-subscript
2815 * \li Origin: vermeer, 12 Dec 2001
2818 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
2821 * \var lyx::FuncCode lyx::LFUN_MATH_SUPERSCRIPT
2822 * \li Action: Enters superscript expression in math expression.
2823 * \li Syntax: math-superscript
2824 * \li Origin: vermeer, 12 Dec 2001
2827 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
2830 * \var lyx::FuncCode lyx::LFUN_MENU_OPEN
2831 * \li Action: Opens the menu given by its name.
2832 * \li Syntax: menu-open <NAME>
2833 * \li Params: <NAME>: menu name. See various .inc files in lib/ui for candidates.
2836 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
2839 * \var lyx::FuncCode lyx::LFUN_MESSAGE
2840 * \li Action: Shows message in statusbar (for script purposes).
2841 * \li Syntax: message <STRING>
2842 * \li Origin: Lgb, 8 Apr 2001
2845 { LFUN_MESSAGE, "message", NoBuffer, System },
2848 * \var lyx::FuncCode lyx::LFUN_META_PREFIX
2849 * \li Action: Simulate halting Meta key (Alt key on PCs).
2850 * \li Notion: Used for buffer edition not for GUI control.
2851 * \li Syntax: meta-prefix
2854 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
2857 * \var lyx::FuncCode lyx::LFUN_MOUSE_DOUBLE
2858 * \li Action: This function is called when double click on mouse button is
2859 pressed (inside workarea). Action depends on the context.
2860 * \li Notion: This is an internal LFUN, not to be used by users.
2861 * \li Origin: Andre, 9 Aug 2002
2864 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
2867 * \var lyx::FuncCode lyx::LFUN_MOUSE_MOTION
2868 * \li Action: This function is called when mouse cursor is moving over the text.
2869 Action depends on the context.
2870 * \li Notion: This is an internal LFUN, not to be used by users.
2871 * \li Origin: Andre, 9 Aug 2002
2874 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
2877 * \var lyx::FuncCode lyx::LFUN_MOUSE_PRESS
2878 * \li Action: This function is called when mouse button is pressed (inside workarea).
2879 Action depends on the context.
2880 * \li Notion: This is an internal LFUN, not to be used by users.
2881 * \li Origin: Andre, 9 Aug 2002
2884 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
2887 * \var lyx::FuncCode lyx::LFUN_MOUSE_RELEASE
2888 * \li Action: This function is called when mouse button is released (inside workarea).
2889 Action depends on the context.
2890 * \li Notion: This is an internal LFUN, not to be used by users.
2891 * \li Origin: Andre, 9 Aug 2002
2894 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
2898 * \var lyx::FuncCode lyx::LFUN_MOUSE_TRIPLE
2899 * \li Action: This function is called when triple click on mouse button is
2900 pressed (inside workarea). Action depends on the context.
2901 * \li Notion: This is an internal LFUN, not to be used by users.
2902 * \li Origin: Andre, 9 Aug 2002
2905 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
2908 * \var lyx::FuncCode lyx::LFUN_NEWLINE_INSERT
2909 * \li Action: Inserts a line break or new line.
2910 * \li Syntax: newline-insert [<ARG>]
2911 * \li Params: <ARG>: <newline|linebreak> default: newline
2912 * \li Origin: JSpitzm, 25 Mar 2008
2915 { LFUN_NEWLINE_INSERT, "newline-insert", Noop, Edit },
2918 * \var lyx::FuncCode lyx::LFUN_NEWPAGE_INSERT
2919 * \li Action: Inserts a new page.
2920 * \li Syntax: newpage-insert <ARG>
2921 * \li Params: <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
2922 * \li Origin: uwestoehr, 24 Nov 2007
2925 { LFUN_NEWPAGE_INSERT, "newpage-insert", Noop, Edit },
2928 * \var lyx::FuncCode lyx::LFUN_NOMENCL_INSERT
2929 * \li Action: Inserts Nomenclature entry.
2930 * \li Notion: It automatically takes the word on the cursor position if no symbol is given.
2931 * \li Syntax: nomencl-insert [<SYMBOL>]
2932 * \li Origin: Ugras, 4 Nov 2006
2935 { LFUN_NOMENCL_INSERT, "nomencl-insert", Noop, Edit },
2938 * \var lyx::FuncCode lyx::LFUN_NOMENCLATURE_PRINT
2939 * \li Action: Inserts list of Nomenclature entries.
2940 * \li Syntax: nomenclature-print
2941 * \li Origin: Ugras, 4 Nov 2006
2944 { LFUN_NOMENCL_PRINT, "nomencl-print", Noop, Edit },
2948 * \var lyx::FuncCode lyx::LFUN_NOTE_INSERT
2949 * \li Action: Inserts Note on the current cursor position,
2950 move selection inside the inset.
2951 * \li Syntax: note-insert [<TYPE>]
2952 * \li Params: <TYPE>: <Note|Greyedout|Comment> default: Note
2955 { LFUN_NOTE_INSERT, "note-insert", Noop, Edit },
2958 * \var lyx::FuncCode lyx::LFUN_NOTE_NEXT
2959 * \li Action: Moves the cursor to the beginning of next Note inset.
2960 * \li Syntax: note-next
2963 { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
2966 * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
2967 * \li Action: Move the current group in the downward direction in the
2968 structure of the document.
2969 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
2970 the whole substructure of the group.
2971 * \li Syntax: outline-down
2972 * \li Origin: Vermeer, 23 Mar 2006
2975 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
2978 * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
2979 * \li Action: Moves the current group in the downward direction in the
2980 hierarchy of the document structure.
2981 * \li Notion: Part -> Chapter -> Section -> etc.
2982 * \li Syntax: outline-in
2983 * \li Origin: Vermeer, 23 Mar 2006
2986 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
2989 * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
2990 * \li Action: Moves the current group in the upward direction in the
2991 hierarchy of the document structure.
2992 * \li Notion: Part <- Chapter <- Section <- etc.
2993 * \li Syntax: outline-out
2994 * \li Origin: Vermeer, 23 Mar 2006
2997 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
3001 * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
3002 * \li Action: Move the current group in the upward direction in the
3003 structure of the document.
3004 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
3005 the whole substructure of the group.
3006 * \li Syntax: outline-up
3007 * \li Origin: Vermeer, 23 Mar 2006
3010 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
3013 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_BREAK
3014 * \li Action: Breaks the current paragraph at the current location.
3015 * \li Notion: Removes the selection.
3016 * \li Syntax: paragraph-break [<LAYOUT>]
3017 * \li Params: <LAYOUT>: "inverse" - decreases depth by one (or change layout
3018 to default layout) when the cursor is at the end of
3022 { LFUN_PARAGRAPH_BREAK, "paragraph-break", Noop, Edit },
3025 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN
3026 * \li Action: Move the cursor to the next paragraph (or beginning of the current one)
3027 in downward direction.
3028 * \li Syntax: paragraph-down
3029 * \li Origin: Asger, 1 Oct 1996
3032 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
3035 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN_SELECT
3036 * \li Action: Move the cursor and select the text to the next paragraph (or
3037 beginning of the current one) in downward direction.
3038 * \li Syntax: paragraph-down-select
3039 * \li Origin: Asger, 1 Oct 1996
3042 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
3045 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
3046 * \li Action: Jump to a paragraph given by its id number and optionally the
3047 desired position within the paragraph.
3048 If given four arguments id_start, pos_start, id_end, pos_end,
3049 perform a selection from start to end.
3050 * \li Notion: Note that id number of paragraph is not the sequential number of
3051 paragraph seen on the screen. Moreover the id is unique for all
3052 opened buffers (documents). Both ids must belong to the same
3054 * \li Syntax: paragraph-goto <PAR_ID> <POS_IN_PAR> [<PAR_ID> <POS_IN_PAR>]
3055 * \li Params: <PAR_ID>: paragraph id \n
3056 <POS_IN_PAR>: desired position within the paragraph
3057 * \li Origin: Dekel, 26 Aug 2000
3061 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly | NoInternal, Edit },
3064 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
3065 * \li Action: Moves the current paragraph downwards in the document.
3066 * \li Syntax: paragraph-move-down
3067 * \li Origin: Edwin, 8 Apr 2006
3070 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
3073 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
3074 * \li Action: Moves the current paragraph upwards in the document.
3075 * \li Notion: Movement through the document will possibly break the paragraph-depth
3076 (e.g. itemize structure).
3077 * \li Syntax: paragraph-move-up
3078 * \li Origin: Edwin, 8 Apr 2006
3081 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
3085 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
3086 * \li Action: Change paragraph settings.
3087 * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
3088 This function only modifies, and does not override, existing settings.
3089 Note that the "leftindent" indent setting is deprecated.
3090 * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
3091 * \li Params: <INDENT>: \noindent|\indent|\indent-toggle|\leftindent LENGTH\n
3092 <SPACING>: \paragraph_spacing default|single|onehalf|double|other SIZE \n
3093 <ALIGN>: \align block|left|right|center|default\n
3094 <OTHERS>: \labelwidthstring WIDTH|\start_of_appendix
3095 * \li Origin: rgh, Aug 15 2007
3098 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
3101 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
3102 * \li Action: Change paragraph settings.
3103 * \li Notion: Overwrite all nonspecified settings to the default ones.
3104 Use paragraph-params lfun if you don't want to overwrite others settings.
3105 * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
3106 * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
3107 * \li Origin: leeming, 30 Mar 2004
3110 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
3113 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP
3114 * \li Action: Move the cursor to the next paragraph (or beginning of the current one)
3115 in upward direction.
3116 * \li Syntax: paragraph-up
3117 * \li Origin: Asger, 1 Oct 1996
3120 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
3123 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UPDATE
3124 * \li Action: Updates the values inside the paragraph dialog from the paragraph.
3125 * \li Notion: This is an internal LFUN, not to be used by users. Called internally
3126 by #LFUN_DIALOG_UPDATE.
3127 * \li Origin: leeming, 13 Mar 2003
3130 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
3134 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP_SELECT
3135 * \li Action: Move the cursor and select the text to the next paragraph (or
3136 beginning of the current one) in upward direction.
3137 * \li Syntax: paragraph-up-select
3138 * \li Origin: Asger, 1 Oct 1996
3141 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
3144 * \var lyx::FuncCode lyx::LFUN_PASTE
3145 * \li Action: Pastes material (text or picture) from the active clipboard.
3146 * \li Syntax: paste [<TYPE>|<NUM>]
3147 * \li Params: <TYPE>: emf|pdf|png|jpeg|linkback|wmf|latex|html \n
3148 <NUM>: number of the selection in the internal clipboard stack to be pasted.
3151 { LFUN_PASTE, "paste", Noop, Edit },
3154 * \var lyx::FuncCode lyx::LFUN_PHANTOM_INSERT
3155 * \li Action: Inserts phantom on the current cursor position,
3156 move selection inside the inset.
3157 * \li Syntax: phantom-insert [<TYPE>]
3158 * \li Params: <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
3159 * \li Origin: uwestoehr, 30 Jan 2009
3162 { LFUN_PHANTOM_INSERT, "phantom-insert", Noop, Edit },
3165 * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
3166 * \li Action: Save user preferences.
3167 * \li Syntax: preferences-save
3168 * \li Origin: Lgb, 27 Nov 1999
3171 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
3174 * \var lyx::FuncCode lyx::LFUN_PREVIEW_INSERT
3175 * \li Action: Inserts a new preview inset.
3176 * \li Syntax: preview-insert
3177 * \li Origin: vfr, 28 Mar 2010
3180 { LFUN_PREVIEW_INSERT, "preview-insert", Noop, Edit },
3183 * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
3184 * \li Action: Pastes the currently selected text.
3185 * \li Notion: Primary selection mechanism is linux-only thing.
3186 * \li Syntax: primary-selection-paste [<ARG>]
3187 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
3190 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
3193 * \var lyx::FuncCode lyx::LFUN_QUOTE_INSERT
3194 * \li Action: Inserts quotes according to the type and quote-language preference.
3195 * \li Notion: Currently 15 different quote styles are distinguished (see params).
3196 * \li Syntax: quote-insert [<LEVEL>] [<SIDE>] [<STYLE>]
3197 * \li Params: <LEVEL>: 'inner' for (i.e., secondary, usually single) quotes, otherwise
3198 * outer (i.e., primary, usually double) quotes will be used.\n
3199 * <SIDE>: 'opening' for opening quotes, 'closing' for closing quotes,
3200 * otherwise the side will be guessed from the context.\n
3201 * <STYLE>: 'british' for `British' quote style (with ``inner quotation'')\n
3202 * 'cjk' for Chinese/Japanese/Korean corner bracket quotation marks\n
3203 * 'cjk-angle' for Chinese/Japanese/Korean angle bracket quotation marks\n
3204 * 'danish' for >>Danish<< quote style (with >inner quotation<)\n
3205 * 'english' for ``English'' quote style (with `inner quotation')\n
3206 * 'french' for <<french>> quote style (with ``inner quotation'')\n
3207 * 'frenchin' for <<frenchin>> quote style (with <<inner quotation>>) ["in" = Imprimerie Nationale]\n
3208 * 'german' for ,,German`` quote style (with ,inner quotation`)\n
3209 * 'plain' for "Plain" quote style (with 'inner quotation')\n
3210 * 'polish' for ,,Polish'' quote style (with ,inner quotation')\n
3211 * 'swedish' for ''Swedish'' quote style (with 'inner quotation')\n
3212 * 'swedishg' for >>swedishg>> quote style (with 'inner quotation') ["g" = Guillemets]\n
3213 * 'swiss' for <<Swiss>> quote style (with <inner quotation>)\n
3214 * 'russian' for <<Russian>> quote style (with ,,inner quotation``)\n
3215 * 'dynamic' for Dynamic quotation marks which inherit the global
3217 * If no quote style is specified, the document-wide will be used.
3220 { LFUN_QUOTE_INSERT, "quote-insert", Noop, Edit },
3223 * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
3224 * \li Action: Reconfigure the automatic settings.
3225 * \li Syntax: reconfigure
3226 * \li Origin: Asger, 14 Feb 1997
3229 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
3232 * \var lyx::FuncCode lyx::LFUN_REDO
3233 * \li Action: Redoes the last thing undone.
3237 { LFUN_REDO, "redo", ReadOnly, Edit },
3240 * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
3241 * \li Action: Go to the next label or cross-reference.
3242 * \li Syntax: reference-next
3243 * \li Origin: Dekel, 14 Jan 2001
3246 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
3250 * \var lyx::FuncCode lyx::LFUN_REGEXP_MODE
3251 * \li Action: Enters regexp mode (i.e., puts regexp insets on the current
3252 cursor position). Used by the advanced search dialog.
3253 * \li Notion: If there is any selected text, then it is moved inside the created
3255 * \li Syntax: regexp-mode [<ARG>]
3256 * \li Params: <ARG>: eventual argument (regular expression).
3257 * \li Origin: Tommaso, 4 Oct 2008
3260 { LFUN_REGEXP_MODE, "regexp-mode", Noop, Math },
3263 * \var lyx::FuncCode lyx::LFUN_REPEAT
3264 * \li Action: Repeat the given command.
3265 * \li Syntax: repeat <COUNT> <LFUN-COMMAND>
3266 * \li Origin: Andre, 27 Oct 2003
3269 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
3272 * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN
3273 * \li Action: Moves the cursor one page in downward direction.
3274 * \li Syntax: screen-down
3277 { LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit },
3280 * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN_SELECT
3281 * \li Action: Moves the cursor one screen in downward direction adding the current
3282 position to the selection.
3283 * \li Syntax: screen-down-select
3286 { LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit },
3289 * \var lyx::FuncCode lyx::LFUN_SCREEN_FONT_UPDATE
3290 * \li Action: Update fonts and its metrics.
3291 * \li Notion: Automatically called after zoom, dpi, font names, or norm change.
3292 * \li Syntax: screen-font-update
3293 * \li Origin: ARRae, 13 Aug 2000
3296 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
3299 * \var lyx::FuncCode lyx::LFUN_SCREEN_RECENTER
3300 * \li Action: Recenters the screen on the current cursor position.
3301 * \li Syntax: screen-recenter
3304 { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit },
3308 * \var lyx::FuncCode lyx::LFUN_SCREEN_SHOW_CURSOR
3309 * \li Action: Repositions the screen such that the cursor is visible.
3310 * \li Syntax: screen-show-cursor
3311 * \li Origin: vfr, 25 Mar 2009
3314 { LFUN_SCREEN_SHOW_CURSOR, "screen-show-cursor", ReadOnly, Edit },
3318 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP
3319 * \li Action: Moves the cursor one page in upward direction.
3320 * \li Syntax: screen-up
3323 { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit },
3326 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP_SELECT
3327 * \li Action: Moves the cursor one page in upward direction adding the current
3328 position to the selection.
3329 * \li Syntax: screen-up-select
3332 { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit },
3335 * \var lyx::FuncCode lyx::LFUN_SCRIPT_INSERT
3336 * \li Action: Inserts a subscript or superscript inset.
3337 * \li Syntax: script-insert <TYPE>
3338 * \li Params: <TYPE>: subscript|superscript
3339 * \li Origin: Georg, 23 Nov 2010
3342 { LFUN_SCRIPT_INSERT, "script-insert", Noop, Edit },
3345 * \var lyx::FuncCode lyx::LFUN_SCROLL
3346 * \li Action: Scroll the buffer view.
3347 * \li Notion: Only scrolls the screen up or down; does not move the cursor.
3348 * \li Syntax: scroll <TYPE> <QUANTITY>
3349 * \li Params: <TYPE>: line|page\n
3350 <QUANTITY>: up|down|<number>
3351 * \li Origin: Abdel, Dec 27 2007
3354 { LFUN_SCROLL, "scroll", ReadOnly, Edit },
3357 * \var lyx::FuncCode lyx::LFUN_SECTION_SELECT
3358 * \li Action: Select the whole section.
3359 * \li Notion: The cursor should be in a section heading
3360 before calling this lfun.
3361 * \li Syntax: section-select
3362 * \li Origin: vfr, 05 May 2009
3365 { LFUN_SECTION_SELECT, "section-select", ReadOnly, Edit },
3369 * \var lyx::FuncCode lyx::LFUN_SELECTION_PASTE
3370 * \li Action: Pastes the internal selection text in permanent selection.
3371 * \li Notion: Created in order to have middle mouse button pasting correct (bound to
3372 command-alternatives selection-paste ; primary-selection-paste paragraph).
3373 * \li Syntax: selection-paste
3374 * \li Origin: lasgouttes, 14 Jan 2009
3377 { LFUN_SELECTION_PASTE, "selection-paste", Noop, Edit },
3380 * \var lyx::FuncCode lyx::LFUN_SELF_INSERT
3381 * \li Action: Inserts the given string (accordingly to the correct keymap).
3382 * \li Notion: Automatically replace the currently selected text. Depends on lyxrc
3383 settings "auto_region_delete".
3384 * \li Syntax: self-insert <STRING>
3387 { LFUN_SELF_INSERT, "self-insert", SingleParUpdate, Hidden },
3390 * \var lyx::FuncCode lyx::LFUN_SEPARATOR_INSERT
3391 * \li Action: Inserts an environment separator or latex paragraph break.
3392 * \li Syntax: separator-insert [<ARG>]
3393 * \li Params: <ARG>: <plain|parbreak|latexpar> default: plain
3394 * \li Origin: ef, 2 May 2014
3397 { LFUN_SEPARATOR_INSERT, "separator-insert", Noop, Edit },
3400 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_FILENAME
3401 * \li Action: Returns path and file name of the currently edited document.
3402 * \li Syntax: server-get-filename
3405 { LFUN_SERVER_GET_FILENAME, "server-get-filename", ReadOnly, System },
3408 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_LAYOUT
3409 * \li Action: Returns the current layout (that is environment) name
3410 on the cursor position.
3411 * \li Syntax: server-get-layout
3414 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
3417 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_STATISTICS
3418 * \li Action: Returns the statistics (number of words and characters)
3419 in the document or in the given selection.
3420 * \li Notion: Note that this function gives the number of words/chars written,
3421 not the number of characters which will be typeset.
3422 * \li Syntax: server-get-statistics [<TYPE>]
3423 * \li Params: <TYPE>: <words|chars|chars-space> The requested count; if not
3424 specified, the three values are returned, separated
3426 words: count words.\n
3427 chars: count characters.\n
3428 chars-space: count characters and spaces.
3429 * \li Origin: brokenclock, Oct 10 2014
3432 { LFUN_SERVER_GET_STATISTICS, "server-get-statistics", ReadOnly, System },
3435 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
3436 * \li Action: Returns the coordinates of cursor position in the editing area.
3437 * \li Syntax: server-get-xy
3440 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
3444 * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
3445 * \li Action: Sets the cursor position in LyX based on the row number of generated TeX file.
3446 * \li Notion: This can be useful for DVI inverse-search or detection of the problematic
3447 line from LaTeX compilation. Note that before this function can be used
3448 export to LaTeX output must occur (in order to map the row numbers).
3449 * \li Syntax: server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
3450 * \li Params: <FILE>: the path and filename. Environment variables are expanded in the path.
3451 In case this LFUN does not work make sure you are giving correct
3453 If the file is located inside LyX temporary directory it will be
3454 mapped back into the appropriate opened buffer (e.g. for the case
3455 of generated .tex file).\n
3456 .ext: extensions will be automatically replaced by .lyx.\n
3457 <ROW_NUMBER> The row number of the LaTeX file to which to go.
3458 * \li Sample: server-goto-file-row /home/user/example.lyx 41\n
3459 server-goto-file-row /tmp/lyx_tmpdir.XM3088/lyx_tmpbuf0/example.tex 41
3460 * \li Origin: Edmar, 23 Dec 1998
3463 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly | NoBuffer, System },
3466 * \var lyx::FuncCode lyx::LFUN_SERVER_NOTIFY
3467 * \li Action: Sends notify message about the last key-sequence to client.
3468 * \li Notion: This can be used to grab last key-sequence used inside the LyX window.
3469 See also Debug extensions section in Additional features manual.
3470 * \li Syntax: server-notify
3473 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
3476 * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
3477 * \li Action: Sets the cursor position based on the editing area coordinates
3478 (similar to clicking on that point with left mouse button).
3479 * \li Syntax: server-set-xy <X> <Y>
3482 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
3485 * \var lyx::FuncCode lyx::LFUN_SET_COLOR
3486 * \li Action: Set the given LyX color to the color defined by the X11 name given.
3487 * \li Notion: A new color entry is created if the color is unknown.
3488 Color names can be stored as a part of user settings.
3489 * \li Syntax: set-color <LYX_NAME> <X11_NAME>
3490 * \li Origin: SLior, 11 Jun 2000
3493 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
3496 * \var lyx::FuncCode lyx::LFUN_SET_GRAPHICS_GROUP
3497 * \li Action: Set the group for the graphics inset on the cursor position.
3498 * \li Syntax: set-graphics-group [<GROUP>]
3499 * \li Params: <GROUP>: Id for an existing group. In case the Id is an empty string,
3500 the graphics inset is removed from the current group.
3501 * \li Origin: sanda, 6 May 2008
3504 { LFUN_SET_GRAPHICS_GROUP, "set-graphics-group", Noop, Edit },
3508 * \var lyx::FuncCode lyx::LFUN_SPACE_INSERT
3509 * \li Action: Inserts one of horizontal space insets.
3510 * \li Syntax: space-insert <NAME> [<LEN>]
3511 * \li Params: <NAME>: normal, protected, visible, thin, quad, qquad, enspace,
3512 enskip, negthinspace, negmedspace, negthickspace, hfill,
3513 hfill*, dotfill, hrulefill, hspace, hspace* \n
3514 Only in math mode: med and thick.\n
3515 <LEN>: length for custom spaces (hspace, hspace* for protected)
3516 * \li Origin: JSpitzm, 20 May 2003, Mar 17 2008
3519 { LFUN_SPACE_INSERT, "space-insert", Noop, Edit },
3522 * \var lyx::FuncCode lyx::LFUN_SPECIALCHAR_INSERT
3523 * \li Action: Inserts various characters into the document.
3524 * \li Syntax: specialchar-insert <CHAR>
3525 * \li Params: <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots,
3526 end-of-sentence, menu-separator, lyx, tex, latex, latex2e.
3527 * \li Origin: JSpitzm, 6 Dec 2007
3530 { LFUN_SPECIALCHAR_INSERT, "specialchar-insert", Noop, Edit },
3533 * \var lyx::FuncCode lyx::LFUN_SPELLING_ADD
3534 * \li Action: Add the word under the cursor to the respective
3535 * spell checker dictionary.
3536 * The default for the language is retrieved from the cursor position.
3537 * \li Syntax: spelling-add [<STRING>] [<LANG>]
3538 * \li Params: <WORD>: word to add
3539 <LANG>: language name (see file languages)
3540 * \li Origin: JSpitzm, 18 Jan 2010
3543 { LFUN_SPELLING_ADD, "spelling-add", ReadOnly, Edit },
3546 * \var lyx::FuncCode lyx::LFUN_SPELLING_CONTINUOUSLY
3547 * \li Action: Toggle continuous spell checking.
3548 * \li Syntax: spelling-continuously
3549 * \li Origin: vfr, 24 March 2013
3552 { LFUN_SPELLING_CONTINUOUSLY, "spelling-continuously", ReadOnly, Edit },
3556 * \var lyx::FuncCode lyx::LFUN_SPELLING_IGNORE
3557 * \li Action: Let the spell checker ignore the word under the cursor
3558 * in the current session for the given language.
3559 * The default for the language is retrieved from the cursor position.
3560 * \li Syntax: spelling-ignore [<WORD>] [<LANG>]
3561 * \li Params: <WORD>: word to ignore
3562 <LANG>: language name (see file languages)
3563 * \li Origin: JSpitzm, 18 Jan 2010
3566 { LFUN_SPELLING_IGNORE, "spelling-ignore", ReadOnly, Edit },
3569 * \var lyx::FuncCode lyx::LFUN_SPELLING_REMOVE
3570 * \li Action: Remove the word under the cursor from the respective
3571 * spell checker dictionary.
3572 * The default for the language is retrieved from the cursor position.
3573 * \li Syntax: spelling-remove [<STRING>] [<LANG>]
3574 * \li Params: <WORD>: word to remove
3575 * <LANG>: language name (see file languages)
3576 * \li Origin: SWitt, 28 July 2010
3579 { LFUN_SPELLING_REMOVE, "spelling-remove", ReadOnly, Edit },
3583 * \var lyx::FuncCode lyx::LFUN_STATISTICS
3584 * \li Action: Count the statistics (number of words and characters)
3585 in the document or in the given selection and display it
3587 * \li Notion: Note that this function gives the number of words/chars written,
3588 not the number of characters which will be typeset.
3589 * \li Syntax: statistics
3590 * \li Origin: lasgouttes, Jan 27 2004; sanda, Jan 8 2008
3593 { LFUN_STATISTICS, "statistics", ReadOnly, System },
3596 * \var lyx::FuncCode lyx::LFUN_TABULAR_FEATURE
3597 * \li Action: Modify properties of tabulars and table-like math environments.
3598 * \li Syntax: tabular-feature <FEATURE> [<ARG>]
3599 * \li Params: Generally see #LFUN_INSET_INSERT for further details.\n
3600 * <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|\n
3601 copy-column|move-column-right|move-column-left|move-row-down|move-row-up|\n
3602 toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|\n
3603 align-left|align-right|align-center|align-block|align-decimal|set-decimal-point|\n
3604 valign-top|valign-bottom|valign-middle|longtabular-align-left|\n
3605 longtabular-align-center|longtabular-align-right|m-align-left|m-align-right|\n
3606 m-align-center|m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|\n
3607 set-all-lines|unset-all-lines|toggle-longtabular|set-longtabular|unset-longtabular|set-pwidth|\n
3608 set-mpwidth|set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|\n
3609 set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|\n
3610 unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|\n
3611 set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|\n
3612 set-special-column|set-special-multicolumn|set-special-multirow|\n
3613 toggle-booktabs|set-booktabs|unset-booktabs|set-top-space|set-bottom-space|\n
3614 set-interline-space|set-border-lines|tabular-valign-top|\n
3615 tabular-valign-middle|tabular-valign-bottom|set-tabular-width\n
3616 Various math-environment features are handled as well, e.g. add-vline-left/right for\n
3617 the Grid/Array environment.\n
3618 <ARG>: additional argument for some commands, use debug mode to explore its values.
3619 * \li Origin: gm, 10 Dec 2015
3622 { LFUN_TABULAR_FEATURE, "tabular-feature", Noop, Edit },
3625 * \var lyx::FuncCode lyx::LFUN_TABULAR_INSERT
3626 * \li Action: Inserts table into the document.
3627 * \li Notion: See #LFUN_TABULAR_FEATURE for some more details
3628 about tabular modifications.
3629 * \li Syntax: tabular-insert [<ROWS> <COLUMNS>]
3630 * \li Params: In case no arguments are given show insert dialog.
3631 * \li Origin: Jug, 12 Apr 2000
3634 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
3638 * \var lyx::FuncCode lyx::LFUN_TAB_DELETE
3639 * \li Action: Delete a tab or up to an equivalent amount of spaces from
3641 * \li Notion: It also works on a selection - it removes a tab or spaces from the
3642 beginning of each line spanned by the selection. This is useful if
3643 you want to indent/unindent multiple lines in one action.
3644 * \li Syntax: tab-delete
3645 * \li Origin: vfr, Sep 30 2008
3648 { LFUN_TAB_DELETE, "tab-delete", SingleParUpdate, Edit },
3651 * \var lyx::FuncCode lyx::LFUN_TAB_GROUP_CLOSE
3652 * \li Action: Close the current tab group.
3653 * \li Notion: This only closes the work areas, not the buffers themselves.
3654 The still opened buffers can be visualized in another tab group.
3655 * \li Syntax: tab-group-close
3656 * \li Origin: Abdel, 21 Feb 2008
3659 { LFUN_TAB_GROUP_CLOSE, "tab-group-close", ReadOnly, Buffer },
3663 * \var lyx::FuncCode lyx::LFUN_TAB_INSERT
3664 * \li Action: Insert a tab into a listings inset.
3665 * \li Notion: It also works on a selection.
3666 * \li Syntax: tab-insert
3667 * \li Origin: vfr, Sep 30 2008
3670 { LFUN_TAB_INSERT, "tab-insert", SingleParUpdate, Edit },
3673 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
3674 * \li Action: Sets the text class for the current buffer.
3675 * \li Syntax: textclass-apply <TEXTCLASS>
3676 * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
3677 the filename, minus the ".layout" extension.
3680 { LFUN_TEXTCLASS_APPLY, "textclass-apply", NoInternal, Layout },
3683 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
3684 * \li Action: Loads information for a textclass from disk.
3685 * \li Syntax: textclass-load <TEXTCLASS>
3686 * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
3687 the filename, minus the ".layout" extension.
3690 { LFUN_TEXTCLASS_LOAD, "textclass-load", NoInternal, Layout },
3694 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_APPLY
3695 * \li Action: Toggle user-defined (=last-time used) text style.
3696 * \li Notion: This style is set via #LFUN_TEXTSTYLE_UPDATE, which is
3697 automatically triggered when using Text Style dialog.
3698 * \li Syntax: textstyle-apply
3699 * \li Origin: leeming, 12 Mar 2003
3702 { LFUN_TEXTSTYLE_APPLY, "textstyle-apply", Noop, Layout },
3705 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_UPDATE
3706 * \li Action: Apply text style and update the settings to be used by #LFUN_TEXTSTYLE_APPLY.
3707 * \li Syntax: textstyle-update <FONT_INFO>
3708 * \li Params: <FONT_INFO>: specifies font atributes, e.g. family, series, shape,
3709 size, emph, noun, underbar, number, color, language,
3711 Use lyx -dbg action for exact syntax of text-style
3713 * \li Origin: leeming, 12 Mar 2003
3716 { LFUN_TEXTSTYLE_UPDATE, "textstyle-update", Noop, Layout },
3719 * \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
3720 * \li Action: Look up thesaurus entries with respect to the word under the cursor.
3721 * \li Syntax: thesaurus-entry [<STRING>] [lang=<LANG>]
3722 * \li Params: <STRING>: word to look up
3723 <LANG>: language (see file languages)
3724 * \li Origin: Levon, 20 Jul 2001
3727 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
3730 * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
3731 * \li Action: Toggles visibility of a given toolbar between on/off/auto.
3732 * \li Notion: Skipping "auto" when allowauto is false.
3733 * \li Syntax: toolbar-toggle <NAME> [allowauto]
3734 * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|\n
3735 minibuffer|review|view/update|math_panels|vcs|
3736 view-others|update-others
3737 * \li Origin: Edwin, 21 May 2007
3740 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
3743 * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
3744 * \li Action: Various UI visibility-toggling actions.
3745 * \li Syntax: ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
3746 * \li Params: statusbar : Toggle visibility of the statusbar.\n
3747 menubar : Toggle visibility of the menubar.\n
3748 scrollbar : Toggle visibility of the scrollbar.\n
3749 frame : Toggle visibility of the frames around editing window.\n
3750 fullscreen : Toggle fullscreen mode. This also covers calling the
3751 previous functions. However #LFUN_TOOLBAR_TOGGLE for the
3752 custom tweaks of the toolbars should be used.
3753 * \li Origin: sanda, 9 Feb 2007
3756 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
3760 * \var lyx::FuncCode lyx::LFUN_UNDO
3761 * \li Action: Undoes the last edit.
3765 { LFUN_UNDO, "undo", ReadOnly, Edit },
3768 * \var lyx::FuncCode lyx::LFUN_UNICODE_INSERT
3769 * \li Action: Inserts a single unicode character.
3770 * \li Syntax: unicode-insert <CHAR>
3771 * \li Params: <CHAR>: The character to insert, given as its code
3772 point, in hexadecimal.
3773 * \li Sample: unicode-insert 0x0100
3774 * \li Origin: Lgb, 22 Oct 2006
3777 { LFUN_UNICODE_INSERT, "unicode-insert", Noop, Edit },
3780 * \var lyx::FuncCode lyx::LFUN_UP
3781 * \li Action: Moves the cursor one line in upward direction.
3785 { LFUN_UP, "up", ReadOnly | NoUpdate, Edit },
3788 * \var lyx::FuncCode lyx::LFUN_UP_SELECT
3789 * \li Action: Moves the cursor one line in upward direction adding the current
3790 position to the selection.
3791 * \li Syntax: up-select
3794 { LFUN_UP_SELECT, "up-select", ReadOnly | SingleParUpdate, Edit },
3797 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_IN
3798 * \li Action: Checks-in/commits the changes of the registered file to the repository.
3799 * \li Notion: In RCS case this also unlocks the file.
3800 * \li Syntax: vc-check-in
3801 * \li Origin: Lgb, 1 Jul 1997
3804 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
3807 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_OUT
3808 * \li Action: Checks-out the document for edit (and locks it in some cases).
3809 * \li Syntax: vc-check-out
3810 * \li Origin: Lgb, 1 Jul 1997
3813 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
3816 * \var lyx::FuncCode lyx::LFUN_VC_COMMAND
3817 * \li Action: Executes external command. This command is intended to support
3818 additional VCS commands.
3819 * \li Syntax: vc-command <FLAG> <PATH> <COMMAND>
3820 * \li Params: <FLAG>: Flags for the command can be combined together.\n
3821 U - dUmmy - no flags \n
3822 D - Doc - need document loaded to proceed \n
3823 I - dIrty - mark document dirty \n
3824 R - Reload - ensure that the document is saved and reload it after command execution \n
3825 M - Message - ask for input string (commit message)\n
3826 <PATH>: path where to start. $$p will be replaced by the current document path.\n
3827 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current
3828 document(with absolute path)/path/message.
3829 * \li Sample: vc-command DR $$p "svn up"
3830 * \li Origin: sanda, 13 Jan 2009
3833 { LFUN_VC_COMMAND, "vc-command", NoBuffer | ReadOnly, System },
3836 * \var lyx::FuncCode lyx::LFUN_VC_COMPARE
3837 * \li Action: Compares two revisions of the same file under version control.
3838 * \li Syntax: vc-compare [<REV1>] [<REV2>]
3839 * \li Params: Revision number either points directly to commit in history
3840 or if negative number -x it points to (last commit - x).\n
3841 In RCS we subtract only in the last number of revision specification.
3842 Special case "0" is reserved for the last committed revision.\n
3843 <REV1>: Older file.\n
3844 <REV2>: Newer file. Used only if REV1 > 0.\n
3845 If no parameter is given, interactive dialog will be shown.
3846 * \li Sample: Compare current document against last commit\n
3848 Compare current document against current revision - 5 commits\n
3850 Compare revisions 120 and 155\n
3852 * \li Origin: sanda, 12 Feb 2010
3855 { LFUN_VC_COMPARE, "vc-compare", ReadOnly, System },
3859 * \var lyx::FuncCode lyx::LFUN_VC_COPY
3860 * \li Action: Copies the document to another name.
3861 * \li Notion: Copying with revision history is only supported by SVN.
3862 For RCS and CVS it is simulated by adding the document
3864 Disabled if uncommitted changes exist.
3865 * \li Syntax: vc-copy <FILENAME>
3866 * \li Params: <FILENAME>: New name of the document.\n
3867 * A file dialog is opened if no filename is given.
3868 * \li Origin: gb, 05 Feb 2013
3871 { LFUN_VC_COPY, "vc-copy", ReadOnly, System },
3874 * \var lyx::FuncCode lyx::LFUN_VC_LOCKING_TOGGLE
3875 * \li Action: Toggles the locking property of the edited file.
3876 * \li Notion: This is currently implemented only for SVN.
3877 * \li Syntax: vc-locking-toggle
3878 * \li Origin: sanda, 25 Jun 2009
3881 { LFUN_VC_LOCKING_TOGGLE, "vc-locking-toggle", ReadOnly, System },
3884 * \var lyx::FuncCode lyx::LFUN_VC_REGISTER
3885 * \li Action: Register the document as an file inside version control system.
3886 * \li Notion: File is registered inside cvs, svn or rcs repository acording to the existence
3887 of cvs/svn/rcs entries in the document's directory. \n
3888 See LyX Additional Features Manual (Version Control Chapter) for additional
3890 * \li Syntax: vc-register
3891 * \li Origin: Lgb, 1 Jul 1997
3894 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
3897 * \var lyx::FuncCode lyx::LFUN_VC_RENAME
3898 * \li Action: Renames the document to another name.
3899 * \li Notion: Renaming with revision history is only supported by SVN.
3900 For CVS it is simulated by adding the document under a new
3901 name and deleting the old one. For RCS it is not supported.
3902 Disabled if uncommitted changes exist.
3903 * \li Syntax: vc-rename <FILENAME>
3904 * \li Params: <FILENAME>: New name of the document.\n
3905 * A file dialog is opened if no filename is given.
3906 * \li Origin: gb, 05 Feb 2013
3909 { LFUN_VC_RENAME, "vc-rename", ReadOnly, System },
3912 * \var lyx::FuncCode lyx::LFUN_VC_REPO_UPDATE
3913 * \li Action: Update the local archive directory in which resides
3914 the current document with the remote repository.
3915 * \li Syntax: vc-repo-update
3916 * \li Origin: sanda, 16 Oct 2009
3919 { LFUN_VC_REPO_UPDATE, "vc-repo-update", ReadOnly, System },
3922 * \var lyx::FuncCode lyx::LFUN_VC_REVERT
3923 * \li Action: Reverts the document to the last check-in/commit in VCS.
3924 * \li Syntax: vc-revert
3925 * \li Origin: Lgb, 1 Jul 1997
3928 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
3931 * \var lyx::FuncCode lyx::LFUN_VC_UNDO_LAST
3932 * \li Action: Undo last check-in.
3933 * \li Notion: This is currently implemented only for RCS.
3934 * \li Syntax: vc-check-out
3935 * \li Origin: Lgb, 1 Jul 1997
3938 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
3941 * \var lyx::FuncCode lyx::LFUN_VIEW_CLOSE
3942 * \li Action: Close the current document work area.
3943 * \li Notion: Close the current work area. If no other work areas are showing the buffer,
3944 then close the associated buffer as well.
3945 * \li Syntax: view-close
3946 * \li Origin: Tommaso, 15 Sep 2012
3949 { LFUN_VIEW_CLOSE, "view-close", ReadOnly, Buffer },
3953 * \var lyx::FuncCode lyx::LFUN_VIEW_SPLIT
3954 * \li Action: Creates another split view of current buffer.
3955 * \li Notion: All split views act in the same way independently.
3956 * \li Syntax: view-split <vertical|horizontal>
3957 * \li Params: horizontal : The work areas are laid out side by side.\n
3958 vertical : The work areas laid out vertically.
3959 * \li Origin: Abdel, 20 Feb 2008
3962 { LFUN_VIEW_SPLIT, "view-split", ReadOnly, Buffer },
3966 * \var lyx::FuncCode lyx::LFUN_WINDOW_CLOSE
3967 * \li Action: Closes the current LyX window.
3968 * \li Syntax: window-close
3969 * \li Origin: Abdel, 23 Oct 2006
3972 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
3976 * \var lyx::FuncCode lyx::LFUN_WINDOW_NEW
3977 * \li Action: Creates new empty LyX window.
3978 * \li Notion: Already opened documents from the previous window can be found under View menu.
3979 * \li Syntax: window-new [<GEOMETRY>]
3980 * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently
3981 accepted only on Windows platform.
3982 * \li Origin: Abdel, 21 Oct 2006
3985 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
3988 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD
3989 * \li Action: Moves the cursor to the logically previous beginning of a word.
3990 * \li Notion: This is not the action which should be bound to the arrow keys,
3991 because backwards may be left or right, depending on the
3992 language. The arrow keys should be bound to #LFUN_WORD_LEFT or
3993 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
3994 * \li Syntax: word-backward
3997 { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit },
4000 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD_SELECT
4001 * \li Action: Moves the cursor to the logically previous beginning of a word,
4002 adding the logically traversed text to the selection.
4003 * \li Notion: See also #LFUN_WORD_BACKWARD.
4004 * \li Syntax: word-backward-select
4007 { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
4010 * \var lyx::FuncCode lyx::LFUN_WORD_CAPITALIZE
4011 * \li Action: Capitalizes the words in the selection (i.e. the first letters)
4012 or the first letter of word at cursor position.
4013 * \li Syntax: word-capitalize [<SEL_TYPE>]
4014 * \li Params: <SEL_TYPE>: if this is equal to "partial", then the
4015 * default word starts at cursor position (emacs-style).
4016 * Otherwise, the whole word is considered.
4019 { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
4022 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_BACKWARD
4023 * \li Action: Deletes characters to the beginning of the word (usually the "C+BackSpace" key).
4024 * \li Syntax: word-delete-backward [force]
4025 * \li Params: force: Delete big insets, do no only select them.
4028 { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
4031 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_FORWARD
4032 * \li Action: Deletes characters to the end of the word (usually the "C+Delete" key).
4033 * \li Syntax: word-delete-forward [force]
4034 * \li Params: force: Delete big insets, do no only select them.
4037 { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
4040 * \var lyx::FuncCode lyx::LFUN_WORD_FIND
4041 * \li Action: Search for next occurrence of a string.
4042 * \li Syntax: word-find [<DATA>]
4043 * \li Params: <DATA>: data encoded from Find dialog (see #lyx::find2string()).
4044 If no parameter is given, search with last find-dialog
4045 data is used for search (i.e. find-next).
4046 * \li Origin: Andre, Jan 7 2004
4049 { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
4052 * \var lyx::FuncCode lyx::LFUN_WORD_FINDADV
4053 * \li Action: Search for next occurrence of a pattern.
4054 * \li Syntax: word-findadv [<DATA>]
4055 * \li Params: <DATA>: data encoded from FindAdv dialog (see #lyx::findadv2string()).
4056 If no parameter is given, search with last find-dialog
4057 data is used for search (i.e. find-next).
4058 * \li Origin: Tommaso, Nov 15 2007
4061 { LFUN_WORD_FINDADV, "word-findadv", ReadOnly | NoBuffer, Edit },
4064 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_BACKWARD
4065 * \li Action: Search for a given string in backward direction.
4066 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
4067 * \li Syntax: word-find-backward [<STRING>]
4068 * \li Origin: Etienne, 20 Feb 1998
4071 { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
4074 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_FORWARD
4075 * \li Action: Search for a given string in forward direction.
4076 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
4077 * \li Syntax: word-find-forward [<STRING>]
4078 * \li Origin: Etienne, 16 Feb 1998
4081 { LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit },
4084 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD
4085 * \li Action: Moves the cursor to the logically next beginning of a word.
4086 * \li Notion: This is not the action which should be bound to the arrow keys,
4087 because forward may be left or right, depending on the language.
4088 The arrow keys should be bound to #LFUN_WORD_LEFT or
4089 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
4090 * \li Syntax: word-forward
4093 { LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
4096 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD_SELECT
4097 * \li Action: Moves the cursor to the logically next beginning of a word,
4098 adding the logically traversed text to the selection.
4099 * \li Notion: See also #LFUN_WORD_FORWARD.
4100 * \li Syntax: word-forward-select
4103 { LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
4106 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT
4107 * \li Action: Moves the cursor to the next beginning of a word "on the left".
4108 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
4109 "left" key is pressed. Generally, it moves the cursor to the
4110 next beginning of a word on the left. However, in Bidi text this
4111 become slightly more complicated, and there are different modes
4112 of cursor movement. In "visual mode", this moves left, plain and
4113 simple. In "logical mode", movement is logically forward in RTL
4114 paragraphs, and logically backwards in LTR paragraphs.
4115 * \li Syntax: word-left
4116 * \li Origin: dov, 28 Oct 2007
4119 { LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
4122 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT_SELECT
4123 * \li Action: Moves the cursor to the next beginning of a word "on the left",
4124 adding *logically* traversed text to the selection.
4125 * \li Notion: See also #LFUN_WORD_LEFT for exact details of the movement.
4126 * \li Syntax: word-left-select
4127 * \li Origin: dov, 28 Oct 2007
4130 { LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit },
4133 * \var lyx::FuncCode lyx::LFUN_WORD_LOWCASE
4134 * \li Action: Change the words in the selection or word at cursor position
4136 * \li Syntax: word-lowcase [<SEL_TYPE>]
4137 * \li Params: <SEL_TYPE>: if this is equal to "partial", then the
4138 * default word starts at cursor position (emacs-style).
4139 * Otherwise, the whole word is considered.
4142 { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
4145 * \var lyx::FuncCode lyx::LFUN_WORD_REPLACE
4146 * \li Action: Replace a string in the document.
4147 * \li Syntax: word-replace [<DATA>]
4148 * \li Params: <DATA>: data is of the form
4151 <casesensitive> <matchword> <all> <forward> <findnext>"
4152 * \li Origin: Andre, Jan 7 2004
4155 { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
4158 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT
4159 * \li Action: Moves the cursor to the next beginning of a word "on the right".
4160 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
4161 "right" key is pressed. Generally, it moves the cursor to the
4162 next beginning of a word on the right. However, in Bidi text
4163 this become slightly more complicated, and there are different
4164 modes of cursor movement. In "visual mode", this moves right,
4165 plain and simple. In "logical mode", movement is logically
4166 forward in LTR paragraphs, and logically backwards in RTL
4168 * \li Syntax: word-right
4169 * \li Origin: dov, 28 Oct 2007
4172 { LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit },
4175 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT_SELECT
4176 * \li Action: Moves the cursor to the next beginning of a word "on the right",
4177 adding *logically* traversed text to the selection.
4178 * \li Notion: See also #LFUN_WORD_RIGHT for exact details of the movement.
4179 * \li Syntax: word-right-select
4180 * \li Origin: dov, 28 Oct 2007
4183 { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
4186 * \var lyx::FuncCode lyx::LFUN_WORD_SELECT
4187 * \li Action: Puts the word where the cursor stands into the selection.
4188 * \li Syntax: word-select
4189 * \li Origin: Andre, 11 Sep 2002
4192 { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
4195 * \var lyx::FuncCode lyx::LFUN_WORD_UPCASE
4196 * \li Action: Change the words in the selection or word at cursor position
4198 * \li Syntax: word-upcase [<SEL_TYPE>]
4199 * \li Params: <SEL_TYPE>: if this is equal to "partial", then the
4200 * default word starts at cursor position (emacs-style).
4201 * Otherwise, the whole word is considered.
4204 { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
4207 * \var lyx::FuncCode lyx::LFUN_WRAP_INSERT
4208 * \li Action: Inserts floats wrapped by the text around.
4209 * \li Syntax: wrap-insert <TYPE>
4210 * \li Params: <TYPE>: table|figure
4211 * \li Origin: Dekel, 7 Apr 2002
4214 { LFUN_WRAP_INSERT, "wrap-insert", Noop, Edit },
4216 { LFUN_NOACTION, "", Noop, Hidden }
4217 #ifndef DOXYGEN_SHOULD_SKIP_THIS
4220 for (int i = 0; items[i].action != LFUN_NOACTION; ++i)
4221 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
4227 LyXAction::LyXAction()
4233 FuncRequest LyXAction::lookupFunc(string const & func) const
4235 string const func2 = trim(func);
4238 return FuncRequest(LFUN_NOACTION);
4241 string const arg = split(func2, cmd, ' ');
4243 FuncMap::const_iterator const fit = lyx_func_map.find(cmd);
4245 return fit != lyx_func_map.end()
4246 ? FuncRequest(fit->second, arg)
4247 : FuncRequest(LFUN_UNKNOWN_ACTION);
4251 string const LyXAction::getActionName(FuncCode action) const
4253 InfoMap::const_iterator const it = lyx_info_map.find(action);
4254 return it != lyx_info_map.end() ? it->second.name : string();
4258 LyXAction::FuncType LyXAction::getActionType(FuncCode action) const
4260 InfoMap::const_iterator const it = lyx_info_map.find(action);
4261 return it != lyx_info_map.end() ? it->second.type : Hidden;
4265 bool LyXAction::funcHasFlag(FuncCode action,
4266 LyXAction::FuncAttribs flag) const
4268 InfoMap::const_iterator ici = lyx_info_map.find(action);
4270 if (ici == lyx_info_map.end()) {
4271 LYXERR0("action: " << action << " is not known.");
4272 LASSERT(false, return false);
4275 return ici->second.attrib & flag;
4279 LyXAction::const_iterator LyXAction::func_begin() const
4281 return lyx_func_map.begin();
4285 LyXAction::const_iterator LyXAction::func_end() const
4287 return lyx_func_map.end();
4291 LyXErr & operator<<(LyXErr & l, FuncCode code)
4294 l.stream() << lyxaction.getActionName(code);