/*! * \file LyXAction.cpp * This file is part of LyX, the document processor. * Licence details can be found in the file COPYING. * * \author Lars Gullik Bjønnes * \author Jean-Marc Lasgouttes * \author John Levon * \author André Pönitz * \author Pavel Sanda * * Full author contact details are available in file CREDITS. */ #include #include "LyXAction.h" #include "FuncRequest.h" #include "support/debug.h" #include "support/lstrings.h" #include "support/lassert.h" #include using namespace std; using namespace lyx::support; namespace lyx { /* NAMING RULES FOR USER-COMMANDS Here's the set of rules to apply when a new command name is introduced: 1) Use the object.event order. That is, use `word-forward' instead of `forward-word'. 2) Don't introduce an alias for an already named object. Same for events. 3) Forward movement or focus is called `forward' (not `right'). 4) Backward movement or focus is called `backward' (not `left'). 5) Upward movement of focus is called `up'. 6) Downward movement is called `down'. 7) The begin of an object is called `begin' (not `start'). 8) The end of an object is called `end'. (May 19 1996, 12:04, RvdK) */ /* LFUN documentation * * The documentation below primarily describes the purpose and syntax * of the various LFUNs. * * The list is alphabetized. Try to keep it that way, and don't forget to add * doxygen commentary. This allows the file LFUNs.lyx to be auto-generated. * (If you should want to do that, see the gen_lfuns.py script, which is in * the development/tools/ directory.) * * Doxygen template below. Some notes: Parameters should be set in uppercase * and put in , [] means optional one. * * Use spaces for indentation (doxy -> .lyx generator is tab-sensitive). */ /*! * \var lyx::FuncCode lyx::LFUN_ * \li Action: * \li Notion: * \li Syntax: * \li Params: * \li Sample: * \li Origin: * \endvar */ LyXAction lyxaction; void LyXAction::newFunc(FuncCode action, string const & name, unsigned int attrib, LyXAction::FuncType type) { lyx_func_map[name] = action; FuncInfo tmpinfo; tmpinfo.name = name; tmpinfo.attrib = attrib; tmpinfo.type = type; lyx_info_map[action] = tmpinfo; } // Needed for LFUNs documentation to be accepted, since doxygen won't take // \var inside functions. #ifndef DOXYGEN_SHOULD_SKIP_THIS void LyXAction::init() { // This function was changed to use the array below in initalization // instead of calling newFunc numerous times because of compilation // times. Since the array is not static we get back the memory it // occupies after the init is completed. It compiles several // magnitudes faster. static bool init; if (init) return; struct ev_item { FuncCode action; char const * name; unsigned int attrib; FuncType type; }; ev_item const items[] = { #endif /*! * \var lyx::FuncCode lyx::LFUN_ACCENT_ACUTE * \li Action: Adds an acute accent \htmlonly (á)\endhtmlonly to the next character typed. * \li Syntax: accent-acute * \endvar */ { LFUN_ACCENT_ACUTE, "accent-acute", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_ACCENT_BREVE * \li Action: Adds a breve accent \htmlonly (ă)\endhtmlonly to the next character typed. * \li Syntax: accent-breve * \endvar */ { LFUN_ACCENT_BREVE, "accent-breve", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_ACCENT_CARON * \li Action: Adds a caron \htmlonly (ǎ)\endhtmlonly to the next character typed. * \li Syntax: accent-caron * \endvar */ { LFUN_ACCENT_CARON, "accent-caron", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_ACCENT_CEDILLA * \li Action: Adds a cedilla \htmlonly (ç)\endhtmlonly to the next character typed. * \li Syntax: accent-cedilla * \endvar */ { LFUN_ACCENT_CEDILLA, "accent-cedilla", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_ACCENT_CIRCLE * \li Action: Adds a circle accent \htmlonly (å)\endhtmlonly to the next character typed. * \li Syntax: accent-circle * \endvar */ { LFUN_ACCENT_CIRCLE, "accent-circle", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_ACCENT_CIRCUMFLEX * \li Action: Adds a circumflex \htmlonly (ê)\endhtmlonly to the next character typed. * \li Syntax: accent-circumflex * \endvar */ { LFUN_ACCENT_CIRCUMFLEX, "accent-circumflex", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_ACCENT_DOT * \li Action: Adds a dot accent \htmlonly (ż)\endhtmlonly to the next character typed. * \li Syntax: accent-dot * \endvar */ { LFUN_ACCENT_DOT, "accent-dot", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_ACCENT_GRAVE * \li Action: Adds a grave accent \htmlonly (è)\endhtmlonly to the next character typed. * \li Syntax: accent-grave * \endvar */ { LFUN_ACCENT_GRAVE, "accent-grave", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_ACCENT_HUNGARIAN_UMLAUT * \li Action: Adds a Hungarian umlaut \htmlonly (ő)\endhtmlonly to the next character typed. * \li Syntax: accent-grave * \endvar */ { LFUN_ACCENT_HUNGARIAN_UMLAUT, "accent-hungarian-umlaut", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_ACCENT_MACRON * \li Action: Adds a macron \htmlonly (ā)\endhtmlonly to the next character typed. * \li Syntax: accent-macron * \endvar */ { LFUN_ACCENT_MACRON, "accent-macron", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_ACCENT_OGONEK * \li Action: Adds an ogonek accent \htmlonly (ą)\endhtmlonly to the next character typed. * \li Syntax: accent-ogonek * \endvar */ { LFUN_ACCENT_OGONEK, "accent-ogonek", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_ACCENT_PERISPOMENI * \li Action: Adds a perispomeni (Greek circumflex) over the next character typed. * \li Syntax: accent-perispomeni * \endvar */ { LFUN_ACCENT_PERISPOMENI, "accent-perispomeni", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_ACCENT_TIE * \li Action: Adds a tie \htmlonly (a͡)\endhtmlonly over the next two character typed. * \li Notion: The following char will finish the tie. * \li Syntax: accent-tie * \endvar */ { LFUN_ACCENT_TIE, "accent-tie", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_ACCENT_TILDE * \li Action: Adds a tilde \htmlonly (ã)\endhtmlonly over the next character typed. * \li Syntax: accent-tilde * \endvar */ { LFUN_ACCENT_TILDE, "accent-tilde", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_ACCENT_UMLAUT * \li Action: Adds an umlaut \htmlonly (ä)\endhtmlonly over the next character typed. * \li Syntax: accent-umlaut * \endvar */ { LFUN_ACCENT_UMLAUT, "accent-umlaut", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERBAR * \li Action: Adds a bar \htmlonly (a̠)\endhtmlonly under the next character typed. * \li Syntax: accent-underbar * \endvar */ { LFUN_ACCENT_UNDERBAR, "accent-underbar", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERDOT * \li Action: Adds a dot \htmlonly (ạ)\endhtmlonly under the next character typed. * \li Syntax: accent-underdot * \endvar */ { LFUN_ACCENT_UNDERDOT, "accent-underdot", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_ACCEPT * \li Action: Accepts all tracked changes in the document. * \li Syntax: all-changes-accept * \li Origin: Levon, 16 Oct 2002 * \endvar */ { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_REJECT * \li Action: Rejects all tracked changes in the document. * \li Notion: Reject does not work recursively; the user may have to repeat the operation. * \li Syntax: all-changes-reject * \li Origin: Levon, 16 Oct 2002 * \endvar */ { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_APPENDIX * \li Action: Start (or remove) Appendix on the given cursor position. * \li Syntax: appendix * \li Origin: ettrich, 5 May 1998 * \endvar */ { LFUN_APPENDIX, "appendix", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_ARGUMENT_INSERT * \li Action: Inserts an argument (short title) inset. * \li Syntax: argument-insert * \li Params: : see layout declarations * \li Origin: vermeer, 12 Aug 2002 * \endvar */ { LFUN_ARGUMENT_INSERT, "argument-insert", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_ADD * \li Action: Adds database, which will be used for bibtex citations. * \li Notion: Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor position. * \li Syntax: bibtex-database-add * \li Origin: Ale, 30 May 1997 * \endvar */ { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_DEL * \li Action: Adds database, which will be used for bibtex citations. * \li Notion: Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor position. * \li Syntax: bibtex-database-del * \li Origin: Ale, 30 May 1997 * \endvar */ { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR * \li Action: Clears the list of saved bookmarks. * \li Syntax: bookmark-clear * \li Origin: bpeng, 31 October 2006 * \endvar */ { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO * \li Action: Moves the cursor to the numbered bookmark, opening the file if necessary. Note that bookmarks are saved per-session, not per file. * \li Notion: Bookmark 0 has a special purpose. It is automatically set \n 1. to the paragraph you are currently editing \n 2. to the paragraph from where you are jumping to the last-edited position (jump-back feature) \n 3. when jumping from crossreference to the requested label by #LFUN_LABEL_GOTO. * \li Syntax: bookmark-goto * \li Params: : the number of the bookmark to restore. * \li Origin: Dekel, 27 January 2001 * \endvar */ { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE * \li Action: Save a bookmark. * \li Notion: Saves a numbered bookmark to the sessions file. The number must be between 1 and 9, inclusive. Note that bookmarks are saved per-session, not per file. * \li Syntax: bookmark-save * \li Params: : the number of the bookmark to save. * \li Origin: Dekel, 27 January 2001 * \endvar */ { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_BOX_INSERT * \li Action: Inserts Box inset. * \li Syntax: box-insert [] * \li Params: : Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox \n Framed is the default one. * \li Origin: vermeer, 7 Oct 2003 * \endvar */ { LFUN_BOX_INSERT, "box-insert", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_BRANCHES_RENAME * \li Action: Rename all branches of a given name in a document. * \li Syntax: branches-rename * \li Params: : Current name of the branch to be renamed * : New name of the branch * \li Origin: spitz, 9 Jul 2009 * \endvar */ { LFUN_BRANCHES_RENAME, "branches-rename", Noop, Buffer }, /*! * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE * \li Action: Activate the branch. * \li Syntax: branch-activate * \li Params: : The branch to activate * \li Sample: lyx -x "branch-activate answers" -e pdf2 finalexam.lyx \n could be used to export a pdf with the answers branch included without one's having to open LyX and activate the branch manually. * \li Origin: rgh, 27 May 2008 * \endvar */ { LFUN_BRANCH_ACTIVATE, "branch-activate", AtPoint, Buffer }, /*! * \var lyx::FuncCode lyx::LFUN_BRANCH_ADD * \li Action: Add a branch to the buffer's BranchList. * \li Syntax: branch-add * \li Params: : Name of the branch to add * \li Origin: spitz, 7 Jul 2009 * \endvar */ { LFUN_BRANCH_ADD, "branch-add", AtPoint, Buffer }, /*! * \var lyx::FuncCode lyx::LFUN_BRANCH_ADD_INSERT * \li Action: Create new branch and directly put the branch inset into the document. * \li Syntax: branch-add-insert [] * \li Params: : Branch name. If it is not specified, you will be asked. * \li Origin: sanda, 10 Jul 2009 * \endvar */ { LFUN_BRANCH_ADD_INSERT, "branch-add-insert", Noop, Buffer }, /*! * \var lyx::FuncCode lyx::LFUN_BRANCH_DEACTIVATE * \li Action: De-activate the branch. * \li Syntax: branch-deactivate * \li Params: : The branch to deactivate * \li Origin: rgh, 27 May 2008 * \endvar */ { LFUN_BRANCH_DEACTIVATE, "branch-deactivate", AtPoint, Buffer }, /*! * \var lyx::FuncCode lyx::LFUN_BRANCH_INSERT * \li Action: Inserts branch inset. * \li Syntax: branch-insert * \li Origin: vermeer, 17 Aug 2003 * \endvar */ { LFUN_BRANCH_INSERT, "branch-insert", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_BRANCH_INVERT * \li Action: Toggles inversion status of branch inset. * \li Syntax: branch-invert * \li Origin: rgheck, 12 July 2016 * \endvar */ { LFUN_BRANCH_INVERT, "branch-invert", AtPoint, Buffer }, /*! * \var lyx::FuncCode lyx::LFUN_BRANCH_MASTER_ACTIVATE * \li Action: Activate the branch in the master buffer. * \li Syntax: branch-master-activate * \li Params: : The branch to activate * \li Sample: lyx -x "branch-activate answers" -e pdf2 finalexam.lyx \n could be used to export a pdf with the answers branch included without one's having to open LyX and activate the branch manually. * \li Origin: spitz, 30 Sep 2012 * \endvar */ { LFUN_BRANCH_MASTER_ACTIVATE, "branch-master-activate", AtPoint, Buffer }, /*! * \var lyx::FuncCode lyx::LFUN_BRANCH_MASTER_DEACTIVATE * \li Action: De-activate the branch in the master buffer. * \li Syntax: branch-master-deactivate * \li Params: : The branch to deactivate * \li Origin: spitz, 30 Sep 2012 * \endvar */ { LFUN_BRANCH_MASTER_DEACTIVATE, "branch-master-deactivate", AtPoint, Buffer }, /*! * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE * \li Action: Saves the current buffer to a temporary file. * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN is called automatically by LyX, to "autosave" the current buffer. * \li Syntax: buffer-auto-save * \endvar */ { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer }, /*! * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN * \li Action: Move the cursor to the beginning of the document. * \li Syntax: buffer-begin * \endvar */ { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN_SELECT * \li Action: Move the cursor to the beginning of the document adding the traversed text to the selection. * \li Syntax: buffer-begin-select * \endvar */ { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_BUFFER_CHILD_OPEN * \li Action: Loads the given child document. * \li Notion: The current document is treated as a parent. * \li Syntax: buffer-child-open * \li Params: : Filename of the child. The directory of the parent is assumed by default. * \li Origin: Ale, 28 May 1997 * \endvar */ { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer }, /*! * \var lyx::FuncCode lyx::LFUN_BUFFER_CHKTEX * \li Action: Runs chktex for the current document. * \li Syntax: buffer-chktex * \li Origin: Asger, 30 Oct 1997 * \endvar */ { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer }, /*! * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE * \li Action: Closes the current buffer. * \li Notion: Closes the current buffer, asking whether to save it, etc, if the buffer has been modified. * \li Syntax: buffer-close * \endvar */ { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer }, /*! * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE_ALL * \li Action: Closes all buffers. * \li Notion: Closes all buffers, asking whether to save it, etc, if a buffer has been modified. * \li Syntax: buffer-close-all * \endvar */ { LFUN_BUFFER_CLOSE_ALL, "buffer-close-all", ReadOnly, Buffer }, /*! * \var lyx::FuncCode lyx::LFUN_BUFFER_END * \li Action: Move the cursor to the end of the document. * \li Syntax: buffer-end * \endvar */ { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_BUFFER_END_SELECT * \li Action: Move the cursor to the end of the document adding the traversed text to the selection. * \li Syntax: buffer-end-select * \endvar */ { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT * \li Action: Exports the current buffer (document) to the given format. * \li Syntax: buffer-export [] [] * \li Params: is either "custom" or one of the formats which you can find in Tools->Preferences->File formats->Format. Usual format you will enter is "pdf2" (pdflatex), "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n In case of "custom" you will be asked for a format you want to start from and for the command that you want to apply to this format. Internally the control is then passed to #LFUN_BUFFER_EXPORT_CUSTOM.\n If absent or "default", then the default output format of the document is used. If present, this argument provides the export destination filename. Its containing folder will also be the destination folder, where all the needed external files will be copied. * \li Origin: Lgb, 29 Jul 1997 * \endvar */ { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer }, /*! * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_AS * \li Action: Opens a dialog for exporting the current buffer. * \li Syntax: buffer-export-as [] * \li Params: is the export format initially selected in the dialog. * You can pass any of the formats which you can find in * Tools->Preferences->File formats->Format, provided it * has the "document" flag set. If no format is specified * the dialog will start with the default output format of * the current document. * \li Sample: buffer-export-as pdf2 * \li Origin: tommaso, 6 Oct 2011 * \endvar */ { LFUN_BUFFER_EXPORT_AS, "buffer-export-as", ReadOnly, Buffer }, /*! * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM * \li Action: Exports the current buffer (document) from the given format using the given command on it. * \li Syntax: buffer-export-custom * \li Params: format to start from (LyX will care to produce such intermediate file).\n this command will be launched on the file. Note that you can use "$$FName" string to qualify the intermediate file. * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps * \li Origin: leeming, 27 Mar 2004 * \endvar */ { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer }, /*! * \var lyx::FuncCode lyx::LFUN_BUFFER_FORALL * \li Action: Applies a command to all non-hidden buffers. * \li Notion: a buffer is `hidden' if it is internally open in LyX, but not visible in any window. * \li Syntax: buffer-forall * \li Params: : The command to be applied to the buffers. * \li Sample: Close all Notes in buffers: \n buffer-forall inset-forall Note inset-toggle close \n Toggle change tracking on buffers: \n buffer-forall changes-track \n Toggle read-only for buffers: \n buffer-forall buffer-toggle-read-only \n Show statistics for individual buffers: \n buffer-forall statistics \n Activate the branch named "Solutions" in buffers: \n buffer-forall branch-activate Solutions \n Export buffers to PDF (pdflatex): \n buffer-forall buffer-export pdf2 \n * \li Origin: skostysh, 20 Jul 2012 * \endvar */ { LFUN_BUFFER_FORALL, "buffer-forall", ReadOnly | Argument, Buffer }, /*! * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT * \li Action: Import a given file as a lyx document. * \li Notion: File can be imported iff lyx file format is (transitively) reachable via defined converters in preferences. Look in the File->Import menu to get an idea of the currently active import formats. * \li Syntax: buffer-import [] * \li Origin: Asger, 24 Jul 1998 * \endvar */ { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer }, /*! * \var lyx::FuncCode lyx::LFUN_BUFFER_LANGUAGE * \li Action: Set language of the current document. * \li Syntax: buffer-language * \li Params: : language name. See lib/languages for list. * \li Origin: leeming, 30 Mar 2004 * \endvar */ { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer }, /*! * \var lyx::FuncCode lyx::LFUN_BUFFER_MOVE_NEXT * \li Action: Moves the current tab one spot to the right. * \li Syntax: buffer-move-next * \li Origin: skostysh, 7 Apr 2015 * \endvar */ { LFUN_BUFFER_MOVE_NEXT, "buffer-move-next", ReadOnly, Buffer }, /*! * \var lyx::FuncCode lyx::LFUN_BUFFER_MOVE_PREVIOUS * \li Action: Moves the current tab one spot to the left. * \li Syntax: buffer-move-previous * \li Origin: skostysh, 7 Apr 2015 * \endvar */ { LFUN_BUFFER_MOVE_PREVIOUS, "buffer-move-previous", ReadOnly, Buffer }, /*! * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW * \li Action: Creates a new buffer (that is, document) and switches to it. * \li Notion: Implicit path can be set in Preferences dialog. * \li Syntax: buffer-new [] * \li Params: : filename of created file with absolute path. * \endvar */ { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer }, /*! * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE * \li Action: Creates a new buffer (that is, document) from a template. * \li Notion: Path for new files and templates can be set in Preferences dialog. Template will be asked for via Open-dialog. * \li Syntax: buffer-new-template [] * \li Params: : filename of created file with absolute path. * \endvar */ { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer }, /*! * \var lyx::FuncCode lyx::LFUN_BUFFER_NEXT * \li Action: Switch to the next opened document. * \li Notion: Note that this does not necessarily mean next in tabbar (for full list see View menu). * \li Syntax: buffer-next * \endvar */ { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer }, /*! * \var lyx::FuncCode lyx::LFUN_BUFFER_PARAMS_APPLY * \li Action: Apply the given settings to the current document. * \li Syntax: buffer-params-apply [] * \li Params: : contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file. * \li Origin: leeming, 30 Mar 2004 * \endvar */ { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", NoInternal, Buffer }, /*! * \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS * \li Action: Switch to the previous opened document. * \li Syntax: buffer-previous * \endvar */ { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer }, /*! * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD * \li Action: Reverts opened document. * \li Syntax: buffer-reload * \li Origin: Asger, 2 Feb 1997 * \endvar */ { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer }, /*! * \var lyx::FuncCode lyx::LFUN_BUFFER_SAVE_AS_DEFAULT * \li Action: Save the current document settings as default. * \li Notion: The file will will be saved into ~/.lyx/templates/defaults.lyx . * \li Syntax: buffer-save-as-default [] * \li Params: : contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file. * \li Origin: leeming, 30 Mar 2004 * \endvar */ { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer }, /*! * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH * \li Action: Display and switch to the given buffer. * \li Syntax: buffer-switch * \li Params: : path and filename of already opened (but possibly hidden) document which is to be shown. * \endvar */ { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer }, /*! * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION * \li Action: Toggles compression of the current document on/off. * \li Syntax: buffer-toggle-compression * \li Origin: bpeng, 27 Apr 2006 * \endvar */ { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer }, /*! * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_OUTPUT_SYNC * \li Action: Toggles including of resources for forward/reverse search of the given document. * \li Notion: When toggled on, SyncTeX is invoked for PDF, while srcltx package is used for DVI. Custom LaTeX macro can be defined in preferences. * \li Syntax: buffer-toggle-output-sync * \li Origin: sanda, 25 May 2010 * \endvar */ { LFUN_BUFFER_TOGGLE_OUTPUT_SYNC, "buffer-toggle-output-sync", Noop, System }, /*! * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY * \li Action: Toggle editing mode of the current document between read/write and read-only. * \li Notion: This function is not allowed if the file is under version control, since read-only flag is often used in version control file locking. * \li Syntax: buffer-toggle-read-only * \li Origin: Lgb, 27 May 1997 * \endvar */ { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer }, /*! * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE * \li Action: Exports the current document and put the result into the temporary directory. * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW) the output will be rewritten - updated. This is useful in case your viewer is able to detect such changes (e.g. ghostview for postscript). * \li Syntax: buffer-update [] * \li Params: : The format to display, where this is one of the formats defined (in the current GUI) in the Tools>Preferences>File Formats dialog. If no format is given, the default format as specified in the same dialog is used. * \li Origin: Dekel, 5 Aug 2000 * \endvar */ { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer }, /*! * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW * \li Action: Displays current buffer in chosen format. * \li Notion: Displays the contents of the current buffer in the chosen format, for example, PDF or DVI. This runs the necessary converter, calls the defined viewer, and so forth. * \li Syntax: buffer-view [] * \li Params: : The format to display, where this is one of the formats defined (in the current GUI) in the Tools>Preferences>File Formats dialog. If no format is given, the default format as specified in the same dialog is used. * \endvar */ { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer }, /*! * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW_CACHE * \li Action: Opens the file that was created from last preview of this buffer. * \li Notion: This LFUN is called by the "Show Output Anyway" button in the LaTeX * Errors dialog. It can also be called by the user, which is useful * if the document takes a long time to compile, and you just * want to see the last previewed version. * \li Syntax: buffer-view-cache * \endvar */ { LFUN_BUFFER_VIEW_CACHE, "buffer-view-cache", ReadOnly, Buffer }, /*! * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE * \li Action: Saves the current buffer. * \li Notion: Saves the current buffer to disk, using the filename that is already associated with the buffer, asking for one if none is yet assigned. * \li Syntax: buffer-write * \endvar */ { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer }, /*! * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL * \li Action: Save all changed documents. * \li Syntax: buffer-write-all * \li Origin: rgh, gpothier 6 Aug 2007 * \endvar */ { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer }, /*! * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS * \li Action: Rename and save current buffer. * \li Syntax: buffer-write-as * \li Params: : New name of the buffer/file. A relative path is with respect to the original location of the buffer/file. * \endvar */ { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer }, /*! * \var lyx::FuncCode lyx::LFUN_BUFFER_EXTERNAL_MODIFICATION_CLEAR * \li Action: Clear the external modification flag on the current buffer. * \li Syntax: buffer-external-modification-clear * \li Origin: gm, 2 March 2017 * \endvar */ { LFUN_BUFFER_EXTERNAL_MODIFICATION_CLEAR, "buffer-external-modification-clear", ReadOnly, Buffer }, /*! * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM * \li Action: Sets the zoom of the screen fonts. * \li Syntax: buffer-zoom [] * \li Params: : The target zoom value in %; * the default is the default zoom as saved in preferences. * \li Origin: daniel, 28 Oct 2016 * \endvar */ { LFUN_BUFFER_ZOOM, "buffer-zoom", ReadOnly, Buffer }, /*! * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_IN * \li Action: Increases the zoom of the screen fonts. * \li Syntax: buffer-zoom-in [] * \li Params: : The zoom value addition in % (neg. or pos.); * the default is 10% of the default zoom as saved in preferences. * \li Origin: vfr, 30 Mar 2009 * \endvar */ { LFUN_BUFFER_ZOOM_IN, "buffer-zoom-in", ReadOnly, Buffer }, /*! * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_OUT * \li Action: Decreases the zoom of the screen fonts. * \li Syntax: buffer-zoom-out [] * \li Params: : The zoom value abstraction in % (neg. or pos.); * the default is 10% of the default zoom as saved in preferences. * \li Origin: vfr, 30 Mar 2009 * \endvar */ { LFUN_BUFFER_ZOOM_OUT, "buffer-zoom-out", ReadOnly, Buffer }, /*! * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM * \li Action: Generates the code (literate programming). * \li Notion: Latex file with extension \literate_extension is generated. Then LyX invokes \build_command (with a default of ``make'') to generate the code and \build_error_filter to process the compilation error messages. \n In case you want to process your literate file with a script, or some other program, just insert in your lyxrc file an entry with:\n \build_command "my_script my_arguments" \n The \build_error_filter differs from the \literate_error_filter only in that the former will identify error messages from your compiler. * \li Syntax: build-program * \endvar */ { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer }, /*! * \var lyx::FuncCode lyx::LFUN_CALL * \li Action: Executes a command defined in a .def file. * \li Notion: The definitions are by default read from lib/commands/default.def.\n A .def file allows to define a command with \define "" "" where is the name of the new command and is the lfun code to be executed (see e.g. #LFUN_COMMAND_SEQUENCE). \def_file "FileName" allows to include another .def file. \n This is particularly useful in connection with toolbar buttons: Since the name of the button image for this lfun is lib/images/commands/.png this is the way to assign an image to a complex command-sequence. * \li Syntax: call * \li Params: : Name of the command that must be called. * \li Origin: broider, 2 Oct 2007 * \endvar */ { LFUN_CALL, "call", NoBuffer, System }, /*! * \var lyx::FuncCode lyx::LFUN_CANCEL * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX . * \li Syntax: cancel * \endvar */ { LFUN_CANCEL, "cancel", NoBuffer, System }, /*! * \var lyx::FuncCode lyx::LFUN_CAPTION_INSERT * \li Action: Inserts a caption inset. * \li Syntax: caption-insert * \li Origin: Lgb, 18 Jul 2000 * \endvar */ { LFUN_CAPTION_INSERT, "caption-insert", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_CELL_BACKWARD * \li Action: Moves the cursor to the previous cell inside the table. * \li Syntax: cell-backward * \li Origin: Jug, 22 May 2000 * \endvar */ { LFUN_CELL_BACKWARD, "cell-backward", ReadOnly | NoUpdate, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_CELL_FORWARD * \li Action: Moves the cursor to the next cell inside the table. * \li Syntax: cell-forward * \endvar */ { LFUN_CELL_FORWARD, "cell-forward", ReadOnly | NoUpdate, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_CELL_SPLIT * \li Action: Splits cell and shifts right part to the next cell (inside the math grid). * \li Syntax: cell-split * \li Origin: Ale, 15 May 1997 * \endvar */ { LFUN_CELL_SPLIT, "cell-split", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_CHANGES_MERGE * \li Action: Open change tracking dialog for merging and moves the cursor to the position of the next change. * \li Syntax: changes-merge * \li Origin: Levon, 16 Oct 2002 * \endvar */ { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_CHANGES_OUTPUT * \li Action: Toggles showing of change tracking in typeset output. * \li Syntax: changes-output * \li Origin: jspitzm, 21 Jan 2005 * \endvar */ { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_CHANGES_TRACK * \li Action: Toggles change tracking to on/off. * \li Syntax: changes-track * \li Origin: levon, 1 Oct 2002 * \endvar */ { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_CHANGE_ACCEPT * \li Action: Accepts tracked change inside the selection. * \li Syntax: change-accept * \li Origin: Levon, 16 Oct 2002 * \endvar */ { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_CHANGE_NEXT * \li Action: Moves the cursor to the position of the next change of the change tracking records. * \li Syntax: change-next * \li Origin: schmitt, 4 Oct 2006 * \endvar */ { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_CHANGE_PREVIOUS * \li Action: Moves the cursor to the position of the previous change of the change tracking records. * \li Syntax: change-previous * \li Origin: vfr, 4 Apr 2009 * \endvar */ { LFUN_CHANGE_PREVIOUS, "change-previous", ReadOnly, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_CHANGE_REJECT * \li Action: Rejects tracked change inside the selection. * \li Syntax: change-reject * \li Origin: Levon, 16 Oct 2002 * \endvar */ { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_CHARS_TRANSPOSE * \li Action: Transposes the character at the cursor with the one before it. * \li Syntax: chars-transpose * \li Origin: Lgb, 25 Apr 2001 * \endvar */ { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD * \li Action: Moves the cursor one position logically backwards. * \li Notion: This is not the action which should be bound to the arrow keys, because backwards may be left or right, depending on the language. The arrow keys should be bound to #LFUN_CHAR_LEFT or #LFUN_CHAR_RIGHT actions, which in turn may employ this one. * \li Syntax: char-backward * \endvar */ { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD_SELECT * \li Action: Moves the cursor one position logically backwards, adding traversed position to the selection. * \li Notion: See also #LFUN_CHAR_BACKWARD. * \li Syntax: char-backward-select * \endvar */ { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_BACKWARD * \li Action: Deletes one character in the backward direction (usually the "BackSpace" key). * \li Syntax: char-delete-backward [force] * \li Params: force: Delete big insets, do not only select them. * \endvar */ { LFUN_CHAR_DELETE_BACKWARD, "char-delete-backward", SingleParUpdate, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_FORWARD * \li Action: Deletes one character in the backward direction (usually the "Delete" key). * \li Syntax: char-delete-forward [force] * \li Params: force: Delete big insets, do not only select them. * \endvar */ { LFUN_CHAR_DELETE_FORWARD, "char-delete-forward", SingleParUpdate, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD * \li Action: Moves the cursor one position logically forward. * \li Notion: This is not the action which should be bound to the arrow keys, because forward may be left or right, depending on the language. The arrow keys should be bound to #LFUN_CHAR_LEFT or #LFUN_CHAR_RIGHT actions, which in turn may employ this one. * \li Syntax: char-forward * \endvar */ { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD_SELECT * \li Action: Moves the cursor one position logically forward, adding traversed position to the selection. * \li Notion: See also #LFUN_CHAR_FORWARD. * \li Syntax: char-forward-select * \endvar */ { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT * \li Action: Moves the cursor one position "to the left". * \li Notion: This is the action which should be taken when the "left" key is pressed. Generally, it moves the cursor one position to the left. However, in Bidi text this become slightly more complicated, and there are different modes of cursor movement. In "visual mode", this moves left, plain and simple. In "logical mode", movement is logically forward in RTL paragraphs, and logically backwards in LTR paragraphs. * \li Syntax: char-left * \endvar */ { LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT_SELECT * \li Action: Moves the cursor one position "to the left", adding traversed position to the selection. * \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement. * \li Syntax: char-left-select * \endvar */ { LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT * \li Action: Moves the cursor one position "to the right". * \li Notion: This is the action which should be taken when the "right" key is pressed. Generally, it moves the cursor one position to the right. However, in Bidi text this become slightly more complicated, and there are different modes of cursor movement. In "visual mode", this moves right, plain and simple. In "logical mode", movement is logically forward in LTR paragraphs, and logically backwards in RTL paragraphs. * \li Syntax: char-right * \endvar */ { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT_SELECT * \li Action: Moves the cursor one position "to the right", adding traversed position to the selection. * \li Notion: See also #LFUN_CHAR_RIGHT for exact details of the movement. * \li Syntax: char-right-select * \endvar */ { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_CITATION_INSERT * \li Action: Inserts citation from loaded citation database. * \li Syntax: citation-insert [[|]] * \li Params: : Citation (shortcut listed in available citations). \n : text which should appear before citation. * \li Origin: AAS, 97-02-23 * \endvar */ { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE * \li Action: Pastes text from the active clipboard (retains formatting if the clipboard contains formatted text). Pastes plain text if plain text is on the clipboard, but tries to interpret it in special ways for certain insets, e.g. converting csv data to rows and columns if the paste happens in a tabular inset. * \li Notion: Historically, LFUN_CLIPBOARD_PASTE was introduced as a counterpart of LFUN_PRIMARY_SELECTION_PASTE: It behaved exactly the same, but the source is the clipboard, not the selection. * \li Syntax: clipboard-paste [] * \li Params: : "paragraph" will cause pasting as one paragraph, i.e. "Join lines". * \li Origin: Georg, 10 Jul 2006 * \endvar */ { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE_SIMPLE * \li Action: Pastes plain text from the active clipboard even if formatted LyX content is in the clipboard. Pastes plain text if plain text is on the clipboard, without trying to interpret it in special ways for certain insets, e.g. converting csv data to rows and columns if the paste happens in a tabular inset. * \li Syntax: clipboard-paste-simple [] * \li Params: : "paragraph" will cause pasting as one paragraph, i.e. "Join lines". * \endvar */ { LFUN_CLIPBOARD_PASTE_SIMPLE, "clipboard-paste-simple", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_COMMAND_ALTERNATIVES * \li Action: Runs the first listed command that is enabled. * \li Notion: This can be used to bind multiple functions to a single key, and then which one is used will depend upon the context. * \li Syntax: command-alternatives * \li Params: : Sequence of commands separated by semicolons. * \li Sample: command-alternatives completion-accept;cell-forward * \li Origin: rgh, 24 September 2008 * \endvar */ { LFUN_COMMAND_ALTERNATIVES, "command-alternatives", NoBuffer, System }, /*! * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE * \li Action: Switches the focus to the minibuffer so that the user can type in there. If necessary, it opens the minibuffer toolbar. * \li Notion: Usually bound to M-x shortcut. * \li Syntax: command-execute * \endvar */ { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_COMMAND_PREFIX * \li Action: Return the current key sequence and available options as a string. * \li Notion: No options are added if no current map exists. \n This is probably usable only with connection to lyxserver. * \li Syntax: command-prefix * \endvar */ { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden }, /*! * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE * \li Action: Run more commands (LFUN and its parameters) in a sequence. * \li Syntax: command-sequence * \li Params: : Sequence of commands separated by semicolons. * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle; * \li Origin: Andre, 11 Nov 1999 * \endvar */ { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System }, /*! * \var lyx::FuncCode lyx::LFUN_COMPLETE * \li Action: Try to complete the word or command at the cursor position. * \li Syntax: complete * \li Origin: sts, Feb 19 2008 * \endvar */ { LFUN_COMPLETE, "complete", SingleParUpdate, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_COMPLETION_ACCEPT * \li Action: Accept suggested completion. * \li Syntax: completion-accept * \li Origin: sanda, Sep 08 2008 * \endvar */ { LFUN_COMPLETION_ACCEPT, "completion-accept", SingleParUpdate, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_COMPLETION_CANCEL * \li Action: Try to cancel completion, either the popup or the inline completion. * \li Syntax: completion-cancel * \li Origin: sts, Sep 07 2008 * \endvar */ { LFUN_COMPLETION_CANCEL, "completion-cancel", SingleParUpdate, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE * \li Action: Show the inline completion at the cursor position. * \li Syntax: completion-inline * \li Origin: sts, Feb 19 2008 * \endvar */ { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP * \li Action: Show the completion popup at the cursor position. * \li Syntax: completion-popup * \li Origin: sts, Feb 19 2008 * \endvar */ { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_COPY * \li Action: Copies the current selection to the clipboard. * \li Syntax: copy * \endvar */ { LFUN_COPY, "copy", ReadOnly, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE * \li Action: Determine whether to keep cursor inside the editing window regardless of the scrollbar movement. * \li Syntax: toggle-cursor-follows-scrollbar * \li Origin: ARRae, 2 Dec 1997 * \endvar */ { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System }, /*! * \var lyx::FuncCode lyx::LFUN_CUT * \li Action: Cuts to the clipboard. * \li Syntax: cut * \endvar */ { LFUN_CUT, "cut", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_DATE_INSERT * \li Action: Inserts the current date. * \li Syntax: date-insert [] * \li Params: : Format of date. The default value (%x) can be set in Preferences->Date format. For possible formats see manual page of strftime function. * \li Origin: jdblair, 31 Jan 2000 * \endvar */ { LFUN_DATE_INSERT, "date-insert", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_DEBUG_LEVEL_SET * \li Action: Set debug output level. * \li Syntax: debug-level-set * \li Params: : comma separated list of levels or the correspondent number of their combination. 0 is equivalent to disabling all debug events. See lyx -dbg for the current list of debug levels and their numbers. * \li Origin: sanda, 28 Dec 2009 * \endvar */ { LFUN_DEBUG_LEVEL_SET, "debug-level-set", NoBuffer, System }, /*! * \var lyx::FuncCode lyx::LFUN_DEPTH_DECREMENT * \li Action: Decrease the nesting depth of the (selected) paragraph(s) inside lists. * \li Syntax: depth-decrement * \endvar */ { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_DEPTH_INCREMENT * \li Action: Increase the nesting depth of the (selected) paragraph(s) inside lists. * \li Syntax: depth-increment * \endvar */ { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_DEVEL_MODE_TOGGLE * \li Action: toggle a mode where more information is given in UI * \li Syntax: devel-mode-toggle * \li Notion: in so called "devel" mode, the information given in the * status bar is more precise, and the help documents are * open in editing mode. * \li Origin: lasgouttes, 23 Jul 2017 * \endvar */ { LFUN_DEVEL_MODE_TOGGLE, "devel-mode-toggle", NoBuffer, System }, /*! * \var lyx::FuncCode lyx::LFUN_DIALOG_DISCONNECT_INSET * \li Action: Closes opened connection to opened inset. * \li Notion: Connection is used for apply functions. * \li Syntax: dialog-disconnect-inset * \li Origin: leeming, 25 Feb 2003 * \endvar */ { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_DIALOG_HIDE * \li Action: Hides showed dialog. Counterpart to #LFUN_DIALOG_SHOW . * \li Syntax: dialog-hide * \li Params: See #LFUN_DIALOG_SHOW . * \li Origin: leeming, 25 Feb 2003 * \endvar */ { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW * \li Action: Shows hidden dialog or creates new one for a given function/inset settings etc. * \li Syntax: dialog-show [] * \li Params: : aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|\n compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|\n graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimiter|\n mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|\n print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|\n thesaurus|texinfo|toc|view-source|vspace|wrap| \n : latexlog|vclog \n : data, usually settings for the given dialog. Use debug mode for the details. * \li Origin: leeming, 17 Jun 2003 * \endvar */ { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW_NEW_INSET * \li Action: Shows hidden dialog or create new one for a given inset settings etc. * \li Notion: Internally uses #LFUN_DIALOG_SHOW with processed data for a given inset. * \li Syntax: dialog-show-new-inset [] * \li Params: See #LFUN_DIALOG_SHOW . * \li Origin: leeming, 25 Feb 2003 * \endvar */ { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_DIALOG_TOGGLE * \li Action: Toggles dialog between showed/hidden state. * \li Notion: Internally uses #LFUN_DIALOG_SHOW , #LFUN_DIALOG_HIDE . * \li Syntax: dialog-toggle [] * \li Params: See #LFUN_DIALOG_SHOW . * \li Origin: JSpitzm, 30 Apr 2007 * \endvar */ { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_DIALOG_UPDATE * \li Action: Updates the dialog values from the inset/paragraph/document. * \li Syntax: dialog-update * \li Params: : paragraph|prefs| \n : inset name * \li Origin: leeming, 25 Feb 2003 * \endvar */ { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_DOWN * \li Action: Moves the cursor one line in downward direction. * \li Syntax: down * \endvar */ { LFUN_DOWN, "down", ReadOnly | NoUpdate, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_DOWN_SELECT * \li Action: Moves the cursor one line in downward direction adding the current position to the selection. * \li Syntax: down-select * \endvar */ { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE * \li Action: Displays list of layout choices. * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the dropbox allowing for choice of layout. * \li Syntax: drop-layouts-choice * \endvar */ { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout }, /*! * \var lyx::FuncCode lyx::LFUN_ENVIRONMENT_SPLIT * \li Action: Splits the current environment with a Separator. * \li Syntax: environment-split [before|outer|previous] * \li Params: outer: If this is given, LyX will split the outermost environment in the current nesting hierarchy.\n previous: If this is given, LyX will split the environment in the previous paragraph (if there is one).\n before: If this is given, the new environment will be appended rather than prepended. * \li Origin: spitz, 23 Dec 2012 * \endvar */ { LFUN_ENVIRONMENT_SPLIT, "environment-split", Noop, Layout }, /*! * \var lyx::FuncCode lyx::LFUN_ERT_INSERT * \li Action: Inserts an ERT inset. * \li Syntax: ert-insert * \li Origin: Jug, 18 Feb 2000 * \endvar */ { LFUN_ERT_INSERT, "ert-insert", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_ESCAPE * \li Action: Clears the selection. If no text is selected call #LFUN_FINISHED_FORWARD. Inside math mode jumps out of the math inset. * \li Syntax: escape * \li Origin: Lgb, 17 May 2001 * \endvar */ { LFUN_ESCAPE, "escape", ReadOnly, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_FILE_INSERT * \li Action: Inserts another LyX file. * \li Syntax: file-insert [] * \li Params: : Filename to be inserted. * \endvar */ { LFUN_FILE_INSERT, "file-insert", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT * \li Action: Inserts plain text file. * \li Syntax: file-insert-plaintext [] * \li Params: : Filename to be inserted. * \li Origin: CFO-G, 19 Nov 1997 * \endvar */ { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA * \li Action: Inserts plain text file as paragraph (i.e. join lines). * \li Syntax: file-insert-plaintext-para [] * \li Params: : Filename to be inserted. * \li Origin: Levon, 14 Feb 2001 * \endvar */ { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_FILE_OPEN * \li Action: Open LyX document. * \li Syntax: file-open [] * \li Params: : Filename to be opened. * \endvar */ { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer }, /*! * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD * \li Action: Moves the cursor out of the current slice, going backwards. * \li Notion: See also #LFUN_FINISHED_FORWARD. * \endvar */ { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden }, /*! * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD * \li Action: Moves the cursor out of the current slice, going forward. * \li Notion: Cursor movement within an inset may be different than cursor movement in the surrounding text. This action should be called automatically by the cursor movement within the inset, when movement within the inset has ceased (reached the end of the last paragraph, for example), in order to move correctly back into the surrounding text. * \endvar */ { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden }, /*! * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT * \li Action: Moves the cursor out of the current slice, going left. * \li Notion: See also #LFUN_FINISHED_FORWARD. * \endvar */ { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden }, /*! * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT * \li Action: Moves the cursor out of the current slice, going right. * \li Notion: See also #LFUN_FINISHED_FORWARD * \endvar */ { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden }, /*! * \var lyx::FuncCode lyx::LFUN_FLEX_INSERT * \li Action: Inserts CharStyle, Custom inset or XML short element. * \li Notion: Look into the Customization manual for more information about these elements.\n To make this command enabled the layout file for the document class you're using has to load the character styles. There are a few contained in the Logical Markup module. You can also of course create some yourself. \n For dissolving the element see #LFUN_INSET_DISSOLVE. * \li Syntax: flex-insert Name * \li Params: Name: This name must be defined either in your layout file or imported by some module. The definition is InsetLayout Name or InsetLayout . The Flex: prefix is optional. * \li Sample: flex-insert Code * \endvar */ { LFUN_FLEX_INSERT, "flex-insert", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_FLOAT_INSERT * \li Action: Inserts a float inset. * \li Syntax: float-insert * \li Params: : type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given. * \li Origin: Lgb, 27 Jun 2000 * \endvar */ { LFUN_FLOAT_INSERT, "float-insert", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_FLOAT_LIST_INSERT * \li Action: Inserts the list of floats in the document. * \li Syntax: float-list-insert * \li Params: : type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given. * \li Origin: Lgb, 3 May 2001 * \endvar */ { LFUN_FLOAT_LIST_INSERT, "float-list-insert", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_FLOAT_WIDE_INSERT * \li Action: Inserts float insets as in #LFUN_FLOAT_INSERT but span multiple columns. * \li Notion: Corresponds to the starred floats (figure*, table*, etc.) in LaTeX. * \li Syntax: float-wide-insert * \li Params: : type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given. * \li Origin: Lgb, 31 Oct 2001 * \endvar */ { LFUN_FLOAT_WIDE_INSERT, "float-wide-insert", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_FONT_BOLD * \li Action: Toggles the bold font (selection-wise) using mathbf in math. * \li Syntax: font-bold * \endvar */ { LFUN_FONT_BOLD, "font-bold", Noop, Layout }, /*! * \var lyx::FuncCode lyx::LFUN_FONT_BOLDSYMBOL * \li Action: Toggles the bold font (selection-wise) using boldsymbol in math. * \li Syntax: font-boldsymbol * \endvar */ { LFUN_FONT_BOLDSYMBOL, "font-boldsymbol", Noop, Layout }, /*! * \var lyx::FuncCode lyx::LFUN_FONT_DEFAULT * \li Action: Reverts the settings of the font to the default values (selection-wise). * \li Syntax: font-default * \endvar */ { LFUN_FONT_DEFAULT, "font-default", Noop, Layout }, /*! * \var lyx::FuncCode lyx::LFUN_FONT_EMPH * \li Action: Toggles the emphasis font style (selection-wise). * \li Syntax: font-emph * \endvar */ { LFUN_FONT_EMPH, "font-emph", Noop, Layout }, /*! * \var lyx::FuncCode lyx::LFUN_FONT_FRAK * \li Action: Toggles Fraktur family font (math-mode, selection-wise). * \li Syntax: font-frak * \li Origin: vermeer, 10 Jan 2002 * \endvar */ { LFUN_FONT_FRAK, "font-frak", Noop, Layout }, /*! * \var lyx::FuncCode lyx::LFUN_FONT_ITAL * \li Action: Toggles Italics font shape (math-mode, selection-wise). * \li Syntax: font-ital * \li Origin: vermeer, 10 Jan 2002 * \endvar */ { LFUN_FONT_ITAL, "font-ital", Noop, Layout }, /*! * \var lyx::FuncCode lyx::LFUN_FONT_NOUN * \li Action: Toggles Noun text style font (selection-wise). * \li Syntax: font-noun * \endvar */ { LFUN_FONT_NOUN, "font-noun", Noop, Layout }, /*! * \var lyx::FuncCode lyx::LFUN_FONT_ROMAN * \li Action: Toggles Roman family font (selection-wise). * \li Syntax: font-roman * \endvar */ { LFUN_FONT_ROMAN, "font-roman", Noop, Layout }, /*! * \var lyx::FuncCode lyx::LFUN_FONT_SANS * \li Action: Toggles Sans Serif family font (selection-wise). * \li Syntax: font-sans * \endvar */ { LFUN_FONT_SANS, "font-sans", Noop, Layout }, /*! * \var lyx::FuncCode lyx::LFUN_FONT_SIZE * \li Action: Sets font size according to lyx format string. * \li Syntax: font-size * \li Params: : tiny|scriptsize|footnotesize|small|normal|large|larger|\n largest|huge|giant|increase|decrease|default * \endvar */ { LFUN_FONT_SIZE, "font-size", Noop, Layout }, /*! * \var lyx::FuncCode lyx::LFUN_FONT_STATE * \li Action: Returns the info about the current font. * \li Syntax: font-state * \endvar */ { LFUN_FONT_STATE, "font-state", ReadOnly, Layout }, /*! * \var lyx::FuncCode lyx::LFUN_FONT_STRIKEOUT * \li Action: Toggles strikeout (strike-through) in the font (selection-wise). * \li Syntax: font-strikeout * \li Origin: sanda, 3 May 2009 * \endvar */ { LFUN_FONT_STRIKEOUT, "font-strikeout", Noop, Layout }, /*! * \var lyx::FuncCode lyx::LFUN_FONT_CROSSOUT * \li Action: Toggles xout (cross-through) in the font (selection-wise). * \li Syntax: font-crossout * \li Origin: uwestoehr, 4 April 2017 * \endvar */ { LFUN_FONT_CROSSOUT, "font-crossout", Noop, Layout }, /*! * \var lyx::FuncCode lyx::LFUN_FONT_TYPEWRITER * \li Action: Toggles the typewriter family font (selection-wise). * \li Syntax: font-typewriter * \endvar */ { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout }, /*! * \var lyx::FuncCode lyx::LFUN_FONT_UNDERLINE * \li Action: Toggles underline in the font (selection-wise). * \li Syntax: font-underline * \endvar */ { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout }, /*! * \var lyx::FuncCode lyx::LFUN_FONT_UNDERUNDERLINE * \li Action: Toggles double underline in the font (selection-wise). * \li Syntax: font-underunderline * \li Origin: sanda, 5 May 2009 * \endvar */ { LFUN_FONT_UNDERUNDERLINE, "font-underunderline", Noop, Layout }, /*! * \var lyx::FuncCode lyx::LFUN_FONT_UNDERWAVE * \li Action: Toggles wavy underline in the font (selection-wise). * \li Syntax: font-underwave * \li Origin: sanda, 5 May 2009 * \endvar */ { LFUN_FONT_UNDERWAVE, "font-underwave", Noop, Layout }, /*! * \var lyx::FuncCode lyx::LFUN_FOOTNOTE_INSERT * \li Action: Inserts a footnote inset. * \li Syntax: footnote-insert * \li Origin: Jug, 7 Mar 2000 * \endvar */ { LFUN_FOOTNOTE_INSERT, "footnote-insert", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_FORWARD_SEARCH * \li Action: Sets the cursor position in the previewed (dvi/pdf) file based on the row number in LyX window. * \li Notion: The external program used for forward search call can be specified in LyX Output preferences. See Additional manual for details of these settings. * \li Syntax: forward-search * \li Origin: sanda, 14 Apr 2010 * \endvar */ { LFUN_FORWARD_SEARCH, "forward-search", ReadOnly, System }, /*! * \var lyx::FuncCode lyx::LFUN_GRAPHICS_RELOAD * \li Action: Reloads the image if necessary. * \li Syntax: graphics-reload * \li Origin: vfr, 10 Aug 2009 * \endvar */ { LFUN_GRAPHICS_RELOAD, "graphics-reload", ReadOnly | AtPoint, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_HELP_OPEN * \li Action: Open the given help file according to the language setting. * \li Syntax: help-open [.lyx] * \li Params: : any document from (/usr/share/)doc directory. * \li Origin: Jug, 27 Jun 1999 * \endvar */ { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer }, /*! * \var lyx::FuncCode lyx::LFUN_HREF_INSERT * \li Action: Inserts hyperlinks into the document (clickable in pdf output). * \li Notion: Hyperlink target can be set via selection + hyperlink-insert function. * \li Syntax: href-insert [] * \li Origin: CFO-G, 21 Nov 1997 * \endvar */ { LFUN_HREF_INSERT, "href-insert", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_ICON_SIZE * \li Action: Sets icon size of toolbars. * \li Syntax: icon-size [] * \li Params: : the icon size in px or one of the logical settings small|normal|big|huge|giant, the default is normal (whose size in px is icon set dependent). * \li Origin: 11 July 2016 * \endvar */ { LFUN_ICON_SIZE, "icon-size", NoBuffer, Buffer }, /*! * \var lyx::FuncCode lyx::LFUN_INDEX_INSERT * \li Action: Inserts Index entry. * \li Notion: It automatically takes the word on the cursor position. * \li Syntax: index-insert [] * \li Params: : name of the index, if multiple indices are defined. With an empty argument, the default index is selected. * \li Origin: leeming, 3 Aug 2000 * \endvar */ { LFUN_INDEX_INSERT, "index-insert", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_INDEX_PRINT * \li Action: Inserts list of Index entries on a new page. * \li Syntax: index-print [] * \li Params: : name of the index, if multiple indices are defined. With an empty argument, the default index is selected. * \li Origin: Lgb, 27 Feb 1997 * \endvar */ { LFUN_INDEX_PRINT, "index-print", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_INFO_INSERT * \li Action: Displays shortcuts, lyxrc, package and textclass availability and menu information in a non-editable boxed InsetText. * \li Notion: Apart from lfun arguments you can use the following method: \n 1. input the type and argument of this inset, e.g. "menu paste", in the work area.\n 2. select the text and run info-insert lfun. * \li Syntax: info-insert * \li Params: : shortcut[s]|lyxrc|lyxinfo|package|textclass|menu|icon|buffer \n : argument for a given type. Look into InsetInfo.h for detailed description. \n shortcut[s]: name of lfun (e.g math-insert \alpha) \n lyxrc: name of rc_entry (e.g. bind_file) \n lyxinfo: "version" - used version of LyX \n package: name of latex package (e.g. listings) \n textclass: name of textclass (e.g. article) \n menu: name of lfun used in menu \n icon: icon of lfun used in toolbar or direct icon name\n buffer: "name"|"path"|"class"|"vcs-tree-revision"| "vcs-revision"|"vcs-author"|"vcs-date"|"vcs-time" * \li Sample: command-sequence info-insert buffer path; info-insert buffer name * \li Origin: bpeng, 7 Oct 2007 * \endvar */ { LFUN_INFO_INSERT, "info-insert", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_INSET_APPLY * \li Action: Apply data for an inset. * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should be applied. This is either changed to #LFUN_INSET_MODIFY or #LFUN_INSET_INSERT depending on the context where it is called. * \li Syntax: inset-apply * \li Params: See #LFUN_INSET_INSERT . * \endvar */ { LFUN_INSET_APPLY, "inset-apply", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN * \li Action: Move the cursor to the beginning of the current inset if it is not already there. If the cursor is already at the beginning of the current inset, move it to the beginning of the enclosing inset or the main work area, respectively, if there is no enclosing inset. * \li Syntax: inset-begin * \li Origin: lasgouttes, 16 Mar 2009 * \endvar */ { LFUN_INSET_BEGIN, "inset-begin", ReadOnly, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN_SELECT * \li Action: Move the cursor to the beginning of the current inset if it is not already there. If the cursor is already at the beginning of the current inset, move it to the beginning of the enclosing inset or the main work area, respectively, if there is no enclosing inset (adding the traversed text to the selection). * \li Syntax: inset-begin-select * \li Origin: lasgouttes, 16 Mar 2009 * \endvar */ { LFUN_INSET_BEGIN_SELECT, "inset-begin-select", ReadOnly, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_INSET_COPY_AS * \li Action: Copies the inset to the clipboard as a certain type. * \li Notion: Currently used only for InsetInfo where its content is copied as a text. * \li Syntax: inset-copy-as * \li Origin: vfr, 18 Apr 2010 * \endvar */ { LFUN_INSET_COPY_AS, "inset-copy-as", ReadOnly | NoUpdate | AtPoint, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_INSET_DIALOG_UPDATE * \li Action: Updates the values inside the dialog from the inset. * \li Notion: This is an internal LFUN, not to be used by users. Called internally by #LFUN_DIALOG_UPDATE * \li Params: * \li Origin: leeming, 25 Feb 2003 * \endvar */ { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden }, /*! * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE * \li Action: Dissolve the current inset into text. * \li Syntax: inset-dissolve [] * \li Params: : this can be used to make sure the right kind of inset is dissolved. For example "dissolve" entry in the charstyles sub-menu should only dissolve the charstyle inset, even if the cursor is inside several nested insets of different type.\n For values see #lyx::InsetLayout::lyxtype_ . * \li Origin: JSpitz, 7 Aug 2006 * \endvar */ { LFUN_INSET_DISSOLVE, "inset-dissolve", AtPoint, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_INSET_EDIT * \li Action: Edit the inset at cursor with an external application, if one is attributed. If the inset is file based, the referenced file is edited. Otherwise, the inset contents is written to a temporary file, the inset is locked, and the temporary file is edited. In this case, #LFUN_INSET_END_EDIT must be called to overtake the changes and unlock the inset after editing is finished. * \li Syntax: inset-edit [] * \li Params: : Parameters for the inset. \n Currently only the filename will be considered. * \li Origin: JSpitzm, 27 Apr 2006 * \endvar */ { LFUN_INSET_EDIT, "inset-edit", ReadOnly | AtPoint, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_INSET_END_EDIT * \li Action: End editing the inset at cursor with an external application. * This replaces the inset contents with the contents of the * temporary file, deletes the file and unlocks the inset. * \li Syntax: inset-end-edit * \li Origin: gb, 11 Oct 2015 * \endvar */ { LFUN_INSET_END_EDIT, "inset-end-edit", ReadOnly | AtPoint, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_INSET_END * \li Action: Move the cursor to the end of the current inset if it is not already there. If the cursor is already at the end of the current inset, move it to the end of the enclosing inset or the main work area, respectively, if there is no enclosing inset. * \li Syntax: inset-end * \li Origin: lasgouttes, 16 Mar 2009 * \endvar */ { LFUN_INSET_END, "inset-end", ReadOnly, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_INSET_END_SELECT * \li Action: Move the cursor to the end of the current inset if it is not already there. If the cursor is already at the end of the current inset, move it to the end of the enclosing inset or the main work area, respectively, if there is no enclosing inset (adding the traversed text to the selection). * \li Syntax: inset-end-select * \li Origin: lasgouttes, 16 Mar 2009 * \endvar */ { LFUN_INSET_END_SELECT, "inset-end-select", ReadOnly, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_INSET_FORALL * \li Action: Apply the given commands on insets of a given name. * \li Notion: WARNING: use at your own risks; this function gives you too many ways of shooting yourself in the foot. A typical example is inset-forall Note note-insert which starts an infinite loop. This is mitigated by the fact that the number of actions is arbitrarily limited to 100000. Note also that inset-forall does not update metrics between iterations, which can lead to bugs. This has to be eventually fixed. * \li Syntax: inset-forall \n : Type of Inset. If is *, all insets are matched. The name is used like for InsetLayout in layout files: "Note" matches all note insets, while "Note:Note" only matches LyX yellow note insets. * \li Sample: Remove all index insets: \n inset-forall Index char-delete-forward force \n Close all Notes (also works for a particular branch, for example): \n inset-forall Note inset-toggle close \n Transform all yellow notes to comments \n inset-forall Note:Note inset-modify note Note Comment \n Try to put LyX in an infinite loop if there is at least a Note: \n inset-forall Note char-backward * \li Origin: lasgouttes, 27 Nov 2009 * \endvar */ { LFUN_INSET_FORALL, "inset-forall", ReadOnly, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_INSET_INSERT * \li Action: Insert new inset (type given by the parameters). * \li Syntax: inset-insert * \li Params: : \n : depends on the given inset. Use "lyx -dbg action" to explore. * \li Sample: inset-insert ref LatexCommand reference "