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