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