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