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