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