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