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.C
  12  * - add a branch to the suitable ::dispatch() methods
  13  * - add correct test in LyXFunc::getStatus()
  14  */
  15
  16 #ifndef LFUNS_H
  17 #define LFUNS_H
  18
  19 #include <iosfwd>
  20
  21 /** These are all the lyx functions, the main mechanism
  22  * through which the frontends communicate with the core.
  23  *
  24  * They are managed in LyXAction.C and handled in various
  25  * ::dispatch() functions, starting with LyXFunc.C:dispatch()
  26  */
  27 enum kb_action {
  28         LFUN_UNKNOWN_ACTION = -1,
  29         // 0
  30         LFUN_NOACTION = 0,
  31         LFUN_PREFIX,
  32         LFUN_CENTER,
  33         LFUN_MENUNEW,
  34         LFUN_MENUWRITE,
  35         // 5
  36         LFUN_WRITEAS,
  37         LFUN_MENUPRINT,
  38         LFUN_MENUSENDTO,
  39         LFUN_BUILDPROG,
  40         LFUN_TOCVIEW,
  41         // 10
  42         LFUN_PREVIEW,
  43         LFUN_CLOSEBUFFER,
  44         LFUN_QUIT,
  45         LFUN_AUTOSAVE,
  46         LFUN_UNDO,
  47         // 15
  48         LFUN_REDO,
  49         LFUN_MENUSEARCH,
  50         LFUN_PASTE,
  51         LFUN_PASTESELECTION,
  52         LFUN_CUT,
  53         // 20
  54         LFUN_COPY,
  55         LFUN_GOTOERROR,
  56         LFUN_GOTONOTE,
  57         LFUN_INSET_TOGGLE,
  58         LFUN_HYPHENATION,
  59         // 25
  60         LFUN_LIGATURE_BREAK,
  61         LFUN_HFILL,
  62         LFUN_FREEFONT_APPLY,
  63         LFUN_FREEFONT_UPDATE,
  64         LFUN_EMPH,
  65         // 30
  66         LFUN_BOLD,
  67         LFUN_ROMAN,
  68         LFUN_NOUN,
  69         LFUN_ITAL,
  70         LFUN_FRAK,
  71         // 35
  72         LFUN_RIGHT,
  73         LFUN_LEFT,
  74         LFUN_UP,
  75         LFUN_DOWN,
  76         LFUN_PRIOR,
  77         // 40
  78         LFUN_NEXT,
  79         LFUN_HOME,
  80         LFUN_END,
  81         LFUN_CELL_FORWARD,
  82         LFUN_CELL_BACKWARD,
  83         // 45
  84         LFUN_WORDRIGHT,
  85         LFUN_WORDLEFT,
  86         LFUN_BEGINNINGBUF,
  87         LFUN_ENDBUF,
  88         LFUN_RIGHTSEL,
  89         // 50
  90         LFUN_LEFTSEL,
  91         LFUN_UPSEL,
  92         LFUN_DOWNSEL,
  93         LFUN_PRIORSEL,
  94         LFUN_NEXTSEL,
  95         // 55
  96         LFUN_HOMESEL,
  97         LFUN_ENDSEL,
  98         LFUN_WORDRIGHTSEL,
  99         LFUN_WORDLEFTSEL,
 100         LFUN_WORDSEL,
 101         // 60
 102         LFUN_BEGINNINGBUFSEL,
 103         LFUN_ENDBUFSEL,
 104         LFUN_PROTECTEDSPACE,
 105         LFUN_SETMARK,
 106         LFUN_DELETE,
 107         // 65
 108         LFUN_BACKSPACE,
 109         LFUN_BREAKLINE,
 110         LFUN_BREAKPARAGRAPH,
 111         LFUN_BREAKPARAGRAPHKEEPLAYOUT,
 112         LFUN_QUOTE,
 113         // 70
 114         LFUN_CIRCUMFLEX,
 115         LFUN_SUBSCRIPT,
 116         LFUN_SUPERSCRIPT,
 117         LFUN_GRAVE,
 118         LFUN_ACUTE,
 119         // 75
 120         LFUN_TILDE,
 121         LFUN_CEDILLA,
 122         LFUN_MACRON,
 123         LFUN_UNDERBAR,
 124         LFUN_UNDERDOT,
 125         // 80
 126         LFUN_CIRCLE,
 127         LFUN_TIE,
 128         LFUN_BREVE,
 129         LFUN_CARON,
 130         LFUN_SPECIAL_CARON,
 131         // 85
 132         LFUN_HUNG_UMLAUT,
 133         LFUN_UMLAUT,
 134         LFUN_DOT,
 135         LFUN_OGONEK,
 136         LFUN_SELFINSERT,
 137         // 90
 138         LFUN_GETBUFNAME,
 139         LFUN_GETXY,
 140         LFUN_SETXY,
 141         LFUN_CHARATCURSOR,
 142         LFUN_LINEATCURSOR,
 143         // 95
 144         LFUN_GETLAYOUT,
 145         LFUN_GETFONT,
 146         LFUN_GETNAME,
 147         LFUN_NOTIFY,
 148         LFUN_GOTOFILEROW,
 149         // 100
 150         LFUN_INSERT_NOTE,
 151         LFUN_ENVIRONMENT_INSERT,
 152         LFUN_KMAP_OFF,
 153         LFUN_KMAP_PRIM,
 154         LFUN_KMAP_SEC,
 155         // 105
 156         LFUN_KMAP_TOGGLE,
 157         LFUN_INSERT_MATH,
 158         LFUN_INSERT_MATRIX,
 159         LFUN_MATH_LIMITS,
 160         LFUN_MATH_DELIM,                // Alejandro 180696
 161         // 110
 162         LFUN_MATH_DISPLAY,              // Alejandro 180696
 163         LFUN_MATH_MODE,                 // Alejandro 040696
 164         LFUN_MATH_NUMBER,               // Alejandro 040696
 165         LFUN_MATH_NONUMBER,             // Alejandro 180696
 166         LFUN_MATH_SIZE,                 // Alejandro 150896
 167         // 115
 168         LFUN_MATH_MACRO,                // ale970510
 169         LFUN_MATH_EXTERN,               // Andre' 20010424
 170         LFUN_MATH_PANEL,                // Andre' 20010522
 171         LFUN_MATH_MUTATE,               // Andre' 20010523
 172         LFUN_MATH_IMPORT_SELECTION,     // Andre' 20010704
 173         // 120
 174         LFUN_MATH_SPACE,                // Andre' 20010725
 175         LFUN_DELETE_WORD_FORWARD,
 176         LFUN_DELETE_WORD_BACKWARD,
 177         LFUN_DELETE_LINE_FORWARD,
 178         LFUN_MARK_OFF,
 179         // 125
 180         LFUN_MARK_ON,
 181         LFUN_LAYOUT,
 182         LFUN_LAYOUT_CHARACTER,
 183         LFUN_LAYOUT_PARAGRAPH,
 184         LFUN_LAYOUT_DOCUMENT,
 185         // 130
 186         LFUN_LAYOUT_PREAMBLE,
 187         LFUN_DROP_LAYOUTS_CHOICE,
 188         LFUN_CODE,
 189         LFUN_SANS,
 190         LFUN_DEFAULT,
 191         // 135
 192         LFUN_UNDERLINE,
 193         LFUN_FONT_SIZE,
 194         LFUN_FONT_STATE,
 195         LFUN_UPCASE_WORD,
 196         LFUN_LOWCASE_WORD,
 197         // 140
 198         LFUN_CAPITALIZE_WORD,
 199         LFUN_INSERT_LABEL,
 200         LFUN_DEPTH_MIN,
 201         LFUN_DEPTH_PLUS,
 202         LFUN_MENU_OPEN_BY_NAME,
 203         // 145
 204         LFUN_SPELLCHECK,
 205         LFUN_CANCEL,
 206         LFUN_META_FAKE,
 207         LFUN_EXEC_COMMAND,
 208         LFUN_FILE_INSERT,
 209         // 150
 210         LFUN_FILE_INSERT_ASCII,         // CFO-G 1997-11-19
 211         LFUN_FILE_INSERT_ASCII_PARA,    // Levon 2001-02-14
 212         LFUN_FILE_NEW,
 213         LFUN_FILE_OPEN,
 214         LFUN_UP_PARAGRAPH,              // Asger 1996-10-01
 215         // 155
 216         LFUN_UP_PARAGRAPHSEL,           // Asger 1996-10-01
 217         LFUN_DOWN_PARAGRAPH,            // Asger 1996-10-01
 218         LFUN_DOWN_PARAGRAPHSEL,         // Asger 1996-10-01
 219         LFUN_BREAKPARAGRAPH_SKIP,
 220         LFUN_BACKSPACE_SKIP,
 221         // 160
 222         LFUN_DELETE_SKIP,
 223         LFUN_MENUNEWTMPLT,              // Asger 1997-02-02
 224         LFUN_MENURELOAD,                // Asger 1997-02-02
 225         LFUN_RECONFIGURE,               // Asger 1997-02-14
 226         LFUN_INDEX_PRINT,               // Lgb 97-02-27
 227         // 165
 228         LFUN_LATEX_LOG,                 // Lgb 97-04-05
 229         LFUN_CELL_SPLIT,
 230         LFUN_CHILDOPEN,                 // Ale 970528
 231         LFUN_TOC_INSERT,                // Lgb 97-05-27
 232         LFUN_FLOAT_LIST,                // Lgb 20010503
 233         // 170
 234         LFUN_READ_ONLY_TOGGLE,          // Lgb 97-05-27
 235         LFUN_VC_REGISTER,               // Lgb 97-07-01
 236         LFUN_VC_CHECKIN,                // Lgb 97-07-01
 237         LFUN_VC_CHECKOUT,               // Lgb 97-07-01
 238         LFUN_VC_REVERT,                 // Lgb 97-07-01
 239         // 175
 240         LFUN_VC_UNDO,                   // Lgb 97-07-01
 241         LFUN_VC_HISTORY,                // Lgb 97-07-01
 242         LFUN_EXPORT,                    // Lgb 97-07-29
 243         LFUN_REF_GOTO,                  // Ale 970806
 244         LFUN_PARENTINSERT,              // Ale 970813
 245         // 180
 246         LFUN_REMOVEERRORS,              // Asger 970906
 247         LFUN_LDOTS,                     // Asger 970929
 248         LFUN_END_OF_SENTENCE,           // Asger 970929
 249         LFUN_TOGGLECURSORFOLLOW,        // ARRae 971202
 250         LFUN_RUNCHKTEX,                 // Asger 971030
 251         // 185
 252         LFUN_HTMLURL,                   // CFO-G 971121
 253         LFUN_URL,                       // CFO-G 971121
 254         LFUN_WORDFINDFORWARD,           // Etienne 980216
 255         LFUN_WORDFINDBACKWARD,          // Etienne 980220
 256         LFUN_APPENDIX,                  // ettrich 980505
 257         // 190
 258         LFUN_IMPORT,                    // Asger 980724
 259         LFUN_MENU_SEPARATOR,            // Asger 990220
 260         LFUN_SEQUENCE,                  // Andre' 991111
 261         LFUN_DIALOG_PREFERENCES,        // ARRae 20000726
 262         LFUN_SAVEPREFERENCES,           // Lgb 991127
 263         // 195
 264         LFUN_HELP_OPEN,                 // Jug 990627
 265         LFUN_DATE_INSERT,               // jdblair 20000131
 266         LFUN_LANGUAGE,                  // Dekel 20000203
 267         LFUN_INSET_ERT,                 // Jug 20000218
 268         LFUN_INSET_FOOTNOTE,            // Jug 20000307
 269         // 200
 270         LFUN_PARAGRAPH_SPACING,         // Lgb 20000411
 271         LFUN_TABULAR_INSERT,            // Jug 20000412
 272         LFUN_LOFVIEW,                   // Dekel 20000519
 273         LFUN_LOTVIEW,                   // Dekel 20000519
 274         LFUN_LOAVIEW,                   // Dekel 20000519
 275         // 205
 276         LFUN_SET_COLOR,                 // SLior 20000611
 277         LFUN_INSET_MARGINAL,            // Lgb 20000626
 278         LFUN_INSET_MINIPAGE,            // Lgb 20000627
 279         LFUN_INSET_FLOAT,               // Lgb 20000627
 280         LFUN_INSET_WIDE_FLOAT,          // Lgb 20010531
 281         // 210
 282         LFUN_INSET_CAPTION,             // Lgb 20000718
 283         LFUN_SWITCHBUFFER,
 284         LFUN_TABULAR_FEATURE,           // Jug 20000728
 285         LFUN_LAYOUT_TABULAR,            // Jug 20000731
 286         LFUN_SCROLL_INSET,              // Jug 20000801
 287         // 215
 288         LFUN_UPDATE,                    // Dekel 20000805
 289         LFUN_INDEX_INSERT,              // Angus 20000803
 290         LFUN_SCREEN_FONT_UPDATE,        // ARRae 20000813
 291         LFUN_GOTO_PARAGRAPH,            // Dekel 20000826
 292         LFUN_REFERENCE_GOTO,            // Dekel 20010114
 293         // 220
 294         LFUN_BOOKMARK_SAVE,             // Dekel 20010127
 295         LFUN_BOOKMARK_GOTO,             // Dekel 20010127
 296         LFUN_SELECT_FILE_SYNC,          // Levon 20010214
 297         LFUN_MESSAGE,                   // Lgb 20010408
 298         LFUN_TRANSPOSE_CHARS,           // Lgb 20010425
 299         // 225
 300         LFUN_ESCAPE,                    // Lgb 20010517
 301         LFUN_HELP_ABOUTLYX,             // Edwin 20010712
 302         LFUN_THESAURUS_ENTRY,           // Levon 20010720
 303         LFUN_HELP_TEXINFO,              // Herbert 20011001
 304         LFUN_FORKS_SHOW,                // Angus 16 Feb 2002
 305         // 230
 306         LFUN_FORKS_KILL,                // Angus 16 Feb 2002
 307         LFUN_TOOLTIPS_TOGGLE,           // Angus 8 Mar 2002
 308         LFUN_INSET_OPTARG,              // Martin 12 Aug 2002
 309         LFUN_MOUSE_PRESS,               // André 9 Aug 2002
 310         LFUN_MOUSE_MOTION,              // André 9 Aug 2002
 311         // 235
 312         LFUN_MOUSE_RELEASE,             // André 9 Aug 2002
 313         LFUN_MOUSE_DOUBLE,              // André 9 Aug 2002
 314         LFUN_MOUSE_TRIPLE,              // André 9 Aug 2002
 315         LFUN_EDIT,                      // André 16 Aug 2002
 316         LFUN_INSET_WRAP,                // Dekel 7 Apr 2002
 317         // 240
 318         LFUN_TRACK_CHANGES,             // Levon 20021001 (cool date !)
 319         LFUN_MERGE_CHANGES,             // Levon 20021016
 320         LFUN_ACCEPT_CHANGE,             // Levon 20021016
 321         LFUN_REJECT_CHANGE,             // Levon 20021016
 322         LFUN_ACCEPT_ALL_CHANGES,        // Levon 20021016
 323         // 245
 324         LFUN_REJECT_ALL_CHANGES,        // Levon 20021016
 325         LFUN_INSERT_BIBITEM,            // André 14 Feb 2003
 326         LFUN_DIALOG_SHOW_NEW_INSET,
 327         LFUN_DIALOG_SHOW_NEXT_INSET,
 328         LFUN_DIALOG_UPDATE,
 329         // 250
 330         LFUN_DIALOG_HIDE,
 331         LFUN_DIALOG_DISCONNECT_INSET,
 332         LFUN_INSET_APPLY,
 333         LFUN_INSET_INSERT,
 334         LFUN_INSET_MODIFY,
 335         // 255
 336         LFUN_INSET_DIALOG_UPDATE,
 337         LFUN_INSET_SETTINGS,
 338         LFUN_PARAGRAPH_APPLY,
 339         LFUN_PARAGRAPH_UPDATE,
 340
 341         LFUN_LASTACTION                  // end of the table
 342 };
 343
 344 std::ostream & operator<<(std::ostream &, kb_action);
 345
 346 #endif // LFUNS_H