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