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