X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FLyXAction.cpp;h=a9307c3bc63181ba55bf09a4064d2a64da9b9952;hb=b9116e8b81f55ee795ea444ee02ff921bf82606a;hp=56b810306ee631eebb7129407ca6ed3dc728f01a;hpb=75bfed55079cab6b73fbea6ce4ae3f10d1af3b91;p=lyx.git diff --git a/src/LyXAction.cpp b/src/LyXAction.cpp index 56b810306e..a9307c3bc6 100644 --- a/src/LyXAction.cpp +++ b/src/LyXAction.cpp @@ -892,7 +892,8 @@ void LyXAction::init() * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM * \li Action: Sets the zoom of the screen fonts. * \li Syntax: buffer-zoom [] -* \li Params: : The zoom in % points (neg. or pos.), the default is to reset to zoom savd in preferences. +* \li Params: : The target zoom value in %; +* the default is the default zoom as saved in preferences. * \li Origin: daniel, 28 Oct 2016 * \endvar */ @@ -902,7 +903,8 @@ void LyXAction::init() * \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 in % points (neg. or pos.), the default is 20. + * \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 */ @@ -913,7 +915,8 @@ void LyXAction::init() * \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 in % points (neg. or pos.), the default is -20. + * \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 */ @@ -1395,6 +1398,19 @@ void LyXAction::init() { 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. @@ -1497,9 +1513,13 @@ void LyXAction::init() /*! * \var lyx::FuncCode lyx::LFUN_ENVIRONMENT_SPLIT * \li Action: Splits the current environment with a Separator. - * \li Syntax: environment-split [outer] + * \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. + 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 */ @@ -1897,7 +1917,7 @@ 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|lyxinfo|package|textclass|menu|buffer \n + * \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 @@ -1930,8 +1950,10 @@ void LyXAction::init() /*! * \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, or at the beginning of the - enclosing inset otherwise + 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 @@ -1941,8 +1963,10 @@ void LyXAction::init() /*! * \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, or at the beginning of the - enclosing inset otherwise (adding the + 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 @@ -1990,6 +2014,11 @@ void LyXAction::init() * \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. @@ -1999,11 +2028,24 @@ void LyXAction::init() { 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, or at the end of the - enclosing inset otherwise + * \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 @@ -2012,9 +2054,11 @@ void LyXAction::init() /*! * \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, or at the end of the - enclosing inset otherwise (adding the + * \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 @@ -2284,8 +2328,9 @@ void LyXAction::init() /*! * \var lyx::FuncCode lyx::LFUN_LAYOUT * \li Action: Sets the layout (that is, environment) for the current paragraph. - * \li Syntax: layout - * \li Params: : the layout to use + * \li Syntax: layout [ignorenests] + * \li Params: : the layout to use\n + ignorenests: If specified, nesting advices will be ignored. * \endvar */ { LFUN_LAYOUT, "layout", Noop, Layout }, @@ -2464,6 +2509,25 @@ void LyXAction::init() { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit }, +/*! + * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_EXPORT + * \li Action: Exports the master buffer (document) to the given format. + * \li Syntax: master-buffer-export [] [] + * \li Params: is 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 + Note that "custom" is not allowed in this case.\n + If absent or "default", then the default output format of the + document is used.\n + 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: rkh, 18 April 2018 + * \endvar + */ + { LFUN_MASTER_BUFFER_EXPORT, "master-buffer-export", ReadOnly, Buffer }, + /*! * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE * \li Action: Update (export) the document built from the master buffer, @@ -3032,10 +3096,11 @@ void LyXAction::init() * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_BREAK * \li Action: Breaks the current paragraph at the current location. * \li Notion: Removes the selection. - * \li Syntax: paragraph-break [] + * \li Syntax: paragraph-break [] [ignoresep] * \li Params: : "inverse" - decreases depth by one (or change layout to default layout) when the cursor is at the end of - the line. + the line.\n + ignoresep: Do not account for paragraph separators while breaking. * \endvar */ { LFUN_PARAGRAPH_BREAK, "paragraph-break", Noop, Edit }, @@ -3523,6 +3588,17 @@ void LyXAction::init() */ { LFUN_SET_GRAPHICS_GROUP, "set-graphics-group", Noop, Edit }, +/*! + * \var lyx::FuncCode lyx::LFUN_GRAPHICS_UNIFY + * \li Action: Set the same group for all graphics insets in the marked block. + * \li Syntax: graphics-unify [] + * \li Params: : Id for an existing group. In case the Id is an empty string, + the group Id from the first graphics inset will be used. + * \li Origin: sanda, 7 Feb 2018 + * \endvar + */ + { LFUN_GRAPHICS_UNIFY, "graphics-unify", Noop, Edit }, + /*! * \var lyx::FuncCode lyx::LFUN_SPACE_INSERT @@ -3800,10 +3876,10 @@ void LyXAction::init() /*! * \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 + * \li Syntax: unicode-insert ... + * \li Params: : The character to insert, given as its code point, in hexadecimal. - * \li Sample: unicode-insert 0x0100 + * \li Sample: unicode-insert 0x0100 0x0259 * \li Origin: Lgb, 22 Oct 2006 * \endvar */ @@ -4187,6 +4263,16 @@ void LyXAction::init() */ { LFUN_WORD_REPLACE, "word-replace", Noop, Edit }, +/*! + * \var lyx::FuncCode lyx::LFUN_BUFFER_ANONYMIZE + * \li Action: For debug purposes only. Convert all [a-zA-Z0-1] characters to + single character. Useful when submitting docs to list or bugzilla. + * \li Syntax: buffer-anonymize + * \li Origin: sanda, Feb 1 2018 + * \endvar + */ + { LFUN_BUFFER_ANONYMIZE, "buffer-anonymize", Noop, Edit }, + /*! * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT * \li Action: Moves the cursor to the next beginning of a word "on the right".