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