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