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