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