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