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