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