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