X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FLyXAction.cpp;h=55c90ca1b36041d3b7afc5ad5e8aab9c8b7b6b16;hb=3ca2b42389e50fb341918e4c25715cc0f8726c5e;hp=63b4a69beee77b1c91d43f961456cf88076e810a;hpb=1ed70d10fdfa64186c1b640bc83158d94fd1f2f3;p=lyx.git diff --git a/src/LyXAction.cpp b/src/LyXAction.cpp index 63b4a69bee..55c90ca1b3 100644 --- a/src/LyXAction.cpp +++ b/src/LyXAction.cpp @@ -49,11 +49,13 @@ namespace lyx { /* LFUN documentation * - * The documentation below is primarily description of purpose and syntax - * relating to the different LFUNs. + * The documentation below primarily describes the purpose and syntax + * of the various LFUNs. * - * Try to find an appropriate (thematical) place when adding the new LFUN - * and don't forget to add doxygen commentary. + * 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. @@ -111,6 +113,7 @@ void LyXAction::init() ev_item const items[] = { #endif + /*! * \var lyx::FuncCode lyx::LFUN_ACCENT_ACUTE * \li Action: Adds an acute accent \htmlonly (á)\endhtmlonly @@ -119,6 +122,7 @@ void LyXAction::init() * \endvar */ { LFUN_ACCENT_ACUTE, "accent-acute", Noop, Edit }, + /*! * \var lyx::FuncCode lyx::LFUN_ACCENT_BREVE * \li Action: Adds a breve accent \htmlonly (ă)\endhtmlonly @@ -127,6 +131,7 @@ void LyXAction::init() * \endvar */ { LFUN_ACCENT_BREVE, "accent-breve", Noop, Edit }, + /*! * \var lyx::FuncCode lyx::LFUN_ACCENT_CARON * \li Action: Adds a caron \htmlonly (ǎ)\endhtmlonly @@ -135,6 +140,7 @@ void LyXAction::init() * \endvar */ { LFUN_ACCENT_CARON, "accent-caron", Noop, Edit }, + /*! * \var lyx::FuncCode lyx::LFUN_ACCENT_CEDILLA * \li Action: Adds a cedilla \htmlonly (ç)\endhtmlonly @@ -143,6 +149,7 @@ void LyXAction::init() * \endvar */ { LFUN_ACCENT_CEDILLA, "accent-cedilla", Noop, Edit }, + /*! * \var lyx::FuncCode lyx::LFUN_ACCENT_CIRCLE * \li Action: Adds a circle accent \htmlonly (å)\endhtmlonly @@ -151,6 +158,7 @@ void LyXAction::init() * \endvar */ { LFUN_ACCENT_CIRCLE, "accent-circle", Noop, Edit }, + /*! * \var lyx::FuncCode lyx::LFUN_ACCENT_CIRCUMFLEX * \li Action: Adds a circumflex \htmlonly (ê)\endhtmlonly @@ -159,6 +167,7 @@ void LyXAction::init() * \endvar */ { LFUN_ACCENT_CIRCUMFLEX, "accent-circumflex", Noop, Edit }, + /*! * \var lyx::FuncCode lyx::LFUN_ACCENT_DOT * \li Action: Adds a dot accent \htmlonly (ż)\endhtmlonly @@ -167,6 +176,7 @@ void LyXAction::init() * \endvar */ { LFUN_ACCENT_DOT, "accent-dot", Noop, Edit }, + /*! * \var lyx::FuncCode lyx::LFUN_ACCENT_GRAVE * \li Action: Adds a grave accent \htmlonly (è)\endhtmlonly @@ -175,6 +185,7 @@ void LyXAction::init() * \endvar */ { LFUN_ACCENT_GRAVE, "accent-grave", Noop, Edit }, + /*! * \var lyx::FuncCode lyx::LFUN_ACCENT_HUNGARIAN_UMLAUT * \li Action: Adds a Hungarian umlaut \htmlonly (ő)\endhtmlonly @@ -183,6 +194,7 @@ void LyXAction::init() * \endvar */ { LFUN_ACCENT_HUNGARIAN_UMLAUT, "accent-hungarian-umlaut", Noop, Edit }, + /*! * \var lyx::FuncCode lyx::LFUN_ACCENT_MACRON * \li Action: Adds a macron \htmlonly (ā)\endhtmlonly @@ -191,6 +203,7 @@ void LyXAction::init() * \endvar */ { LFUN_ACCENT_MACRON, "accent-macron", Noop, Edit }, + /*! * \var lyx::FuncCode lyx::LFUN_ACCENT_OGONEK * \li Action: Adds an ogonek accent \htmlonly (ą)\endhtmlonly @@ -199,6 +212,7 @@ void LyXAction::init() * \endvar */ { LFUN_ACCENT_OGONEK, "accent-ogonek", Noop, Edit }, + /*! * \var lyx::FuncCode lyx::LFUN_ACCENT_PERISPOMENI * \li Action: Adds a perispomeni (Greek circumflex) @@ -207,6 +221,7 @@ void LyXAction::init() * \endvar */ { LFUN_ACCENT_PERISPOMENI, "accent-perispomeni", Noop, Edit }, + /*! * \var lyx::FuncCode lyx::LFUN_ACCENT_TIE * \li Action: Adds a tie \htmlonly (a͡)\endhtmlonly @@ -216,6 +231,7 @@ void LyXAction::init() * \endvar */ { LFUN_ACCENT_TIE, "accent-tie", Noop, Edit }, + /*! * \var lyx::FuncCode lyx::LFUN_ACCENT_TILDE * \li Action: Adds a tilde \htmlonly (ã)\endhtmlonly @@ -224,6 +240,7 @@ void LyXAction::init() * \endvar */ { LFUN_ACCENT_TILDE, "accent-tilde", Noop, Edit }, + /*! * \var lyx::FuncCode lyx::LFUN_ACCENT_UMLAUT * \li Action: Adds an umlaut \htmlonly (ä)\endhtmlonly @@ -232,6 +249,7 @@ void LyXAction::init() * \endvar */ { LFUN_ACCENT_UMLAUT, "accent-umlaut", Noop, Edit }, + /*! * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERBAR * \li Action: Adds a bar \htmlonly (a̠)\endhtmlonly @@ -240,6 +258,7 @@ void LyXAction::init() * \endvar */ { LFUN_ACCENT_UNDERBAR, "accent-underbar", Noop, Edit }, + /*! * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERDOT * \li Action: Adds a dot \htmlonly (ạ)\endhtmlonly @@ -249,541 +268,884 @@ void LyXAction::init() */ { LFUN_ACCENT_UNDERDOT, "accent-underdot", Noop, Edit }, + /*! - * \var lyx::FuncCode lyx::LFUN_CAPTION_INSERT - * \li Action: Inserts a caption inset. - * \li Syntax: caption-insert - * \li Origin: Lgb, 18 Jul 2000 + * \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_CAPTION_INSERT, "caption-insert", Noop, Edit }, + { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", 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 + * \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_DATE_INSERT, "date-insert", Noop, Edit }, + { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit }, + + /*! - * \var lyx::FuncCode lyx::LFUN_FOOTNOTE_INSERT - * \li Action: Inserts a footnote inset. - * \li Syntax: footnote-insert - * \li Origin: Jug, 7 Mar 2000 + * \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_FOOTNOTE_INSERT, "footnote-insert", Noop, Edit }, + { LFUN_APPENDIX, "appendix", Noop, Edit }, + + /*! - * \var lyx::FuncCode lyx::LFUN_ERT_INSERT - * \li Action: Inserts an ERT inset. - * \li Syntax: ert-insert - * \li Origin: Jug, 18 Feb 2000 + * \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_ERT_INSERT, "ert-insert", Noop, Edit }, + { LFUN_ARGUMENT_INSERT, "argument-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 + * \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_FLOAT_INSERT, "float-insert", Noop, Edit }, + { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", 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 + * \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_FLOAT_WIDE_INSERT, "float-wide-insert", Noop, Edit }, + { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", 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 + * \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_FLOAT_LIST_INSERT, "float-list-insert", Noop, Edit }, + { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit }, + + /*! - * \var lyx::FuncCode lyx::LFUN_WRAP_INSERT - * \li Action: Inserts floats wrapped by the text around. - * \li Syntax: wrap-insert - * \li Params: : table|figure - * \li Origin: Dekel, 7 Apr 2002 + * \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_WRAP_INSERT, "wrap-insert", Noop, Edit }, + { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, 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 + * \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_ARGUMENT_INSERT, "argument-insert", Noop, Edit }, + { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit }, + /*! - * \var lyx::FuncCode lyx::LFUN_NEWPAGE_INSERT - * \li Action: Inserts a new page. - * \li Syntax: newpage-insert - * \li Params: : default: newpage - * \li Origin: uwestoehr, 24 Nov 2007 + * \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_NEWPAGE_INSERT, "newpage-insert", Noop, Edit }, + { LFUN_BOX_INSERT, "box-insert", Noop, Edit }, + /*! - * \var lyx::FuncCode lyx::LFUN_MARGINALNOTE_INSERT - * \li Action: Inserts a marginal note. - * \li Syntax: marginalnote-insert - * \li Origin: Lgb, 26 Jun 2000 + * \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_MARGINALNOTE_INSERT, "marginalnote-insert", Noop, Edit }, + { LFUN_BRANCHES_RENAME, "branches-rename", Noop, Buffer }, + /*! - * \var lyx::FuncCode lyx::LFUN_UNICODE_INSERT - * \li Action: Inserts a single unicode character. - * \li Syntax: unicode-insert - * \li Params: : The character to insert, given as its code - point, in hexadecimal. - * \li Sample: unicode-insert 0x0100 - * \li Origin: Lgb, 22 Oct 2006 + * \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_UNICODE_INSERT, "unicode-insert", Noop, Edit }, + { LFUN_BRANCH_ACTIVATE, "branch-activate", AtPoint, Buffer }, + /*! - * \var lyx::FuncCode lyx::LFUN_LISTING_INSERT - * \li Action: Inserts a new listings inset. - * \li Syntax: listing-insert - * \li Origin: Herbert, 10 Nov 2001; bpeng, 2 May 2007 + * \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_LISTING_INSERT, "listing-insert", Noop, Edit }, + { LFUN_BRANCH_ADD, "branch-add", AtPoint, Buffer }, + + + /*! - * \var lyx::FuncCode lyx::LFUN_PREVIEW_INSERT - * \li Action: Inserts a new preview inset. - * \li Syntax: preview-insert - * \li Origin: vfr, 28 Mar 2010 + * \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_PREVIEW_INSERT, "preview-insert", Noop, Edit }, + { LFUN_BRANCH_ADD_INSERT, "branch-add-insert", Noop, Buffer }, + + + /*! - * \var lyx::FuncCode lyx::LFUN_TAB_INSERT - * \li Action: Insert a tab into a listings inset. - * \li Notion: It also works on a selection. - * \li Syntax: tab-insert - * \li Origin: vfr, Sep 30 2008 + * \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_TAB_INSERT, "tab-insert", SingleParUpdate, Edit }, + { LFUN_BRANCH_DEACTIVATE, "branch-deactivate", AtPoint, Buffer }, + /*! - * \var lyx::FuncCode lyx::LFUN_TAB_DELETE - * \li Action: Delete a tab or up to an equivalent amount of spaces from - a listings inset. - * \li Notion: It also works on a selection - it removes a tab or spaces from the - beginning of each line spanned by the selection. This is useful if - you want to indent/unindent multiple lines in one action. - * \li Syntax: tab-delete - * \li Origin: vfr, Sep 30 2008 + * \var lyx::FuncCode lyx::LFUN_BRANCH_INSERT + * \li Action: Inserts branch inset. + * \li Syntax: branch-insert + * \li Origin: vermeer, 17 Aug 2003 * \endvar */ - { LFUN_TAB_DELETE, "tab-delete", SingleParUpdate, Edit }, + { LFUN_BRANCH_INSERT, "branch-insert", Noop, Edit }, + /*! - * \var lyx::FuncCode lyx::LFUN_QUOTE_INSERT - * \li Action: Inserts quotes according to the type and quote-language preference. - * \li Notion: Currently English, Swedish, German, Polish, French, Danish quotes - are distinguished. - * \li Syntax: quote-insert [] [] [