X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FLyXAction.cpp;h=963cfd2b1adfbe45b295783694ea622a6d3fda57;hb=604a3341d9bd6b6bee6f042292f28b89027ca2b5;hp=346692765f1ab03d253bd64f4b84818d68fc7c1d;hpb=c5b06d46bf46a54706a169ac28b9c18dc3cbbf48;p=lyx.git diff --git a/src/LyXAction.cpp b/src/LyXAction.cpp index 346692765f..963cfd2b1a 100644 --- a/src/LyXAction.cpp +++ b/src/LyXAction.cpp @@ -57,6 +57,8 @@ namespace lyx { * * 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). */ /*! @@ -315,13 +317,13 @@ void LyXAction::init() */ { LFUN_WRAP_INSERT, "wrap-insert", Noop, Edit }, /*! - * \var lyx::FuncCode lyx::LFUN_OPTIONAL_INSERT - * \li Action: Inserts an optional-argument (short title) inset. - * \li Syntax: optional-insert + * \var lyx::FuncCode lyx::LFUN_ARGUMENT_INSERT + * \li Action: Inserts an argument (short title) inset. + * \li Syntax: argument-insert * \li Origin: vermeer, 12 Aug 2002 * \endvar */ - { LFUN_OPTIONAL_INSERT, "optional-insert", Noop, Edit }, + { LFUN_ARGUMENT_INSERT, "argument-insert", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_LINE_INSERT * \li Action: Inserts a horizontal line. @@ -366,6 +368,14 @@ void LyXAction::init() * \endvar */ { LFUN_LISTING_INSERT, "listing-insert", Noop, Edit }, +/*! + * \var lyx::FuncCode lyx::LFUN_PREVIEW_INSERT + * \li Action: Inserts a new preview inset. + * \li Syntax: preview-insert + * \li Origin: vfr, 28 Mar 2010 + * \endvar + */ + { LFUN_PREVIEW_INSERT, "preview-insert", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_TAB_INSERT * \li Action: Insert a tab into a listings inset. @@ -406,16 +416,18 @@ void LyXAction::init() the work area.\n 2. select the text and run info-insert lfun. * \li Syntax: info-insert - * \li Params: : shortcut[s]|lyxrc|package|textclass|menu|buffer \n + * \li Params: : shortcut[s]|lyxrc|lyxinfo|package|textclass|menu|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: name of lfun used in toolbar \n - buffer: "name"|"path"|"class" + 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 @@ -575,16 +587,6 @@ void LyXAction::init() * \endvar */ { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit }, -/*! - * \var lyx::FuncCode lyx::LFUN_NOTES_MUTATE - * \li Action: Changes all Note insets of a particular type (source) - to a different type (target) fot the current document. - * \li Syntax: notes-mutate - * \li Params: : Note|Comment|Greyedout - * \li Origin: sanda, 18 Jun 2008 - * \endvar - */ - { LFUN_NOTES_MUTATE, "notes-mutate", Argument, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_PHANTOM_INSERT * \li Action: Inserts phantom on the current cursor postion, @@ -607,6 +609,7 @@ void LyXAction::init() /*! * \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 @@ -990,6 +993,39 @@ void LyXAction::init() * \endvar */ { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit }, +/*! + * \var lyx::FuncCode lyx::LFUN_SPELLING_ADD + * \li Action: Add the word under the cursor to the respective + * spell checker dictionary. + * \li Syntax: spelling-add [] [] + * \li Params: : word to add + : language name (see file languages) + * \li Origin: JSpitzm, 18 Jan 2010 + * \endvar + */ + { LFUN_SPELLING_ADD, "spelling-add", ReadOnly, Edit }, +/*! + * \var lyx::FuncCode lyx::LFUN_SPELLING_IGNORE + * \li Action: Let the spell checker ignore the word under the cursor + * in the current session for the given language. + * \li Syntax: spelling-ignore [] [] + * \li Params: : word to ignore + : language name (see file languages) + * \li Origin: JSpitzm, 18 Jan 2010 + * \endvar + */ + { LFUN_SPELLING_IGNORE, "spelling-ignore", ReadOnly, Edit }, +/*! + * \var lyx::FuncCode lyx::LFUN_SPELLING_REMOVE + * \li Action: Remove the word under the cursor from the respective + * spell checker dictionary. + * \li Syntax: spelling-remove [] [] + * \li Params: : word to remove + : language name (see file languages) + * \li Origin: SWitt, 28 July 2010 + * \endvar + */ + { LFUN_SPELLING_REMOVE, "spelling-remove", ReadOnly, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY * \li Action: Look up thesaurus entries with respect to the word under the cursor. @@ -1083,6 +1119,17 @@ void LyXAction::init() */ { LFUN_INSET_SELECT_ALL, "inset-select-all", ReadOnly, Edit }, +/*! + * \var lyx::FuncCode lyx::LFUN_SECTION_SELECT + * \li Action: Selects the whole section. + * \li Notion: The cursor should be in a section heading + before calling this lfun. + * \li Syntax: section-select + * \li Origin: vfr, 05 May 2009 + * \endvar + */ + { LFUN_SECTION_SELECT, "section-select", ReadOnly, Edit }, + /*! * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN * \li Action: Move the cursor to the begining of the (screen) line. @@ -1175,14 +1222,14 @@ void LyXAction::init() * \li Syntax: undo * \endvar */ - { LFUN_UNDO, "undo", Noop, Edit }, + { LFUN_UNDO, "undo", ReadOnly, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_REDO * \li Action: Redoes the last thing undone. * \li Syntax: redo * \endvar */ - { LFUN_REDO, "redo", Noop, Edit }, + { LFUN_REDO, "redo", ReadOnly, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_REPEAT * \li Action: Repeat the given command. @@ -2007,25 +2054,6 @@ void LyXAction::init() * \endvar */ { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit }, - -/*! - * \var lyx::FuncCode lyx::LFUN_OUTLINE_DRAGMOVE - * \li Action: Moves the document section associated with the specified - heading to a specified location. Both the heading and the - target paragraph are specified by the paragraph ID numbers. - * \li Notion: The heading is a paragraph with style Part/Chapter/Section/ - etc. Id number of the paragraph is not the sequential number - seen on the screen, but an internal number that is unique - for all opened buffers (documents). - * \li Syntax: outline-dragmove - * \li Params: : paragraph id of the section heading which - is to be moved. \n - : the paragraph id where the section - will be moved to. - * \li Origin: Rob Oakes, 22 June 2009 - * \endvar - */ - { LFUN_OUTLINE_DRAGMOVE, "outline-dragmove", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_INSET_EDIT @@ -2037,43 +2065,20 @@ void LyXAction::init() * \li Origin: JSpitzm, 27 Apr 2006 * \endvar */ - - { LFUN_INSET_EDIT, "inset-edit", ReadOnly, Edit }, + { LFUN_INSET_EDIT, "inset-edit", ReadOnly | AtPoint, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_TABULAR_INSERT * \li Action: Inserts table into the document. + * \li Notion: See #LFUN_INSET_MODIFY for some more details + about tabular modifications. * \li Syntax: tabular-insert [ ] * \li Params: In case no arguments are given show insert dialog. * \li Origin: Jug, 12 Apr 2000 * \endvar */ { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit }, -/*! - * \var lyx::FuncCode lyx::LFUN_TABULAR_FEATURE - * \li Action: Sets various features to the table/cell on the current cursor position. - * \li Notion: Various math-environment features are handled here as well, e.g. - add-vline-left/right for the Grid/Array environment - * \li Syntax: tabular-feature [] - * \li Params: : append-row|append-column|delete-row|delete-column|copy-row|copy-column| - toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right| - align-left|align-right|align-center|align-block|valign-top|valign-bottom| - valign-middle|longtabular-align-left|longtabular-align-center| - longtabular-align-right|m-align-left|m-align-right|m-align-center| - m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|set-all-lines| - unset-all-lines|set-longtabular|unset-longtabular|set-pwidth|set-mpwidth| - set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular| - set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead| - unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot| - set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption| - set-special-column|set-special-multi|set-booktabs|unset-booktabs| - set-top-space|set-bottom-space|set-interline-space|set-border-lines| - tabular-valign-top|tabular-valign-middle|tabular-valign-bottom \n - : additional argument for some commands, use debug mode to explore its values. - * \li Origin: Jug, 28 Jul 2000 - * \endvar - */ - { LFUN_TABULAR_FEATURE, "tabular-feature", Noop, Edit }, + /*! * \var lyx::FuncCode lyx::LFUN_CELL_BACKWARD * \li Action: Moves the cursor to the previous cell inside the table. @@ -2157,7 +2162,8 @@ void LyXAction::init() R - Reload - ensure that the document is saved and reload it after command execution \n M - Message - ask for input string (commit message)\n : path where to start. $$p will be replaced by the current document path.\n - : command to execute. $$i/$$p/$$m will be replaced by the current document/path/message. + : command to execute. $$i/$$p/$$m will be replaced by the current + document(with absolute path)/path/message. * \li Sample: vc-command DR $$p "svn up" * \li Origin: sanda, 13 Jan 2009 * \endvar @@ -2182,6 +2188,27 @@ void LyXAction::init() * \endvar */ { LFUN_VC_REPO_UPDATE, "vc-repo-update", ReadOnly, System }, +/*! + * \var lyx::FuncCode lyx::LFUN_VC_COMPARE + * \li Action: Compares two revisions of the same file under version control. + * \li Notion: This is currently implemented only for SVN and RCS. + * \li Syntax: vc-compare [] + * \li Params: Revision number either points directly to commit in history + or if negative number -x it points to last commit - x.\n + In RCS we subtract only in the last number of revision specification. + Special case "0" is reserved for the last committed revision.\n + : Older file.\n + : Newer file. Used only if REV1 > 0. + * \li Sample: Compare current document against last commit\n + vc-compare 0 + * \li Sample: Compare current document against current revision - 5 commits\n + vc-compare -5 + * \li Sample: Compare revisions 120 and 155\n + vc-compare 120 155 + * \li Origin: sanda, 12 Feb 2010 + * \endvar + */ + { LFUN_VC_COMPARE, "vc-compare", ReadOnly, System }, /*! * \var lyx::FuncCode lyx::LFUN_CHANGES_TRACK @@ -2288,7 +2315,7 @@ void LyXAction::init() * \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 "