]> git.lyx.org Git - lyx.git/blob - src/LyXAction.cpp
4f424883f7a7e207932cbbe015bd0f05f842654e
[lyx.git] / src / LyXAction.cpp
1 /*!
2  * \file LyXAction.cpp
3  * This file is part of LyX, the document processor.
4  * Licence details can be found in the file COPYING.
5  *
6  * \author Lars Gullik Bjønnes
7  * \author Jean-Marc Lasgouttes
8  * \author John Levon
9  * \author André Pönitz
10  * \author Pavel Sanda
11  *
12  * Full author contact details are available in file CREDITS.
13  */
14
15 #include <config.h>
16
17 #include "LyXAction.h"
18
19 #include "FuncRequest.h"
20
21 #include "support/debug.h"
22 #include "support/lstrings.h"
23
24 #include "support/lassert.h"
25
26 #include <iostream>
27
28 using namespace std;
29 using namespace lyx::support;
30
31 namespace lyx {
32
33 /*
34      NAMING RULES FOR USER-COMMANDS
35      Here's the set of rules to apply when a new command name is introduced:
36
37      1) Use the object.event order. That is, use `word-forward'
38         instead of `forward-word'.
39      2) Don't introduce an alias for an already named object. Same for events.
40      3) Forward movement or focus is called `forward' (not `right').
41      4) Backward movement or focus is called `backward' (not `left').
42      5) Upward movement of focus is called `up'.
43      6) Downward movement is called `down'.
44      7) The begin of an object is called `begin' (not `start').
45      8) The end of an object is called `end'.
46
47      (May 19 1996, 12:04, RvdK)
48 */
49
50 /* LFUN documentation
51  *
52  * The documentation below primarily describes the purpose and syntax
53  * of the various LFUNs.
54  *
55  * The list is alphabetized. Try to keep it that way, and don't forget to add
56  * doxygen commentary. This allows the file LFUNs.lyx to be auto-generated.
57  * (If you should want to do that, see the gen_lfuns.py script, which is in
58  * the development/tools/ directory.)
59  *
60  * Doxygen template below. Some notes: Parameters should be set in uppercase
61  * and put in <BRACKETS>, [<PARAM>] means optional one.
62  *
63  * Use spaces for indentation (doxy -> .lyx generator is tab-sensitive).
64  */
65
66 /*!
67  * \var lyx::FuncCode lyx::LFUN_
68  * \li Action:
69  * \li Notion:
70  * \li Syntax:
71  * \li Params:
72  * \li Sample:
73  * \li Origin:
74  * \endvar
75  */
76
77 LyXAction lyxaction;
78
79
80 void LyXAction::newFunc(FuncCode action, string const & name,
81                         unsigned int attrib, LyXAction::FuncType type)
82 {
83         lyx_func_map[name] = action;
84         FuncInfo tmpinfo;
85         tmpinfo.name = name;
86         tmpinfo.attrib = attrib;
87         tmpinfo.type = type;
88         lyx_info_map[action] = tmpinfo;
89 }
90
91
92 // Needed for LFUNs documentation to be accepted, since doxygen won't take
93 // \var inside functions.
94 #ifndef DOXYGEN_SHOULD_SKIP_THIS
95 void LyXAction::init()
96 {
97         // This function was changed to use the array below in initalization
98         // instead of calling newFunc numerous times because of compilation
99         // times. Since the array is not static we get back the memory it
100         // occupies after the init is completed. It compiles several
101         // magnitudes faster.
102
103         static bool init;
104         if (init)
105                 return;
106
107         struct ev_item {
108                 FuncCode action;
109                 char const * name;
110                 unsigned int attrib;
111                 FuncType type;
112         };
113
114         ev_item const items[] = {
115 #endif
116
117 /*!
118  * \var lyx::FuncCode lyx::LFUN_ACCENT_ACUTE
119  * \li Action: Adds an acute accent \htmlonly (&aacute;)\endhtmlonly
120                to the next character typed.
121  * \li Syntax: accent-acute
122  * \endvar
123  */
124                 { LFUN_ACCENT_ACUTE, "accent-acute", Noop, Edit },
125
126 /*!
127  * \var lyx::FuncCode lyx::LFUN_ACCENT_BREVE
128  * \li Action: Adds a breve accent \htmlonly (&#259;)\endhtmlonly
129                to the next character typed.
130  * \li Syntax: accent-breve
131  * \endvar
132  */
133                 { LFUN_ACCENT_BREVE, "accent-breve", Noop, Edit },
134
135 /*!
136  * \var lyx::FuncCode lyx::LFUN_ACCENT_CARON
137  * \li Action: Adds a caron \htmlonly (&#462;)\endhtmlonly
138                to the next character typed.
139  * \li Syntax: accent-caron
140  * \endvar
141  */
142                 { LFUN_ACCENT_CARON, "accent-caron", Noop, Edit },
143
144 /*!
145  * \var lyx::FuncCode lyx::LFUN_ACCENT_CEDILLA
146  * \li Action: Adds a cedilla \htmlonly (&ccedil;)\endhtmlonly
147                to the next character typed.
148  * \li Syntax: accent-cedilla
149  * \endvar
150  */
151                 { LFUN_ACCENT_CEDILLA, "accent-cedilla", Noop, Edit },
152
153 /*!
154  * \var lyx::FuncCode lyx::LFUN_ACCENT_CIRCLE
155  * \li Action: Adds a circle accent \htmlonly (&aring;)\endhtmlonly
156                to the next character typed.
157  * \li Syntax: accent-circle
158  * \endvar
159  */
160                 { LFUN_ACCENT_CIRCLE, "accent-circle", Noop, Edit },
161
162 /*!
163  * \var lyx::FuncCode lyx::LFUN_ACCENT_CIRCUMFLEX
164  * \li Action: Adds a circumflex \htmlonly (&ecirc;)\endhtmlonly
165                to the next character typed.
166  * \li Syntax: accent-circumflex
167  * \endvar
168  */
169                 { LFUN_ACCENT_CIRCUMFLEX, "accent-circumflex", Noop, Edit },
170
171 /*!
172  * \var lyx::FuncCode lyx::LFUN_ACCENT_DOT
173  * \li Action: Adds a dot accent \htmlonly (&#380;)\endhtmlonly
174                to the next character typed.
175  * \li Syntax: accent-dot
176  * \endvar
177  */
178                 { LFUN_ACCENT_DOT, "accent-dot", Noop, Edit },
179
180 /*!
181  * \var lyx::FuncCode lyx::LFUN_ACCENT_GRAVE
182  * \li Action: Adds a grave accent \htmlonly (&egrave;)\endhtmlonly
183                to the next character typed.
184  * \li Syntax: accent-grave
185  * \endvar
186  */
187                 { LFUN_ACCENT_GRAVE, "accent-grave", Noop, Edit },
188
189 /*!
190  * \var lyx::FuncCode lyx::LFUN_ACCENT_HUNGARIAN_UMLAUT
191  * \li Action: Adds a Hungarian umlaut \htmlonly (&#337;)\endhtmlonly
192                to the next character typed.
193  * \li Syntax: accent-grave
194  * \endvar
195  */
196                 { LFUN_ACCENT_HUNGARIAN_UMLAUT, "accent-hungarian-umlaut", Noop, Edit },
197
198 /*!
199  * \var lyx::FuncCode lyx::LFUN_ACCENT_MACRON
200  * \li Action: Adds a macron \htmlonly (&#257;)\endhtmlonly
201                to the next character typed.
202  * \li Syntax: accent-macron
203  * \endvar
204  */
205                 { LFUN_ACCENT_MACRON, "accent-macron", Noop, Edit },
206
207 /*!
208  * \var lyx::FuncCode lyx::LFUN_ACCENT_OGONEK
209  * \li Action: Adds an ogonek accent \htmlonly (&#261;)\endhtmlonly
210                to the next character typed.
211  * \li Syntax: accent-ogonek
212  * \endvar
213  */
214                 { LFUN_ACCENT_OGONEK, "accent-ogonek", Noop, Edit },
215
216 /*!
217  * \var lyx::FuncCode lyx::LFUN_ACCENT_PERISPOMENI
218  * \li Action: Adds a perispomeni (Greek circumflex)
219                over the next character typed.
220  * \li Syntax: accent-perispomeni
221  * \endvar
222  */
223                 { LFUN_ACCENT_PERISPOMENI, "accent-perispomeni", Noop, Edit },
224
225 /*!
226  * \var lyx::FuncCode lyx::LFUN_ACCENT_TIE
227  * \li Action: Adds a tie \htmlonly (a&#865;)\endhtmlonly
228                over the next two character typed.
229  * \li Notion: The following char will finish the tie.
230  * \li Syntax: accent-tie
231  * \endvar
232  */
233                 { LFUN_ACCENT_TIE, "accent-tie", Noop, Edit },
234
235 /*!
236  * \var lyx::FuncCode lyx::LFUN_ACCENT_TILDE
237  * \li Action: Adds a tilde \htmlonly (&atilde;)\endhtmlonly
238                over the next character typed.
239  * \li Syntax: accent-tilde
240  * \endvar
241  */
242                 { LFUN_ACCENT_TILDE, "accent-tilde", Noop, Edit },
243
244 /*!
245  * \var lyx::FuncCode lyx::LFUN_ACCENT_UMLAUT
246  * \li Action: Adds an umlaut \htmlonly (&auml;)\endhtmlonly
247                over the next character typed.
248  * \li Syntax: accent-umlaut
249  * \endvar
250  */
251                 { LFUN_ACCENT_UMLAUT, "accent-umlaut", Noop, Edit },
252
253 /*!
254  * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERBAR
255  * \li Action: Adds a bar \htmlonly (a&#800;)\endhtmlonly
256                under the next character typed.
257  * \li Syntax: accent-underbar
258  * \endvar
259  */
260                 { LFUN_ACCENT_UNDERBAR, "accent-underbar", Noop, Edit },
261
262 /*!
263  * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERDOT
264  * \li Action: Adds a dot \htmlonly (&#7841;)\endhtmlonly
265                under the next character typed.
266  * \li Syntax: accent-underdot
267  * \endvar
268  */
269                 { LFUN_ACCENT_UNDERDOT, "accent-underdot", Noop, Edit },
270
271
272 /*!
273  * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_ACCEPT
274  * \li Action: Accepts all tracked changes in the document.
275  * \li Syntax: all-changes-accept
276  * \li Origin: Levon, 16 Oct 2002
277  * \endvar
278  */
279                 { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
280
281 /*!
282  * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_REJECT
283  * \li Action: Rejects all tracked changes in the document.
284  * \li Notion: Reject does not work recursively; the user may have to repeat the operation.
285  * \li Syntax: all-changes-reject
286  * \li Origin: Levon, 16 Oct 2002
287  * \endvar
288  */
289                 { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
290
291
292 /*!
293  * \var lyx::FuncCode lyx::LFUN_APPENDIX
294  * \li Action: Start (or remove) Appendix on the given cursor position.
295  * \li Syntax: appendix
296  * \li Origin: ettrich, 5 May 1998
297  * \endvar
298  */
299                 { LFUN_APPENDIX, "appendix", Noop, Edit },
300
301
302 /*!
303  * \var lyx::FuncCode lyx::LFUN_ARGUMENT_INSERT
304  * \li Action: Inserts an argument (short title) inset.
305  * \li Syntax: argument-insert <argument nr>
306  * \li Params: <argument nr>: see layout declarations
307  * \li Origin: vermeer, 12 Aug 2002
308  * \endvar
309  */
310                 { LFUN_ARGUMENT_INSERT, "argument-insert", Noop, Edit },
311
312 /*!
313  * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_ADD
314  * \li Action: Adds database, which will be used for bibtex citations.
315  * \li Notion: Databases are added to the first BibTeX inset
316                (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
317  * \li Syntax: bibtex-database-add <DATABASE-NAME>
318  * \li Origin: Ale, 30 May 1997
319  * \endvar
320  */
321                 { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit },
322
323 /*!
324  * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_DEL
325  * \li Action: Adds database, which will be used for bibtex citations.
326  * \li Notion: Databases are deleted from the first BibTeX inset
327                (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
328  * \li Syntax: bibtex-database-del <DATABASE-NAME>
329  * \li Origin: Ale, 30 May 1997
330  * \endvar
331  */
332                 { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
333
334
335 /*!
336  * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
337  * \li Action: Clears the list of saved bookmarks.
338  * \li Syntax: bookmark-clear
339  * \li Origin: bpeng, 31 October 2006
340  * \endvar
341  */
342                 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
343
344
345 /*!
346  * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
347  * \li Action: Moves the cursor to the numbered bookmark, opening the file
348                if necessary. Note that bookmarks are saved per-session, not
349                per file.
350  * \li Notion: Bookmark 0 has a special purpose. It is automatically set \n
351                1. to the paragraph you are currently editing \n
352                2. to the paragraph from where you are jumping to the last-edited
353                   position (jump-back feature) \n
354                3. when jumping from crossreference to the requested label by
355                   #LFUN_LABEL_GOTO.
356  * \li Syntax: bookmark-goto <NUMBER>
357  * \li Params: <NUMBER>: the number of the bookmark to restore.
358  * \li Origin: Dekel, 27 January 2001
359  * \endvar
360  */
361                 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
362
363 /*!
364  * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
365  * \li Action: Save a bookmark.
366  * \li Notion: Saves a numbered bookmark to the sessions file. The number
367                must be between 1 and 9, inclusive. Note that bookmarks are
368                saved per-session, not per file.
369  * \li Syntax: bookmark-save <NUMBER>
370  * \li Params: <NUMBER>: the number of the bookmark to save.
371  * \li Origin: Dekel, 27 January 2001
372  * \endvar
373  */
374                 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
375
376 /*!
377  * \var lyx::FuncCode lyx::LFUN_BOX_INSERT
378  * \li Action: Inserts Box inset.
379  * \li Syntax: box-insert [<TYPE>]
380  * \li Params: <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox \n
381                        Framed is the default one.
382  * \li Origin: vermeer, 7 Oct 2003
383  * \endvar
384  */
385                 { LFUN_BOX_INSERT, "box-insert", Noop, Edit },
386
387 /*!
388  * \var lyx::FuncCode lyx::LFUN_BRANCHES_RENAME
389  * \li Action: Rename all branches of a given name in a document.
390  * \li Syntax: branches-rename <OLDNAME> <NEWNAME>
391  * \li Params: <OLDNAME>: Current name of the branch to be renamed
392  *             <NEWNAME>: New name of the branch
393  * \li Origin: spitz, 9 Jul 2009
394  * \endvar
395  */
396                 { LFUN_BRANCHES_RENAME, "branches-rename", Noop, Buffer },
397
398 /*!
399  * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
400  * \li Action: Activate the branch.
401  * \li Syntax: branch-activate <BRANCH>
402  * \li Params: <BRANCH>: The branch to activate
403  * \li Sample: lyx -x "branch-activate answers" -e pdf2 finalexam.lyx \n
404                could be used to export a pdf with the answers branch included
405                without one's having to open LyX and activate the branch manually.
406  * \li Origin: rgh, 27 May 2008
407  * \endvar
408  */
409                 { LFUN_BRANCH_ACTIVATE, "branch-activate", AtPoint, Buffer },
410
411 /*!
412  * \var lyx::FuncCode lyx::LFUN_BRANCH_ADD
413  * \li Action: Add a branch to the buffer's BranchList.
414  * \li Syntax: branch-add <BRANCH>
415  * \li Params: <BRANCH>: Name of the branch to add
416  * \li Origin: spitz, 7 Jul 2009
417  * \endvar
418  */
419                 { LFUN_BRANCH_ADD, "branch-add", AtPoint, Buffer },
420
421
422
423 /*!
424  * \var lyx::FuncCode lyx::LFUN_BRANCH_ADD_INSERT
425  * \li Action: Create new branch and directly put the branch inset into
426                the document.
427  * \li Syntax: branch-add-insert [<NAME>]
428  * \li Params: <NAME>: Branch name. If it is not specified, you will be asked.
429  * \li Origin: sanda, 10 Jul 2009
430  * \endvar
431  */
432                 { LFUN_BRANCH_ADD_INSERT, "branch-add-insert", Noop, Buffer },
433
434
435
436 /*!
437  * \var lyx::FuncCode lyx::LFUN_BRANCH_DEACTIVATE
438  * \li Action: De-activate the branch.
439  * \li Syntax: branch-deactivate <BRANCH>
440  * \li Params: <BRANCH>: The branch to deactivate
441  * \li Origin: rgh, 27 May 2008
442  * \endvar
443  */
444                 { LFUN_BRANCH_DEACTIVATE, "branch-deactivate", AtPoint, Buffer },
445
446 /*!
447  * \var lyx::FuncCode lyx::LFUN_BRANCH_INSERT
448  * \li Action: Inserts branch inset.
449  * \li Syntax: branch-insert <BRANCH-NAME>
450  * \li Origin: vermeer, 17 Aug 2003
451  * \endvar
452  */
453                 { LFUN_BRANCH_INSERT, "branch-insert", Noop, Edit },
454
455 /*!
456  * \var lyx::FuncCode lyx::LFUN_BRANCH_INVERT
457  * \li Action: Toggles inversion status of branch inset.
458  * \li Syntax: branch-invert
459  * \li Origin: rgheck, 12 July 2016
460  * \endvar
461  */
462                 { LFUN_BRANCH_INVERT, "branch-invert", AtPoint, Buffer },
463
464
465 /*!
466  * \var lyx::FuncCode lyx::LFUN_BRANCH_MASTER_ACTIVATE
467  * \li Action: Activate the branch in the master buffer.
468  * \li Syntax: branch-master-activate <BRANCH>
469  * \li Params: <BRANCH>: The branch to activate
470  * \li Sample: lyx -x "branch-activate answers" -e pdf2 finalexam.lyx \n
471                could be used to export a pdf with the answers branch included
472                without one's having to open LyX and activate the branch manually.
473  * \li Origin: spitz, 30 Sep 2012
474  * \endvar
475  */
476                 { LFUN_BRANCH_MASTER_ACTIVATE, "branch-master-activate", AtPoint, Buffer },
477
478 /*!
479  * \var lyx::FuncCode lyx::LFUN_BRANCH_MASTER_DEACTIVATE
480  * \li Action: De-activate the branch in the master buffer.
481  * \li Syntax: branch-master-deactivate <BRANCH>
482  * \li Params: <BRANCH>: The branch to deactivate
483  * \li Origin: spitz, 30 Sep 2012
484  * \endvar
485  */
486                 { LFUN_BRANCH_MASTER_DEACTIVATE, "branch-master-deactivate", AtPoint, Buffer },
487
488
489 /*!
490  * \var lyx::FuncCode lyx::LFUN_BUFFER_ANONYMIZE
491  * \li Action: For debug purposes only. Convert all [a-zA-Z0-1] characters to
492                single character. Useful when submitting docs to list or bugzilla.
493  * \li Syntax: buffer-anonymize
494  * \li Origin: sanda, Feb 1 2018
495  * \endvar
496  */
497                 { LFUN_BUFFER_ANONYMIZE, "buffer-anonymize", Noop, Edit },
498
499
500 /*!
501  * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
502  * \li Action: Saves the current buffer to a temporary file.
503  * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
504                is called automatically by LyX, to "autosave" the current buffer.
505  * \li Syntax: buffer-auto-save
506  * \endvar
507  */
508                 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
509
510 /*!
511  * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN
512  * \li Action: Move the cursor to the beginning of the document.
513  * \li Syntax: buffer-begin
514  * \endvar
515  */
516                 { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
517
518 /*!
519  * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN_SELECT
520  * \li Action: Move the cursor to the beginning of the document adding the
521                traversed text to the selection.
522  * \li Syntax: buffer-begin-select
523  * \endvar
524  */
525                 { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
526
527 /*!
528  * \var lyx::FuncCode lyx::LFUN_BUFFER_CHILD_OPEN
529  * \li Action: Loads the given child document.
530  * \li Notion: The current document is treated as a parent.
531  * \li Syntax: buffer-child-open <FILE>
532  * \li Params: <FILE>: Filename of the child. The directory of the parent is assumed by default.
533  * \li Origin: Ale, 28 May 1997
534  * \endvar
535  */
536                 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
537
538 /*!
539  * \var lyx::FuncCode lyx::LFUN_BUFFER_CHKTEX
540  * \li Action: Runs chktex for the current document.
541  * \li Syntax: buffer-chktex
542  * \li Origin: Asger, 30 Oct 1997
543  * \endvar
544  */
545                 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
546
547 /*!
548  * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
549  * \li Action: Closes the current buffer.
550  * \li Notion: Closes the current buffer, asking whether to save it, etc,
551                if the buffer has been modified.
552  * \li Syntax: buffer-close
553  * \endvar
554  */
555                 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
556
557 /*!
558  * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE_ALL
559  * \li Action: Closes all buffers.
560  * \li Notion: Closes all buffers, asking whether to save it, etc,
561                if a buffer has been modified.
562  * \li Syntax: buffer-close-all
563  * \endvar
564  */
565                 { LFUN_BUFFER_CLOSE_ALL, "buffer-close-all", ReadOnly, Buffer },
566
567 /*!
568  * \var lyx::FuncCode lyx::LFUN_BUFFER_END
569  * \li Action: Move the cursor to the end of the document.
570  * \li Syntax: buffer-end
571  * \endvar
572  */
573                 { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
574
575 /*!
576  * \var lyx::FuncCode lyx::LFUN_BUFFER_END_SELECT
577  * \li Action: Move the cursor to the end of the document adding the
578                traversed text to the selection.
579  * \li Syntax: buffer-end-select
580  * \endvar
581  */
582                 { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
583
584
585 /*!
586  * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
587  * \li Action: Exports the current buffer (document) to the given format.
588  * \li Syntax: buffer-export [<FORMAT>] [<DEST>]
589  * \li Params: <FORMAT> is either "custom" or one of the formats which you
590                         can find in Tools->Preferences->File formats->Format.
591                         Usual format you will enter is "pdf2" (pdflatex),
592                         "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
593                         In case of "custom" you will be asked for a format you
594                         want to start from and for the command that you want to
595                         apply to this format. Internally the control is then passed
596                         to #LFUN_BUFFER_EXPORT_CUSTOM.\n
597                         If absent or "default", then the default output format of the
598                         document is used.\n
599                <DEST>   If present, this argument provides the export destination
600                         filename. Its containing folder will also be the destination
601                         folder, where all the needed external files will be copied.
602  * \li Origin: Lgb, 29 Jul 1997
603  * \endvar
604  */
605                 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
606
607 /*!
608  * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_AS
609  * \li Action: Opens a dialog for exporting the current buffer.
610  * \li Syntax: buffer-export-as [<FORMAT>]
611  * \li Params: <FORMAT> is the export format initially selected in the dialog.
612  *                      You can pass any of the formats which you can find in
613  *                      Tools->Preferences->File formats->Format, provided it
614  *                      has the "document" flag set. If no format is specified
615  *                      the dialog will start with the default output format of
616  *                      the current document.
617  * \li Sample: buffer-export-as pdf2
618  * \li Origin: tommaso, 6 Oct 2011
619  * \endvar
620  */
621                 { LFUN_BUFFER_EXPORT_AS, "buffer-export-as", ReadOnly, Buffer },
622
623 /*!
624  * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
625  * \li Action: Exports the current buffer (document) from the given format using
626                the given command on it.
627  * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
628  * \li Params: <FORMAT> format to start from (LyX will care to produce such
629                         intermediate file).\n
630                <COMMAND> this command will be launched on the file. Note that you can
631                          use "$$FName" string to qualify the intermediate file.
632  * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
633  * \li Origin: leeming, 27 Mar 2004
634  * \endvar
635  */
636                 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
637
638 /*!
639  * \var lyx::FuncCode lyx::LFUN_BUFFER_FORALL
640  * \li Action: Applies a command to all non-hidden buffers.
641  * \li Notion: a buffer is `hidden' if it is internally open in LyX, but not
642                visible in any window.
643  * \li Syntax: buffer-forall <LFUN-COMMAND>
644  * \li Params: <LFUN-COMMAND>: The command to be applied to the buffers.
645  * \li Sample: Close all Notes in buffers: \n
646                buffer-forall inset-forall Note inset-toggle close \n
647                Toggle change tracking on buffers: \n
648                buffer-forall changes-track \n
649                Toggle read-only for buffers: \n
650                buffer-forall buffer-toggle-read-only \n
651                Show statistics for individual buffers: \n
652                buffer-forall statistics \n
653                Activate the branch named "Solutions" in buffers: \n
654                buffer-forall branch-activate Solutions \n
655                Export buffers to PDF (pdflatex): \n
656                buffer-forall buffer-export pdf2 \n
657  * \li Origin: skostysh, 20 Jul 2012
658  * \endvar
659  */
660                 { LFUN_BUFFER_FORALL, "buffer-forall", ReadOnly | Argument, Buffer },
661
662 /*!
663  * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
664  * \li Action: Import a given file as a lyx document.
665  * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
666                defined converters in preferences. Look in the File->Import menu to get
667                an idea of the currently active import formats.
668  * \li Syntax: buffer-import <FORMAT> [<FILE>]
669  * \li Origin: Asger, 24 Jul 1998
670  * \endvar
671  */
672                 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
673
674 /*!
675  * \var lyx::FuncCode lyx::LFUN_BUFFER_LANGUAGE
676  * \li Action: Set language of the current document.
677  * \li Syntax: buffer-language <LANG>
678  * \li Params: <LANG>: language name. See lib/languages for list.
679  * \li Origin: leeming, 30 Mar 2004
680  * \endvar
681  */
682                 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
683
684 /*!
685  * \var lyx::FuncCode lyx::LFUN_BUFFER_MOVE_NEXT
686  * \li Action: Moves the current tab one spot to the right.
687  * \li Syntax: buffer-move-next
688  * \li Origin: skostysh, 7 Apr 2015
689  * \endvar
690  */
691                 { LFUN_BUFFER_MOVE_NEXT, "buffer-move-next", ReadOnly, Buffer },
692
693 /*!
694  * \var lyx::FuncCode lyx::LFUN_BUFFER_MOVE_PREVIOUS
695  * \li Action: Moves the current tab one spot to the left.
696  * \li Syntax: buffer-move-previous
697  * \li Origin: skostysh, 7 Apr 2015
698  * \endvar
699  */
700                 { LFUN_BUFFER_MOVE_PREVIOUS, "buffer-move-previous", ReadOnly, Buffer },
701
702 /*!
703  * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
704  * \li Action: Creates a new buffer (that is, document) and switches to it.
705  * \li Notion: Implicit path can be set in Preferences dialog.
706  * \li Syntax: buffer-new [<FILE>]
707  * \li Params: <FILE>: filename of created file with absolute path.
708  * \endvar
709  */
710                 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
711
712 /*!
713  * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
714  * \li Action: Creates a new buffer (that is, document) from a template.
715  * \li Notion: Path for new files and templates can be set in Preferences dialog.
716                Template will be asked for via Open-dialog.
717  * \li Syntax: buffer-new-template [<FILE>]
718  * \li Params: <FILE>: filename of created file with absolute path.
719  * \endvar
720  */
721                 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
722
723 /*!
724  * \var lyx::FuncCode lyx::LFUN_BUFFER_NEXT
725  * \li Action: Switch to the next opened document.
726  * \li Notion: Note that this does not necessarily mean next in tabbar
727                (for full list see View menu).
728  * \li Syntax: buffer-next
729  * \endvar
730  */
731                 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
732
733 /*!
734  * \var lyx::FuncCode lyx::LFUN_BUFFER_PARAMS_APPLY
735  * \li Action: Apply the given settings to the current document.
736  * \li Syntax: buffer-params-apply [<ARGS>]
737  * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
738                        you can find in document header of usual .lyx file.
739  * \li Origin: leeming, 30 Mar 2004
740  * \endvar
741  */
742                 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", NoInternal, Buffer },
743
744
745 /*!
746  * \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS
747  * \li Action: Switch to the previous opened document.
748  * \li Syntax: buffer-previous
749  * \endvar
750  */
751                 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
752
753 /*!
754  * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
755  * \li Action: Reverts opened document.
756  * \li Syntax: buffer-reload [dump]
757  * \li Params: dump: do not ask for any confirmation, just reload. All changes will be lost.
758  * \li Origin: Asger, 2 Feb 1997
759  * \endvar
760  */
761                 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
762
763 /*!
764  * \var lyx::FuncCode lyx::LFUN_BUFFER_SAVE_AS_DEFAULT
765  * \li Action: Save the current document settings as default.
766  * \li Notion: The file will will be saved into ~/.lyx/templates/defaults.lyx .
767  * \li Syntax: buffer-save-as-default [<ARGS>]
768  * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
769                        you can find in document header of usual .lyx file.
770  * \li Origin: leeming, 30 Mar 2004
771  * \endvar
772  */
773                 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
774
775 /*!
776  * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
777  * \li Action: Display and switch to the given buffer.
778  * \li Syntax: buffer-switch <BUFFER>
779  * \li Params: <BUFFER>: path and filename of already opened (but possibly hidden)
780                          document which is to be shown.
781  * \endvar
782  */
783                 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
784
785 /*!
786  * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
787  * \li Action: Toggles compression of the current document on/off.
788  * \li Syntax: buffer-toggle-compression
789  * \li Origin: bpeng, 27 Apr 2006
790  * \endvar
791  */
792                 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
793
794 /*!
795  * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_OUTPUT_SYNC
796  * \li Action: Toggles including of resources for forward/reverse search of the given document.
797  * \li Notion: When toggled on, SyncTeX is invoked for PDF, while srcltx package
798                is used for DVI. Custom LaTeX macro can be defined in preferences.
799  * \li Syntax: buffer-toggle-output-sync
800  * \li Origin: sanda, 25 May 2010
801  * \endvar
802  */
803                 { LFUN_BUFFER_TOGGLE_OUTPUT_SYNC, "buffer-toggle-output-sync", Noop, System },
804
805 /*!
806  * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
807  * \li Action: Toggle editing mode of the current document between read/write and read-only.
808  * \li Notion: This function is not allowed if the file is under version control, since
809                read-only flag is often used in version control file locking.
810  * \li Syntax: buffer-toggle-read-only
811  * \li Origin: Lgb, 27 May 1997
812  * \endvar
813  */
814                 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
815
816 /*!
817  * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
818  * \li Action: Exports the current document and put the result into the
819                temporary directory.
820  * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
821                the output will be rewritten - updated. This is useful in case your viewer
822                is able to detect such changes (e.g. ghostview for postscript).
823  * \li Syntax: buffer-update [<FORMAT>]
824  * \li Params: <FORMAT>: The format to display, where this is one of the
825                          formats defined (in the current GUI) in the
826                          Tools>Preferences>File Formats dialog.
827                          If no format is given, the default format as
828                          specified in the same dialog is used.
829  * \li Origin: Dekel, 5 Aug 2000
830  * \endvar
831  */
832                 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
833
834
835 /*!
836  * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
837  * \li Action: Displays current buffer in chosen format.
838  * \li Notion: Displays the contents of the current buffer in the chosen
839                format, for example, PDF or DVI. This runs the necessary
840                converter, calls the defined viewer, and so forth.
841  * \li Syntax: buffer-view [<FORMAT>]
842  * \li Params: <FORMAT>: The format to display, where this is one of the
843                          formats defined (in the current GUI) in the
844                          Tools>Preferences>File Formats dialog.
845                          If no format is given, the default format as
846                          specified in the same dialog is used.
847  * \endvar
848  */
849                 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
850
851 /*!
852  * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW_CACHE
853  * \li Action: Opens the file that was created from last preview of this buffer.
854  * \li Notion: This LFUN is called by the "Show Output Anyway" button in the LaTeX
855  *             Errors dialog. It can also be called by the user, which is useful
856  *             if the document takes a long time to compile, and you just
857  *             want to see the last previewed version.
858  * \li Syntax: buffer-view-cache
859  * \endvar
860  */
861                 { LFUN_BUFFER_VIEW_CACHE, "buffer-view-cache", ReadOnly, Buffer },
862
863 /*!
864  * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
865  * \li Action: Saves the current buffer.
866  * \li Notion: Saves the current buffer to disk, using the filename that
867                is already associated with the buffer, asking for one if
868                none is yet assigned.
869  * \li Syntax: buffer-write
870  * \endvar
871  */
872                 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
873
874 /*!
875  * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
876  * \li Action: Save all changed documents.
877  * \li Syntax: buffer-write-all
878  * \li Origin: rgh, gpothier 6 Aug 2007
879  * \endvar
880  */
881                 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
882
883 /*!
884  * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
885  * \li Action: Rename and save current buffer.
886  * \li Syntax: buffer-write-as <FILENAME>
887  * \li Params: <FILENAME>: New name of the buffer/file. A relative path
888                is with respect to the original location of the buffer/file.
889  * \endvar
890  */
891                 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
892
893 /*!
894  * \var lyx::FuncCode lyx::LFUN_BUFFER_EXTERNAL_MODIFICATION_CLEAR
895  * \li Action: Clear the external modification flag on the current buffer.
896  * \li Syntax: buffer-external-modification-clear
897  * \li Origin: gm, 2 March 2017
898  * \endvar
899  */
900                 { LFUN_BUFFER_EXTERNAL_MODIFICATION_CLEAR,
901                   "buffer-external-modification-clear", ReadOnly, Buffer },
902
903 /*!
904 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM
905 * \li Action: Sets the zoom of the screen fonts.
906 * \li Syntax: buffer-zoom [<ZOOM>]
907 * \li Params: <ZOOM>: The target zoom value in %;
908 *                     the default is the default zoom as saved in preferences.
909 * \li Origin: daniel, 28 Oct 2016
910 * \endvar
911 */
912                 { LFUN_BUFFER_ZOOM, "buffer-zoom", ReadOnly, Buffer },
913
914 /*!
915  * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_IN
916  * \li Action: Increases the zoom of the screen fonts.
917  * \li Syntax: buffer-zoom-in [<ZOOM>]
918  * \li Params: <ZOOM>: The zoom value addition in % (neg. or pos.);
919  *                     the default is 10% of the default zoom as saved in preferences.
920  * \li Origin: vfr, 30 Mar 2009
921  * \endvar
922  */
923                 { LFUN_BUFFER_ZOOM_IN, "buffer-zoom-in", ReadOnly, Buffer },
924
925
926 /*!
927  * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_OUT
928  * \li Action: Decreases the zoom of the screen fonts.
929  * \li Syntax: buffer-zoom-out [<ZOOM>]
930  * \li Params: <ZOOM>: The zoom value abstraction in % (neg. or pos.);
931  *                     the default is 10% of the default zoom as saved in preferences.
932  * \li Origin: vfr, 30 Mar 2009
933  * \endvar
934  */
935                 { LFUN_BUFFER_ZOOM_OUT, "buffer-zoom-out", ReadOnly, Buffer },
936
937
938 /*!
939  * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
940  * \li Action: Generates the code (literate programming).
941  * \li Notion: Latex file with extension \literate_extension is generated.
942                Then LyX invokes \build_command (with a default of ``make'') to generate the code and
943                \build_error_filter to process the compilation error messages. \n
944                In case you want to process your literate file with a script, or some other program,
945                just insert in your lyxrc file an entry with:\n
946                \build_command "my_script my_arguments" \n
947                The \build_error_filter differs from the \literate_error_filter only in that the
948                former will identify error messages from your compiler.
949  * \li Syntax: build-program
950  * \endvar
951  */
952                 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
953
954
955 /*!
956  * \var lyx::FuncCode lyx::LFUN_CALL
957  * \li Action: Executes a command defined in a .def file.
958  * \li Notion: The definitions are by default read from lib/commands/default.def.\n
959                A .def file allows to define a command with \define "<NAME>" "<LFUN>"
960                where <NAME> is the name of the new command and <LFUN> is the lfun code
961                to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
962                \def_file "FileName" allows to include another .def file. \n
963                This is particularly useful in connection with toolbar buttons:
964                Since the name of the button image for this lfun is
965                lib/images/commands/<NAME>.png this is the way to assign an image
966                to a complex command-sequence.
967  * \li Syntax: call <NAME>
968  * \li Params: <NAME>: Name of the command that must be called.
969  * \li Origin: broider, 2 Oct 2007
970  * \endvar
971  */
972                 { LFUN_CALL, "call", NoBuffer, System },
973
974 /*!
975  * \var lyx::FuncCode lyx::LFUN_CANCEL
976  * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
977  * \li Syntax: cancel
978  * \endvar
979  */
980                 { LFUN_CANCEL, "cancel", NoBuffer, System },
981
982
983 /*!
984  * \var lyx::FuncCode lyx::LFUN_CAPTION_INSERT
985  * \li Action: Inserts a caption inset.
986  * \li Syntax: caption-insert
987  * \li Origin: Lgb, 18 Jul 2000
988  * \endvar
989  */
990                 { LFUN_CAPTION_INSERT, "caption-insert", Noop, Edit },
991
992 /*!
993  * \var lyx::FuncCode lyx::LFUN_CELL_BACKWARD
994  * \li Action: Moves the cursor to the previous cell inside the table.
995  * \li Syntax: cell-backward
996  * \li Origin: Jug, 22 May 2000
997  * \endvar
998  */
999                 { LFUN_CELL_BACKWARD, "cell-backward", ReadOnly | NoUpdate, Edit },
1000
1001 /*!
1002  * \var lyx::FuncCode lyx::LFUN_CELL_FORWARD
1003  * \li Action: Moves the cursor to the next cell inside the table.
1004  * \li Syntax: cell-forward
1005  * \endvar
1006  */
1007                 { LFUN_CELL_FORWARD, "cell-forward", ReadOnly | NoUpdate, Edit },
1008
1009 /*!
1010  * \var lyx::FuncCode lyx::LFUN_CELL_SPLIT
1011  * \li Action: Splits cell and shifts right part to the next cell (inside the math grid).
1012  * \li Syntax: cell-split
1013  * \li Origin: Ale, 15 May 1997
1014  * \endvar
1015  */
1016                 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
1017
1018
1019 /*!
1020  * \var lyx::FuncCode lyx::LFUN_CHANGES_MERGE
1021  * \li Action: Open change tracking dialog for merging and moves the cursor
1022                to the position of the next change.
1023  * \li Syntax: changes-merge
1024  * \li Origin: Levon, 16 Oct 2002
1025  * \endvar
1026  */
1027                 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
1028
1029 /*!
1030  * \var lyx::FuncCode lyx::LFUN_CHANGES_OUTPUT
1031  * \li Action: Toggles showing of change tracking in typeset output.
1032  * \li Syntax: changes-output
1033  * \li Origin: spitz, 21 Jan 2005
1034  * \endvar
1035  */
1036                 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
1037
1038 /*!
1039  * \var lyx::FuncCode lyx::LFUN_CHANGES_TRACK
1040  * \li Action: Toggles change tracking to on/off.
1041  * \li Syntax: changes-track
1042  * \li Origin: levon, 1 Oct 2002
1043  * \endvar
1044  */
1045                 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
1046
1047 /*!
1048  * \var lyx::FuncCode lyx::LFUN_CHANGE_ACCEPT
1049  * \li Action: Accepts tracked change inside the selection.
1050  * \li Syntax: change-accept
1051  * \li Origin: Levon, 16 Oct 2002
1052  * \endvar
1053  */
1054                 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
1055
1056 /*!
1057  * \var lyx::FuncCode lyx::LFUN_CHANGE_NEXT
1058  * \li Action: Moves the cursor to the position of the next change
1059                of the change tracking records.
1060  * \li Syntax: change-next
1061  * \li Origin: schmitt, 4 Oct 2006
1062  * \endvar
1063  */
1064                 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
1065
1066 /*!
1067  * \var lyx::FuncCode lyx::LFUN_CHANGE_PREVIOUS
1068  * \li Action: Moves the cursor to the position of the previous change
1069                of the change tracking records.
1070  * \li Syntax: change-previous
1071  * \li Origin: vfr, 4 Apr 2009
1072  * \endvar
1073  */
1074                 { LFUN_CHANGE_PREVIOUS, "change-previous", ReadOnly, Edit },
1075
1076 /*!
1077  * \var lyx::FuncCode lyx::LFUN_CHANGE_REJECT
1078  * \li Action: Rejects tracked change inside the selection.
1079  * \li Syntax: change-reject
1080  * \li Origin: Levon, 16 Oct 2002
1081  * \endvar
1082  */
1083                 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
1084
1085 /*!
1086  * \var lyx::FuncCode lyx::LFUN_CHARS_TRANSPOSE
1087  * \li Action: Transposes the character at the cursor with the one before it.
1088  * \li Syntax: chars-transpose
1089  * \li Origin: Lgb, 25 Apr 2001
1090  * \endvar
1091  */
1092                 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
1093
1094
1095 /*!
1096  * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD
1097  * \li Action: Moves the cursor one position logically backwards.
1098  * \li Notion: This is not the action which should be bound to the arrow keys,
1099                because backwards may be left or right, depending on the
1100                language. The arrow keys should be bound to #LFUN_CHAR_LEFT or
1101                #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
1102  * \li Syntax: char-backward
1103  * \endvar
1104  */
1105                 { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit },
1106
1107 /*!
1108  * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD_SELECT
1109  * \li Action: Moves the cursor one position logically backwards, adding
1110                traversed position to the selection.
1111  * \li Notion: See also #LFUN_CHAR_BACKWARD.
1112  * \li Syntax: char-backward-select
1113  * \endvar
1114  */
1115                 { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit },
1116
1117 /*!
1118  * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_BACKWARD
1119  * \li Action: Deletes one character in the backward direction (usually the "BackSpace" key).
1120  * \li Syntax: char-delete-backward [force]
1121  * \li Params: force: Delete big insets, do not only select them.
1122  * \endvar
1123  */
1124                 { LFUN_CHAR_DELETE_BACKWARD, "char-delete-backward", SingleParUpdate, Edit },
1125
1126 /*!
1127  * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_FORWARD
1128  * \li Action: Deletes one character in the backward direction (usually the "Delete" key).
1129  * \li Syntax: char-delete-forward [force]
1130  * \li Params: force: Delete big insets, do not only select them.
1131  * \endvar
1132  */
1133                 { LFUN_CHAR_DELETE_FORWARD, "char-delete-forward", SingleParUpdate, Edit },
1134
1135 /*!
1136  * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD
1137  * \li Action: Moves the cursor one position logically forward.
1138  * \li Notion: This is not the action which should be bound to the arrow keys,
1139                because forward may be left or right, depending on the language.
1140                The arrow keys should be bound to #LFUN_CHAR_LEFT or
1141                #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
1142  * \li Syntax: char-forward
1143  * \endvar
1144  */
1145                 { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit },
1146
1147 /*!
1148  * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD_SELECT
1149  * \li Action: Moves the cursor one position logically forward, adding
1150                traversed position to the selection.
1151  * \li Notion: See also #LFUN_CHAR_FORWARD.
1152  * \li Syntax: char-forward-select
1153  * \endvar
1154  */
1155                 { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit },
1156
1157 /*!
1158  * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT
1159  * \li Action: Moves the cursor one position "to the left".
1160  * \li Notion: This is the action which should be taken when the "left" key
1161                is pressed. Generally, it moves the cursor one position to the
1162                left. However, in Bidi text this become slightly more
1163                complicated, and there are different modes of cursor movement.
1164                In "visual mode", this moves left, plain and simple. In "logical
1165                mode", movement is logically forward in RTL paragraphs, and
1166                logically backwards in LTR paragraphs.
1167  * \li Syntax: char-left
1168  * \endvar
1169  */
1170                 { LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit },
1171
1172 /*!
1173  * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT_SELECT
1174  * \li Action: Moves the cursor one position "to the left", adding
1175                traversed position to the selection.
1176  * \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement.
1177  * \li Syntax: char-left-select
1178  * \endvar
1179  */
1180                 { LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit },
1181
1182 /*!
1183  * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT
1184  * \li Action: Moves the cursor one position "to the right".
1185  * \li Notion: This is the action which should be taken when the "right" key
1186                is pressed. Generally, it moves the cursor one position to the
1187                right. However, in Bidi text this become slightly more
1188                complicated, and there are different modes of cursor movement.
1189                In "visual mode", this moves right, plain and simple. In "logical
1190                mode", movement is logically forward in LTR paragraphs, and
1191                logically backwards in RTL paragraphs.
1192  * \li Syntax: char-right
1193  * \endvar
1194  */
1195                 { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit },
1196
1197 /*!
1198  * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT_SELECT
1199  * \li Action: Moves the cursor one position "to the right", adding
1200                traversed position to the selection.
1201  * \li Notion: See also #LFUN_CHAR_RIGHT for exact details of the movement.
1202  * \li Syntax: char-right-select
1203  * \endvar
1204  */
1205                 { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit },
1206
1207
1208 /*!
1209  * \var lyx::FuncCode lyx::LFUN_CITATION_INSERT
1210  * \li Action: Inserts citation from loaded citation database.
1211  * \li Syntax: citation-insert [<KEY>[|<TEXT_BEFORE>]]
1212  * \li Params: <KEY>: Citation (shortcut listed in available citations). \n
1213                <TEXT_BEFORE>: text which should appear before citation.
1214  * \li Origin: AAS, 97-02-23
1215  * \endvar
1216  */
1217                 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
1218
1219 /*!
1220  * \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE
1221  * \li Action: Pastes text from the active clipboard (retains formatting if the
1222                clipboard contains formatted text). Pastes plain text if plain text is
1223                on the clipboard, but tries to interpret it in special ways for certain
1224                insets, e.g. converting csv data to rows and columns if the paste happens
1225                in a tabular inset.
1226  * \li Notion: Historically, LFUN_CLIPBOARD_PASTE was introduced as a counterpart of
1227                LFUN_PRIMARY_SELECTION_PASTE: It behaved exactly the same, but the source
1228                is the clipboard, not the selection.
1229  * \li Syntax: clipboard-paste [<ARG>]
1230  * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1231  * \li Origin: Georg, 10 Jul 2006
1232  * \endvar
1233  */
1234                 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
1235
1236 /*!
1237  * \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE_SIMPLE
1238  * \li Action: Pastes plain text from the active clipboard even if formatted
1239                LyX content is in the clipboard. Pastes plain text if plain text
1240                is on the clipboard, without trying to interpret it in special
1241                ways for certain insets, e.g. converting csv data to rows and
1242                columns if the paste happens in a tabular inset.
1243  * \li Syntax: clipboard-paste-simple [<ARG>]
1244  * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1245  * \endvar
1246  */
1247                 { LFUN_CLIPBOARD_PASTE_SIMPLE, "clipboard-paste-simple", Noop, Edit },
1248
1249 /*!
1250  * \var lyx::FuncCode lyx::LFUN_COMMAND_ALTERNATIVES
1251  * \li Action: Runs the first listed command that is enabled.
1252  * \li Notion: This can be used to bind multiple functions to a single key,
1253                and then which one is used will depend upon the context.
1254  * \li Syntax: command-alternatives <CMDS>
1255  * \li Params: <CMDS>: Sequence of commands separated by semicolons.
1256  * \li Sample: command-alternatives completion-accept;cell-forward
1257  * \li Origin: rgh, 24 September 2008
1258  * \endvar
1259  */
1260                 { LFUN_COMMAND_ALTERNATIVES, "command-alternatives", NoBuffer, System },
1261
1262 /*!
1263  * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
1264  * \li Action: Switches the focus to the minibuffer so that the user can type
1265                in there. If necessary, it opens the minibuffer toolbar.
1266  * \li Notion: Usually bound to M-x shortcut.
1267  * \li Syntax: command-execute
1268  * \endvar
1269  */
1270                 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
1271
1272
1273 /*!
1274  * \var lyx::FuncCode lyx::LFUN_COMMAND_PREFIX
1275  * \li Action: Return the current key sequence and available options as a string.
1276  * \li Notion: No options are added if no current map exists. \n
1277                This is probably usable only with connection to lyxserver.
1278  * \li Syntax: command-prefix
1279  * \endvar
1280  */
1281                 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
1282
1283 /*!
1284  * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
1285  * \li Action: Run more commands (LFUN and its parameters) in a sequence.
1286  * \li Syntax: command-sequence <CMDS>
1287  * \li Params: <CMDS>: Sequence of commands separated by semicolons.
1288  * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
1289  * \li Origin: Andre, 11 Nov 1999
1290  * \endvar
1291  */
1292                 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
1293
1294 /*!
1295  * \var lyx::FuncCode lyx::LFUN_COMPLETE
1296  * \li Action: Try to complete the word or command at the cursor position.
1297  * \li Syntax: complete
1298  * \li Origin: sts, Feb 19 2008
1299  * \endvar
1300  */
1301                 { LFUN_COMPLETE, "complete", SingleParUpdate, Edit },
1302
1303
1304 /*!
1305  * \var lyx::FuncCode lyx::LFUN_COMPLETION_ACCEPT
1306  * \li Action: Accept suggested completion.
1307  * \li Syntax: completion-accept
1308  * \li Origin: sanda, Sep 08 2008
1309  * \endvar
1310  */
1311                 { LFUN_COMPLETION_ACCEPT, "completion-accept", SingleParUpdate, Edit },
1312
1313
1314
1315 /*!
1316  * \var lyx::FuncCode lyx::LFUN_COMPLETION_CANCEL
1317  * \li Action: Try to cancel completion, either the popup or the inline completion.
1318  * \li Syntax: completion-cancel
1319  * \li Origin: sts, Sep 07 2008
1320  * \endvar
1321  */
1322                 { LFUN_COMPLETION_CANCEL, "completion-cancel", SingleParUpdate, Edit },
1323
1324 /*!
1325  * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
1326  * \li Action: Show the inline completion at the cursor position.
1327  * \li Syntax: completion-inline
1328  * \li Origin: sts, Feb 19 2008
1329  * \endvar
1330  */
1331                 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
1332
1333 /*!
1334  * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
1335  * \li Action: Show the completion popup at the cursor position.
1336  * \li Syntax: completion-popup
1337  * \li Origin: sts, Feb 19 2008
1338  * \endvar
1339  */
1340                 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
1341
1342 /*!
1343  * \var lyx::FuncCode lyx::LFUN_COPY
1344  * \li Action: Copies the current selection to the clipboard.
1345  * \li Syntax: copy
1346  * \endvar
1347  */
1348                 { LFUN_COPY, "copy", ReadOnly, Edit },
1349
1350 /*!
1351  * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
1352  * \li Action: Determine whether to keep cursor inside the editing window regardless
1353                of the scrollbar movement.
1354  * \li Syntax: toggle-cursor-follows-scrollbar
1355  * \li Origin: ARRae, 2 Dec 1997
1356  * \endvar
1357  */
1358                 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
1359
1360 /*!
1361  * \var lyx::FuncCode lyx::LFUN_CUT
1362  * \li Action: Cuts to the clipboard.
1363  * \li Syntax: cut
1364  * \endvar
1365  */
1366                 { LFUN_CUT, "cut", Noop, Edit },
1367
1368 /*!
1369  * \var lyx::FuncCode lyx::LFUN_DATE_INSERT
1370  * \li Action: Inserts the current date.
1371  * \li Syntax: date-insert [<ARG>]
1372  * \li Params: <ARG>: Format of date. The default value (%x) can be set
1373                       in Preferences->Output->General->Date format. For
1374                       possible formats see the manual page of the
1375                       strftime function.
1376  * \li Origin: jdblair, 31 Jan 2000
1377  * \endvar
1378  */
1379                 { LFUN_DATE_INSERT, "date-insert", Noop, Edit },
1380
1381 /*!
1382  * \var lyx::FuncCode lyx::LFUN_DEBUG_LEVEL_SET
1383  * \li Action: Set debug output level.
1384  * \li Syntax: debug-level-set <LEVEL>
1385  * \li Params: <LEVEL>: comma separated list of levels or the correspondent number
1386                         of their combination. 0 is equivalent to disabling all debug
1387                         events. See lyx -dbg for the current list of debug levels
1388                         and their numbers.
1389  * \li Origin: sanda, 28 Dec 2009
1390  * \endvar
1391  */
1392                 { LFUN_DEBUG_LEVEL_SET, "debug-level-set", NoBuffer, System },
1393
1394
1395 /*!
1396  * \var lyx::FuncCode lyx::LFUN_DEPTH_DECREMENT
1397  * \li Action: Decrease the nesting depth of the (selected) paragraph(s)
1398                inside lists.
1399  * \li Syntax: depth-decrement
1400  * \endvar
1401  */
1402                 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
1403
1404 /*!
1405  * \var lyx::FuncCode lyx::LFUN_DEPTH_INCREMENT
1406  * \li Action: Increase the nesting depth of the (selected) paragraph(s)
1407                inside lists.
1408  * \li Syntax: depth-increment
1409  * \endvar
1410  */
1411                 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
1412
1413
1414 /*!
1415  * \var lyx::FuncCode lyx::LFUN_DEVEL_MODE_TOGGLE
1416  * \li Action: toggle a mode where more information is given in UI
1417  * \li Syntax: devel-mode-toggle
1418  * \li Notion: in so called "devel" mode, the information given in the
1419  *             status bar is more precise, and the help documents are
1420  *             open in editing mode.
1421  * \li Origin: lasgouttes, 23 Jul 2017
1422  * \endvar
1423  */
1424                 { LFUN_DEVEL_MODE_TOGGLE, "devel-mode-toggle", NoBuffer, System },
1425
1426
1427 /*!
1428  * \var lyx::FuncCode lyx::LFUN_DIALOG_DISCONNECT_INSET
1429  * \li Action: Closes opened connection to opened inset.
1430  * \li Notion: Connection is used for apply functions.
1431  * \li Syntax: dialog-disconnect-inset <INSET-NAME>
1432  * \li Origin: leeming, 25 Feb 2003
1433  * \endvar
1434  */
1435                 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
1436
1437
1438 /*!
1439  * \var lyx::FuncCode lyx::LFUN_DIALOG_HIDE
1440  * \li Action: Hides showed dialog. Counterpart to #LFUN_DIALOG_SHOW .
1441  * \li Syntax: dialog-hide <NAME>
1442  * \li Params: See #LFUN_DIALOG_SHOW .
1443  * \li Origin: leeming, 25 Feb 2003
1444  * \endvar
1445  */
1446                 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
1447
1448 /*!
1449  * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW
1450  * \li Action: Shows hidden dialog or creates new one for a given function/inset settings etc.
1451  * \li Syntax: dialog-show <NAME> [<DATA>]
1452  * \li Params: <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|\n
1453                compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|\n
1454                graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimiter|\n
1455                mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|\n
1456                print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|\n
1457                thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL> \n
1458                <SPECIAL>: latexlog|vclog \n
1459                <DATA>: data, usually settings for the given dialog. Use debug mode for the
1460                        details.
1461  * \li Origin: leeming, 17 Jun 2003
1462  * \endvar
1463  */
1464                 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
1465
1466 /*!
1467  * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW_NEW_INSET
1468  * \li Action: Shows hidden dialog or create new one for a given inset settings etc.
1469  * \li Notion: Internally uses #LFUN_DIALOG_SHOW with processed data for a given inset.
1470  * \li Syntax: dialog-show-new-inset <NAME> [<DATA>]
1471  * \li Params: See #LFUN_DIALOG_SHOW .
1472  * \li Origin: leeming, 25 Feb 2003
1473  * \endvar
1474  */
1475                 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
1476
1477 /*!
1478  * \var lyx::FuncCode lyx::LFUN_DIALOG_TOGGLE
1479  * \li Action: Toggles dialog between showed/hidden state.
1480  * \li Notion: Internally uses #LFUN_DIALOG_SHOW , #LFUN_DIALOG_HIDE .
1481  * \li Syntax: dialog-toggle <NAME> [<DATA>]
1482  * \li Params: See #LFUN_DIALOG_SHOW .
1483  * \li Origin: spitz, 30 Apr 2007
1484  * \endvar
1485  */
1486                 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
1487
1488 /*!
1489  * \var lyx::FuncCode lyx::LFUN_DIALOG_UPDATE
1490  * \li Action: Updates the dialog values from the inset/paragraph/document.
1491  * \li Syntax: dialog-update <NAME>
1492  * \li Params: <NAME>: paragraph|prefs|<INSET> \n
1493                <INSET>: inset name
1494  * \li Origin: leeming, 25 Feb 2003
1495  * \endvar
1496  */
1497                 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
1498
1499 /*!
1500  * \var lyx::FuncCode lyx::LFUN_DOWN
1501  * \li Action: Moves the cursor one line in downward direction.
1502  * \li Syntax: down
1503  * \endvar
1504  */
1505                 { LFUN_DOWN, "down", ReadOnly | NoUpdate, Edit },
1506
1507 /*!
1508  * \var lyx::FuncCode lyx::LFUN_DOWN_SELECT
1509  * \li Action: Moves the cursor one line in downward direction adding the current
1510                position to the selection.
1511  * \li Syntax: down-select
1512  * \endvar
1513  */
1514                 { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, Edit },
1515
1516 /*!
1517  * \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE
1518  * \li Action: Displays list of layout choices.
1519  * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
1520                dropbox allowing for choice of layout.
1521  * \li Syntax: drop-layouts-choice
1522  * \endvar
1523  */
1524                 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
1525
1526 /*!
1527  * \var lyx::FuncCode lyx::LFUN_ENVIRONMENT_SPLIT
1528  * \li Action: Splits the current environment with a Separator.
1529  * \li Syntax: environment-split [before|outer|previous]
1530  * \li Params: outer:    If this is given, LyX will split the outermost environment in
1531                          the current nesting hierarchy.\n
1532                previous: If this is given, LyX will split the environment in the previous
1533                          paragraph (is there is one).\n
1534                before:   If this is given, the new environment will be appended rather than
1535                          prepended.
1536  * \li Origin: spitz, 23 Dec 2012
1537  * \endvar
1538  */
1539                 { LFUN_ENVIRONMENT_SPLIT, "environment-split", Noop, Layout },
1540
1541
1542 /*!
1543  * \var lyx::FuncCode lyx::LFUN_ERT_INSERT
1544  * \li Action: Inserts an ERT inset.
1545  * \li Syntax: ert-insert
1546  * \li Origin: Jug, 18 Feb 2000
1547  * \endvar
1548  */
1549                 { LFUN_ERT_INSERT, "ert-insert", Noop, Edit },
1550
1551 /*!
1552  * \var lyx::FuncCode lyx::LFUN_ESCAPE
1553  * \li Action: Clears the selection. If no text is selected call #LFUN_FINISHED_FORWARD.
1554                Inside math mode jumps out of the math inset.
1555  * \li Syntax: escape
1556  * \li Origin: Lgb, 17 May 2001
1557  * \endvar
1558  */
1559                 { LFUN_ESCAPE, "escape", ReadOnly, Edit },
1560
1561 /*!
1562  * \var lyx::FuncCode lyx::LFUN_EXPORT_CANCEL
1563  * \li Action: Cancel background export process.
1564  * \li Syntax: export-cancel
1565  * \li Origin: rgh, 10 December 2017
1566  * \endvar
1567  */
1568                 { LFUN_EXPORT_CANCEL, "export-cancel", ReadOnly | NoUpdate | NoInternal, Edit },
1569
1570 /*!
1571  * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
1572  * \li Action: Inserts another LyX file.
1573  * \li Syntax: file-insert [<FILE>]
1574  * \li Params: <FILE>: Filename to be inserted.
1575  * \endvar
1576  */
1577                 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
1578
1579 /*!
1580  * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
1581  * \li Action: Inserts plain text file.
1582  * \li Syntax: file-insert-plaintext [<FILE>]
1583  * \li Params: <FILE>: Filename to be inserted.
1584  * \li Origin: CFO-G, 19 Nov 1997
1585  * \endvar
1586  */
1587                 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
1588
1589 /*!
1590  * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
1591  * \li Action: Inserts plain text file as paragraph (i.e. join lines).
1592  * \li Syntax: file-insert-plaintext-para [<FILE>]
1593  * \li Params: <FILE>: Filename to be inserted.
1594  * \li Origin: Levon, 14 Feb 2001
1595  * \endvar
1596  */
1597                 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
1598
1599 /*!
1600  * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
1601  * \li Action: Open LyX document.
1602  * \li Syntax: file-open [<FILE>]
1603  * \li Params: <FILE>: Filename to be opened.
1604  * \endvar
1605  */
1606                 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
1607
1608
1609 /*!
1610  * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
1611  * \li Action: Moves the cursor out of the current slice, going backwards.
1612  * \li Notion: See also #LFUN_FINISHED_FORWARD.
1613  * \endvar
1614  */
1615                 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
1616
1617 /*!
1618  * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
1619  * \li Action: Moves the cursor out of the current slice, going forward.
1620  * \li Notion: Cursor movement within an inset may be different than cursor
1621                movement in the surrounding text. This action should be called
1622                automatically by the cursor movement within the inset, when
1623                movement within the inset has ceased (reached the end of the
1624                last paragraph, for example), in order to move correctly
1625                back into the surrounding text.
1626  * \endvar
1627  */
1628                 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
1629
1630 /*!
1631  * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
1632  * \li Action: Moves the cursor out of the current slice, going left.
1633  * \li Notion: See also #LFUN_FINISHED_FORWARD.
1634  * \endvar
1635  */
1636                 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
1637
1638
1639 /*!
1640  * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
1641  * \li Action: Moves the cursor out of the current slice, going right.
1642  * \li Notion: See also #LFUN_FINISHED_FORWARD
1643  * \endvar
1644  */
1645                 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
1646
1647 /*!
1648  * \var lyx::FuncCode lyx::LFUN_FLEX_INSERT
1649  * \li Action: Inserts CharStyle, Custom inset or XML short element.
1650  * \li Notion: Look into the Customization manual for more information about
1651                these elements.\n
1652                To make this command enabled the layout file for the document
1653                class you're using has to load the character styles. There are
1654                a few contained in the Logical Markup module. You can also of
1655                course create some yourself. \n
1656                For dissolving the element see #LFUN_INSET_DISSOLVE.
1657  * \li Syntax: flex-insert Name
1658  * \li Params: Name: This name must be defined either in your layout file
1659                      or imported by some module. The definition is
1660                      InsetLayout Name or InsetLayout <Flex:Name>. The Flex:
1661                      prefix is optional.
1662  * \li Sample: flex-insert Code
1663  * \endvar
1664  */
1665                 { LFUN_FLEX_INSERT, "flex-insert", Noop, Edit },
1666
1667 /*!
1668  * \var lyx::FuncCode lyx::LFUN_FLOAT_INSERT
1669  * \li Action: Inserts a float inset.
1670  * \li Syntax: float-insert <TYPE>
1671  * \li Params: <TYPE>: type of float depends on the used textclass. Usually
1672                        "algorithm", "table", "figure" parameters can be given.
1673  * \li Origin: Lgb, 27 Jun 2000
1674  * \endvar
1675  */
1676                 { LFUN_FLOAT_INSERT, "float-insert", Noop, Edit },
1677
1678 /*!
1679  * \var lyx::FuncCode lyx::LFUN_FLOAT_LIST_INSERT
1680  * \li Action: Inserts the list of floats in the document.
1681  * \li Syntax: float-list-insert <TYPE>
1682  * \li Params: <TYPE>: type of float depends on the used textclass. Usually
1683                        "algorithm", "table", "figure" parameters can be given.
1684  * \li Origin: Lgb, 3 May 2001
1685  * \endvar
1686  */
1687                 { LFUN_FLOAT_LIST_INSERT, "float-list-insert", Noop, Edit },
1688
1689 /*!
1690  * \var lyx::FuncCode lyx::LFUN_FLOAT_WIDE_INSERT
1691  * \li Action: Inserts float insets as in #LFUN_FLOAT_INSERT but span multiple columns.
1692  * \li Notion: Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
1693  * \li Syntax: float-wide-insert <TYPE>
1694  * \li Params: <TYPE>: type of float depends on the used textclass. Usually
1695                        "algorithm", "table", "figure" parameters can be given.
1696  * \li Origin: Lgb, 31 Oct 2001
1697  * \endvar
1698  */
1699                 { LFUN_FLOAT_WIDE_INSERT, "float-wide-insert", Noop, Edit },
1700
1701 /*!
1702  * \var lyx::FuncCode lyx::LFUN_FONT_BOLD
1703  * \li Action: Toggles the bold font (selection-wise) using mathbf in math.
1704  * \li Syntax: font-bold
1705  * \endvar
1706  */
1707                 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
1708
1709
1710 /*!
1711  * \var lyx::FuncCode lyx::LFUN_FONT_BOLDSYMBOL
1712  * \li Action: Toggles the bold font (selection-wise) using boldsymbol in math.
1713  * \li Syntax: font-boldsymbol
1714  * \endvar
1715  */
1716                 { LFUN_FONT_BOLDSYMBOL, "font-boldsymbol", Noop, Layout },
1717
1718 /*!
1719  * \var lyx::FuncCode lyx::LFUN_FONT_DEFAULT
1720  * \li Action: Reverts the settings of the font to the default values (selection-wise).
1721  * \li Syntax: font-default
1722  * \endvar
1723  */
1724                 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
1725
1726 /*!
1727  * \var lyx::FuncCode lyx::LFUN_FONT_EMPH
1728  * \li Action: Toggles the emphasis font style (selection-wise).
1729  * \li Syntax: font-emph
1730  * \endvar
1731  */
1732                 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
1733
1734 /*!
1735  * \var lyx::FuncCode lyx::LFUN_FONT_FRAK
1736  * \li Action: Toggles Fraktur family font (math-mode, selection-wise).
1737  * \li Syntax: font-frak
1738  * \li Origin: vermeer, 10 Jan 2002
1739  * \endvar
1740  */
1741                 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
1742
1743 /*!
1744  * \var lyx::FuncCode lyx::LFUN_FONT_ITAL
1745  * \li Action: Toggles Italics font shape (math-mode, selection-wise).
1746  * \li Syntax: font-ital
1747  * \li Origin: vermeer, 10 Jan 2002
1748  * \endvar
1749  */
1750                 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
1751
1752 /*!
1753  * \var lyx::FuncCode lyx::LFUN_FONT_NOUN
1754  * \li Action: Toggles Noun text style font (selection-wise).
1755  * \li Syntax: font-noun
1756  * \endvar
1757  */
1758                 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
1759
1760 /*!
1761  * \var lyx::FuncCode lyx::LFUN_FONT_ROMAN
1762  * \li Action: Toggles Roman family font (selection-wise).
1763  * \li Syntax: font-roman
1764  * \endvar
1765  */
1766                 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
1767
1768 /*!
1769  * \var lyx::FuncCode lyx::LFUN_FONT_SANS
1770  * \li Action: Toggles Sans Serif family font (selection-wise).
1771  * \li Syntax: font-sans
1772  * \endvar
1773  */
1774                 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
1775
1776 /*!
1777  * \var lyx::FuncCode lyx::LFUN_FONT_SIZE
1778  * \li Action: Sets font size according to lyx format string.
1779  * \li Syntax: font-size <SIZE>
1780  * \li Params: <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|\n
1781                        largest|huge|giant|increase|decrease|default
1782  * \endvar
1783  */
1784                 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
1785
1786 /*!
1787  * \var lyx::FuncCode lyx::LFUN_FONT_STATE
1788  * \li Action: Returns the info about the current font.
1789  * \li Syntax: font-state
1790  * \endvar
1791  */
1792                 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
1793
1794
1795 /*!
1796  * \var lyx::FuncCode lyx::LFUN_FONT_STRIKEOUT
1797  * \li Action: Toggles strikeout (strike-through) in the font (selection-wise).
1798  * \li Syntax: font-strikeout
1799  * \li Origin: sanda, 3 May 2009
1800  * \endvar
1801  */
1802                 { LFUN_FONT_STRIKEOUT, "font-strikeout", Noop, Layout },
1803
1804 /*!
1805  * \var lyx::FuncCode lyx::LFUN_FONT_CROSSOUT
1806  * \li Action: Toggles xout (cross-through) in the font (selection-wise).
1807  * \li Syntax: font-crossout
1808  * \li Origin: uwestoehr, 4 April 2017
1809  * \endvar
1810  */
1811                 { LFUN_FONT_CROSSOUT, "font-crossout", Noop, Layout },
1812
1813 /*!
1814  * \var lyx::FuncCode lyx::LFUN_FONT_TYPEWRITER
1815  * \li Action: Toggles the typewriter family font (selection-wise).
1816  * \li Syntax: font-typewriter
1817  * \endvar
1818  */
1819                 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
1820
1821 /*!
1822  * \var lyx::FuncCode lyx::LFUN_FONT_UNDERLINE
1823  * \li Action: Toggles underline in the font (selection-wise).
1824  * \li Syntax: font-underline
1825  * \endvar
1826  */
1827                 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
1828
1829 /*!
1830  * \var lyx::FuncCode lyx::LFUN_FONT_UNDERUNDERLINE
1831  * \li Action: Toggles double underline in the font (selection-wise).
1832  * \li Syntax: font-underunderline
1833  * \li Origin: sanda, 5 May 2009
1834  * \endvar
1835  */
1836                 { LFUN_FONT_UNDERUNDERLINE, "font-underunderline", Noop, Layout },
1837
1838 /*!
1839  * \var lyx::FuncCode lyx::LFUN_FONT_UNDERWAVE
1840  * \li Action: Toggles wavy underline in the font (selection-wise).
1841  * \li Syntax: font-underwave
1842  * \li Origin: sanda, 5 May 2009
1843  * \endvar
1844  */
1845                 { LFUN_FONT_UNDERWAVE, "font-underwave", Noop, Layout },
1846
1847 /*!
1848  * \var lyx::FuncCode lyx::LFUN_FOOTNOTE_INSERT
1849  * \li Action: Inserts a footnote inset.
1850  * \li Syntax: footnote-insert
1851  * \li Origin: Jug, 7 Mar 2000
1852  * \endvar
1853  */
1854                 { LFUN_FOOTNOTE_INSERT, "footnote-insert", Noop, Edit },
1855
1856 /*!
1857  * \var lyx::FuncCode lyx::LFUN_FORWARD_SEARCH
1858  * \li Action: Sets the cursor position in the previewed (dvi/pdf) file based on the row
1859                number in LyX window.
1860  * \li Notion: The external program used for forward search call can be specified in
1861                LyX Output preferences. See Additional manual for details of these
1862                settings.
1863  * \li Syntax: forward-search
1864  * \li Origin: sanda, 14 Apr 2010
1865  * \endvar
1866  */
1867                 { LFUN_FORWARD_SEARCH, "forward-search", ReadOnly, System },
1868
1869 /*!
1870  * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
1871  * \li Action: Open the given help file according to the language setting.
1872  * \li Syntax: help-open <FILE>[.lyx]
1873  * \li Params: <FILE>: any document from (/usr/share/)doc directory.
1874  * \li Origin: Jug, 27 Jun 1999
1875  * \endvar
1876  */
1877                 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
1878
1879 /*!
1880  * \var lyx::FuncCode lyx::LFUN_HREF_INSERT
1881  * \li Action: Inserts hyperlinks into the document (clickable in pdf output).
1882  * \li Notion: Hyperlink target can be set via selection + hyperlink-insert function.
1883  * \li Syntax: href-insert [<TARGET>]
1884  * \li Origin: CFO-G, 21 Nov 1997
1885  * \endvar
1886  */
1887                 { LFUN_HREF_INSERT, "href-insert", Noop, Edit },
1888
1889 /*!
1890  * \var lyx::FuncCode lyx::LFUN_ICON_SIZE
1891  * \li Action: Sets icon size of toolbars.
1892  * \li Syntax: icon-size [<SIZE>]
1893  * \li Params: <SIZE> : the icon size in px or one of the logical settings
1894                         small|normal|big|huge|giant, the default is normal
1895                         (whose size in px is icon set dependent).
1896  * \li Origin: 11 July 2016
1897  * \endvar
1898  */
1899                 { LFUN_ICON_SIZE, "icon-size", NoBuffer, Buffer },
1900
1901 /*!
1902  * \var lyx::FuncCode lyx::LFUN_INDEX_INSERT
1903  * \li Action: Inserts Index entry.
1904  * \li Notion: It automatically takes the word on the cursor position.
1905  * \li Syntax: index-insert [<TYPE:Name>]
1906  * \li Params: <TYPE:Name>: name of the index, if multiple indices are defined.
1907                With an empty argument, the default index is selected.
1908  * \li Origin: leeming, 3 Aug 2000
1909  * \endvar
1910  */
1911                 { LFUN_INDEX_INSERT, "index-insert", Noop, Edit },
1912
1913 /*!
1914  * \var lyx::FuncCode lyx::LFUN_INDEX_PRINT
1915  * \li Action: Inserts list of Index entries on a new page.
1916  * \li Syntax: index-print [<TYPE:Name>]
1917  * \li Params: <TYPE:Name>: name of the index, if multiple indices are defined.
1918                With an empty argument, the default index is selected.
1919  * \li Origin: Lgb, 27 Feb 1997
1920  * \endvar
1921  */
1922                 { LFUN_INDEX_PRINT, "index-print", Noop, Edit },
1923
1924 /*!
1925  * \var lyx::FuncCode lyx::LFUN_INFO_INSERT
1926  * \li Action: Displays shortcuts, lyxrc, package and textclass availability and menu
1927                information in a non-editable boxed InsetText.
1928  * \li Notion: Apart from lfun arguments you can use the following method: \n
1929                1. input the type and argument of this inset, e.g. "menu paste", in
1930                the work area.\n
1931                2. select the text and run info-insert lfun.
1932  * \li Syntax: info-insert <TYPE> <ARG>
1933  * \li Params: <TYPE>: date|moddate|fixdate|time|modtime|fixtime|shortcut|shortcuts|lyxrc|
1934  *                     lyxinfo|package|textclass|menu|l7n|icon|buffer|vcs \n
1935                <ARG>: argument for a given type. Look into InsetInfo.h for detailed
1936                       description. \n
1937                       date: current date (formatted and localized)\n
1938                       moddate: date of last modification (saving) (formatted and localized)\n
1939                       fixdate: a static date (formatted and localized)\n
1940                       time: current time (formatted and localized)\n
1941                       modtime: time of last modification (saving) (formatted and localized)\n
1942                       fixtime: a static time (formatted and localized)\n
1943                       shortcut[s]: name of lfun (e.g math-insert \alpha) \n
1944                       lyxrc: name of rc_entry (e.g. bind_file) \n
1945                       lyxinfo: "version" - used version of LyX \n
1946                       package: name of latex package (e.g. listings) \n
1947                       textclass: name of textclass (e.g. article) \n
1948                       menu: name of lfun used in menu  \n
1949                       l7n: localizable string.\n
1950                       icon: icon of lfun used in toolbar or direct icon name\n
1951                       buffer: "name"|"name-noext"|"path"|"class"
1952                       vcs: "tree-revision"|"revision"|"author"|"date"|"time"
1953  * \li Sample: command-sequence info-insert buffer path; info-insert buffer name
1954  * \li Origin: bpeng, 7 Oct 2007
1955  * \endvar
1956  */
1957                 { LFUN_INFO_INSERT, "info-insert", Noop, Edit },
1958
1959 /*!
1960  * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
1961  * \li Action: Apply data for an inset.
1962  * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
1963                be applied. This is either changed to #LFUN_INSET_MODIFY or
1964                #LFUN_INSET_INSERT depending on the context where it is called.
1965  * \li Syntax: inset-apply <ARGS>
1966  * \li Params: See #LFUN_INSET_INSERT .
1967  * \endvar
1968  */
1969                 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
1970
1971 /*!
1972  * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN
1973  * \li Action: Move the cursor to the beginning of the current inset
1974                if it is not already there. If the cursor is already at
1975                the beginning of the current inset, move it to the
1976                beginning of the enclosing inset or the main work area,
1977                respectively, if there is no enclosing inset.
1978  * \li Syntax: inset-begin
1979  * \li Origin: lasgouttes, 16 Mar 2009
1980  * \endvar
1981  */
1982                 { LFUN_INSET_BEGIN, "inset-begin", ReadOnly, Edit },
1983
1984 /*!
1985  * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN_SELECT
1986  * \li Action: Move the cursor to the beginning of the current inset
1987                if it is not already there. If the cursor is already at
1988                the beginning of the current inset, move it to the
1989                beginning of the enclosing inset or the main work area,
1990                respectively, if there is no enclosing inset (adding the
1991                traversed text to the selection).
1992  * \li Syntax: inset-begin-select
1993  * \li Origin: lasgouttes, 16 Mar 2009
1994  * \endvar
1995  */
1996                 { LFUN_INSET_BEGIN_SELECT, "inset-begin-select", ReadOnly, Edit },
1997
1998 /*!
1999  * \var lyx::FuncCode lyx::LFUN_INSET_COPY_AS
2000  * \li Action: Copies the inset to the clipboard as a certain type.
2001  * \li Notion: Currently used only for InsetInfo where its content is copied as a text.
2002  * \li Syntax: inset-copy-as
2003  * \li Origin: vfr, 18 Apr 2010
2004  * \endvar
2005  */
2006                 { LFUN_INSET_COPY_AS, "inset-copy-as", ReadOnly | NoUpdate | AtPoint, Edit },
2007
2008
2009 /*!
2010  * \var lyx::FuncCode lyx::LFUN_INSET_DIALOG_UPDATE
2011  * \li Action: Updates the values inside the dialog from the inset.
2012  * \li Notion: This is an internal LFUN, not to be used by users. Called internally
2013                by #LFUN_DIALOG_UPDATE
2014  * \li Params: <DIALOG-NAME>
2015  * \li Origin: leeming, 25 Feb 2003
2016  * \endvar
2017  */
2018                 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
2019
2020 /*!
2021  * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE
2022  * \li Action: Dissolve the current inset into text.
2023  * \li Syntax: inset-dissolve [<INSET>]
2024  * \li Params: <INSET>: this can be used to make sure the right kind of inset
2025                         is dissolved. For example "dissolve" entry in the charstyles
2026                         sub-menu should only dissolve the charstyle inset, even if the
2027                         cursor is inside several nested insets of different type.\n
2028                         For values see #lyx::InsetLayout::lyxtype_ .
2029  * \li Origin: JSpitz, 7 Aug 2006
2030  * \endvar
2031  */
2032                 { LFUN_INSET_DISSOLVE, "inset-dissolve", AtPoint, Edit },
2033
2034 /*!
2035  * \var lyx::FuncCode lyx::LFUN_INSET_EDIT
2036  * \li Action: Edit the inset at cursor with an external application,
2037                if one is attributed.
2038                If the inset is file based, the referenced file is edited.
2039                Otherwise, the inset contents is written to a temporary file,
2040                the inset is locked, and the temporary file is edited.
2041                In this case, #LFUN_INSET_END_EDIT must be called to overtake
2042                the changes and unlock the inset after editing is finished.
2043  * \li Syntax: inset-edit [<INSET_PARAMS>]
2044  * \li Params: <INSET_PARAMS>: Parameters for the inset. \n
2045                                Currently only the filename will be considered.
2046  * \li Origin: spitz, 27 Apr 2006
2047  * \endvar
2048  */
2049                 { LFUN_INSET_EDIT, "inset-edit", ReadOnly | AtPoint, Edit },
2050
2051
2052  /*!
2053  * \var lyx::FuncCode lyx::LFUN_INSET_END_EDIT
2054  * \li Action: End editing the inset at cursor with an external application.
2055  *             This replaces the inset contents with the contents of the
2056  *             temporary file, deletes the file and unlocks the inset.
2057  * \li Syntax: inset-end-edit 
2058  * \li Origin: gb, 11 Oct 2015
2059  * \endvar
2060  */
2061                 { LFUN_INSET_END_EDIT, "inset-end-edit", ReadOnly | AtPoint, Edit },
2062
2063 /*!
2064  * \var lyx::FuncCode lyx::LFUN_INSET_END
2065  * \li Action: Move the cursor to the end of the current inset if it
2066                is not already there. If the cursor is already at the
2067                end of the current inset, move it to the end of the
2068                enclosing inset or the main work area, respectively, if
2069                there is no enclosing inset.
2070  * \li Syntax: inset-end
2071  * \li Origin: lasgouttes, 16 Mar 2009
2072  * \endvar
2073  */
2074                 { LFUN_INSET_END, "inset-end", ReadOnly, Edit },
2075
2076 /*!
2077  * \var lyx::FuncCode lyx::LFUN_INSET_END_SELECT
2078  * \li Action: Move the cursor to the end of the current inset if it
2079                is not already there. If the cursor is already at the
2080                end of the current inset, move it to the end of the
2081                enclosing inset or the main work area, respectively, if
2082                there is no enclosing inset (adding the
2083                traversed text to the selection).
2084  * \li Syntax: inset-end-select
2085  * \li Origin: lasgouttes, 16 Mar 2009
2086  * \endvar
2087  */
2088                 { LFUN_INSET_END_SELECT, "inset-end-select", ReadOnly, Edit },
2089
2090
2091 /*!
2092  * \var lyx::FuncCode lyx::LFUN_INSET_FORALL
2093  * \li Action: Apply the given commands on insets of a given name.
2094  * \li Notion: WARNING: use at your own risks; this function gives
2095                you too many ways of shooting yourself in the foot.
2096                A typical example is
2097                    inset-forall Note note-insert
2098                which starts an infinite loop. This is mitigated by the fact
2099                that the number of actions is arbitrarily limited to 100000.
2100                Note also that inset-forall does not update metrics between
2101                iterations, which can lead to bugs. This has to be eventually
2102                fixed.
2103  * \li Syntax: inset-forall <NAME> <LFUN-COMMAND> \n
2104                <NAME>: Type of Inset. If <NAME> is *, all insets are matched.
2105                The name is used like for InsetLayout in layout files: "Note"
2106                matches all note insets, while "Note:Note" only matches LyX
2107                yellow note insets.
2108  * \li Sample: Remove all index insets: \n
2109                    inset-forall Index char-delete-forward force \n
2110                Close all Notes (also works for a particular branch, for example): \n
2111                    inset-forall Note inset-toggle close \n
2112                Transform all yellow notes to comments \n
2113                    inset-forall Note:Note inset-modify note Note Comment \n
2114                Try to put LyX in an infinite loop if there is at least a Note: \n
2115                    inset-forall Note char-backward
2116  * \li Origin: lasgouttes, 27 Nov 2009
2117  * \endvar
2118  */
2119                 { LFUN_INSET_FORALL, "inset-forall", ReadOnly, Edit },
2120
2121
2122 /*!
2123  * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
2124  * \li Action: Insert new inset (type given by the parameters).
2125  * \li Syntax: inset-insert <INSET> <ARGS>
2126  * \li Params: <INSET>: <bibitem|bibtex|citation|ert|listings|external|graphics|tabular|\n
2127                          hyperlink|include|index|label|line|nomencl|vspace|ref|toc|script>\n
2128                <ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
2129  * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
2130                where <label name> is the name of the referenced label and
2131                <Format> is one of the following: \n
2132                ref -- <reference> \n
2133                eqref -- (<reference>) \n
2134                pageref -- <page> \n
2135                vpageref -- on <page> \n
2136                vref -- <reference> on <page> \n
2137                formatted -- Formatted reference
2138  * \endvar
2139  */
2140                 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
2141
2142 /*!
2143  * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
2144  * \li Action: Modify some properties of an inset.
2145  * \li Notion: Used for argument, bibitem, bibtex, box, branch, caption, citation,
2146                         command, ert, external, float, graphics, include, index,
2147                         info, label, line, listings, newline, newpage, nomencl,
2148                         note, phantom, quotes, ref, script, separator, space,
2149                         tabular, vspace and wrap insets.
2150  * \li Syntax: inset-modify <INSET> <ARGS> \n
2151                inset-modify changetype <TYPE>
2152  * \li Sample: Change a Note inset into a Comment inset: \n
2153                    inset-modify note Note Comment \n
2154                Change a Box into an Ovalbox: \n
2155                    inset-modify changetype Ovalbox \n
2156                Change a quotation mark to e[nglish style], l[eft side = opening], s[ingle = inner, secondary] \n
2157                    inset-modify changetype els \n
2158                Change only the style of a quotation mark, maintaining the other aspects (. = wildcard) \n
2159                    inset-modify changetype e.. \n
2160  * \endvar
2161  */
2162                 { LFUN_INSET_MODIFY, "inset-modify", AtPoint, Edit },
2163
2164 /*!
2165  * \var lyx::FuncCode lyx::LFUN_INSET_SELECT_ALL
2166  * \li Action: Select all contents of an inset.
2167  * \li Notion: There are 3 successive levels: select current cell,
2168  *             select all cells of inset, select the inset from outside
2169  *             (in the enclosing inset).
2170  * \li Syntax: inset-select-all
2171  * \li Origin: vfr, 22 Aug 2009; lasgouttes 1 Nov 2014
2172  * \endvar
2173  */
2174                 { LFUN_INSET_SELECT_ALL, "inset-select-all", ReadOnly, Edit },
2175
2176
2177 /*!
2178  * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
2179  * \li Action: Open the inset's properties dialog.
2180  * \li Notion: Used for bibitem, bibtex, box, branch, citation, ert, external,
2181                float, graphics, href, include, index, index_print, label, line,
2182                listings, note, phantom, ref, space, tabular, vspace, wrap insets.
2183  * \li Syntax: inset-settings <INSET>
2184  * \li Params: <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|\n
2185                          graphics|href|include|index|index_print|label|line|\n
2186                          listings|note|phantom|ref|space|tabular|vspace|wrap>.
2187  * \endvar
2188  */
2189                 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly | AtPoint, Edit },
2190
2191 /*!
2192  * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
2193  * \li Action: Toggles the collapsible inset at cursor position,
2194                or the inset we are currently in.
2195  * \li Syntax: inset-toggle [<ARG>]
2196  * \li Params: <ARG>: <open|close|toggle|assign>. \n
2197                open/close/toggle are for collapsible insets. toggle is used when no argument is given.\n
2198                assign synchronize the branch-inset with activation status of the branch.
2199                Used for global toggling when changed activation.
2200  * \li Origin: lasgouttes, 19 Jul 2001
2201  * \endvar
2202  */
2203                 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly | AtPoint, Edit },
2204
2205 /*!
2206  * \var lyx::FuncCode lyx::LFUN_IN_IPA
2207  * \li Action: Only active in IPA inset.
2208  * \li Notion: Dummy function which is only active in a IPA inset.
2209                It's used to toggle the IPA toolbar if the cursor moves
2210                into an IPA inset.
2211  * \li Syntax: in-ipa
2212  * \li Origin: spitz, 20 May 2012
2213  * \endvar
2214  */
2215                 { LFUN_IN_IPA, "in-ipa", Noop, Edit },
2216
2217 /*!
2218  * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
2219  * \li Action: Only active in Math Macro definition.
2220  * \li Notion: Dummy function which is only active in a Math Macro definition.
2221                It's used to toggle the Math Macro toolbar if the cursor moves
2222                into a Math Macro definition.
2223  * \li Syntax: in-mathmacrotemplate
2224  * \li Origin: sts, 06 January 2008
2225  * \endvar
2226  */
2227                 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
2228
2229
2230 /*!
2231  * \var lyx::FuncCode lyx::LFUN_IPAMACRO_INSERT
2232  * \li Action: Inserts special IPA macros into the document.
2233  * \li Syntax: ipamacro-insert <CHAR>
2234  * \li Params: <CHAR>: tone-falling, tone-rising, tone-high-rising, tone-low-rising,
2235  *                     tone-high-rising-falling, deco bottomtiebar, deco toptiebar.
2236  * \li Origin: spitz, 22 Aug 2012
2237  * \endvar
2238  */
2239                 { LFUN_IPAMACRO_INSERT, "ipamacro-insert", Noop, Edit },
2240
2241 /*!
2242  * \var lyx::FuncCode lyx::LFUN_IPA_INSERT
2243  * \li Action: Inserts an IPA inset.
2244  * \li Syntax: ipa-insert
2245  * \li Origin: spitz, 05 Mar 2012
2246  * \endvar
2247  */
2248                 { LFUN_IPA_INSERT, "ipa-insert", Noop, Edit },
2249
2250 /*!
2251  * \var lyx::FuncCode lyx::LFUN_KEYMAP_OFF
2252  * \li Action: Turn off the loaded keyboard map.
2253  * \li Syntax: keymap-off
2254  * \endvar
2255  */
2256                 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
2257
2258 /*!
2259  * \var lyx::FuncCode lyx::LFUN_KEYMAP_PRIMARY
2260  * \li Action: Turn on the primary keyboard map.
2261  * \li Notion: Maps were widely used in past, when X-windows didn't have nowadays
2262                keyboard support. They can be still used to maintain uniform keyboard
2263                layout across the various platforms.\n
2264                The language is to be set in the Preferences dialog.
2265  * \li Syntax: keymap-primary
2266  * \endvar
2267  */
2268                 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
2269
2270 /*!
2271  * \var lyx::FuncCode lyx::LFUN_KEYMAP_SECONDARY
2272  * \li Action: Turn on the secondary keyboard map.
2273  * \li Syntax: keymap-secondary
2274  * \endvar
2275  */
2276                 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
2277
2278 /*!
2279  * \var lyx::FuncCode lyx::LFUN_KEYMAP_TOGGLE
2280  * \li Action: Toggles keyboard maps (first/second/off).
2281  * \li Syntax: keymap-toggle
2282  * \li Origin: leeming, 30 Mar 2004
2283  * \endvar
2284  */
2285                 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
2286
2287
2288 /*!
2289  * \var lyx::FuncCode lyx::LFUN_LABEL_COPY_AS_REF
2290  * \li Action: Copies the label at the cursor as a cross-reference to be pasted elsewhere.
2291  * \li Syntax: copy-label-as-reference <LABEL>
2292  * \li Params: <LABEL>: The label to copy (for multi-line math)
2293  * \li Origin: sts, 16 Nov 2008
2294  * \endvar
2295  */
2296                 { LFUN_LABEL_COPY_AS_REFERENCE, "label-copy-as-reference",
2297                         ReadOnly | NoUpdate | AtPoint, Edit },
2298
2299
2300 /*!
2301  * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
2302  * \li Action: Goto a label.
2303  * \li Syntax: label-goto [<LABEL>]
2304  * \li Params: <LABEL>: Requested label. If no label is given and reference
2305                         is on cursor position, Bookmark 0 is saved and
2306                         cursor moves to the position of referenced label.
2307  * \li Origin: Ale, 6 Aug 1997
2308  * \endvar
2309  */
2310                 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
2311
2312 /*!
2313  * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT
2314  * \li Action: Inserts label to text or displayed formula.
2315  * \li Syntax: label-insert [<LABEL>]
2316  * \li Params: <LABEL>: Requested label. If no label is given dialog requesting
2317                         name will be opened.
2318  * \endvar
2319  */
2320                 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
2321
2322 /*!
2323  * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT_AS_REFERENCE
2324  * \li Action: Inserts the label (in ToC pane) as a cross-reference at the position of the cursor.
2325  * \li Syntax: label-insert-as-reference
2326  * \li Origin: vfr, 7 Apr 2009
2327  * \endvar
2328  */
2329                 { LFUN_LABEL_INSERT_AS_REFERENCE, "label-insert-as-reference", Noop, Edit},
2330
2331
2332 /*!
2333  * \var lyx::FuncCode lyx::LFUN_LANGUAGE
2334  * \li Action: Set language from the current cursor position.
2335  * \li Syntax: language <LANG> [set]
2336  * \li Params: <LANG>: Requested language. Look in lib/languages for
2337                        the list. "language reset" or "language" (without param)
2338                        reset to the document language.
2339                   set: If used, the language will be set to the specified
2340                        language. Otherwise, the language will be toggled (i.e., if
2341                        the current language is LANG, switch to the document language
2342                        or the default language, if LANG is the document language).
2343  * \li Origin: Dekel, 2 Mar 2000
2344  * \endvar
2345  */
2346                 { LFUN_LANGUAGE, "language", Noop, Edit },
2347
2348
2349 /*!
2350  * \var lyx::FuncCode lyx::LFUN_LAYOUT
2351  * \li Action: Sets the layout (that is, environment) for the current paragraph.
2352  * \li Syntax: layout <LAYOUT> [ignorenests]
2353  * \li Params: <LAYOUT>: the layout to use\n
2354                ignorenests: If specified, nesting advices will be ignored.
2355  * \endvar
2356  */
2357                 { LFUN_LAYOUT, "layout", Noop, Layout },
2358
2359 /*!
2360  * \var lyx::FuncCode lyx::LFUN_LAYOUT_TOGGLE
2361  * \li Action: Toggles the layout (that is, environment) for the current paragraph.
2362  * \li Notion: Contrary to `layout', this function resets the current
2363  *             (or selection) layout to the standard layout it already has the
2364  *             correct layout. Useful for toolbar icons.
2365  * \li Syntax: layout-toggle <LAYOUT> [ignorenests]
2366  * \li Params: <LAYOUT>: the layout to toggle\n
2367                ignorenests: If specified, nesting advices will be ignored.
2368  * \li Origin: lasgouttes, 14 May 2018
2369  * \endvar
2370  */
2371                 { LFUN_LAYOUT_TOGGLE, "layout-toggle", Noop, Layout },
2372
2373 /*!
2374  * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
2375  * \li Action: Clears the module list.
2376  * \li Notion: Clears the list of included modules for the current buffer.
2377  * \li Syntax: layout-modules-clear
2378  * \li Origin: rgh, 25 August 2007
2379  * \endvar
2380  */
2381                 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", NoInternal, Layout },
2382
2383 /*!
2384  * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULE_ADD
2385  * \li Action: Adds a module.
2386  * \li Notion: Adds a module to the list of included modules for the current buffer.
2387  * \li Syntax: layout-module-add <MODULE>
2388  * \li Params: <MODULE>: the module to be added
2389  * \li Origin: rgh, 25 August 2007
2390  * \endvar
2391  */
2392                 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", NoInternal, Layout },
2393
2394 /*!
2395  * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH
2396  * \li Action: Launches the paragraph settings dialog.
2397  * \li Syntax: layout-paragraph
2398  * \endvar
2399  */
2400                 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
2401
2402 /*!
2403  * \var lyx::FuncCode lyx::LFUN_LAYOUT_RELOAD
2404  * \li Action: Reloads layout information.
2405  * \li Notion: Reloads all layout information for the current buffer from disk, thus
2406                recognizing any changes that have been made to layout files on the fly.
2407                This is intended to be used only by layout developers and should not be
2408                used when one is trying to do actual work.
2409  * \li Syntax: layout-reload
2410  * \li Origin: rgh, 3 September 2007
2411  * \endvar
2412  */
2413                 { LFUN_LAYOUT_RELOAD, "layout-reload", NoInternal, Layout },
2414
2415 /*!
2416  * \var lyx::FuncCode lyx::LFUN_LAYOUT_TABULAR
2417  * \li Action: Launches the tabular settings dialog.
2418  * \li Syntax: layout-tabular
2419  * \li Origin: Jug, 31 Jul 2000
2420  * \endvar
2421  */
2422                 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
2423
2424 /*!
2425  * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN
2426  * \li Action: Move the cursor to the beginning of the (screen) line.
2427  * \li Syntax: line-begin
2428  * \endvar
2429  */
2430                 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
2431
2432 /*!
2433  * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN_SELECT
2434  * \li Action: Move the cursor to the beginning of the (screen) line adding the
2435                traversed text to the selection.
2436  * \li Syntax: line-begin-select
2437  * \endvar
2438  */
2439                 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
2440
2441 /*!
2442  * \var lyx::FuncCode lyx::LFUN_LINE_DELETE_FORWARD
2443  * \li Action: Deletes the letters to the end of the (screen) line or
2444                deletes the selection.
2445  * \li Syntax: line-delete-forward
2446  * \endvar
2447  */
2448                 { LFUN_LINE_DELETE_FORWARD, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
2449
2450 /*!
2451  * \var lyx::FuncCode lyx::LFUN_LINE_END
2452  * \li Action: Move the cursor to the end of the (screen) line.
2453  * \li Syntax: line-end
2454  * \endvar
2455  */
2456                 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
2457
2458 /*!
2459  * \var lyx::FuncCode lyx::LFUN_LINE_END_SELECT
2460  * \li Action: Move the cursor to the end of the (screen) line adding the
2461                traversed text to the selection.
2462  * \li Syntax: line-end-select
2463  * \endvar
2464  */
2465                 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
2466
2467 /*!
2468  * \var lyx::FuncCode lyx::LFUN_LISTING_INSERT
2469  * \li Action: Inserts a new listings inset.
2470  * \li Syntax: listing-insert
2471  * \li Origin: Herbert, 10 Nov 2001; bpeng, 2 May 2007
2472  * \endvar
2473  */
2474                 { LFUN_LISTING_INSERT, "listing-insert", Noop, Edit },
2475
2476 /*!
2477  * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
2478  * \li Action: Apply the given settings to user preferences.
2479  * \li Syntax: lyxrc-apply <SETTINGS>
2480  * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
2481                            to get an idea which commands to use and their syntax.
2482                            #lyx::LyXRC::LyXRCTags has the list of possible commands.
2483  * \endvar
2484  */
2485                 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
2486
2487 /*!
2488  * \var lyx::FuncCode lyx::LFUN_LYX_ACTIVATE
2489  * \li Action: Activates the LyX window.
2490  * \li Notion: On Linux and Mac OS, this action brings the LyX window
2491                into focus. Such behavior is not allowed by Windows OS
2492                so instead the color of the taskbar entry is changed to
2493                indicate that the window has changed in some way.
2494                This action is useful in combination with reverse search.
2495  * \li Syntax: lyx-activate
2496  * \li Origin: skostysh, 4 Aug 2016
2497  * \endvar
2498  */
2499                 { LFUN_LYX_ACTIVATE, "lyx-activate", ReadOnly | NoBuffer, Hidden },
2500
2501 /*!
2502  * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
2503  * \li Action: Terminates the current LyX instance.
2504  * \li Notion: Terminates the current LyX instance, asking whether to save
2505                modified documents, etc.
2506  * \li Syntax: lyx-quit
2507  * \endvar
2508  */
2509                 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
2510
2511 /*!
2512  * \var lyx::FuncCode lyx::LFUN_MARGINALNOTE_INSERT
2513  * \li Action: Inserts a marginal note.
2514  * \li Syntax: marginalnote-insert
2515  * \li Origin: Lgb, 26 Jun 2000
2516  * \endvar
2517  */
2518                 { LFUN_MARGINALNOTE_INSERT, "marginalnote-insert", Noop, Edit },
2519
2520 /*!
2521  * \var lyx::FuncCode lyx::LFUN_MARK_OFF
2522  * \li Action: Disable selecting of text-region.
2523  * \li Syntax: mark-off
2524  * \endvar
2525  */
2526                 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
2527
2528 /*!
2529  * \var lyx::FuncCode lyx::LFUN_MARK_ON
2530  * \li Action: Enable selecting of text-region.
2531  * \li Notion: After enabling you can simply move arrow keys to get selected region.
2532  * \li Syntax: mark-on
2533  * \endvar
2534  */
2535                 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
2536
2537 /*!
2538  * \var lyx::FuncCode lyx::LFUN_MARK_TOGGLE
2539  * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
2540  * \li Syntax: mark-toggle
2541  * \li Origin: Andre, May 5 2006
2542  * \endvar
2543  */
2544                 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
2545
2546
2547 /*!
2548  * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_EXPORT
2549  * \li Action: Exports the master buffer (document) to the given format.
2550  * \li Syntax: master-buffer-export [<FORMAT>] [<DEST>]
2551  * \li Params: <FORMAT> is one of the formats which you can find in 
2552                         Tools->Preferences->File formats->Format.
2553                         Usual format you will enter is "pdf2" (pdflatex),
2554                         "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
2555                         Note that "custom" is not allowed in this case.\n
2556                         If absent or "default", then the default output format of the
2557                         document is used.\n
2558                <DEST>   If present, this argument provides the export destination
2559                         filename. Its containing folder will also be the destination
2560                         folder, where all the needed external files will be copied.
2561  * \li Origin: rkh, 18 April 2018
2562  * \endvar
2563  */
2564                 { LFUN_MASTER_BUFFER_EXPORT, "master-buffer-export", ReadOnly, Buffer },
2565
2566 /*!
2567  * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
2568  * \li Action: Update (export) the document built from the master buffer,
2569                if the current buffer is part of a master/child document.
2570  * \li Syntax: master-buffer-update [<FORMAT>]
2571  * \li Params: <FORMAT>: The format to display, where this is one of the
2572                          formats defined (in the current GUI) in the
2573                          Tools>Preferences>File Formats dialog.
2574                          If no format is given, the default format as
2575                          specified in the same dialog is used.
2576  * \li Origin: Tommaso, 20 Sep 2007
2577  * \endvar
2578  */
2579                 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
2580
2581 /*!
2582  * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
2583  * \li Action: Show a preview built from the master buffer, if available.
2584                if the current buffer is part of a master/child document.
2585  * \li Syntax: master-buffer-view [<FORMAT>]
2586  * \li Params: <FORMAT>: The format to display, where this is one of the
2587                          formats defined (in the current GUI) in the
2588                          Tools>Preferences>File Formats dialog.
2589                          If no format is given, the default format as
2590                          specified in the same dialog is used.
2591  * \li Origin: Tommaso, 20 Sep 2007
2592  * \endvar
2593  */
2594                 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
2595
2596 /*!
2597  * \var lyx::FuncCode lyx::LFUN_MATH_AMS_MATRIX
2598  * \li Action: Inserts an extended matrix as provided by the amsmath package.
2599  * \li Syntax: math-matrix <COLS> <ROWS> [<DECORATION>]
2600  * \li Params: <DECORATION>: Decoration determines the LaTeX name of the matrix
2601                              that should be created. Possible values include
2602                              pmatrix, bmatrix, Bmatrix, vmatrix, Vmatrix and
2603                              matrix. The default is 'matrix'.
2604  * \li Sample: math-ams-matrix 3 3 bmatrix
2605  * \endvar
2606  */
2607                 { LFUN_MATH_AMS_MATRIX, "math-ams-matrix", Noop, Math },
2608
2609 /*!
2610  * \var lyx::FuncCode lyx::LFUN_MATH_BIGDELIM
2611  * \li Action: Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
2612  * \li Syntax: math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
2613  * \li Params: <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r \n
2614                <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
2615  * \li Sample: math-bigdelim "Bigl" "\Downarrow" "Bigr" "\}"
2616  * \li Origin: Enrico & Georg, 7 May 2006
2617  * \endvar
2618  */
2619                 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
2620
2621 /*!
2622  * \var lyx::FuncCode lyx::LFUN_MATH_DELIM
2623  * \li Action: Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
2624  * \li Syntax: math-delim [<LEFT>] [<RIGHT>]
2625  * \li Params: <LEFT/RIGHT>: Delimiters to be used. Each delimiter can be specified by
2626                              either a LaTeX name or a valid character.
2627                              ( is the default letter.
2628  * \li Sample: math-delim { rangle
2629  * \li Origin: Alejandro, 18 Jun 1996
2630  * \endvar
2631  */
2632                 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
2633
2634 /*!
2635  * \var lyx::FuncCode lyx::LFUN_MATH_DISPLAY
2636  * \li Action: Creates a new displayed equation in text mode.
2637                Toggles inlined/display formula in math mode.
2638  * \li Syntax: math-display [<ARG>]
2639  * \li Params: <ARG>: this argument will be passed to #LFUN_MATH_INSERT when creating
2640                       new equation from the text mode.
2641  * \li Origin: Alejandro, 18 Jun 1996
2642  * \endvar
2643  */
2644                 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
2645
2646 /*!
2647  * \var lyx::FuncCode lyx::LFUN_MATH_EXTERN
2648  * \li Action: Calls external program and passes the current expression/equation
2649                as an argument for the calculation in the format appropriate to the
2650                given language.
2651  * \li Notion: Selection can be used to determine the input for the external program.
2652  * \li Syntax: math-extern <LANG> [<COMMAND>]
2653  * \li Params: <LANG>: octave|maxima|maple|mathematica|script \n
2654                        where "script" stands for the external script (normalized
2655                        expression will be passed)
2656  * \li Origin: Andre, 24 Apr 2001
2657  * \li Sample: math-extern maple simplify
2658  * \endvar
2659  */
2660                 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
2661
2662 /*!
2663  * \var lyx::FuncCode lyx::LFUN_MATH_FONT_STYLE
2664  * \li Action: Changes the text style used in math.
2665  * \li Syntax: math-font-style <STYLE>
2666  * \li Params: <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf|textnormal\n
2667                |textrm|textsf|texttt|textbf|textmd|textit|textsc|textsl|textup
2668  * \li Origin: vfr, 9 jan 2009
2669  * \endvar
2670  */
2671                 { LFUN_MATH_FONT_STYLE, "math-font-style", Noop, Math },
2672
2673 /*!
2674  * \var lyx::FuncCode lyx::LFUN_MATH_INSERT
2675  * \li Action: Inserts math objects and symbols.
2676  * \li Syntax: math-insert <ARG>
2677  * \li Params: <ARG>: Symbol or LaTeX code to be inserted.
2678  * \li Notion: When <ARG> is a _single_ math inset with more than one cell
2679                (such as "x_y^z" or "\frac{x}{y}"), the content of cell(0) is
2680                replaced by the current selection (only works if the selection
2681                is in mathed). As an example, if "abc" is selected in mathed,
2682                "math-insert \frac{x}{y}" replaces "abc" with "\frac{abc}{y}",
2683                and "math-insert x_y^z" replaces "abc" with "abc_y^z".
2684                If nothing is selected (or the selection is not in mathed),
2685                math-insert works as expected.
2686  * \endvar
2687  */
2688                 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
2689
2690 /*!
2691  * \var lyx::FuncCode lyx::LFUN_MATH_LIMITS
2692  * \li Action: Toggles the position of the limits from above/below to the right
2693                side an vice versa in integral symbol, a limit, a summation, etc.
2694  * \li Notion: Put the cursor before the symbol with the limits and then invoke
2695                math-limits.
2696  * \li Syntax: math-limits [<STATE>]
2697  * \li Params: <STATE>: limits|nolimits
2698  * \endvar
2699  */
2700                 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
2701
2702 /*!
2703  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO
2704  * \li Action: Inserts a math macro definition at the cursor position in the text.
2705  * \li Syntax: math-macro <NAME> [<NARGS>] [def]
2706  * \li Params: <NAME>: The name of the macro, e.g. "mymacro".\n
2707                <NARGS>: The number of parameters of the macro. Default is 0.
2708                "def": Has no effect anymore, just for compatibility with former LyX versions.
2709  * \li Origin: ale, 10 May 1997;  sts, 21 Dec 2007
2710  * \endvar
2711  */
2712                 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
2713
2714 /*!
2715  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
2716  * \li Action: Add a greedy optional parameter.
2717  * \li Notion: Add a greedy optional parameter which eats the value
2718                from the following cells in mathed which are in the [value]
2719                format.
2720  * \li Syntax: math-macro-add-greedy-optional-param
2721  * \li Origin: sts, 06 January 2008
2722  * \endvar
2723  */
2724                 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
2725
2726 /*!
2727  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
2728  * \li Action: Add an optional parameter.
2729  * \li Notion: Insert an optional parameter just behind the
2730                already existing optional parameters.
2731  * \li Syntax: math-macro-add-optional-param
2732  * \li Origin: sts, 06 January 2008
2733  * \endvar
2734  */
2735                 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
2736
2737 /*!
2738  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
2739  * \li Action: Add a parameter.
2740  * \li Notion: Add a parameter to a Math Macro.
2741  * \li Params: <NUM>: The number of the parameter behind which the new one
2742                will be added (1 for the first, i.e. use 0 for add a
2743                parameter at the left), defaults to the last one.
2744  * \li Syntax: math-macro-add-param <NUM>
2745  * \li Origin: sts, 06 January 2008
2746  * \endvar
2747  */
2748                 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
2749
2750 /*!
2751  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
2752  * \li Action: Append a greedy parameter.
2753  * \li Notion: Append a greedy parameter to a Math Macro which
2754                eats the following mathed cell in every instance of
2755                the macro in the buffer.
2756  * \li Syntax: math-macro-append-greedy-param
2757  * \li Origin: sts, 06 January 2008
2758  * \endvar
2759  */
2760                 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
2761
2762 /*!
2763  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
2764  * \li Action: Fold a Math Macro.
2765  * \li Notion: Fold the Math Macro the cursor is in if it was
2766                unfolded, i.e. displayed as \foo before.
2767  * \li Syntax: math-macro-fold
2768  * \li Origin: sts, 06 January 2008
2769  * \endvar
2770  */
2771                 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
2772
2773 /*!
2774  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
2775  * \li Action: Make a parameter non-optional.
2776  * \li Notion: Turn the last optional parameter of a Math Macro
2777                into a non-optional parameter. The default value is
2778                remembered to be reused later if the user changes his mind.
2779  * \li Syntax: math-macro-make-nonoptional
2780  * \li Origin: sts, 06 January 2008
2781  * \endvar
2782  */
2783                 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
2784
2785 /*!
2786  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
2787  * \li Action: Make a parameter optional.
2788  * \li Notion: Turn the first non-optional parameter of a Math Macro
2789                into an optional parameter with a default value.
2790  * \li Syntax: math-macro-make-optional
2791  * \li Origin: sts, 06 January 2008
2792  * \endvar
2793  */
2794                 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
2795
2796 /*!
2797  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
2798  * \li Action: Remove a greedy parameter.
2799  * \li Notion: Remove a greedy parameter of a Math Macro and spit
2800                out the values of it in every instance of the macro
2801                in the buffer. If it is an optional parameter the [valud]
2802                format is used.
2803  * \li Syntax: math-macro-remove-greedy-param
2804  * \li Origin: sts, 06 January 2008
2805  * \endvar
2806  */
2807                 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
2808
2809 /*!
2810  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
2811  * \li Action: Remove the last optional parameter.
2812  * \li Notion: Remove the last optional parameter of a Math Macro and
2813                remove it in all the instances of the macro in the buffer.
2814  * \li Syntax: math-macro-remove-optional-param
2815  * \li Origin: sts, 06 January 2008
2816  * \endvar
2817  */
2818                 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
2819
2820 /*!
2821  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
2822  * \li Action: Remove the last parameter.
2823  * \li Notion: Remove the last parameter of a Math Macro and
2824                remove its value in all instances of the macro
2825                in the buffer.
2826  * \li Params: <NUM>: The number of the parameter to be deleted (1 for
2827                the first), defaults to the last one.
2828  * \li Syntax: math-macro-remove-param <NUM>
2829  * \li Origin: sts, 06 January 2008
2830  * \endvar
2831  */
2832                 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
2833
2834 /*!
2835  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
2836  * \li Action: Unfold a Math Macro.
2837  * \li Notion: Unfold the Math Macro the cursor is in, i.e.
2838                display it as \foo.
2839  * \li Syntax: math-macro-unfold
2840  * \li Origin: sts, 06 January 2008
2841  * \endvar
2842  */
2843                 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
2844
2845 /*!
2846  * \var lyx::FuncCode lyx::LFUN_MATH_MATRIX
2847  * \li Action: Inserts a matrix.
2848  * \li Syntax: math-matrix <COLS> <ROWS> [<ALIGN>]
2849  * \li Params: <ALIGN>: Alignment is a word composed of the vertical alignment
2850                         (b, c or t) (i.e. 1 char) and the horizontal alignments
2851                         (l, c or r) (i.e. <COL> chars).
2852  * \li Sample: math-matrix 3 3 bccc
2853  * \endvar
2854  */
2855                 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
2856
2857 /*!
2858  * \var lyx::FuncCode lyx::LFUN_MATH_MODE
2859  * \li Action: In text mode enters math mode (i.e. puts math insets on the current
2860                cursor position), in math mode enters text mode inside math expression.
2861  * \li Notion: If there is some selected text, it puts the text inside created math box.
2862  * \li Syntax: math-mode [on|<ARG>]
2863  * \li Params: <ARG>: eventual argument (LaTeX code) is passed to #LFUN_MATH_INSERT .\n
2864                 "on": allow only entering of math mode from text mode.
2865  * \li Origin: Alejandro, 4 Jun 1996
2866  * \endvar
2867  */
2868                 { LFUN_MATH_MODE, "math-mode", Noop, Math },
2869
2870 /*!
2871  * \var lyx::FuncCode lyx::LFUN_MATH_MUTATE
2872  * \li Action: Mutates the type of math inset to the newly selected one.
2873  * \li Syntax: math-mutate <TYPE>
2874  * \li Params: <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
2875                        multline|gather|flalign
2876  * \li Origin: Andre, 23 May 2001
2877  * \endvar
2878  */
2879                 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
2880
2881 /*!
2882  * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
2883  * \li Action: Toggles numbering of the current formula line.
2884  * \li Notion: Must be in display formula mode.
2885  * \li Syntax: math-number-line-toggle
2886  * \li Origin: Alejandro, 18 Jun 1996
2887  * \endvar
2888  */
2889                 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
2890
2891 /*!
2892  * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
2893  * \li Action: Toggles numbering/labeling of the current formula.
2894  * \li Notion: Must be in display formula mode.
2895  * \li Syntax: math-number-toggle
2896  * \li Origin: Alejandro, 4 Jun 1996
2897  * \endvar
2898  */
2899                 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
2900
2901 /*!
2902  * \var lyx::FuncCode lyx::LFUN_MATH_SIZE
2903  * \li Action: Changes arbitrarily the size used by math fonts inside a context.
2904  * \li Notion: Provides an interface to the LaTeX math mode font size commands.
2905  * \li Syntax: math-size <STYLE>
2906  * \li Params: <STYLE>: \displaystyle|\textstyle|\scriptstyle|\scriptscriptstyle
2907  * \li Origin: Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
2908  * \endvar
2909  */
2910                 { LFUN_MATH_SIZE, "math-size", Noop, Math },
2911
2912 /*!
2913  * \var lyx::FuncCode lyx::LFUN_MATH_SPACE
2914  * \li Action: Inserts space into math expression.
2915  * \li Notion: Use spacebar after entering this space to change type of space.
2916  * \li Syntax: math-space [<TYPE>] [<LEN>]
2917  * \li Params: <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace \n
2918                        positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad \n
2919                        custom space: hspace \n
2920                        "," used by default.\n
2921                        Note that ! is equivalent to negthinspace, , = thinspace,
2922                        : = medspace, and ; = thickspace.\n
2923                <LEN>: length for custom spaces (hspace)
2924  * \li Origin: Andre, 25 Jul 2001; sanda, 16 Jun 2008
2925  * \endvar
2926  */
2927                 { LFUN_MATH_SPACE, "math-space", Noop, Math },
2928
2929 /*!
2930  * \var lyx::FuncCode lyx::LFUN_MATH_SUBSCRIPT
2931  * \li Action: Enters subscript expression in math expression.
2932  * \li Syntax: math-subscript
2933  * \li Origin: vermeer, 12 Dec 2001
2934  * \endvar
2935  */
2936                 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
2937
2938 /*!
2939  * \var lyx::FuncCode lyx::LFUN_MATH_SUPERSCRIPT
2940  * \li Action: Enters superscript expression in math expression.
2941  * \li Syntax: math-superscript
2942  * \li Origin: vermeer, 12 Dec 2001
2943  * \endvar
2944  */
2945                 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
2946
2947 /*!
2948  * \var lyx::FuncCode lyx::LFUN_MENU_OPEN
2949  * \li Action: Opens the menu given by its name.
2950  * \li Syntax: menu-open <NAME>
2951  * \li Params: <NAME>: menu name. See various .inc files in lib/ui for candidates.
2952  * \endvar
2953  */
2954                 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
2955
2956 /*!
2957  * \var lyx::FuncCode lyx::LFUN_MESSAGE
2958  * \li Action: Shows message in statusbar (for script purposes).
2959  * \li Syntax: message <STRING>
2960  * \li Origin: Lgb, 8 Apr 2001
2961  * \endvar
2962  */
2963                 { LFUN_MESSAGE, "message", NoBuffer, System },
2964
2965 /*!
2966  * \var lyx::FuncCode lyx::LFUN_META_PREFIX
2967  * \li Action: Simulate halting Meta key (Alt key on PCs).
2968  * \li Notion: Used for buffer edition not for GUI control.
2969  * \li Syntax: meta-prefix
2970  * \endvar
2971  */
2972                 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
2973
2974 /*!
2975  * \var lyx::FuncCode lyx::LFUN_MOUSE_DOUBLE
2976  * \li Action: This function is called when double click on mouse button is
2977                pressed (inside workarea). Action depends on the context.
2978  * \li Notion: This is an internal LFUN, not to be used by users.
2979  * \li Origin: Andre, 9 Aug 2002
2980  * \endvar
2981  */
2982                 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
2983
2984 /*!
2985  * \var lyx::FuncCode lyx::LFUN_MOUSE_MOTION
2986  * \li Action: This function is called when mouse cursor is moving over the text.
2987                Action depends on the context.
2988  * \li Notion: This is an internal LFUN, not to be used by users.
2989  * \li Origin: Andre, 9 Aug 2002
2990  * \endvar
2991  */
2992                 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
2993
2994 /*!
2995  * \var lyx::FuncCode lyx::LFUN_MOUSE_PRESS
2996  * \li Action: This function is called when mouse button is pressed (inside workarea).
2997                Action depends on the context.
2998  * \li Notion: This is an internal LFUN, not to be used by users.
2999  * \li Origin: Andre, 9 Aug 2002
3000  * \endvar
3001  */
3002                 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
3003
3004 /*!
3005  * \var lyx::FuncCode lyx::LFUN_MOUSE_RELEASE
3006  * \li Action: This function is called when mouse button is released (inside workarea).
3007                Action depends on the context.
3008  * \li Notion: This is an internal LFUN, not to be used by users.
3009  * \li Origin: Andre, 9 Aug 2002
3010  * \endvar
3011  */
3012                 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
3013
3014
3015 /*!
3016  * \var lyx::FuncCode lyx::LFUN_MOUSE_TRIPLE
3017  * \li Action: This function is called when triple click on mouse button is
3018                pressed (inside workarea). Action depends on the context.
3019  * \li Notion: This is an internal LFUN, not to be used by users.
3020  * \li Origin: Andre, 9 Aug 2002
3021  * \endvar
3022  */
3023                 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
3024
3025 /*!
3026  * \var lyx::FuncCode lyx::LFUN_NEWLINE_INSERT
3027  * \li Action: Inserts a line break or new line.
3028  * \li Syntax: newline-insert [<ARG>]
3029  * \li Params: <ARG>: <newline|linebreak> default: newline
3030  * \li Origin: spitz, 25 Mar 2008
3031  * \endvar
3032  */
3033                 { LFUN_NEWLINE_INSERT, "newline-insert", Noop, Edit },
3034
3035 /*!
3036  * \var lyx::FuncCode lyx::LFUN_NEWPAGE_INSERT
3037  * \li Action: Inserts a new page.
3038  * \li Syntax: newpage-insert <ARG>
3039  * \li Params: <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
3040  * \li Origin: uwestoehr, 24 Nov 2007
3041  * \endvar
3042  */
3043                 { LFUN_NEWPAGE_INSERT, "newpage-insert", Noop, Edit },
3044
3045 /*!
3046  * \var lyx::FuncCode lyx::LFUN_NOMENCL_INSERT
3047  * \li Action: Inserts Nomenclature entry.
3048  * \li Notion: It automatically takes the word on the cursor position if no symbol is given.
3049  * \li Syntax: nomencl-insert [<SYMBOL>]
3050  * \li Origin: Ugras, 4 Nov 2006
3051  * \endvar
3052  */
3053                 { LFUN_NOMENCL_INSERT, "nomencl-insert", Noop, Edit },
3054
3055 /*!
3056  * \var lyx::FuncCode lyx::LFUN_NOMENCLATURE_PRINT
3057  * \li Action: Inserts list of Nomenclature entries.
3058  * \li Syntax: nomenclature-print
3059  * \li Origin: Ugras, 4 Nov 2006
3060  * \endvar
3061  */
3062                 { LFUN_NOMENCL_PRINT, "nomencl-print", Noop, Edit },
3063
3064
3065 /*!
3066  * \var lyx::FuncCode lyx::LFUN_NOTE_INSERT
3067  * \li Action: Inserts Note on the current cursor position,
3068                move selection inside the inset.
3069  * \li Syntax: note-insert [<TYPE>]
3070  * \li Params: <TYPE>: <Note|Greyedout|Comment> default: Note
3071  * \endvar
3072  */
3073                 { LFUN_NOTE_INSERT, "note-insert", Noop, Edit },
3074
3075 /*!
3076  * \var lyx::FuncCode lyx::LFUN_NOTE_NEXT
3077  * \li Action: Moves the cursor to the beginning of next Note inset.
3078  * \li Syntax: note-next
3079  * \endvar
3080  */
3081                 { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
3082
3083 /*!
3084  * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
3085  * \li Action: Move the current group in the downward direction in the
3086                structure of the document.
3087  * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
3088                the whole substructure of the group.
3089  * \li Syntax: outline-down
3090  * \li Origin: Vermeer, 23 Mar 2006
3091  * \endvar
3092  */
3093                 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
3094
3095 /*!
3096  * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
3097  * \li Action: Moves the current group in the downward direction in the
3098                hierarchy of the document structure.
3099  * \li Notion: Part -> Chapter -> Section -> etc.
3100  * \li Syntax: outline-in
3101  * \li Origin: Vermeer, 23 Mar 2006
3102  * \endvar
3103  */
3104                 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
3105
3106 /*!
3107  * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
3108  * \li Action: Moves the current group in the upward direction in the
3109                hierarchy of the document structure.
3110  * \li Notion: Part <- Chapter <- Section <- etc.
3111  * \li Syntax: outline-out
3112  * \li Origin: Vermeer, 23 Mar 2006
3113  * \endvar
3114  */
3115                 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
3116
3117
3118 /*!
3119  * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
3120  * \li Action: Move the current group in the upward direction in the
3121                structure of the document.
3122  * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
3123                the whole substructure of the group.
3124  * \li Syntax: outline-up
3125  * \li Origin: Vermeer, 23 Mar 2006
3126  * \endvar
3127  */
3128                 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
3129
3130 /*!
3131  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_BREAK
3132  * \li Action: Breaks the current paragraph at the current location.
3133  * \li Notion: Removes the selection.
3134  * \li Syntax: paragraph-break [<LAYOUT>] [ignoresep]
3135  * \li Params: <LAYOUT>: "inverse" - decreases depth by one (or change layout
3136                          to default layout) when the cursor is at the end of
3137                          the line.\n
3138                ignoresep: Do not account for paragraph separators while breaking.
3139  * \endvar
3140  */
3141                 { LFUN_PARAGRAPH_BREAK, "paragraph-break", Noop, Edit },
3142
3143 /*!
3144  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN
3145  * \li Action: Move the cursor to the next paragraph (or beginning of the current one)
3146                in downward direction.
3147  * \li Syntax: paragraph-down
3148  * \li Origin: Asger, 1 Oct 1996
3149  * \endvar
3150  */
3151                 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
3152
3153 /*!
3154  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN_SELECT
3155  * \li Action: Move the cursor and select the text to the next paragraph (or
3156                beginning of the current one) in downward direction.
3157  * \li Syntax: paragraph-down-select
3158  * \li Origin: Asger, 1 Oct 1996
3159  * \endvar
3160  */
3161                 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
3162
3163 /*!
3164  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
3165  * \li Action: Jump to a paragraph given by its id number and optionally the
3166                desired position within the paragraph.
3167                If given four arguments id_start, pos_start, id_end, pos_end,
3168                perform a selection from start to end.
3169  * \li Notion: Note that id number of paragraph is not the sequential number of
3170                paragraph seen on the screen. Moreover the id is unique for all
3171                opened buffers (documents). Both ids must belong to the same
3172                buffer.
3173  * \li Syntax: paragraph-goto <PAR_ID> <POS_IN_PAR> [<PAR_ID> <POS_IN_PAR>]
3174  * \li Params: <PAR_ID>:  paragraph id \n
3175                <POS_IN_PAR>: desired position within the paragraph
3176  * \li Origin: Dekel, 26 Aug 2000
3177                gmunch, 5 Sep 2016
3178  * \endvar
3179  */
3180                 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly | NoInternal, Edit },
3181
3182 /*!
3183  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
3184  * \li Action: Moves the current paragraph downwards in the document.
3185  * \li Syntax: paragraph-move-down
3186  * \li Origin: Edwin, 8 Apr 2006
3187  * \endvar
3188  */
3189                 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
3190
3191 /*!
3192  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
3193  * \li Action: Moves the current paragraph upwards in the document.
3194  * \li Notion: Movement through the document will possibly break the paragraph-depth
3195                (e.g. itemize structure).
3196  * \li Syntax: paragraph-move-up
3197  * \li Origin: Edwin, 8 Apr 2006
3198  * \endvar
3199  */
3200                 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
3201
3202
3203 /*!
3204  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
3205  * \li Action: Change paragraph settings.
3206  * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
3207                This function only modifies, and does not override, existing settings.
3208                Note that the "leftindent" indent setting is deprecated.
3209  * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
3210  * \li Params: <INDENT>:  \noindent|\indent|\indent-toggle|\leftindent LENGTH\n
3211                <SPACING>: \paragraph_spacing default|single|onehalf|double|other SIZE \n
3212                <ALIGN>:   \align block|left|right|center|default\n
3213                <OTHERS>:  \labelwidthstring WIDTH|\start_of_appendix
3214  * \li Origin: rgh, Aug 15 2007
3215  * \endvar
3216  */
3217                 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
3218
3219 /*!
3220  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
3221  * \li Action: Change paragraph settings.
3222  * \li Notion: Overwrite all nonspecified settings to the default ones.
3223                Use paragraph-params lfun if you don't want to overwrite others settings.
3224  * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
3225  * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
3226  * \li Origin: leeming, 30 Mar 2004
3227  * \endvar
3228  */
3229                 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
3230
3231 /*!
3232  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP
3233  * \li Action: Move the cursor to the next paragraph (or beginning of the current one)
3234                in upward direction.
3235  * \li Syntax: paragraph-up
3236  * \li Origin: Asger, 1 Oct 1996
3237  * \endvar
3238  */
3239                 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
3240
3241 /*!
3242  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UPDATE
3243  * \li Action: Updates the values inside the paragraph dialog from the paragraph.
3244  * \li Notion: This is an internal LFUN, not to be used by users. Called internally
3245                by #LFUN_DIALOG_UPDATE.
3246  * \li Origin: leeming, 13 Mar 2003
3247  * \endvar
3248  */
3249                 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
3250
3251
3252 /*!
3253  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP_SELECT
3254  * \li Action: Move the cursor and select the text to the next paragraph (or
3255                beginning of the current one) in upward direction.
3256  * \li Syntax: paragraph-up-select
3257  * \li Origin: Asger, 1 Oct 1996
3258  * \endvar
3259  */
3260                 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
3261
3262 /*!
3263  * \var lyx::FuncCode lyx::LFUN_PASTE
3264  * \li Action: Pastes material (text or picture) from the active clipboard.
3265  * \li Syntax: paste [<TYPE>|<NUM>]
3266  * \li Params: <TYPE>: emf|pdf|png|jpeg|linkback|wmf|latex|html \n
3267                <NUM>: number of the selection in the internal clipboard stack to be pasted.
3268  * \endvar
3269  */
3270                 { LFUN_PASTE, "paste", Noop, Edit },
3271
3272 /*!
3273  * \var lyx::FuncCode lyx::LFUN_PHANTOM_INSERT
3274  * \li Action: Inserts phantom on the current cursor position,
3275                move selection inside the inset.
3276  * \li Syntax: phantom-insert [<TYPE>]
3277  * \li Params: <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
3278  * \li Origin: uwestoehr, 30 Jan 2009
3279  * \endvar
3280  */
3281                 { LFUN_PHANTOM_INSERT, "phantom-insert", Noop, Edit },
3282
3283 /*!
3284  * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
3285  * \li Action: Save user preferences.
3286  * \li Syntax: preferences-save
3287  * \li Origin: Lgb, 27 Nov 1999
3288  * \endvar
3289  */
3290                 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
3291
3292 /*!
3293  * \var lyx::FuncCode lyx::LFUN_PREVIEW_INSERT
3294  * \li Action: Inserts a new preview inset.
3295  * \li Syntax: preview-insert
3296  * \li Origin: vfr, 28 Mar 2010
3297  * \endvar
3298  */
3299                 { LFUN_PREVIEW_INSERT, "preview-insert", Noop, Edit },
3300
3301 /*!
3302  * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
3303  * \li Action: Pastes the currently selected text.
3304  * \li Notion: Primary selection mechanism is linux-only thing.
3305  * \li Syntax: primary-selection-paste [<ARG>]
3306  * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
3307  * \endvar
3308  */
3309                 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
3310
3311 /*!
3312  * \var lyx::FuncCode lyx::LFUN_QUOTE_INSERT
3313  * \li Action: Inserts quotes according to the type and quote-language preference.
3314  * \li Notion: Currently 15 different quote styles are distinguished (see params).
3315  * \li Syntax: quote-insert [<LEVEL>] [<SIDE>] [<STYLE>]
3316  * \li Params: <LEVEL>: 'inner' for (i.e., secondary, usually single) quotes, otherwise
3317  *                       outer (i.e., primary, usually double) quotes will be used.\n
3318  *             <SIDE>:  'opening' for opening quotes, 'closing' for closing quotes,
3319  *                       otherwise the side will be guessed from the context.\n
3320  *             <STYLE>: 'british' for `British' quote style (with ``inner quotation'')\n
3321  *                      'cjk' for Chinese/Japanese/Korean corner bracket quotation marks\n
3322  *                      'cjk-angle' for Chinese/Japanese/Korean angle bracket quotation marks\n
3323  *                      'danish' for >>Danish<< quote style (with >inner quotation<)\n
3324  *                      'english' for ``English'' quote style (with `inner quotation')\n
3325  *                      'french' for <<french>> quote style (with ``inner quotation'')\n
3326  *                      'frenchin' for <<frenchin>> quote style (with <<inner quotation>>) ["in" = Imprimerie Nationale]\n
3327  *                      'german' for ,,German`` quote style (with ,inner quotation`)\n
3328  *                      'plain' for "Plain" quote style (with 'inner quotation')\n
3329  *                      'polish' for ,,Polish'' quote style (with ,inner quotation')\n
3330  *                      'swedish' for ''Swedish'' quote style (with 'inner quotation')\n
3331  *                      'swedishg' for >>swedishg>> quote style (with 'inner quotation') ["g" = Guillemets]\n
3332  *                      'swiss' for <<Swiss>> quote style (with <inner quotation>)\n
3333  *                      'russian' for <<Russian>> quote style (with ,,inner quotation``)\n
3334  *                      'dynamic' for Dynamic quotation marks which inherit the global
3335  *                                document style\n
3336  *                      If no quote style is specified, the document-wide will be used.
3337  * \endvar
3338  */
3339                 { LFUN_QUOTE_INSERT, "quote-insert", Noop, Edit },
3340
3341 /*!
3342  * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
3343  * \li Action: Reconfigure the automatic settings.
3344  * \li Syntax: reconfigure
3345  * \li Origin: Asger, 14 Feb 1997
3346  * \endvar
3347  */
3348                 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
3349
3350 /*!
3351  * \var lyx::FuncCode lyx::LFUN_REDO
3352  * \li Action: Redoes the last thing undone.
3353  * \li Syntax: redo
3354  * \endvar
3355  */
3356                 { LFUN_REDO, "redo", ReadOnly, Edit },
3357
3358 /*!
3359  * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
3360  * \li Action: Go to the next label or cross-reference.
3361  * \li Syntax: reference-next
3362  * \li Origin: Dekel, 14 Jan 2001
3363  * \endvar
3364  */
3365                 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
3366
3367
3368 /*!
3369  * \var lyx::FuncCode lyx::LFUN_REGEXP_MODE
3370  * \li Action: Enters regexp mode (i.e., puts regexp insets on the current
3371                cursor position). Used by the advanced search dialog.
3372  * \li Notion: If there is any selected text, then it is moved inside the created
3373                regexp inset.
3374  * \li Syntax: regexp-mode [<ARG>]
3375  * \li Params: <ARG>: eventual argument (regular expression).
3376  * \li Origin: Tommaso, 4 Oct 2008
3377  * \endvar
3378  */
3379                 { LFUN_REGEXP_MODE, "regexp-mode", Noop, Math },
3380
3381 /*!
3382  * \var lyx::FuncCode lyx::LFUN_REPEAT
3383  * \li Action: Repeat the given command.
3384  * \li Notion: fails when the repeat count is greater than 10000.
3385  * \li Syntax: repeat <COUNT> <LFUN-COMMAND>
3386  * \li Origin: Andre, 27 Oct 2003
3387  * \endvar
3388  */
3389                 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
3390
3391 /*!
3392  * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN
3393  * \li Action: Moves the cursor one page in downward direction.
3394  * \li Syntax: screen-down
3395  * \endvar
3396  */
3397                 { LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit },
3398
3399 /*!
3400  * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN_SELECT
3401  * \li Action: Moves the cursor one screen in downward direction adding the current
3402                position to the selection.
3403  * \li Syntax: screen-down-select
3404  * \endvar
3405  */
3406                 { LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit },
3407
3408 /*!
3409  * \var lyx::FuncCode lyx::LFUN_SCREEN_FONT_UPDATE
3410  * \li Action: Update fonts and its metrics.
3411  * \li Notion: Automatically called after zoom, dpi, font names, or norm change.
3412  * \li Syntax: screen-font-update
3413  * \li Origin: ARRae, 13 Aug 2000
3414  * \endvar
3415  */
3416                 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
3417
3418 /*!
3419  * \var lyx::FuncCode lyx::LFUN_SCREEN_RECENTER
3420  * \li Action: Recenters the screen on the current cursor position.
3421  * \li Syntax: screen-recenter
3422  * \endvar
3423  */
3424                 { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit },
3425
3426
3427 /*!
3428  * \var lyx::FuncCode lyx::LFUN_SCREEN_SHOW_CURSOR
3429  * \li Action: Repositions the screen such that the cursor is visible.
3430  * \li Syntax: screen-show-cursor
3431  * \li Origin: vfr, 25 Mar 2009
3432  * \endvar
3433  */
3434                 { LFUN_SCREEN_SHOW_CURSOR, "screen-show-cursor", ReadOnly, Edit },
3435
3436
3437 /*!
3438  * \var lyx::FuncCode lyx::LFUN_SCREEN_UP
3439  * \li Action: Moves the cursor one page in upward direction.
3440  * \li Syntax: screen-up
3441  * \endvar
3442  */
3443                 { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit },
3444
3445 /*!
3446  * \var lyx::FuncCode lyx::LFUN_SCREEN_UP_SELECT
3447  * \li Action: Moves the cursor one page in upward direction adding the current
3448                position to the selection.
3449  * \li Syntax: screen-up-select
3450  * \endvar
3451  */
3452                 { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit },
3453
3454 /*!
3455  * \var lyx::FuncCode lyx::LFUN_SCRIPT_INSERT
3456  * \li Action: Inserts a subscript or superscript inset.
3457  * \li Syntax: script-insert <TYPE>
3458  * \li Params: <TYPE>: subscript|superscript
3459  * \li Origin: Georg, 23 Nov 2010
3460  * \endvar
3461  */
3462                 { LFUN_SCRIPT_INSERT, "script-insert", Noop, Edit },
3463
3464 /*!
3465  * \var lyx::FuncCode lyx::LFUN_SCROLL
3466  * \li Action: Scroll the buffer view.
3467  * \li Notion: Only scrolls the screen up or down; does not move the cursor.
3468  * \li Syntax: scroll <TYPE> <QUANTITY>
3469  * \li Params: <TYPE>:  line|page\n
3470                <QUANTITY>: up|down|<number>
3471  * \li Origin: Abdel, Dec 27 2007
3472  * \endvar
3473  */
3474                 { LFUN_SCROLL, "scroll", ReadOnly, Edit },
3475
3476 /*!
3477  * \var lyx::FuncCode lyx::LFUN_SECTION_SELECT
3478  * \li Action: Select the whole section.
3479  * \li Notion: The cursor should be in a section heading
3480                before calling this lfun.
3481  * \li Syntax: section-select
3482  * \li Origin: vfr, 05 May 2009
3483  * \endvar
3484  */
3485                 { LFUN_SECTION_SELECT, "section-select", ReadOnly, Edit },
3486
3487
3488 /*!
3489  * \var lyx::FuncCode lyx::LFUN_SELECTION_PASTE
3490  * \li Action: Pastes the internal selection text in permanent selection.
3491  * \li Notion: Created in order to have middle mouse button pasting correct (bound to
3492                command-alternatives selection-paste ; primary-selection-paste paragraph).
3493  * \li Syntax: selection-paste
3494  * \li Origin: lasgouttes, 14 Jan 2009
3495  * \endvar
3496  */
3497                 { LFUN_SELECTION_PASTE, "selection-paste", Noop, Edit },
3498
3499 /*!
3500  * \var lyx::FuncCode lyx::LFUN_SELF_INSERT
3501  * \li Action: Inserts the given string (accordingly to the correct keymap).
3502  * \li Notion: Automatically replace the currently selected text. Depends on lyxrc
3503                settings "auto_region_delete".
3504  * \li Syntax: self-insert <STRING>
3505  * \endvar
3506  */
3507                 { LFUN_SELF_INSERT, "self-insert", SingleParUpdate, Hidden },
3508
3509 /*!
3510  * \var lyx::FuncCode lyx::LFUN_SEPARATOR_INSERT
3511  * \li Action: Inserts an environment separator or latex paragraph break.
3512  * \li Syntax: separator-insert [<ARG>]
3513  * \li Params: <ARG>: <plain|parbreak|latexpar> default: plain
3514  * \li Origin: ef, 2 May 2014
3515  * \endvar
3516  */
3517                 { LFUN_SEPARATOR_INSERT, "separator-insert", Noop, Edit },
3518
3519 /*!
3520  * \var lyx::FuncCode lyx::LFUN_SERVER_GET_FILENAME
3521  * \li Action: Returns path and file name of the currently edited document.
3522  * \li Syntax: server-get-filename
3523  * \endvar
3524  */
3525                 { LFUN_SERVER_GET_FILENAME, "server-get-filename", ReadOnly, System },
3526
3527 /*!
3528  * \var lyx::FuncCode lyx::LFUN_SERVER_GET_LAYOUT
3529  * \li Action: Returns the current layout (that is environment) name
3530                on the cursor position.
3531  * \li Syntax: server-get-layout
3532  * \endvar
3533  */
3534                 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
3535
3536 /*!
3537  * \var lyx::FuncCode lyx::LFUN_SERVER_GET_STATISTICS
3538  * \li Action: Returns the statistics (number of words and characters)
3539                in the document or in the given selection.
3540  * \li Notion: Note that this function gives the number of words/chars written,
3541                not the number of characters which will be typeset.
3542  * \li Syntax: server-get-statistics [<TYPE>]
3543  * \li Params: <TYPE>: <words|chars|chars-space> The requested count; if not
3544                        specified, the three values are returned, separated
3545                        by a space.\n
3546                 words: count words.\n
3547                 chars: count characters.\n
3548                 chars-space: count characters and spaces.
3549  * \li Origin: brokenclock, Oct 10 2014
3550  * \endvar
3551  */
3552                 { LFUN_SERVER_GET_STATISTICS, "server-get-statistics", ReadOnly, System },
3553
3554 /*!
3555  * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
3556  * \li Action: Returns the coordinates of cursor position in the editing area.
3557  * \li Syntax: server-get-xy
3558  * \endvar
3559  */
3560                 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
3561
3562
3563 /*!
3564  * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
3565  * \li Action: Sets the cursor position in LyX based on the row number of generated TeX file.
3566  * \li Notion: This can be useful for DVI inverse-search or detection of the problematic
3567                line from LaTeX compilation. Note that before this function can be used
3568                export to LaTeX output must occur (in order to map the row numbers).
3569  * \li Syntax: server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
3570  * \li Params: <FILE>: the path and filename. Environment variables are expanded in the path.
3571                        In case this LFUN does not work make sure you are giving correct
3572                        path to the file.\n
3573                        If the file is located inside LyX temporary directory it will be
3574                        mapped back into the appropriate opened buffer (e.g. for the case
3575                        of generated .tex file).\n
3576                  .ext: extensions will be automatically replaced by .lyx.\n
3577                  <ROW_NUMBER> The row number of the LaTeX file to which to go.
3578  * \li Sample: server-goto-file-row /home/user/example.lyx 41\n
3579                server-goto-file-row /tmp/lyx_tmpdir.XM3088/lyx_tmpbuf0/example.tex 41
3580  * \li Origin: Edmar, 23 Dec 1998
3581  * \endvar
3582  */
3583                 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly | NoBuffer, System },
3584
3585 /*!
3586  * \var lyx::FuncCode lyx::LFUN_SERVER_NOTIFY
3587  * \li Action: Sends notify message about the last key-sequence to client.
3588  * \li Notion: This can be used to grab last key-sequence used inside the LyX window.
3589                See also Debug extensions section in Additional features manual.
3590  * \li Syntax: server-notify
3591  * \endvar
3592  */
3593                 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
3594
3595 /*!
3596  * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
3597  * \li Action: Sets the cursor position based on the editing area coordinates
3598                (similar to clicking on that point with left mouse button).
3599  * \li Syntax: server-set-xy <X> <Y>
3600  * \endvar
3601  */
3602                 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
3603
3604 /*!
3605  * \var lyx::FuncCode lyx::LFUN_SET_COLOR
3606  * \li Action: Set the given LyX color to the color defined by the X11 name given.
3607  * \li Notion: A new color entry is created if the color is unknown.
3608                Color names can be stored as a part of user settings.
3609  * \li Syntax: set-color <LYX_NAME> <X11_NAME>
3610  * \li Origin: SLior, 11 Jun 2000
3611  * \endvar
3612  */
3613                 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
3614
3615 /*!
3616  * \var lyx::FuncCode lyx::LFUN_GRAPHICS_SET_GROUP
3617  * \li Action: Set the group for the graphics inset on the cursor position.
3618  * \li Syntax: graphics-set-group [<GROUP>]
3619  * \li Params: <GROUP>: Id for an existing group. In case the Id is an empty string,
3620                         the graphics inset is removed from the current group.
3621  * \li Origin: sanda, 6 May 2008
3622  * \endvar
3623  */
3624                 { LFUN_GRAPHICS_SET_GROUP, "graphics-set-group", Noop, Edit },
3625
3626 /*!
3627  * \var lyx::FuncCode lyx::LFUN_GRAPHICS_UNIFY
3628  * \li Action: Set the same group for all graphics insets in the marked block.
3629  * \li Syntax: graphics-unify [<GROUP>]
3630  * \li Params: <GROUP>: Id for an existing group. In case the Id is an empty string,
3631                         the group Id from the first graphics inset will be used.
3632  * \li Origin: sanda, 7 Feb 2018
3633  * \endvar
3634  */
3635                 { LFUN_GRAPHICS_UNIFY, "graphics-unify", Noop, Edit },
3636
3637 /*!
3638  * \var lyx::FuncCode lyx::LFUN_GRAPHICS_RELOAD
3639  * \li Action: Reloads the image if necessary.
3640  * \li Syntax: graphics-reload
3641  * \li Origin: vfr, 10 Aug 2009
3642  * \endvar
3643  */
3644                 { LFUN_GRAPHICS_RELOAD, "graphics-reload", ReadOnly | AtPoint, Edit },
3645
3646 /*!
3647  * \var lyx::FuncCode lyx::LFUN_SPACE_INSERT
3648  * \li Action: Inserts one of horizontal space insets.
3649  * \li Syntax: space-insert <NAME> [<LEN>]
3650  * \li Params: <NAME>: normal, protected, visible, thin, quad, qquad, enspace,
3651                        enskip, negthinspace, negmedspace, negthickspace, hfill,
3652                        hfill*, dotfill, hrulefill, hspace, hspace* \n
3653                        Only in math mode: med and thick.\n
3654                <LEN>: length for custom spaces (hspace, hspace* for protected)
3655  * \li Origin: spitz, 20 May 2003, Mar 17 2008
3656  * \endvar
3657  */
3658                 { LFUN_SPACE_INSERT, "space-insert", Noop, Edit },
3659
3660 /*!
3661  * \var lyx::FuncCode lyx::LFUN_SPECIALCHAR_INSERT
3662  * \li Action: Inserts various characters into the document.
3663  * \li Syntax: specialchar-insert <CHAR>
3664  * \li Params: <CHAR>: hyphenation, allowbreak, ligature-break, slash,
3665                        nobreakdash, dots, end-of-sentence, menu-separator,
3666                        lyx, tex, latex, latex2e.
3667  * \li Origin: spitz, 6 Dec 2007
3668  * \endvar
3669  */
3670                 { LFUN_SPECIALCHAR_INSERT, "specialchar-insert", Noop, Edit },
3671
3672 /*!
3673  * \var lyx::FuncCode lyx::LFUN_SPELLING_ADD
3674  * \li Action: Add the word under the cursor to the respective
3675  *             spell checker dictionary.
3676  *             The default for the language is retrieved from the cursor position.
3677  * \li Syntax: spelling-add [<STRING>] [<LANG>]
3678  * \li Params: <WORD>: word to add
3679                <LANG>: language name (see file languages)
3680  * \li Origin: spitz, 18 Jan 2010
3681  * \endvar
3682  */
3683                 { LFUN_SPELLING_ADD, "spelling-add", ReadOnly, Edit },
3684
3685 /*!
3686  * \var lyx::FuncCode lyx::LFUN_SPELLING_CONTINUOUSLY
3687  * \li Action: Toggle continuous spell checking.
3688  * \li Syntax: spelling-continuously
3689  * \li Origin: vfr, 24 March 2013
3690  * \endvar
3691  */
3692                 { LFUN_SPELLING_CONTINUOUSLY, "spelling-continuously", ReadOnly, Edit },
3693
3694
3695 /*!
3696  * \var lyx::FuncCode lyx::LFUN_SPELLING_IGNORE
3697  * \li Action: Let the spell checker ignore the word under the cursor
3698  *             in the current session for the given language.
3699  *             The default for the language is retrieved from the cursor position.
3700  * \li Syntax: spelling-ignore [<WORD>] [<LANG>]
3701  * \li Params: <WORD>: word to ignore
3702                <LANG>: language name (see file languages)
3703  * \li Origin: spitz, 18 Jan 2010
3704  * \endvar
3705  */
3706                 { LFUN_SPELLING_IGNORE, "spelling-ignore", ReadOnly, Edit },
3707
3708 /*!
3709  * \var lyx::FuncCode lyx::LFUN_SPELLING_REMOVE
3710  * \li Action: Remove the word under the cursor from the respective
3711  *             spell checker dictionary.
3712  *             The default for the language is retrieved from the cursor position.
3713  * \li Syntax: spelling-remove [<STRING>] [<LANG>]
3714  * \li Params: <WORD>: word to remove
3715  *             <LANG>: language name (see file languages)
3716  * \li Origin: SWitt, 28 July 2010
3717  * \endvar
3718  */
3719                 { LFUN_SPELLING_REMOVE, "spelling-remove", ReadOnly, Edit },
3720
3721
3722 /*!
3723  * \var lyx::FuncCode lyx::LFUN_STATISTICS
3724  * \li Action: Count the statistics (number of words and characters)
3725                in the document or in the given selection and display it
3726                in a dialog box.
3727  * \li Notion: Note that this function gives the number of words/chars written,
3728                not the number of characters which will be typeset.
3729  * \li Syntax: statistics
3730  * \li Origin: lasgouttes, Jan 27 2004; sanda, Jan 8 2008
3731  * \endvar
3732  */
3733                 { LFUN_STATISTICS, "statistics", ReadOnly, System },
3734
3735 /*!
3736  * \var lyx::FuncCode lyx::LFUN_TABULAR_FEATURE
3737  * \li Action: Modify properties of tabulars and table-like math environments.
3738  * \li Syntax: tabular-feature <FEATURE> [<ARG>]
3739  * \li Params: Generally see #LFUN_INSET_INSERT for further details.\n
3740  *             <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|\n
3741                        copy-column|move-column-right|move-column-left|move-row-down|move-row-up|\n
3742                        toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|\n
3743                        align-left|align-right|align-center|align-block|align-decimal|set-decimal-point|\n
3744                        valign-top|valign-bottom|valign-middle|longtabular-align-left|\n
3745                        longtabular-align-center|longtabular-align-right|m-align-left|m-align-right|\n
3746                        m-align-center|m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|\n
3747                        set-all-lines|unset-all-lines|toggle-longtabular|set-longtabular|unset-longtabular|set-pwidth|\n
3748                        set-mpwidth|set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|\n
3749                        set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|\n
3750                        unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|\n
3751                        set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|\n
3752                        set-special-column|set-special-multicolumn|set-special-multirow|\n
3753                        toggle-booktabs|set-booktabs|unset-booktabs|set-top-space|set-bottom-space|\n
3754                        set-interline-space|set-border-lines|tabular-valign-top|\n
3755                        tabular-valign-middle|tabular-valign-bottom|set-tabular-width|\n
3756                        toggle-varwidth-column
3757                Various math-environment features are handled as well, e.g. add-vline-left/right for\n
3758                the Grid/Array environment.\n
3759                <ARG>: additional argument for some commands, use debug mode to explore its values.
3760  * \li Origin: gm, 10 Dec 2015
3761  * \endvar
3762  */
3763                 { LFUN_TABULAR_FEATURE, "tabular-feature", Noop, Edit },
3764
3765 /*!
3766  * \var lyx::FuncCode lyx::LFUN_TABULAR_INSERT
3767  * \li Action: Inserts table into the document.
3768  * \li Notion: See #LFUN_TABULAR_FEATURE for some more details
3769                about tabular modifications.
3770  * \li Syntax: tabular-insert [<ROWS> <COLUMNS>]
3771  * \li Params: In case no arguments are given show insert dialog.
3772  * \li Origin: Jug, 12 Apr 2000
3773  * \endvar
3774  */
3775                 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
3776
3777
3778 /*!
3779  * \var lyx::FuncCode lyx::LFUN_TAB_DELETE
3780  * \li Action: Delete a tab or up to an equivalent amount of spaces from
3781                a listings inset.
3782  * \li Notion: It also works on a selection - it removes a tab or spaces from the
3783                beginning of each line spanned by the selection. This is useful if
3784                you want to indent/unindent multiple lines in one action.
3785  * \li Syntax: tab-delete
3786  * \li Origin: vfr, Sep 30 2008
3787  * \endvar
3788  */
3789                 { LFUN_TAB_DELETE, "tab-delete", SingleParUpdate, Edit },
3790
3791 /*!
3792  * \var lyx::FuncCode lyx::LFUN_TAB_GROUP_CLOSE
3793  * \li Action: Close the current tab group.
3794  * \li Notion: This only closes the work areas, not the buffers themselves.
3795                The still opened buffers can be visualized in another tab group.
3796  * \li Syntax: tab-group-close
3797  * \li Origin: Abdel, 21 Feb 2008
3798  * \endvar
3799  */
3800                 { LFUN_TAB_GROUP_CLOSE, "tab-group-close", ReadOnly, Buffer },
3801
3802
3803 /*!
3804  * \var lyx::FuncCode lyx::LFUN_TAB_INSERT
3805  * \li Action: Insert a tab into a listings inset.
3806  * \li Notion: It also works on a selection.
3807  * \li Syntax: tab-insert
3808  * \li Origin: vfr, Sep 30 2008
3809  * \endvar
3810  */
3811                 { LFUN_TAB_INSERT, "tab-insert", SingleParUpdate, Edit },
3812
3813 /*!
3814  * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
3815  * \li Action: Sets the text class for the current buffer.
3816  * \li Syntax: textclass-apply <TEXTCLASS>
3817  * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
3818                    the filename, minus the ".layout" extension.
3819  * \endvar
3820  */
3821                 { LFUN_TEXTCLASS_APPLY, "textclass-apply", NoInternal, Layout },
3822
3823 /*!
3824  * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
3825  * \li Action: Loads information for a textclass from disk.
3826  * \li Syntax: textclass-load <TEXTCLASS>
3827  * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
3828                    the filename, minus the ".layout" extension.
3829  * \endvar
3830  */
3831                 { LFUN_TEXTCLASS_LOAD, "textclass-load", NoInternal, Layout },
3832
3833
3834 /*!
3835  * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_APPLY
3836  * \li Action: Toggle user-defined (=last-time used) text style.
3837  * \li Notion: This style is set via #LFUN_TEXTSTYLE_UPDATE, which is
3838                automatically triggered when using Text Style dialog.
3839  * \li Syntax: textstyle-apply
3840  * \li Origin: leeming, 12 Mar 2003
3841  * \endvar
3842  */
3843                 { LFUN_TEXTSTYLE_APPLY, "textstyle-apply", Noop, Layout },
3844
3845 /*!
3846  * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_UPDATE
3847  * \li Action: Apply text style and update the settings to be used by #LFUN_TEXTSTYLE_APPLY.
3848  * \li Syntax: textstyle-update <FONT_INFO>
3849  * \li Params: <FONT_INFO>: specifies font attributes, e.g. family, series, shape,
3850                             size, emph, noun, underbar, number, color, language,
3851                             toggleall.\n
3852                             Use lyx -dbg action for exact syntax of text-style
3853                             dialog parameters.
3854  * \li Origin: leeming, 12 Mar 2003
3855  * \endvar
3856  */
3857                 { LFUN_TEXTSTYLE_UPDATE, "textstyle-update", Noop, Layout },
3858
3859 /*!
3860  * \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
3861  * \li Action: Look up thesaurus entries with respect to the word under the cursor.
3862  * \li Syntax: thesaurus-entry [<STRING>] [lang=<LANG>]
3863  * \li Params: <STRING>: word to look up
3864                <LANG>: language (see file languages)
3865  * \li Origin: Levon, 20 Jul 2001
3866  * \endvar
3867  */
3868                 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
3869
3870 /*!
3871  * \var lyx::FuncCode lyx::LFUN_TOOLBAR_MOVABLE
3872  * \li Action: Toggles movability of a given toolbar between true/false.
3873  * \li Syntax: toolbar-movable <NAME>
3874  * \li Params: <NAME>: *|standard|extra|table|math|mathmacrotemplate|
3875                         minibuffer|review|view/update|math_panels|vcs|
3876                         view-others|update-others
3877 * \li Origin: daniel, 12 July 2016
3878 * \endvar
3879 */
3880                 { LFUN_TOOLBAR_MOVABLE, "toolbar-movable", NoBuffer, Buffer },
3881
3882 /*!
3883  * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
3884  * \li Action: Toggles visibility of a given toolbar between on/off/auto.
3885  * \li Notion: Skipping "auto" when allowauto is false.
3886  * \li Syntax: toolbar-toggle <NAME> [allowauto]
3887  * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|\n
3888                        minibuffer|review|view/update|math_panels|vcs|
3889                        view-others|update-others
3890  * \li Origin: Edwin, 21 May 2007
3891  * \endvar
3892  */
3893                 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
3894
3895 /*!
3896  * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
3897  * \li Action: Various UI visibility-toggling actions.
3898  * \li Syntax: ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
3899  * \li Params: statusbar  : Toggle visibility of the statusbar.\n
3900                menubar    : Toggle visibility of the menubar.\n
3901                scrollbar  : Toggle visibility of the scrollbar.\n
3902                frame      : Toggle visibility of the frames around editing window.\n
3903                fullscreen : Toggle fullscreen mode. This also covers calling the
3904                             previous functions. However #LFUN_TOOLBAR_TOGGLE for the
3905                             custom tweaks of the toolbars should be used.
3906  * \li Origin: sanda, 9 Feb 2007
3907  * \endvar
3908  */
3909                 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
3910
3911
3912 /*!
3913  * \var lyx::FuncCode lyx::LFUN_UNDO
3914  * \li Action: Undoes the last edit.
3915  * \li Syntax: undo
3916  * \endvar
3917  */
3918                 { LFUN_UNDO, "undo", ReadOnly, Edit },
3919
3920 /*!
3921  * \var lyx::FuncCode lyx::LFUN_UNICODE_INSERT
3922  * \li Action: Inserts a single unicode character.
3923  * \li Syntax: unicode-insert <CHAR1> <CHAR2> ...
3924  * \li Params: <CHARn>: The character to insert, given as its code
3925                        point, in hexadecimal.
3926  * \li Sample: unicode-insert 0x0100 0x0259
3927  * \li Origin: Lgb, 22 Oct 2006
3928  * \endvar
3929  */
3930                 { LFUN_UNICODE_INSERT, "unicode-insert", Noop, Edit },
3931
3932 /*!
3933  * \var lyx::FuncCode lyx::LFUN_UP
3934  * \li Action: Moves the cursor one line in upward direction.
3935  * \li Syntax: up
3936  * \endvar
3937  */
3938                 { LFUN_UP, "up", ReadOnly | NoUpdate, Edit },
3939
3940 /*!
3941  * \var lyx::FuncCode lyx::LFUN_UP_SELECT
3942  * \li Action: Moves the cursor one line in upward direction adding the current
3943                position to the selection.
3944  * \li Syntax: up-select
3945  * \endvar
3946  */
3947                 { LFUN_UP_SELECT, "up-select", ReadOnly | SingleParUpdate, Edit },
3948
3949 /*!
3950  * \var lyx::FuncCode lyx::LFUN_VC_CHECK_IN
3951  * \li Action: Checks-in/commits the changes of the registered file to the repository.
3952  * \li Notion: In RCS case this also unlocks the file.
3953  * \li Syntax: vc-check-in
3954  * \li Origin: Lgb, 1 Jul 1997
3955  * \endvar
3956  */
3957                 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
3958
3959 /*!
3960  * \var lyx::FuncCode lyx::LFUN_VC_CHECK_OUT
3961  * \li Action: Checks-out the document for edit (and locks it in some cases).
3962  * \li Syntax: vc-check-out
3963  * \li Origin: Lgb, 1 Jul 1997
3964  * \endvar
3965  */
3966                 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
3967
3968 /*!
3969  * \var lyx::FuncCode lyx::LFUN_VC_COMMAND
3970  * \li Action: Executes external command. This command is intended to support
3971                additional VCS commands.
3972  * \li Syntax: vc-command <FLAG> <PATH> <COMMAND>
3973  * \li Params:  <FLAG>: Flags for the command can be combined together.\n
3974                         U - dUmmy - no flags \n
3975                         D - Doc - need document loaded to proceed \n
3976                         I - dIrty - mark document dirty \n
3977                         R - Reload - ensure that the document is saved and reload it after command execution \n
3978                         M - Message - ask for input string (commit message)\n
3979                 <PATH>: path where to start. $$p will be replaced by the current document path.\n
3980                 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current
3981                            document(with absolute path)/path/message.
3982  * \li Sample: vc-command DR $$p "svn up"
3983  * \li Origin: sanda, 13 Jan 2009
3984  * \endvar
3985  */
3986                 { LFUN_VC_COMMAND, "vc-command", NoBuffer | ReadOnly, System },
3987
3988 /*!
3989  * \var lyx::FuncCode lyx::LFUN_VC_COMPARE
3990  * \li Action: Compares two revisions of the same file under version control.
3991  * \li Syntax: vc-compare [<REV1>] [<REV2>]
3992  * \li Params: Revision number either points directly to commit in history
3993                or if negative number -x it points to (last commit - x).\n
3994                In RCS we subtract only in the last number of revision specification.
3995                Special case "0" is reserved for the last committed revision.\n
3996                <REV1>: Older file.\n
3997                <REV2>: Newer file. Used only if REV1 > 0.\n
3998                If no parameter is given, interactive dialog will be shown.
3999  * \li Sample: Compare current document against last commit\n
4000                vc-compare 0\n
4001                Compare current document against current revision - 5 commits\n
4002                vc-compare -5\n
4003                Compare revisions 120 and 155\n
4004                vc-compare 120 155
4005  * \li Origin: sanda, 12 Feb 2010
4006  * \endvar
4007  */
4008                 { LFUN_VC_COMPARE, "vc-compare", ReadOnly, System },
4009
4010
4011 /*!
4012  * \var lyx::FuncCode lyx::LFUN_VC_COPY
4013  * \li Action: Copies the document to another name.
4014  * \li Notion: Copying with revision history is only supported by SVN.
4015                For RCS and CVS it is simulated by adding the document
4016                under a new name.
4017                Disabled if uncommitted changes exist.
4018  * \li Syntax: vc-copy <FILENAME>
4019  * \li Params: <FILENAME>: New name of the document.\n
4020  *             A file dialog is opened if no filename is given.
4021  * \li Origin: gb, 05 Feb 2013
4022  * \endvar
4023  */
4024                 { LFUN_VC_COPY, "vc-copy", ReadOnly, System },
4025
4026 /*!
4027  * \var lyx::FuncCode lyx::LFUN_VC_LOCKING_TOGGLE
4028  * \li Action: Toggles the locking property of the edited file.
4029  * \li Notion: This is currently implemented only for SVN.
4030  * \li Syntax: vc-locking-toggle
4031  * \li Origin: sanda, 25 Jun 2009
4032  * \endvar
4033  */
4034                 { LFUN_VC_LOCKING_TOGGLE, "vc-locking-toggle", ReadOnly, System },
4035
4036 /*!
4037  * \var lyx::FuncCode lyx::LFUN_VC_REGISTER
4038  * \li Action: Register the document as an file inside version control system.
4039  * \li Notion: File is registered inside cvs, svn or rcs repository acording to the existence
4040                of cvs/svn/rcs entries in the document's directory. \n
4041                See LyX Additional Features Manual (Version Control Chapter) for additional
4042                information.
4043  * \li Syntax: vc-register
4044  * \li Origin: Lgb, 1 Jul 1997
4045  * \endvar
4046  */
4047                 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
4048
4049 /*!
4050  * \var lyx::FuncCode lyx::LFUN_VC_RENAME
4051  * \li Action: Renames the document to another name.
4052  * \li Notion: Renaming with revision history is only supported by SVN.
4053                For CVS it is simulated by adding the document under a new
4054                name and deleting the old one. For RCS it is not supported.
4055                Disabled if uncommitted changes exist.
4056  * \li Syntax: vc-rename <FILENAME>
4057  * \li Params: <FILENAME>: New name of the document.\n
4058  *             A file dialog is opened if no filename is given.
4059  * \li Origin: gb, 05 Feb 2013
4060  * \endvar
4061  */
4062                 { LFUN_VC_RENAME, "vc-rename", ReadOnly, System },
4063
4064 /*!
4065  * \var lyx::FuncCode lyx::LFUN_VC_REPO_UPDATE
4066  * \li Action: Update the local archive directory in which resides
4067                the current document with the remote repository.
4068  * \li Syntax: vc-repo-update
4069  * \li Origin: sanda, 16 Oct 2009
4070  * \endvar
4071  */
4072                 { LFUN_VC_REPO_UPDATE, "vc-repo-update", ReadOnly, System },
4073
4074 /*!
4075  * \var lyx::FuncCode lyx::LFUN_VC_REVERT
4076  * \li Action: Reverts the document to the last check-in/commit in VCS.
4077  * \li Syntax: vc-revert
4078  * \li Origin: Lgb, 1 Jul 1997
4079  * \endvar
4080  */
4081                 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
4082
4083 /*!
4084  * \var lyx::FuncCode lyx::LFUN_VC_UNDO_LAST
4085  * \li Action: Undo last check-in.
4086  * \li Notion: This is currently implemented only for RCS.
4087  * \li Syntax: vc-check-out
4088  * \li Origin: Lgb, 1 Jul 1997
4089  * \endvar
4090  */
4091                 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
4092
4093 /*!
4094  * \var lyx::FuncCode lyx::LFUN_VIEW_CLOSE
4095  * \li Action: Close the current document work area.
4096  * \li Notion: Close the current work area. If no other work areas are showing the buffer,
4097                then close the associated buffer as well.
4098  * \li Syntax: view-close
4099  * \li Origin: Tommaso, 15 Sep 2012
4100  * \endvar
4101  */
4102                 { LFUN_VIEW_CLOSE, "view-close", ReadOnly, Buffer },
4103
4104
4105 /*!
4106  * \var lyx::FuncCode lyx::LFUN_VIEW_SPLIT
4107  * \li Action: Creates another split view of current buffer.
4108  * \li Notion: All split views act in the same way independently.
4109  * \li Syntax: view-split <vertical|horizontal>
4110  * \li Params: horizontal : The work areas are laid out side by side.\n
4111                vertical   : The work areas laid out vertically.
4112  * \li Origin: Abdel, 20 Feb 2008
4113  * \endvar
4114  */
4115                 { LFUN_VIEW_SPLIT, "view-split", ReadOnly, Buffer },
4116
4117
4118 /*!
4119  * \var lyx::FuncCode lyx::LFUN_WINDOW_CLOSE
4120  * \li Action: Closes the current LyX window.
4121  * \li Syntax: window-close
4122  * \li Origin: Abdel, 23 Oct 2006
4123  * \endvar
4124  */
4125                 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
4126
4127
4128 /*!
4129  * \var lyx::FuncCode lyx::LFUN_WINDOW_NEW
4130  * \li Action: Creates new empty LyX window.
4131  * \li Notion: Already opened documents from the previous window can be found under View menu.
4132  * \li Syntax: window-new [<GEOMETRY>]
4133  * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently
4134                            accepted only on Windows platform.
4135  * \li Origin: Abdel, 21 Oct 2006
4136  * \endvar
4137  */
4138                 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
4139
4140 /*!
4141  * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD
4142  * \li Action: Moves the cursor to the logically previous beginning of a word.
4143  * \li Notion: This is not the action which should be bound to the arrow keys,
4144                because backwards may be left or right, depending on the
4145                language. The arrow keys should be bound to #LFUN_WORD_LEFT or
4146                #LFUN_WORD_RIGHT actions, which in turn may employ this one.
4147  * \li Syntax: word-backward
4148  * \endvar
4149  */
4150                 { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit },
4151
4152 /*!
4153  * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD_SELECT
4154  * \li Action: Moves the cursor to the logically previous beginning of a word,
4155                adding the logically traversed text to the selection.
4156  * \li Notion: See also #LFUN_WORD_BACKWARD.
4157  * \li Syntax: word-backward-select
4158  * \endvar
4159  */
4160                 { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
4161
4162 /*!
4163  * \var lyx::FuncCode lyx::LFUN_WORD_CAPITALIZE
4164  * \li Action: Capitalizes the words in the selection (i.e. the first letters)
4165                or the first letter of word at cursor position.
4166  * \li Syntax: word-capitalize [<SEL_TYPE>]
4167  * \li Params: <SEL_TYPE>: if this is equal to "partial", then the
4168  *             default word starts at cursor position (emacs-style).
4169  *             Otherwise, the whole word is considered.
4170  * \endvar
4171  */
4172                 { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
4173
4174 /*!
4175  * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_BACKWARD
4176  * \li Action: Deletes characters to the beginning of the word (usually the "C+BackSpace" key).
4177  * \li Syntax: word-delete-backward [force]
4178  * \li Params: force: Delete big insets, do not only select them.
4179  * \endvar
4180  */
4181                 { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
4182
4183 /*!
4184  * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_FORWARD
4185  * \li Action: Deletes characters to the end of the word (usually the "C+Delete" key).
4186  * \li Syntax: word-delete-forward [force]
4187  * \li Params: force: Delete big insets, do not only select them.
4188  * \endvar
4189  */
4190                 { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
4191
4192 /*!
4193  * \var lyx::FuncCode lyx::LFUN_WORD_FIND
4194  * \li Action: Search for next occurrence of a string.
4195  * \li Syntax: word-find [<DATA>]
4196  * \li Params: <DATA>: data encoded from Find dialog (see #lyx::find2string()).
4197                        If no parameter is given, search with last find-dialog
4198                        data is used for search (i.e. find-next).
4199  * \li Origin: Andre, Jan 7 2004
4200  * \endvar
4201  */
4202                 { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
4203
4204 /*!
4205  * \var lyx::FuncCode lyx::LFUN_WORD_FINDADV
4206  * \li Action: Search for next occurrence of a pattern.
4207  * \li Syntax: word-findadv [<DATA>]
4208  * \li Params: <DATA>: data encoded from FindAdv dialog (see #lyx::findadv2string()).
4209                        If no parameter is given, search with last find-dialog
4210                        data is used for search (i.e. find-next).
4211  * \li Origin: Tommaso, Nov 15 2007
4212  * \endvar
4213  */
4214                 { LFUN_WORD_FINDADV, "word-findadv", ReadOnly | NoBuffer, Edit },
4215
4216 /*!
4217  * \var lyx::FuncCode lyx::LFUN_WORD_FIND_BACKWARD
4218  * \li Action: Search for a given string in backward direction.
4219  * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
4220  * \li Syntax: word-find-backward [<STRING>]
4221  * \li Origin: Etienne, 20 Feb 1998
4222  * \endvar
4223  */
4224                 { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
4225
4226 /*!
4227  * \var lyx::FuncCode lyx::LFUN_WORD_FIND_FORWARD
4228  * \li Action: Search for a given string in forward direction.
4229  * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
4230  * \li Syntax: word-find-forward [<STRING>]
4231  * \li Origin: Etienne, 16 Feb 1998
4232  * \endvar
4233  */
4234                 { LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit },
4235
4236 /*!
4237  * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD
4238  * \li Action: Moves the cursor to the logically next beginning of a word.
4239  * \li Notion: This is not the action which should be bound to the arrow keys,
4240                because forward may be left or right, depending on the language.
4241                The arrow keys should be bound to #LFUN_WORD_LEFT or
4242                #LFUN_WORD_RIGHT actions, which in turn may employ this one.
4243  * \li Syntax: word-forward
4244  * \endvar
4245  */
4246                 { LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
4247
4248 /*!
4249  * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD_SELECT
4250  * \li Action: Moves the cursor to the logically next beginning of a word,
4251                adding the logically traversed text to the selection.
4252  * \li Notion: See also #LFUN_WORD_FORWARD.
4253  * \li Syntax: word-forward-select
4254  * \endvar
4255  */
4256                 { LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
4257
4258 /*!
4259  * \var lyx::FuncCode lyx::LFUN_WORD_LEFT
4260  * \li Action: Moves the cursor to the next beginning of a word "on the left".
4261  * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
4262                "left" key is pressed. Generally, it moves the cursor to the
4263                next beginning of a word on the left. However, in Bidi text this
4264                become slightly more complicated, and there are different modes
4265                of cursor movement. In "visual mode", this moves left, plain and
4266                simple. In "logical mode", movement is logically forward in RTL
4267                paragraphs, and logically backwards in LTR paragraphs.
4268  * \li Syntax: word-left
4269  * \li Origin: dov, 28 Oct 2007
4270  * \endvar
4271  */
4272                 { LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
4273
4274 /*!
4275  * \var lyx::FuncCode lyx::LFUN_WORD_LEFT_SELECT
4276  * \li Action: Moves the cursor to the next beginning of a word "on the left",
4277                adding *logically* traversed text to the selection.
4278  * \li Notion: See also #LFUN_WORD_LEFT for exact details of the movement.
4279  * \li Syntax: word-left-select
4280  * \li Origin: dov, 28 Oct 2007
4281  * \endvar
4282  */
4283                 { LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit },
4284
4285 /*!
4286  * \var lyx::FuncCode lyx::LFUN_WORD_LOWCASE
4287  * \li Action: Change the words in the selection or word at cursor position
4288                to lower case.
4289  * \li Syntax: word-lowcase [<SEL_TYPE>]
4290  * \li Params: <SEL_TYPE>: if this is equal to "partial", then the
4291  *             default word starts at cursor position (emacs-style).
4292  *             Otherwise, the whole word is considered.
4293  * \endvar
4294  */
4295                 { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
4296
4297 /*!
4298  * \var lyx::FuncCode lyx::LFUN_WORD_REPLACE
4299  * \li Action: Replace a string in the document.
4300  * \li Syntax: word-replace [<DATA>]
4301  * \li Params: <DATA>: data is of the form
4302                        "<replacestring> \n
4303                         <searchstring> \n
4304                         <casesensitive> <matchword> <all> <forward> <findnext>"
4305  * \li Origin: Andre, Jan 7 2004
4306  * \endvar
4307  */
4308                 { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
4309
4310 /*!
4311  * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT
4312  * \li Action: Moves the cursor to the next beginning of a word "on the right".
4313  * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
4314                "right" key is pressed. Generally, it moves the cursor to the
4315                next beginning of a word on the right. However, in Bidi text
4316                this become slightly more complicated, and there are different
4317                modes of cursor movement. In "visual mode", this moves right,
4318                plain and simple. In "logical mode", movement is logically
4319                forward in LTR paragraphs, and logically backwards in RTL
4320                paragraphs.
4321  * \li Syntax: word-right
4322  * \li Origin: dov, 28 Oct 2007
4323  * \endvar
4324  */
4325                 { LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit },
4326
4327 /*!
4328  * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT_SELECT
4329  * \li Action: Moves the cursor to the next beginning of a word "on the right",
4330                adding *logically* traversed text to the selection.
4331  * \li Notion: See also #LFUN_WORD_RIGHT for exact details of the movement.
4332  * \li Syntax: word-right-select
4333  * \li Origin: dov, 28 Oct 2007
4334  * \endvar
4335  */
4336                 { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
4337
4338 /*!
4339  * \var lyx::FuncCode lyx::LFUN_WORD_SELECT
4340  * \li Action: Puts the word where the cursor stands into the selection.
4341  * \li Syntax: word-select
4342  * \li Origin: Andre, 11 Sep 2002
4343  * \endvar
4344  */
4345                 { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
4346
4347 /*!
4348  * \var lyx::FuncCode lyx::LFUN_WORD_UPCASE
4349  * \li Action: Change the words in the selection or word at cursor position
4350                to upper case.
4351  * \li Syntax: word-upcase [<SEL_TYPE>]
4352  * \li Params: <SEL_TYPE>: if this is equal to "partial", then the
4353  *             default word starts at cursor position (emacs-style).
4354  *             Otherwise, the whole word is considered.
4355  * \endvar
4356  */
4357                 { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
4358
4359 /*!
4360  * \var lyx::FuncCode lyx::LFUN_WRAP_INSERT
4361  * \li Action: Inserts floats wrapped by the text around.
4362  * \li Syntax: wrap-insert <TYPE>
4363  * \li Params: <TYPE>: table|figure
4364  * \li Origin: Dekel, 7 Apr 2002
4365  * \endvar
4366  */
4367                 { LFUN_WRAP_INSERT, "wrap-insert", Noop, Edit },
4368
4369                 { LFUN_NOACTION, "", Noop, Hidden }
4370 #ifndef DOXYGEN_SHOULD_SKIP_THIS
4371         };
4372
4373         for (int i = 0; items[i].action != LFUN_NOACTION; ++i)
4374                 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
4375
4376         init = true;
4377 }
4378 #endif
4379
4380 LyXAction::LyXAction()
4381 {
4382         init();
4383 }
4384
4385
4386 FuncRequest LyXAction::lookupFunc(string const & func) const
4387 {
4388         string const func2 = trim(func);
4389
4390         if (func2.empty())
4391                 return FuncRequest(LFUN_NOACTION);
4392
4393         string cmd;
4394         string const arg = split(func2, cmd, ' ');
4395
4396         FuncMap::const_iterator const fit = lyx_func_map.find(cmd);
4397
4398         return fit != lyx_func_map.end()
4399                         ? FuncRequest(fit->second, arg)
4400                         : FuncRequest(LFUN_UNKNOWN_ACTION);
4401 }
4402
4403
4404 string const LyXAction::getActionName(FuncCode action) const
4405 {
4406         InfoMap::const_iterator const it = lyx_info_map.find(action);
4407         return it != lyx_info_map.end() ? it->second.name : string();
4408 }
4409
4410
4411 LyXAction::FuncType LyXAction::getActionType(FuncCode action) const
4412 {
4413         InfoMap::const_iterator const it = lyx_info_map.find(action);
4414         return it != lyx_info_map.end() ? it->second.type : Hidden;
4415 }
4416
4417
4418 bool LyXAction::funcHasFlag(FuncCode action,
4419                             LyXAction::FuncAttribs flag) const
4420 {
4421         InfoMap::const_iterator ici = lyx_info_map.find(action);
4422
4423         if (ici == lyx_info_map.end()) {
4424                 LYXERR0("action: " << action << " is not known.");
4425                 LASSERT(false, return false);
4426         }
4427
4428         return ici->second.attrib & flag;
4429 }
4430
4431
4432 LyXAction::const_iterator LyXAction::func_begin() const
4433 {
4434         return lyx_func_map.begin();
4435 }
4436
4437
4438 LyXAction::const_iterator LyXAction::func_end() const
4439 {
4440         return lyx_func_map.end();
4441 }
4442
4443
4444 LyXErr & operator<<(LyXErr & l, FuncCode code)
4445 {
4446         if (l.enabled())
4447                 l.stream() << lyxaction.getActionName(code);
4448         return l;
4449 }
4450
4451 } // namespace lyx