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