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