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