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