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