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