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