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