src/lfuns.h

   1 // -*- C++ -*-
   2 /**
   3  * \file lfuns.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * Full author contact details are available in file CREDITS.
   8  *
   9  * To add a new function:
  10  * - add a new enum constant immediately before LFUN_LASTACTION
  11  * - add an appropriate line in LyXAction.cpp
  12  * - add a branch to a suitable ::doDispatch() method
  13  * - add correct test to the corresponding ::getStatus() method
  14  */
  15
  16 #ifndef LFUNS_H
  17 #define LFUNS_H
  18
  19 #include <iosfwd>
  20
  21
  22 namespace lyx {
  23
  24 /** These are all the lyx functions, the main mechanism
  25  * through which the frontends communicate with the core.
  26  *
  27  * They are managed in LyXAction.cpp and handled in various
  28  * ::dispatch() functions, starting with LyXFunc.C:dispatch(),
  29  * BufferView::dispatch(), Cursor::dispatch() and
  30  * Inset*::doDispatch();
  31  */
  32
  33 /** LFUN documentation (a start at least, Chr 2007-08-12)
  34  *
  35  * The documentation below is primarily notes about restrictions and
  36  * oddities relating to the different LFUNs. Note that this
  37  * documentation may well be moved to a more suitable location later
  38  * on.
  39  *
  40  * The documentation is interspersed with the enum:s. Another choice
  41  * was to put it in a separate list. The best choice was unclear, so
  42  * this may change. Particularly if doxygen can be used somehow.
  43  */
  44
  45 enum kb_action {
  46         LFUN_UNKNOWN_ACTION = -1,
  47         // 0
  48         LFUN_NOACTION = 0,
  49         LFUN_COMMAND_PREFIX,
  50         LFUN_SCREEN_RECENTER,
  51         LFUN_BUFFER_NEW,
  52         LFUN_BUFFER_WRITE,
  53         // 5
  54         LFUN_BUFFER_WRITE_AS,
  55 /**     LFUN_BUFFER_WRITE_AS,           Chr 2007-08-12
  56  * Function:    Save current buffer as .lyx-file with a new filename.
  57  * Syntax:      buffer-write-as <filename>
  58  * In:          <filename> = Name of the new file. Must currently be
  59  *              an absolute path (bug 4135). Relative paths will be
  60  *              treated as relative to the location of the original
  61  *              buffer (i.e. LyX file?).
  62  *
  63  */
  64         LFUN_BUILD_PROGRAM,
  65         LFUN_BUFFER_VIEW,
  66         LFUN_BUFFER_CLOSE,
  67         LFUN_LYX_QUIT,
  68         // 10
  69         LFUN_BUFFER_AUTO_SAVE,
  70         LFUN_UNDO,
  71         LFUN_REDO,
  72         LFUN_PASTE,
  73         LFUN_PRIMARY_SELECTION_PASTE,
  74         // 15
  75         LFUN_CUT,
  76         LFUN_COPY,
  77         LFUN_ERROR_NEXT,
  78         LFUN_NOTE_NEXT,
  79         LFUN_INSET_TOGGLE,
  80         // 20
  81         LFUN_HYPHENATION_POINT_INSERT,
  82         LFUN_LIGATURE_BREAK_INSERT,
  83         LFUN_HFILL_INSERT,
  84         LFUN_FONT_FREE_APPLY,
  85         LFUN_FONT_FREE_UPDATE,
  86         // 25
  87         LFUN_FONT_EMPH,
  88         LFUN_FONT_BOLD,
  89         LFUN_FONT_ROMAN,
  90         LFUN_FONT_NOUN,
  91         LFUN_FONT_ITAL,
  92         // 30
  93         LFUN_FONT_FRAK,
  94         LFUN_CHAR_FORWARD,
  95         LFUN_CHAR_BACKWARD,
  96         LFUN_UP,
  97         LFUN_DOWN,
  98         // 35
  99         LFUN_SCREEN_UP,
 100         LFUN_SCREEN_DOWN,
 101         LFUN_LINE_BEGIN,
 102         LFUN_LINE_END,
 103         LFUN_CELL_FORWARD,
 104         // 40
 105         LFUN_CELL_BACKWARD,
 106         LFUN_WORD_FORWARD,
 107         LFUN_WORD_BACKWARD,
 108         LFUN_BUFFER_BEGIN,
 109         LFUN_BUFFER_END,
 110         // 45
 111         LFUN_CHAR_FORWARD_SELECT,
 112         LFUN_CHAR_BACKWARD_SELECT,
 113         LFUN_UP_SELECT,
 114         LFUN_DOWN_SELECT,
 115         LFUN_SCREEN_UP_SELECT,
 116         // 50
 117         LFUN_SCREEN_DOWN_SELECT,
 118         LFUN_LINE_BEGIN_SELECT,
 119         LFUN_LINE_END_SELECT,
 120         LFUN_WORD_FORWARD_SELECT,
 121         LFUN_WORD_BACKWARD_SELECT,
 122         // 55
 123         LFUN_WORD_SELECT,
 124         LFUN_BUFFER_BEGIN_SELECT,
 125         LFUN_BUFFER_END_SELECT,
 126         LFUN_SPACE_INSERT,  // JSpitzm 20030520
 127         LFUN_MARK_TOGGLE,
 128         // 60
 129         LFUN_CHAR_DELETE_FORWARD,
 130         LFUN_CHAR_DELETE_BACKWARD,
 131         LFUN_BREAK_LINE,
 132         LFUN_BREAK_PARAGRAPH,
 133         LFUN_BREAK_PARAGRAPH_KEEP_LAYOUT,
 134         // 65
 135         LFUN_QUOTE_INSERT,
 136         LFUN_ACCENT_CIRCUMFLEX,
 137         LFUN_MATH_SUBSCRIPT,
 138         LFUN_MATH_SUPERSCRIPT,
 139         LFUN_ACCENT_GRAVE,
 140         // 70
 141         LFUN_ACCENT_ACUTE,
 142         LFUN_ACCENT_TILDE,
 143         LFUN_ACCENT_CEDILLA,
 144         LFUN_ACCENT_MACRON,
 145         LFUN_ACCENT_UNDERBAR,
 146         // 75
 147         LFUN_ACCENT_UNDERDOT,
 148         LFUN_ACCENT_CIRCLE,
 149         LFUN_ACCENT_TIE,
 150         LFUN_ACCENT_BREVE,
 151         LFUN_ACCENT_CARON,
 152         // 80
 153         LFUN_ACCENT_SPECIAL_CARON,
 154         LFUN_ACCENT_HUNGARIAN_UMLAUT,
 155         LFUN_ACCENT_UMLAUT,
 156         LFUN_ACCENT_DOT,
 157         LFUN_ACCENT_OGONEK,
 158         // 85
 159         LFUN_SELF_INSERT,
 160         LFUN_GETBUFNAME,
 161         LFUN_SERVER_GET_XY,
 162         LFUN_SERVER_SET_XY,
 163         LFUN_SERVER_CHAR_AFTER,
 164         // 90
 165         LFUN_LINEATCURSOR,
 166         LFUN_SERVER_GET_LAYOUT,
 167         LFUN_SERVER_GET_FONT,
 168         LFUN_SERVER_GET_NAME,
 169         LFUN_SERVER_NOTIFY,
 170         // 95
 171         LFUN_SERVER_GOTO_FILE_ROW,
 172         LFUN_NOTE_INSERT,
 173         LFUN_ENVIRONMENT_INSERT,        // unused as of 20060905
 174         LFUN_KEYMAP_OFF,
 175         LFUN_KEYMAP_PRIMARY,
 176         // 100
 177         LFUN_KEYMAP_SECONDARY,
 178         LFUN_KEYMAP_TOGGLE,
 179         LFUN_MATH_INSERT,
 180         LFUN_MATH_MATRIX,
 181         LFUN_MATH_LIMITS,
 182         // 105
 183         LFUN_MATH_DELIM,                // Alejandro 180696
 184         LFUN_MATH_DISPLAY,              // Alejandro 180696
 185         LFUN_MATH_MODE,                 // Alejandro 040696
 186         LFUN_MATH_NUMBER,               // Alejandro 040696
 187         LFUN_MATH_NONUMBER,             // Alejandro 180696
 188         // 110
 189         LFUN_MATH_SIZE,                 // Alejandro 150896
 190         LFUN_MATH_MACRO,                // ale970510
 191         LFUN_MATH_EXTERN,               // Andre' 20010424
 192         LFUN_MATH_MUTATE,               // Andre' 20010523
 193         LFUN_MATH_IMPORT_SELECTION,     // Andre' 20010704
 194         // 115
 195         LFUN_MATH_SPACE,                // Andre' 20010725
 196         LFUN_WORD_DELETE_FORWARD,
 197         LFUN_WORD_DELETE_BACKWARD,
 198         LFUN_LINE_DELETE,
 199         LFUN_MARK_OFF,
 200         // 120
 201         LFUN_MARK_ON,
 202         LFUN_LAYOUT,
 203         LFUN_LAYOUT_PARAGRAPH,
 204         LFUN_DROP_LAYOUTS_CHOICE,       // used in bindings as of 20060905
 205         LFUN_FONT_CODE,
 206         // 125
 207         LFUN_FONT_SANS,
 208         LFUN_FONT_DEFAULT,
 209         LFUN_FONT_UNDERLINE,
 210         LFUN_FONT_SIZE,
 211         LFUN_FONT_STATE,
 212         // 130
 213         LFUN_WORD_UPCASE,
 214         LFUN_WORD_LOWCASE,
 215         LFUN_WORD_CAPITALIZE,
 216         LFUN_LABEL_INSERT,
 217         LFUN_DEPTH_DECREMENT,
 218         // 135
 219         LFUN_DEPTH_INCREMENT,
 220         LFUN_MENU_OPEN,                 // used in bindings as of 20060905
 221         LFUN_CANCEL,
 222         LFUN_META_PREFIX,
 223         LFUN_COMMAND_EXECUTE,
 224         // 140
 225         LFUN_FILE_INSERT,
 226         LFUN_FILE_INSERT_PLAINTEXT,     // CFO-G 1997-11-19
 227         LFUN_FILE_INSERT_PLAINTEXT_PARA,// Levon 2001-02-14
 228         LFUN_FILE_NEW,                  // for scripting purposes
 229         LFUN_FILE_OPEN,
 230         // 145
 231         LFUN_PARAGRAPH_UP,              // Asger 1996-10-01
 232         LFUN_PARAGRAPH_UP_SELECT,       // Asger 1996-10-01
 233         LFUN_PARAGRAPH_DOWN,            // Asger 1996-10-01
 234         LFUN_PARAGRAPH_DOWN_SELECT,     // Asger 1996-10-01
 235         LFUN_BREAK_PARAGRAPH_SKIP,
 236         // 150
 237         LFUN_DELETE_BACKWARD_SKIP,
 238         LFUN_DELETE_FORWARD_SKIP,
 239         LFUN_BUFFER_NEW_TEMPLATE,       // Asger 1997-02-02
 240         LFUN_BUFFER_RELOAD,             // Asger 1997-02-02
 241         LFUN_RECONFIGURE,               // Asger 1997-02-14
 242         // 155
 243         LFUN_INDEX_PRINT,               // Lgb 97-02-27
 244         LFUN_CELL_SPLIT,
 245         LFUN_BUFFER_CHILD_OPEN,         // Ale 970528
 246         LFUN_TOC_INSERT,                // Lgb 97-05-27
 247         LFUN_FLOAT_LIST,                // Lgb 20010503
 248         // 160
 249         LFUN_BUFFER_TOGGLE_READ_ONLY,          // Lgb 97-05-27
 250         LFUN_VC_REGISTER,               // Lgb 97-07-01
 251         LFUN_VC_CHECK_IN,               // Lgb 97-07-01
 252         LFUN_VC_CHECK_OUT,              // Lgb 97-07-01
 253         LFUN_VC_REVERT,                 // Lgb 97-07-01
 254         // 165
 255         LFUN_VC_UNDO_LAST,              // Lgb 97-07-01
 256         LFUN_BUFFER_EXPORT,             // Lgb 97-07-29
 257         LFUN_LABEL_GOTO,                // Ale 970806
 258         LFUN_DOTS_INSERT,               // Asger 970929
 259         LFUN_END_OF_SENTENCE_PERIOD_INSERT,           // Asger 970929
 260         // 170
 261         LFUN_TOGGLE_CURSOR_FOLLOWS_SCROLLBAR,        // ARRae 971202
 262         LFUN_BUFFER_CHKTEX,                 // Asger 971030
 263         LFUN_HTML_INSERT,                   // CFO-G 971121; must co-exist with URL_INSERT as of 20060905
 264         LFUN_URL_INSERT,                       // CFO-G 971121
 265         LFUN_WORD_FIND_FORWARD,           // Etienne 980216
 266         // 175
 267         LFUN_WORD_FIND_BACKWARD,          // Etienne 980220
 268         LFUN_APPENDIX,                  // ettrich 980505
 269         LFUN_BUFFER_IMPORT,                    // Asger 980724
 270         LFUN_MENU_SEPARATOR_INSERT,            // Asger 990220
 271         LFUN_COMMAND_SEQUENCE,                  // Andre' 991111
 272         // 180
 273         LFUN_PREFERENCES_SAVE,           // Lgb 991127
 274         LFUN_HELP_OPEN,                 // Jug 990627
 275         LFUN_DATE_INSERT,               // jdblair 20000131
 276         LFUN_LANGUAGE,                  // Dekel 20000203
 277         LFUN_ERT_INSERT,                        // Jug 20000218
 278         // 185
 279         LFUN_FOOTNOTE_INSERT,            // Jug 20000307
 280         LFUN_PARAGRAPH_SPACING,         // Lgb 20000411
 281         LFUN_TABULAR_INSERT,            // Jug 20000412
 282         LFUN_LOFVIEW,                   // Dekel 20000519
 283         LFUN_LOTVIEW,                   // Dekel 20000519
 284         // 190
 285         LFUN_LOAVIEW,                   // Dekel 20000519
 286         LFUN_SET_COLOR,                 // SLior 20000611
 287         LFUN_MARGINALNOTE_INSERT,            // Lgb 20000626
 288         LFUN_FLOAT_INSERT,               // Lgb 20000627
 289         LFUN_FLOAT_WIDE_INSERT,          // Lgb 20010531
 290         // 195
 291         LFUN_CAPTION_INSERT,             // Lgb 20000718; inactive as of 20060905
 292         LFUN_BUFFER_SWITCH,
 293         LFUN_TABULAR_FEATURE,           // Jug 20000728
 294         LFUN_LAYOUT_TABULAR,            // Jug 20000731
 295         LFUN_BUFFER_UPDATE,                    // Dekel 20000805
 296         // 200
 297         LFUN_INDEX_INSERT,              // Angus 20000803
 298         LFUN_SCREEN_FONT_UPDATE,        // ARRae 20000813
 299         LFUN_PARAGRAPH_GOTO,            // Dekel 20000826
 300         LFUN_REFERENCE_NEXT,            // Dekel 20010114
 301         LFUN_BOOKMARK_SAVE,             // Dekel 20010127
 302         // 205
 303         LFUN_BOOKMARK_GOTO,             // Dekel 20010127
 304         LFUN_SELECT_FILE_SYNC,          // Levon 20010214
 305         LFUN_MESSAGE,                   // Lgb 20010408; for scripting purposes, output in minibuffer
 306         LFUN_CHARS_TRANSPOSE,           // Lgb 20010425
 307         LFUN_ESCAPE,                    // Lgb 20010517
 308         // 210
 309         LFUN_THESAURUS_ENTRY,           // Levon 20010720
 310         LFUN_OPTIONAL_INSERT,              // Martin 12 Aug 2002
 311         LFUN_MOUSE_PRESS,               // André 9 Aug 2002
 312         LFUN_MOUSE_MOTION,              // André 9 Aug 2002
 313         LFUN_MOUSE_RELEASE,             // André 9 Aug 2002
 314         // 215
 315         LFUN_MOUSE_DOUBLE,              // André 9 Aug 2002
 316         LFUN_MOUSE_TRIPLE,              // André 9 Aug 2002
 317         LFUN_WRAP_INSERT,                // Dekel 7 Apr 2002
 318         LFUN_CHANGES_TRACK,             // Levon 20021001 (cool date !)
 319         LFUN_CHANGES_MERGE,             // Levon 20021016
 320         // 220
 321         LFUN_CHANGE_ACCEPT,             // Levon 20021016
 322         LFUN_CHANGE_REJECT,             // Levon 20021016
 323         LFUN_ALL_CHANGES_ACCEPT,        // Levon 20021016
 324         LFUN_ALL_CHANGES_REJECT,        // Levon 20021016
 325         LFUN_BIBITEM_INSERT,            // André 14 Feb 2003
 326         // 225
 327         LFUN_DIALOG_SHOW,
 328         LFUN_DIALOG_SHOW_NEW_INSET,
 329         LFUN_DIALOG_UPDATE,
 330         LFUN_DIALOG_HIDE,
 331         LFUN_DIALOG_TOGGLE,             // JSpitzm 20070430
 332         // 230
 333         LFUN_DIALOG_DISCONNECT_INSET,
 334         LFUN_INSET_APPLY,
 335         LFUN_INSET_INSERT,
 336         LFUN_INSET_MODIFY,
 337         LFUN_INSET_DIALOG_UPDATE,
 338         // 235
 339         LFUN_INSET_SETTINGS,
 340         LFUN_PARAGRAPH_PARAMS_APPLY,
 341         LFUN_PARAGRAPH_UPDATE,
 342         LFUN_EXTERNAL_EDIT,
 343         LFUN_BRANCH_INSERT,
 344         // 240
 345         LFUN_BOX_INSERT,
 346         LFUN_LINE_INSERT,
 347         LFUN_PAGEBREAK_INSERT,
 348         LFUN_REPEAT,
 349         LFUN_FINISHED_LEFT,
 350         // 245
 351         LFUN_FINISHED_RIGHT,
 352         LFUN_CHARSTYLE_INSERT,
 353         LFUN_WORD_FIND,
 354         LFUN_WORD_REPLACE,
 355         LFUN_BUFFER_EXPORT_CUSTOM,
 356         // 250
 357         LFUN_BUFFER_PRINT,
 358         LFUN_NEXT_INSET_TOGGLE,
 359         LFUN_ALL_INSETS_TOGGLE,
 360         LFUN_BUFFER_LANGUAGE,
 361         LFUN_TEXTCLASS_APPLY,
 362         // 255
 363         LFUN_TEXTCLASS_LOAD,
 364         LFUN_BUFFER_SAVE_AS_DEFAULT,
 365         LFUN_BUFFER_PARAMS_APPLY,
 366         LFUN_LYXRC_APPLY,
 367         LFUN_GRAPHICS_EDIT,
 368         // 260
 369         LFUN_INSET_REFRESH,
 370         LFUN_BUFFER_NEXT,
 371         LFUN_BUFFER_PREVIOUS,
 372         LFUN_WORDS_COUNT,
 373         LFUN_CHANGES_OUTPUT,             // jspitzm 20050121
 374         // 265
 375         LFUN_BIBTEX_DATABASE_ADD,
 376         LFUN_BIBTEX_DATABASE_DEL,
 377         LFUN_CITATION_INSERT,
 378         LFUN_OUTLINE_UP,                 // Vermeer 20060323
 379         LFUN_OUTLINE_DOWN,
 380         // 270
 381         LFUN_OUTLINE_IN,
 382         LFUN_OUTLINE_OUT,
 383         LFUN_PARAGRAPH_MOVE_DOWN,                // Edwin 20060408
 384         LFUN_PARAGRAPH_MOVE_UP,                  // Edwin 20060408
 385         LFUN_BUFFER_TOGGLE_COMPRESSION,                 // bpeng 20060427
 386         // 275
 387         LFUN_MATH_BIGDELIM,
 388         LFUN_CLIPBOARD_PASTE,
 389         LFUN_INSET_DISSOLVE,                 // jspitzm 20060807
 390         LFUN_CHANGE_NEXT,
 391         LFUN_WINDOW_NEW,                 // Abdel 20061021
 392         // 280
 393         LFUN_WINDOW_CLOSE,               // Abdel 20061023
 394         LFUN_UNICODE_INSERT,             // Lgb 20061022
 395         LFUN_BOOKMARK_CLEAR,             // bpeng 20061031
 396         LFUN_NOMENCL_INSERT,             // Ugras
 397         LFUN_NOMENCL_PRINT,              // Ugras
 398         // 285
 399         LFUN_CLEARPAGE_INSERT,           // Ugras 20061125
 400         LFUN_CLEARDOUBLEPAGE_INSERT,     // Ugras 20061125
 401         LFUN_LISTING_INSERT,             // Herbert 20011110, bpeng 20070502
 402         LFUN_TOOLBAR_TOGGLE,             // Edwin 20070521
 403         LFUN_BUFFER_WRITE_ALL,           // rgh, gpothier 200707XX
 404
 405         LFUN_LASTACTION                  // end of the table
 406 };
 407
 408 std::ostream & operator<<(std::ostream &, kb_action);
 409
 410
 411 } // namespace lyx
 412
 413 #endif // LFUNS_H