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