]> git.lyx.org Git - lyx.git/blobdiff - src/lfuns.h
Embedding: saving inzip name to .lyx file so that embedded files can always be found...
[lyx.git] / src / lfuns.h
index adef48e5ebc24c013b5c3e896b4a6dee2b328775..45ba19b174a38bb9a5a3cfd0fcba1c82f169e170 100644 (file)
@@ -315,7 +315,7 @@ enum kb_action {
        // 120
  /**
  * LFUN_LAYOUT
- * \li Action: Sets the layout for the current paragraph
+ * \li Action: Sets the layout (that is, environment) for the current paragraph
  * \li Syntax: layout <LAYOUT>
  * \li Params: <LAYOUT>: the layout to use
  */
@@ -370,7 +370,13 @@ 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
+ * \li Action: Reconfigure the automatic settings.
+ * \li Syntax: reconfigure
+ * \li Origin: Asger, 14 Feb 1997
+ */
+       LFUN_RECONFIGURE,
        LFUN_INDEX_PRINT,               // Lgb 97-02-27
        // 155
        LFUN_CELL_SPLIT,
@@ -397,7 +403,13 @@ enum kb_action {
        LFUN_BUFFER_IMPORT,             // Asger 980724
        LFUN_COMMAND_SEQUENCE,          // Andre' 991111
        // 175
-       LFUN_PREFERENCES_SAVE,          // Lgb 991127
+/**
+ * LFUN_PREFERENCES_SAVE
+ * \li Action: Save user preferences.
+ * \li Syntax: preferences-save
+ * \li Origin: Lgb, 27 Nov 1999
+ */
+       LFUN_PREFERENCES_SAVE,
        LFUN_HELP_OPEN,                 // Jug 990627
        LFUN_DATE_INSERT,               // jdblair 20000131
        LFUN_LANGUAGE,                  // Dekel 20000203
@@ -540,19 +552,74 @@ enum kb_action {
        LFUN_INSET_REFRESH,
        LFUN_BUFFER_NEXT,
        LFUN_BUFFER_PREVIOUS,
-       LFUN_WORDS_COUNT,
+/**
+ * LFUN_STATISTICS
+ * \li Action: Count the statistics (number of words and characters)
+               in the document or in the given selection.
+ * \li Notion: Note that this function gives the number of words/chars written,
+               not the number of characters which will be typeset.
+ * \li Syntax: statistics
+ * \li Origin: lasgouttes, Jan 27 2004; ps, Jan 8 2008
+ */
+       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
+ * \li Action: Move the current group in the upward direction in the
+               structure of the document.
+ * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
+               the whole substructure of the group.
+ * \li Syntax: outline-up
+ * \li Origin: Vermeer, 23 Mar 2006
+ */
+       LFUN_OUTLINE_UP,
        // 265
+/**
+ * LFUN_OUTLINE_DOWN
+ * \li Action: Move the current group in the downward direction in the
+               structure of the document.
+ * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
+               the whole substructure of the group.
+ * \li Syntax: outline-down
+ * \li Origin: Vermeer, 23 Mar 2006
+ */
        LFUN_OUTLINE_DOWN,
+/**
+ * LFUN_OUTLINE_IN
+ * \li Action: Moves the current group in the downward direction in the
+               hierarchy of the document structure.
+ * \li Notion: Part -> Chapter -> Section -> etc.
+ * \li Syntax: outline-in
+ * \li Origin: Vermeer, 23 Mar 2006
+ */
        LFUN_OUTLINE_IN,
+/**
+ * LFUN_OUTLINE_OUT
+ * \li Action: Moves the current group in the upward direction in the
+               hierarchy of the document structure.
+ * \li Notion: Part <- Chapter <- Section <- etc.
+ * \li Syntax: outline-out
+ * \li Origin: Vermeer, 23 Mar 2006
+ */
        LFUN_OUTLINE_OUT,
-       LFUN_PARAGRAPH_MOVE_DOWN,        // Edwin 20060408
-       LFUN_PARAGRAPH_MOVE_UP,          // Edwin 20060408
+/**
+ * LFUN_PARAGRAPH_MOVE_DOWN
+ * \li Action: Moves the current paragraph downwards in the document.
+ * \li Syntax: paragraph-move-down
+ * \li Origin: Edwin, 8 Apr 2006
+ */
+       LFUN_PARAGRAPH_MOVE_DOWN,
+/**
+ * LFUN_PARAGRAPH_MOVE_UP
+ * \li Action: Moves the current paragraph upwards in the document.
+ * \li Syntax: paragraph-move-up
+ * \li Origin: Edwin, 8 Apr 2006
+ */
+       LFUN_PARAGRAPH_MOVE_UP,
        // 270
        LFUN_BUFFER_TOGGLE_COMPRESSION,  // bpeng 20060427
        LFUN_MATH_BIGDELIM,
@@ -568,7 +635,7 @@ enum kb_action {
  * \li Action: Clears the list of saved bookmarks
  * \li Syntax: bookmark-clear
  * \li Origin: bpeng, 31 October 2006
      */
+ */
        LFUN_BOOKMARK_CLEAR,             // bpeng 20061031
        LFUN_NOMENCL_INSERT,             // Ugras
        // 280
@@ -640,20 +707,127 @@ enum kb_action {
        LFUN_WORD_RIGHT,                 // dov, 20071028
        LFUN_WORD_RIGHT_SELECT,          // dov, 20071028
        // 305
+/**
+ * LFUN_MATH_MACRO_FOLD
+ * \li Action: Fold a Math Macro
+ * \li Notion: Fold the Math Macro the cursor is in if it was 
+               unfolded, i.e. displayed as \foo before. 
+ * \li Syntax: math-macro-fold
+ * \li Origin: sts, 06 January 2008
+ */
        LFUN_MATH_MACRO_FOLD,
+/**
+ * LFUN_MATH_MACRO_UNFOLD
+ * \li Action: Unfold a Math Macro
+ * \li Notion: Unfold the Math Macro the cursor is in, i.e. 
+               display it as \foo. 
+ * \li Syntax: math-macro-unfold
+ * \li Origin: sts, 06 January 2008
+ */
        LFUN_MATH_MACRO_UNFOLD,
+/**
+ * LFUN_MATH_MACRO_ADD_PARAM
+ * \li Action: Add a parameter
+ * \li Notion: Add a parameter to a Math Macro
+ * \li Params: <NUM>: The number of the parameter behind which the new one
+               will be added (1 for the first, i.e. use 0 for add a 
+               parameter at the left), defaults to the last one.
+ * \li Syntax: math-macro-add-param <NUM>
+ * \li Origin: sts, 06 January 2008
+ */    
        LFUN_MATH_MACRO_ADD_PARAM,
+/**
+ * LFUN_MATH_MACRO_REMOVE_PARAM
+ * \li Action: Remove the last parameter
+ * \li Notion: Remove the last parameter of a Math Macro and
+               remove its value in all instances of the macro 
+               in the buffer.
+ * \li Params: <NUM>: The number of the parameter to be deleted (1 for 
+               the first), defaults to the last one.
+ * \li Syntax: math-macro-remove-param <NUM>
+ * \li Origin: sts, 06 January 2008
+ */
        LFUN_MATH_MACRO_REMOVE_PARAM,
+/**
+ * LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
+ * \li Action: Append a greedy parameter
+ * \li Notion: Append a greedy parameter to a Math Macro which
+               eats the following mathed cell in every instance of
+               the macro in the buffer.
+ * \li Syntax: math-macro-append-greedy-param
+ * \li Origin: sts, 06 January 2008
+ */
        LFUN_MATH_MACRO_APPEND_GREEDY_PARAM,
        // 310
+/**
+ * LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
+ * \li Action: Remove a greedy parameter
+ * \li Notion: Remove a greedy parameter of a Math Macro and spit
+               out the values of it in every instance of the macro 
+               in the buffer. If it is an optional parameter the [valud]
+               format is used.
+ * \li Syntax: math-macro-remove-greedy-param
+ * \li Origin: sts, 06 January 2008
+ */
        LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM,
+/**
+ * LFUN_MATH_MACRO_MAKE_OPTIONAL
+ * \li Action: Make a parameter optional
+ * \li Notion: Turn the first non-optional parameter of a Math Macro
+               into an optional parameter with a default value.
+ * \li Syntax: math-macro-make-optional
+ * \li Origin: sts, 06 January 2008
+ */    
        LFUN_MATH_MACRO_MAKE_OPTIONAL,
+/**
+ * LFUN_MATH_MACRO_MAKE_NONOPTIONAL
+ * \li Action: Make a parameter non-optional
+ * \li Notion: Turn the last optional parameter of a Math Macro
+               into a non-optional parameter. The default value is
+               remembered to be reused later if the user changes his mind.
+ * \li Syntax: math-macro-make-nonoptional
+ * \li Origin: sts, 06 January 2008
+ */
        LFUN_MATH_MACRO_MAKE_NONOPTIONAL,
+/**
+ * LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
+ * \li Action: Add an optional parameter
+ * \li Notion: Insert an optional parameter just behind the 
+               already existing optional parameters.
+ * \li Syntax: math-macro-add-optional-param
+ * \li Origin: sts, 06 January 2008
+ */
        LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM,
+/**
+ * LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
+ * \li Action: Remove the last optional parameter
+ * \li Notion: Remove the last optional parameter of a Math Macro and
+               remove it in all the instances of the macro in the buffer.
+ * \li Syntax: math-macro-remove-optional-param
+ * \li Origin: sts, 06 January 2008
+ */
        LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM,
 
        // 315
+/**
+ * LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
+ * \li Action: Add a greedy optional parameter
+ * \li Notion: Add a greedy optional parameter which eats the value
+               from the following cells in mathed which are in the [value]
+               format.
+ * \li Syntax: math-macro-add-greedy-optional-param
+ * \li Origin: sts, 06 January 2008
+ */
        LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM,
+/**
+ * LFUN_IN_MATHMACROTEMPLATE
+ * \li Action: Only active in Math Macro definition
+ * \li Notion: Dummy function which is only active in a Math Macro definition. 
+               It's used to toggle the Math Macro toolbar if the cursor moves
+               into a Math Macro definition.
+ * \li Syntax: in-mathmacrotemplate
+ * \li Origin: sts, 06 January 2008
+ */
        LFUN_IN_MATHMACROTEMPLATE,
 /** LFUN_SCROLL
  * \li Action: scroll the buffer view
@@ -662,7 +836,7 @@ enum kb_action {
  * \li Params: <TYPE>:  line|page\n
                <QUANTITY>: up|down|<number>\n
  * \li Origin: Abdelrazak Younes, Dec 27 2007
-*/
+ */
        LFUN_SCROLL,
        LFUN_LASTACTION                  // end of the table
 };