4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * Full author contact details are available in file CREDITS.
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
24 /** These are all the lyx functions, the main mechanism
25 * through which the frontends communicate with the core.
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();
33 /** LFUN documentation (a start at least, Chr 2007-08-12)
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
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.
46 LFUN_UNKNOWN_ACTION = -1,
55 /** LFUN_BUFFER_WRITE_AS,
56 * Function: Rename and save current buffer.
57 * Syntax: buffer-write-as <filename>
58 * In: <filename> = New name of the buffer/file. A relative path
59 * is with respect to the original location of the buffer/file.
66 LFUN_BUFFER_AUTO_SAVE,
70 LFUN_PRIMARY_SELECTION_PASTE,
78 LFUN_HYPHENATION_POINT_INSERT,
79 LFUN_LIGATURE_BREAK_INSERT,
82 LFUN_FONT_FREE_UPDATE,
108 LFUN_CHAR_FORWARD_SELECT,
109 LFUN_CHAR_BACKWARD_SELECT,
112 LFUN_SCREEN_UP_SELECT,
114 LFUN_SCREEN_DOWN_SELECT,
115 LFUN_LINE_BEGIN_SELECT,
116 LFUN_LINE_END_SELECT,
117 LFUN_WORD_FORWARD_SELECT,
118 LFUN_WORD_BACKWARD_SELECT,
121 LFUN_BUFFER_BEGIN_SELECT,
122 LFUN_BUFFER_END_SELECT,
123 LFUN_SPACE_INSERT, // JSpitzm 20030520
126 LFUN_CHAR_DELETE_FORWARD,
127 LFUN_CHAR_DELETE_BACKWARD,
129 LFUN_BREAK_PARAGRAPH,
130 LFUN_BREAK_PARAGRAPH_KEEP_LAYOUT,
133 LFUN_ACCENT_CIRCUMFLEX,
135 LFUN_MATH_SUPERSCRIPT,
142 LFUN_ACCENT_UNDERBAR,
144 LFUN_ACCENT_UNDERDOT,
150 LFUN_ACCENT_SPECIAL_CARON,
151 LFUN_ACCENT_HUNGARIAN_UMLAUT,
160 LFUN_SERVER_CHAR_AFTER,
163 LFUN_SERVER_GET_LAYOUT,
164 LFUN_SERVER_GET_FONT,
165 LFUN_SERVER_GET_NAME,
168 LFUN_SERVER_GOTO_FILE_ROW,
170 LFUN_ENVIRONMENT_INSERT, // unused as of 20060905
174 LFUN_KEYMAP_SECONDARY,
180 LFUN_MATH_DELIM, // Alejandro 180696
181 LFUN_MATH_DISPLAY, // Alejandro 180696
182 LFUN_MATH_MODE, // Alejandro 040696
183 LFUN_MATH_NUMBER, // Alejandro 040696
184 LFUN_MATH_NONUMBER, // Alejandro 180696
186 LFUN_MATH_SIZE, // Alejandro 150896
187 LFUN_MATH_MACRO, // ale970510
188 LFUN_MATH_EXTERN, // Andre' 20010424
189 LFUN_MATH_MUTATE, // Andre' 20010523
190 LFUN_MATH_IMPORT_SELECTION, // Andre' 20010704
192 LFUN_MATH_SPACE, // Andre' 20010725
193 LFUN_WORD_DELETE_FORWARD,
194 LFUN_WORD_DELETE_BACKWARD,
200 LFUN_LAYOUT_PARAGRAPH,
201 LFUN_DROP_LAYOUTS_CHOICE, // used in bindings as of 20060905
212 LFUN_WORD_CAPITALIZE,
214 LFUN_DEPTH_DECREMENT,
216 LFUN_DEPTH_INCREMENT,
217 LFUN_MENU_OPEN, // used in bindings as of 20060905
220 LFUN_COMMAND_EXECUTE,
223 LFUN_FILE_INSERT_PLAINTEXT, // CFO-G 1997-11-19
224 LFUN_FILE_INSERT_PLAINTEXT_PARA,// Levon 2001-02-14
225 LFUN_FILE_NEW, // for scripting purposes
228 LFUN_PARAGRAPH_UP, // Asger 1996-10-01
229 LFUN_PARAGRAPH_UP_SELECT, // Asger 1996-10-01
230 LFUN_PARAGRAPH_DOWN, // Asger 1996-10-01
231 LFUN_PARAGRAPH_DOWN_SELECT, // Asger 1996-10-01
232 LFUN_BREAK_PARAGRAPH_SKIP,
234 LFUN_DELETE_BACKWARD_SKIP,
235 LFUN_DELETE_FORWARD_SKIP,
236 LFUN_BUFFER_NEW_TEMPLATE, // Asger 1997-02-02
237 LFUN_BUFFER_RELOAD, // Asger 1997-02-02
238 LFUN_RECONFIGURE, // Asger 1997-02-14
240 LFUN_INDEX_PRINT, // Lgb 97-02-27
242 LFUN_BUFFER_CHILD_OPEN, // Ale 970528
243 LFUN_TOC_INSERT, // Lgb 97-05-27
244 LFUN_FLOAT_LIST, // Lgb 20010503
246 LFUN_BUFFER_TOGGLE_READ_ONLY, // Lgb 97-05-27
247 LFUN_VC_REGISTER, // Lgb 97-07-01
248 LFUN_VC_CHECK_IN, // Lgb 97-07-01
249 LFUN_VC_CHECK_OUT, // Lgb 97-07-01
250 LFUN_VC_REVERT, // Lgb 97-07-01
252 LFUN_VC_UNDO_LAST, // Lgb 97-07-01
253 LFUN_BUFFER_EXPORT, // Lgb 97-07-29
254 LFUN_LABEL_GOTO, // Ale 970806
255 LFUN_DOTS_INSERT, // Asger 970929
256 LFUN_END_OF_SENTENCE_PERIOD_INSERT, // Asger 970929
258 LFUN_TOGGLE_CURSOR_FOLLOWS_SCROLLBAR, // ARRae 971202
259 LFUN_BUFFER_CHKTEX, // Asger 971030
260 LFUN_HTML_INSERT, // CFO-G 971121; must co-exist with URL_INSERT as of 20060905
261 LFUN_URL_INSERT, // CFO-G 971121
262 LFUN_WORD_FIND_FORWARD, // Etienne 980216
264 LFUN_WORD_FIND_BACKWARD, // Etienne 980220
265 LFUN_APPENDIX, // ettrich 980505
266 LFUN_BUFFER_IMPORT, // Asger 980724
267 LFUN_MENU_SEPARATOR_INSERT, // Asger 990220
268 LFUN_COMMAND_SEQUENCE, // Andre' 991111
270 LFUN_PREFERENCES_SAVE, // Lgb 991127
271 LFUN_HELP_OPEN, // Jug 990627
272 LFUN_DATE_INSERT, // jdblair 20000131
273 LFUN_LANGUAGE, // Dekel 20000203
274 LFUN_ERT_INSERT, // Jug 20000218
276 LFUN_FOOTNOTE_INSERT, // Jug 20000307
277 LFUN_PARAGRAPH_SPACING, // Lgb 20000411
278 LFUN_TABULAR_INSERT, // Jug 20000412
279 LFUN_LOFVIEW, // Dekel 20000519
280 LFUN_LOTVIEW, // Dekel 20000519
282 LFUN_LOAVIEW, // Dekel 20000519
283 LFUN_SET_COLOR, // SLior 20000611
284 LFUN_MARGINALNOTE_INSERT, // Lgb 20000626
285 LFUN_FLOAT_INSERT, // Lgb 20000627
286 LFUN_FLOAT_WIDE_INSERT, // Lgb 20010531
288 LFUN_CAPTION_INSERT, // Lgb 20000718; inactive as of 20060905
290 LFUN_TABULAR_FEATURE, // Jug 20000728
291 LFUN_LAYOUT_TABULAR, // Jug 20000731
292 LFUN_BUFFER_UPDATE, // Dekel 20000805
294 LFUN_INDEX_INSERT, // Angus 20000803
295 LFUN_SCREEN_FONT_UPDATE, // ARRae 20000813
296 LFUN_PARAGRAPH_GOTO, // Dekel 20000826
297 LFUN_REFERENCE_NEXT, // Dekel 20010114
298 LFUN_BOOKMARK_SAVE, // Dekel 20010127
300 LFUN_BOOKMARK_GOTO, // Dekel 20010127
301 LFUN_SELECT_FILE_SYNC, // Levon 20010214
302 LFUN_MESSAGE, // Lgb 20010408; for scripting purposes, output in minibuffer
303 LFUN_CHARS_TRANSPOSE, // Lgb 20010425
304 LFUN_ESCAPE, // Lgb 20010517
306 LFUN_THESAURUS_ENTRY, // Levon 20010720
307 LFUN_OPTIONAL_INSERT, // Martin 12 Aug 2002
308 LFUN_MOUSE_PRESS, // André 9 Aug 2002
309 LFUN_MOUSE_MOTION, // André 9 Aug 2002
310 LFUN_MOUSE_RELEASE, // André 9 Aug 2002
312 LFUN_MOUSE_DOUBLE, // André 9 Aug 2002
313 LFUN_MOUSE_TRIPLE, // André 9 Aug 2002
314 LFUN_WRAP_INSERT, // Dekel 7 Apr 2002
315 LFUN_CHANGES_TRACK, // Levon 20021001 (cool date !)
316 LFUN_CHANGES_MERGE, // Levon 20021016
318 LFUN_CHANGE_ACCEPT, // Levon 20021016
319 LFUN_CHANGE_REJECT, // Levon 20021016
320 LFUN_ALL_CHANGES_ACCEPT, // Levon 20021016
321 LFUN_ALL_CHANGES_REJECT, // Levon 20021016
322 LFUN_BIBITEM_INSERT, // André 14 Feb 2003
325 LFUN_DIALOG_SHOW_NEW_INSET,
328 LFUN_DIALOG_TOGGLE, // JSpitzm 20070430
330 LFUN_DIALOG_DISCONNECT_INSET,
334 LFUN_INSET_DIALOG_UPDATE,
337 LFUN_PARAGRAPH_PARAMS_APPLY,
338 LFUN_PARAGRAPH_UPDATE,
344 LFUN_PAGEBREAK_INSERT,
352 LFUN_BUFFER_EXPORT_CUSTOM,
355 LFUN_NEXT_INSET_TOGGLE,
356 LFUN_ALL_INSETS_TOGGLE,
357 LFUN_BUFFER_LANGUAGE,
358 LFUN_TEXTCLASS_APPLY,
361 LFUN_BUFFER_SAVE_AS_DEFAULT,
362 LFUN_BUFFER_PARAMS_APPLY,
368 LFUN_BUFFER_PREVIOUS,
370 LFUN_CHANGES_OUTPUT, // jspitzm 20050121
372 LFUN_BIBTEX_DATABASE_ADD,
373 LFUN_BIBTEX_DATABASE_DEL,
374 LFUN_CITATION_INSERT,
375 LFUN_OUTLINE_UP, // Vermeer 20060323
380 LFUN_PARAGRAPH_MOVE_DOWN, // Edwin 20060408
381 LFUN_PARAGRAPH_MOVE_UP, // Edwin 20060408
382 LFUN_BUFFER_TOGGLE_COMPRESSION, // bpeng 20060427
385 LFUN_CLIPBOARD_PASTE,
386 LFUN_INSET_DISSOLVE, // jspitzm 20060807
388 LFUN_WINDOW_NEW, // Abdel 20061021
390 LFUN_WINDOW_CLOSE, // Abdel 20061023
391 LFUN_UNICODE_INSERT, // Lgb 20061022
392 LFUN_BOOKMARK_CLEAR, // bpeng 20061031
393 LFUN_NOMENCL_INSERT, // Ugras
394 LFUN_NOMENCL_PRINT, // Ugras
396 LFUN_CLEARPAGE_INSERT, // Ugras 20061125
397 LFUN_CLEARDOUBLEPAGE_INSERT, // Ugras 20061125
398 LFUN_LISTING_INSERT, // Herbert 20011110, bpeng 20070502
399 LFUN_TOOLBAR_TOGGLE, // Edwin 20070521
400 LFUN_BUFFER_WRITE_ALL, // rgh, gpothier 200707XX
402 LFUN_PARAGRAPH_PARAMS, // rgh, 200708XX
403 LFUN_LAYOUT_MODULES_CLEAR, // rgh, 20070825
404 LFUN_LAYOUT_MODULE_ADD, // rgh, 20070825
406 LFUN_LASTACTION // end of the table
409 std::ostream & operator<<(std::ostream &, kb_action);