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