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