X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Flfuns.h;h=31331d1b08483b07f0a1907952991c6b110aeeb8;hb=8c73b3d2ce356e2720186f8cf5208614d124fdcf;hp=b62de88a7f3815b46f860ec94b50a648fb6da619;hpb=32035952582d37beb103c82362efa89081f16b1f;p=lyx.git diff --git a/src/lfuns.h b/src/lfuns.h index b62de88a7f..31331d1b08 100644 --- a/src/lfuns.h +++ b/src/lfuns.h @@ -7,8 +7,8 @@ * Full author contact details are available in file CREDITS. * * To add a new function: - * - add a new enum constant and doc immediately before LFUN_LASTACTION - * - add an appropriate line in LyXAction.cpp + * - add a new enum constant immediately before LFUN_LASTACTION + * - add an appropriate line and documentation in LyXAction.cpp * - add a branch to a suitable ::doDispatch() method * - add correct test to the corresponding ::getStatus() method */ @@ -29,24 +29,6 @@ namespace lyx { * BufferView::dispatch(), Cursor::dispatch() and * Inset*::doDispatch(); */ - -/* LFUN documentation (a start at least, Chr 2007-08-12) - * - * The documentation below is primarily notes about restrictions and - * oddities relating to the different LFUNs. - * - * Doxygen template below. - */ - -/** - * - * \li Action: - * \li Notion: - * \li Syntax: - * \li Params: - * \li Origin: - */ - enum kb_action { LFUN_UNKNOWN_ACTION = -1, // 0 @@ -56,13 +38,6 @@ enum kb_action { LFUN_BUFFER_NEW, LFUN_BUFFER_WRITE, // 5 -/** - * 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. - */ LFUN_BUFFER_WRITE_AS, LFUN_BUILD_PROGRAM, LFUN_BUFFER_VIEW, @@ -126,12 +101,6 @@ enum kb_action { LFUN_BUFFER_END_SELECT, LFUN_SPACE_INSERT, // JSpitzm 20030520 LFUN_SPECIALCHAR_INSERT, // JSpitzm, 20071206 -/** - * LFUN_MARK_TOGGLE - * \li Action: Toggle between MARK_ON and MARK_OFF - * \li Syntax: mark-toggle - * \li Origin: poenitz, May 5 2006 - */ LFUN_MARK_TOGGLE, LFUN_CHAR_DELETE_FORWARD, // 60 @@ -191,8 +160,8 @@ enum kb_action { // 105 LFUN_MATH_DISPLAY, // Alejandro 180696 LFUN_MATH_MODE, // Alejandro 040696 - LFUN_MATH_NUMBER, // Alejandro 040696 - LFUN_MATH_NONUMBER, // Alejandro 180696 + LFUN_MATH_NUMBER_TOGGLE, + LFUN_MATH_NUMBER_LINE_TOGGLE, LFUN_MATH_SIZE, // Alejandro 150896 // 110 LFUN_MATH_MACRO, // ale970510 @@ -204,23 +173,12 @@ enum kb_action { LFUN_WORD_DELETE_FORWARD, LFUN_WORD_DELETE_BACKWARD, LFUN_LINE_DELETE, -/** - * LFUN_MARK_OFF - * \li Action: Disable selecting of text-region. - * \li Syntax: mark-off - */ LFUN_MARK_OFF, -/** - * LFUN_MARK_ON - * \li Action: Enable selecting of text-region. - * \li Notion: After enabling you can simply move arrow keys to get selected region. - * \li Syntax: mark-on - */ LFUN_MARK_ON, // 120 LFUN_LAYOUT, LFUN_LAYOUT_PARAGRAPH, - LFUN_DROP_LAYOUTS_CHOICE, // used in bindings as of 20060905 + LFUN_DROP_LAYOUTS_CHOICE, // used in bindings as of 20071228 LFUN_FONT_TYPEWRITER, // changed from FONT_CODE 20070920 LFUN_FONT_SANS, // 125 @@ -257,7 +215,7 @@ enum kb_action { LFUN_DELETE_FORWARD_SKIP, LFUN_BUFFER_NEW_TEMPLATE, // Asger 1997-02-02 LFUN_BUFFER_RELOAD, // Asger 1997-02-02 - LFUN_RECONFIGURE, // Asger 1997-02-14 + LFUN_RECONFIGURE, LFUN_INDEX_PRINT, // Lgb 97-02-27 // 155 LFUN_CELL_SPLIT, @@ -284,7 +242,7 @@ enum kb_action { LFUN_BUFFER_IMPORT, // Asger 980724 LFUN_COMMAND_SEQUENCE, // Andre' 991111 // 175 - LFUN_PREFERENCES_SAVE, // Lgb 991127 + LFUN_PREFERENCES_SAVE, LFUN_HELP_OPEN, // Jug 990627 LFUN_DATE_INSERT, // jdblair 20000131 LFUN_LANGUAGE, // Dekel 20000203 @@ -312,9 +270,9 @@ enum kb_action { LFUN_SCREEN_FONT_UPDATE, // ARRae 20000813 LFUN_PARAGRAPH_GOTO, // Dekel 20000826 LFUN_REFERENCE_NEXT, // Dekel 20010114 - LFUN_BOOKMARK_SAVE, // Dekel 20010127 + LFUN_BOOKMARK_SAVE, // 200 - LFUN_BOOKMARK_GOTO, // Dekel 20010127 + LFUN_BOOKMARK_GOTO, LFUN_SELECT_FILE_SYNC, // Levon 20010214 LFUN_MESSAGE, // Lgb 20010408; for scripting purposes, output in minibuffer LFUN_CHARS_TRANSPOSE, // Lgb 20010425 @@ -352,15 +310,6 @@ enum kb_action { // 230 LFUN_INSET_SETTINGS, LFUN_PARAGRAPH_PARAMS_APPLY, -/** - * LFUN_PARAGRAPH_PARAMS_APPLY - * \li Action: Change paragraph settings. - * \li Notion: Overwrite all nonspecified settings to the default ones. - Use paragraph-params lfun if you don't want to overwrite others settings. - * \li Syntax: lfun-paragraph-params-apply [INDENT] [SPACING] [ALIGN] [OTHERS] - * \li Params: For parameters see lfun-paragraph-params lfun. - * \li Origin: leeming, 30 Mar 2004 - */ LFUN_PARAGRAPH_UPDATE, LFUN_EXTERNAL_EDIT, LFUN_BRANCH_INSERT, @@ -393,19 +342,19 @@ enum kb_action { LFUN_INSET_REFRESH, LFUN_BUFFER_NEXT, LFUN_BUFFER_PREVIOUS, - LFUN_WORDS_COUNT, + LFUN_STATISTICS, // 260 LFUN_CHANGES_OUTPUT, // jspitzm 20050121 LFUN_BIBTEX_DATABASE_ADD, LFUN_BIBTEX_DATABASE_DEL, LFUN_CITATION_INSERT, - LFUN_OUTLINE_UP, // Vermeer 20060323 + LFUN_OUTLINE_UP, // 265 LFUN_OUTLINE_DOWN, LFUN_OUTLINE_IN, LFUN_OUTLINE_OUT, - LFUN_PARAGRAPH_MOVE_DOWN, // Edwin 20060408 - LFUN_PARAGRAPH_MOVE_UP, // Edwin 20060408 + LFUN_PARAGRAPH_MOVE_DOWN, + LFUN_PARAGRAPH_MOVE_UP, // 270 LFUN_BUFFER_TOGGLE_COMPRESSION, // bpeng 20060427 LFUN_MATH_BIGDELIM, @@ -427,21 +376,9 @@ enum kb_action { // 285 LFUN_BUFFER_WRITE_ALL, // rgh, gpothier 200707XX LFUN_PARAGRAPH_PARAMS, -/** - * LFUN_PARAGRAPH_PARAMS - * \li Action: Change paragraph settings - * \li Notion: Modifies the current paragraph, or currently selected paragraphs. - This function only modifies, and does not override, existing settings. - * \li Syntax: lfun_paragraph-params [INDENT] [SPACING] [ALIGN] [OTHERS] - * \li Params: INDENT: \\noindent|\\indent|\\indent-toggle|\\leftindent LENGTH\n - SPACING: \\paragraph_spacing default|single|onehalf|double|other\n - ALIGN: \\align block|left|right|center|default\n - OTHERS: \\labelwidthstring WIDTH|\\start_of_appendix\n - * \li Origin: rgh, Aug 15 2007 - */ - LFUN_LAYOUT_MODULES_CLEAR, // rgh, 20070825 - LFUN_LAYOUT_MODULE_ADD, // rgh, 20070825 - LFUN_LAYOUT_RELOAD, // rgh, 20070903 + LFUN_LAYOUT_MODULES_CLEAR, + LFUN_LAYOUT_MODULE_ADD, + LFUN_LAYOUT_RELOAD, // 290 LFUN_MASTER_BUFFER_VIEW, // Tommaso, 20070920 LFUN_MASTER_BUFFER_UPDATE, // Tommaso, 20070920 @@ -472,9 +409,11 @@ enum kb_action { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, - // 315 LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, + LFUN_IN_MATHMACROTEMPLATE, + LFUN_SCROLL, + LFUN_UI_TOGGLE, LFUN_LASTACTION // end of the table };