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.
586 <DEST> If present, this argument provides the export destination
587 filename. Its containing folder will also be the destination
588 folder, where all the needed external files will be copied.
589 * \li Origin: Lgb, 29 Jul 1997
592 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
595 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_AS
596 * \li Action: Opens a dialog for exporting the current buffer.
597 * \li Syntax: buffer-export-as [<FORMAT>]
598 * \li Params: <FORMAT> is the export format initially selected in the dialog.
599 * You can pass any of the formats which you can find in
600 * Tools->Preferences->File formats->Format, provided it
601 * has the "document" flag set. If no format is specified
602 * the dialog will start with the default output format of
603 * the current document.
604 * \li Sample: buffer-export-as pdf2
605 * \li Origin: tommaso, 6 Oct 2011
608 { LFUN_BUFFER_EXPORT_AS, "buffer-export-as", ReadOnly, Buffer },
611 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
612 * \li Action: Exports the current buffer (document) from the given format using
613 the given command on it.
614 * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
615 * \li Params: <FORMAT> format to start from (LyX will care to produce such
616 intermediate file).\n
617 <COMMAND> this command will be launched on the file. Note that you can
618 use "$$FName" string to qualify the intermediate file.
619 * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
620 * \li Origin: leeming, 27 Mar 2004
623 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
626 * \var lyx::FuncCode lyx::LFUN_BUFFER_FORALL
627 * \li Action: Applies a command to all non-hidden buffers.
628 * \li Notion: a buffer is `hidden' if it is internally open in LyX, but not
629 visible in any window.
630 * \li Syntax: buffer-forall <LFUN-COMMAND>
631 * \li Params: <LFUN-COMMAND>: The command to be applied to the buffers.
632 * \li Sample: Close all Notes in buffers: \n
633 buffer-forall inset-forall Note inset-toggle close \n
634 Toggle change tracking on buffers: \n
635 buffer-forall changes-track \n
636 Toggle read-only for buffers: \n
637 buffer-forall buffer-toggle-read-only \n
638 Show statistics for individual buffers: \n
639 buffer-forall statistics \n
640 Activate the branch named "Solutions" in buffers: \n
641 buffer-forall branch-activate Solutions \n
642 Export buffers to PDF (pdflatex): \n
643 buffer-forall buffer-export pdf2 \n
644 * \li Origin: skostysh, 20 Jul 2012
647 { LFUN_BUFFER_FORALL, "buffer-forall", ReadOnly | Argument, Buffer },
650 * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
651 * \li Action: Import a given file as a lyx document.
652 * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
653 defined converters in preferences. Look in the File->Import menu to get
654 an idea of the currently active import formats.
655 * \li Syntax: buffer-import <FORMAT> [<FILE>]
656 * \li Origin: Asger, 24 Jul 1998
659 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
662 * \var lyx::FuncCode lyx::LFUN_BUFFER_LANGUAGE
663 * \li Action: Set language of the current document.
664 * \li Syntax: buffer-language <LANG>
665 * \li Params: <LANG>: language name. See lib/languages for list.
666 * \li Origin: leeming, 30 Mar 2004
669 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
672 * \var lyx::FuncCode lyx::LFUN_BUFFER_MOVE_NEXT
673 * \li Action: Moves the current tab one spot to the right.
674 * \li Syntax: buffer-move-next
675 * \li Origin: skostysh, 7 Apr 2015
678 { LFUN_BUFFER_MOVE_NEXT, "buffer-move-next", ReadOnly, Buffer },
681 * \var lyx::FuncCode lyx::LFUN_BUFFER_MOVE_PREVIOUS
682 * \li Action: Moves the current tab one spot to the left.
683 * \li Syntax: buffer-move-previous
684 * \li Origin: skostysh, 7 Apr 2015
687 { LFUN_BUFFER_MOVE_PREVIOUS, "buffer-move-previous", ReadOnly, Buffer },
690 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
691 * \li Action: Creates a new buffer (that is, document) and switches to it.
692 * \li Notion: Implicit path can be set in Preferences dialog.
693 * \li Syntax: buffer-new [<FILE>]
694 * \li Params: <FILE>: filename of created file with absolute path.
697 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
700 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
701 * \li Action: Creates a new buffer (that is, document) from a template.
702 * \li Notion: Path for new files and templates can be set in Preferences dialog.
703 Template will be asked for via Open-dialog.
704 * \li Syntax: buffer-new-template [<FILE>]
705 * \li Params: <FILE>: filename of created file with absolute path.
708 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
711 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEXT
712 * \li Action: Switch to the next opened document.
713 * \li Notion: Note that this does not necessarily mean next in tabbar
714 (for full list see View menu).
715 * \li Syntax: buffer-next
718 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
721 * \var lyx::FuncCode lyx::LFUN_BUFFER_PARAMS_APPLY
722 * \li Action: Apply the given settings to the current document.
723 * \li Syntax: buffer-params-apply [<ARGS>]
724 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
725 you can find in document header of usual .lyx file.
726 * \li Origin: leeming, 30 Mar 2004
729 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", NoInternal, Buffer },
733 * \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS
734 * \li Action: Switch to the previous opened document.
735 * \li Syntax: buffer-previous
738 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
741 * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
742 * \li Action: Reverts opened document.
743 * \li Syntax: buffer-reload
744 * \li Origin: Asger, 2 Feb 1997
747 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
750 * \var lyx::FuncCode lyx::LFUN_BUFFER_SAVE_AS_DEFAULT
751 * \li Action: Save the current document settings as default.
752 * \li Notion: The file will will be saved into ~/.lyx/templates/defaults.lyx .
753 * \li Syntax: buffer-save-as-default [<ARGS>]
754 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
755 you can find in document header of usual .lyx file.
756 * \li Origin: leeming, 30 Mar 2004
759 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
762 * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
763 * \li Action: Display and switch to the given buffer.
764 * \li Syntax: buffer-switch <BUFFER>
765 * \li Params: <BUFFER>: path and filename of already opened (but possibly hidden)
766 document which is to be shown.
769 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
772 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
773 * \li Action: Toggles compression of the current document on/off.
774 * \li Syntax: buffer-toggle-compression
775 * \li Origin: bpeng, 27 Apr 2006
778 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
781 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_OUTPUT_SYNC
782 * \li Action: Toggles including of resources for forward/reverse search of the given document.
783 * \li Notion: When toggled on, SyncTeX is invoked for PDF, while srcltx package
784 is used for DVI. Custom LaTeX macro can be defined in preferences.
785 * \li Syntax: buffer-toggle-output-sync
786 * \li Origin: sanda, 25 May 2010
789 { LFUN_BUFFER_TOGGLE_OUTPUT_SYNC, "buffer-toggle-output-sync", Noop, System },
792 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
793 * \li Action: Toggle editing mode of the current document between read/write and read-only.
794 * \li Notion: This function is not allowed if the file is under version control, since
795 read-only flag is often used in version control file locking.
796 * \li Syntax: buffer-toggle-read-only
797 * \li Origin: Lgb, 27 May 1997
800 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
803 * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
804 * \li Action: Exports the current document and put the result into the
806 * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
807 the output will be rewritten - updated. This is useful in case your viewer
808 is able to detect such changes (e.g. ghostview for postscript).
809 * \li Syntax: buffer-update [<FORMAT>]
810 * \li Params: <FORMAT>: The format to display, where this is one of the
811 formats defined (in the current GUI) in the
812 Tools>Preferences>File Formats dialog.
813 If no format is given, the default format as
814 specified in the same dialog is used.
815 * \li Origin: Dekel, 5 Aug 2000
818 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
822 * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
823 * \li Action: Displays current buffer in chosen format.
824 * \li Notion: Displays the contents of the current buffer in the chosen
825 format, for example, PDF or DVI. This runs the necessary
826 converter, calls the defined viewer, and so forth.
827 * \li Syntax: buffer-view [<FORMAT>]
828 * \li Params: <FORMAT>: The format to display, where this is one of the
829 formats defined (in the current GUI) in the
830 Tools>Preferences>File Formats dialog.
831 If no format is given, the default format as
832 specified in the same dialog is used.
835 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
838 * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW_CACHE
839 * \li Action: Opens the file that was created from last preview of this buffer.
840 * \li Notion: This LFUN is called by the "Show Output Anyway" button in the LaTeX
841 * Errors dialog. It can also be called by the user, which is useful
842 * if the document takes a long time to compile, and you just
843 * want to see the last previewed version.
844 * \li Syntax: buffer-view-cache
847 { LFUN_BUFFER_VIEW_CACHE, "buffer-view-cache", ReadOnly, Buffer },
850 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
851 * \li Action: Saves the current buffer.
852 * \li Notion: Saves the current buffer to disk, using the filename that
853 is already associated with the buffer, asking for one if
854 none is yet assigned.
855 * \li Syntax: buffer-write
858 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
861 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
862 * \li Action: Save all changed documents.
863 * \li Syntax: buffer-write-all
864 * \li Origin: rgh, gpothier 6 Aug 2007
867 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
870 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
871 * \li Action: Rename and save current buffer.
872 * \li Syntax: buffer-write-as <FILENAME>
873 * \li Params: <FILENAME>: New name of the buffer/file. A relative path
874 is with respect to the original location of the buffer/file.
877 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
880 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_IN
881 * \li Action: Increases the zoom of the screen fonts.
882 * \li Syntax: buffer-zoom-in [<ZOOM>]
883 * \li Params: <ZOOM>: The zoom in % points (neg. or pos.), the default is 20.
884 * \li Origin: vfr, 30 Mar 2009
887 { LFUN_BUFFER_ZOOM_IN, "buffer-zoom-in", ReadOnly, Buffer },
891 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_OUT
892 * \li Action: Decreases the zoom of the screen fonts.
893 * \li Syntax: buffer-zoom-out [<ZOOM>]
894 * \li Params: <ZOOM>: The zoom in % points (neg. or pos.), the default is -20.
895 * \li Origin: vfr, 30 Mar 2009
898 { LFUN_BUFFER_ZOOM_OUT, "buffer-zoom-out", ReadOnly, Buffer },
902 * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
903 * \li Action: Generates the code (literate programming).
904 * \li Notion: Latex file with extension \literate_extension is generated.
905 Then LyX invokes \build_command (with a default of ``make'') to generate the code and
906 \build_error_filter to process the compilation error messages. \n
907 In case you want to process your literate file with a script, or some other program,
908 just insert in your lyxrc file an entry with:\n
909 \build_command "my_script my_arguments" \n
910 The \build_error_filter differs from the \literate_error_filter only in that the
911 former will identify error messages from your compiler.
912 * \li Syntax: build-program
915 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
919 * \var lyx::FuncCode lyx::LFUN_CALL
920 * \li Action: Executes a command defined in a .def file.
921 * \li Notion: The definitions are by default read from lib/commands/default.def.\n
922 A .def file allows to define a command with \define "<NAME>" "<LFUN>"
923 where <NAME> is the name of the new command and <LFUN> is the lfun code
924 to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
925 \def_file "FileName" allows to include another .def file. \n
926 This is particularly useful in connection with toolbar buttons:
927 Since the name of the button image for this lfun is
928 lib/images/commands/<NAME>.png this is the way to assign an image
929 to a complex command-sequence.
930 * \li Syntax: call <NAME>
931 * \li Params: <NAME>: Name of the command that must be called.
932 * \li Origin: broider, 2 Oct 2007
935 { LFUN_CALL, "call", NoBuffer, System },
938 * \var lyx::FuncCode lyx::LFUN_CANCEL
939 * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
943 { LFUN_CANCEL, "cancel", NoBuffer, System },
947 * \var lyx::FuncCode lyx::LFUN_CAPTION_INSERT
948 * \li Action: Inserts a caption inset.
949 * \li Syntax: caption-insert
950 * \li Origin: Lgb, 18 Jul 2000
953 { LFUN_CAPTION_INSERT, "caption-insert", Noop, Edit },
956 * \var lyx::FuncCode lyx::LFUN_CELL_BACKWARD
957 * \li Action: Moves the cursor to the previous cell inside the table.
958 * \li Syntax: cell-backward
959 * \li Origin: Jug, 22 May 2000
962 { LFUN_CELL_BACKWARD, "cell-backward", ReadOnly | NoUpdate, Edit },
965 * \var lyx::FuncCode lyx::LFUN_CELL_FORWARD
966 * \li Action: Moves the cursor to the next cell inside the table.
967 * \li Syntax: cell-forward
970 { LFUN_CELL_FORWARD, "cell-forward", ReadOnly | NoUpdate, Edit },
973 * \var lyx::FuncCode lyx::LFUN_CELL_SPLIT
974 * \li Action: Splits cell and shifts right part to the next cell (inside the math grid).
975 * \li Syntax: cell-split
976 * \li Origin: Ale, 15 May 1997
979 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
983 * \var lyx::FuncCode lyx::LFUN_CHANGES_MERGE
984 * \li Action: Open change tracking dialog for merging and moves the cursor
985 to the position of the next change.
986 * \li Syntax: changes-merge
987 * \li Origin: Levon, 16 Oct 2002
990 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
993 * \var lyx::FuncCode lyx::LFUN_CHANGES_OUTPUT
994 * \li Action: Toggles showing of change tracking in typeset output.
995 * \li Syntax: changes-output
996 * \li Origin: jspitzm, 21 Jan 2005
999 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
1002 * \var lyx::FuncCode lyx::LFUN_CHANGES_TRACK
1003 * \li Action: Toggles change tracking to on/off.
1004 * \li Syntax: changes-track
1005 * \li Origin: levon, 1 Oct 2002
1008 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
1011 * \var lyx::FuncCode lyx::LFUN_CHANGE_ACCEPT
1012 * \li Action: Accepts tracked change inside the selection.
1013 * \li Syntax: change-accept
1014 * \li Origin: Levon, 16 Oct 2002
1017 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
1020 * \var lyx::FuncCode lyx::LFUN_CHANGE_NEXT
1021 * \li Action: Moves the cursor to the position of the next change
1022 of the change tracking records.
1023 * \li Syntax: change-next
1024 * \li Origin: schmitt, 4 Oct 2006
1027 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
1030 * \var lyx::FuncCode lyx::LFUN_CHANGE_PREVIOUS
1031 * \li Action: Moves the cursor to the position of the previous change
1032 of the change tracking records.
1033 * \li Syntax: change-previous
1034 * \li Origin: vfr, 4 Apr 2009
1037 { LFUN_CHANGE_PREVIOUS, "change-previous", ReadOnly, Edit },
1040 * \var lyx::FuncCode lyx::LFUN_CHANGE_REJECT
1041 * \li Action: Rejects tracked change inside the selection.
1042 * \li Syntax: change-reject
1043 * \li Origin: Levon, 16 Oct 2002
1046 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
1049 * \var lyx::FuncCode lyx::LFUN_CHARS_TRANSPOSE
1050 * \li Action: Transposes the character at the cursor with the one before it.
1051 * \li Syntax: chars-transpose
1052 * \li Origin: Lgb, 25 Apr 2001
1055 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
1059 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD
1060 * \li Action: Moves the cursor one position logically backwards.
1061 * \li Notion: This is not the action which should be bound to the arrow keys,
1062 because backwards may be left or right, depending on the
1063 language. The arrow keys should be bound to #LFUN_CHAR_LEFT or
1064 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
1065 * \li Syntax: char-backward
1068 { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit },
1071 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD_SELECT
1072 * \li Action: Moves the cursor one position logically backwards, adding
1073 traversed position to the selection.
1074 * \li Notion: See also #LFUN_CHAR_BACKWARD.
1075 * \li Syntax: char-backward-select
1078 { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit },
1081 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_BACKWARD
1082 * \li Action: Deletes one character in the backward direction (usually the "BackSpace" key).
1083 * \li Syntax: char-delete-backward [force]
1084 * \li Params: force: Delete big insets, do no only select them.
1087 { LFUN_CHAR_DELETE_BACKWARD, "char-delete-backward", SingleParUpdate, Edit },
1090 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_FORWARD
1091 * \li Action: Deletes one character in the backward direction (usually the "Delete" key).
1092 * \li Syntax: char-delete-forward [force]
1093 * \li Params: force: Delete big insets, do no only select them.
1096 { LFUN_CHAR_DELETE_FORWARD, "char-delete-forward", SingleParUpdate, Edit },
1099 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD
1100 * \li Action: Moves the cursor one position logically forward.
1101 * \li Notion: This is not the action which should be bound to the arrow keys,
1102 because forward may be left or right, depending on the language.
1103 The arrow keys should be bound to #LFUN_CHAR_LEFT or
1104 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
1105 * \li Syntax: char-forward
1108 { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit },
1111 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD_SELECT
1112 * \li Action: Moves the cursor one position logically forward, adding
1113 traversed position to the selection.
1114 * \li Notion: See also #LFUN_CHAR_FORWARD.
1115 * \li Syntax: char-forward-select
1118 { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit },
1121 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT
1122 * \li Action: Moves the cursor one position "to the left".
1123 * \li Notion: This is the action which should be taken when the "left" key
1124 is pressed. Generally, it moves the cursor one position to the
1125 left. However, in Bidi text this become slightly more
1126 complicated, and there are different modes of cursor movement.
1127 In "visual mode", this moves left, plain and simple. In "logical
1128 mode", movement is logically forward in RTL paragraphs, and
1129 logically backwards in LTR paragraphs.
1130 * \li Syntax: char-left
1133 { LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit },
1136 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT_SELECT
1137 * \li Action: Moves the cursor one position "to the left", adding
1138 traversed position to the selection.
1139 * \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement.
1140 * \li Syntax: char-left-select
1143 { LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit },
1146 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT
1147 * \li Action: Moves the cursor one position "to the right".
1148 * \li Notion: This is the action which should be taken when the "right" key
1149 is pressed. Generally, it moves the cursor one position to the
1150 right. However, in Bidi text this become slightly more
1151 complicated, and there are different modes of cursor movement.
1152 In "visual mode", this moves right, plain and simple. In "logical
1153 mode", movement is logically forward in LTR paragraphs, and
1154 logically backwards in RTL paragraphs.
1155 * \li Syntax: char-right
1158 { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit },
1161 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT_SELECT
1162 * \li Action: Moves the cursor one position "to the right", adding
1163 traversed position to the selection.
1164 * \li Notion: See also #LFUN_CHAR_RIGHT for exact details of the movement.
1165 * \li Syntax: char-right-select
1168 { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit },
1172 * \var lyx::FuncCode lyx::LFUN_CITATION_INSERT
1173 * \li Action: Inserts citation from loaded citation database.
1174 * \li Syntax: citation-insert [<KEY>[|<TEXT_BEFORE>]]
1175 * \li Params: <KEY>: Citation (shortcut listed in available citations). \n
1176 <TEXT_BEFORE>: text which should appear before citation.
1177 * \li Origin: AAS, 97-02-23
1180 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
1183 * \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE
1184 * \li Action: Pastes text from the active clipboard (retains formatting if the
1185 clipboard contains formatted text). Pastes plain text if plain text is
1186 on the clipboard, but tries to interpret it in special ways for certain
1187 insets, e.g. converting csv data to rows and columns if the paste happens
1189 * \li Notion: Historically, LFUN_CLIPBOARD_PASTE was introduced as a counterpart of
1190 LFUN_PRIMARY_SELECTION_PASTE: It behaved exactly the same, but the source
1191 is the clipboard, not the selection.
1192 * \li Syntax: clipboard-paste [<ARG>]
1193 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1194 * \li Origin: Georg, 10 Jul 2006
1197 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
1200 * \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE_SIMPLE
1201 * \li Action: Pastes plain text from the active clipboard even if formatted
1202 LyX content is in the clipboard. Pastes plain text if plain text
1203 is on the clipboard, without trying to interpret it in special
1204 ways for certain insets, e.g. converting csv data to rows and
1205 columns if the paste happens in a tabular inset.
1206 * \li Syntax: clipboard-paste-simple [<ARG>]
1207 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1210 { LFUN_CLIPBOARD_PASTE_SIMPLE, "clipboard-paste-simple", Noop, Edit },
1213 * \var lyx::FuncCode lyx::LFUN_COMMAND_ALTERNATIVES
1214 * \li Action: Runs the first listed command that is enabled.
1215 * \li Notion: This can be used to bind multiple functions to a single key,
1216 and then which one is used will depend upon the context.
1217 * \li Syntax: command-alternatives <CMDS>
1218 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
1219 * \li Sample: command-alternatives completion-accept;cell-forward
1220 * \li Origin: rgh, 24 September 2008
1223 { LFUN_COMMAND_ALTERNATIVES, "command-alternatives", NoBuffer, System },
1226 * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
1227 * \li Action: Switches the focus to the minibuffer so that the user can type
1228 in there. If necessary, it opens the minibuffer toolbar.
1229 * \li Notion: Usually bound to M-x shortcut.
1230 * \li Syntax: command-execute
1233 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
1237 * \var lyx::FuncCode lyx::LFUN_COMMAND_PREFIX
1238 * \li Action: Return the current key sequence and available options as a string.
1239 * \li Notion: No options are added if no current map exists. \n
1240 This is probably usable only with connection to lyxserver.
1241 * \li Syntax: command-prefix
1244 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
1247 * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
1248 * \li Action: Run more commands (LFUN and its parameters) in a sequence.
1249 * \li Syntax: command-sequence <CMDS>
1250 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
1251 * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
1252 * \li Origin: Andre, 11 Nov 1999
1255 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
1258 * \var lyx::FuncCode lyx::LFUN_COMPLETE
1259 * \li Action: Try to complete the word or command at the cursor position.
1260 * \li Syntax: complete
1261 * \li Origin: sts, Feb 19 2008
1264 { LFUN_COMPLETE, "complete", SingleParUpdate, Edit },
1268 * \var lyx::FuncCode lyx::LFUN_COMPLETION_ACCEPT
1269 * \li Action: Accept suggested completion.
1270 * \li Syntax: completion-accept
1271 * \li Origin: sanda, Sep 08 2008
1274 { LFUN_COMPLETION_ACCEPT, "completion-accept", SingleParUpdate, Edit },
1279 * \var lyx::FuncCode lyx::LFUN_COMPLETION_CANCEL
1280 * \li Action: Try to cancel completion, either the popup or the inline completion.
1281 * \li Syntax: completion-cancel
1282 * \li Origin: sts, Sep 07 2008
1285 { LFUN_COMPLETION_CANCEL, "completion-cancel", SingleParUpdate, Edit },
1288 * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
1289 * \li Action: Show the inline completion at the cursor position.
1290 * \li Syntax: completion-inline
1291 * \li Origin: sts, Feb 19 2008
1294 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
1297 * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
1298 * \li Action: Show the completion popup at the cursor position.
1299 * \li Syntax: completion-popup
1300 * \li Origin: sts, Feb 19 2008
1303 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
1306 * \var lyx::FuncCode lyx::LFUN_COPY
1307 * \li Action: Copies the current selection to the clipboard.
1311 { LFUN_COPY, "copy", ReadOnly, Edit },
1314 * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
1315 * \li Action: Determine whether to keep cursor inside the editing window regardless
1316 of the scrollbar movement.
1317 * \li Syntax: toggle-cursor-follows-scrollbar
1318 * \li Origin: ARRae, 2 Dec 1997
1321 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
1324 * \var lyx::FuncCode lyx::LFUN_CUT
1325 * \li Action: Cuts to the clipboard.
1329 { LFUN_CUT, "cut", Noop, Edit },
1332 * \var lyx::FuncCode lyx::LFUN_DATE_INSERT
1333 * \li Action: Inserts the current date.
1334 * \li Syntax: date-insert [<ARG>]
1335 * \li Params: <ARG>: Format of date. The default value (%x) can be set
1336 in Preferences->Date format. For possible formats
1337 see manual page of strftime function.
1338 * \li Origin: jdblair, 31 Jan 2000
1341 { LFUN_DATE_INSERT, "date-insert", Noop, Edit },
1344 * \var lyx::FuncCode lyx::LFUN_DEBUG_LEVEL_SET
1345 * \li Action: Set debug output level.
1346 * \li Syntax: debug-level-set <LEVEL>
1347 * \li Params: <LEVEL>: comma separated list of levels or the correspondent number
1348 of their combination. 0 is equivalent to disabling all debug
1349 events. See lyx -dbg for the current list of debug levels
1351 * \li Origin: sanda, 28 Dec 2009
1354 { LFUN_DEBUG_LEVEL_SET, "debug-level-set", NoBuffer, System },
1358 * \var lyx::FuncCode lyx::LFUN_DEPTH_DECREMENT
1359 * \li Action: Decrease the nesting depth of the (selected) paragraph(s)
1361 * \li Syntax: depth-decrement
1364 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
1367 * \var lyx::FuncCode lyx::LFUN_DEPTH_INCREMENT
1368 * \li Action: Increase the nesting depth of the (selected) paragraph(s)
1370 * \li Syntax: depth-increment
1373 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
1377 * \var lyx::FuncCode lyx::LFUN_DIALOG_DISCONNECT_INSET
1378 * \li Action: Closes opened connection to opened inset.
1379 * \li Notion: Connection is used for apply functions.
1380 * \li Syntax: dialog-disconnect-inset <INSET-NAME>
1381 * \li Origin: leeming, 25 Feb 2003
1384 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
1388 * \var lyx::FuncCode lyx::LFUN_DIALOG_HIDE
1389 * \li Action: Hides showed dialog. Counterpart to #LFUN_DIALOG_SHOW .
1390 * \li Syntax: dialog-hide <NAME>
1391 * \li Params: See #LFUN_DIALOG_SHOW .
1392 * \li Origin: leeming, 25 Feb 2003
1395 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
1398 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW
1399 * \li Action: Shows hidden dialog or creates new one for a given function/inset settings etc.
1400 * \li Syntax: dialog-show <NAME> [<DATA>]
1401 * \li Params: <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|\n
1402 compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|\n
1403 graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimiter|\n
1404 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|\n
1405 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|\n
1406 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL> \n
1407 <SPECIAL>: latexlog|vclog \n
1408 <DATA>: data, usually settings for the given dialog. Use debug mode for the
1410 * \li Origin: leeming, 17 Jun 2003
1413 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
1416 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW_NEW_INSET
1417 * \li Action: Shows hidden dialog or create new one for a given inset settings etc.
1418 * \li Notion: Internally uses #LFUN_DIALOG_SHOW with processed data for a given inset.
1419 * \li Syntax: dialog-show-new-inset <NAME> [<DATA>]
1420 * \li Params: See #LFUN_DIALOG_SHOW .
1421 * \li Origin: leeming, 25 Feb 2003
1424 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
1427 * \var lyx::FuncCode lyx::LFUN_DIALOG_TOGGLE
1428 * \li Action: Toggles dialog between showed/hidden state.
1429 * \li Notion: Internally uses #LFUN_DIALOG_SHOW , #LFUN_DIALOG_HIDE .
1430 * \li Syntax: dialog-toggle <NAME> [<DATA>]
1431 * \li Params: See #LFUN_DIALOG_SHOW .
1432 * \li Origin: JSpitzm, 30 Apr 2007
1435 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
1438 * \var lyx::FuncCode lyx::LFUN_DIALOG_UPDATE
1439 * \li Action: Updates the dialog values from the inset/paragraph/document.
1440 * \li Syntax: dialog-update <NAME>
1441 * \li Params: <NAME>: paragraph|prefs|<INSET> \n
1443 * \li Origin: leeming, 25 Feb 2003
1446 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
1449 * \var lyx::FuncCode lyx::LFUN_DOWN
1450 * \li Action: Moves the cursor one line in downward direction.
1454 { LFUN_DOWN, "down", ReadOnly | NoUpdate, Edit },
1457 * \var lyx::FuncCode lyx::LFUN_DOWN_SELECT
1458 * \li Action: Moves the cursor one line in downward direction adding the current
1459 position to the selection.
1460 * \li Syntax: down-select
1463 { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, Edit },
1466 * \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE
1467 * \li Action: Displays list of layout choices.
1468 * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
1469 dropbox allowing for choice of layout.
1470 * \li Syntax: drop-layouts-choice
1473 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
1476 * \var lyx::FuncCode lyx::LFUN_ENVIRONMENT_SPLIT
1477 * \li Action: Splits the current environment with a Separator.
1478 * \li Syntax: environment-split [outer]
1479 * \li Params: outer: If this is given, LyX will split the outermost environment in
1480 * the current nesting hierarchy.
1481 * \li Origin: spitz, 23 Dec 2012
1484 { LFUN_ENVIRONMENT_SPLIT, "environment-split", Noop, Layout },
1488 * \var lyx::FuncCode lyx::LFUN_ERT_INSERT
1489 * \li Action: Inserts an ERT inset.
1490 * \li Syntax: ert-insert
1491 * \li Origin: Jug, 18 Feb 2000
1494 { LFUN_ERT_INSERT, "ert-insert", Noop, Edit },
1497 * \var lyx::FuncCode lyx::LFUN_ESCAPE
1498 * \li Action: Clears the selection. If no text is selected call #LFUN_FINISHED_FORWARD.
1499 Inside math mode jumps out of the math inset.
1500 * \li Syntax: escape
1501 * \li Origin: Lgb, 17 May 2001
1504 { LFUN_ESCAPE, "escape", ReadOnly, Edit },
1507 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
1508 * \li Action: Inserts another LyX file.
1509 * \li Syntax: file-insert [<FILE>]
1510 * \li Params: <FILE>: Filename to be inserted.
1513 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
1516 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
1517 * \li Action: Inserts plain text file.
1518 * \li Syntax: file-insert-plaintext [<FILE>]
1519 * \li Params: <FILE>: Filename to be inserted.
1520 * \li Origin: CFO-G, 19 Nov 1997
1523 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
1526 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
1527 * \li Action: Inserts plain text file as paragraph (i.e. join lines).
1528 * \li Syntax: file-insert-plaintext-para [<FILE>]
1529 * \li Params: <FILE>: Filename to be inserted.
1530 * \li Origin: Levon, 14 Feb 2001
1533 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
1536 * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
1537 * \li Action: Open LyX document.
1538 * \li Syntax: file-open [<FILE>]
1539 * \li Params: <FILE>: Filename to be opened.
1542 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
1546 * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
1547 * \li Action: Moves the cursor out of the current slice, going backwards.
1548 * \li Notion: See also #LFUN_FINISHED_FORWARD.
1551 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
1554 * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
1555 * \li Action: Moves the cursor out of the current slice, going forward.
1556 * \li Notion: Cursor movement within an inset may be different than cursor
1557 movement in the surrounding text. This action should be called
1558 automatically by the cursor movement within the inset, when
1559 movement within the inset has ceased (reached the end of the
1560 last paragraph, for example), in order to move correctly
1561 back into the surrounding text.
1564 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
1567 * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
1568 * \li Action: Moves the cursor out of the current slice, going left.
1569 * \li Notion: See also #LFUN_FINISHED_FORWARD.
1572 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
1576 * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
1577 * \li Action: Moves the cursor out of the current slice, going right.
1578 * \li Notion: See also #LFUN_FINISHED_FORWARD
1581 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
1584 * \var lyx::FuncCode lyx::LFUN_FLEX_INSERT
1585 * \li Action: Inserts CharStyle, Custom inset or XML short element.
1586 * \li Notion: Look into the Customization manual for more information about
1588 To make this command enabled the layout file for the document
1589 class you're using has to load the character styles. There are
1590 a few contained in the Logical Markup module. You can also of
1591 course create some yourself. \n
1592 For dissolving the element see #LFUN_INSET_DISSOLVE.
1593 * \li Syntax: flex-insert Name
1594 * \li Params: Name: This name must be defined either in your layout file
1595 or imported by some module. The definition is
1596 InsetLayout Name or InsetLayout <Flex:Name>. The Flex:
1598 * \li Sample: flex-insert Code
1601 { LFUN_FLEX_INSERT, "flex-insert", Noop, Edit },
1604 * \var lyx::FuncCode lyx::LFUN_FLOAT_INSERT
1605 * \li Action: Inserts a float inset.
1606 * \li Syntax: float-insert <TYPE>
1607 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
1608 "algorithm", "table", "figure" parameters can be given.
1609 * \li Origin: Lgb, 27 Jun 2000
1612 { LFUN_FLOAT_INSERT, "float-insert", Noop, Edit },
1615 * \var lyx::FuncCode lyx::LFUN_FLOAT_LIST_INSERT
1616 * \li Action: Inserts the list of floats in the document.
1617 * \li Syntax: float-list-insert <TYPE>
1618 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
1619 "algorithm", "table", "figure" parameters can be given.
1620 * \li Origin: Lgb, 3 May 2001
1623 { LFUN_FLOAT_LIST_INSERT, "float-list-insert", Noop, Edit },
1626 * \var lyx::FuncCode lyx::LFUN_FLOAT_WIDE_INSERT
1627 * \li Action: Inserts float insets as in #LFUN_FLOAT_INSERT but span multiple columns.
1628 * \li Notion: Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
1629 * \li Syntax: float-wide-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, 31 Oct 2001
1635 { LFUN_FLOAT_WIDE_INSERT, "float-wide-insert", Noop, Edit },
1638 * \var lyx::FuncCode lyx::LFUN_FONT_BOLD
1639 * \li Action: Toggles the bold font (selection-wise) using mathbf in math.
1640 * \li Syntax: font-bold
1643 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
1647 * \var lyx::FuncCode lyx::LFUN_FONT_BOLDSYMBOL
1648 * \li Action: Toggles the bold font (selection-wise) using boldsymbol in math.
1649 * \li Syntax: font-boldsymbol
1652 { LFUN_FONT_BOLDSYMBOL, "font-boldsymbol", Noop, Layout },
1655 * \var lyx::FuncCode lyx::LFUN_FONT_DEFAULT
1656 * \li Action: Reverts the settings of the font to the default values (selection-wise).
1657 * \li Syntax: font-default
1660 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
1663 * \var lyx::FuncCode lyx::LFUN_FONT_EMPH
1664 * \li Action: Toggles the emphasis font style (selection-wise).
1665 * \li Syntax: font-emph
1668 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
1671 * \var lyx::FuncCode lyx::LFUN_FONT_FRAK
1672 * \li Action: Toggles Fraktur family font (math-mode, selection-wise).
1673 * \li Syntax: font-frak
1674 * \li Origin: vermeer, 10 Jan 2002
1677 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
1680 * \var lyx::FuncCode lyx::LFUN_FONT_ITAL
1681 * \li Action: Toggles Italics font shape (math-mode, selection-wise).
1682 * \li Syntax: font-ital
1683 * \li Origin: vermeer, 10 Jan 2002
1686 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
1689 * \var lyx::FuncCode lyx::LFUN_FONT_NOUN
1690 * \li Action: Toggles Noun text style font (selection-wise).
1691 * \li Syntax: font-noun
1694 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
1697 * \var lyx::FuncCode lyx::LFUN_FONT_ROMAN
1698 * \li Action: Toggles Roman family font (selection-wise).
1699 * \li Syntax: font-roman
1702 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
1705 * \var lyx::FuncCode lyx::LFUN_FONT_SANS
1706 * \li Action: Toggles Sans Serif family font (selection-wise).
1707 * \li Syntax: font-sans
1710 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
1713 * \var lyx::FuncCode lyx::LFUN_FONT_SIZE
1714 * \li Action: Sets font size according to lyx format string.
1715 * \li Syntax: font-size <SIZE>
1716 * \li Params: <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|\n
1717 largest|huge|giant|increase|decrease|default
1720 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
1723 * \var lyx::FuncCode lyx::LFUN_FONT_STATE
1724 * \li Action: Returns the info about the current font.
1725 * \li Syntax: font-state
1728 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
1732 * \var lyx::FuncCode lyx::LFUN_FONT_STRIKEOUT
1733 * \li Action: Toggles strikeout (strike-through) in the font (selection-wise).
1734 * \li Syntax: font-strikeout
1735 * \li Origin: sanda, 3 May 2009
1738 { LFUN_FONT_STRIKEOUT, "font-strikeout", Noop, Layout },
1741 * \var lyx::FuncCode lyx::LFUN_FONT_TYPEWRITER
1742 * \li Action: Toggles the typewriter family font (selection-wise).
1743 * \li Syntax: font-typewriter
1746 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
1749 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERLINE
1750 * \li Action: Toggles underline in the font (selection-wise).
1751 * \li Syntax: font-underline
1754 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
1757 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERUNDERLINE
1758 * \li Action: Toggles double underline in the font (selection-wise).
1759 * \li Syntax: font-underunderline
1760 * \li Origin: sanda, 5 May 2009
1763 { LFUN_FONT_UNDERUNDERLINE, "font-underunderline", Noop, Layout },
1766 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERWAVE
1767 * \li Action: Toggles wavy underline in the font (selection-wise).
1768 * \li Syntax: font-underwave
1769 * \li Origin: sanda, 5 May 2009
1772 { LFUN_FONT_UNDERWAVE, "font-underwave", Noop, Layout },
1775 * \var lyx::FuncCode lyx::LFUN_FOOTNOTE_INSERT
1776 * \li Action: Inserts a footnote inset.
1777 * \li Syntax: footnote-insert
1778 * \li Origin: Jug, 7 Mar 2000
1781 { LFUN_FOOTNOTE_INSERT, "footnote-insert", Noop, Edit },
1784 * \var lyx::FuncCode lyx::LFUN_FORWARD_SEARCH
1785 * \li Action: Sets the cursor position in the previewed (dvi/pdf) file based on the row
1786 number in LyX window.
1787 * \li Notion: The external program used for forward search call can be specified in
1788 LyX Output preferences. See Additional manual for details of these
1790 * \li Syntax: forward-search
1791 * \li Origin: sanda, 14 Apr 2010
1794 { LFUN_FORWARD_SEARCH, "forward-search", ReadOnly, System },
1797 * \var lyx::FuncCode lyx::LFUN_GRAPHICS_RELOAD
1798 * \li Action: Reloads the image if necessary.
1799 * \li Syntax: graphics-reload
1800 * \li Origin: vfr, 10 Aug 2009
1803 { LFUN_GRAPHICS_RELOAD, "graphics-reload", ReadOnly | AtPoint, Edit },
1806 * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
1807 * \li Action: Open the given help file according to the language setting.
1808 * \li Syntax: help-open <FILE>[.lyx]
1809 * \li Params: <FILE>: any document from (/usr/share/)doc directory.
1810 * \li Origin: Jug, 27 Jun 1999
1813 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
1816 * \var lyx::FuncCode lyx::LFUN_HREF_INSERT
1817 * \li Action: Inserts hyperlinks into the document (clickable in pdf output).
1818 * \li Notion: Hyperlink target can be set via selection + hyperlink-insert function.
1819 * \li Syntax: href-insert [<TARGET>]
1820 * \li Origin: CFO-G, 21 Nov 1997
1823 { LFUN_HREF_INSERT, "href-insert", Noop, Edit },
1826 * \var lyx::FuncCode lyx::LFUN_ICON_SIZE
1827 * \li Action: Sets icon size of toolbars.
1828 * \li Syntax: icon-size [<SIZE>]
1829 * \li Params: <SIZE> : the icon size in px or one of the logical settings
1830 small|normal|big|huge|giant, the default is normal
1831 (whose size in px is icon set dependent).
1832 * \li Origin: 11 July 2016
1835 { LFUN_ICON_SIZE, "icon-size", NoBuffer, Buffer },
1838 * \var lyx::FuncCode lyx::LFUN_INDEX_INSERT
1839 * \li Action: Inserts Index entry.
1840 * \li Notion: It automatically takes the word on the cursor position.
1841 * \li Syntax: index-insert [<TYPE:Name>]
1842 * \li Params: <TYPE:Name>: name of the index, if multiple indices are defined.
1843 With an empty argument, the default index is selected.
1844 * \li Origin: leeming, 3 Aug 2000
1847 { LFUN_INDEX_INSERT, "index-insert", Noop, Edit },
1850 * \var lyx::FuncCode lyx::LFUN_INDEX_PRINT
1851 * \li Action: Inserts list of Index entries on a new page.
1852 * \li Syntax: index-print [<TYPE:Name>]
1853 * \li Params: <TYPE:Name>: name of the index, if multiple indices are defined.
1854 With an empty argument, the default index is selected.
1855 * \li Origin: Lgb, 27 Feb 1997
1858 { LFUN_INDEX_PRINT, "index-print", Noop, Edit },
1861 * \var lyx::FuncCode lyx::LFUN_INFO_INSERT
1862 * \li Action: Displays shortcuts, lyxrc, package and textclass availability and menu
1863 information in a non-editable boxed InsetText.
1864 * \li Notion: Apart from lfun arguments you can use the following method: \n
1865 1. input the type and argument of this inset, e.g. "menu paste", in
1867 2. select the text and run info-insert lfun.
1868 * \li Syntax: info-insert <TYPE> <ARG>
1869 * \li Params: <TYPE>: shortcut[s]|lyxrc|lyxinfo|package|textclass|menu|buffer \n
1870 <ARG>: argument for a given type. Look into InsetInfo.h for detailed
1872 shortcut[s]: name of lfun (e.g math-insert \alpha) \n
1873 lyxrc: name of rc_entry (e.g. bind_file) \n
1874 lyxinfo: "version" - used version of LyX \n
1875 package: name of latex package (e.g. listings) \n
1876 textclass: name of textclass (e.g. article) \n
1877 menu: name of lfun used in menu \n
1878 icon: icon of lfun used in toolbar or direct icon name\n
1879 buffer: "name"|"path"|"class"|"vcs-tree-revision"|
1880 "vcs-revision"|"vcs-author"|"vcs-date"|"vcs-time"
1881 * \li Sample: command-sequence info-insert buffer path; info-insert buffer name
1882 * \li Origin: bpeng, 7 Oct 2007
1885 { LFUN_INFO_INSERT, "info-insert", Noop, Edit },
1888 * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
1889 * \li Action: Apply data for an inset.
1890 * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
1891 be applied. This is either changed to #LFUN_INSET_MODIFY or
1892 #LFUN_INSET_INSERT depending on the context where it is called.
1893 * \li Syntax: inset-apply <ARGS>
1894 * \li Params: See #LFUN_INSET_INSERT .
1897 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
1900 * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN
1901 * \li Action: Move the cursor to the beginning of the current inset
1902 if it is not already there, or at the beginning of the
1903 enclosing inset otherwise
1904 * \li Syntax: inset-begin
1905 * \li Origin: lasgouttes, 16 Mar 2009
1908 { LFUN_INSET_BEGIN, "inset-begin", ReadOnly, Edit },
1911 * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN_SELECT
1912 * \li Action: Move the cursor to the beginning of the current inset
1913 if it is not already there, or at the beginning of the
1914 enclosing inset otherwise (adding the
1915 traversed text to the selection).
1916 * \li Syntax: inset-begin-select
1917 * \li Origin: lasgouttes, 16 Mar 2009
1920 { LFUN_INSET_BEGIN_SELECT, "inset-begin-select", ReadOnly, Edit },
1923 * \var lyx::FuncCode lyx::LFUN_INSET_COPY_AS
1924 * \li Action: Copies the inset to the clipboard as a certain type.
1925 * \li Notion: Currently used only for InsetInfo where its content is copied as a text.
1926 * \li Syntax: inset-copy-as
1927 * \li Origin: vfr, 18 Apr 2010
1930 { LFUN_INSET_COPY_AS, "inset-copy-as", ReadOnly | NoUpdate | AtPoint, Edit },
1934 * \var lyx::FuncCode lyx::LFUN_INSET_DIALOG_UPDATE
1935 * \li Action: Updates the values inside the dialog from the inset.
1936 * \li Notion: This is an internal LFUN, not to be used by users. Called internally
1937 by #LFUN_DIALOG_UPDATE
1938 * \li Params: <DIALOG-NAME>
1939 * \li Origin: leeming, 25 Feb 2003
1942 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
1945 * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE
1946 * \li Action: Dissolve the current inset into text.
1947 * \li Syntax: inset-dissolve [<INSET>]
1948 * \li Params: <INSET>: this can be used to make sure the right kind of inset
1949 is dissolved. For example "dissolve" entry in the charstyles
1950 sub-menu should only dissolve the charstyle inset, even if the
1951 cursor is inside several nested insets of different type.\n
1952 For values see #lyx::InsetLayout::lyxtype_ .
1953 * \li Origin: JSpitz, 7 Aug 2006
1956 { LFUN_INSET_DISSOLVE, "inset-dissolve", AtPoint, Edit },
1959 * \var lyx::FuncCode lyx::LFUN_INSET_EDIT
1960 * \li Action: Edit the inset at cursor with an external application,
1961 if one is attributed.
1962 * \li Syntax: inset-edit [<INSET_PARAMS>]
1963 * \li Params: <INSET_PARAMS>: Parameters for the inset. \n
1964 Currently only the filename will be considered.
1965 * \li Origin: JSpitzm, 27 Apr 2006
1968 { LFUN_INSET_EDIT, "inset-edit", ReadOnly | AtPoint, Edit },
1972 * \var lyx::FuncCode lyx::LFUN_INSET_END
1973 * \li Action: Move the cursor to the end of the current inset
1974 if it is not already there, or at the end of the
1975 enclosing inset otherwise
1976 * \li Syntax: inset-end
1977 * \li Origin: lasgouttes, 16 Mar 2009
1980 { LFUN_INSET_END, "inset-end", ReadOnly, Edit },
1983 * \var lyx::FuncCode lyx::LFUN_INSET_END_SELECT
1984 * \li Action: Move the cursor to the end of the current inset
1985 if it is not already there, or at the end of the
1986 enclosing inset otherwise (adding the
1987 traversed text to the selection).
1988 * \li Syntax: inset-end-select
1989 * \li Origin: lasgouttes, 16 Mar 2009
1992 { LFUN_INSET_END_SELECT, "inset-end-select", ReadOnly, Edit },
1996 * \var lyx::FuncCode lyx::LFUN_INSET_FORALL
1997 * \li Action: Apply the given commands on insets of a given name.
1998 * \li Notion: WARNING: use at your own risks; this function gives
1999 you too many ways of shooting yourself in the foot.
2000 A typical example is
2001 inset-forall Note note-insert
2002 which starts an infinite loop. This is mitigated by the fact
2003 that the number of actions is arbitrarily limited to 100000.
2004 Note also that inset-forall does not update metrics between
2005 iterations, which can lead to bugs. This has to be eventually
2007 * \li Syntax: inset-forall <NAME> <LFUN-COMMAND> \n
2008 <NAME>: Type of Inset. If <NAME> is *, all insets are matched.
2009 The name is used like for InsetLayout in layout files: "Note"
2010 matches all note insets, while "Note:Note" only matches LyX
2012 * \li Sample: Remove all index insets: \n
2013 inset-forall Index char-delete-forward \n
2014 Close all Notes (also works for a particular branch, for example): \n
2015 inset-forall Note inset-toggle close \n
2016 Transform all yellow notes to comments \n
2017 inset-forall Note:Note inset-modify note Note Comment \n
2018 Try to put LyX in an infinite loop if there is at least a Note: \n
2019 inset-forall Note char-backward
2020 * \li Origin: lasgouttes, 27 Nov 2009
2023 { LFUN_INSET_FORALL, "inset-forall", ReadOnly, Edit },
2027 * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
2028 * \li Action: Insert new inset (type given by the parameters).
2029 * \li Syntax: inset-insert <INSET> <ARGS>
2030 * \li Params: <INSET>: <bibitem|bibtex|citation|ert|listings|external|graphics|tabular|\n
2031 hyperlink|include|index|label|line|nomencl|vspace|ref|toc|script>\n
2032 <ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
2033 * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
2034 where <label name> is the name of the referenced label and
2035 <Format> is one of the following: \n
2036 ref -- <reference> \n
2037 eqref -- (<reference>) \n
2038 pageref -- <page> \n
2039 vpageref -- on <page> \n
2040 vref -- <reference> on <page> \n
2041 formatted -- Formatted reference
2044 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
2047 * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
2048 * \li Action: Modify some properties of an inset.
2049 * \li Notion: Used for argument, bibitem, bibtex, box, branch, caption, citation,
2050 command, ert, external, float, graphics, include, index,
2051 info, label, line, listings, newline, newpage, nomencl,
2052 note, phantom, quotes, ref, script, separator, space,
2053 tabular, vspace and wrap insets.
2054 * \li Syntax: inset-modify <INSET> <ARGS> \n
2055 inset-modify changetype <TYPE>
2056 * \li Sample: Change a Note inset into a Comment inset: \n
2057 inset-modify note Note Comment \n
2058 Change a Box into an Ovalbox: \n
2059 inset-modify changetype Ovalbox \n
2060 Change a quotation mark to e[nglish style], l[eft side = opening], s[ingle = inner, secondary] \n
2061 inset-modify changetype els \n
2062 Change only the style of a quotation mark, maintaining the other aspects (. = wildcard) \n
2063 inset-modify changetype e.. \n
2066 { LFUN_INSET_MODIFY, "inset-modify", AtPoint, Edit },
2069 * \var lyx::FuncCode lyx::LFUN_INSET_SELECT_ALL
2070 * \li Action: Select all contents of an inset.
2071 * \li Notion: There are 3 successive levels: select current cell,
2072 * select all cells of inset, select the inset from outside
2073 * (in the enclosing inset).
2074 * \li Syntax: inset-select-all
2075 * \li Origin: vfr, 22 Aug 2009; lasgouttes 1 Nov 2014
2078 { LFUN_INSET_SELECT_ALL, "inset-select-all", ReadOnly, Edit },
2082 * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
2083 * \li Action: Open the inset's properties dialog.
2084 * \li Notion: Used for bibitem, bibtex, box, branch, citation, ert, external,
2085 float, graphics, href, include, index, index_print, label, line,
2086 listings, note, phantom, ref, space, tabular, vspace, wrap insets.
2087 * \li Syntax: inset-settings <INSET>
2088 * \li Params: <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|\n
2089 graphics|href|include|index|index_print|label|line|\n
2090 listings|note|phantom|ref|space|tabular|vspace|wrap>.
2093 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly | AtPoint, Edit },
2096 * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
2097 * \li Action: Toggles the collapsible inset at cursor position,
2098 or the inset we are currently in.
2099 * \li Syntax: inset-toggle [<ARG>]
2100 * \li Params: <ARG>: <open|close|toggle|assign>. \n
2101 open/close/toggle are for collapsible insets. toggle is used when no argument is given.\n
2102 assign synchronize the branch-inset with activation status of the branch.
2103 Used for global toggling when changed activation.
2104 * \li Origin: lasgouttes, 19 Jul 2001
2107 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly | AtPoint, Edit },
2110 * \var lyx::FuncCode lyx::LFUN_IN_IPA
2111 * \li Action: Only active in IPA inset.
2112 * \li Notion: Dummy function which is only active in a IPA inset.
2113 It's used to toggle the IPA toolbar if the cursor moves
2115 * \li Syntax: in-ipa
2116 * \li Origin: spitz, 20 May 2012
2119 { LFUN_IN_IPA, "in-ipa", Noop, Edit },
2122 * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
2123 * \li Action: Only active in Math Macro definition.
2124 * \li Notion: Dummy function which is only active in a Math Macro definition.
2125 It's used to toggle the Math Macro toolbar if the cursor moves
2126 into a Math Macro definition.
2127 * \li Syntax: in-mathmacrotemplate
2128 * \li Origin: sts, 06 January 2008
2131 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
2135 * \var lyx::FuncCode lyx::LFUN_IPAMACRO_INSERT
2136 * \li Action: Inserts special IPA macros into the document.
2137 * \li Syntax: ipamacro-insert <CHAR>
2138 * \li Params: <CHAR>: tone-falling, tone-rising, tone-high-rising, tone-low-rising,
2139 * tone-high-rising-falling, deco bottomtiebar, deco toptiebar.
2140 * \li Origin: JSpitzm, 22 Aug 2012
2143 { LFUN_IPAMACRO_INSERT, "ipamacro-insert", Noop, Edit },
2146 * \var lyx::FuncCode lyx::LFUN_IPA_INSERT
2147 * \li Action: Inserts an IPA inset.
2148 * \li Syntax: ipa-insert
2149 * \li Origin: spitz, 05 Mar 2012
2152 { LFUN_IPA_INSERT, "ipa-insert", Noop, Edit },
2155 * \var lyx::FuncCode lyx::LFUN_KEYMAP_OFF
2156 * \li Action: Turn off the loaded keyboard map.
2157 * \li Syntax: keymap-off
2160 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
2163 * \var lyx::FuncCode lyx::LFUN_KEYMAP_PRIMARY
2164 * \li Action: Turn on the primary keyboard map.
2165 * \li Notion: Maps were widely used in past, when X-windows didn't have nowadays
2166 keyboard support. They can be still used to maintain uniform keyboard
2167 layout across the various platforms.\n
2168 The language is to be set in the Preferences dialog.
2169 * \li Syntax: keymap-primary
2172 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
2175 * \var lyx::FuncCode lyx::LFUN_KEYMAP_SECONDARY
2176 * \li Action: Turn on the secondary keyboard map.
2177 * \li Syntax: keymap-secondary
2180 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
2183 * \var lyx::FuncCode lyx::LFUN_KEYMAP_TOGGLE
2184 * \li Action: Toggles keyboard maps (first/second/off).
2185 * \li Syntax: keymap-toggle
2186 * \li Origin: leeming, 30 Mar 2004
2189 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
2193 * \var lyx::FuncCode lyx::LFUN_LABEL_COPY_AS_REF
2194 * \li Action: Copies the label at the cursor as a cross-reference to be pasted elsewhere.
2195 * \li Syntax: copy-label-as-reference <LABEL>
2196 * \li Params: <LABEL>: The label to copy (for multi-line math)
2197 * \li Origin: sts, 16 Nov 2008
2200 { LFUN_LABEL_COPY_AS_REFERENCE, "label-copy-as-reference",
2201 ReadOnly | NoUpdate | AtPoint, Edit },
2205 * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
2206 * \li Action: Goto a label.
2207 * \li Syntax: label-goto [<LABEL>]
2208 * \li Params: <LABEL>: Requested label. If no label is given and reference
2209 is on cursor position, Bookmark 0 is saved and
2210 cursor moves to the position of referenced label.
2211 * \li Origin: Ale, 6 Aug 1997
2214 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
2217 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT
2218 * \li Action: Inserts label to text or displayed formula.
2219 * \li Syntax: label-insert [<LABEL>]
2220 * \li Params: <LABEL>: Requested label. If no label is given dialog requesting
2221 name will be opened.
2224 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
2227 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT_AS_REFERENCE
2228 * \li Action: Inserts the label (in ToC pane) as a cross-reference at the position of the cursor.
2229 * \li Syntax: label-insert-as-reference
2230 * \li Origin: vfr, 7 Apr 2009
2233 { LFUN_LABEL_INSERT_AS_REFERENCE, "label-insert-as-reference", Noop, Edit},
2237 * \var lyx::FuncCode lyx::LFUN_LANGUAGE
2238 * \li Action: Set language from the current cursor position.
2239 * \li Syntax: language <LANG> [set]
2240 * \li Params: <LANG>: Requested language. Look in lib/languages for
2241 the list. "language reset" or "language" (without param)
2242 reset to the document language.
2243 set: If used, the language will be set to the specified
2244 language. Otherwise, the language will be toggled (i.e., if
2245 the current language is LANG, switch to the document language
2246 or the default language, if LANG is the document language).
2247 * \li Origin: Dekel, 2 Mar 2000
2250 { LFUN_LANGUAGE, "language", Noop, Edit },
2254 * \var lyx::FuncCode lyx::LFUN_LAYOUT
2255 * \li Action: Sets the layout (that is, environment) for the current paragraph.
2256 * \li Syntax: layout <LAYOUT>
2257 * \li Params: <LAYOUT>: the layout to use
2260 { LFUN_LAYOUT, "layout", Noop, Layout },
2263 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
2264 * \li Action: Clears the module list.
2265 * \li Notion: Clears the list of included modules for the current buffer.
2266 * \li Syntax: layout-modules-clear
2267 * \li Origin: rgh, 25 August 2007
2270 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", NoInternal, Layout },
2273 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULE_ADD
2274 * \li Action: Adds a module.
2275 * \li Notion: Adds a module to the list of included modules for the current buffer.
2276 * \li Syntax: layout-module-add <MODULE>
2277 * \li Params: <MODULE>: the module to be added
2278 * \li Origin: rgh, 25 August 2007
2281 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", NoInternal, Layout },
2284 * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH
2285 * \li Action: Launches the paragraph settings dialog.
2286 * \li Syntax: layout-paragraph
2289 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
2292 * \var lyx::FuncCode lyx::LFUN_LAYOUT_RELOAD
2293 * \li Action: Reloads layout information.
2294 * \li Notion: Reloads all layout information for the current buffer from disk, thus
2295 recognizing any changes that have been made to layout files on the fly.
2296 This is intended to be used only by layout developers and should not be
2297 used when one is trying to do actual work.
2298 * \li Syntax: layout-reload
2299 * \li Origin: rgh, 3 September 2007
2302 { LFUN_LAYOUT_RELOAD, "layout-reload", NoInternal, Layout },
2305 * \var lyx::FuncCode lyx::LFUN_LAYOUT_TABULAR
2306 * \li Action: Launches the tabular settings dialog.
2307 * \li Syntax: layout-tabular
2308 * \li Origin: Jug, 31 Jul 2000
2311 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
2314 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN
2315 * \li Action: Move the cursor to the beginning of the (screen) line.
2316 * \li Syntax: line-begin
2319 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
2322 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN_SELECT
2323 * \li Action: Move the cursor to the beginning of the (screen) line adding the
2324 traversed text to the selection.
2325 * \li Syntax: line-begin-select
2328 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
2331 * \var lyx::FuncCode lyx::LFUN_LINE_DELETE_FORWARD
2332 * \li Action: Deletes the letters to the end of the (screen) line or
2333 deletes the selection.
2334 * \li Syntax: line-delete-forward
2337 { LFUN_LINE_DELETE_FORWARD, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
2340 * \var lyx::FuncCode lyx::LFUN_LINE_END
2341 * \li Action: Move the cursor to the end of the (screen) line.
2342 * \li Syntax: line-end
2345 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
2348 * \var lyx::FuncCode lyx::LFUN_LINE_END_SELECT
2349 * \li Action: Move the cursor to the end of the (screen) line adding the
2350 traversed text to the selection.
2351 * \li Syntax: line-end-select
2354 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
2357 * \var lyx::FuncCode lyx::LFUN_LISTING_INSERT
2358 * \li Action: Inserts a new listings inset.
2359 * \li Syntax: listing-insert
2360 * \li Origin: Herbert, 10 Nov 2001; bpeng, 2 May 2007
2363 { LFUN_LISTING_INSERT, "listing-insert", Noop, Edit },
2366 * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
2367 * \li Action: Apply the given settings to user preferences.
2368 * \li Syntax: lyxrc-apply <SETTINGS>
2369 * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
2370 to get an idea which commands to use and their syntax.
2371 #lyx::LyXRC::LyXRCTags has the list of possible commands.
2374 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
2377 * \var lyx::FuncCode lyx::LFUN_LYX_ACTIVATE
2378 * \li Action: Activates the LyX window.
2379 * \li Notion: On Linux and Mac OS, this action brings the LyX window
2380 into focus. Such behavior is not allowed by Windows OS
2381 so instead the color of the taskbar entry is changed to
2382 indicate that the window has changed in some way.
2383 This action is useful in combination with reverse search.
2384 * \li Syntax: lyx-activate
2385 * \li Origin: skostysh, 4 Aug 2016
2388 { LFUN_LYX_ACTIVATE, "lyx-activate", ReadOnly | NoBuffer, Hidden },
2391 * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
2392 * \li Action: Terminates the current LyX instance.
2393 * \li Notion: Terminates the current LyX instance, asking whether to save
2394 modified documents, etc.
2395 * \li Syntax: lyx-quit
2398 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
2401 * \var lyx::FuncCode lyx::LFUN_MARGINALNOTE_INSERT
2402 * \li Action: Inserts a marginal note.
2403 * \li Syntax: marginalnote-insert
2404 * \li Origin: Lgb, 26 Jun 2000
2407 { LFUN_MARGINALNOTE_INSERT, "marginalnote-insert", Noop, Edit },
2410 * \var lyx::FuncCode lyx::LFUN_MARK_OFF
2411 * \li Action: Disable selecting of text-region.
2412 * \li Syntax: mark-off
2415 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
2418 * \var lyx::FuncCode lyx::LFUN_MARK_ON
2419 * \li Action: Enable selecting of text-region.
2420 * \li Notion: After enabling you can simply move arrow keys to get selected region.
2421 * \li Syntax: mark-on
2424 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
2427 * \var lyx::FuncCode lyx::LFUN_MARK_TOGGLE
2428 * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
2429 * \li Syntax: mark-toggle
2430 * \li Origin: Andre, May 5 2006
2433 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
2437 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
2438 * \li Action: Update (export) the document built from the master buffer,
2439 if the current buffer is part of a master/child document.
2440 * \li Syntax: master-buffer-update [<FORMAT>]
2441 * \li Params: <FORMAT>: The format to display, where this is one of the
2442 formats defined (in the current GUI) in the
2443 Tools>Preferences>File Formats dialog.
2444 If no format is given, the default format as
2445 specified in the same dialog is used.
2446 * \li Origin: Tommaso, 20 Sep 2007
2449 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
2452 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
2453 * \li Action: Show a preview built from the master buffer, if available.
2454 if the current buffer is part of a master/child document.
2455 * \li Syntax: master-buffer-view [<FORMAT>]
2456 * \li Params: <FORMAT>: The format to display, where this is one of the
2457 formats defined (in the current GUI) in the
2458 Tools>Preferences>File Formats dialog.
2459 If no format is given, the default format as
2460 specified in the same dialog is used.
2461 * \li Origin: Tommaso, 20 Sep 2007
2464 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
2467 * \var lyx::FuncCode lyx::LFUN_MATH_AMS_MATRIX
2468 * \li Action: Inserts an extended matrix as provided by the amsmath package.
2469 * \li Syntax: math-matrix <COLS> <ROWS> [<DECORATION>]
2470 * \li Params: <DECORATION>: Decoration determines the LaTeX name of the matrix
2471 that should be created. Possible values include
2472 pmatrix, bmatrix, Bmatrix, vmatrix, Vmatrix and
2473 matrix. The default is 'matrix'.
2474 * \li Sample: math-ams-matrix 3 3 bmatrix
2477 { LFUN_MATH_AMS_MATRIX, "math-ams-matrix", Noop, Math },
2480 * \var lyx::FuncCode lyx::LFUN_MATH_BIGDELIM
2481 * \li Action: Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
2482 * \li Syntax: math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
2483 * \li Params: <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r \n
2484 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
2485 * \li Sample: math-bigdelim "Bigl" "\Downarrow" "Bigr" "\}"
2486 * \li Origin: Enrico & Georg, 7 May 2006
2489 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
2492 * \var lyx::FuncCode lyx::LFUN_MATH_DELIM
2493 * \li Action: Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
2494 * \li Syntax: math-delim [<LEFT>] [<RIGHT>]
2495 * \li Params: <LEFT/RIGHT>: Delimiters to be used. Each delimiter can be specified by
2496 either a LaTeX name or a valid character.
2497 ( is the default letter.
2498 * \li Sample: math-delim { rangle
2499 * \li Origin: Alejandro, 18 Jun 1996
2502 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
2505 * \var lyx::FuncCode lyx::LFUN_MATH_DISPLAY
2506 * \li Action: Creates a new displayed equation in text mode.
2507 Toggles inlined/display formula in math mode.
2508 * \li Syntax: math-display [<ARG>]
2509 * \li Params: <ARG>: this argument will be passed to #LFUN_MATH_INSERT when creating
2510 new equation from the text mode.
2511 * \li Origin: Alejandro, 18 Jun 1996
2514 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
2517 * \var lyx::FuncCode lyx::LFUN_MATH_EXTERN
2518 * \li Action: Calls external program and passes the current expression/equation
2519 as an argument for the calculation in the format appropriate to the
2521 * \li Notion: Selection can be used to determine the input for the external program.
2522 * \li Syntax: math-extern <LANG> [<COMMAND>]
2523 * \li Params: <LANG>: octave|maxima|maple|mathematica|script \n
2524 where "script" stands for the external script (normalized
2525 expression will be passed)
2526 * \li Origin: Andre, 24 Apr 2001
2527 * \li Sample: math-extern maple simplify
2530 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
2533 * \var lyx::FuncCode lyx::LFUN_MATH_FONT_STYLE
2534 * \li Action: Changes the text style used in math.
2535 * \li Syntax: math-font-style <STYLE>
2536 * \li Params: <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf|textnormal\n
2537 |textrm|textsf|texttt|textbf|textmd|textit|textsc|textsl|textup
2538 * \li Origin: vfr, 9 jan 2009
2541 { LFUN_MATH_FONT_STYLE, "math-font-style", Noop, Math },
2544 * \var lyx::FuncCode lyx::LFUN_MATH_INSERT
2545 * \li Action: Inserts math objects and symbols.
2546 * \li Syntax: math-insert <ARG>
2547 * \li Params: <ARG>: Symbol or LaTeX code to be inserted.
2548 * \li Notion: When <ARG> is a _single_ math inset with more than one cell
2549 (such as "x_y^z" or "\frac{x}{y}"), the content of cell(0) is
2550 replaced by the current selection (only works if the selection
2551 is in mathed). As an example, if "abc" is selected in mathed,
2552 "math-insert \frac{x}{y}" replaces "abc" with "\frac{abc}{y}",
2553 and "math-insert x_y^z" replaces "abc" with "abc_y^z".
2554 If nothing is selected (or the selection is not in mathed),
2555 math-insert works as expected.
2558 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
2561 * \var lyx::FuncCode lyx::LFUN_MATH_LIMITS
2562 * \li Action: Toggles the position of the limits from above/below to the right
2563 side an vice versa in integral symbol, a limit, a summation, etc.
2564 * \li Notion: Put the cursor before the symbol with the limits and then invoke
2566 * \li Syntax: math-limits [<STATE>]
2567 * \li Params: <STATE>: limits|nolimits
2570 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
2573 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO
2574 * \li Action: Inserts a math macro definition at the cursor position in the text.
2575 * \li Syntax: math-macro <NAME> [<NARGS>] [def]
2576 * \li Params: <NAME>: The name of the macro, e.g. "mymacro".\n
2577 <NARGS>: The number of parameters of the macro. Default is 0.
2578 "def": Has no effect anymore, just for compatibility with former LyX versions.
2579 * \li Origin: ale, 10 May 1997; sts, 21 Dec 2007
2582 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
2585 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
2586 * \li Action: Add a greedy optional parameter.
2587 * \li Notion: Add a greedy optional parameter which eats the value
2588 from the following cells in mathed which are in the [value]
2590 * \li Syntax: math-macro-add-greedy-optional-param
2591 * \li Origin: sts, 06 January 2008
2594 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
2597 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
2598 * \li Action: Add an optional parameter.
2599 * \li Notion: Insert an optional parameter just behind the
2600 already existing optional parameters.
2601 * \li Syntax: math-macro-add-optional-param
2602 * \li Origin: sts, 06 January 2008
2605 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
2608 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
2609 * \li Action: Add a parameter.
2610 * \li Notion: Add a parameter to a Math Macro.
2611 * \li Params: <NUM>: The number of the parameter behind which the new one
2612 will be added (1 for the first, i.e. use 0 for add a
2613 parameter at the left), defaults to the last one.
2614 * \li Syntax: math-macro-add-param <NUM>
2615 * \li Origin: sts, 06 January 2008
2618 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
2621 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
2622 * \li Action: Append a greedy parameter.
2623 * \li Notion: Append a greedy parameter to a Math Macro which
2624 eats the following mathed cell in every instance of
2625 the macro in the buffer.
2626 * \li Syntax: math-macro-append-greedy-param
2627 * \li Origin: sts, 06 January 2008
2630 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
2633 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
2634 * \li Action: Fold a Math Macro.
2635 * \li Notion: Fold the Math Macro the cursor is in if it was
2636 unfolded, i.e. displayed as \foo before.
2637 * \li Syntax: math-macro-fold
2638 * \li Origin: sts, 06 January 2008
2641 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
2644 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
2645 * \li Action: Make a parameter non-optional.
2646 * \li Notion: Turn the last optional parameter of a Math Macro
2647 into a non-optional parameter. The default value is
2648 remembered to be reused later if the user changes his mind.
2649 * \li Syntax: math-macro-make-nonoptional
2650 * \li Origin: sts, 06 January 2008
2653 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
2656 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
2657 * \li Action: Make a parameter optional.
2658 * \li Notion: Turn the first non-optional parameter of a Math Macro
2659 into an optional parameter with a default value.
2660 * \li Syntax: math-macro-make-optional
2661 * \li Origin: sts, 06 January 2008
2664 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
2667 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
2668 * \li Action: Remove a greedy parameter.
2669 * \li Notion: Remove a greedy parameter of a Math Macro and spit
2670 out the values of it in every instance of the macro
2671 in the buffer. If it is an optional parameter the [valud]
2673 * \li Syntax: math-macro-remove-greedy-param
2674 * \li Origin: sts, 06 January 2008
2677 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
2680 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
2681 * \li Action: Remove the last optional parameter.
2682 * \li Notion: Remove the last optional parameter of a Math Macro and
2683 remove it in all the instances of the macro in the buffer.
2684 * \li Syntax: math-macro-remove-optional-param
2685 * \li Origin: sts, 06 January 2008
2688 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
2691 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
2692 * \li Action: Remove the last parameter.
2693 * \li Notion: Remove the last parameter of a Math Macro and
2694 remove its value in all instances of the macro
2696 * \li Params: <NUM>: The number of the parameter to be deleted (1 for
2697 the first), defaults to the last one.
2698 * \li Syntax: math-macro-remove-param <NUM>
2699 * \li Origin: sts, 06 January 2008
2702 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
2705 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
2706 * \li Action: Unfold a Math Macro.
2707 * \li Notion: Unfold the Math Macro the cursor is in, i.e.
2709 * \li Syntax: math-macro-unfold
2710 * \li Origin: sts, 06 January 2008
2713 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
2716 * \var lyx::FuncCode lyx::LFUN_MATH_MATRIX
2717 * \li Action: Inserts a matrix.
2718 * \li Syntax: math-matrix <COLS> <ROWS> [<ALIGN>]
2719 * \li Params: <ALIGN>: Alignment is a word composed of the vertical alignment
2720 (b, c or t) (i.e. 1 char) and the horizontal alignments
2721 (l, c or r) (i.e. <COL> chars).
2722 * \li Sample: math-matrix 3 3 bccc
2725 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
2728 * \var lyx::FuncCode lyx::LFUN_MATH_MODE
2729 * \li Action: In text mode enters math mode (i.e. puts math insets on the current
2730 cursor position), in math mode enters text mode inside math expression.
2731 * \li Notion: If there is some selected text, it puts the text inside created math box.
2732 * \li Syntax: math-mode [on|<ARG>]
2733 * \li Params: <ARG>: eventual argument (LaTeX code) is passed to #LFUN_MATH_INSERT .\n
2734 "on": allow only entering of math mode from text mode.
2735 * \li Origin: Alejandro, 4 Jun 1996
2738 { LFUN_MATH_MODE, "math-mode", Noop, Math },
2741 * \var lyx::FuncCode lyx::LFUN_MATH_MUTATE
2742 * \li Action: Mutates the type of math inset to the newly selected one.
2743 * \li Syntax: math-mutate <TYPE>
2744 * \li Params: <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
2745 multline|gather|flalign
2746 * \li Origin: Andre, 23 May 2001
2749 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
2752 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
2753 * \li Action: Toggles numbering of the current formula line.
2754 * \li Notion: Must be in display formula mode.
2755 * \li Syntax: math-number-line-toggle
2756 * \li Origin: Alejandro, 18 Jun 1996
2759 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
2762 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
2763 * \li Action: Toggles numbering/labeling of the current formula.
2764 * \li Notion: Must be in display formula mode.
2765 * \li Syntax: math-number-toggle
2766 * \li Origin: Alejandro, 4 Jun 1996
2769 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
2772 * \var lyx::FuncCode lyx::LFUN_MATH_SIZE
2773 * \li Action: Changes arbitrarily the size used by math fonts inside a context.
2774 * \li Notion: Provides an interface to the LaTeX math mode font size commands.
2775 * \li Syntax: math-size <STYLE>
2776 * \li Params: <STYLE>: \displaystyle|\textstyle|\scriptstyle|\scriptscriptstyle
2777 * \li Origin: Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
2780 { LFUN_MATH_SIZE, "math-size", Noop, Math },
2783 * \var lyx::FuncCode lyx::LFUN_MATH_SPACE
2784 * \li Action: Inserts space into math expression.
2785 * \li Notion: Use spacebar after entering this space to change type of space.
2786 * \li Syntax: math-space [<TYPE>] [<LEN>]
2787 * \li Params: <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace \n
2788 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad \n
2789 custom space: hspace \n
2790 "," used by default.\n
2791 Note that ! is equivalent to negthinspace, , = thinspace,
2792 : = medspace, and ; = thickspace.\n
2793 <LEN>: length for custom spaces (hspace)
2794 * \li Origin: Andre, 25 Jul 2001; sanda, 16 Jun 2008
2797 { LFUN_MATH_SPACE, "math-space", Noop, Math },
2800 * \var lyx::FuncCode lyx::LFUN_MATH_SUBSCRIPT
2801 * \li Action: Enters subscript expression in math expression.
2802 * \li Syntax: math-subscript
2803 * \li Origin: vermeer, 12 Dec 2001
2806 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
2809 * \var lyx::FuncCode lyx::LFUN_MATH_SUPERSCRIPT
2810 * \li Action: Enters superscript expression in math expression.
2811 * \li Syntax: math-superscript
2812 * \li Origin: vermeer, 12 Dec 2001
2815 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
2818 * \var lyx::FuncCode lyx::LFUN_MENU_OPEN
2819 * \li Action: Opens the menu given by its name.
2820 * \li Syntax: menu-open <NAME>
2821 * \li Params: <NAME>: menu name. See various .inc files in lib/ui for candidates.
2824 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
2827 * \var lyx::FuncCode lyx::LFUN_MESSAGE
2828 * \li Action: Shows message in statusbar (for script purposes).
2829 * \li Syntax: message <STRING>
2830 * \li Origin: Lgb, 8 Apr 2001
2833 { LFUN_MESSAGE, "message", NoBuffer, System },
2836 * \var lyx::FuncCode lyx::LFUN_META_PREFIX
2837 * \li Action: Simulate halting Meta key (Alt key on PCs).
2838 * \li Notion: Used for buffer edition not for GUI control.
2839 * \li Syntax: meta-prefix
2842 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
2845 * \var lyx::FuncCode lyx::LFUN_MOUSE_DOUBLE
2846 * \li Action: This function is called when double click on mouse button is
2847 pressed (inside workarea). Action depends on the context.
2848 * \li Notion: This is an internal LFUN, not to be used by users.
2849 * \li Origin: Andre, 9 Aug 2002
2852 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
2855 * \var lyx::FuncCode lyx::LFUN_MOUSE_MOTION
2856 * \li Action: This function is called when mouse cursor is moving over the text.
2857 Action depends on the context.
2858 * \li Notion: This is an internal LFUN, not to be used by users.
2859 * \li Origin: Andre, 9 Aug 2002
2862 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
2865 * \var lyx::FuncCode lyx::LFUN_MOUSE_PRESS
2866 * \li Action: This function is called when mouse button is pressed (inside workarea).
2867 Action depends on the context.
2868 * \li Notion: This is an internal LFUN, not to be used by users.
2869 * \li Origin: Andre, 9 Aug 2002
2872 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
2875 * \var lyx::FuncCode lyx::LFUN_MOUSE_RELEASE
2876 * \li Action: This function is called when mouse button is released (inside workarea).
2877 Action depends on the context.
2878 * \li Notion: This is an internal LFUN, not to be used by users.
2879 * \li Origin: Andre, 9 Aug 2002
2882 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
2886 * \var lyx::FuncCode lyx::LFUN_MOUSE_TRIPLE
2887 * \li Action: This function is called when triple click on mouse button is
2888 pressed (inside workarea). Action depends on the context.
2889 * \li Notion: This is an internal LFUN, not to be used by users.
2890 * \li Origin: Andre, 9 Aug 2002
2893 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
2896 * \var lyx::FuncCode lyx::LFUN_NEWLINE_INSERT
2897 * \li Action: Inserts a line break or new line.
2898 * \li Syntax: newline-insert [<ARG>]
2899 * \li Params: <ARG>: <newline|linebreak> default: newline
2900 * \li Origin: JSpitzm, 25 Mar 2008
2903 { LFUN_NEWLINE_INSERT, "newline-insert", Noop, Edit },
2906 * \var lyx::FuncCode lyx::LFUN_NEWPAGE_INSERT
2907 * \li Action: Inserts a new page.
2908 * \li Syntax: newpage-insert <ARG>
2909 * \li Params: <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
2910 * \li Origin: uwestoehr, 24 Nov 2007
2913 { LFUN_NEWPAGE_INSERT, "newpage-insert", Noop, Edit },
2916 * \var lyx::FuncCode lyx::LFUN_NOMENCL_INSERT
2917 * \li Action: Inserts Nomenclature entry.
2918 * \li Notion: It automatically takes the word on the cursor position if no symbol is given.
2919 * \li Syntax: nomencl-insert [<SYMBOL>]
2920 * \li Origin: Ugras, 4 Nov 2006
2923 { LFUN_NOMENCL_INSERT, "nomencl-insert", Noop, Edit },
2926 * \var lyx::FuncCode lyx::LFUN_NOMENCLATURE_PRINT
2927 * \li Action: Inserts list of Nomenclature entries.
2928 * \li Syntax: nomenclature-print
2929 * \li Origin: Ugras, 4 Nov 2006
2932 { LFUN_NOMENCL_PRINT, "nomencl-print", Noop, Edit },
2936 * \var lyx::FuncCode lyx::LFUN_NOTE_INSERT
2937 * \li Action: Inserts Note on the current cursor position,
2938 move selection inside the inset.
2939 * \li Syntax: note-insert [<TYPE>]
2940 * \li Params: <TYPE>: <Note|Greyedout|Comment> default: Note
2943 { LFUN_NOTE_INSERT, "note-insert", Noop, Edit },
2946 * \var lyx::FuncCode lyx::LFUN_NOTE_NEXT
2947 * \li Action: Moves the cursor to the beginning of next Note inset.
2948 * \li Syntax: note-next
2951 { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
2954 * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
2955 * \li Action: Move the current group in the downward direction in the
2956 structure of the document.
2957 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
2958 the whole substructure of the group.
2959 * \li Syntax: outline-down
2960 * \li Origin: Vermeer, 23 Mar 2006
2963 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
2966 * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
2967 * \li Action: Moves the current group in the downward direction in the
2968 hierarchy of the document structure.
2969 * \li Notion: Part -> Chapter -> Section -> etc.
2970 * \li Syntax: outline-in
2971 * \li Origin: Vermeer, 23 Mar 2006
2974 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
2977 * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
2978 * \li Action: Moves the current group in the upward direction in the
2979 hierarchy of the document structure.
2980 * \li Notion: Part <- Chapter <- Section <- etc.
2981 * \li Syntax: outline-out
2982 * \li Origin: Vermeer, 23 Mar 2006
2985 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
2989 * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
2990 * \li Action: Move the current group in the upward direction in the
2991 structure of the document.
2992 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
2993 the whole substructure of the group.
2994 * \li Syntax: outline-up
2995 * \li Origin: Vermeer, 23 Mar 2006
2998 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
3001 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_BREAK
3002 * \li Action: Breaks the current paragraph at the current location.
3003 * \li Notion: Removes the selection.
3004 * \li Syntax: paragraph-break [<LAYOUT>]
3005 * \li Params: <LAYOUT>: "inverse" - decreases depth by one (or change layout
3006 to default layout) when the cursor is at the end of
3010 { LFUN_PARAGRAPH_BREAK, "paragraph-break", Noop, Edit },
3013 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN
3014 * \li Action: Move the cursor to the next paragraph (or beginning of the current one)
3015 in downward direction.
3016 * \li Syntax: paragraph-down
3017 * \li Origin: Asger, 1 Oct 1996
3020 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
3023 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN_SELECT
3024 * \li Action: Move the cursor and select the text to the next paragraph (or
3025 beginning of the current one) in downward direction.
3026 * \li Syntax: paragraph-down-select
3027 * \li Origin: Asger, 1 Oct 1996
3030 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
3033 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
3034 * \li Action: Jump to a paragraph given by its id number and optionally the
3035 desired position within the paragraph.
3036 If given four arguments id_start, pos_start, id_end, pos_end,
3037 perform a selection from start to end.
3038 * \li Notion: Note that id number of paragraph is not the sequential number of
3039 paragraph seen on the screen. Moreover the id is unique for all
3040 opened buffers (documents). Both ids must belong to the same
3042 * \li Syntax: paragraph-goto <PAR_ID> <POS_IN_PAR> [<PAR_ID> <POS_IN_PAR>]
3043 * \li Params: <PAR_ID>: paragraph id \n
3044 <POS_IN_PAR>: desired position within the paragraph
3045 * \li Origin: Dekel, 26 Aug 2000
3049 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly | NoInternal, Edit },
3052 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
3053 * \li Action: Moves the current paragraph downwards in the document.
3054 * \li Syntax: paragraph-move-down
3055 * \li Origin: Edwin, 8 Apr 2006
3058 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
3061 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
3062 * \li Action: Moves the current paragraph upwards in the document.
3063 * \li Notion: Movement through the document will possibly break the paragraph-depth
3064 (e.g. itemize structure).
3065 * \li Syntax: paragraph-move-up
3066 * \li Origin: Edwin, 8 Apr 2006
3069 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
3073 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
3074 * \li Action: Change paragraph settings.
3075 * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
3076 This function only modifies, and does not override, existing settings.
3077 Note that the "leftindent" indent setting is deprecated.
3078 * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
3079 * \li Params: <INDENT>: \noindent|\indent|\indent-toggle|\leftindent LENGTH\n
3080 <SPACING>: \paragraph_spacing default|single|onehalf|double|other SIZE \n
3081 <ALIGN>: \align block|left|right|center|default\n
3082 <OTHERS>: \labelwidthstring WIDTH|\start_of_appendix
3083 * \li Origin: rgh, Aug 15 2007
3086 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
3089 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
3090 * \li Action: Change paragraph settings.
3091 * \li Notion: Overwrite all nonspecified settings to the default ones.
3092 Use paragraph-params lfun if you don't want to overwrite others settings.
3093 * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
3094 * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
3095 * \li Origin: leeming, 30 Mar 2004
3098 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
3101 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP
3102 * \li Action: Move the cursor to the next paragraph (or beginning of the current one)
3103 in upward direction.
3104 * \li Syntax: paragraph-up
3105 * \li Origin: Asger, 1 Oct 1996
3108 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
3111 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UPDATE
3112 * \li Action: Updates the values inside the paragraph dialog from the paragraph.
3113 * \li Notion: This is an internal LFUN, not to be used by users. Called internally
3114 by #LFUN_DIALOG_UPDATE.
3115 * \li Origin: leeming, 13 Mar 2003
3118 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
3122 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP_SELECT
3123 * \li Action: Move the cursor and select the text to the next paragraph (or
3124 beginning of the current one) in upward direction.
3125 * \li Syntax: paragraph-up-select
3126 * \li Origin: Asger, 1 Oct 1996
3129 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
3132 * \var lyx::FuncCode lyx::LFUN_PASTE
3133 * \li Action: Pastes material (text or picture) from the active clipboard.
3134 * \li Syntax: paste [<TYPE>|<NUM>]
3135 * \li Params: <TYPE>: emf|pdf|png|jpeg|linkback|wmf|latex|html \n
3136 <NUM>: number of the selection in the internal clipboard stack to be pasted.
3139 { LFUN_PASTE, "paste", Noop, Edit },
3142 * \var lyx::FuncCode lyx::LFUN_PHANTOM_INSERT
3143 * \li Action: Inserts phantom on the current cursor position,
3144 move selection inside the inset.
3145 * \li Syntax: phantom-insert [<TYPE>]
3146 * \li Params: <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
3147 * \li Origin: uwestoehr, 30 Jan 2009
3150 { LFUN_PHANTOM_INSERT, "phantom-insert", Noop, Edit },
3153 * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
3154 * \li Action: Save user preferences.
3155 * \li Syntax: preferences-save
3156 * \li Origin: Lgb, 27 Nov 1999
3159 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
3162 * \var lyx::FuncCode lyx::LFUN_PREVIEW_INSERT
3163 * \li Action: Inserts a new preview inset.
3164 * \li Syntax: preview-insert
3165 * \li Origin: vfr, 28 Mar 2010
3168 { LFUN_PREVIEW_INSERT, "preview-insert", Noop, Edit },
3171 * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
3172 * \li Action: Pastes the currently selected text.
3173 * \li Notion: Primary selection mechanism is linux-only thing.
3174 * \li Syntax: primary-selection-paste [<ARG>]
3175 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
3178 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
3181 * \var lyx::FuncCode lyx::LFUN_QUOTE_INSERT
3182 * \li Action: Inserts quotes according to the type and quote-language preference.
3183 * \li Notion: Currently 15 different quote styles are distinguished (see params).
3184 * \li Syntax: quote-insert [<LEVEL>] [<SIDE>] [<STYLE>]
3185 * \li Params: <LEVEL>: 'inner' for (i.e., secondary, usually single) quotes, otherwise
3186 * outer (i.e., primary, usually double) quotes will be used.\n
3187 * <SIDE>: 'opening' for opening quotes, 'closing' for closing quotes,
3188 * otherwise the side will be guessed from the context.\n
3189 * <STYLE>: 'british' for `British' quote style (with ``inner quotation'')\n
3190 * 'cjk' for Chinese/Japanese/Korean corner bracket quotation marks\n
3191 * 'cjk-angle' for Chinese/Japanese/Korean angle bracket quotation marks\n
3192 * 'danish' for >>Danish<< quote style (with >inner quotation<)\n
3193 * 'english' for ``English'' quote style (with `inner quotation')\n
3194 * 'french' for <<french>> quote style (with ``inner quotation'')\n
3195 * 'frenchin' for <<frenchin>> quote style (with <<inner quotation>>) ["in" = Imprimerie Nationale]\n
3196 * 'german' for ,,German`` quote style (with ,inner quotation`)\n
3197 * 'plain' for "Plain" quote style (with 'inner quotation')\n
3198 * 'polish' for ,,Polish'' quote style (with ,inner quotation')\n
3199 * 'swedish' for ''Swedish'' quote style (with 'inner quotation')\n
3200 * 'swedishg' for >>swedishg>> quote style (with 'inner quotation') ["g" = Guillemets]\n
3201 * 'swiss' for <<Swiss>> quote style (with <inner quotation>)\n
3202 * 'russian' for <<Russian>> quote style (with ,,inner quotation``)\n
3203 * 'dynamic' for Dynamic quotation marks which inherit the global
3205 * If no quote style is specified, the document-wide will be used.
3208 { LFUN_QUOTE_INSERT, "quote-insert", Noop, Edit },
3211 * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
3212 * \li Action: Reconfigure the automatic settings.
3213 * \li Syntax: reconfigure
3214 * \li Origin: Asger, 14 Feb 1997
3217 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
3220 * \var lyx::FuncCode lyx::LFUN_REDO
3221 * \li Action: Redoes the last thing undone.
3225 { LFUN_REDO, "redo", ReadOnly, Edit },
3228 * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
3229 * \li Action: Go to the next label or cross-reference.
3230 * \li Syntax: reference-next
3231 * \li Origin: Dekel, 14 Jan 2001
3234 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
3238 * \var lyx::FuncCode lyx::LFUN_REGEXP_MODE
3239 * \li Action: Enters regexp mode (i.e., puts regexp insets on the current
3240 cursor position). Used by the advanced search dialog.
3241 * \li Notion: If there is any selected text, then it is moved inside the created
3243 * \li Syntax: regexp-mode [<ARG>]
3244 * \li Params: <ARG>: eventual argument (regular expression).
3245 * \li Origin: Tommaso, 4 Oct 2008
3248 { LFUN_REGEXP_MODE, "regexp-mode", Noop, Math },
3251 * \var lyx::FuncCode lyx::LFUN_REPEAT
3252 * \li Action: Repeat the given command.
3253 * \li Syntax: repeat <COUNT> <LFUN-COMMAND>
3254 * \li Origin: Andre, 27 Oct 2003
3257 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
3260 * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN
3261 * \li Action: Moves the cursor one page in downward direction.
3262 * \li Syntax: screen-down
3265 { LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit },
3268 * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN_SELECT
3269 * \li Action: Moves the cursor one screen in downward direction adding the current
3270 position to the selection.
3271 * \li Syntax: screen-down-select
3274 { LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit },
3277 * \var lyx::FuncCode lyx::LFUN_SCREEN_FONT_UPDATE
3278 * \li Action: Update fonts and its metrics.
3279 * \li Notion: Automatically called after zoom, dpi, font names, or norm change.
3280 * \li Syntax: screen-font-update
3281 * \li Origin: ARRae, 13 Aug 2000
3284 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
3287 * \var lyx::FuncCode lyx::LFUN_SCREEN_RECENTER
3288 * \li Action: Recenters the screen on the current cursor position.
3289 * \li Syntax: screen-recenter
3292 { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit },
3296 * \var lyx::FuncCode lyx::LFUN_SCREEN_SHOW_CURSOR
3297 * \li Action: Repositions the screen such that the cursor is visible.
3298 * \li Syntax: screen-show-cursor
3299 * \li Origin: vfr, 25 Mar 2009
3302 { LFUN_SCREEN_SHOW_CURSOR, "screen-show-cursor", ReadOnly, Edit },
3306 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP
3307 * \li Action: Moves the cursor one page in upward direction.
3308 * \li Syntax: screen-up
3311 { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit },
3314 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP_SELECT
3315 * \li Action: Moves the cursor one page in upward direction adding the current
3316 position to the selection.
3317 * \li Syntax: screen-up-select
3320 { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit },
3323 * \var lyx::FuncCode lyx::LFUN_SCRIPT_INSERT
3324 * \li Action: Inserts a subscript or superscript inset.
3325 * \li Syntax: script-insert <TYPE>
3326 * \li Params: <TYPE>: subscript|superscript
3327 * \li Origin: Georg, 23 Nov 2010
3330 { LFUN_SCRIPT_INSERT, "script-insert", Noop, Edit },
3333 * \var lyx::FuncCode lyx::LFUN_SCROLL
3334 * \li Action: Scroll the buffer view.
3335 * \li Notion: Only scrolls the screen up or down; does not move the cursor.
3336 * \li Syntax: scroll <TYPE> <QUANTITY>
3337 * \li Params: <TYPE>: line|page\n
3338 <QUANTITY>: up|down|<number>
3339 * \li Origin: Abdel, Dec 27 2007
3342 { LFUN_SCROLL, "scroll", ReadOnly, Edit },
3345 * \var lyx::FuncCode lyx::LFUN_SECTION_SELECT
3346 * \li Action: Select the whole section.
3347 * \li Notion: The cursor should be in a section heading
3348 before calling this lfun.
3349 * \li Syntax: section-select
3350 * \li Origin: vfr, 05 May 2009
3353 { LFUN_SECTION_SELECT, "section-select", ReadOnly, Edit },
3357 * \var lyx::FuncCode lyx::LFUN_SELECTION_PASTE
3358 * \li Action: Pastes the internal selection text in permanent selection.
3359 * \li Notion: Created in order to have middle mouse button pasting correct (bound to
3360 command-alternatives selection-paste ; primary-selection-paste paragraph).
3361 * \li Syntax: selection-paste
3362 * \li Origin: lasgouttes, 14 Jan 2009
3365 { LFUN_SELECTION_PASTE, "selection-paste", Noop, Edit },
3368 * \var lyx::FuncCode lyx::LFUN_SELF_INSERT
3369 * \li Action: Inserts the given string (accordingly to the correct keymap).
3370 * \li Notion: Automatically replace the currently selected text. Depends on lyxrc
3371 settings "auto_region_delete".
3372 * \li Syntax: self-insert <STRING>
3375 { LFUN_SELF_INSERT, "self-insert", SingleParUpdate, Hidden },
3378 * \var lyx::FuncCode lyx::LFUN_SEPARATOR_INSERT
3379 * \li Action: Inserts an environment separator or latex paragraph break.
3380 * \li Syntax: separator-insert [<ARG>]
3381 * \li Params: <ARG>: <plain|parbreak|latexpar> default: plain
3382 * \li Origin: ef, 2 May 2014
3385 { LFUN_SEPARATOR_INSERT, "separator-insert", Noop, Edit },
3388 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_FILENAME
3389 * \li Action: Returns path and file name of the currently edited document.
3390 * \li Syntax: server-get-filename
3393 { LFUN_SERVER_GET_FILENAME, "server-get-filename", ReadOnly, System },
3396 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_LAYOUT
3397 * \li Action: Returns the current layout (that is environment) name
3398 on the cursor position.
3399 * \li Syntax: server-get-layout
3402 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
3405 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_STATISTICS
3406 * \li Action: Returns the statistics (number of words and characters)
3407 in the document or in the given selection.
3408 * \li Notion: Note that this function gives the number of words/chars written,
3409 not the number of characters which will be typeset.
3410 * \li Syntax: server-get-statistics [<TYPE>]
3411 * \li Params: <TYPE>: <words|chars|chars-space> The requested count; if not
3412 specified, the three values are returned, separated
3414 words: count words.\n
3415 chars: count characters.\n
3416 chars-space: count characters and spaces.
3417 * \li Origin: brokenclock, Oct 10 2014
3420 { LFUN_SERVER_GET_STATISTICS, "server-get-statistics", ReadOnly, System },
3423 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
3424 * \li Action: Returns the coordinates of cursor position in the editing area.
3425 * \li Syntax: server-get-xy
3428 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
3432 * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
3433 * \li Action: Sets the cursor position in LyX based on the row number of generated TeX file.
3434 * \li Notion: This can be useful for DVI inverse-search or detection of the problematic
3435 line from LaTeX compilation. Note that before this function can be used
3436 export to LaTeX output must occur (in order to map the row numbers).
3437 * \li Syntax: server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
3438 * \li Params: <FILE>: the path and filename. Environment variables are expanded in the path.
3439 In case this LFUN does not work make sure you are giving correct
3441 If the file is located inside LyX temporary directory it will be
3442 mapped back into the appropriate opened buffer (e.g. for the case
3443 of generated .tex file).\n
3444 .ext: extensions will be automatically replaced by .lyx.\n
3445 <ROW_NUMBER> The row number of the LaTeX file to which to go.
3446 * \li Sample: server-goto-file-row /home/user/example.lyx 41\n
3447 server-goto-file-row /tmp/lyx_tmpdir.XM3088/lyx_tmpbuf0/example.tex 41
3448 * \li Origin: Edmar, 23 Dec 1998
3451 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly | NoBuffer, System },
3454 * \var lyx::FuncCode lyx::LFUN_SERVER_NOTIFY
3455 * \li Action: Sends notify message about the last key-sequence to client.
3456 * \li Notion: This can be used to grab last key-sequence used inside the LyX window.
3457 See also Debug extensions section in Additional features manual.
3458 * \li Syntax: server-notify
3461 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
3464 * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
3465 * \li Action: Sets the cursor position based on the editing area coordinates
3466 (similar to clicking on that point with left mouse button).
3467 * \li Syntax: server-set-xy <X> <Y>
3470 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
3473 * \var lyx::FuncCode lyx::LFUN_SET_COLOR
3474 * \li Action: Set the given LyX color to the color defined by the X11 name given.
3475 * \li Notion: A new color entry is created if the color is unknown.
3476 Color names can be stored as a part of user settings.
3477 * \li Syntax: set-color <LYX_NAME> <X11_NAME>
3478 * \li Origin: SLior, 11 Jun 2000
3481 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
3484 * \var lyx::FuncCode lyx::LFUN_SET_GRAPHICS_GROUP
3485 * \li Action: Set the group for the graphics inset on the cursor position.
3486 * \li Syntax: set-graphics-group [<GROUP>]
3487 * \li Params: <GROUP>: Id for an existing group. In case the Id is an empty string,
3488 the graphics inset is removed from the current group.
3489 * \li Origin: sanda, 6 May 2008
3492 { LFUN_SET_GRAPHICS_GROUP, "set-graphics-group", Noop, Edit },
3496 * \var lyx::FuncCode lyx::LFUN_SPACE_INSERT
3497 * \li Action: Inserts one of horizontal space insets.
3498 * \li Syntax: space-insert <NAME> [<LEN>]
3499 * \li Params: <NAME>: normal, protected, visible, thin, quad, qquad, enspace,
3500 enskip, negthinspace, negmedspace, negthickspace, hfill,
3501 hfill*, dotfill, hrulefill, hspace, hspace* \n
3502 Only in math mode: med and thick.\n
3503 <LEN>: length for custom spaces (hspace, hspace* for protected)
3504 * \li Origin: JSpitzm, 20 May 2003, Mar 17 2008
3507 { LFUN_SPACE_INSERT, "space-insert", Noop, Edit },
3510 * \var lyx::FuncCode lyx::LFUN_SPECIALCHAR_INSERT
3511 * \li Action: Inserts various characters into the document.
3512 * \li Syntax: specialchar-insert <CHAR>
3513 * \li Params: <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots,
3514 end-of-sentence, menu-separator, lyx, tex, latex, latex2e.
3515 * \li Origin: JSpitzm, 6 Dec 2007
3518 { LFUN_SPECIALCHAR_INSERT, "specialchar-insert", Noop, Edit },
3521 * \var lyx::FuncCode lyx::LFUN_SPELLING_ADD
3522 * \li Action: Add the word under the cursor to the respective
3523 * spell checker dictionary.
3524 * The default for the language is retrieved from the cursor position.
3525 * \li Syntax: spelling-add [<STRING>] [<LANG>]
3526 * \li Params: <WORD>: word to add
3527 <LANG>: language name (see file languages)
3528 * \li Origin: JSpitzm, 18 Jan 2010
3531 { LFUN_SPELLING_ADD, "spelling-add", ReadOnly, Edit },
3534 * \var lyx::FuncCode lyx::LFUN_SPELLING_CONTINUOUSLY
3535 * \li Action: Toggle continuous spell checking.
3536 * \li Syntax: spelling-continuously
3537 * \li Origin: vfr, 24 March 2013
3540 { LFUN_SPELLING_CONTINUOUSLY, "spelling-continuously", ReadOnly, Edit },
3544 * \var lyx::FuncCode lyx::LFUN_SPELLING_IGNORE
3545 * \li Action: Let the spell checker ignore the word under the cursor
3546 * in the current session for the given language.
3547 * The default for the language is retrieved from the cursor position.
3548 * \li Syntax: spelling-ignore [<WORD>] [<LANG>]
3549 * \li Params: <WORD>: word to ignore
3550 <LANG>: language name (see file languages)
3551 * \li Origin: JSpitzm, 18 Jan 2010
3554 { LFUN_SPELLING_IGNORE, "spelling-ignore", ReadOnly, Edit },
3557 * \var lyx::FuncCode lyx::LFUN_SPELLING_REMOVE
3558 * \li Action: Remove the word under the cursor from the respective
3559 * spell checker dictionary.
3560 * The default for the language is retrieved from the cursor position.
3561 * \li Syntax: spelling-remove [<STRING>] [<LANG>]
3562 * \li Params: <WORD>: word to remove
3563 * <LANG>: language name (see file languages)
3564 * \li Origin: SWitt, 28 July 2010
3567 { LFUN_SPELLING_REMOVE, "spelling-remove", ReadOnly, Edit },
3571 * \var lyx::FuncCode lyx::LFUN_STATISTICS
3572 * \li Action: Count the statistics (number of words and characters)
3573 in the document or in the given selection and display it
3575 * \li Notion: Note that this function gives the number of words/chars written,
3576 not the number of characters which will be typeset.
3577 * \li Syntax: statistics
3578 * \li Origin: lasgouttes, Jan 27 2004; sanda, Jan 8 2008
3581 { LFUN_STATISTICS, "statistics", ReadOnly, System },
3584 * \var lyx::FuncCode lyx::LFUN_TABULAR_FEATURE
3585 * \li Action: Modify properties of tabulars and table-like math environments.
3586 * \li Syntax: tabular-feature <FEATURE> [<ARG>]
3587 * \li Params: Generally see #LFUN_INSET_INSERT for further details.\n
3588 * <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|\n
3589 copy-column|move-column-right|move-column-left|move-row-down|move-row-up|\n
3590 toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|\n
3591 align-left|align-right|align-center|align-block|align-decimal|set-decimal-point|\n
3592 valign-top|valign-bottom|valign-middle|longtabular-align-left|\n
3593 longtabular-align-center|longtabular-align-right|m-align-left|m-align-right|\n
3594 m-align-center|m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|\n
3595 set-all-lines|unset-all-lines|toggle-longtabular|set-longtabular|unset-longtabular|set-pwidth|\n
3596 set-mpwidth|set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|\n
3597 set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|\n
3598 unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|\n
3599 set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|\n
3600 set-special-column|set-special-multicolumn|set-special-multirow|\n
3601 toggle-booktabs|set-booktabs|unset-booktabs|set-top-space|set-bottom-space|\n
3602 set-interline-space|set-border-lines|tabular-valign-top|\n
3603 tabular-valign-middle|tabular-valign-bottom|set-tabular-width\n
3604 Various math-environment features are handled as well, e.g. add-vline-left/right for\n
3605 the Grid/Array environment.\n
3606 <ARG>: additional argument for some commands, use debug mode to explore its values.
3607 * \li Origin: gm, 10 Dec 2015
3610 { LFUN_TABULAR_FEATURE, "tabular-feature", Noop, Edit },
3613 * \var lyx::FuncCode lyx::LFUN_TABULAR_INSERT
3614 * \li Action: Inserts table into the document.
3615 * \li Notion: See #LFUN_TABULAR_FEATURE for some more details
3616 about tabular modifications.
3617 * \li Syntax: tabular-insert [<ROWS> <COLUMNS>]
3618 * \li Params: In case no arguments are given show insert dialog.
3619 * \li Origin: Jug, 12 Apr 2000
3622 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
3626 * \var lyx::FuncCode lyx::LFUN_TAB_DELETE
3627 * \li Action: Delete a tab or up to an equivalent amount of spaces from
3629 * \li Notion: It also works on a selection - it removes a tab or spaces from the
3630 beginning of each line spanned by the selection. This is useful if
3631 you want to indent/unindent multiple lines in one action.
3632 * \li Syntax: tab-delete
3633 * \li Origin: vfr, Sep 30 2008
3636 { LFUN_TAB_DELETE, "tab-delete", SingleParUpdate, Edit },
3639 * \var lyx::FuncCode lyx::LFUN_TAB_GROUP_CLOSE
3640 * \li Action: Close the current tab group.
3641 * \li Notion: This only closes the work areas, not the buffers themselves.
3642 The still opened buffers can be visualized in another tab group.
3643 * \li Syntax: tab-group-close
3644 * \li Origin: Abdel, 21 Feb 2008
3647 { LFUN_TAB_GROUP_CLOSE, "tab-group-close", ReadOnly, Buffer },
3651 * \var lyx::FuncCode lyx::LFUN_TAB_INSERT
3652 * \li Action: Insert a tab into a listings inset.
3653 * \li Notion: It also works on a selection.
3654 * \li Syntax: tab-insert
3655 * \li Origin: vfr, Sep 30 2008
3658 { LFUN_TAB_INSERT, "tab-insert", SingleParUpdate, Edit },
3661 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
3662 * \li Action: Sets the text class for the current buffer.
3663 * \li Syntax: textclass-apply <TEXTCLASS>
3664 * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
3665 the filename, minus the ".layout" extension.
3668 { LFUN_TEXTCLASS_APPLY, "textclass-apply", NoInternal, Layout },
3671 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
3672 * \li Action: Loads information for a textclass from disk.
3673 * \li Syntax: textclass-load <TEXTCLASS>
3674 * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
3675 the filename, minus the ".layout" extension.
3678 { LFUN_TEXTCLASS_LOAD, "textclass-load", NoInternal, Layout },
3682 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_APPLY
3683 * \li Action: Toggle user-defined (=last-time used) text style.
3684 * \li Notion: This style is set via #LFUN_TEXTSTYLE_UPDATE, which is
3685 automatically triggered when using Text Style dialog.
3686 * \li Syntax: textstyle-apply
3687 * \li Origin: leeming, 12 Mar 2003
3690 { LFUN_TEXTSTYLE_APPLY, "textstyle-apply", Noop, Layout },
3693 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_UPDATE
3694 * \li Action: Apply text style and update the settings to be used by #LFUN_TEXTSTYLE_APPLY.
3695 * \li Syntax: textstyle-update <FONT_INFO>
3696 * \li Params: <FONT_INFO>: specifies font atributes, e.g. family, series, shape,
3697 size, emph, noun, underbar, number, color, language,
3699 Use lyx -dbg action for exact syntax of text-style
3701 * \li Origin: leeming, 12 Mar 2003
3704 { LFUN_TEXTSTYLE_UPDATE, "textstyle-update", Noop, Layout },
3707 * \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
3708 * \li Action: Look up thesaurus entries with respect to the word under the cursor.
3709 * \li Syntax: thesaurus-entry [<STRING>] [lang=<LANG>]
3710 * \li Params: <STRING>: word to look up
3711 <LANG>: language (see file languages)
3712 * \li Origin: Levon, 20 Jul 2001
3715 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
3718 * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
3719 * \li Action: Toggles visibility of a given toolbar between on/off/auto.
3720 * \li Notion: Skipping "auto" when allowauto is false.
3721 * \li Syntax: toolbar-toggle <NAME> [allowauto]
3722 * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|\n
3723 minibuffer|review|view/update|math_panels|vcs|
3724 view-others|update-others
3725 * \li Origin: Edwin, 21 May 2007
3728 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
3731 * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
3732 * \li Action: Various UI visibility-toggling actions.
3733 * \li Syntax: ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
3734 * \li Params: statusbar : Toggle visibility of the statusbar.\n
3735 menubar : Toggle visibility of the menubar.\n
3736 scrollbar : Toggle visibility of the scrollbar.\n
3737 frame : Toggle visibility of the frames around editing window.\n
3738 fullscreen : Toggle fullscreen mode. This also covers calling the
3739 previous functions. However #LFUN_TOOLBAR_TOGGLE for the
3740 custom tweaks of the toolbars should be used.
3741 * \li Origin: sanda, 9 Feb 2007
3744 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
3748 * \var lyx::FuncCode lyx::LFUN_UNDO
3749 * \li Action: Undoes the last edit.
3753 { LFUN_UNDO, "undo", ReadOnly, Edit },
3756 * \var lyx::FuncCode lyx::LFUN_UNICODE_INSERT
3757 * \li Action: Inserts a single unicode character.
3758 * \li Syntax: unicode-insert <CHAR>
3759 * \li Params: <CHAR>: The character to insert, given as its code
3760 point, in hexadecimal.
3761 * \li Sample: unicode-insert 0x0100
3762 * \li Origin: Lgb, 22 Oct 2006
3765 { LFUN_UNICODE_INSERT, "unicode-insert", Noop, Edit },
3768 * \var lyx::FuncCode lyx::LFUN_UP
3769 * \li Action: Moves the cursor one line in upward direction.
3773 { LFUN_UP, "up", ReadOnly | NoUpdate, Edit },
3776 * \var lyx::FuncCode lyx::LFUN_UP_SELECT
3777 * \li Action: Moves the cursor one line in upward direction adding the current
3778 position to the selection.
3779 * \li Syntax: up-select
3782 { LFUN_UP_SELECT, "up-select", ReadOnly | SingleParUpdate, Edit },
3785 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_IN
3786 * \li Action: Checks-in/commits the changes of the registered file to the repository.
3787 * \li Notion: In RCS case this also unlocks the file.
3788 * \li Syntax: vc-check-in
3789 * \li Origin: Lgb, 1 Jul 1997
3792 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
3795 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_OUT
3796 * \li Action: Checks-out the document for edit (and locks it in some cases).
3797 * \li Syntax: vc-check-out
3798 * \li Origin: Lgb, 1 Jul 1997
3801 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
3804 * \var lyx::FuncCode lyx::LFUN_VC_COMMAND
3805 * \li Action: Executes external command. This command is intended to support
3806 additional VCS commands.
3807 * \li Syntax: vc-command <FLAG> <PATH> <COMMAND>
3808 * \li Params: <FLAG>: Flags for the command can be combined together.\n
3809 U - dUmmy - no flags \n
3810 D - Doc - need document loaded to proceed \n
3811 I - dIrty - mark document dirty \n
3812 R - Reload - ensure that the document is saved and reload it after command execution \n
3813 M - Message - ask for input string (commit message)\n
3814 <PATH>: path where to start. $$p will be replaced by the current document path.\n
3815 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current
3816 document(with absolute path)/path/message.
3817 * \li Sample: vc-command DR $$p "svn up"
3818 * \li Origin: sanda, 13 Jan 2009
3821 { LFUN_VC_COMMAND, "vc-command", NoBuffer | ReadOnly, System },
3824 * \var lyx::FuncCode lyx::LFUN_VC_COMPARE
3825 * \li Action: Compares two revisions of the same file under version control.
3826 * \li Syntax: vc-compare [<REV1>] [<REV2>]
3827 * \li Params: Revision number either points directly to commit in history
3828 or if negative number -x it points to (last commit - x).\n
3829 In RCS we subtract only in the last number of revision specification.
3830 Special case "0" is reserved for the last committed revision.\n
3831 <REV1>: Older file.\n
3832 <REV2>: Newer file. Used only if REV1 > 0.\n
3833 If no parameter is given, interactive dialog will be shown.
3834 * \li Sample: Compare current document against last commit\n
3836 Compare current document against current revision - 5 commits\n
3838 Compare revisions 120 and 155\n
3840 * \li Origin: sanda, 12 Feb 2010
3843 { LFUN_VC_COMPARE, "vc-compare", ReadOnly, System },
3847 * \var lyx::FuncCode lyx::LFUN_VC_COPY
3848 * \li Action: Copies the document to another name.
3849 * \li Notion: Copying with revision history is only supported by SVN.
3850 For RCS and CVS it is simulated by adding the document
3852 Disabled if uncommitted changes exist.
3853 * \li Syntax: vc-copy <FILENAME>
3854 * \li Params: <FILENAME>: New name of the document.\n
3855 * A file dialog is opened if no filename is given.
3856 * \li Origin: gb, 05 Feb 2013
3859 { LFUN_VC_COPY, "vc-copy", ReadOnly, System },
3862 * \var lyx::FuncCode lyx::LFUN_VC_LOCKING_TOGGLE
3863 * \li Action: Toggles the locking property of the edited file.
3864 * \li Notion: This is currently implemented only for SVN.
3865 * \li Syntax: vc-locking-toggle
3866 * \li Origin: sanda, 25 Jun 2009
3869 { LFUN_VC_LOCKING_TOGGLE, "vc-locking-toggle", ReadOnly, System },
3872 * \var lyx::FuncCode lyx::LFUN_VC_REGISTER
3873 * \li Action: Register the document as an file inside version control system.
3874 * \li Notion: File is registered inside cvs, svn or rcs repository acording to the existence
3875 of cvs/svn/rcs entries in the document's directory. \n
3876 See LyX Additional Features Manual (Version Control Chapter) for additional
3878 * \li Syntax: vc-register
3879 * \li Origin: Lgb, 1 Jul 1997
3882 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
3885 * \var lyx::FuncCode lyx::LFUN_VC_RENAME
3886 * \li Action: Renames the document to another name.
3887 * \li Notion: Renaming with revision history is only supported by SVN.
3888 For CVS it is simulated by adding the document under a new
3889 name and deleting the old one. For RCS it is not supported.
3890 Disabled if uncommitted changes exist.
3891 * \li Syntax: vc-rename <FILENAME>
3892 * \li Params: <FILENAME>: New name of the document.\n
3893 * A file dialog is opened if no filename is given.
3894 * \li Origin: gb, 05 Feb 2013
3897 { LFUN_VC_RENAME, "vc-rename", ReadOnly, System },
3900 * \var lyx::FuncCode lyx::LFUN_VC_REPO_UPDATE
3901 * \li Action: Update the local archive directory in which resides
3902 the current document with the remote repository.
3903 * \li Syntax: vc-repo-update
3904 * \li Origin: sanda, 16 Oct 2009
3907 { LFUN_VC_REPO_UPDATE, "vc-repo-update", ReadOnly, System },
3910 * \var lyx::FuncCode lyx::LFUN_VC_REVERT
3911 * \li Action: Reverts the document to the last check-in/commit in VCS.
3912 * \li Syntax: vc-revert
3913 * \li Origin: Lgb, 1 Jul 1997
3916 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
3919 * \var lyx::FuncCode lyx::LFUN_VC_UNDO_LAST
3920 * \li Action: Undo last check-in.
3921 * \li Notion: This is currently implemented only for RCS.
3922 * \li Syntax: vc-check-out
3923 * \li Origin: Lgb, 1 Jul 1997
3926 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
3929 * \var lyx::FuncCode lyx::LFUN_VIEW_CLOSE
3930 * \li Action: Close the current document work area.
3931 * \li Notion: Close the current work area. If no other work areas are showing the buffer,
3932 then close the associated buffer as well.
3933 * \li Syntax: view-close
3934 * \li Origin: Tommaso, 15 Sep 2012
3937 { LFUN_VIEW_CLOSE, "view-close", ReadOnly, Buffer },
3941 * \var lyx::FuncCode lyx::LFUN_VIEW_SPLIT
3942 * \li Action: Creates another split view of current buffer.
3943 * \li Notion: All split views act in the same way independently.
3944 * \li Syntax: view-split <vertical|horizontal>
3945 * \li Params: horizontal : The work areas are laid out side by side.\n
3946 vertical : The work areas laid out vertically.
3947 * \li Origin: Abdel, 20 Feb 2008
3950 { LFUN_VIEW_SPLIT, "view-split", ReadOnly, Buffer },
3954 * \var lyx::FuncCode lyx::LFUN_WINDOW_CLOSE
3955 * \li Action: Closes the current LyX window.
3956 * \li Syntax: window-close
3957 * \li Origin: Abdel, 23 Oct 2006
3960 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
3964 * \var lyx::FuncCode lyx::LFUN_WINDOW_NEW
3965 * \li Action: Creates new empty LyX window.
3966 * \li Notion: Already opened documents from the previous window can be found under View menu.
3967 * \li Syntax: window-new [<GEOMETRY>]
3968 * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently
3969 accepted only on Windows platform.
3970 * \li Origin: Abdel, 21 Oct 2006
3973 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
3976 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD
3977 * \li Action: Moves the cursor to the logically previous beginning of a word.
3978 * \li Notion: This is not the action which should be bound to the arrow keys,
3979 because backwards may be left or right, depending on the
3980 language. The arrow keys should be bound to #LFUN_WORD_LEFT or
3981 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
3982 * \li Syntax: word-backward
3985 { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit },
3988 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD_SELECT
3989 * \li Action: Moves the cursor to the logically previous beginning of a word,
3990 adding the logically traversed text to the selection.
3991 * \li Notion: See also #LFUN_WORD_BACKWARD.
3992 * \li Syntax: word-backward-select
3995 { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
3998 * \var lyx::FuncCode lyx::LFUN_WORD_CAPITALIZE
3999 * \li Action: Capitalizes the words in the selection (i.e. the first letters)
4000 or the first letter of word at cursor position.
4001 * \li Syntax: word-capitalize [<SEL_TYPE>]
4002 * \li Params: <SEL_TYPE>: if this is equal to "partial", then the
4003 * default word starts at cursor position (emacs-style).
4004 * Otherwise, the whole word is considered.
4007 { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
4010 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_BACKWARD
4011 * \li Action: Deletes characters to the beginning of the word (usually the "C+BackSpace" key).
4012 * \li Syntax: word-delete-backward [force]
4013 * \li Params: force: Delete big insets, do no only select them.
4016 { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
4019 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_FORWARD
4020 * \li Action: Deletes characters to the end of the word (usually the "C+Delete" key).
4021 * \li Syntax: word-delete-forward [force]
4022 * \li Params: force: Delete big insets, do no only select them.
4025 { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
4028 * \var lyx::FuncCode lyx::LFUN_WORD_FIND
4029 * \li Action: Search for next occurrence of a string.
4030 * \li Syntax: word-find [<DATA>]
4031 * \li Params: <DATA>: data encoded from Find dialog (see #lyx::find2string()).
4032 If no parameter is given, search with last find-dialog
4033 data is used for search (i.e. find-next).
4034 * \li Origin: Andre, Jan 7 2004
4037 { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
4040 * \var lyx::FuncCode lyx::LFUN_WORD_FINDADV
4041 * \li Action: Search for next occurrence of a pattern.
4042 * \li Syntax: word-findadv [<DATA>]
4043 * \li Params: <DATA>: data encoded from FindAdv dialog (see #lyx::findadv2string()).
4044 If no parameter is given, search with last find-dialog
4045 data is used for search (i.e. find-next).
4046 * \li Origin: Tommaso, Nov 15 2007
4049 { LFUN_WORD_FINDADV, "word-findadv", ReadOnly | NoBuffer, Edit },
4052 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_BACKWARD
4053 * \li Action: Search for a given string in backward direction.
4054 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
4055 * \li Syntax: word-find-backward [<STRING>]
4056 * \li Origin: Etienne, 20 Feb 1998
4059 { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
4062 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_FORWARD
4063 * \li Action: Search for a given string in forward direction.
4064 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
4065 * \li Syntax: word-find-forward [<STRING>]
4066 * \li Origin: Etienne, 16 Feb 1998
4069 { LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit },
4072 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD
4073 * \li Action: Moves the cursor to the logically next beginning of a word.
4074 * \li Notion: This is not the action which should be bound to the arrow keys,
4075 because forward may be left or right, depending on the language.
4076 The arrow keys should be bound to #LFUN_WORD_LEFT or
4077 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
4078 * \li Syntax: word-forward
4081 { LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
4084 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD_SELECT
4085 * \li Action: Moves the cursor to the logically next beginning of a word,
4086 adding the logically traversed text to the selection.
4087 * \li Notion: See also #LFUN_WORD_FORWARD.
4088 * \li Syntax: word-forward-select
4091 { LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
4094 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT
4095 * \li Action: Moves the cursor to the next beginning of a word "on the left".
4096 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
4097 "left" key is pressed. Generally, it moves the cursor to the
4098 next beginning of a word on the left. However, in Bidi text this
4099 become slightly more complicated, and there are different modes
4100 of cursor movement. In "visual mode", this moves left, plain and
4101 simple. In "logical mode", movement is logically forward in RTL
4102 paragraphs, and logically backwards in LTR paragraphs.
4103 * \li Syntax: word-left
4104 * \li Origin: dov, 28 Oct 2007
4107 { LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
4110 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT_SELECT
4111 * \li Action: Moves the cursor to the next beginning of a word "on the left",
4112 adding *logically* traversed text to the selection.
4113 * \li Notion: See also #LFUN_WORD_LEFT for exact details of the movement.
4114 * \li Syntax: word-left-select
4115 * \li Origin: dov, 28 Oct 2007
4118 { LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit },
4121 * \var lyx::FuncCode lyx::LFUN_WORD_LOWCASE
4122 * \li Action: Change the words in the selection or word at cursor position
4124 * \li Syntax: word-lowcase [<SEL_TYPE>]
4125 * \li Params: <SEL_TYPE>: if this is equal to "partial", then the
4126 * default word starts at cursor position (emacs-style).
4127 * Otherwise, the whole word is considered.
4130 { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
4133 * \var lyx::FuncCode lyx::LFUN_WORD_REPLACE
4134 * \li Action: Replace a string in the document.
4135 * \li Syntax: word-replace [<DATA>]
4136 * \li Params: <DATA>: data is of the form
4139 <casesensitive> <matchword> <all> <forward> <findnext>"
4140 * \li Origin: Andre, Jan 7 2004
4143 { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
4146 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT
4147 * \li Action: Moves the cursor to the next beginning of a word "on the right".
4148 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
4149 "right" key is pressed. Generally, it moves the cursor to the
4150 next beginning of a word on the right. However, in Bidi text
4151 this become slightly more complicated, and there are different
4152 modes of cursor movement. In "visual mode", this moves right,
4153 plain and simple. In "logical mode", movement is logically
4154 forward in LTR paragraphs, and logically backwards in RTL
4156 * \li Syntax: word-right
4157 * \li Origin: dov, 28 Oct 2007
4160 { LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit },
4163 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT_SELECT
4164 * \li Action: Moves the cursor to the next beginning of a word "on the right",
4165 adding *logically* traversed text to the selection.
4166 * \li Notion: See also #LFUN_WORD_RIGHT for exact details of the movement.
4167 * \li Syntax: word-right-select
4168 * \li Origin: dov, 28 Oct 2007
4171 { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
4174 * \var lyx::FuncCode lyx::LFUN_WORD_SELECT
4175 * \li Action: Puts the word where the cursor stands into the selection.
4176 * \li Syntax: word-select
4177 * \li Origin: Andre, 11 Sep 2002
4180 { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
4183 * \var lyx::FuncCode lyx::LFUN_WORD_UPCASE
4184 * \li Action: Change the words in the selection or word at cursor position
4186 * \li Syntax: word-upcase [<SEL_TYPE>]
4187 * \li Params: <SEL_TYPE>: if this is equal to "partial", then the
4188 * default word starts at cursor position (emacs-style).
4189 * Otherwise, the whole word is considered.
4192 { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
4195 * \var lyx::FuncCode lyx::LFUN_WRAP_INSERT
4196 * \li Action: Inserts floats wrapped by the text around.
4197 * \li Syntax: wrap-insert <TYPE>
4198 * \li Params: <TYPE>: table|figure
4199 * \li Origin: Dekel, 7 Apr 2002
4202 { LFUN_WRAP_INSERT, "wrap-insert", Noop, Edit },
4204 { LFUN_NOACTION, "", Noop, Hidden }
4205 #ifndef DOXYGEN_SHOULD_SKIP_THIS
4208 for (int i = 0; items[i].action != LFUN_NOACTION; ++i)
4209 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
4215 LyXAction::LyXAction()
4221 FuncRequest LyXAction::lookupFunc(string const & func) const
4223 string const func2 = trim(func);
4226 return FuncRequest(LFUN_NOACTION);
4229 string const arg = split(func2, cmd, ' ');
4231 FuncMap::const_iterator const fit = lyx_func_map.find(cmd);
4233 return fit != lyx_func_map.end()
4234 ? FuncRequest(fit->second, arg)
4235 : FuncRequest(LFUN_UNKNOWN_ACTION);
4239 string const LyXAction::getActionName(FuncCode action) const
4241 InfoMap::const_iterator const it = lyx_info_map.find(action);
4242 return it != lyx_info_map.end() ? it->second.name : string();
4246 LyXAction::FuncType LyXAction::getActionType(FuncCode action) const
4248 InfoMap::const_iterator const it = lyx_info_map.find(action);
4249 return it != lyx_info_map.end() ? it->second.type : Hidden;
4253 bool LyXAction::funcHasFlag(FuncCode action,
4254 LyXAction::FuncAttribs flag) const
4256 InfoMap::const_iterator ici = lyx_info_map.find(action);
4258 if (ici == lyx_info_map.end()) {
4259 LYXERR0("action: " << action << " is not known.");
4260 LASSERT(false, return false);
4263 return ici->second.attrib & flag;
4267 LyXAction::const_iterator LyXAction::func_begin() const
4269 return lyx_func_map.begin();
4273 LyXAction::const_iterator LyXAction::func_end() const
4275 return lyx_func_map.end();
4279 LyXErr & operator<<(LyXErr & l, FuncCode code)
4282 l.stream() << lyxaction.getActionName(code);