]> git.lyx.org Git - lyx.git/blob - src/LyXAction.cpp
Fix compilation for clang 3.7 with libc++
[lyx.git] / src / LyXAction.cpp
1 /*!
2  * \file LyXAction.cpp
3  * This file is part of LyX, the document processor.
4  * Licence details can be found in the file COPYING.
5  *
6  * \author Lars Gullik Bjønnes
7  * \author Jean-Marc Lasgouttes
8  * \author John Levon
9  * \author André Pönitz
10  * \author Pavel Sanda
11  *
12  * Full author contact details are available in file CREDITS.
13  */
14
15 #include <config.h>
16
17 #include "LyXAction.h"
18
19 #include "FuncRequest.h"
20
21 #include "support/debug.h"
22 #include "support/lstrings.h"
23
24 #include "support/lassert.h"
25
26 #include <iostream>
27
28 using namespace std;
29 using namespace lyx::support;
30
31 namespace lyx {
32
33 /*
34      NAMING RULES FOR USER-COMMANDS
35      Here's the set of rules to apply when a new command name is introduced:
36
37      1) Use the object.event order. That is, use `word-forward'
38         instead of `forward-word'.
39      2) Don't introduce an alias for an already named object. Same for events.
40      3) Forward movement or focus is called `forward' (not `right').
41      4) Backward movement or focus is called `backward' (not `left').
42      5) Upward movement of focus is called `up'.
43      6) Downward movement is called `down'.
44      7) The begin of an object is called `begin' (not `start').
45      8) The end of an object is called `end'.
46
47      (May 19 1996, 12:04, RvdK)
48 */
49
50 /* LFUN documentation
51  *
52  * The documentation below primarily describes the purpose and syntax
53  * of the various LFUNs.
54  *
55  * The list is alphabetized. Try to keep it that way, and don't forget to add
56  * doxygen commentary. This allows the file LFUNs.lyx to be auto-generated.
57  * (If you should want to do that, see the gen_lfuns.py script, which is in
58  * the development/tools/ directory.)
59  *
60  * Doxygen template below. Some notes: Parameters should be set in uppercase
61  * and put in <BRACKETS>, [<PARAM>] means optional one.
62  *
63  * Use spaces for indentation (doxy -> .lyx generator is tab-sensitive).
64  */
65
66 /*!
67  * \var lyx::FuncCode lyx::LFUN_
68  * \li Action:
69  * \li Notion:
70  * \li Syntax:
71  * \li Params:
72  * \li Sample:
73  * \li Origin:
74  * \endvar
75  */
76
77 LyXAction lyxaction;
78
79
80 void LyXAction::newFunc(FuncCode action, string const & name,
81                         unsigned int attrib, LyXAction::FuncType type)
82 {
83         lyx_func_map[name] = action;
84         FuncInfo tmpinfo;
85         tmpinfo.name = name;
86         tmpinfo.attrib = attrib;
87         tmpinfo.type = type;
88         lyx_info_map[action] = tmpinfo;
89 }
90
91
92 // Needed for LFUNs documentation to be accepted, since doxygen won't take
93 // \var inside functions.
94 #ifndef DOXYGEN_SHOULD_SKIP_THIS
95 void LyXAction::init()
96 {
97         // This function was changed to use the array below in initalization
98         // instead of calling newFunc numerous times because of compilation
99         // times. Since the array is not static we get back the memory it
100         // occupies after the init is completed. It compiles several
101         // magnitudes faster.
102
103         static bool init;
104         if (init)
105                 return;
106
107         struct ev_item {
108                 FuncCode action;
109                 char const * name;
110                 unsigned int attrib;
111                 FuncType type;
112         };
113
114         ev_item const items[] = {
115 #endif
116
117 /*!
118  * \var lyx::FuncCode lyx::LFUN_ACCENT_ACUTE
119  * \li Action: Adds an acute accent \htmlonly (&aacute;)\endhtmlonly
120                to the next character typed.
121  * \li Syntax: accent-acute
122  * \endvar
123  */
124                 { LFUN_ACCENT_ACUTE, "accent-acute", Noop, Edit },
125
126 /*!
127  * \var lyx::FuncCode lyx::LFUN_ACCENT_BREVE
128  * \li Action: Adds a breve accent \htmlonly (&#259;)\endhtmlonly
129                to the next character typed.
130  * \li Syntax: accent-breve
131  * \endvar
132  */
133                 { LFUN_ACCENT_BREVE, "accent-breve", Noop, Edit },
134
135 /*!
136  * \var lyx::FuncCode lyx::LFUN_ACCENT_CARON
137  * \li Action: Adds a caron \htmlonly (&#462;)\endhtmlonly
138                to the next character typed.
139  * \li Syntax: accent-caron
140  * \endvar
141  */
142                 { LFUN_ACCENT_CARON, "accent-caron", Noop, Edit },
143
144 /*!
145  * \var lyx::FuncCode lyx::LFUN_ACCENT_CEDILLA
146  * \li Action: Adds a cedilla \htmlonly (&ccedil;)\endhtmlonly
147                to the next character typed.
148  * \li Syntax: accent-cedilla
149  * \endvar
150  */
151                 { LFUN_ACCENT_CEDILLA, "accent-cedilla", Noop, Edit },
152
153 /*!
154  * \var lyx::FuncCode lyx::LFUN_ACCENT_CIRCLE
155  * \li Action: Adds a circle accent \htmlonly (&aring;)\endhtmlonly
156                to the next character typed.
157  * \li Syntax: accent-circle
158  * \endvar
159  */
160                 { LFUN_ACCENT_CIRCLE, "accent-circle", Noop, Edit },
161
162 /*!
163  * \var lyx::FuncCode lyx::LFUN_ACCENT_CIRCUMFLEX
164  * \li Action: Adds a circumflex \htmlonly (&ecirc;)\endhtmlonly
165                to the next character typed.
166  * \li Syntax: accent-circumflex
167  * \endvar
168  */
169                 { LFUN_ACCENT_CIRCUMFLEX, "accent-circumflex", Noop, Edit },
170
171 /*!
172  * \var lyx::FuncCode lyx::LFUN_ACCENT_DOT
173  * \li Action: Adds a dot accent \htmlonly (&#380;)\endhtmlonly
174                to the next character typed.
175  * \li Syntax: accent-dot
176  * \endvar
177  */
178                 { LFUN_ACCENT_DOT, "accent-dot", Noop, Edit },
179
180 /*!
181  * \var lyx::FuncCode lyx::LFUN_ACCENT_GRAVE
182  * \li Action: Adds a grave accent \htmlonly (&egrave;)\endhtmlonly
183                to the next character typed.
184  * \li Syntax: accent-grave
185  * \endvar
186  */
187                 { LFUN_ACCENT_GRAVE, "accent-grave", Noop, Edit },
188
189 /*!
190  * \var lyx::FuncCode lyx::LFUN_ACCENT_HUNGARIAN_UMLAUT
191  * \li Action: Adds a Hungarian umlaut \htmlonly (&#337;)\endhtmlonly
192                to the next character typed.
193  * \li Syntax: accent-grave
194  * \endvar
195  */
196                 { LFUN_ACCENT_HUNGARIAN_UMLAUT, "accent-hungarian-umlaut", Noop, Edit },
197
198 /*!
199  * \var lyx::FuncCode lyx::LFUN_ACCENT_MACRON
200  * \li Action: Adds a macron \htmlonly (&#257;)\endhtmlonly
201                to the next character typed.
202  * \li Syntax: accent-macron
203  * \endvar
204  */
205                 { LFUN_ACCENT_MACRON, "accent-macron", Noop, Edit },
206
207 /*!
208  * \var lyx::FuncCode lyx::LFUN_ACCENT_OGONEK
209  * \li Action: Adds an ogonek accent \htmlonly (&#261;)\endhtmlonly
210                to the next character typed.
211  * \li Syntax: accent-ogonek
212  * \endvar
213  */
214                 { LFUN_ACCENT_OGONEK, "accent-ogonek", Noop, Edit },
215
216 /*!
217  * \var lyx::FuncCode lyx::LFUN_ACCENT_PERISPOMENI
218  * \li Action: Adds a perispomeni (Greek circumflex)
219                over the next character typed.
220  * \li Syntax: accent-perispomeni
221  * \endvar
222  */
223                 { LFUN_ACCENT_PERISPOMENI, "accent-perispomeni", Noop, Edit },
224
225 /*!
226  * \var lyx::FuncCode lyx::LFUN_ACCENT_TIE
227  * \li Action: Adds a tie \htmlonly (a&#865;)\endhtmlonly
228                over the next two character typed.
229  * \li Notion: The following char will finish the tie.
230  * \li Syntax: accent-tie
231  * \endvar
232  */
233                 { LFUN_ACCENT_TIE, "accent-tie", Noop, Edit },
234
235 /*!
236  * \var lyx::FuncCode lyx::LFUN_ACCENT_TILDE
237  * \li Action: Adds a tilde \htmlonly (&atilde;)\endhtmlonly
238                over the next character typed.
239  * \li Syntax: accent-tilde
240  * \endvar
241  */
242                 { LFUN_ACCENT_TILDE, "accent-tilde", Noop, Edit },
243
244 /*!
245  * \var lyx::FuncCode lyx::LFUN_ACCENT_UMLAUT
246  * \li Action: Adds an umlaut \htmlonly (&auml;)\endhtmlonly
247                over the next character typed.
248  * \li Syntax: accent-umlaut
249  * \endvar
250  */
251                 { LFUN_ACCENT_UMLAUT, "accent-umlaut", Noop, Edit },
252
253 /*!
254  * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERBAR
255  * \li Action: Adds a bar \htmlonly (a&#800;)\endhtmlonly
256                under the next character typed.
257  * \li Syntax: accent-underbar
258  * \endvar
259  */
260                 { LFUN_ACCENT_UNDERBAR, "accent-underbar", Noop, Edit },
261
262 /*!
263  * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERDOT
264  * \li Action: Adds a dot \htmlonly (&#7841;)\endhtmlonly
265                under the next character typed.
266  * \li Syntax: accent-underdot
267  * \endvar
268  */
269                 { LFUN_ACCENT_UNDERDOT, "accent-underdot", Noop, Edit },
270
271
272 /*!
273  * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_ACCEPT
274  * \li Action: Accepts all tracked changes in the document.
275  * \li Syntax: all-changes-accept
276  * \li Origin: Levon, 16 Oct 2002
277  * \endvar
278  */
279                 { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
280
281 /*!
282  * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_REJECT
283  * \li Action: Rejects all tracked changes in the document.
284  * \li Notion: Reject does not work recursively; the user may have to repeat the operation.
285  * \li Syntax: all-changes-reject
286  * \li Origin: Levon, 16 Oct 2002
287  * \endvar
288  */
289                 { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
290
291
292 /*!
293  * \var lyx::FuncCode lyx::LFUN_APPENDIX
294  * \li Action: Start (or remove) Appendix on the given cursor position.
295  * \li Syntax: appendix
296  * \li Origin: ettrich, 5 May 1998
297  * \endvar
298  */
299                 { LFUN_APPENDIX, "appendix", Noop, Edit },
300
301
302 /*!
303  * \var lyx::FuncCode lyx::LFUN_ARGUMENT_INSERT
304  * \li Action: Inserts an argument (short title) inset.
305  * \li Syntax: argument-insert <argument nr>
306  * \li Params: <argument nr>: see layout declarations
307  * \li Origin: vermeer, 12 Aug 2002
308  * \endvar
309  */
310                 { LFUN_ARGUMENT_INSERT, "argument-insert", Noop, Edit },
311
312 /*!
313  * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_ADD
314  * \li Action: Adds database, which will be used for bibtex citations.
315  * \li Notion: Databases are added to the first BibTeX inset
316                (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
317  * \li Syntax: bibtex-database-add <DATABASE-NAME>
318  * \li Origin: Ale, 30 May 1997
319  * \endvar
320  */
321                 { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit },
322
323 /*!
324  * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_DEL
325  * \li Action: Adds database, which will be used for bibtex citations.
326  * \li Notion: Databases are deleted from the first BibTeX inset
327                (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
328  * \li Syntax: bibtex-database-del <DATABASE-NAME>
329  * \li Origin: Ale, 30 May 1997
330  * \endvar
331  */
332                 { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
333
334
335 /*!
336  * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
337  * \li Action: Clears the list of saved bookmarks.
338  * \li Syntax: bookmark-clear
339  * \li Origin: bpeng, 31 October 2006
340  * \endvar
341  */
342                 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
343
344
345 /*!
346  * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
347  * \li Action: Moves the cursor to the numbered bookmark, opening the file
348                if necessary. Note that bookmarks are saved per-session, not
349                per file.
350  * \li Notion: Bookmark 0 has a special purpose. It is automatically set \n
351                1. to the paragraph you are currently editing \n
352                2. to the paragraph from where you are jumping to the last-edited
353                   position (jump-back feature) \n
354                3. when jumping from crossreference to the requested label by
355                   #LFUN_LABEL_GOTO.
356  * \li Syntax: bookmark-goto <NUMBER>
357  * \li Params: <NUMBER>: the number of the bookmark to restore.
358  * \li Origin: Dekel, 27 January 2001
359  * \endvar
360  */
361                 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
362
363 /*!
364  * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
365  * \li Action: Save a bookmark.
366  * \li Notion: Saves a numbered bookmark to the sessions file. The number
367                must be between 1 and 9, inclusive. Note that bookmarks are
368                saved per-session, not per file.
369  * \li Syntax: bookmark-save <NUMBER>
370  * \li Params: <NUMBER>: the number of the bookmark to save.
371  * \li Origin: Dekel, 27 January 2001
372  * \endvar
373  */
374                 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
375
376 /*!
377  * \var lyx::FuncCode lyx::LFUN_BOX_INSERT
378  * \li Action: Inserts Box inset.
379  * \li Syntax: box-insert [<TYPE>]
380  * \li Params: <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox \n
381                        Framed is the default one.
382  * \li Origin: vermeer, 7 Oct 2003
383  * \endvar
384  */
385                 { LFUN_BOX_INSERT, "box-insert", Noop, Edit },
386
387 /*!
388  * \var lyx::FuncCode lyx::LFUN_BRANCHES_RENAME
389  * \li Action: Rename all branches of a given name in a document.
390  * \li Syntax: branches-rename <OLDNAME> <NEWNAME>
391  * \li Params: <OLDNAME>: Current name of the branch to be renamed
392  *             <NEWNAME>: New name of the branch
393  * \li Origin: spitz, 9 Jul 2009
394  * \endvar
395  */
396                 { LFUN_BRANCHES_RENAME, "branches-rename", Noop, Buffer },
397
398 /*!
399  * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
400  * \li Action: Activate the branch.
401  * \li Syntax: branch-activate <BRANCH>
402  * \li Params: <BRANCH>: The branch to activate
403  * \li Sample: lyx -x "branch-activate answers" -e pdf2 finalexam.lyx \n
404                could be used to export a pdf with the answers branch included
405                without one's having to open LyX and activate the branch manually.
406  * \li Origin: rgh, 27 May 2008
407  * \endvar
408  */
409                 { LFUN_BRANCH_ACTIVATE, "branch-activate", AtPoint, Buffer },
410
411 /*!
412  * \var lyx::FuncCode lyx::LFUN_BRANCH_ADD
413  * \li Action: Add a branch to the buffer's BranchList.
414  * \li Syntax: branch-add <BRANCH>
415  * \li Params: <BRANCH>: Name of the branch to add
416  * \li Origin: spitz, 7 Jul 2009
417  * \endvar
418  */
419                 { LFUN_BRANCH_ADD, "branch-add", AtPoint, Buffer },
420
421
422
423 /*!
424  * \var lyx::FuncCode lyx::LFUN_BRANCH_ADD_INSERT
425  * \li Action: Create new branch and directly put the branch inset into
426                the document.
427  * \li Syntax: branch-add-insert [<NAME>]
428  * \li Params: <NAME>: Branch name. If it is not specified, you will be asked.
429  * \li Origin: sanda, 10 Jul 2009
430  * \endvar
431  */
432                 { LFUN_BRANCH_ADD_INSERT, "branch-add-insert", Noop, Buffer },
433
434
435
436 /*!
437  * \var lyx::FuncCode lyx::LFUN_BRANCH_DEACTIVATE
438  * \li Action: De-activate the branch.
439  * \li Syntax: branch-deactivate <BRANCH>
440  * \li Params: <BRANCH>: The branch to deactivate
441  * \li Origin: rgh, 27 May 2008
442  * \endvar
443  */
444                 { LFUN_BRANCH_DEACTIVATE, "branch-deactivate", AtPoint, Buffer },
445
446 /*!
447  * \var lyx::FuncCode lyx::LFUN_BRANCH_INSERT
448  * \li Action: Inserts branch inset.
449  * \li Syntax: branch-insert <BRANCH-NAME>
450  * \li Origin: vermeer, 17 Aug 2003
451  * \endvar
452  */
453                 { LFUN_BRANCH_INSERT, "branch-insert", Noop, Edit },
454
455 /*!
456  * \var lyx::FuncCode lyx::LFUN_BRANCH_INVERT
457  * \li Action: Toggles inversion status of branch inset.
458  * \li Syntax: branch-invert
459  * \li Origin: rgheck, 12 July 2016
460  * \endvar
461  */
462                 { LFUN_BRANCH_INVERT, "branch-invert", AtPoint, Buffer },
463
464
465 /*!
466  * \var lyx::FuncCode lyx::LFUN_BRANCH_MASTER_ACTIVATE
467  * \li Action: Activate the branch in the master buffer.
468  * \li Syntax: branch-master-activate <BRANCH>
469  * \li Params: <BRANCH>: The branch to activate
470  * \li Sample: lyx -x "branch-activate answers" -e pdf2 finalexam.lyx \n
471                could be used to export a pdf with the answers branch included
472                without one's having to open LyX and activate the branch manually.
473  * \li Origin: spitz, 30 Sep 2012
474  * \endvar
475  */
476                 { LFUN_BRANCH_MASTER_ACTIVATE, "branch-master-activate", AtPoint, Buffer },
477
478 /*!
479  * \var lyx::FuncCode lyx::LFUN_BRANCH_MASTER_DEACTIVATE
480  * \li Action: De-activate the branch in the master buffer.
481  * \li Syntax: branch-master-deactivate <BRANCH>
482  * \li Params: <BRANCH>: The branch to deactivate
483  * \li Origin: spitz, 30 Sep 2012
484  * \endvar
485  */
486                 { LFUN_BRANCH_MASTER_DEACTIVATE, "branch-master-deactivate", AtPoint, Buffer },
487
488
489 /*!
490  * \var lyx::FuncCode lyx::LFUN_BUFFER_ANONYMIZE
491  * \li Action: For debug purposes only. Convert all [a-zA-Z0-1] characters to
492                single character. Useful when submitting docs to list or bugzilla.
493  * \li Syntax: buffer-anonymize
494  * \li Origin: sanda, Feb 1 2018
495  * \endvar
496  */
497                 { LFUN_BUFFER_ANONYMIZE, "buffer-anonymize", Noop, Edit },
498
499
500 /*!
501  * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
502  * \li Action: Saves the current buffer to a temporary file.
503  * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
504                is called automatically by LyX, to "autosave" the current buffer.
505  * \li Syntax: buffer-auto-save
506  * \endvar
507  */
508                 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
509
510 /*!
511  * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN
512  * \li Action: Move the cursor to the beginning of the document.
513  * \li Syntax: buffer-begin
514  * \endvar
515  */
516                 { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
517
518 /*!
519  * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN_SELECT
520  * \li Action: Move the cursor to the beginning of the document adding the
521                traversed text to the selection.
522  * \li Syntax: buffer-begin-select
523  * \endvar
524  */
525                 { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
526
527 /*!
528  * \var lyx::FuncCode lyx::LFUN_BUFFER_CHILD_OPEN
529  * \li Action: Loads the given child document.
530  * \li Notion: The current document is treated as a parent.
531  * \li Syntax: buffer-child-open <FILE>
532  * \li Params: <FILE>: Filename of the child. The directory of the parent is assumed by default.
533  * \li Origin: Ale, 28 May 1997
534  * \endvar
535  */
536                 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
537
538 /*!
539  * \var lyx::FuncCode lyx::LFUN_BUFFER_CHKTEX
540  * \li Action: Runs chktex for the current document.
541  * \li Syntax: buffer-chktex
542  * \li Origin: Asger, 30 Oct 1997
543  * \endvar
544  */
545                 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
546
547 /*!
548  * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
549  * \li Action: Closes the current buffer.
550  * \li Notion: Closes the current buffer, asking whether to save it, etc,
551                if the buffer has been modified.
552  * \li Syntax: buffer-close
553  * \endvar
554  */
555                 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
556
557 /*!
558  * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE_ALL
559  * \li Action: Closes all buffers.
560  * \li Notion: Closes all buffers, asking whether to save it, etc,
561                if a buffer has been modified.
562  * \li Syntax: buffer-close-all
563  * \endvar
564  */
565                 { LFUN_BUFFER_CLOSE_ALL, "buffer-close-all", ReadOnly, Buffer },
566
567 /*!
568  * \var lyx::FuncCode lyx::LFUN_BUFFER_END
569  * \li Action: Move the cursor to the end of the document.
570  * \li Syntax: buffer-end
571  * \endvar
572  */
573                 { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
574
575 /*!
576  * \var lyx::FuncCode lyx::LFUN_BUFFER_END_SELECT
577  * \li Action: Move the cursor to the end of the document adding the
578                traversed text to the selection.
579  * \li Syntax: buffer-end-select
580  * \endvar
581  */
582                 { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
583
584
585 /*!
586  * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
587  * \li Action: Exports the current buffer (document) to the given format.
588  * \li Syntax: buffer-export [<FORMAT>] [<DEST>]
589  * \li Params: <FORMAT> is either "custom" or one of the formats which you
590                         can find in Tools->Preferences->File formats->Format.
591                         Usual format you will enter is "pdf2" (pdflatex),
592                         "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
593                         In case of "custom" you will be asked for a format you
594                         want to start from and for the command that you want to
595                         apply to this format. Internally the control is then passed
596                         to #LFUN_BUFFER_EXPORT_CUSTOM.\n
597                         If absent or "default", then the default output format of the
598                         document is used.\n
599                <DEST>   If present, this argument provides the export destination
600                         filename. Its containing folder will also be the destination
601                         folder, where all the needed external files will be copied.
602  * \li Origin: Lgb, 29 Jul 1997
603  * \endvar
604  */
605                 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
606
607 /*!
608  * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_AS
609  * \li Action: Opens a dialog for exporting the current buffer.
610  * \li Syntax: buffer-export-as [<FORMAT>]
611  * \li Params: <FORMAT> is the export format initially selected in the dialog.
612  *                      You can pass any of the formats which you can find in
613  *                      Tools->Preferences->File formats->Format, provided it
614  *                      has the "document" flag set. If no format is specified
615  *                      the dialog will start with the default output format of
616  *                      the current document.
617  * \li Sample: buffer-export-as pdf2
618  * \li Origin: tommaso, 6 Oct 2011
619  * \endvar
620  */
621                 { LFUN_BUFFER_EXPORT_AS, "buffer-export-as", ReadOnly, Buffer },
622
623 /*!
624  * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
625  * \li Action: Exports the current buffer (document) from the given format using
626                the given command on it.
627  * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
628  * \li Params: <FORMAT> format to start from (LyX will care to produce such
629                         intermediate file).\n
630                <COMMAND> this command will be launched on the file. Note that you can
631                          use "$$FName" string to qualify the intermediate file.
632  * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
633  * \li Origin: leeming, 27 Mar 2004
634  * \endvar
635  */
636                 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
637
638 /*!
639  * \var lyx::FuncCode lyx::LFUN_BUFFER_FORALL
640  * \li Action: Applies a command to all non-hidden buffers.
641  * \li Notion: a buffer is `hidden' if it is internally open in LyX, but not
642                visible in any window.
643  * \li Syntax: buffer-forall <LFUN-COMMAND>
644  * \li Params: <LFUN-COMMAND>: The command to be applied to the buffers.
645  * \li Sample: Close all Notes in buffers: \n
646                buffer-forall inset-forall Note inset-toggle close \n
647                Toggle change tracking on buffers: \n
648                buffer-forall changes-track \n
649                Toggle read-only for buffers: \n
650                buffer-forall buffer-toggle-read-only \n
651                Show statistics for individual buffers: \n
652                buffer-forall statistics \n
653                Activate the branch named "Solutions" in buffers: \n
654                buffer-forall branch-activate Solutions \n
655                Export buffers to PDF (pdflatex): \n
656                buffer-forall buffer-export pdf2 \n
657  * \li Origin: skostysh, 20 Jul 2012
658  * \endvar
659  */
660                 { LFUN_BUFFER_FORALL, "buffer-forall", ReadOnly | Argument, Buffer },
661
662 /*!
663  * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
664  * \li Action: Import a given file as a lyx document.
665  * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
666                defined converters in preferences. Look in the File->Import menu to get
667                an idea of the currently active import formats.
668  * \li Syntax: buffer-import <FORMAT> [<FILE>]
669  * \li Origin: Asger, 24 Jul 1998
670  * \endvar
671  */
672                 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
673
674 /*!
675  * \var lyx::FuncCode lyx::LFUN_BUFFER_LANGUAGE
676  * \li Action: Set language of the current document.
677  * \li Syntax: buffer-language <LANG>
678  * \li Params: <LANG>: language name. See lib/languages for list.
679  * \li Origin: leeming, 30 Mar 2004
680  * \endvar
681  */
682                 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
683
684 /*!
685  * \var lyx::FuncCode lyx::LFUN_BUFFER_MOVE_NEXT
686  * \li Action: Moves the current tab one spot to the right.
687  * \li Syntax: buffer-move-next
688  * \li Origin: skostysh, 7 Apr 2015
689  * \endvar
690  */
691                 { LFUN_BUFFER_MOVE_NEXT, "buffer-move-next", ReadOnly, Buffer },
692
693 /*!
694  * \var lyx::FuncCode lyx::LFUN_BUFFER_MOVE_PREVIOUS
695  * \li Action: Moves the current tab one spot to the left.
696  * \li Syntax: buffer-move-previous
697  * \li Origin: skostysh, 7 Apr 2015
698  * \endvar
699  */
700                 { LFUN_BUFFER_MOVE_PREVIOUS, "buffer-move-previous", ReadOnly, Buffer },
701
702 /*!
703  * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
704  * \li Action: Creates a new buffer (that is, document) and switches to it.
705  * \li Notion: Implicit path can be set in Preferences dialog.
706  * \li Syntax: buffer-new [<FILE>]
707  * \li Params: <FILE>: filename of created file with absolute path.
708  * \endvar
709  */
710                 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
711
712 /*!
713  * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
714  * \li Action: Creates a new buffer (that is, document) from a template.
715  * \li Notion: Path for new files and templates can be set in Preferences dialog.
716                Template will be asked for via Open-dialog.
717  * \li Syntax: buffer-new-template [<FILE>] [<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_FLEX_INSERT
1673  * \li Action: Inserts CharStyle, Custom inset or XML short element.
1674  * \li Notion: Look into the Customization manual for more information about
1675                these elements.\n
1676                To make this command enabled the layout file for the document
1677                class you're using has to load the character styles. There are
1678                a few contained in the Logical Markup module. You can also of
1679                course create some yourself. \n
1680                For dissolving the element see #LFUN_INSET_DISSOLVE.
1681  * \li Syntax: flex-insert Name
1682  * \li Params: Name: This name must be defined either in your layout file
1683                      or imported by some module. The definition is
1684                      InsetLayout Name or InsetLayout <Flex:Name>. The Flex:
1685                      prefix is optional.
1686  * \li Sample: flex-insert Code
1687  * \endvar
1688  */
1689                 { LFUN_FLEX_INSERT, "flex-insert", Noop, Edit },
1690
1691 /*!
1692  * \var lyx::FuncCode lyx::LFUN_FLOAT_INSERT
1693  * \li Action: Inserts a float inset.
1694  * \li Syntax: float-insert <TYPE>
1695  * \li Params: <TYPE>: type of float depends on the used textclass. Usually
1696                        "algorithm", "table", "figure" parameters can be given.
1697  * \li Origin: Lgb, 27 Jun 2000
1698  * \endvar
1699  */
1700                 { LFUN_FLOAT_INSERT, "float-insert", Noop, Edit },
1701
1702 /*!
1703  * \var lyx::FuncCode lyx::LFUN_FLOAT_LIST_INSERT
1704  * \li Action: Inserts the list of floats in the document.
1705  * \li Syntax: float-list-insert <TYPE>
1706  * \li Params: <TYPE>: type of float depends on the used textclass. Usually
1707                        "algorithm", "table", "figure" parameters can be given.
1708  * \li Origin: Lgb, 3 May 2001
1709  * \endvar
1710  */
1711                 { LFUN_FLOAT_LIST_INSERT, "float-list-insert", Noop, Edit },
1712
1713 /*!
1714  * \var lyx::FuncCode lyx::LFUN_FLOAT_WIDE_INSERT
1715  * \li Action: Inserts float insets as in #LFUN_FLOAT_INSERT but span multiple columns.
1716  * \li Notion: Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
1717  * \li Syntax: float-wide-insert <TYPE>
1718  * \li Params: <TYPE>: type of float depends on the used textclass. Usually
1719                        "algorithm", "table", "figure" parameters can be given.
1720  * \li Origin: Lgb, 31 Oct 2001
1721  * \endvar
1722  */
1723                 { LFUN_FLOAT_WIDE_INSERT, "float-wide-insert", Noop, Edit },
1724
1725 /*!
1726  * \var lyx::FuncCode lyx::LFUN_FONT_BOLD
1727  * \li Action: Toggles the bold font (selection-wise) using mathbf in math.
1728  * \li Syntax: font-bold
1729  * \endvar
1730  */
1731                 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
1732
1733
1734 /*!
1735  * \var lyx::FuncCode lyx::LFUN_FONT_BOLDSYMBOL
1736  * \li Action: Toggles the bold font (selection-wise) using boldsymbol in math.
1737  * \li Syntax: font-boldsymbol
1738  * \endvar
1739  */
1740                 { LFUN_FONT_BOLDSYMBOL, "font-boldsymbol", Noop, Layout },
1741
1742 /*!
1743  * \var lyx::FuncCode lyx::LFUN_FONT_DEFAULT
1744  * \li Action: Reverts the settings of the font to the default values (selection-wise).
1745  * \li Syntax: font-default
1746  * \endvar
1747  */
1748                 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
1749
1750 /*!
1751  * \var lyx::FuncCode lyx::LFUN_FONT_EMPH
1752  * \li Action: Toggles the emphasis font style (selection-wise).
1753  * \li Syntax: font-emph
1754  * \endvar
1755  */
1756                 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
1757
1758 /*!
1759  * \var lyx::FuncCode lyx::LFUN_FONT_FRAK
1760  * \li Action: Toggles Fraktur family font (math-mode, selection-wise).
1761  * \li Syntax: font-frak
1762  * \li Origin: vermeer, 10 Jan 2002
1763  * \endvar
1764  */
1765                 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
1766
1767 /*!
1768  * \var lyx::FuncCode lyx::LFUN_FONT_ITAL
1769  * \li Action: Toggles Italics font shape (math-mode, selection-wise).
1770  * \li Syntax: font-ital
1771  * \li Origin: vermeer, 10 Jan 2002
1772  * \endvar
1773  */
1774                 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
1775
1776 /*!
1777  * \var lyx::FuncCode lyx::LFUN_FONT_NOUN
1778  * \li Action: Toggles Noun text style font (selection-wise).
1779  * \li Syntax: font-noun
1780  * \endvar
1781  */
1782                 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
1783
1784 /*!
1785  * \var lyx::FuncCode lyx::LFUN_FONT_ROMAN
1786  * \li Action: Toggles Roman family font (selection-wise).
1787  * \li Syntax: font-roman
1788  * \endvar
1789  */
1790                 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
1791
1792 /*!
1793  * \var lyx::FuncCode lyx::LFUN_FONT_SANS
1794  * \li Action: Toggles Sans Serif family font (selection-wise).
1795  * \li Syntax: font-sans
1796  * \endvar
1797  */
1798                 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
1799
1800 /*!
1801  * \var lyx::FuncCode lyx::LFUN_FONT_SIZE
1802  * \li Action: Sets font size according to lyx format string.
1803  * \li Syntax: font-size <SIZE>
1804  * \li Params: <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|\n
1805                        largest|huge|giant|increase|decrease|default
1806  * \endvar
1807  */
1808                 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
1809
1810 /*!
1811  * \var lyx::FuncCode lyx::LFUN_FONT_STATE
1812  * \li Action: Returns the info about the current font.
1813  * \li Syntax: font-state
1814  * \endvar
1815  */
1816                 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
1817
1818
1819 /*!
1820  * \var lyx::FuncCode lyx::LFUN_FONT_STRIKEOUT
1821  * \li Action: Toggles strikeout (strike-through) in the font (selection-wise).
1822  * \li Syntax: font-strikeout
1823  * \li Origin: sanda, 3 May 2009
1824  * \endvar
1825  */
1826                 { LFUN_FONT_STRIKEOUT, "font-strikeout", Noop, Layout },
1827
1828 /*!
1829  * \var lyx::FuncCode lyx::LFUN_FONT_CROSSOUT
1830  * \li Action: Toggles xout (cross-through) in the font (selection-wise).
1831  * \li Syntax: font-crossout
1832  * \li Origin: uwestoehr, 4 April 2017
1833  * \endvar
1834  */
1835                 { LFUN_FONT_CROSSOUT, "font-crossout", Noop, Layout },
1836
1837 /*!
1838  * \var lyx::FuncCode lyx::LFUN_FONT_NO_SPELLCHECK
1839  * \li Action: Toggles nospellcheck status in the font (selection-wise).
1840  * \li Syntax: font-nospellcheck
1841  * \li Origin: spitz, 5 March 2021
1842  * \endvar
1843  */
1844                 { LFUN_FONT_NO_SPELLCHECK, "font-nospellcheck", Noop, Layout },
1845
1846 /*!
1847  * \var lyx::FuncCode lyx::LFUN_FONT_TYPEWRITER
1848  * \li Action: Toggles the typewriter family font (selection-wise).
1849  * \li Syntax: font-typewriter
1850  * \endvar
1851  */
1852                 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
1853
1854 /*!
1855  * \var lyx::FuncCode lyx::LFUN_FONT_UNDERLINE
1856  * \li Action: Toggles underline in the font (selection-wise).
1857  * \li Syntax: font-underline
1858  * \endvar
1859  */
1860                 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
1861
1862 /*!
1863  * \var lyx::FuncCode lyx::LFUN_FONT_UNDERUNDERLINE
1864  * \li Action: Toggles double underline in the font (selection-wise).
1865  * \li Syntax: font-underunderline
1866  * \li Origin: sanda, 5 May 2009
1867  * \endvar
1868  */
1869                 { LFUN_FONT_UNDERUNDERLINE, "font-underunderline", Noop, Layout },
1870
1871 /*!
1872  * \var lyx::FuncCode lyx::LFUN_FONT_UNDERWAVE
1873  * \li Action: Toggles wavy underline in the font (selection-wise).
1874  * \li Syntax: font-underwave
1875  * \li Origin: sanda, 5 May 2009
1876  * \endvar
1877  */
1878                 { LFUN_FONT_UNDERWAVE, "font-underwave", Noop, Layout },
1879
1880 /*!
1881  * \var lyx::FuncCode lyx::LFUN_FOOTNOTE_INSERT
1882  * \li Action: Inserts a footnote inset.
1883  * \li Syntax: footnote-insert
1884  * \li Origin: Jug, 7 Mar 2000
1885  * \endvar
1886  */
1887                 { LFUN_FOOTNOTE_INSERT, "footnote-insert", Noop, Edit },
1888
1889 /*!
1890  * \var lyx::FuncCode lyx::LFUN_FORWARD_SEARCH
1891  * \li Action: Sets the cursor position in the previewed (dvi/pdf) file based on the row
1892                number in LyX window.
1893  * \li Notion: The external program used for forward search call can be specified in
1894                LyX Output preferences. See Additional manual for details of these
1895                settings.
1896  * \li Syntax: forward-search
1897  * \li Origin: sanda, 14 Apr 2010
1898  * \endvar
1899  */
1900                 { LFUN_FORWARD_SEARCH, "forward-search", ReadOnly, System },
1901
1902 /*!
1903  * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
1904  * \li Action: Open the given help file according to the language setting.
1905  * \li Syntax: help-open <FILE>[.lyx]
1906  * \li Params: <FILE>: any document from (/usr/share/)doc directory.
1907  * \li Origin: Jug, 27 Jun 1999
1908  * \endvar
1909  */
1910                 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
1911
1912 /*!
1913  * \var lyx::FuncCode lyx::LFUN_LYXFILES_OPEN
1914  * \li Action: Open lyxfiles (templates/examples). Create a view if he have none.
1915  * \li Syntax: lyxfiles-open [<TYPE>]
1916  * \li Params: <TYPE>: templates or examples. Default is templates.
1917  * \li Origin: spitz, 10 Feb 2021
1918  * \endvar
1919  */
1920                 { LFUN_LYXFILES_OPEN, "lyxfiles-open", NoBuffer | Argument, Buffer },
1921
1922 /*!
1923  * \var lyx::FuncCode lyx::LFUN_HREF_INSERT
1924  * \li Action: Inserts hyperlinks into the document (clickable in pdf output).
1925  * \li Notion: Hyperlink target can be set via selection + hyperlink-insert function.
1926  * \li Syntax: href-insert [<TARGET>]
1927  * \li Origin: CFO-G, 21 Nov 1997
1928  * \endvar
1929  */
1930                 { LFUN_HREF_INSERT, "href-insert", Noop, Edit },
1931
1932 /*!
1933  * \var lyx::FuncCode lyx::LFUN_ICON_SIZE
1934  * \li Action: Sets icon size of toolbars.
1935  * \li Syntax: icon-size [<SIZE>]
1936  * \li Params: <SIZE> : the icon size in px or one of the logical settings
1937                         small|normal|big|huge|giant, the default is normal
1938                         (whose size in px is icon set dependent).
1939  * \li Origin: 11 July 2016
1940  * \endvar
1941  */
1942                 { LFUN_ICON_SIZE, "icon-size", NoBuffer, Buffer },
1943
1944
1945 /*!
1946  * \var lyx::FuncCode lyx::LFUN_IF_RELATIVES
1947  * \li Action: Helper function for master-related actions
1948  * \li Notion: In a buffer, the function will be disabled if the buffer
1949  *             has no master or children. It thus allows to enable
1950  *             actions only in documents with master/children
1951  * \li Syntax: ifrelatives <ACTION>
1952  * \li Origin: spitz, 2 January 2020
1953  * \endvar
1954  */
1955                 { LFUN_IF_RELATIVES, "ifrelatives", Noop, Buffer },
1956
1957 /*!
1958  * \var lyx::FuncCode lyx::LFUN_INDEX_INSERT
1959  * \li Action: Inserts Index entry.
1960  * \li Notion: It automatically takes the word on the cursor position.
1961  * \li Syntax: index-insert [<TYPE:Name>]
1962  * \li Params: <TYPE:Name>: name of the index, if multiple indices are defined.
1963                With an empty argument, the default index is selected.
1964  * \li Origin: leeming, 3 Aug 2000
1965  * \endvar
1966  */
1967                 { LFUN_INDEX_INSERT, "index-insert", Noop, Edit },
1968
1969 /*!
1970  * \var lyx::FuncCode lyx::LFUN_INDEX_PRINT
1971  * \li Action: Inserts list of Index entries on a new page.
1972  * \li Syntax: index-print [<TYPE:Name>]
1973  * \li Params: <TYPE:Name>: name of the index, if multiple indices are defined.
1974                With an empty argument, the default index is selected.
1975  * \li Origin: Lgb, 27 Feb 1997
1976  * \endvar
1977  */
1978                 { LFUN_INDEX_PRINT, "index-print", Noop, Edit },
1979
1980 /*!
1981  * \var lyx::FuncCode lyx::LFUN_INFO_INSERT
1982  * \li Action: Displays shortcuts, lyxrc, package and textclass availability and menu
1983                information in a non-editable boxed InsetText.
1984  * \li Notion: Apart from lfun arguments you can use the following method: \n
1985                1. input the type and argument of this inset, e.g. "menu paste", in
1986                the work area.\n
1987                2. select the text and run info-insert lfun.
1988  * \li Syntax: info-insert <TYPE> <ARG>
1989  * \li Params: <TYPE>: date|moddate|fixdate|time|modtime|fixtime|shortcut|shortcuts|lyxrc|
1990  *                     lyxinfo|package|textclass|menu|l7n|icon|buffer|vcs \n
1991                <ARG>: argument for a given type. Look into InsetInfo.h for detailed
1992                       description. \n
1993                       date: current date (formatted and localized)\n
1994                       moddate: date of last modification (saving) (formatted and localized)\n
1995                       fixdate: a static date (formatted and localized)\n
1996                       time: current time (formatted and localized)\n
1997                       modtime: time of last modification (saving) (formatted and localized)\n
1998                       fixtime: a static time (formatted and localized)\n
1999                       shortcut[s]: name of lfun (e.g math-insert \alpha) \n
2000                       lyxrc: name of rc_entry (e.g. bind_file) \n
2001                       lyxinfo: "version" - used version of LyX \n
2002                       package: name of latex package (e.g. listings) \n
2003                       textclass: name of textclass (e.g. article) \n
2004                       menu: name of lfun used in menu  \n
2005                       l7n: localizable string.\n
2006                       icon: icon of lfun used in toolbar or direct icon name\n
2007                       buffer: "name"|"name-noext"|"path"|"class"
2008                       vcs: "tree-revision"|"revision"|"author"|"date"|"time"
2009  * \li Sample: command-sequence info-insert buffer path; info-insert buffer name
2010  * \li Origin: bpeng, 7 Oct 2007
2011  * \endvar
2012  */
2013                 { LFUN_INFO_INSERT, "info-insert", Noop, Edit },
2014
2015 /*!
2016  * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
2017  * \li Action: Apply data for an inset.
2018  * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
2019                be applied. This is either changed to #LFUN_INSET_MODIFY or
2020                #LFUN_INSET_INSERT depending on the context where it is called.
2021  * \li Syntax: inset-apply <ARGS>
2022  * \li Params: See #LFUN_INSET_INSERT .
2023  * \endvar
2024  */
2025                 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
2026
2027 /*!
2028  * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN
2029  * \li Action: Move the cursor to the beginning of the current inset
2030                if it is not already there. If the cursor is already at
2031                the beginning of the current inset, move it to the
2032                beginning of the enclosing inset or the main work area,
2033                respectively, if there is no enclosing inset.
2034  * \li Syntax: inset-begin
2035  * \li Origin: lasgouttes, 16 Mar 2009
2036  * \endvar
2037  */
2038                 { LFUN_INSET_BEGIN, "inset-begin", ReadOnly, Edit },
2039
2040 /*!
2041  * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN_SELECT
2042  * \li Action: Move the cursor to the beginning of the current inset
2043                if it is not already there. If the cursor is already at
2044                the beginning of the current inset, move it to the
2045                beginning of the enclosing inset or the main work area,
2046                respectively, if there is no enclosing inset (adding the
2047                traversed text to the selection).
2048  * \li Syntax: inset-begin-select
2049  * \li Origin: lasgouttes, 16 Mar 2009
2050  * \endvar
2051  */
2052                 { LFUN_INSET_BEGIN_SELECT, "inset-begin-select", ReadOnly, Edit },
2053
2054 /*!
2055  * \var lyx::FuncCode lyx::LFUN_INSET_COPY_AS
2056  * \li Action: Copies the inset to the clipboard as a certain type.
2057  * \li Notion: Currently used only for InsetInfo where its content is copied as a text.
2058  * \li Syntax: inset-copy-as
2059  * \li Origin: vfr, 18 Apr 2010
2060  * \endvar
2061  */
2062                 { LFUN_INSET_COPY_AS, "inset-copy-as", ReadOnly | NoUpdate | AtPoint, Edit },
2063
2064
2065 /*!
2066  * \var lyx::FuncCode lyx::LFUN_INSET_DIALOG_UPDATE
2067  * \li Action: Updates the values inside the dialog from the inset.
2068  * \li Notion: This is an internal LFUN, not to be used by users. Called internally
2069                by #LFUN_DIALOG_UPDATE
2070  * \li Params: <DIALOG-NAME>
2071  * \li Origin: leeming, 25 Feb 2003
2072  * \endvar
2073  */
2074                 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
2075
2076 /*!
2077  * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE
2078  * \li Action: Dissolve the current inset into text.
2079  * \li Syntax: inset-dissolve [<INSET>]
2080  * \li Params: <INSET>: this can be used to make sure the right kind of inset
2081                         is dissolved. For example "dissolve" entry in the charstyles
2082                         sub-menu should only dissolve the charstyle inset, even if the
2083                         cursor is inside several nested insets of different type.\n
2084                         For values see #lyx::InsetLayout::lyxtype_ .
2085  * \li Origin: JSpitz, 7 Aug 2006
2086  * \endvar
2087  */
2088                 { LFUN_INSET_DISSOLVE, "inset-dissolve", AtPoint, Edit },
2089
2090 /*!
2091  * \var lyx::FuncCode lyx::LFUN_INSET_EDIT
2092  * \li Action: Edit the inset at cursor with an external application,
2093                if one is attributed.
2094                If the inset is file based, the referenced file is edited.
2095                Otherwise, the inset contents is written to a temporary file,
2096                the inset is locked, and the temporary file is edited.
2097                In this case, #LFUN_INSET_END_EDIT must be called to overtake
2098                the changes and unlock the inset after editing is finished.
2099  * \li Syntax: inset-edit [<INSET_PARAMS>]
2100  * \li Params: <INSET_PARAMS>: Parameters for the inset. \n
2101                                Currently only the filename will be considered.
2102  * \li Origin: spitz, 27 Apr 2006
2103  * \endvar
2104  */
2105                 { LFUN_INSET_EDIT, "inset-edit", ReadOnly | AtPoint, Edit },
2106
2107
2108  /*!
2109  * \var lyx::FuncCode lyx::LFUN_INSET_END_EDIT
2110  * \li Action: End editing the inset at cursor with an external application.
2111  *             This replaces the inset contents with the contents of the
2112  *             temporary file, deletes the file and unlocks the inset.
2113  * \li Syntax: inset-end-edit 
2114  * \li Origin: gb, 11 Oct 2015
2115  * \endvar
2116  */
2117                 { LFUN_INSET_END_EDIT, "inset-end-edit", ReadOnly | AtPoint, Edit },
2118
2119 /*!
2120  * \var lyx::FuncCode lyx::LFUN_INSET_END
2121  * \li Action: Move the cursor to the end of the current inset if it
2122                is not already there. If the cursor is already at the
2123                end of the current inset, move it to the end of the
2124                enclosing inset or the main work area, respectively, if
2125                there is no enclosing inset.
2126  * \li Syntax: inset-end
2127  * \li Origin: lasgouttes, 16 Mar 2009
2128  * \endvar
2129  */
2130                 { LFUN_INSET_END, "inset-end", ReadOnly, Edit },
2131
2132 /*!
2133  * \var lyx::FuncCode lyx::LFUN_INSET_END_SELECT
2134  * \li Action: Move the cursor to the end of the current inset if it
2135                is not already there. If the cursor is already at the
2136                end of the current inset, move it to the end of the
2137                enclosing inset or the main work area, respectively, if
2138                there is no enclosing inset (adding the
2139                traversed text to the selection).
2140  * \li Syntax: inset-end-select
2141  * \li Origin: lasgouttes, 16 Mar 2009
2142  * \endvar
2143  */
2144                 { LFUN_INSET_END_SELECT, "inset-end-select", ReadOnly, Edit },
2145
2146
2147 /*!
2148  * \var lyx::FuncCode lyx::LFUN_INSET_FORALL
2149  * \li Action: Apply the given commands on insets of a given name.
2150  * \li Notion: WARNING: use at your own risks; this function gives
2151                you too many ways of shooting yourself in the foot.
2152                A typical example is
2153                    inset-forall Note note-insert
2154                which starts an infinite loop. This is mitigated by the fact
2155                that the number of actions is arbitrarily limited to 100000.
2156                Note also that inset-forall does not update metrics between
2157                iterations, which can lead to bugs. This has to be eventually
2158                fixed.
2159  * \li Syntax: inset-forall <NAME> <LFUN-COMMAND> \n
2160                <NAME>: Type of Inset. If <NAME> is *, all insets are matched.
2161                The name is used like for InsetLayout in layout files: "Note"
2162                matches all note insets, while "Note:Note" only matches LyX
2163                yellow note insets.
2164  * \li Sample: Remove all index insets: \n
2165                    inset-forall Index char-delete-forward force \n
2166                Close all Notes (also works for a particular branch, for example): \n
2167                    inset-forall Note inset-toggle close \n
2168                Transform all yellow notes to comments \n
2169                    inset-forall Note:Note inset-modify note Note Comment \n
2170                Try to put LyX in an infinite loop if there is at least a Note: \n
2171                    inset-forall Note char-backward
2172  * \li Origin: lasgouttes, 27 Nov 2009
2173  * \endvar
2174  */
2175                 { LFUN_INSET_FORALL, "inset-forall", ReadOnly, Edit },
2176
2177
2178 /*!
2179  * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
2180  * \li Action: Insert new inset (type given by the parameters).
2181  * \li Syntax: inset-insert <INSET> <ARGS>
2182  * \li Params: <INSET>: <bibitem|bibtex|citation|ert|listings|external|graphics|tabular|\n
2183                          hyperlink|include|index|label|line|nomencl|vspace|ref|toc|script>\n
2184                <ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
2185  * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
2186                where <label name> is the name of the referenced label and
2187                <Format> is one of the following: \n
2188                ref -- <reference> \n
2189                eqref -- (<reference>) \n
2190                pageref -- <page> \n
2191                vpageref -- on <page> \n
2192                vref -- <reference> on <page> \n
2193                formatted -- Formatted reference
2194  * \endvar
2195  */
2196                 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
2197
2198 /*!
2199  * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
2200  * \li Action: Modify some properties of an inset.
2201  * \li Notion: Used for argument, bibitem, bibtex, box, branch, caption, citation,
2202                         command, ert, external, float, graphics, include, index,
2203                         info, label, line, listings, newline, newpage, nomencl,
2204                         note, phantom, quotes, ref, script, separator, space,
2205                         tabular, vspace and wrap insets.
2206  * \li Syntax: inset-modify <INSET> <ARGS> \n
2207                inset-modify changetype <TYPE>
2208  * \li Sample: Change a Note inset into a Comment inset: \n
2209                    inset-modify note Note Comment \n
2210                Change a Box into an Ovalbox: \n
2211                    inset-modify changetype Ovalbox \n
2212                Change a quotation mark to e[nglish style], l[eft side = opening], s[ingle = inner, secondary] \n
2213                    inset-modify changetype els \n
2214                Change only the style of a quotation mark, maintaining the other aspects (. = wildcard) \n
2215                    inset-modify changetype e.. \n
2216  * \endvar
2217  */
2218                 { LFUN_INSET_MODIFY, "inset-modify", AtPoint, Edit },
2219
2220 /*!
2221  * \var lyx::FuncCode lyx::LFUN_INSET_SELECT_ALL
2222  * \li Action: Select all contents of an inset.
2223  * \li Notion: There are 3 successive levels: select current cell,
2224  *             select all cells of inset, select the inset from outside
2225  *             (in the enclosing inset).
2226  * \li Syntax: inset-select-all
2227  * \li Origin: vfr, 22 Aug 2009; lasgouttes 1 Nov 2014
2228  * \endvar
2229  */
2230                 { LFUN_INSET_SELECT_ALL, "inset-select-all", ReadOnly, Edit },
2231
2232
2233 /*!
2234  * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
2235  * \li Action: Open the inset's properties dialog.
2236  * \li Notion: Used for bibitem, bibtex, box, branch, citation, ert, external,
2237                float, graphics, href, include, index, index_print, label, line,
2238                listings, note, phantom, ref, space, tabular, vspace, wrap insets.
2239  * \li Syntax: inset-settings <INSET>
2240  * \li Params: <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|\n
2241                          graphics|href|include|index|index_print|label|line|\n
2242                          listings|note|phantom|ref|space|tabular|vspace|wrap>.
2243  * \endvar
2244  */
2245                 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly | AtPoint, Edit },
2246
2247 /*!
2248  * \var lyx::FuncCode lyx::LFUN_INSET_SPLIT
2249  * \li Action: Splits the current inset into two at current position.
2250  * \li Syntax: inset-split [<INSET>]
2251  * \li Params: <INSET>: this can be used to make sure the right kind of inset
2252                         is dissolved. For example "split" entry in the charstyles
2253                         sub-menu should only dissolve the charstyle inset, even if the
2254                         cursor is inside several nested insets of different type.\n
2255                         For values see #lyx::InsetLayout::lyxtype_ .
2256  * \li Origin: spitz, 22 Dec 2020
2257  * \endvar
2258  */
2259                 { LFUN_INSET_SPLIT, "inset-split", AtPoint, Edit },
2260
2261 /*!
2262  * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
2263  * \li Action: Toggles the collapsible inset at cursor position,
2264                or the inset we are currently in.
2265  * \li Syntax: inset-toggle [<ARG>]
2266  * \li Params: <ARG>: <open|close|toggle|assign>. \n
2267                open/close/toggle are for collapsible insets. toggle is used when no argument is given.\n
2268                assign synchronize the branch-inset with activation status of the branch.
2269                Used for global toggling when changed activation.
2270  * \li Origin: lasgouttes, 19 Jul 2001
2271  * \endvar
2272  */
2273                 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly | AtPoint, Edit },
2274
2275 /*!
2276  * \var lyx::FuncCode lyx::LFUN_IN_IPA
2277  * \li Action: Only active in IPA inset.
2278  * \li Notion: Dummy function which is only active in a IPA inset.
2279                It's used to toggle the IPA toolbar if the cursor moves
2280                into an IPA inset.
2281  * \li Syntax: in-ipa
2282  * \li Origin: spitz, 20 May 2012
2283  * \endvar
2284  */
2285                 { LFUN_IN_IPA, "in-ipa", Noop, Edit },
2286
2287 /*!
2288  * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
2289  * \li Action: Only active in Math Macro definition.
2290  * \li Notion: Dummy function which is only active in a Math Macro definition.
2291                It's used to toggle the Math Macro toolbar if the cursor moves
2292                into a Math Macro definition.
2293  * \li Syntax: in-mathmacrotemplate
2294  * \li Origin: sts, 06 January 2008
2295  * \endvar
2296  */
2297                 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
2298
2299
2300 /*!
2301  * \var lyx::FuncCode lyx::LFUN_IPAMACRO_INSERT
2302  * \li Action: Inserts special IPA macros into the document.
2303  * \li Syntax: ipamacro-insert <CHAR>
2304  * \li Params: <CHAR>: tone-falling, tone-rising, tone-high-rising, tone-low-rising,
2305  *                     tone-high-rising-falling, deco bottomtiebar, deco toptiebar.
2306  * \li Origin: spitz, 22 Aug 2012
2307  * \endvar
2308  */
2309                 { LFUN_IPAMACRO_INSERT, "ipamacro-insert", Noop, Edit },
2310
2311 /*!
2312  * \var lyx::FuncCode lyx::LFUN_IPA_INSERT
2313  * \li Action: Inserts an IPA inset.
2314  * \li Syntax: ipa-insert
2315  * \li Origin: spitz, 05 Mar 2012
2316  * \endvar
2317  */
2318                 { LFUN_IPA_INSERT, "ipa-insert", Noop, Edit },
2319
2320 /*!
2321  * \var lyx::FuncCode lyx::LFUN_KEYMAP_OFF
2322  * \li Action: Turn off the loaded keyboard map.
2323  * \li Syntax: keymap-off
2324  * \endvar
2325  */
2326                 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
2327
2328 /*!
2329  * \var lyx::FuncCode lyx::LFUN_KEYMAP_PRIMARY
2330  * \li Action: Turn on the primary keyboard map.
2331  * \li Notion: Maps were widely used in past, when X-windows didn't have nowadays
2332                keyboard support. They can be still used to maintain uniform keyboard
2333                layout across the various platforms.\n
2334                The language is to be set in the Preferences dialog.
2335  * \li Syntax: keymap-primary
2336  * \endvar
2337  */
2338                 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
2339
2340 /*!
2341  * \var lyx::FuncCode lyx::LFUN_KEYMAP_SECONDARY
2342  * \li Action: Turn on the secondary keyboard map.
2343  * \li Syntax: keymap-secondary
2344  * \endvar
2345  */
2346                 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
2347
2348 /*!
2349  * \var lyx::FuncCode lyx::LFUN_KEYMAP_TOGGLE
2350  * \li Action: Toggles keyboard maps (first/second/off).
2351  * \li Syntax: keymap-toggle
2352  * \li Origin: leeming, 30 Mar 2004
2353  * \endvar
2354  */
2355                 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
2356
2357
2358 /*!
2359  * \var lyx::FuncCode lyx::LFUN_LABEL_COPY_AS_REFERENCE
2360  * \li Action: Copies the label at the cursor as a cross-reference to be pasted elsewhere.
2361  * \li Syntax: copy-label-as-reference <LABEL>
2362  * \li Params: <LABEL>: The label to copy (for multi-line math)
2363  * \li Origin: sts, 16 Nov 2008
2364  * \endvar
2365  */
2366                 { LFUN_LABEL_COPY_AS_REFERENCE, "label-copy-as-reference",
2367                         ReadOnly | NoUpdate | AtPoint, Edit },
2368
2369
2370 /*!
2371  * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
2372  * \li Action: Goto a label.
2373  * \li Syntax: label-goto [<LABEL>]
2374  * \li Params: <LABEL>: Requested label. If no label is given and reference
2375                         is on cursor position, Bookmark 0 is saved and
2376                         cursor moves to the position of referenced label.
2377  * \li Origin: Ale, 6 Aug 1997
2378  * \endvar
2379  */
2380                 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
2381
2382 /*!
2383  * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT
2384  * \li Action: Inserts label to text or displayed formula.
2385  * \li Syntax: label-insert [<LABEL>]
2386  * \li Params: <LABEL>: Requested label. If no label is given dialog requesting
2387                         name will be opened.
2388  * \endvar
2389  */
2390                 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
2391
2392 /*!
2393  * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT_AS_REFERENCE
2394  * \li Action: Inserts the label (in ToC pane) as a cross-reference at the position of the cursor.
2395  * \li Syntax: label-insert-as-reference
2396  * \li Origin: vfr, 7 Apr 2009
2397  * \endvar
2398  */
2399                 { LFUN_LABEL_INSERT_AS_REFERENCE, "label-insert-as-reference", Noop, Edit},
2400
2401
2402 /*!
2403  * \var lyx::FuncCode lyx::LFUN_LANGUAGE
2404  * \li Action: Set language from the current cursor position.
2405  * \li Syntax: language <LANG> [set]
2406  * \li Params: <LANG>: Requested language. Look in lib/languages for
2407                        the list. "language reset" or "language" (without param)
2408                        reset to the document language.
2409                   set: If used, the language will be set to the specified
2410                        language. Otherwise, the language will be toggled (i.e., if
2411                        the current language is LANG, switch to the document language
2412                        or the default language, if LANG is the document language).
2413  * \li Origin: Dekel, 2 Mar 2000
2414  * \endvar
2415  */
2416                 { LFUN_LANGUAGE, "language", Noop, Edit },
2417
2418
2419 /*!
2420  * \var lyx::FuncCode lyx::LFUN_LAYOUT
2421  * \li Action: Sets the layout (that is, environment) for the current paragraph.
2422  * \li Syntax: layout <LAYOUT> [ignoreautonests]
2423  * \li Params: <LAYOUT>: the layout to use\n
2424                ignoreautonests: If specified, nesting advices will be ignored.
2425  * \endvar
2426  */
2427                 { LFUN_LAYOUT, "layout", Noop, Layout },
2428
2429 /*!
2430  * \var lyx::FuncCode lyx::LFUN_LAYOUT_TOGGLE
2431  * \li Action: Toggles the layout (that is, environment) for the current paragraph.
2432  * \li Notion: Contrary to `layout', this function resets the current
2433  *             (or selection) layout to the standard layout it already has the
2434  *             correct layout. Useful for toolbar icons.
2435  * \li Syntax: layout-toggle <LAYOUT> [ignoreautonests]
2436  * \li Params: <LAYOUT>: the layout to toggle\n
2437                ignoreautonests: If specified, nesting advices will be ignored.
2438  * \li Origin: lasgouttes, 14 May 2018
2439  * \endvar
2440  */
2441                 { LFUN_LAYOUT_TOGGLE, "layout-toggle", Noop, Layout },
2442
2443 /*!
2444  * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
2445  * \li Action: Clears the module list.
2446  * \li Notion: Clears the list of included modules for the current buffer.
2447  * \li Syntax: layout-modules-clear
2448  * \li Origin: rgh, 25 August 2007
2449  * \endvar
2450  */
2451                 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", NoInternal, Layout },
2452
2453 /*!
2454  * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULE_ADD
2455  * \li Action: Adds a module.
2456  * \li Notion: Adds a module to the list of included modules for the current buffer.
2457  * \li Syntax: layout-module-add <MODULE>
2458  * \li Params: <MODULE>: the module to be added
2459  * \li Origin: rgh, 25 August 2007
2460  * \endvar
2461  */
2462                 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", NoInternal, Layout },
2463
2464 /*!
2465  * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH
2466  * \li Action: Launches the paragraph settings dialog.
2467  * \li Syntax: layout-paragraph
2468  * \endvar
2469  */
2470                 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
2471
2472 /*!
2473  * \var lyx::FuncCode lyx::LFUN_LAYOUT_RELOAD
2474  * \li Action: Reloads layout information.
2475  * \li Notion: Reloads all layout information for the current buffer from disk, thus
2476                recognizing any changes that have been made to layout files on the fly.
2477                This is intended to be used only by layout developers and should not be
2478                used when one is trying to do actual work.
2479  * \li Syntax: layout-reload
2480  * \li Origin: rgh, 3 September 2007
2481  * \endvar
2482  */
2483                 { LFUN_LAYOUT_RELOAD, "layout-reload", NoInternal, Layout },
2484
2485 /*!
2486  * \var lyx::FuncCode lyx::LFUN_LAYOUT_TABULAR
2487  * \li Action: Launches the tabular settings dialog.
2488  * \li Syntax: layout-tabular
2489  * \li Origin: Jug, 31 Jul 2000
2490  * \endvar
2491  */
2492                 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
2493
2494 /*!
2495  * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN
2496  * \li Action: Move the cursor to the beginning of the (screen) line.
2497  * \li Syntax: line-begin
2498  * \endvar
2499  */
2500                 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
2501
2502 /*!
2503  * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN_SELECT
2504  * \li Action: Move the cursor to the beginning of the (screen) line adding the
2505                traversed text to the selection.
2506  * \li Syntax: line-begin-select
2507  * \endvar
2508  */
2509                 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
2510
2511 /*!
2512  * \var lyx::FuncCode lyx::LFUN_LINE_DELETE_FORWARD
2513  * \li Action: Deletes the letters to the end of the (screen) line or
2514                deletes the selection.
2515  * \li Syntax: line-delete-forward
2516  * \endvar
2517  */
2518                 { LFUN_LINE_DELETE_FORWARD, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
2519
2520 /*!
2521  * \var lyx::FuncCode lyx::LFUN_LINE_END
2522  * \li Action: Move the cursor to the end of the (screen) line.
2523  * \li Syntax: line-end
2524  * \endvar
2525  */
2526                 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
2527
2528 /*!
2529  * \var lyx::FuncCode lyx::LFUN_LINE_END_SELECT
2530  * \li Action: Move the cursor to the end of the (screen) line adding the
2531                traversed text to the selection.
2532  * \li Syntax: line-end-select
2533  * \endvar
2534  */
2535                 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
2536
2537 /*!
2538  * \var lyx::FuncCode lyx::LFUN_LISTING_INSERT
2539  * \li Action: Inserts a new listings inset.
2540  * \li Syntax: listing-insert
2541  * \li Origin: Herbert, 10 Nov 2001; bpeng, 2 May 2007
2542  * \endvar
2543  */
2544                 { LFUN_LISTING_INSERT, "listing-insert", Noop, Edit },
2545
2546 /*!
2547  * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
2548  * \li Action: Apply the given settings to user preferences.
2549  * \li Syntax: lyxrc-apply <SETTINGS>
2550  * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
2551                            to get an idea which commands to use and their syntax.
2552                            #lyx::LyXRC::LyXRCTags has the list of possible commands.
2553  * \endvar
2554  */
2555                 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
2556
2557 /*!
2558  * \var lyx::FuncCode lyx::LFUN_LYX_ACTIVATE
2559  * \li Action: Activates the LyX window.
2560  * \li Notion: On Linux and Mac OS, this action brings the LyX window
2561                into focus. Such behavior is not allowed by Windows OS
2562                so instead the color of the taskbar entry is changed to
2563                indicate that the window has changed in some way.
2564                This action is useful in combination with reverse search.
2565  * \li Syntax: lyx-activate
2566  * \li Origin: skostysh, 4 Aug 2016
2567  * \endvar
2568  */
2569                 { LFUN_LYX_ACTIVATE, "lyx-activate", ReadOnly | NoBuffer, Hidden },
2570
2571 /*!
2572  * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
2573  * \li Action: Terminates the current LyX instance.
2574  * \li Notion: Terminates the current LyX instance, asking whether to save
2575                modified documents, etc.
2576  * \li Syntax: lyx-quit
2577  * \endvar
2578  */
2579                 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
2580
2581 /*!
2582  * \var lyx::FuncCode lyx::LFUN_MARGINALNOTE_INSERT
2583  * \li Action: Inserts a marginal note.
2584  * \li Syntax: marginalnote-insert
2585  * \li Origin: Lgb, 26 Jun 2000
2586  * \endvar
2587  */
2588                 { LFUN_MARGINALNOTE_INSERT, "marginalnote-insert", Noop, Edit },
2589
2590 /*!
2591  * \var lyx::FuncCode lyx::LFUN_MARK_OFF
2592  * \li Action: Disable selecting of text-region.
2593  * \li Syntax: mark-off
2594  * \endvar
2595  */
2596                 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
2597
2598 /*!
2599  * \var lyx::FuncCode lyx::LFUN_MARK_ON
2600  * \li Action: Enable selecting of text-region.
2601  * \li Notion: After enabling you can simply move arrow keys to get selected region.
2602  * \li Syntax: mark-on
2603  * \endvar
2604  */
2605                 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
2606
2607 /*!
2608  * \var lyx::FuncCode lyx::LFUN_MARK_TOGGLE
2609  * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
2610  * \li Syntax: mark-toggle
2611  * \li Origin: Andre, May 5 2006
2612  * \endvar
2613  */
2614                 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
2615
2616
2617 /*!
2618  * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_EXPORT
2619  * \li Action: Exports the master buffer (document) to the given format.
2620  * \li Syntax: master-buffer-export [<FORMAT>] [<DEST>]
2621  * \li Params: <FORMAT> is one of the formats which you can find in 
2622                         Tools->Preferences->File formats->Format.
2623                         Usual format you will enter is "pdf2" (pdflatex),
2624                         "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
2625                         Note that "custom" is not allowed in this case.\n
2626                         If absent or "default", then the default output format of the
2627                         document is used.\n
2628                <DEST>   If present, this argument provides the export destination
2629                         filename. Its containing folder will also be the destination
2630                         folder, where all the needed external files will be copied.
2631  * \li Origin: rkh, 18 April 2018
2632  * \endvar
2633  */
2634                 { LFUN_MASTER_BUFFER_EXPORT, "master-buffer-export", ReadOnly, Buffer },
2635                 
2636 /*!
2637  * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_FORALL
2638  * \li Action: Applies a command to a buffer and all it children, starting from the master.
2639  * \li Syntax: master-buffer-forall <LFUN-COMMAND>
2640  * \li Params: <LFUN-COMMAND>: The command to be applied to the buffers.
2641  * \li Sample: Close all Notes in buffers: \n
2642                master-buffer-forall inset-forall Note inset-toggle close \n
2643                Toggle change tracking on buffers: \n
2644                master-buffer-forall changes-track \n
2645                Toggle read-only for buffers: \n
2646                master-buffer-forall buffer-toggle-read-only \n
2647                Show statistics for individual buffers: \n
2648                master-buffer-forall statistics \n
2649                Activate the branch named "Solutions" in buffers: \n
2650                master-buffer-forall branch-activate Solutions \n
2651  * \li Origin: spitz, 31 Dec 2019
2652  * \endvar
2653  */
2654                 { LFUN_MASTER_BUFFER_FORALL, "master-buffer-forall", ReadOnly | Argument, Buffer },
2655
2656 /*!
2657  * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
2658  * \li Action: Update (export) the document built from the master buffer,
2659                if the current buffer is part of a master/child document.
2660  * \li Syntax: master-buffer-update [<FORMAT>]
2661  * \li Params: <FORMAT>: The format to display, where this is one of the
2662                          formats defined (in the current GUI) in the
2663                          Tools>Preferences>File Formats dialog.
2664                          If no format is given, the default format as
2665                          specified in the same dialog is used.
2666  * \li Origin: Tommaso, 20 Sep 2007
2667  * \endvar
2668  */
2669                 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
2670
2671 /*!
2672  * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
2673  * \li Action: Show a preview built from the master buffer, if available.
2674                if the current buffer is part of a master/child document.
2675  * \li Syntax: master-buffer-view [<FORMAT>]
2676  * \li Params: <FORMAT>: The format to display, where this is one of the
2677                          formats defined (in the current GUI) in the
2678                          Tools>Preferences>File Formats dialog.
2679                          If no format is given, the default format as
2680                          specified in the same dialog is used.
2681  * \li Origin: Tommaso, 20 Sep 2007
2682  * \endvar
2683  */
2684                 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
2685
2686 /*!
2687  * \var lyx::FuncCode lyx::LFUN_MATH_AMS_MATRIX
2688  * \li Action: Inserts an extended matrix as provided by the amsmath package.
2689  * \li Syntax: math-matrix <COLS> <ROWS> [<DECORATION>]
2690  * \li Params: <DECORATION>: Decoration determines the LaTeX name of the matrix
2691                              that should be created. Possible values include
2692                              pmatrix, bmatrix, Bmatrix, vmatrix, Vmatrix, smallmatrix, and
2693                              matrix. The default is 'matrix'.
2694  * \li Sample: math-ams-matrix 3 3 bmatrix
2695  * \endvar
2696  */
2697                 { LFUN_MATH_AMS_MATRIX, "math-ams-matrix", Noop, Math },
2698
2699 /*!
2700  * \var lyx::FuncCode lyx::LFUN_MATH_BIGDELIM
2701  * \li Action: Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
2702  * \li Syntax: math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
2703  * \li Params: <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r \n
2704                <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
2705  * \li Sample: math-bigdelim "Bigl" "\Downarrow" "Bigr" "\}"
2706  * \li Origin: Enrico & Georg, 7 May 2006
2707  * \endvar
2708  */
2709                 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
2710
2711 /*!
2712  * \var lyx::FuncCode lyx::LFUN_MATH_DELIM
2713  * \li Action: Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
2714  * \li Syntax: math-delim [<LEFT>] [<RIGHT>]
2715  * \li Params: <LEFT/RIGHT>: Delimiters to be used. Each delimiter can be specified by
2716                              either a LaTeX name or a valid character.
2717                              ( is the default letter.
2718  * \li Sample: math-delim { rangle
2719  * \li Origin: Alejandro, 18 Jun 1996
2720  * \endvar
2721  */
2722                 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
2723
2724 /*!
2725  * \var lyx::FuncCode lyx::LFUN_MATH_DISPLAY
2726  * \li Action: Creates a new displayed equation in text mode.
2727                Toggles inlined/display formula in math mode.
2728  * \li Syntax: math-display [<ARG>]
2729  * \li Params: <ARG>: this argument will be passed to #LFUN_MATH_INSERT when creating
2730                       new equation from the text mode.
2731  * \li Origin: Alejandro, 18 Jun 1996
2732  * \endvar
2733  */
2734                 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
2735
2736 /*!
2737  * \var lyx::FuncCode lyx::LFUN_MATH_EXTERN
2738  * \li Action: Calls external program and passes the current expression/equation
2739                as an argument for the calculation in the format appropriate to the
2740                given language.
2741  * \li Notion: Selection can be used to determine the input for the external program.
2742  * \li Syntax: math-extern <LANG> [<COMMAND>]
2743  * \li Params: <LANG>: octave|maxima|maple|mathematica|script \n
2744                        where "script" stands for the external script (normalized
2745                        expression will be passed)
2746  * \li Origin: Andre, 24 Apr 2001
2747  * \li Sample: math-extern maple simplify
2748  * \endvar
2749  */
2750                 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
2751
2752 /*!
2753  * \var lyx::FuncCode lyx::LFUN_MATH_FONT_STYLE
2754  * \li Action: Changes the text style used in math.
2755  * \li Syntax: math-font-style <STYLE>
2756  * \li Params: <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf|textnormal\n
2757                |textrm|textsf|texttt|textbf|textmd|textit|textsc|textsl|textup
2758  * \li Origin: vfr, 9 jan 2009
2759  * \endvar
2760  */
2761                 { LFUN_MATH_FONT_STYLE, "math-font-style", Noop, Math },
2762
2763 /*!
2764  * \var lyx::FuncCode lyx::LFUN_MATH_INSERT
2765  * \li Action: Inserts math objects and symbols.
2766  * \li Syntax: math-insert <ARG>
2767  * \li Params: <ARG>: Symbol or LaTeX code to be inserted.
2768  * \li Notion: When <ARG> is a _single_ math inset with more than one cell
2769                (such as "x_y^z" or "\frac{x}{y}"), the content of cell(0) is
2770                replaced by the current selection (only works if the selection
2771                is in mathed). As an example, if "abc" is selected in mathed,
2772                "math-insert \frac{x}{y}" replaces "abc" with "\frac{abc}{y}",
2773                and "math-insert x_y^z" replaces "abc" with "abc_y^z".
2774                If nothing is selected (or the selection is not in mathed),
2775                math-insert works as expected.
2776  * \endvar
2777  */
2778                 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
2779
2780 /*!
2781  * \var lyx::FuncCode lyx::LFUN_MATH_LIMITS
2782  * \li Action: Toggles the position of the limits from above/below to the right
2783                side an vice versa in integral symbol, a limit, a summation, etc.
2784  * \li Notion: Put the cursor before the symbol with the limits and then invoke
2785                math-limits.
2786  * \li Syntax: math-limits [<STATE>]
2787  * \li Params: <STATE>: limits|nolimits
2788  * \endvar
2789  */
2790                 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
2791
2792 /*!
2793  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO
2794  * \li Action: Inserts a math macro definition at the cursor position in the text.
2795  * \li Syntax: math-macro <NAME> [<NARGS>] [def]
2796  * \li Params: <NAME>: The name of the macro, e.g. "mymacro".\n
2797                <NARGS>: The number of parameters of the macro. Default is 0.
2798                "def": Has no effect anymore, just for compatibility with former LyX versions.
2799  * \li Origin: ale, 10 May 1997;  sts, 21 Dec 2007
2800  * \endvar
2801  */
2802                 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
2803
2804 /*!
2805  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
2806  * \li Action: Add a greedy optional parameter.
2807  * \li Notion: Add a greedy optional parameter which eats the value
2808                from the following cells in mathed which are in the [value]
2809                format.
2810  * \li Syntax: math-macro-add-greedy-optional-param
2811  * \li Origin: sts, 06 January 2008
2812  * \endvar
2813  */
2814                 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
2815
2816 /*!
2817  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
2818  * \li Action: Add an optional parameter.
2819  * \li Notion: Insert an optional parameter just behind the
2820                already existing optional parameters.
2821  * \li Syntax: math-macro-add-optional-param
2822  * \li Origin: sts, 06 January 2008
2823  * \endvar
2824  */
2825                 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
2826
2827 /*!
2828  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
2829  * \li Action: Add a parameter.
2830  * \li Notion: Add a parameter to a Math Macro.
2831  * \li Params: <NUM>: The number of the parameter behind which the new one
2832                will be added (1 for the first, i.e. use 0 for add a
2833                parameter at the left), defaults to the last one.
2834  * \li Syntax: math-macro-add-param <NUM>
2835  * \li Origin: sts, 06 January 2008
2836  * \endvar
2837  */
2838                 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
2839
2840 /*!
2841  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
2842  * \li Action: Append a greedy parameter.
2843  * \li Notion: Append a greedy parameter to a Math Macro which
2844                eats the following mathed cell in every instance of
2845                the macro in the buffer.
2846  * \li Syntax: math-macro-append-greedy-param
2847  * \li Origin: sts, 06 January 2008
2848  * \endvar
2849  */
2850                 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
2851
2852 /*!
2853  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
2854  * \li Action: Fold a Math Macro.
2855  * \li Notion: Fold the Math Macro the cursor is in if it was
2856                unfolded, i.e. displayed as \foo before.
2857  * \li Syntax: math-macro-fold
2858  * \li Origin: sts, 06 January 2008
2859  * \endvar
2860  */
2861                 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
2862
2863 /*!
2864  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
2865  * \li Action: Make a parameter non-optional.
2866  * \li Notion: Turn the last optional parameter of a Math Macro
2867                into a non-optional parameter. The default value is
2868                remembered to be reused later if the user changes his mind.
2869  * \li Syntax: math-macro-make-nonoptional
2870  * \li Origin: sts, 06 January 2008
2871  * \endvar
2872  */
2873                 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
2874
2875 /*!
2876  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
2877  * \li Action: Make a parameter optional.
2878  * \li Notion: Turn the first non-optional parameter of a Math Macro
2879                into an optional parameter with a default value.
2880  * \li Syntax: math-macro-make-optional
2881  * \li Origin: sts, 06 January 2008
2882  * \endvar
2883  */
2884                 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
2885
2886 /*!
2887  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
2888  * \li Action: Remove a greedy parameter.
2889  * \li Notion: Remove a greedy parameter of a Math Macro and spit
2890                out the values of it in every instance of the macro
2891                in the buffer. If it is an optional parameter the [valud]
2892                format is used.
2893  * \li Syntax: math-macro-remove-greedy-param
2894  * \li Origin: sts, 06 January 2008
2895  * \endvar
2896  */
2897                 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
2898
2899 /*!
2900  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
2901  * \li Action: Remove the last optional parameter.
2902  * \li Notion: Remove the last optional parameter of a Math Macro and
2903                remove it in all the instances of the macro in the buffer.
2904  * \li Syntax: math-macro-remove-optional-param
2905  * \li Origin: sts, 06 January 2008
2906  * \endvar
2907  */
2908                 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
2909
2910 /*!
2911  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
2912  * \li Action: Remove the last parameter.
2913  * \li Notion: Remove the last parameter of a Math Macro and
2914                remove its value in all instances of the macro
2915                in the buffer.
2916  * \li Params: <NUM>: The number of the parameter to be deleted (1 for
2917                the first), defaults to the last one.
2918  * \li Syntax: math-macro-remove-param <NUM>
2919  * \li Origin: sts, 06 January 2008
2920  * \endvar
2921  */
2922                 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
2923
2924 /*!
2925  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
2926  * \li Action: Unfold a Math Macro.
2927  * \li Notion: Unfold the Math Macro the cursor is in, i.e.
2928                display it as \foo.
2929  * \li Syntax: math-macro-unfold
2930  * \li Origin: sts, 06 January 2008
2931  * \endvar
2932  */
2933                 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
2934
2935 /*!
2936  * \var lyx::FuncCode lyx::LFUN_MATH_MATRIX
2937  * \li Action: Inserts a matrix.
2938  * \li Syntax: math-matrix <COLS> <ROWS> [<ALIGN>]
2939  * \li Params: <ALIGN>: Alignment is a word composed of the vertical alignment
2940                         (b, c or t) (i.e. 1 char) and the horizontal alignments
2941                         (l, c or r) (i.e. <COL> chars).
2942  * \li Sample: math-matrix 3 3 bccc
2943  * \endvar
2944  */
2945                 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
2946
2947 /*!
2948  * \var lyx::FuncCode lyx::LFUN_MATH_MODE
2949  * \li Action: In text mode enters math mode (i.e. puts math insets on the current
2950                cursor position), in math mode enters text mode inside math expression.
2951  * \li Notion: If there is some selected text, it puts the text inside created math box.
2952  * \li Syntax: math-mode [on|<ARG>]
2953  * \li Params: <ARG>: eventual argument (LaTeX code) is passed to #LFUN_MATH_INSERT .\n
2954                 "on": allow only entering of math mode from text mode.
2955  * \li Origin: Alejandro, 4 Jun 1996
2956  * \endvar
2957  */
2958                 { LFUN_MATH_MODE, "math-mode", Noop, Math },
2959
2960 /*!
2961  * \var lyx::FuncCode lyx::LFUN_MATH_MUTATE
2962  * \li Action: Mutates the type of math inset to the newly selected one.
2963  * \li Syntax: math-mutate <TYPE>
2964  * \li Params: <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
2965                        multline|gather|flalign
2966  * \li Origin: Andre, 23 May 2001
2967  * \endvar
2968  */
2969                 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
2970
2971 /*!
2972  * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
2973  * \li Action: Toggles numbering of the current formula line.
2974  * \li Notion: Must be in display formula mode.
2975  * \li Syntax: math-number-line-toggle
2976  * \li Origin: Alejandro, 18 Jun 1996
2977  * \endvar
2978  */
2979                 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
2980
2981 /*!
2982  * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
2983  * \li Action: Toggles numbering/labeling of the current formula.
2984  * \li Notion: Must be in display formula mode.
2985  * \li Syntax: math-number-toggle
2986  * \li Origin: Alejandro, 4 Jun 1996
2987  * \endvar
2988  */
2989                 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
2990
2991 /*!
2992  * \var lyx::FuncCode lyx::LFUN_MATH_SIZE
2993  * \li Action: Changes arbitrarily the size used by math fonts inside a context.
2994  * \li Notion: Provides an interface to the LaTeX math mode font size commands.
2995  * \li Syntax: math-size <STYLE>
2996  * \li Params: <STYLE>: \displaystyle|\textstyle|\scriptstyle|\scriptscriptstyle
2997  * \li Origin: Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
2998  * \endvar
2999  */
3000                 { LFUN_MATH_SIZE, "math-size", Noop, Math },
3001
3002 /*!
3003  * \var lyx::FuncCode lyx::LFUN_MATH_SPACE
3004  * \li Action: Inserts space into math expression.
3005  * \li Notion: Use spacebar after entering this space to change type of space.
3006  * \li Syntax: math-space [<TYPE>] [<LEN>]
3007  * \li Params: <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace \n
3008                        positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad \n
3009                        custom space: hspace \n
3010                        "," used by default.\n
3011                        Note that ! is equivalent to negthinspace, , = thinspace,
3012                        : = medspace, and ; = thickspace.\n
3013                <LEN>: length for custom spaces (hspace)
3014  * \li Origin: Andre, 25 Jul 2001; sanda, 16 Jun 2008
3015  * \endvar
3016  */
3017                 { LFUN_MATH_SPACE, "math-space", Noop, Math },
3018
3019 /*!
3020  * \var lyx::FuncCode lyx::LFUN_MATH_SUBSCRIPT
3021  * \li Action: Enters subscript expression in math expression.
3022  * \li Syntax: math-subscript
3023  * \li Origin: vermeer, 12 Dec 2001
3024  * \endvar
3025  */
3026                 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
3027
3028 /*!
3029  * \var lyx::FuncCode lyx::LFUN_MATH_SUPERSCRIPT
3030  * \li Action: Enters superscript expression in math expression.
3031  * \li Syntax: math-superscript
3032  * \li Origin: vermeer, 12 Dec 2001
3033  * \endvar
3034  */
3035                 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
3036
3037 /*!
3038  * \var lyx::FuncCode lyx::LFUN_MENU_OPEN
3039  * \li Action: Opens the menu given by its name.
3040  * \li Syntax: menu-open <NAME>
3041  * \li Params: <NAME>: menu name. See various .inc files in lib/ui for candidates.
3042  * \endvar
3043  */
3044                 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
3045
3046 /*!
3047  * \var lyx::FuncCode lyx::LFUN_MESSAGE
3048  * \li Action: Shows message in statusbar (for script purposes).
3049  * \li Syntax: message <STRING>
3050  * \li Origin: Lgb, 8 Apr 2001
3051  * \endvar
3052  */
3053                 { LFUN_MESSAGE, "message", NoBuffer, System },
3054
3055 /*!
3056  * \var lyx::FuncCode lyx::LFUN_META_PREFIX
3057  * \li Action: Simulate halting Meta key (Alt key on PCs).
3058  * \li Notion: Used for buffer edition not for GUI control.
3059  * \li Syntax: meta-prefix
3060  * \endvar
3061  */
3062                 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
3063
3064 /*!
3065  * \var lyx::FuncCode lyx::LFUN_MOUSE_DOUBLE
3066  * \li Action: This function is called when double click on mouse button is
3067                pressed (inside workarea). Action depends on the context.
3068  * \li Notion: This is an internal LFUN, not to be used by users.
3069  * \li Origin: Andre, 9 Aug 2002
3070  * \endvar
3071  */
3072                 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
3073
3074 /*!
3075  * \var lyx::FuncCode lyx::LFUN_MOUSE_MOTION
3076  * \li Action: This function is called when mouse cursor is moving over the text.
3077                Action depends on the context.
3078  * \li Notion: This is an internal LFUN, not to be used by users.
3079  * \li Origin: Andre, 9 Aug 2002
3080  * \endvar
3081  */
3082                 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
3083
3084 /*!
3085  * \var lyx::FuncCode lyx::LFUN_MOUSE_PRESS
3086  * \li Action: This function is called when mouse button is pressed (inside workarea).
3087                Action depends on the context.
3088  * \li Notion: This is an internal LFUN, not to be used by users.
3089  * \li Origin: Andre, 9 Aug 2002
3090  * \endvar
3091  */
3092                 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
3093
3094 /*!
3095  * \var lyx::FuncCode lyx::LFUN_MOUSE_RELEASE
3096  * \li Action: This function is called when mouse button is released (inside workarea).
3097                Action depends on the context.
3098  * \li Notion: This is an internal LFUN, not to be used by users.
3099  * \li Origin: Andre, 9 Aug 2002
3100  * \endvar
3101  */
3102                 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
3103
3104
3105 /*!
3106  * \var lyx::FuncCode lyx::LFUN_MOUSE_TRIPLE
3107  * \li Action: This function is called when triple click on mouse button is
3108                pressed (inside workarea). Action depends on the context.
3109  * \li Notion: This is an internal LFUN, not to be used by users.
3110  * \li Origin: Andre, 9 Aug 2002
3111  * \endvar
3112  */
3113                 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
3114
3115 /*!
3116  * \var lyx::FuncCode lyx::LFUN_NEWLINE_INSERT
3117  * \li Action: Inserts a line break or new line.
3118  * \li Syntax: newline-insert [<ARG>]
3119  * \li Params: <ARG>: <newline|linebreak> default: newline
3120  * \li Origin: spitz, 25 Mar 2008
3121  * \endvar
3122  */
3123                 { LFUN_NEWLINE_INSERT, "newline-insert", Noop, Edit },
3124
3125 /*!
3126  * \var lyx::FuncCode lyx::LFUN_NEWPAGE_INSERT
3127  * \li Action: Inserts a new page.
3128  * \li Syntax: newpage-insert <ARG>
3129  * \li Params: <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
3130  * \li Origin: uwestoehr, 24 Nov 2007
3131  * \endvar
3132  */
3133                 { LFUN_NEWPAGE_INSERT, "newpage-insert", Noop, Edit },
3134
3135 /*!
3136  * \var lyx::FuncCode lyx::LFUN_NOMENCL_INSERT
3137  * \li Action: Inserts Nomenclature entry.
3138  * \li Notion: It automatically takes the word on the cursor position if no symbol is given.
3139  * \li Syntax: nomencl-insert [<SYMBOL>]
3140  * \li Origin: Ugras, 4 Nov 2006
3141  * \endvar
3142  */
3143                 { LFUN_NOMENCL_INSERT, "nomencl-insert", Noop, Edit },
3144
3145 /*!
3146  * \var lyx::FuncCode lyx::LFUN_NOMENCLATURE_PRINT
3147  * \li Action: Inserts list of Nomenclature entries.
3148  * \li Syntax: nomenclature-print
3149  * \li Origin: Ugras, 4 Nov 2006
3150  * \endvar
3151  */
3152                 { LFUN_NOMENCL_PRINT, "nomencl-print", Noop, Edit },
3153
3154
3155 /*!
3156  * \var lyx::FuncCode lyx::LFUN_NOTE_INSERT
3157  * \li Action: Inserts Note on the current cursor position,
3158                move selection inside the inset.
3159  * \li Syntax: note-insert [<TYPE>]
3160  * \li Params: <TYPE>: <Note|Greyedout|Comment> default: Note
3161  * \endvar
3162  */
3163                 { LFUN_NOTE_INSERT, "note-insert", Noop, Edit },
3164
3165 /*!
3166  * \var lyx::FuncCode lyx::LFUN_NOTE_NEXT
3167  * \li Action: Moves the cursor to the beginning of next Note inset.
3168  * \li Syntax: note-next
3169  * \endvar
3170  */
3171                 { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
3172
3173 /*!
3174  * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
3175  * \li Action: Move the current group in the downward direction in the
3176                structure of the document.
3177  * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
3178                the whole substructure of the group.
3179  * \li Syntax: outline-down
3180  * \li Origin: Vermeer, 23 Mar 2006
3181  * \endvar
3182  */
3183                 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
3184
3185 /*!
3186  * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
3187  * \li Action: Moves the current group in the downward direction in the
3188                hierarchy of the document structure.
3189  * \li Notion: Part -> Chapter -> Section -> etc.
3190  * \li Syntax: outline-in
3191  * \li Origin: Vermeer, 23 Mar 2006
3192  * \endvar
3193  */
3194                 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
3195
3196 /*!
3197  * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
3198  * \li Action: Moves the current group in the upward direction in the
3199                hierarchy of the document structure.
3200  * \li Notion: Part <- Chapter <- Section <- etc.
3201  * \li Syntax: outline-out
3202  * \li Origin: Vermeer, 23 Mar 2006
3203  * \endvar
3204  */
3205                 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
3206
3207
3208 /*!
3209  * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
3210  * \li Action: Move the current group in the upward direction in the
3211                structure of the document.
3212  * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
3213                the whole substructure of the group.
3214  * \li Syntax: outline-up
3215  * \li Origin: Vermeer, 23 Mar 2006
3216  * \endvar
3217  */
3218                 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
3219
3220 /*!
3221  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_BREAK
3222  * \li Action: Breaks the current paragraph at the current location.
3223  * \li Notion: Removes the selection.
3224  * \li Syntax: paragraph-break [<LAYOUT>] [ignoresep]
3225  * \li Params: <LAYOUT>: "inverse" - decreases depth by one (or change layout
3226                          to default layout) when the cursor is at the end of
3227                          the line.\n
3228                ignoresep: Do not account for paragraph separators while breaking.
3229  * \endvar
3230  */
3231                 { LFUN_PARAGRAPH_BREAK, "paragraph-break", Noop, Edit },
3232
3233 /*!
3234  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN
3235  * \li Action: Move the cursor to the next paragraph (or beginning of the current one)
3236                in downward direction.
3237  * \li Syntax: paragraph-down
3238  * \li Origin: Asger, 1 Oct 1996
3239  * \endvar
3240  */
3241                 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
3242
3243 /*!
3244  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN_SELECT
3245  * \li Action: Move the cursor and select the text to the next paragraph (or
3246                beginning of the current one) in downward direction.
3247  * \li Syntax: paragraph-down-select
3248  * \li Origin: Asger, 1 Oct 1996
3249  * \endvar
3250  */
3251                 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
3252
3253 /*!
3254  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
3255  * \li Action: Jump to a paragraph given by its id number and optionally the
3256                desired position within the paragraph.
3257                If given four arguments id_start, pos_start, id_end, pos_end,
3258                perform a selection from start to end.
3259  * \li Notion: Note that id number of paragraph is not the sequential number of
3260                paragraph seen on the screen. Moreover the id is unique for all
3261                opened buffers (documents). Both ids must belong to the same
3262                buffer.
3263  * \li Syntax: paragraph-goto <PAR_ID> <POS_IN_PAR> [<PAR_ID> <POS_IN_PAR>]
3264  * \li Params: <PAR_ID>:  paragraph id \n
3265                <POS_IN_PAR>: desired position within the paragraph
3266  * \li Origin: Dekel, 26 Aug 2000
3267                gmunch, 5 Sep 2016
3268  * \endvar
3269  */
3270                 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly | NoInternal, Edit },
3271
3272 /*!
3273  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
3274  * \li Action: Moves the current paragraph downwards in the document.
3275  * \li Syntax: paragraph-move-down
3276  * \li Origin: Edwin, 8 Apr 2006
3277  * \endvar
3278  */
3279                 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
3280
3281 /*!
3282  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
3283  * \li Action: Moves the current paragraph upwards in the document.
3284  * \li Notion: Movement through the document will possibly break the paragraph-depth
3285                (e.g. itemize structure).
3286  * \li Syntax: paragraph-move-up
3287  * \li Origin: Edwin, 8 Apr 2006
3288  * \endvar
3289  */
3290                 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
3291
3292
3293 /*!
3294  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
3295  * \li Action: Change paragraph settings.
3296  * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
3297                This function only modifies, and does not override, existing settings.
3298                Note that the "leftindent" indent setting is deprecated.
3299  * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
3300  * \li Params: <INDENT>:  \noindent|\indent|\indent-toggle|\leftindent LENGTH\n
3301                <SPACING>: \paragraph_spacing default|single|onehalf|double|other SIZE \n
3302                <ALIGN>:   \align block|left|right|center|default\n
3303                <OTHERS>:  \labelwidthstring WIDTH|\start_of_appendix
3304  * \li Origin: rgh, Aug 15 2007
3305  * \endvar
3306  */
3307                 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
3308
3309 /*!
3310  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
3311  * \li Action: Change paragraph settings.
3312  * \li Notion: Overwrite all nonspecified settings to the default ones.
3313                Use paragraph-params lfun if you don't want to overwrite others settings.
3314  * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
3315  * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
3316  * \li Origin: leeming, 30 Mar 2004
3317  * \endvar
3318  */
3319                 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
3320
3321 /*!
3322  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP
3323  * \li Action: Move the cursor to the next paragraph (or beginning of the current one)
3324                in upward direction.
3325  * \li Syntax: paragraph-up
3326  * \li Origin: Asger, 1 Oct 1996
3327  * \endvar
3328  */
3329                 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
3330
3331 /*!
3332  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UPDATE
3333  * \li Action: Updates the values inside the paragraph dialog from the paragraph.
3334  * \li Notion: This is an internal LFUN, not to be used by users. Called internally
3335                by #LFUN_DIALOG_UPDATE.
3336  * \li Origin: leeming, 13 Mar 2003
3337  * \endvar
3338  */
3339                 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
3340
3341 /*!
3342  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_SELECT
3343  * \li Action: Move cursor to beginning of current paragraph
3344                and select to the end in downward direction
3345  * \li Notion: This function is by default bound to triple mouse click
3346  * \li Syntax: paragraph-select
3347  * \li Origin: Kornel, 16 Apr 2019
3348  * \endvar
3349  */
3350                 { LFUN_PARAGRAPH_SELECT, "paragraph-select", ReadOnly, Edit },
3351
3352 /*!
3353  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP_SELECT
3354  * \li Action: Move the cursor and select the text to the next paragraph (or
3355                beginning of the current one) in upward direction.
3356  * \li Syntax: paragraph-up-select
3357  * \li Origin: Asger, 1 Oct 1996
3358  * \endvar
3359  */
3360                 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
3361
3362 /*!
3363  * \var lyx::FuncCode lyx::LFUN_PASTE
3364  * \li Action: Pastes material (text or picture) from the active clipboard.
3365  * \li Syntax: paste [<TYPE>|<NUM>]
3366  * \li Params: <TYPE>: emf|pdf|png|jpeg|linkback|wmf|latex|html \n
3367                <NUM>: number of the selection in the internal clipboard stack to be pasted.
3368  * \endvar
3369  */
3370                 { LFUN_PASTE, "paste", Noop, Edit },
3371
3372 /*!
3373  * \var lyx::FuncCode lyx::LFUN_PHANTOM_INSERT
3374  * \li Action: Inserts phantom on the current cursor position,
3375                move selection inside the inset.
3376  * \li Syntax: phantom-insert [<TYPE>]
3377  * \li Params: <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
3378  * \li Origin: uwestoehr, 30 Jan 2009
3379  * \endvar
3380  */
3381                 { LFUN_PHANTOM_INSERT, "phantom-insert", Noop, Edit },
3382
3383 /*!
3384  * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
3385  * \li Action: Save user preferences.
3386  * \li Syntax: preferences-save
3387  * \li Origin: Lgb, 27 Nov 1999
3388  * \endvar
3389  */
3390                 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
3391
3392 /*!
3393  * \var lyx::FuncCode lyx::LFUN_PREVIEW_INSERT
3394  * \li Action: Inserts a new preview inset.
3395  * \li Syntax: preview-insert
3396  * \li Origin: vfr, 28 Mar 2010
3397  * \endvar
3398  */
3399                 { LFUN_PREVIEW_INSERT, "preview-insert", Noop, Edit },
3400
3401 /*!
3402  * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
3403  * \li Action: Pastes the currently selected text.
3404  * \li Notion: Primary selection mechanism is linux-only thing.
3405  * \li Syntax: primary-selection-paste [<ARG>]
3406  * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
3407  * \endvar
3408  */
3409                 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
3410
3411 /*!
3412  * \var lyx::FuncCode lyx::LFUN_QUOTE_INSERT
3413  * \li Action: Inserts quotes according to the type and quote-language preference.
3414  * \li Notion: Currently 15 different quote styles are distinguished (see params).
3415  * \li Syntax: quote-insert [<LEVEL>] [<SIDE>] [<STYLE>]
3416  * \li Params: <LEVEL>: 'inner' for (i.e., secondary, usually single) quotes, otherwise
3417  *                       outer (i.e., primary, usually double) quotes will be used.\n
3418  *             <SIDE>:  'opening' for opening quotes, 'closing' for closing quotes,
3419  *                       otherwise the side will be guessed from the context.\n
3420  *             <STYLE>: 'british' for `British' quote style (with ``inner quotation'')\n
3421  *                      'cjk' for Chinese/Japanese/Korean corner bracket quotation marks\n
3422  *                      'cjk-angle' for Chinese/Japanese/Korean angle bracket quotation marks\n
3423  *                      'danish' for >>Danish<< quote style (with >inner quotation<)\n
3424  *                      'english' for ``English'' quote style (with `inner quotation')\n
3425  *                      'french' for <<french>> quote style (with ``inner quotation'')\n
3426  *                      'frenchin' for <<frenchin>> quote style (with <<inner quotation>>) ["in" = Imprimerie Nationale]\n
3427  *                      'german' for ,,German`` quote style (with ,inner quotation`)\n
3428  *                      'plain' for "Plain" quote style (with 'inner quotation')\n
3429  *                      'polish' for ,,Polish'' quote style (with ,inner quotation')\n
3430  *                      'swedish' for ''Swedish'' quote style (with 'inner quotation')\n
3431  *                      'swedishg' for >>swedishg>> quote style (with 'inner quotation') ["g" = Guillemets]\n
3432  *                      'swiss' for <<Swiss>> quote style (with <inner quotation>)\n
3433  *                      'russian' for <<Russian>> quote style (with ,,inner quotation``)\n
3434  *                      'dynamic' for Dynamic quotation marks which inherit the global
3435  *                                document style\n
3436  *                      If no quote style is specified, the document-wide will be used.
3437  * \endvar
3438  */
3439                 { LFUN_QUOTE_INSERT, "quote-insert", Noop, Edit },
3440
3441 /*!
3442  * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
3443  * \li Action: Reconfigure the automatic settings.
3444  * \li Syntax: reconfigure
3445  * \li Origin: Asger, 14 Feb 1997
3446  * \endvar
3447  */
3448                 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
3449
3450 /*!
3451  * \var lyx::FuncCode lyx::LFUN_REDO
3452  * \li Action: Redoes the last thing undone.
3453  * \li Syntax: redo
3454  * \endvar
3455  */
3456                 { LFUN_REDO, "redo", ReadOnly, Edit },
3457
3458 /*!
3459  * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
3460  * \li Action: Go to the next label or cross-reference.
3461  * \li Syntax: reference-next
3462  * \li Origin: Dekel, 14 Jan 2001
3463  * \endvar
3464  */
3465                 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
3466
3467
3468 /*!
3469  * \var lyx::FuncCode lyx::LFUN_REGEXP_MODE
3470  * \li Action: Enters regexp mode (i.e., puts regexp insets on the current
3471                cursor position). Used by the advanced search dialog.
3472  * \li Notion: If there is any selected text, then it is moved inside the created
3473                regexp inset.
3474  * \li Syntax: regexp-mode [<ARG>]
3475  * \li Params: <ARG>: eventual argument (regular expression).
3476  * \li Origin: Tommaso, 4 Oct 2008
3477  * \endvar
3478  */
3479                 { LFUN_REGEXP_MODE, "regexp-mode", Noop, Math },
3480
3481 /*!
3482  * \var lyx::FuncCode lyx::LFUN_REPEAT
3483  * \li Action: Repeat the given command.
3484  * \li Notion: fails when the repeat count is greater than 10000.
3485  * \li Syntax: repeat <COUNT> <LFUN-COMMAND>
3486  * \li Origin: Andre, 27 Oct 2003
3487  * \endvar
3488  */
3489                 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
3490
3491 /*!
3492  * \var lyx::FuncCode lyx::LFUN_SEARCH_IGNORE
3493  * \li Action: Enables/disables searching for features in findadv
3494  * \li Syntax: search-ignore <type> <value>
3495  * \li Params: <type>: language|color|sectioning|font|series|shape|family|markup|underline|strike|deleted
3496  * \li Params: <value>: true|false
3497  * \endvar
3498  */
3499                 { LFUN_SEARCH_IGNORE, "search-ignore", ReadOnly|NoBuffer|NoUpdate, System },
3500
3501 /*!
3502  * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN
3503  * \li Action: Moves the cursor one page in downward direction.
3504  * \li Syntax: screen-down
3505  * \endvar
3506  */
3507                 { LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit },
3508
3509 /*!
3510  * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN_SELECT
3511  * \li Action: Moves the cursor one screen in downward direction adding the current
3512                position to the selection.
3513  * \li Syntax: screen-down-select
3514  * \endvar
3515  */
3516                 { LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit },
3517
3518 /*!
3519  * \var lyx::FuncCode lyx::LFUN_SCREEN_FONT_UPDATE
3520  * \li Action: Update fonts and its metrics.
3521  * \li Notion: Automatically called after zoom, dpi, font names, or norm change.
3522  * \li Syntax: screen-font-update
3523  * \li Origin: ARRae, 13 Aug 2000
3524  * \endvar
3525  */
3526                 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
3527
3528 /*!
3529  * \var lyx::FuncCode lyx::LFUN_SCREEN_RECENTER
3530  * \li Action: Recenters the screen on the current cursor position.
3531  * \li Syntax: screen-recenter
3532  * \endvar
3533  */
3534                 { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit },
3535
3536
3537 /*!
3538  * \var lyx::FuncCode lyx::LFUN_SCREEN_SHOW_CURSOR
3539  * \li Action: Repositions the screen such that the cursor is visible.
3540  * \li Syntax: screen-show-cursor
3541  * \li Origin: vfr, 25 Mar 2009
3542  * \endvar
3543  */
3544                 { LFUN_SCREEN_SHOW_CURSOR, "screen-show-cursor", ReadOnly, Edit },
3545
3546
3547 /*!
3548  * \var lyx::FuncCode lyx::LFUN_SCREEN_UP
3549  * \li Action: Moves the cursor one page in upward direction.
3550  * \li Syntax: screen-up
3551  * \endvar
3552  */
3553                 { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit },
3554
3555 /*!
3556  * \var lyx::FuncCode lyx::LFUN_SCREEN_UP_SELECT
3557  * \li Action: Moves the cursor one page in upward direction adding the current
3558                position to the selection.
3559  * \li Syntax: screen-up-select
3560  * \endvar
3561  */
3562                 { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit },
3563
3564 /*!
3565  * \var lyx::FuncCode lyx::LFUN_SCRIPT_INSERT
3566  * \li Action: Inserts a subscript or superscript inset.
3567  * \li Syntax: script-insert <TYPE>
3568  * \li Params: <TYPE>: subscript|superscript
3569  * \li Origin: Georg, 23 Nov 2010
3570  * \endvar
3571  */
3572                 { LFUN_SCRIPT_INSERT, "script-insert", Noop, Edit },
3573
3574 /*!
3575  * \var lyx::FuncCode lyx::LFUN_SCROLL
3576  * \li Action: Scroll the buffer view.
3577  * \li Notion: Only scrolls the screen up or down; does not move the cursor.
3578  * \li Syntax: scroll <TYPE> <QUANTITY>
3579  * \li Params: <TYPE>:  line|page\n
3580                <QUANTITY>: up|down|<number>
3581  * \li Origin: Abdel, Dec 27 2007
3582  * \endvar
3583  */
3584                 { LFUN_SCROLL, "scroll", ReadOnly, Edit },
3585
3586 /*!
3587  * \var lyx::FuncCode lyx::LFUN_SECTION_SELECT
3588  * \li Action: Select the whole section.
3589  * \li Notion: The cursor should be in a section heading
3590                before calling this lfun.
3591  * \li Syntax: section-select
3592  * \li Origin: vfr, 05 May 2009
3593  * \endvar
3594  */
3595                 { LFUN_SECTION_SELECT, "section-select", ReadOnly, Edit },
3596
3597
3598 /*!
3599  * \var lyx::FuncCode lyx::LFUN_SELECTION_PASTE
3600  * \li Action: Pastes the internal selection text in permanent selection.
3601  * \li Notion: Created in order to have middle mouse button pasting correct (bound to
3602                command-alternatives selection-paste ; primary-selection-paste paragraph).
3603  * \li Syntax: selection-paste
3604  * \li Origin: lasgouttes, 14 Jan 2009
3605  * \endvar
3606  */
3607                 { LFUN_SELECTION_PASTE, "selection-paste", Noop, Edit },
3608
3609 /*!
3610  * \var lyx::FuncCode lyx::LFUN_SELF_INSERT
3611  * \li Action: Inserts the given string (accordingly to the correct keymap).
3612  * \li Notion: Automatically replace the currently selected text. Depends on lyxrc
3613                settings "auto_region_delete".
3614  * \li Syntax: self-insert <STRING>
3615  * \endvar
3616  */
3617                 { LFUN_SELF_INSERT, "self-insert", SingleParUpdate, Hidden },
3618
3619 /*!
3620  * \var lyx::FuncCode lyx::LFUN_SEPARATOR_INSERT
3621  * \li Action: Inserts an environment separator or latex paragraph break.
3622  * \li Syntax: separator-insert [<ARG>]
3623  * \li Params: <ARG>: <plain|parbreak|latexpar> default: plain
3624  * \li Origin: ef, 2 May 2014
3625  * \endvar
3626  */
3627                 { LFUN_SEPARATOR_INSERT, "separator-insert", Noop, Edit },
3628
3629 /*!
3630  * \var lyx::FuncCode lyx::LFUN_SERVER_GET_FILENAME
3631  * \li Action: Returns path and file name of the currently edited document.
3632  * \li Syntax: server-get-filename
3633  * \endvar
3634  */
3635                 { LFUN_SERVER_GET_FILENAME, "server-get-filename", ReadOnly, System },
3636
3637 /*!
3638  * \var lyx::FuncCode lyx::LFUN_SERVER_GET_LAYOUT
3639  * \li Action: Returns the current layout (that is environment) name
3640                on the cursor position.
3641  * \li Syntax: server-get-layout
3642  * \endvar
3643  */
3644                 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
3645
3646 /*!
3647  * \var lyx::FuncCode lyx::LFUN_SERVER_GET_STATISTICS
3648  * \li Action: Returns the statistics (number of words and characters)
3649                in the document or in the given selection.
3650  * \li Notion: Note that this function gives the number of words/chars written,
3651                not the number of characters which will be typeset.
3652  * \li Syntax: server-get-statistics [<TYPE>]
3653  * \li Params: <TYPE>: <words|chars|chars-space> The requested count; if not
3654                        specified, the three values are returned, separated
3655                        by a space.\n
3656                 words: count words.\n
3657                 chars: count characters.\n
3658                 chars-space: count characters and spaces.
3659  * \li Origin: brokenclock, Oct 10 2014
3660  * \endvar
3661  */
3662                 { LFUN_SERVER_GET_STATISTICS, "server-get-statistics", ReadOnly, System },
3663
3664 /*!
3665  * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
3666  * \li Action: Returns the coordinates of cursor position in the editing area.
3667  * \li Syntax: server-get-xy
3668  * \endvar
3669  */
3670                 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
3671
3672
3673 /*!
3674  * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
3675  * \li Action: Sets the cursor position in LyX based on the row number of generated TeX file.
3676  * \li Notion: This can be useful for DVI inverse-search or detection of the problematic
3677                line from LaTeX compilation. Note that before this function can be used
3678                export to LaTeX output must occur (in order to map the row numbers).
3679  * \li Syntax: server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
3680  * \li Params: <FILE>: the path and filename. Environment variables are expanded in the path.
3681                        In case this LFUN does not work make sure you are giving correct
3682                        path to the file.\n
3683                        If the file is located inside LyX temporary directory it will be
3684                        mapped back into the appropriate opened buffer (e.g. for the case
3685                        of generated .tex file).\n
3686                  .ext: extensions will be automatically replaced by .lyx.\n
3687                  <ROW_NUMBER> The row number of the LaTeX file to which to go.
3688  * \li Sample: server-goto-file-row /home/user/example.lyx 41\n
3689                server-goto-file-row /tmp/lyx_tmpdir.XM3088/lyx_tmpbuf0/example.tex 41
3690  * \li Origin: Edmar, 23 Dec 1998
3691  * \endvar
3692  */
3693                 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly | NoBuffer, System },
3694
3695 /*!
3696  * \var lyx::FuncCode lyx::LFUN_SERVER_NOTIFY
3697  * \li Action: Sends notify message about the last key-sequence to client.
3698  * \li Notion: This can be used to grab last key-sequence used inside the LyX window.
3699                See also Debug extensions section in Additional features manual.
3700  * \li Syntax: server-notify
3701  * \endvar
3702  */
3703                 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
3704
3705 /*!
3706  * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
3707  * \li Action: Sets the cursor position based on the editing area coordinates
3708                (similar to clicking on that point with left mouse button).
3709  * \li Syntax: server-set-xy <X> <Y>
3710  * \endvar
3711  */
3712                 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
3713
3714 /*!
3715  * \var lyx::FuncCode lyx::LFUN_SET_COLOR
3716  * \li Action: Set the given LyX color to the color defined by the X11 name given,
3717  *             and optionally a specific color for dark mode.
3718  * \li Notion: A new color entry is created if the color is unknown.
3719                Color names can be stored as a part of user settings.
3720  * \li Syntax: set-color <LYX_NAME> <X11_NAME> [<X11_DARKNAME>]
3721  * \li Origin: SLior, 11 Jun 2000
3722  * \endvar
3723  */
3724                 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
3725
3726 /*!
3727  * \var lyx::FuncCode lyx::LFUN_GRAPHICS_SET_GROUP
3728  * \li Action: Set the group for the graphics inset on the cursor position.
3729  * \li Syntax: graphics-set-group [<GROUP>]
3730  * \li Params: <GROUP>: Id for an existing group. In case the Id is an empty string,
3731                         the graphics inset is removed from the current group.
3732  * \li Origin: sanda, 6 May 2008
3733  * \endvar
3734  */
3735                 { LFUN_GRAPHICS_SET_GROUP, "graphics-set-group", Noop, Edit },
3736
3737 /*!
3738  * \var lyx::FuncCode lyx::LFUN_GRAPHICS_UNIFY
3739  * \li Action: Set the same group for all graphics insets in the marked block.
3740  * \li Syntax: graphics-unify [<GROUP>]
3741  * \li Params: <GROUP>: Id for an existing group. In case the Id is an empty string,
3742                         the group Id from the first graphics inset will be used.
3743  * \li Origin: sanda, 7 Feb 2018
3744  * \endvar
3745  */
3746                 { LFUN_GRAPHICS_UNIFY, "graphics-unify", Noop, Edit },
3747
3748 /*!
3749  * \var lyx::FuncCode lyx::LFUN_GRAPHICS_RELOAD
3750  * \li Action: Reloads the image if necessary.
3751  * \li Syntax: graphics-reload
3752  * \li Origin: vfr, 10 Aug 2009
3753  * \endvar
3754  */
3755                 { LFUN_GRAPHICS_RELOAD, "graphics-reload", ReadOnly | AtPoint, Edit },
3756
3757 /*!
3758  * \var lyx::FuncCode lyx::LFUN_SPACE_INSERT
3759  * \li Action: Inserts one of horizontal space insets.
3760  * \li Syntax: space-insert <NAME> [<LEN>]
3761  * \li Params: <NAME>: normal, protected, visible, thin, quad, qquad, enspace,
3762                        enskip, negthinspace, negmedspace, negthickspace, hfill,
3763                        hfill*, dotfill, hrulefill, hspace, hspace* \n
3764                        Only in math mode: med and thick.\n
3765                <LEN>: length for custom spaces (hspace, hspace* for protected)
3766  * \li Origin: spitz, 20 May 2003, Mar 17 2008
3767  * \endvar
3768  */
3769                 { LFUN_SPACE_INSERT, "space-insert", Noop, Edit },
3770
3771 /*!
3772  * \var lyx::FuncCode lyx::LFUN_SPECIALCHAR_INSERT
3773  * \li Action: Inserts various characters into the document.
3774  * \li Syntax: specialchar-insert <CHAR>
3775  * \li Params: <CHAR>: hyphenation, allowbreak, ligature-break, slash,
3776                        nobreakdash, dots, end-of-sentence, menu-separator,
3777                        lyx, tex, latex, latex2e.
3778  * \li Origin: spitz, 6 Dec 2007
3779  * \endvar
3780  */
3781                 { LFUN_SPECIALCHAR_INSERT, "specialchar-insert", Noop, Edit },
3782
3783 /*!
3784  * \var lyx::FuncCode lyx::LFUN_SPELLING_ADD
3785  * \li Action: Add the word under the cursor to the respective
3786  *             spell checker dictionary.
3787  *             The default for the language is retrieved from the cursor position.
3788  * \li Syntax: spelling-add [<STRING>] [<LANG>]
3789  * \li Params: <WORD>: word to add
3790                <LANG>: language name (see file languages)
3791  * \li Origin: spitz, 18 Jan 2010
3792  * \endvar
3793  */
3794                 { LFUN_SPELLING_ADD, "spelling-add", ReadOnly, Edit },
3795
3796 /*!
3797  * \var lyx::FuncCode lyx::LFUN_SPELLING_ADD_LOCAL
3798  * \li Action: Add the word under the cursor to the document's local
3799  *             spell checker dictionary.
3800  *             The default for the language is retrieved from the cursor position.
3801  * \li Syntax: spelling-add-local [<STRING>] [<LANG>]
3802  * \li Params: <WORD>: word to add
3803                <LANG>: language name (see file languages)
3804  * \li Origin: spitz, 6 Mar 2021
3805  * \endvar
3806  */
3807                 { LFUN_SPELLING_ADD_LOCAL, "spelling-add-local", Noop, Edit },
3808
3809 /*!
3810  * \var lyx::FuncCode lyx::LFUN_SPELLING_REMOVE_LOCAL
3811  * \li Action: Remove the word under the cursor from the document's local
3812  *             spell checker dictionary.
3813  *             The default for the language is retrieved from the cursor position.
3814  * \li Syntax: spelling-remove-local [<STRING>] [<LANG>]
3815  * \li Params: <WORD>: word to remove
3816                <LANG>: language name (see file languages)
3817  * \li Origin: spitz, 7 Mar 2021
3818  * \endvar
3819  */
3820                 { LFUN_SPELLING_REMOVE_LOCAL, "spelling-remove-local", Noop, Edit },
3821
3822 /*!
3823  * \var lyx::FuncCode lyx::LFUN_SPELLING_CONTINUOUSLY
3824  * \li Action: Toggle continuous spell checking.
3825  * \li Syntax: spelling-continuously
3826  * \li Origin: vfr, 24 March 2013
3827  * \endvar
3828  */
3829                 { LFUN_SPELLING_CONTINUOUSLY, "spelling-continuously", ReadOnly, Edit },
3830
3831
3832 /*!
3833  * \var lyx::FuncCode lyx::LFUN_SPELLING_IGNORE
3834  * \li Action: Let the spell checker ignore the word under the cursor
3835  *             in the current session for the given language.
3836  *             The default for the language is retrieved from the cursor position.
3837  * \li Syntax: spelling-ignore [<WORD>] [<LANG>]
3838  * \li Params: <WORD>: word to ignore
3839                <LANG>: language name (see file languages)
3840  * \li Origin: spitz, 18 Jan 2010
3841  * \endvar
3842  */
3843                 { LFUN_SPELLING_IGNORE, "spelling-ignore", ReadOnly, Edit },
3844
3845 /*!
3846  * \var lyx::FuncCode lyx::LFUN_SPELLING_REMOVE
3847  * \li Action: Remove the word under the cursor from the respective
3848  *             spell checker dictionary.
3849  *             The default for the language is retrieved from the cursor position.
3850  * \li Syntax: spelling-remove [<STRING>] [<LANG>]
3851  * \li Params: <WORD>: word to remove
3852  *             <LANG>: language name (see file languages)
3853  * \li Origin: SWitt, 28 July 2010
3854  * \endvar
3855  */
3856                 { LFUN_SPELLING_REMOVE, "spelling-remove", ReadOnly, Edit },
3857
3858
3859 /*!
3860  * \var lyx::FuncCode lyx::LFUN_STATISTICS
3861  * \li Action: Count the statistics (number of words and characters)
3862                in the document or in the given selection and display it
3863                in a dialog box.
3864  * \li Notion: Note that this function gives the number of words/chars written,
3865                not the number of characters which will be typeset.
3866  * \li Syntax: statistics
3867  * \li Origin: lasgouttes, Jan 27 2004; sanda, Jan 8 2008
3868  * \endvar
3869  */
3870                 { LFUN_STATISTICS, "statistics", ReadOnly, System },
3871
3872 /*!
3873  * \var lyx::FuncCode lyx::LFUN_TABULAR_FEATURE
3874  * \li Action: Modify properties of tabulars and table-like math environments.
3875  * \li Syntax: tabular-feature <FEATURE> [<ARG>]
3876  * \li Params: Generally see #LFUN_INSET_INSERT for further details.\n
3877  *             <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|\n
3878                        copy-column|move-column-right|move-column-left|move-row-down|move-row-up|\n
3879                        set-line-top|set-line-bottom|set-line-left|set-line-right|\n
3880                        toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|\n
3881                        set-ltrim-top|set-rtrim-top|set-ltrim-bottom|set-rtrim-bottom\n
3882                        toggle-ltrim-top|toggle-rtrim-top|toggle-ltrim-bottom|toggle-rtrim-bottom\n
3883                        align-left|align-right|align-center|align-block|align-decimal|set-decimal-point|\n
3884                        valign-top|valign-bottom|valign-middle|longtabular-align-left|\n
3885                        longtabular-align-center|longtabular-align-right|m-align-left|m-align-right|\n
3886                        m-align-center|m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|\n
3887                        reset-formal-default|set-all-lines|unset-all-lines|toggle-longtabular|\n
3888                        set-longtabular|unset-longtabular|set-pwidth|\n
3889                        set-mpwidth|set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|\n
3890                        set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|\n
3891                        unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|\n
3892                        set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|\n
3893                        set-special-column|set-special-multicolumn|set-special-multirow|\n
3894                        toggle-booktabs|set-booktabs|unset-booktabs|set-top-space|set-bottom-space|\n
3895                        set-interline-space|set-border-lines|tabular-valign-top|\n
3896                        tabular-valign-middle|tabular-valign-bottom|set-tabular-width|\n
3897                        toggle-varwidth-column
3898                Various math-environment features are handled as well, e.g. add-vline-left/right for\n
3899                the Grid/Array environment.\n
3900                <ARG>: additional argument for some commands, use debug mode to explore its values.
3901  * \li Origin: gm, 10 Dec 2015
3902  * \endvar
3903  */
3904                 { LFUN_TABULAR_FEATURE, "tabular-feature", Noop, Edit },
3905
3906 /*!
3907  * \var lyx::FuncCode lyx::LFUN_TABULAR_INSERT
3908  * \li Action: Inserts table into the document.
3909  * \li Notion: See #LFUN_TABULAR_FEATURE for some more details
3910                about tabular modifications.
3911  * \li Syntax: tabular-insert [<ROWS> <COLUMNS>]
3912  * \li Params: In case no arguments are given show insert dialog.
3913  * \li Origin: Jug, 12 Apr 2000
3914  * \endvar
3915  */
3916                 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
3917
3918 /*!
3919  * \var lyx::FuncCode lyx::LFUN_TABULAR_STYLE_INSERT
3920  * \li Action: Inserts table of a given style into the document.
3921  * \li Notion: See #LFUN_TABULAR_FEATURE for some more details
3922                about tabular modifications.
3923  * \li Syntax: tabular-style-insert <style> <ROWS> <COLUMNS>
3924  * \li Params: Valid styles are the names of the files in lib/tabletemplates,
3925  *             minus _1x<n> and .lyx suffix.
3926  * \li Origin: spitz, 25 Mar 2019
3927  * \endvar
3928  */
3929                 { LFUN_TABULAR_STYLE_INSERT, "tabular-style-insert", Noop, Edit },
3930
3931 /*!
3932  * \var lyx::FuncCode lyx::LFUN_TAB_DELETE
3933  * \li Action: Delete a tab or up to an equivalent amount of spaces from
3934                a listings inset.
3935  * \li Notion: It also works on a selection - it removes a tab or spaces from the
3936                beginning of each line spanned by the selection. This is useful if
3937                you want to indent/unindent multiple lines in one action.
3938  * \li Syntax: tab-delete
3939  * \li Origin: vfr, Sep 30 2008
3940  * \endvar
3941  */
3942                 { LFUN_TAB_DELETE, "tab-delete", SingleParUpdate, Edit },
3943
3944 /*!
3945  * \var lyx::FuncCode lyx::LFUN_TAB_GROUP_CLOSE
3946  * \li Action: Close the current tab group.
3947  * \li Notion: This only closes the work areas, not the buffers themselves.
3948                The still opened buffers can be visualized in another tab group.
3949  * \li Syntax: tab-group-close
3950  * \li Origin: Abdel, 21 Feb 2008
3951  * \endvar
3952  */
3953                 { LFUN_TAB_GROUP_CLOSE, "tab-group-close", ReadOnly, Buffer },
3954
3955
3956 /*!
3957  * \var lyx::FuncCode lyx::LFUN_TAB_INSERT
3958  * \li Action: Insert a tab into a listings inset.
3959  * \li Notion: It also works on a selection.
3960  * \li Syntax: tab-insert
3961  * \li Origin: vfr, Sep 30 2008
3962  * \endvar
3963  */
3964                 { LFUN_TAB_INSERT, "tab-insert", SingleParUpdate, Edit },
3965
3966 /*!
3967  * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
3968  * \li Action: Sets the text class for the current buffer.
3969  * \li Syntax: textclass-apply <TEXTCLASS>
3970  * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
3971                    the filename, minus the ".layout" extension.
3972  * \endvar
3973  */
3974                 { LFUN_TEXTCLASS_APPLY, "textclass-apply", NoInternal, Layout },
3975
3976 /*!
3977  * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
3978  * \li Action: Loads information for a textclass from disk.
3979  * \li Syntax: textclass-load <TEXTCLASS>
3980  * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
3981                    the filename, minus the ".layout" extension.
3982  * \endvar
3983  */
3984                 { LFUN_TEXTCLASS_LOAD, "textclass-load", NoInternal, Layout },
3985
3986
3987 /*!
3988  * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_APPLY
3989  * \li Action: Apply last used text properties.
3990  * \li Syntax: textstyle-apply [<NUM>]
3991  * \li Params: <NUM>: number of the selection in the internal freefonts stack to be applied.
3992  * \li Notion: These properties are stored via #LFUN_TEXTSTYLE_UPDATE, which is
3993                automatically triggered when using Text Style dialog.
3994  * \li Syntax: textstyle-apply
3995  * \li Origin: leeming, 12 Mar 2003
3996  * \endvar
3997  */
3998                 { LFUN_TEXTSTYLE_APPLY, "textstyle-apply", Noop, Layout },
3999
4000 /*!
4001  * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_UPDATE
4002  * \li Action: Apply text style and update the settings to be used by #LFUN_TEXTSTYLE_APPLY.
4003  * \li Syntax: textstyle-update <FONT_INFO>
4004  * \li Params: <FONT_INFO>: specifies font attributes, e.g. family, series, shape,
4005                             size, emph, noun, underbar, number, color, language,
4006                             toggleall.\n
4007                             Use lyx -dbg action for exact syntax of text-style
4008                             dialog parameters.
4009  * \li Origin: leeming, 12 Mar 2003
4010  * \endvar
4011  */
4012                 { LFUN_TEXTSTYLE_UPDATE, "textstyle-update", Noop, Layout },
4013
4014 /*!
4015  * \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
4016  * \li Action: Look up thesaurus entries with respect to the word under the cursor.
4017  * \li Syntax: thesaurus-entry [<STRING>] [lang=<LANG>]
4018  * \li Params: <STRING>: word to look up
4019                <LANG>: language (see file languages)
4020  * \li Origin: Levon, 20 Jul 2001
4021  * \endvar
4022  */
4023                 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
4024
4025 /*!
4026  * \var lyx::FuncCode lyx::LFUN_TOOLBAR_MOVABLE
4027  * \li Action: Toggles movability of a given toolbar between true/false.
4028  * \li Syntax: toolbar-movable <NAME>
4029  * \li Params: <NAME>: *|standard|extra|table|math|mathmacrotemplate|
4030                         minibuffer|review|view/update|math_panels|vcs|
4031                         view-others|update-others
4032 * \li Origin: daniel, 12 July 2016
4033 * \endvar
4034 */
4035                 { LFUN_TOOLBAR_MOVABLE, "toolbar-movable", NoBuffer, Buffer },
4036
4037 /*!
4038  * \var lyx::FuncCode lyx::LFUN_TOOLBAR_SET
4039  * \li Action: Sets visibility of a given toolbar to on, off, or auto.
4040  * \li Notion: Skipping "auto" when allowauto is false.
4041  * \li Syntax: toolbar-set <NAME> [on|off|auto]
4042  * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|\n
4043                        minibuffer|review|view/update|math_panels|vcs|
4044                        view-others|update-others
4045  * \li Origin: spitz, 17 Dec 2020
4046  * \endvar
4047  */
4048                 { LFUN_TOOLBAR_SET, "toolbar-set", NoBuffer, Buffer },
4049
4050 /*!
4051  * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
4052  * \li Action: Toggles visibility of a given toolbar between on/off/auto.
4053  * \li Notion: Skipping "auto" when allowauto is false.
4054  * \li Syntax: toolbar-toggle <NAME> [allowauto]
4055  * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|\n
4056                        minibuffer|review|view/update|math_panels|vcs|
4057                        view-others|update-others
4058  * \li Origin: Edwin, 21 May 2007
4059  * \endvar
4060  */
4061                 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
4062
4063 /*!
4064  * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
4065  * \li Action: Various UI visibility-toggling actions.
4066  * \li Syntax: ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
4067  * \li Params: statusbar  : Toggle visibility of the statusbar.\n
4068                menubar    : Toggle visibility of the menubar.\n
4069                scrollbar  : Toggle visibility of the scrollbar.\n
4070                frame      : Toggle visibility of the frames around editing window.\n
4071                fullscreen : Toggle fullscreen mode. This also covers calling the
4072                             previous functions. However #LFUN_TOOLBAR_TOGGLE for the
4073                             custom tweaks of the toolbars should be used.
4074  * \li Origin: sanda, 9 Feb 2007
4075  * \endvar
4076  */
4077                 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
4078
4079
4080 /*!
4081  * \var lyx::FuncCode lyx::LFUN_UNDO
4082  * \li Action: Undoes the last edit.
4083  * \li Syntax: undo
4084  * \endvar
4085  */
4086                 { LFUN_UNDO, "undo", ReadOnly, Edit },
4087
4088 /*!
4089  * \var lyx::FuncCode lyx::LFUN_UNICODE_INSERT
4090  * \li Action: Inserts a single unicode character.
4091  * \li Syntax: unicode-insert <CHAR1> <CHAR2> ...
4092  * \li Params: <CHARn>: The character to insert, given as its code
4093                        point, in hexadecimal.
4094  * \li Sample: unicode-insert 0x0100 0x0259
4095  * \li Origin: Lgb, 22 Oct 2006
4096  * \endvar
4097  */
4098                 { LFUN_UNICODE_INSERT, "unicode-insert", Noop, Edit },
4099
4100 /*!
4101  * \var lyx::FuncCode lyx::LFUN_UP
4102  * \li Action: Moves the cursor one line in upward direction.
4103  * \li Syntax: up
4104  * \endvar
4105  */
4106                 { LFUN_UP, "up", ReadOnly | NoUpdate, Edit },
4107
4108 /*!
4109  * \var lyx::FuncCode lyx::LFUN_UP_SELECT
4110  * \li Action: Moves the cursor one line in upward direction adding the current
4111                position to the selection.
4112  * \li Syntax: up-select
4113  * \endvar
4114  */
4115                 { LFUN_UP_SELECT, "up-select", ReadOnly | SingleParUpdate, Edit },
4116
4117 /*!
4118  * \var lyx::FuncCode lyx::LFUN_VC_CHECK_IN
4119  * \li Action: Checks-in/commits the changes of the registered file to the repository.
4120  * \li Notion: In RCS case this also unlocks the file.
4121  * \li Syntax: vc-check-in
4122  * \li Origin: Lgb, 1 Jul 1997
4123  * \endvar
4124  */
4125                 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
4126
4127 /*!
4128  * \var lyx::FuncCode lyx::LFUN_VC_CHECK_OUT
4129  * \li Action: Checks-out the document for edit (and locks it in some cases).
4130  * \li Syntax: vc-check-out
4131  * \li Origin: Lgb, 1 Jul 1997
4132  * \endvar
4133  */
4134                 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
4135
4136 /*!
4137  * \var lyx::FuncCode lyx::LFUN_VC_COMMAND
4138  * \li Action: Executes external command. This command is intended to support
4139                additional VCS commands.
4140  * \li Syntax: vc-command <FLAG> <PATH> <COMMAND>
4141  * \li Params:  <FLAG>: Flags for the command can be combined together.\n
4142                         U - dUmmy - no flags \n
4143                         D - Doc - need document loaded to proceed \n
4144                         I - dIrty - mark document dirty \n
4145                         R - Reload - ensure that the document is saved and reload it after command execution \n
4146                         M - Message - ask for input string (commit message)\n
4147                 <PATH>: path where to start. $$p will be replaced by the current document path.\n
4148                 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current
4149                            document(with absolute path)/path/message.
4150  * \li Sample: vc-command DR $$p "svn up"
4151  * \li Origin: sanda, 13 Jan 2009
4152  * \endvar
4153  */
4154                 { LFUN_VC_COMMAND, "vc-command", NoBuffer | ReadOnly, System },
4155
4156 /*!
4157  * \var lyx::FuncCode lyx::LFUN_VC_COMPARE
4158  * \li Action: Compares two revisions of the same file under version control.
4159  * \li Syntax: vc-compare [<REV1>] [<REV2>]
4160  * \li Params: Revision number either points directly to commit in history
4161                or if negative number -x it points to (last commit - x).\n
4162                In RCS we subtract only in the last number of revision specification.
4163                Special case "0" is reserved for the last committed revision.\n
4164                <REV1>: Older file.\n
4165                <REV2>: Newer file. Used only if REV1 > 0.\n
4166                If no parameter is given, interactive dialog will be shown.
4167  * \li Sample: Compare current document against last commit\n
4168                vc-compare 0\n
4169                Compare current document against current revision - 5 commits\n
4170                vc-compare -5\n
4171                Compare revisions 120 and 155\n
4172                vc-compare 120 155
4173  * \li Origin: sanda, 12 Feb 2010
4174  * \endvar
4175  */
4176                 { LFUN_VC_COMPARE, "vc-compare", ReadOnly, System },
4177
4178
4179 /*!
4180  * \var lyx::FuncCode lyx::LFUN_VC_COPY
4181  * \li Action: Copies the document to another name.
4182  * \li Notion: Copying with revision history is only supported by SVN.
4183                For RCS and CVS it is simulated by adding the document
4184                under a new name.
4185                Disabled if uncommitted changes exist.
4186  * \li Syntax: vc-copy <FILENAME>
4187  * \li Params: <FILENAME>: New name of the document.\n
4188  *             A file dialog is opened if no filename is given.
4189  * \li Origin: gb, 05 Feb 2013
4190  * \endvar
4191  */
4192                 { LFUN_VC_COPY, "vc-copy", ReadOnly, System },
4193
4194 /*!
4195  * \var lyx::FuncCode lyx::LFUN_VC_LOCKING_TOGGLE
4196  * \li Action: Toggles the locking property of the edited file.
4197  * \li Notion: This is currently implemented only for SVN.
4198  * \li Syntax: vc-locking-toggle
4199  * \li Origin: sanda, 25 Jun 2009
4200  * \endvar
4201  */
4202                 { LFUN_VC_LOCKING_TOGGLE, "vc-locking-toggle", ReadOnly, System },
4203
4204 /*!
4205  * \var lyx::FuncCode lyx::LFUN_VC_REGISTER
4206  * \li Action: Register the document as an file inside version control system.
4207  * \li Notion: File is registered inside cvs, svn or rcs repository acording to the existence
4208                of cvs/svn/rcs entries in the document's directory. \n
4209                See LyX Additional Features Manual (Version Control Chapter) for additional
4210                information.
4211  * \li Syntax: vc-register
4212  * \li Origin: Lgb, 1 Jul 1997
4213  * \endvar
4214  */
4215                 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
4216
4217 /*!
4218  * \var lyx::FuncCode lyx::LFUN_VC_RENAME
4219  * \li Action: Renames the document to another name.
4220  * \li Notion: Renaming with revision history is only supported by SVN.
4221                For CVS it is simulated by adding the document under a new
4222                name and deleting the old one. For RCS it is not supported.
4223                Disabled if uncommitted changes exist.
4224  * \li Syntax: vc-rename <FILENAME>
4225  * \li Params: <FILENAME>: New name of the document.\n
4226  *             A file dialog is opened if no filename is given.
4227  * \li Origin: gb, 05 Feb 2013
4228  * \endvar
4229  */
4230                 { LFUN_VC_RENAME, "vc-rename", ReadOnly, System },
4231
4232 /*!
4233  * \var lyx::FuncCode lyx::LFUN_VC_REPO_UPDATE
4234  * \li Action: Update the local archive directory in which resides
4235                the current document with the remote repository.
4236  * \li Syntax: vc-repo-update
4237  * \li Origin: sanda, 16 Oct 2009
4238  * \endvar
4239  */
4240                 { LFUN_VC_REPO_UPDATE, "vc-repo-update", ReadOnly, System },
4241
4242 /*!
4243  * \var lyx::FuncCode lyx::LFUN_VC_REVERT
4244  * \li Action: Reverts the document to the last check-in/commit in VCS.
4245  * \li Syntax: vc-revert
4246  * \li Origin: Lgb, 1 Jul 1997
4247  * \endvar
4248  */
4249                 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
4250
4251 /*!
4252  * \var lyx::FuncCode lyx::LFUN_VC_UNDO_LAST
4253  * \li Action: Undo last check-in.
4254  * \li Notion: This is currently implemented only for RCS.
4255  * \li Syntax: vc-check-out
4256  * \li Origin: Lgb, 1 Jul 1997
4257  * \endvar
4258  */
4259                 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
4260
4261 /*!
4262  * \var lyx::FuncCode lyx::LFUN_VIEW_CLOSE
4263  * \li Action: Close the current document work area.
4264  * \li Notion: Close the current work area. If no other work areas are showing the buffer,
4265                then close the associated buffer as well.
4266  * \li Syntax: view-close
4267  * \li Origin: Tommaso, 15 Sep 2012
4268  * \endvar
4269  */
4270                 { LFUN_VIEW_CLOSE, "view-close", ReadOnly, Buffer },
4271
4272
4273 /*!
4274  * \var lyx::FuncCode lyx::LFUN_VIEW_SPLIT
4275  * \li Action: Creates another split view of current buffer.
4276  * \li Notion: All split views act in the same way independently.
4277  * \li Syntax: view-split <vertical|horizontal>
4278  * \li Params: horizontal : The work areas are laid out side by side.\n
4279                vertical   : The work areas laid out vertically.
4280  * \li Origin: Abdel, 20 Feb 2008
4281  * \endvar
4282  */
4283                 { LFUN_VIEW_SPLIT, "view-split", ReadOnly, Buffer },
4284
4285
4286 /*!
4287  * \var lyx::FuncCode lyx::LFUN_WINDOW_CLOSE
4288  * \li Action: Closes the current LyX window.
4289  * \li Syntax: window-close
4290  * \li Origin: Abdel, 23 Oct 2006
4291  * \endvar
4292  */
4293                 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
4294
4295
4296 /*!
4297  * \var lyx::FuncCode lyx::LFUN_WINDOW_NEW
4298  * \li Action: Creates new empty LyX window.
4299  * \li Notion: Already opened documents from the previous window can be found under View menu.
4300  * \li Syntax: window-new [<GEOMETRY>]
4301  * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently
4302                            accepted only on Windows platform.
4303  * \li Origin: Abdel, 21 Oct 2006
4304  * \endvar
4305  */
4306                 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
4307
4308 /*!
4309  * \var lyx::FuncCode lyx::LFUN_WINDOW_RAISE
4310  * \li Action: Raises the LyX window.
4311  * \li Notion: Brings the LyX window to the front. Such behavior is allowed
4312                on Windows only when no other application has focus.
4313                This action is used when LyX is in single instance mode.
4314  * \li Syntax: window-raise
4315  * \li Origin: forenr, 21 Apr 2020
4316  * \endvar
4317  */
4318                 { LFUN_WINDOW_RAISE, "window-raise", ReadOnly | NoBuffer, Hidden },
4319
4320 /*!
4321  * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD
4322  * \li Action: Moves the cursor to the logically previous beginning of a word.
4323  * \li Notion: This is not the action which should be bound to the arrow keys,
4324                because backwards may be left or right, depending on the
4325                language. The arrow keys should be bound to #LFUN_WORD_LEFT or
4326                #LFUN_WORD_RIGHT actions, which in turn may employ this one.
4327  * \li Syntax: word-backward
4328  * \endvar
4329  */
4330                 { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit },
4331
4332 /*!
4333  * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD_SELECT
4334  * \li Action: Moves the cursor to the logically previous beginning of a word,
4335                adding the logically traversed text to the selection.
4336  * \li Notion: See also #LFUN_WORD_BACKWARD.
4337  * \li Syntax: word-backward-select
4338  * \endvar
4339  */
4340                 { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
4341
4342 /*!
4343  * \var lyx::FuncCode lyx::LFUN_WORD_CAPITALIZE
4344  * \li Action: Capitalizes the words in the selection (i.e. the first letters)
4345                or the first letter of word at cursor position.
4346  * \li Syntax: word-capitalize [<SEL_TYPE>]
4347  * \li Params: <SEL_TYPE>: if this is equal to "partial", then the
4348  *             default word starts at cursor position (emacs-style).
4349  *             Otherwise, the whole word is considered.
4350  * \endvar
4351  */
4352                 { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
4353
4354 /*!
4355  * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_BACKWARD
4356  * \li Action: Deletes characters to the beginning of the word (usually the "C+BackSpace" key).
4357  * \li Syntax: word-delete-backward [force]
4358  * \li Params: force: Delete big insets, do not only select them.
4359  * \endvar
4360  */
4361                 { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
4362
4363 /*!
4364  * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_FORWARD
4365  * \li Action: Deletes characters to the end of the word (usually the "C+Delete" key).
4366  * \li Syntax: word-delete-forward [force]
4367  * \li Params: force: Delete big insets, do not only select them.
4368  * \endvar
4369  */
4370                 { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
4371
4372 /*!
4373  * \var lyx::FuncCode lyx::LFUN_WORD_FIND
4374  * \li Action: Search for next occurrence of a string.
4375  * \li Syntax: word-find [<DATA>]
4376  * \li Params: <DATA>: data encoded from Find dialog (see #lyx::find2string()).
4377                        If no parameter is given, search with last find-dialog
4378                        data is used for search (i.e. find-next).
4379  * \li Origin: Andre, Jan 7 2004
4380  * \endvar
4381  */
4382                 { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
4383
4384 /*! 
4385  * \var lyx::FuncCode lyx::LFUN_SEARCH_STRING_SET
4386  * \li Action: Set search string buffer.
4387  * \li Syntax: search-string-set [<DATA>] 
4388  * \li Params: <DATA>: string to search for. If no parameter is given,
4389  *                     use (word under) selection.
4390  * \li Origin: stwitt, spitz, Feb 12 2021 
4391  * \endvar 
4392  */ 
4393                 { LFUN_SEARCH_STRING_SET, "search-string-set", ReadOnly, Edit }, 
4394
4395 /*!
4396  * \var lyx::FuncCode lyx::LFUN_WORD_FINDADV
4397  * \li Action: Search for next occurrence of a pattern.
4398  * \li Syntax: word-findadv [<DATA>]
4399  * \li Params: <DATA>: data encoded from FindAdv dialog (see #lyx::findadv2string()).
4400                        If no parameter is given, search with last find-dialog
4401                        data is used for search (i.e. find-next).
4402  * \li Origin: Tommaso, Nov 15 2007
4403  * \endvar
4404  */
4405                 { LFUN_WORD_FINDADV, "word-findadv", ReadOnly | NoBuffer, Edit },
4406
4407 /*!
4408  * \var lyx::FuncCode lyx::LFUN_WORD_FIND_BACKWARD
4409  * \li Action: Search for a given string in backward direction.
4410  * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
4411  * \li Syntax: word-find-backward [<STRING>]
4412  * \li Origin: Etienne, 20 Feb 1998
4413  * \endvar
4414  */
4415                 { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
4416
4417 /*!
4418  * \var lyx::FuncCode lyx::LFUN_WORD_FIND_FORWARD
4419  * \li Action: Search for a given string in forward direction.
4420  * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
4421  * \li Syntax: word-find-forward [<STRING>]
4422  * \li Origin: Etienne, 16 Feb 1998
4423  * \endvar
4424  */
4425                 { LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit },
4426
4427 /*!
4428  * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD
4429  * \li Action: Moves the cursor to the logically next beginning of a word.
4430  * \li Notion: This is not the action which should be bound to the arrow keys,
4431                because forward may be left or right, depending on the language.
4432                The arrow keys should be bound to #LFUN_WORD_LEFT or
4433                #LFUN_WORD_RIGHT actions, which in turn may employ this one.
4434  * \li Syntax: word-forward
4435  * \endvar
4436  */
4437                 { LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
4438
4439 /*!
4440  * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD_SELECT
4441  * \li Action: Moves the cursor to the logically next beginning of a word,
4442                adding the logically traversed text to the selection.
4443  * \li Notion: See also #LFUN_WORD_FORWARD.
4444  * \li Syntax: word-forward-select
4445  * \endvar
4446  */
4447                 { LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
4448
4449 /*!
4450  * \var lyx::FuncCode lyx::LFUN_WORD_LEFT
4451  * \li Action: Moves the cursor to the next beginning of a word "on the left".
4452  * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
4453                "left" key is pressed. Generally, it moves the cursor to the
4454                next beginning of a word on the left. However, in Bidi text this
4455                become slightly more complicated, and there are different modes
4456                of cursor movement. In "visual mode", this moves left, plain and
4457                simple. In "logical mode", movement is logically forward in RTL
4458                paragraphs, and logically backwards in LTR paragraphs.
4459  * \li Syntax: word-left
4460  * \li Origin: dov, 28 Oct 2007
4461  * \endvar
4462  */
4463                 { LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
4464
4465 /*!
4466  * \var lyx::FuncCode lyx::LFUN_WORD_LEFT_SELECT
4467  * \li Action: Moves the cursor to the next beginning of a word "on the left",
4468                adding *logically* traversed text to the selection.
4469  * \li Notion: See also #LFUN_WORD_LEFT for exact details of the movement.
4470  * \li Syntax: word-left-select
4471  * \li Origin: dov, 28 Oct 2007
4472  * \endvar
4473  */
4474                 { LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit },
4475
4476 /*!
4477  * \var lyx::FuncCode lyx::LFUN_WORD_LOWCASE
4478  * \li Action: Change the words in the selection or word at cursor position
4479                to lower case.
4480  * \li Syntax: word-lowcase [<SEL_TYPE>]
4481  * \li Params: <SEL_TYPE>: if this is equal to "partial", then the
4482  *             default word starts at cursor position (emacs-style).
4483  *             Otherwise, the whole word is considered.
4484  * \endvar
4485  */
4486                 { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
4487
4488 /*!
4489  * \var lyx::FuncCode lyx::LFUN_WORD_REPLACE
4490  * \li Action: Replace a string in the document.
4491  * \li Syntax: word-replace [<DATA>]
4492  * \li Params: <DATA>: data is of the form
4493                        "<replacestring> \n
4494                         <searchstring> \n
4495                         <casesensitive> <matchword> <all> <forward> <findnext>"
4496  * \li Origin: Andre, Jan 7 2004
4497  * \endvar
4498  */
4499                 { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
4500
4501 /*!
4502  * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT
4503  * \li Action: Moves the cursor to the next beginning of a word "on the right".
4504  * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
4505                "right" key is pressed. Generally, it moves the cursor to the
4506                next beginning of a word on the right. However, in Bidi text
4507                this become slightly more complicated, and there are different
4508                modes of cursor movement. In "visual mode", this moves right,
4509                plain and simple. In "logical mode", movement is logically
4510                forward in LTR paragraphs, and logically backwards in RTL
4511                paragraphs.
4512  * \li Syntax: word-right
4513  * \li Origin: dov, 28 Oct 2007
4514  * \endvar
4515  */
4516                 { LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit },
4517
4518 /*!
4519  * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT_SELECT
4520  * \li Action: Moves the cursor to the next beginning of a word "on the right",
4521                adding *logically* traversed text to the selection.
4522  * \li Notion: See also #LFUN_WORD_RIGHT for exact details of the movement.
4523  * \li Syntax: word-right-select
4524  * \li Origin: dov, 28 Oct 2007
4525  * \endvar
4526  */
4527                 { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
4528
4529 /*!
4530  * \var lyx::FuncCode lyx::LFUN_WORD_SELECT
4531  * \li Action: Puts the word where the cursor stands into the selection.
4532  * \li Syntax: word-select
4533  * \li Origin: Andre, 11 Sep 2002
4534  * \endvar
4535  */
4536                 { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
4537
4538 /*!
4539  * \var lyx::FuncCode lyx::LFUN_WORD_UPCASE
4540  * \li Action: Change the words in the selection or word at cursor position
4541                to upper case.
4542  * \li Syntax: word-upcase [<SEL_TYPE>]
4543  * \li Params: <SEL_TYPE>: if this is equal to "partial", then the
4544  *             default word starts at cursor position (emacs-style).
4545  *             Otherwise, the whole word is considered.
4546  * \endvar
4547  */
4548                 { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
4549
4550 /*!
4551  * \var lyx::FuncCode lyx::LFUN_WRAP_INSERT
4552  * \li Action: Inserts floats wrapped by the text around.
4553  * \li Syntax: wrap-insert <TYPE>
4554  * \li Params: <TYPE>: table|figure
4555  * \li Origin: Dekel, 7 Apr 2002
4556  * \endvar
4557  */
4558                 { LFUN_WRAP_INSERT, "wrap-insert", Noop, Edit },
4559
4560                 { LFUN_NOACTION, "", Noop, Hidden }
4561 #ifndef DOXYGEN_SHOULD_SKIP_THIS
4562         };
4563
4564         for (int i = 0; items[i].action != LFUN_NOACTION; ++i)
4565                 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
4566
4567         init = true;
4568 }
4569 #endif
4570
4571 LyXAction::LyXAction()
4572 {
4573         init();
4574 }
4575
4576
4577 FuncRequest LyXAction::lookupFunc(string const & func_name) const
4578 {
4579         string const func2 = trim(func_name);
4580
4581         if (func2.empty())
4582                 return FuncRequest(LFUN_NOACTION);
4583
4584         string cmd;
4585         string const arg = split(func2, cmd, ' ');
4586
4587         FuncMap::const_iterator const fit = lyx_func_map.find(cmd);
4588
4589         return fit != lyx_func_map.end()
4590                         ? FuncRequest(fit->second, arg)
4591                         : FuncRequest(LFUN_UNKNOWN_ACTION);
4592 }
4593
4594
4595 string const LyXAction::getActionName(FuncCode action) const
4596 {
4597         InfoMap::const_iterator const it = lyx_info_map.find(action);
4598         return it != lyx_info_map.end() ? it->second.name : string();
4599 }
4600
4601
4602 LyXAction::FuncType LyXAction::getActionType(FuncCode action) const
4603 {
4604         InfoMap::const_iterator const it = lyx_info_map.find(action);
4605         return it != lyx_info_map.end() ? it->second.type : Hidden;
4606 }
4607
4608
4609 bool LyXAction::funcHasFlag(FuncCode action,
4610                             LyXAction::FuncAttribs flag) const
4611 {
4612         InfoMap::const_iterator ici = lyx_info_map.find(action);
4613
4614         if (ici == lyx_info_map.end()) {
4615                 LYXERR0("action: " << action << " is not known.");
4616                 LASSERT(false, return false);
4617         }
4618
4619         return ici->second.attrib & flag;
4620 }
4621
4622
4623 LyXAction::const_iterator LyXAction::begin() const
4624 {
4625         return lyx_func_map.begin();
4626 }
4627
4628
4629 LyXAction::const_iterator LyXAction::end() const
4630 {
4631         return lyx_func_map.end();
4632 }
4633
4634
4635 LyXErr & operator<<(LyXErr & l, FuncCode code)
4636 {
4637         if (l.enabled())
4638                 l.stream() << lyxaction.getActionName(code);
4639         return l;
4640 }
4641
4642 } // namespace lyx