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 and doc 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
19 #include "support/strfwd.h"
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.
38 * Doxygen template below.
51 LFUN_UNKNOWN_ACTION = -1,
60 * LFUN_BUFFER_WRITE_AS
61 * \li Action: Rename and save current buffer.
62 * \li Syntax: buffer-write-as <filename>
63 * \li Params: <filename> = New name of the buffer/file. A relative path
64 * is with respect to the original location of the buffer/file.
72 LFUN_BUFFER_AUTO_SAVE,
76 LFUN_PRIMARY_SELECTION_PASTE,
86 LFUN_FONT_FREE_UPDATE,
111 LFUN_CHAR_FORWARD_SELECT,
112 LFUN_CHAR_BACKWARD_SELECT,
116 LFUN_SCREEN_UP_SELECT,
117 LFUN_SCREEN_DOWN_SELECT,
118 LFUN_LINE_BEGIN_SELECT,
120 LFUN_LINE_END_SELECT,
121 LFUN_WORD_FORWARD_SELECT,
122 LFUN_WORD_BACKWARD_SELECT,
124 LFUN_BUFFER_BEGIN_SELECT,
126 LFUN_BUFFER_END_SELECT,
127 LFUN_SPACE_INSERT, // JSpitzm 20030520
128 LFUN_SPECIALCHAR_INSERT, // JSpitzm, 20071206
130 LFUN_CHAR_DELETE_FORWARD,
132 LFUN_CHAR_DELETE_BACKWARD,
134 LFUN_LINE_BREAK, // uwestoehr 20071125
135 LFUN_BREAK_PARAGRAPH,
138 LFUN_ACCENT_CIRCUMFLEX,
140 LFUN_MATH_SUPERSCRIPT,
147 LFUN_ACCENT_UNDERBAR,
148 LFUN_ACCENT_UNDERDOT,
154 LFUN_ACCENT_SPECIAL_CARON,
156 LFUN_ACCENT_HUNGARIAN_UMLAUT,
165 LFUN_SERVER_CHAR_AFTER,
168 LFUN_SERVER_GET_LAYOUT,
169 LFUN_SERVER_GET_FONT,
170 LFUN_SERVER_GET_NAME,
172 LFUN_SERVER_GOTO_FILE_ROW,
175 LFUN_ENVIRONMENT_INSERT, // unused as of 20060905
178 LFUN_KEYMAP_SECONDARY,
184 LFUN_MATH_DELIM, // Alejandro 180696
186 LFUN_MATH_DISPLAY, // Alejandro 180696
187 LFUN_MATH_MODE, // Alejandro 040696
188 LFUN_MATH_NUMBER, // Alejandro 040696
189 LFUN_MATH_NONUMBER, // Alejandro 180696
190 LFUN_MATH_SIZE, // Alejandro 150896
192 LFUN_MATH_MACRO, // ale970510
193 LFUN_MATH_EXTERN, // Andre' 20010424
194 LFUN_MATH_MUTATE, // Andre' 20010523
195 LFUN_MATH_IMPORT_SELECTION, // Andre' 20010704
196 LFUN_MATH_SPACE, // Andre' 20010725
198 LFUN_WORD_DELETE_FORWARD,
199 LFUN_WORD_DELETE_BACKWARD,
205 LFUN_LAYOUT_PARAGRAPH,
206 LFUN_DROP_LAYOUTS_CHOICE, // used in bindings as of 20060905
207 LFUN_FONT_TYPEWRITER, // changed from FONT_CODE 20070920
217 LFUN_WORD_CAPITALIZE,
219 LFUN_DEPTH_DECREMENT,
220 LFUN_DEPTH_INCREMENT,
222 LFUN_MENU_OPEN, // used in bindings as of 20060905
225 LFUN_COMMAND_EXECUTE,
228 LFUN_FILE_INSERT_PLAINTEXT, // CFO-G 1997-11-19
229 LFUN_FILE_INSERT_PLAINTEXT_PARA,// Levon 2001-02-14
230 LFUN_FILE_NEW, // for scripting purposes
232 LFUN_PARAGRAPH_UP, // Asger 1996-10-01
234 LFUN_PARAGRAPH_UP_SELECT, // Asger 1996-10-01
235 LFUN_PARAGRAPH_DOWN, // Asger 1996-10-01
236 LFUN_PARAGRAPH_DOWN_SELECT, // Asger 1996-10-01
237 LFUN_BREAK_PARAGRAPH_SKIP,
238 LFUN_DELETE_BACKWARD_SKIP,
240 LFUN_DELETE_FORWARD_SKIP,
241 LFUN_BUFFER_NEW_TEMPLATE, // Asger 1997-02-02
242 LFUN_BUFFER_RELOAD, // Asger 1997-02-02
243 LFUN_RECONFIGURE, // Asger 1997-02-14
244 LFUN_INDEX_PRINT, // Lgb 97-02-27
247 LFUN_BUFFER_CHILD_OPEN, // Ale 970528
248 LFUN_TOC_INSERT, // Lgb 97-05-27
249 LFUN_FLOAT_LIST, // Lgb 20010503
250 LFUN_BUFFER_TOGGLE_READ_ONLY, // Lgb 97-05-27
252 LFUN_VC_REGISTER, // Lgb 97-07-01
253 LFUN_VC_CHECK_IN, // Lgb 97-07-01
254 LFUN_VC_CHECK_OUT, // Lgb 97-07-01
255 LFUN_VC_REVERT, // Lgb 97-07-01
256 LFUN_VC_UNDO_LAST, // Lgb 97-07-01
258 LFUN_BUFFER_EXPORT, // Lgb 97-07-29
259 LFUN_LABEL_GOTO, // Ale 970806
260 LFUN_TOGGLE_CURSOR_FOLLOWS_SCROLLBAR, // ARRae 971202
261 LFUN_BUFFER_CHKTEX, // Asger 971030
262 LFUN_HYPERLINK_INSERT, // CFO-G 971121
264 LFUN_WORD_FIND_FORWARD, // Etienne 980216
265 LFUN_WORD_FIND_BACKWARD, // Etienne 980220
266 LFUN_APPENDIX, // ettrich 980505
267 LFUN_BUFFER_IMPORT, // Asger 980724
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,
339 * LFUN_PARAGRAPH_PARAMS_APPLY
340 * \li Action: Change paragraph settings.
341 * \li Notion: Overwrite all nonspecified settings to the default ones.
342 Use paragraph-params lfun if you don't want to overwrite others settings.
343 * \li Syntax: lfun-paragraph-params-apply [INDENT] [SPACING] [ALIGN] [OTHERS]
344 * \li Params: For parameters see lfun-paragraph-params lfun.
345 * \li Origin: leeming, 30 Mar 2004
347 LFUN_PARAGRAPH_UPDATE,
353 LFUN_NEWPAGE_INSERT, // uwestoehr 20071124
354 LFUN_PAGEBREAK_INSERT,
363 LFUN_BUFFER_EXPORT_CUSTOM,
365 LFUN_NEXT_INSET_TOGGLE,
366 LFUN_ALL_INSETS_TOGGLE,
367 LFUN_BUFFER_LANGUAGE,
369 LFUN_TEXTCLASS_APPLY,
371 LFUN_BUFFER_SAVE_AS_DEFAULT,
372 LFUN_BUFFER_PARAMS_APPLY,
378 LFUN_BUFFER_PREVIOUS,
381 LFUN_CHANGES_OUTPUT, // jspitzm 20050121
382 LFUN_BIBTEX_DATABASE_ADD,
383 LFUN_BIBTEX_DATABASE_DEL,
384 LFUN_CITATION_INSERT,
385 LFUN_OUTLINE_UP, // Vermeer 20060323
390 LFUN_PARAGRAPH_MOVE_DOWN, // Edwin 20060408
391 LFUN_PARAGRAPH_MOVE_UP, // Edwin 20060408
393 LFUN_BUFFER_TOGGLE_COMPRESSION, // bpeng 20060427
395 LFUN_CLIPBOARD_PASTE,
396 LFUN_INSET_DISSOLVE, // jspitzm 20060807
399 LFUN_WINDOW_NEW, // Abdel 20061021
400 LFUN_WINDOW_CLOSE, // Abdel 20061023
401 LFUN_UNICODE_INSERT, // Lgb 20061022
402 LFUN_BOOKMARK_CLEAR, // bpeng 20061031
403 LFUN_NOMENCL_INSERT, // Ugras
405 LFUN_NOMENCL_PRINT, // Ugras
406 LFUN_CLEARPAGE_INSERT, // Ugras 20061125
407 LFUN_CLEARDOUBLEPAGE_INSERT, // Ugras 20061125
408 LFUN_LISTING_INSERT, // Herbert 20011110, bpeng 20070502
409 LFUN_TOOLBAR_TOGGLE, // Edwin 20070521
411 LFUN_BUFFER_WRITE_ALL, // rgh, gpothier 200707XX
412 LFUN_PARAGRAPH_PARAMS,
414 * LFUN_PARAGRAPH_PARAMS
415 * \li Action: Change paragraph settings
416 * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
417 This function only modifies, and does not override, existing settings.
418 * \li Syntax: lfun_paragraph-params [INDENT] [SPACING] [ALIGN] [OTHERS]
419 * \li Params: INDENT: \\noindent|\\indent|\\indent-toggle|\\leftindent LENGTH\n
420 SPACING: \\paragraph_spacing default|single|onehalf|double|other\n
421 ALIGN: \\align block|left|right|center|default\n
422 OTHERS: \\labelwidthstring WIDTH|\\start_of_appendix\n
423 * \li Origin: rgh, Aug 15 2007
425 LFUN_LAYOUT_MODULES_CLEAR, // rgh, 20070825
426 LFUN_LAYOUT_MODULE_ADD, // rgh, 20070825
427 LFUN_LAYOUT_RELOAD, // rgh, 20070903
429 LFUN_MASTER_BUFFER_VIEW, // Tommaso, 20070920
430 LFUN_MASTER_BUFFER_UPDATE, // Tommaso, 20070920
431 LFUN_INFO_INSERT, // bpeng, 20071007
432 LFUN_CALL, // broider, 20071002
433 LFUN_BUFFER_TOGGLE_EMBEDDING, // bpeng, 20071021
435 LFUN_CHAR_LEFT, // dov, 20071022
436 LFUN_CHAR_LEFT_SELECT, // dov, 20071022
437 LFUN_CHAR_RIGHT, // dov, 20071022
438 LFUN_CHAR_RIGHT_SELECT, // dov, 20071022
439 LFUN_FINISHED_BACKWARD, // dov, 20071022
441 LFUN_FINISHED_FORWARD, // dov, 20071022
442 LFUN_WORD_LEFT, // dov, 20071028
443 LFUN_WORD_LEFT_SELECT, // dov, 20071028
444 LFUN_WORD_RIGHT, // dov, 20071028
445 LFUN_WORD_RIGHT_SELECT, // dov, 20071028
447 LFUN_MATH_MACRO_FOLD,
448 LFUN_MATH_MACRO_UNFOLD,
449 LFUN_MATH_MACRO_ADD_PARAM,
450 LFUN_MATH_MACRO_REMOVE_PARAM,
451 LFUN_MATH_MACRO_APPEND_GREEDY_PARAM,
453 LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM,
454 LFUN_MATH_MACRO_MAKE_OPTIONAL,
455 LFUN_MATH_MACRO_MAKE_NONOPTIONAL,
456 LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM,
457 LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM,
460 LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM,
461 LFUN_LASTACTION // end of the table