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