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