X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FLyXAction.cpp;h=cc782d6e6de2cdb79d7142564a284e81059f2d35;hb=c6e1db7682dc8d58a68147b5eee1d004829ef6d2;hp=01c5556fcbec776e2fae670937a9311e3bba56fe;hpb=cb93f034d44a418bf638632f0997198126e5b271;p=lyx.git diff --git a/src/LyXAction.cpp b/src/LyXAction.cpp index 01c5556fcb..cc782d6e6d 100644 --- a/src/LyXAction.cpp +++ b/src/LyXAction.cpp @@ -486,14 +486,14 @@ void LyXAction::init() */ { LFUN_SPACE_INSERT, "space-insert", Noop, Edit }, /*! - * \var lyx::FuncCode lyx::LFUN_HYPERLINK_INSERT + * \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_HYPERLINK_INSERT, "href-insert", Noop, Edit }, + { LFUN_HREF_INSERT, "href-insert", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_SPECIALCHAR_INSERT * \li Action: Inserts various characters into the document. @@ -625,6 +625,15 @@ void LyXAction::init() * \endvar */ { LFUN_NEWLINE_INSERT, "newline-insert", Noop, Edit }, +/*! + * \var lyx::FuncCode lyx::LFUN_SEPARATOR_INSERT + * \li Action: Inserts an environment separator or paragraph break. + * \li Syntax: separator-insert [] + * \li Params: : default: plain + * \li Origin: ef, 2 May 2014 + * \endvar + */ + { LFUN_SEPARATOR_INSERT, "separator-insert", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_ESCAPE * \li Action: Clears the selection. If no text is selected call #LFUN_FINISHED_FORWARD. @@ -1190,13 +1199,13 @@ void LyXAction::init() */ { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit }, /*! - * \var lyx::FuncCode lyx::LFUN_LINE_DELETE + * \var lyx::FuncCode lyx::LFUN_LINE_DELETE_FORWARD * \li Action: Deletes the letters to the end of the (screen) line or deletes the selection. * \li Syntax: line-delete-forward * \endvar */ - { LFUN_LINE_DELETE, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward + { LFUN_LINE_DELETE_FORWARD, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward /*! * \var lyx::FuncCode lyx::LFUN_COPY * \li Action: Copies the current selection to the clipboard. @@ -1215,14 +1224,21 @@ void LyXAction::init() * \var lyx::FuncCode lyx::LFUN_PASTE * \li Action: Pastes material (text or picture) from the active clipboard. * \li Syntax: paste [|] - * \li Params: : emf|pdf|png|jpeg|linkback|wmf \n + * \li Params: : emf|pdf|png|jpeg|linkback|wmf|latex|html \n : number of the selection in the internal clipboard stack to be pasted. * \endvar */ { LFUN_PASTE, "paste", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE - * \li Action: Pastes text from the active clipboard. + * \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 @@ -1250,7 +1266,11 @@ void LyXAction::init() { LFUN_SELECTION_PASTE, "selection-paste", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE_SIMPLE - * \li Action: Pastes simple unformatted text from the active clipboard. + * \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 @@ -1334,21 +1354,21 @@ void LyXAction::init() */ { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout }, /*! - * \var lyx::FuncCode lyx::LFUN_FONT_UULINE + * \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_UULINE, "font-underunderline", Noop, Layout }, + { LFUN_FONT_UNDERUNDERLINE, "font-underunderline", Noop, Layout }, /*! - * \var lyx::FuncCode lyx::LFUN_FONT_UWAVE + * \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_UWAVE, "font-underwave", Noop, Layout }, + { LFUN_FONT_UNDERWAVE, "font-underwave", Noop, Layout }, /*! * \var lyx::FuncCode lyx::LFUN_FONT_STRIKEOUT * \li Action: Toggles strikeout (strike-through) in the font (selection-wise). @@ -1721,10 +1741,12 @@ void LyXAction::init() { LFUN_MATH_MATRIX, "math-matrix", Noop, Math }, /*! * \var lyx::FuncCode lyx::LFUN_MATH_AMS_MATRIX - * \li Action: Inserts a matrix. + * \li Action: Inserts an extended matrix as provided by the amsmath package. * \li Syntax: math-matrix [] * \li Params: : Decoration determines the LaTeX name of the matrix - that should be created. + that should be created. Possible values include + pmatrix, bmatrix, Bmatrix, vmatrix, Vmatrix and + matrix. The default is 'matrix'. * \li Sample: math-ams-matrix 3 3 bmatrix * \endvar */ @@ -2287,7 +2309,7 @@ void LyXAction::init() { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_CHANGES_OUTPUT - * \li Action: Toggles showing of change tracking in typesetted output. + * \li Action: Toggles showing of change tracking in typeset output. * \li Syntax: changes-output * \li Origin: jspitzm, 21 Jan 2005 * \endvar @@ -3075,8 +3097,15 @@ void LyXAction::init() { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer }, /*! * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_AS - * \li Action: Pops up a dialog for exporting the current buffer. - * \li Syntax: 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 */ @@ -3252,8 +3281,8 @@ void LyXAction::init() { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer }, /*! * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE - * \li Action: When run from a child document, this updates (exports) document built - from the master buffer, if available. + * \li Action: Update (export) the document built from the master buffer, + if the current buffer is part of a master/child document. * \li Syntax: master-buffer-update [] * \li Params: : The format to display, where this is one of the formats defined (in the current GUI) in the @@ -3266,8 +3295,8 @@ void LyXAction::init() { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer }, /*! * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW - * \li Action: When run from a child document, this command shows a preview built - from the master buffer, if available. + * \li Action: Show a preview built from the master buffer, if available. + if the current buffer is part of a master/child document. * \li Syntax: master-buffer-view [] * \li Params: : The format to display, where this is one of the formats defined (in the current GUI) in the @@ -3365,7 +3394,7 @@ void LyXAction::init() /*! * \var lyx::FuncCode lyx::LFUN_META_PREFIX * \li Action: Simulate halting Meta key (Alt key on PCs). - * \li Notion: Used for buffer editation not for GUI control. + * \li Notion: Used for buffer edition not for GUI control. * \li Syntax: meta-prefix * \endvar */ @@ -3513,13 +3542,13 @@ void LyXAction::init() */ { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit }, /*! - * \var lyx::FuncCode lyx::LFUN_COMPLETION_COMPLETE + * \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_COMPLETION_COMPLETE, "complete", SingleParUpdate, Edit }, + { LFUN_COMPLETE, "complete", SingleParUpdate, Edit }, /*! * \var lyx::FuncCode lyx::LFUN_COMPLETION_CANCEL @@ -3623,17 +3652,17 @@ void LyXAction::init() * \li Origin: sts, 16 Nov 2008 * \endvar */ - { LFUN_LABEL_COPY_AS_REF, "copy-label-as-reference", + { LFUN_LABEL_COPY_AS_REFERENCE, "label-copy-as-reference", ReadOnly | NoUpdate | AtPoint, Edit }, /*! - * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT_AS_REF + * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT_AS_REFERENCE * \li Action: Inserts the label (in ToC pane) as a cross-reference at the position of the cursor. * \li Syntax: label-insert-as-reference * \li Origin: vfr, 7 Apr 2009 * \endvar */ - { LFUN_LABEL_INSERT_AS_REF, "label-insert-as-reference", Noop, Edit}, + { LFUN_LABEL_INSERT_AS_REFERENCE, "label-insert-as-reference", Noop, Edit}, /*! * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_IN @@ -3668,7 +3697,9 @@ void LyXAction::init() /*! * \var lyx::FuncCode lyx::LFUN_ENVIRONMENT_SPLIT * \li Action: Splits the current environment with a Separator. - * \li Syntax: environment-split + * \li Syntax: environment-split [outer] + * \li Params: outer: If this is given, LyX will split the outermost environment in + * the current nesting hierarchy. * \li Origin: spitz, 23 Dec 2012 * \endvar */ @@ -3730,7 +3761,7 @@ bool LyXAction::funcHasFlag(FuncCode action, if (ici == lyx_info_map.end()) { LYXERR0("action: " << action << " is not known."); - LASSERT(false, /**/); + LASSERT(false, return false); } return ici->second.attrib & flag;