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