]> git.lyx.org Git - lyx.git/blob - src/LyXAction.cpp
Support revision fetching also for RCS.
[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 Syntax: tabular-insert [<ROWS> <COLUMNS>]
2053  * \li Params: In case no arguments are given show insert dialog.
2054  * \li Origin: Jug, 12 Apr 2000
2055  * \endvar
2056  */
2057                 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
2058 /*!
2059  * \var lyx::FuncCode lyx::LFUN_TABULAR_FEATURE
2060  * \li Action: Sets various features to the table/cell on the current cursor position.
2061  * \li Notion: Various math-environment features are handled here as well, e.g.
2062                add-vline-left/right for the Grid/Array environment
2063  * \li Syntax: tabular-feature <FEATURE> [<ARG>]
2064  * \li Params: <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|copy-column|
2065                        toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
2066                        align-left|align-right|align-center|align-block|valign-top|valign-bottom|
2067                        valign-middle|longtabular-align-left|longtabular-align-center|
2068                        longtabular-align-right|m-align-left|m-align-right|m-align-center|
2069                        m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|set-all-lines|
2070                        unset-all-lines|set-longtabular|unset-longtabular|set-pwidth|set-mpwidth|
2071                        set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|
2072                        set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|
2073                        unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|
2074                        set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
2075                        set-special-column|set-special-multicolumn|set-special-multirow|
2076                        set-booktabs|unset-booktabs|set-top-space|set-bottom-space|
2077                        set-interline-space|set-border-lines|tabular-valign-top|
2078                        tabular-valign-middle|tabular-valign-bottom \n
2079                <ARG>: additional argument for some commands, use debug mode to explore its values.
2080  * \li Origin: Jug, 28 Jul 2000
2081  * \endvar
2082  */
2083                 { LFUN_TABULAR_FEATURE, "tabular-feature", Noop, Edit },
2084 /*!
2085  * \var lyx::FuncCode lyx::LFUN_CELL_BACKWARD
2086  * \li Action: Moves the cursor to the previous cell inside the table.
2087  * \li Syntax: cell-backward
2088  * \li Origin: Jug, 22 May 2000
2089  * \endvar
2090  */
2091                 { LFUN_CELL_BACKWARD, "cell-backward", Noop, Edit },
2092 /*!
2093  * \var lyx::FuncCode lyx::LFUN_CELL_FORWARD
2094  * \li Action: Moves the cursor to the next cell inside the table.
2095  * \li Syntax: cell-forward
2096  * \endvar
2097  */
2098                 { LFUN_CELL_FORWARD, "cell-forward", Noop, Edit },
2099 /*!
2100  * \var lyx::FuncCode lyx::LFUN_CELL_SPLIT
2101  * \li Action: Splits cell and shifts right part to the next cell (inside the math grid).
2102  * \li Syntax: cell-split
2103  * \li Origin: Ale, 15 May 1997
2104  * \endvar
2105  */
2106                 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
2107
2108 /*!
2109  * \var lyx::FuncCode lyx::LFUN_VC_REGISTER
2110  * \li Action: Register the document as an file inside version control system (RCS, CVS).
2111  * \li Notion: File is registered inside cvs, svn or rcs repository acording to the existence
2112                of cvs/svn/rcs entries in the document's directory. \n
2113                See LyX Additional Features Manual (Version Control Chapter) for additional
2114                information.
2115  * \li Syntax: vc-register
2116  * \li Origin: Lgb, 1 Jul 1997
2117  * \endvar
2118  */
2119                 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
2120 /*!
2121  * \var lyx::FuncCode lyx::LFUN_VC_CHECK_IN
2122  * \li Action: Checks-in/commits the changes of the registered file to the repository.
2123  * \li Notion: In RCS case this also unlocks the file.
2124  * \li Syntax: vc-check-in
2125  * \li Origin: Lgb, 1 Jul 1997
2126  * \endvar
2127  */
2128                 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
2129 /*!
2130  * \var lyx::FuncCode lyx::LFUN_VC_CHECK_OUT
2131  * \li Action: Checks-out the document for edit (and locks it for RCS).
2132  * \li Notion: This is implemented only for RCS and SVN, not CVS.
2133  * \li Syntax: vc-check-out
2134  * \li Origin: Lgb, 1 Jul 1997
2135  * \endvar
2136  */
2137                 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
2138 /*!
2139  * \var lyx::FuncCode lyx::LFUN_VC_REVERT
2140  * \li Action: Reverts the document to the last check-in/commit in VCS.
2141  * \li Syntax: vc-revert
2142  * \li Origin: Lgb, 1 Jul 1997
2143  * \endvar
2144  */
2145                 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
2146 /*!
2147  * \var lyx::FuncCode lyx::LFUN_VC_UNDO_LAST
2148  * \li Action: Undo last check-in.
2149  * \li Notion: This is currently implemented only for RCS.
2150  * \li Syntax: vc-check-out
2151  * \li Origin: Lgb, 1 Jul 1997
2152  * \endvar
2153  */
2154                 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
2155 /*!
2156  * \var lyx::FuncCode lyx::LFUN_VC_COMMAND
2157  * \li Action: Executes external command. This command is intended to support
2158                additional VCS commands.
2159  * \li Syntax: vc-command <FLAG> <PATH> <COMMAND>
2160  * \li Params:  <FLAG>: Flags for the command can be combined together.\n
2161                         U - dUmmy - no flags \n
2162                         D - Doc - need document loaded to proceed \n
2163                         I - dIrty - mark document dirty \n
2164                         R - Reload - ensure that the document is saved and reload it after command execution \n
2165                         M - Message - ask for input string (commit message)\n
2166                 <PATH>: path where to start. $$p will be replaced by the current document path.\n
2167                 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current
2168                            document(with absolute path)/path/message.
2169  * \li Sample: vc-command DR $$p "svn up"
2170  * \li Origin: sanda, 13 Jan 2009
2171  * \endvar
2172  */
2173                 { LFUN_VC_COMMAND, "vc-command", NoBuffer | ReadOnly, System },
2174 /*!
2175  * \var lyx::FuncCode lyx::LFUN_VC_LOCKING_TOGGLE
2176  * \li Action: Toggles the locking property of the edited file.
2177  * \li Notion: This is currently implemented only for SVN.
2178  * \li Syntax: vc-locking-toggle
2179  * \li Origin: sanda, 25 Jun 2009
2180  * \endvar
2181  */
2182                 { LFUN_VC_LOCKING_TOGGLE, "vc-locking-toggle", ReadOnly, System },
2183 /*!
2184  * \var lyx::FuncCode lyx::LFUN_VC_REPO_UPDATE
2185  * \li Action: Update the local archive directory in which resides
2186                the current document with the remote repository.
2187  * \li Notion: This is currently implemented only for SVN.
2188  * \li Syntax: vc-repo-update
2189  * \li Origin: sanda, 16 Oct 2009
2190  * \endvar
2191  */
2192                 { LFUN_VC_REPO_UPDATE, "vc-repo-update", ReadOnly, System },
2193 /*!
2194  * \var lyx::FuncCode lyx::LFUN_VC_COMPARE
2195  * \li Action: Compares two revisions of the same file under version control.
2196  * \li Notion: This is currently implemented only for SVN and RCS.
2197  * \li Syntax: vc-compare <REV1> [<REV2>]
2198  * \li Params: Revision number either points directly to commit in history
2199                or if negative number -x it points to last commit - x.\n
2200                In RCS we subtract only in the last part of revision specification.
2201                Special case "0" is reserved for the last committed revision.\n
2202                <REV1>: Older file.\n
2203                <REV2>: Newer file. Used only if REV1 > 0.
2204  * \li Sample: Compare current document against last commit\n
2205                vc-compare 0
2206  * \li Sample: Compare current document against current revision - 5 commits\n
2207                vc-compare -5
2208  * \li Sample: Compare revisions 120 and 155\n
2209                vc-compare 120 155
2210  * \li Origin: sanda, 12 Feb 2010
2211  * \endvar
2212  */
2213                 { LFUN_VC_COMPARE, "vc-compare", ReadOnly, System },
2214
2215 /*!
2216  * \var lyx::FuncCode lyx::LFUN_CHANGES_TRACK
2217  * \li Action: Toggles change tracking to on/off.
2218  * \li Syntax: changes-track
2219  * \li Origin: levon, 1 Oct 2002
2220  * \endvar
2221  */
2222                 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
2223 /*!
2224  * \var lyx::FuncCode lyx::LFUN_CHANGES_OUTPUT
2225  * \li Action: Toggles showing of change tracking in typesetted output.
2226  * \li Syntax: changes-output
2227  * \li Origin: jspitzm, 21 Jan 2005
2228  * \endvar
2229  */
2230                 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
2231 /*!
2232  * \var lyx::FuncCode lyx::LFUN_CHANGE_NEXT
2233  * \li Action: Moves the cursor to the position of the next change
2234                of the change tracking records.
2235  * \li Syntax: change-next
2236  * \li Origin: schmitt, 4 Oct 2006
2237  * \endvar
2238  */
2239                 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
2240 /*!
2241  * \var lyx::FuncCode lyx::LFUN_CHANGE_PREVIOUS
2242  * \li Action: Moves the cursor to the position of the previous change
2243                of the change tracking records.
2244  * \li Syntax: change-previous
2245  * \li Origin: vfr, 4 Apr 2009
2246  * \endvar
2247  */
2248                 { LFUN_CHANGE_PREVIOUS, "change-previous", ReadOnly, Edit },
2249 /*!
2250  * \var lyx::FuncCode lyx::LFUN_CHANGES_MERGE
2251  * \li Action: Open change tracking dialog for merging and moves the cursor
2252                to the position of the next change.
2253  * \li Syntax: changes-merge
2254  * \li Origin: Levon, 16 Oct 2002
2255  * \endvar
2256  */
2257                 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
2258 /*!
2259  * \var lyx::FuncCode lyx::LFUN_CHANGE_ACCEPT
2260  * \li Action: Accepts tracked change inside the selection.
2261  * \li Syntax: change-accept
2262  * \li Origin: Levon, 16 Oct 2002
2263  * \endvar
2264  */
2265                 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
2266 /*!
2267  * \var lyx::FuncCode lyx::LFUN_CHANGE_REJECT
2268  * \li Action: Rejects tracked change inside the selection.
2269  * \li Syntax: change-accept
2270  * \li Origin: Levon, 16 Oct 2002
2271  * \endvar
2272  */
2273                 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
2274 /*!
2275  * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_ACCEPT
2276  * \li Action: Accepts all tracked changes in the document.
2277  * \li Syntax: all-changes-accept
2278  * \li Origin: Levon, 16 Oct 2002
2279  * \endvar
2280  */
2281                 { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
2282 /*!
2283  * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_REJECT
2284  * \li Action: Rejects all tracked changes in the document.
2285  * \li Notion: Reject does not work recursively; the user may have to repeat the operation.
2286  * \li Syntax: all-changes-reject
2287  * \li Origin: Levon, 16 Oct 2002
2288  * \endvar
2289  */
2290                 { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
2291
2292 /*!
2293  * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
2294  * \li Action: Apply data for an inset.
2295  * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
2296                be applied. This is either changed to #LFUN_INSET_MODIFY or
2297                #LFUN_INSET_INSERT depending on the context where it is called.
2298  * \li Syntax: inset-apply <ARGS>
2299  * \li Params: See #LFUN_INSET_INSERT .
2300  * \endvar
2301  */
2302                 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
2303 /*!
2304  * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE
2305  * \li Action: Dissolve the current inset into text.
2306  * \li Syntax: inset-dissolve [<INSET>]
2307  * \li Params: <INSET>: this can be used to make sure the right kind of inset
2308                         is dissolved. For example "dissolve" entry in the charstyles
2309                         sub-menu should only dissolve the charstyle inset, even if the
2310                         cursor is inside several nested insets of different type.\n
2311                         For values see #lyx::InsetLayout::lyxtype_ .
2312  * \li Origin: JSpitz, 7 Aug 2006
2313  * \endvar
2314  */
2315                 { LFUN_INSET_DISSOLVE, "inset-dissolve", AtPoint, Edit },
2316 /*!
2317  * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
2318  * \li Action: Insert new inset (type given by the parameters).
2319  * \li Syntax: inset-insert <INSET> <ARGS>
2320  * \li Params: <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics|
2321                          hyperlink|include|index|label|nomencl|vspace|ref|toc>\n
2322                <ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
2323  * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
2324                where <label name> is the name of the referenced label and
2325                <Format> is one of the following: \n
2326                ref -- <reference> \n
2327                eqref -- (<reference>) \n
2328                pageref -- <page> \n
2329                vpageref -- on <page> \n
2330                vref -- <reference> on <page> \n
2331                prettyref -- Formatted reference
2332  * \endvar
2333  */
2334                 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
2335 /*!
2336  * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
2337  * \li Action: Modify some properties of an inset.
2338  * \li Notion: Used for bibitem, bibtex, box, branch, command, ert, external,
2339                         floats, graphics, include, index, info, label, 
2340                         listings, newline, newpage, nomencl, note, phantom, 
2341                         ref, space, tabular, vspace, wrap insets.
2342  * \li Syntax: inset-modify <INSET> <ARGS>
2343  * \li Syntax: inset-modify changetype <TYPE>
2344  * \li Sample: inset-modify note Note Comment
2345  * \li Sample: inset-modify changetype Ovalbox
2346  * \li Params: See #LFUN_INSET_INSERT for further details.
2347  * \endvar
2348  */
2349                 { LFUN_INSET_MODIFY, "inset-modify", AtPoint, Edit },
2350 /*!
2351  * \var lyx::FuncCode lyx::LFUN_INSET_DIALOG_UPDATE
2352  * \li Action: Updates the values inside the dialog from the inset.
2353  * \li Notion: This is internal LFUN, not to be used by users. Called internally
2354                by #LFUN_DIALOG_UPDATE
2355  * \li Params: <DIALOG-NAME>
2356  * \li Origin: leeming, 25 Feb 2003
2357  * \endvar
2358  */
2359                 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
2360 /*!
2361  * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
2362  * \li Action: Open the inset's properties dialog.
2363  * \li Notion: Used for bibitem, bibtex, box, branch, citation, ert, external,
2364                float, graphics, href, include, index, index_print, label, listings,
2365                note, phantom, ref, space, tabular, vspace, wrap insets.
2366  * \li Syntax: inset-settings <INSET>
2367  * \li Params: <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|
2368                          graphics|href|include|index|index_print|label|listings|
2369                          note|phantom|ref|space|tabular|vspace|wrap>.
2370  * \endvar
2371  */
2372                 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly | AtPoint, Edit },
2373 /*!
2374  * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
2375  * \li Action: Toggles the collapsable inset at cursor position,
2376                or the inset we are currently in.
2377  * \li Syntax: inset-toggle [<ARG>]
2378  * \li Params: <ARG>: <open|close|toggle|assign>. \n
2379                open/close/toggle are for collapsable insets. toggle is used when no argument is given.\n
2380                assign synchronize the branch-inset with activation status of the branch.
2381                Used for global toggling when changed activation.
2382  * \li Origin: lasgouttes, 19 Jul 2001
2383  * \endvar
2384  */
2385                 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly | AtPoint, Edit },
2386 /*!
2387  * \var lyx::FuncCode lyx::LFUN_ALL_INSETS_TOGGLE
2388  * \li Action: Toggles (open/closes) all collapsable insets (of a given type) in the document.
2389  * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
2390  * \li Syntax: all-insets-toggle [<STATE>] [<INSET>]
2391  * \li Params: <STATE>: <toggle|open|close|assign> default: toggle \n
2392                <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all insets
2393  * \li Origin: leeming, 30 Mar 2004
2394  * \endvar
2395  */
2396                 { LFUN_ALL_INSETS_TOGGLE, "all-insets-toggle", ReadOnly, Edit },
2397 /*!
2398  * \var lyx::FuncCode lyx::LFUN_INSET_FORALL
2399  * \li Action: Apply the given commands on insets of a given name.
2400  * \li Notion: WARNING: use at your own risks; this function gives
2401                you too many ways of shooting yourself in the foot.
2402                A typical example is
2403                    inset-forall Note note-insert
2404                which starts an infinite loop. This is mitigated by the fact
2405                that the number of actions is arbitrarily limited to 10000.
2406  * \li Syntax: inset-forall <NAME> <LFUN-COMMAND> \n
2407                <NAME>: Type of Inset. If <NAME> is *, all insets are matched.
2408                The name is used like for InsetLayout in layout files: "Note"
2409                matches all note insets, while "Note:Note" only matches LyX
2410                yellow note insets.
2411  * \li Sample: Remove all index insets: \n
2412                    inset-forall Index delete-char-forward \n
2413                Close all Notes (also works for a particular branch, for example): \n
2414                    inset-forall Note inset-toggle close \n
2415                Transform all yellow notes to comments \n
2416                    inset-forall Note:Note inset-modify note Note Comment \n
2417                Try to put LyX in an infinite loop if there is at least a Note: \n
2418                    inset-forall Note char-backward
2419  * \li Origin: lasgouttes, 27 Nov 2009
2420  * \endvar
2421  */
2422                 { LFUN_INSET_FORALL, "inset-forall", ReadOnly, Edit },
2423
2424 /*!
2425  * \var lyx::FuncCode lyx::LFUN_GRAPHICS_RELOAD
2426  * \li Action: Reloads the image if necessary.
2427  * \li Syntax: graphics-reload
2428  * \li Origin: vfr, 10 Aug 2009
2429  * \endvar
2430  */
2431                 { LFUN_GRAPHICS_RELOAD, "graphics-reload", ReadOnly | AtPoint, Edit },
2432 /*!
2433  * \var lyx::FuncCode lyx::LFUN_SET_GRAPHICS_GROUP
2434  * \li Action: Set the group for the graphics inset on the cursor position.
2435  * \li Syntax: set-graphics-group [<GROUP>]
2436  * \li Params: <GROUP>: Id for an existing group. In case the Id is an empty string,
2437                         the graphics inset is removed from the current group.
2438  * \li Origin: sanda, 6 May 2008
2439  * \endvar
2440  */
2441                 { LFUN_SET_GRAPHICS_GROUP, "set-graphics-group", Noop, Edit },
2442
2443 /*!
2444  * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
2445  * \li Action: Moves the cursor out of the current slice, going forward.
2446  * \li Notion: Cursor movement within an inset may be different than cursor
2447                movement in the surrounding text. This action should be called
2448                automatically by the cursor movement within the inset, when
2449                movement within the inset has ceased (reached the end of the
2450                last paragraph, for example), in order to move correctly
2451                back into the surrounding text.
2452  * \endvar
2453  */
2454                 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
2455 /*!
2456  * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
2457  * \li Action: Moves the cursor out of the current slice, going backwards.
2458  * \li Notion: See also #LFUN_FINISHED_FORWARD.
2459  * \endvar
2460  */
2461                 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
2462 /*!
2463  * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
2464  * \li Action: Moves the cursor out of the current slice, going right.
2465  * \li Notion: See also #LFUN_FINISHED_FORWARD
2466  * \endvar
2467  */
2468                 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
2469 /*!
2470  * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
2471  * \li Action: Moves the cursor out of the current slice, going left.
2472  * \li Notion: See also #LFUN_FINISHED_FORWARD.
2473  * \endvar
2474  */
2475                 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
2476
2477 /*!
2478  * \var lyx::FuncCode lyx::LFUN_LANGUAGE
2479  * \li Action: Set language from the current cursor position.
2480  * \li Syntax: language <LANG>
2481  * \li Params: <LANG>: Requested language. Look in lib/languages for
2482                        the list.
2483  * \li Origin: Dekel, 2 Mar 2000
2484  * \endvar
2485  */
2486                 { LFUN_LANGUAGE, "language", Noop, Edit },
2487
2488 /*!
2489  * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
2490  * \li Action: Goto a label.
2491  * \li Syntax: label-goto [<LABEL>]
2492  * \li Params: <LABEL>: Requested label. If no label is given and reference
2493                         is on cursor position, Bookmark 0 is saved and
2494                         cursor moves to the position of referenced label.
2495  * \li Origin: Ale, 6 Aug 1997
2496  * \endvar
2497  */
2498                 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
2499 /*!
2500  * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT
2501  * \li Action: Inserts label to text or displayed formula.
2502  * \li Syntax: label-insert [<LABEL>]
2503  * \li Params: <LABEL>: Requested label. If no label is given dialog requesting
2504                         name will be opened.
2505  * \endvar
2506  */
2507                 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
2508 /*!
2509  * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
2510  * \li Action: Go to the next label or cross-reference.
2511  * \li Syntax: reference-next
2512  * \li Origin: Dekel, 14 Jan 2001
2513  * \endvar
2514  */
2515                 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
2516
2517 /*!
2518  * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
2519  * \li Action: Moves the cursor to the numbered bookmark, opening the file
2520                if necessary. Note that bookmarsk are saved per-session, not
2521                per file.
2522  * \li Notion: Bookmark 0 has a special purpose. It is automatically set \n
2523                1. to the paragraph you are currently editing \n
2524                2. to the paragraph from where you are jumping to the last-edited
2525                   position (jump-back feature) \n
2526                3. when jumping from crossreference to the requested label by
2527                   #LFUN_LABEL_GOTO.
2528  * \li Syntax: bookmark-goto <NUMBER>
2529  * \li Params: <NUMBER>: the number of the bookmark to restore.
2530  * \li Origin: Dekel, 27 January 2001
2531  * \endvar
2532  */
2533                 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
2534 /*!
2535  * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
2536  * \li Action: Save a bookmark.
2537  * \li Notion: Saves a numbered bookmark to the sessions file. The number
2538                must be between 1 and 9, inclusive. Note that bookmarks are
2539                saved per-session, not per file.
2540  * \li Syntax: bookmark-save <NUMBER>
2541  * \li Params: <NUMBER>: the number of the bookmark to save.
2542  * \li Origin: Dekel, 27 January 2001
2543  * \endvar
2544  */
2545                 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
2546 /*!
2547  * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
2548  * \li Action: Clears the list of saved bookmarks.
2549  * \li Syntax: bookmark-clear
2550  * \li Origin: bpeng, 31 October 2006
2551  * \endvar
2552  */
2553                 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
2554
2555 /*!
2556  * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
2557  * \li Action: Open the given help file according to the language setting.
2558  * \li Syntax: help-open <FILE>[.lyx]
2559  * \li Params: <FILE>: any document from (/usr/share/)doc directory.
2560  * \li Origin: Jug, 27 Jun 1999
2561  * \endvar
2562  */
2563                 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
2564 /*!
2565  * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
2566  * \li Action: Terminates the current LyX instance.
2567  * \li Notion: Terminates the current LyX instance, asking whether to save
2568                modified documents, etc.
2569  * \li Syntax: lyx-quit
2570  * \endvar
2571  */
2572                 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
2573 /*!
2574  * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
2575  * \li Action: Toggles visibility of a given toolbar between on/off/auto.
2576  * \li Notion: Skipping "auto" when allowauto is false.
2577  * \li Syntax: toolbar-toggle <NAME> [allowauto]
2578  * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|
2579                        minibuffer|review|view/update|math_panels|vcs
2580  * \li Origin: Edwin, 21 May 2007
2581  * \endvar
2582  */
2583                 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
2584 /*!
2585  * \var lyx::FuncCode lyx::LFUN_MENU_OPEN
2586  * \li Action: Opens the menu given by its name.
2587  * \li Syntax: menu-open <NAME>
2588  * \li Params: <NAME>: menu name. See various .inc files in lib/ui for candidates.
2589  * \endvar
2590  */
2591                 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
2592 /*!
2593  * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
2594  * \li Action: Various UI visibility-toggling actions.
2595  * \li Syntax: ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
2596  * \li Params: statusbar  : Toggle visibility of the statusbar.\n
2597                menubar    : Toggle visibility of the menubar.\n
2598                scrollbar  : Toggle visibility of the scrollbar.\n
2599                frame      : Toggle visibility of the frames around editing window.\n
2600                fullscreen : Toggle fullscreen mode. This also covers calling the
2601                             previous functions. However #LFUN_TOOLBAR_TOGGLE for the
2602                             custom tweaks of the toolbars should be used.
2603  * \li Origin: sanda, 9 Feb 2007
2604  * \endvar
2605  */
2606                 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
2607
2608 /*!
2609  * \var lyx::FuncCode lyx::LFUN_WINDOW_NEW
2610  * \li Action: Creates new empty LyX window.
2611  * \li Notion: Already opened documents from the previous window can be found under View menu.
2612  * \li Syntax: window-new [<GEOMETRY>]
2613  * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently 
2614                            accepted only on Windows platform.
2615  * \li Origin: Abdel, 21 Oct 2006
2616  * \endvar
2617  */
2618                 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
2619 /*!
2620  * \var lyx::FuncCode lyx::LFUN_WINDOW_CLOSE
2621  * \li Action: Closes the current LyX window.
2622  * \li Syntax: window-close
2623  * \li Origin: Abdel, 23 Oct 2006
2624  * \endvar
2625  */
2626                 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
2627
2628 /*!
2629  * \var lyx::FuncCode lyx::LFUN_SPLIT_VIEW
2630  * \li Action: Creates another split view of current buffer.
2631  * \li Notion: All split views act in the same way indpendently.
2632  * \li Syntax: split-view <vertical|horizontal>
2633  * \li Params: horizontal : The work areas are laid out side by side.\n
2634                vertical   : The work areas laid out vertically.
2635  * \li Origin: Abdel, 20 Feb 2008
2636  * \endvar
2637  */
2638                 { LFUN_SPLIT_VIEW, "split-view", ReadOnly, Buffer },
2639
2640 /*!
2641  * \var lyx::FuncCode lyx::LFUN_CLOSE_TAB_GROUP
2642  * \li Action: Close the current tab group.
2643  * \li Notion: This only closes the work areas, not the buffer themselves.
2644                The still opened buffers can be visualized in another tab group.
2645  * \li Syntax: close-tab-group
2646  * \li Origin: Abdel, 21 Feb 2008
2647  * \endvar
2648  */
2649                 { LFUN_CLOSE_TAB_GROUP, "close-tab-group", ReadOnly, Buffer },
2650 /*!
2651  * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW
2652  * \li Action: Shows hidden dialog or create new one for a given function/inset settings etc.
2653  * \li Syntax: dialog-show <NAME> [<DATA>]
2654  * \li Params: <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|\n
2655                compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|\n
2656                graphics|href|include|index|index_print|info|label|listings|log|mathdelimiter|\n
2657                mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|\n
2658                print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|\n
2659                thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL> \n
2660                <SPECIAL>: latexlog|vclog \n
2661                <DATA>: data, usually settings for the given dialog. Use debug mode for the
2662                        details.
2663  * \li Origin: leeming, 17 Jun 2003
2664  * \endvar
2665  */
2666                 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
2667 /*!
2668  * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW_NEW_INSET
2669  * \li Action: Shows hidden dialog or create new one for a given inset settings etc.
2670  * \li Notion: Internally uses #LFUN_DIALOG_SHOW with processed data for a given inset.
2671  * \li Syntax: dialog-show-new-inset <NAME> [<DATA>]
2672  * \li Params: See #LFUN_DIALOG_SHOW .
2673  * \li Origin: leeming, 25 Feb 2003
2674  * \endvar
2675  */
2676                 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
2677 /*!
2678  * \var lyx::FuncCode lyx::LFUN_DIALOG_UPDATE
2679  * \li Action: Updates the dialog values from the inset/paragraph/document.
2680  * \li Syntax: dialog-update <NAME>
2681  * \li Params: <NAME>: paragraph|prefs|<INSET> \n
2682                <INSET>: inset name
2683  * \li Origin: leeming, 25 Feb 2003
2684  * \endvar
2685  */
2686                 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
2687 /*!
2688  * \var lyx::FuncCode lyx::LFUN_DIALOG_HIDE
2689  * \li Action: Hides showed dialog. Counterpart to #LFUN_DIALOG_SHOW .
2690  * \li Syntax: dialog-hide <NAME>
2691  * \li Params: See #LFUN_DIALOG_SHOW .
2692  * \li Origin: leeming, 25 Feb 2003
2693  * \endvar
2694  */
2695                 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
2696 /*!
2697  * \var lyx::FuncCode lyx::LFUN_DIALOG_TOGGLE
2698  * \li Action: Toggles dialog between showed/hidden state.
2699  * \li Notion: Internally uses #LFUN_DIALOG_SHOW , #LFUN_DIALOG_HIDE .
2700  * \li Syntax: dialog-toggle <NAME> [<DATA>]
2701  * \li Params: See #LFUN_DIALOG_SHOW .
2702  * \li Origin: JSpitzm, 30 Apr 2007
2703  * \endvar
2704  */
2705                 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
2706 /*!
2707  * \var lyx::FuncCode lyx::LFUN_DIALOG_DISCONNECT_INSET
2708  * \li Action: Closes opened connection to opened inset.
2709  * \li Notion: Connection is used for apply functions.
2710  * \li Syntax: dialog-disconnect-inset <INSET-NAME>
2711  * \li Origin: leeming, 25 Feb 2003
2712  * \endvar
2713  */
2714                 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
2715
2716 /*!
2717  * \var lyx::FuncCode lyx::LFUN_MOUSE_PRESS
2718  * \li Action: This function is called when mouse button is pressed (inside workarea).
2719                Action depends on the context.
2720  * \li Notion: This is internal LFUN, not to be used by users.
2721  * \li Origin: Andre, 9 Aug 2002
2722  * \endvar
2723  */
2724                 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
2725 /*!
2726  * \var lyx::FuncCode lyx::LFUN_MOUSE_DOUBLE
2727  * \li Action: This function is called when double click on mouse button is
2728                pressed (inside workarea). Action depends on the context.
2729  * \li Notion: This is internal LFUN, not to be used by users.
2730  * \li Origin: Andre, 9 Aug 2002
2731  * \endvar
2732  */
2733                 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
2734 /*!
2735  * \var lyx::FuncCode lyx::LFUN_MOUSE_TRIPLE
2736  * \li Action: This function is called when triple click on mouse button is
2737                pressed (inside workarea). Action depends on the context.
2738  * \li Notion: This is internal LFUN, not to be used by users.
2739  * \li Origin: Andre, 9 Aug 2002
2740  * \endvar
2741  */
2742                 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
2743 /*!
2744  * \var lyx::FuncCode lyx::LFUN_MOUSE_MOTION
2745  * \li Action: This function is called when mouse cursor is moving over the text.
2746                Action depends on the context.
2747  * \li Notion: This is internal LFUN, not to be used by users.
2748  * \li Origin: Andre, 9 Aug 2002
2749  * \endvar
2750  */
2751                 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
2752 /*!
2753  * \var lyx::FuncCode lyx::LFUN_MOUSE_RELEASE
2754  * \li Action: This function is called when mouse button is released (inside workarea).
2755                Action depends on the context.
2756  * \li Notion: This is internal LFUN, not to be used by users.
2757  * \li Origin: Andre, 9 Aug 2002
2758  * \endvar
2759  */
2760                 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
2761
2762 /*!
2763  * \var lyx::FuncCode lyx::LFUN_KEYMAP_OFF
2764  * \li Action: Turn off the loaded keyboard map.
2765  * \li Syntax: keymap-off
2766  * \endvar
2767  */
2768                 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
2769 /*!
2770  * \var lyx::FuncCode lyx::LFUN_KEYMAP_PRIMARY
2771  * \li Action: Turn on the primary keyboard map.
2772  * \li Notion: Maps were widely used in past, when X-windows didn't have nowadays
2773                keyboard support. They can be still used to maintain uniform keyboard
2774                layout across the various plaforms.\n
2775                The language is to be set in the Preferences dialog.
2776  * \li Syntax: keymap-primary
2777  * \endvar
2778  */
2779                 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
2780 /*!
2781  * \var lyx::FuncCode lyx::LFUN_KEYMAP_SECONDARY
2782  * \li Action: Turn on the secondary keyboard map.
2783  * \li Syntax: keymap-secondary
2784  * \endvar
2785  */
2786                 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
2787 /*!
2788  * \var lyx::FuncCode lyx::LFUN_KEYMAP_TOGGLE
2789  * \li Action: Toggles keyboard maps (first/second/off).
2790  * \li Syntax: keymap-toggle
2791  * \li Origin: leeming, 30 Mar 2004
2792  * \endvar
2793  */
2794                 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
2795
2796 /*!
2797  * \var lyx::FuncCode lyx::LFUN_SERVER_GET_LAYOUT
2798  * \li Action: Returns the current layout (that is environment) name
2799                on the cursor position.
2800  * \li Syntax: server-get-layout
2801  * \endvar
2802  */
2803                 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
2804 /*!
2805  * \var lyx::FuncCode lyx::LFUN_SERVER_GET_FILENAME
2806  * \li Action: Returns path and file name of the currently edited document.
2807  * \li Syntax: server-get-filename
2808  * \endvar
2809  */
2810                 { LFUN_SERVER_GET_FILENAME, "server-get-filename", ReadOnly, System },
2811 /*!
2812  * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
2813  * \li Action: Sets the cursor position based on the row number of generated TeX file.
2814  * \li Notion: This can be useful for DVI inverse-search or detection of the problematic
2815                line from LaTeX compilation. Note that before this function can be used
2816                export to LaTeX output must occur (in order to map the row numbers).
2817  * \li Syntax: server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
2818  * \li Params: <FILE>: the filename. Environment variables are expanded in the path.
2819                        In case this LFUN does not work make sure you are giving correct
2820                        path to the file.\n
2821                        If the file is located inside LyX temporary directory it will be
2822                        mapped back into the appropriate opened buffer (e.g. for the case
2823                        of generated .tex file).
2824                  .ext: extensions will be automatically replaced by .lyx.
2825                  <ROW_NUMBER> The row number of the LaTeX file to which to go.
2826  * \li Origin: Edmar, 23 Dec 1998
2827  * \endvar
2828  */
2829                 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly | NoBuffer, System },
2830 /*!
2831  * \var lyx::FuncCode lyx::LFUN_SERVER_NOTIFY
2832  * \li Action: Sends notify message about the last key-sequence to client.
2833  * \li Notion: This can be used to grab last key-sequence used inside the LyX window.
2834                See also Debug extensions section in Additional features manual.
2835  * \li Syntax: server-notify
2836  * \endvar
2837  */
2838                 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
2839 /*!
2840  * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
2841  * \li Action: Sets the cursor position based on the editing area coordinates
2842                (similar as clicking on that point with left mouse button).
2843  * \li Syntax: server-set-xy <X> <Y>
2844  * \endvar
2845  */
2846                 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
2847 /*!
2848  * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
2849  * \li Action: Returns the coordinates of cursor position in the editing area.
2850  * \li Syntax: server-get-xy
2851  * \endvar
2852  */
2853                 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
2854
2855 /*!
2856  * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
2857  * \li Action: Generates the code (literate programming).
2858  * \li Notion: Latex file with extension \literate_extension is generated.
2859                Then LyX invokes \build_command (with a default of``make'') to generate the code and
2860                \build_error_filter to process the compilation error messages. \n
2861                In case you want to process your literate file with a script, or some other program,
2862                just insert in your lyxrc file an entry with:\n
2863                \build_command "my_script my_arguments" \n
2864                The \build_error_filter differs from the \literate_error_filter only in that the
2865                former will identify error messages from your compiler.
2866  * \li Syntax: build-program
2867  * \endvar
2868  */
2869                 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
2870
2871 /*!
2872  * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
2873  * \li Action: Saves the current buffer to a temporary file.
2874  * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
2875                is called automatically by LyX, to "autosave" the current buffer.
2876  * \li Syntax: buffer-auto-save
2877  * \endvar
2878  */
2879                 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
2880 /*!
2881  * \var lyx::FuncCode lyx::LFUN_BUFFER_CHILD_OPEN
2882  * \li Action: Loads the given child document.
2883  * \li Notion: The current document is treated as a parent.
2884  * \li Syntax: buffer-child-open <FILE>
2885  * \li Params: <FILE>: Filename of the child. The directory of the parent is assumed by default.
2886  * \li Origin: Ale, 28 May 1997
2887  * \endvar
2888  */
2889                 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
2890 /*!
2891  * \var lyx::FuncCode lyx::LFUN_BUFFER_CHKTEX
2892  * \li Action: Runs chktex for the current document.
2893  * \li Syntax: buffer-chktex
2894  * \li Origin: Asger, 30 Oct 1997
2895  * \endvar
2896  */
2897                 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
2898 /*!
2899  * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
2900  * \li Action: Toggles compression of the current document on/off.
2901  * \li Syntax: buffer-toggle-compression
2902  * \li Origin: bpeng, 27 Apr 2006
2903  * \endvar
2904  */
2905                 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
2906 /*!
2907  * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
2908  * \li Action: Closes the current buffer.
2909  * \li Notion: Closes the current buffer, asking whether to save it, etc,
2910                if the buffer has been modified.
2911  * \li Syntax: buffer-close
2912  * \endvar
2913  */
2914                 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
2915 /*!
2916  * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE_ALL
2917  * \li Action: Closes all buffers.
2918  * \li Notion: Closes all buffers, asking whether to save it, etc,
2919                if a buffer has been modified.
2920  * \li Syntax: buffer-close-all
2921  * \endvar
2922  */
2923                 { LFUN_BUFFER_CLOSE_ALL, "buffer-close-all", ReadOnly, Buffer },
2924 /*!
2925  * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
2926  * \li Action: Exports the current buffer (document) to the given format.
2927  * \li Syntax: buffer-export <FORMAT>
2928  * \li Params: <FORMAT> is either "custom" or one of the formats which you
2929                         can find in Tools->Preferences->File formats->Format.
2930                         Usual format you will enter is "pdf2" (pdflatex),
2931                         "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
2932                         In case of "custom" you will be asked for a format you
2933                         want to start from and for the command that you want to
2934                         apply to this format. Internally the control is then passed
2935                         to #LFUN_BUFFER_EXPORT_CUSTOM.
2936  * \li Origin: Lgb, 29 Jul 1997
2937  * \endvar
2938  */
2939                 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
2940 /*!
2941  * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
2942  * \li Action: Exports the current buffer (document) from the given format using
2943                the given command on it.
2944  * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
2945  * \li Params: <FORMAT> format to start from (LyX will care to produce such
2946                         intermediate file).\n
2947                <COMMAND> this command will be launched on the file. Note that you can
2948                          use "$$FName" string to qualify the intermediate file.
2949  * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
2950  * \li Origin: leeming, 27 Mar 2004
2951  * \endvar
2952  */
2953                 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
2954 /*!
2955  * \var lyx::FuncCode lyx::LFUN_BUFFER_PRINT
2956  * \li Action: Prints the current document.
2957  * \li Notion: Many settings can be given via the preferences dialog.
2958  * \li Syntax: buffer-print <TARGET> <TARGET-NAME> <COMMAND>
2959  * \li Params: <TARGET> is either "printer" or "file".\n
2960                <TARGER-NAME> is either "default" or file name or printer name.\n
2961                <COMMAND> command ensuring the printing job.
2962  * \li Sample: buffer-print file "/trash/newfile1.ps" "dvips"
2963  * \li Origin: leeming, 28 Mar 2004
2964  * \endvar
2965  */
2966                 { LFUN_BUFFER_PRINT, "buffer-print", ReadOnly, Buffer },
2967 /*!
2968  * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
2969  * \li Action: Import a given file as a lyx document.
2970  * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
2971                defined convertors in preferences. Look into File->Import menu to get
2972                an idea of the currently active import formats.
2973  * \li Syntax: buffer-import <FORMAT> [<FILE>]
2974  * \li Origin: Asger, 24 Jul 1998
2975  * \endvar
2976  */
2977                 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
2978 /*!
2979  * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
2980  * \li Action: Creates a new buffer (that is, document).
2981  * \li Notion: Implicit path can be set in Preferences dialog.
2982  * \li Syntax: buffer-new [<FILE>]
2983  * \li Params: <FILE>: filename of created file with absolute path.
2984  * \endvar
2985  */
2986                 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
2987 /*!
2988  * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
2989  * \li Action: Creates a new buffer (that is, document) from a template.
2990  * \li Notion: Path for new files and templates can be set in Preferences dialog.
2991                Template will be asked for via Open-dialog.
2992  * \li Syntax: buffer-new-template [<FILE>]
2993  * \li Params: <FILE>: filename of created file with absolute path.
2994  * \endvar
2995  */
2996                 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
2997 /*!
2998  * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
2999  * \li Action: Reverts opened document.
3000  * \li Syntax: buffer-reload
3001  * \li Origin: Asger, 2 Feb 1997
3002  * \endvar
3003  */
3004                 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
3005 /*!
3006  * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
3007  * \li Action: Display/switch to the given buffer.
3008  * \li Syntax: buffer-switch <BUFFER>
3009  * \li Params: <BUFFER>: path and filename of already opened (but possibly hidden)
3010                          document which is to be shown.
3011  * \endvar
3012  */
3013                 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
3014 /*!
3015  * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
3016  * \li Action: Toggle editing mode of the current document between read/write and read-only.
3017  * \li Notion: This function is not allowed if the file is under version control, since
3018                read-only flag is often used in version control file locking.
3019  * \li Syntax: buffer-toggle-read-only
3020  * \li Origin: Lgb, 27 May 1997
3021  * \endvar
3022  */
3023                 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
3024 /*!
3025  * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
3026  * \li Action: Displays current buffer in chosen format.
3027  * \li Notion: Displays the contents of the current buffer in the chosen
3028                format, for example, PDF or DVI. This runs the necessary
3029                converter, calls the defined viewer, and so forth.
3030  * \li Syntax: buffer-view [<FORMAT>]
3031  * \li Params: <FORMAT>: The format to display, where this is one of the
3032                          formats defined (in the current GUI) in the
3033                          Tools>Preferences>File Formats dialog.
3034                          If no format is given, the default format as
3035                          specified in the same dialog is used.
3036  * \endvar
3037  */
3038                 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
3039 /*!
3040  * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
3041  * \li Action: Exports the current document and put the result into the
3042                temporary directory.
3043  * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
3044                the output will be rewriten - updated. This is useful in case your viewer
3045                is able to detect such changes (e.g. ghostview for postscript).
3046  * \li Syntax: buffer-update [<FORMAT>]
3047  * \li Params: <FORMAT>: The format to display, where this is one of the
3048                          formats defined (in the current GUI) in the
3049                          Tools>Preferences>File Formats dialog.
3050                          If no format is given, the default format as
3051                          specified in the same dialog is used.
3052  * \li Origin: Dekel, 5 Aug 2000
3053  * \endvar
3054  */
3055                 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
3056
3057 /*!
3058  * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
3059  * \li Action: Saves the current buffer.
3060  * \li Notion: Saves the current buffer to disk, using the filename that
3061                is already associated with the buffer, asking for one if
3062                none is yet assigned.
3063  * \li Syntax: buffer-write
3064  * \endvar
3065  */
3066                 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
3067 /*!
3068  * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
3069  * \li Action: Rename and save current buffer.
3070  * \li Syntax: buffer-write-as <FILENAME>
3071  * \li Params: <FILENAME>: New name of the buffer/file. A relative path
3072                is with respect to the original location of the buffer/file.
3073  * \endvar
3074  */
3075                 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
3076 /*!
3077  * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
3078  * \li Action: Save all changed documents.
3079  * \li Syntax: buffer-write-all
3080  * \li Origin: rgh, gpothier 6 Aug 2007
3081  * \endvar
3082  */
3083                 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
3084 /*!
3085  * \var lyx::FuncCode lyx::LFUN_BUFFER_NEXT
3086  * \li Action: Switch to the next opened document.
3087  * \li Notion: Note that this does not necessarily mean next in tabbar
3088                (for full list see View menu).
3089  * \li Syntax: buffer-next
3090  * \endvar
3091  */
3092                 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
3093 /*!
3094  * \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS
3095  * \li Action: Switch to the previous opened document.
3096  * \li Syntax: buffer-previous
3097  * \endvar
3098  */
3099                 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
3100 /*!
3101  * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
3102  * \li Action: When run from a child document, this updates (exports) document built
3103                from the master buffer, if available.
3104  * \li Syntax: master-buffer-update [<FORMAT>]
3105  * \li Params: <FORMAT>: The format to display, where this is one of the
3106                          formats defined (in the current GUI) in the
3107                          Tools>Preferences>File Formats dialog.
3108                          If no format is given, the default format as
3109                          specified in the same dialog is used.
3110  * \li Origin: Tommaso, 20 Sep 2007
3111  * \endvar
3112  */
3113                 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
3114 /*!
3115  * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
3116  * \li Action: When run from a child document, this command shows a preview built
3117                from the master buffer, if available.
3118  * \li Syntax: master-buffer-view [<FORMAT>]
3119  * \li Params: <FORMAT>: The format to display, where this is one of the
3120                          formats defined (in the current GUI) in the
3121                          Tools>Preferences>File Formats dialog.
3122                          If no format is given, the default format as
3123                          specified in the same dialog is used.
3124  * \li Origin: Tommaso, 20 Sep 2007
3125  * \endvar
3126  */
3127                 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
3128 /*!
3129  * \var lyx::FuncCode lyx::LFUN_BUFFER_LANGUAGE
3130  * \li Action: Set language of the current document.
3131  * \li Syntax: buffer-language <LANG>
3132  * \li Params: <LANG>: language name. See lib/languages for list.
3133  * \li Origin: leeming, 30 Mar 2004
3134  * \endvar
3135  */
3136                 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
3137 /*!
3138  * \var lyx::FuncCode lyx::LFUN_BUFFER_SAVE_AS_DEFAULT
3139  * \li Action: Save the current document settings as default.
3140  * \li Notion: The file will will be saved into ~/.lyx/templates/defaults.lyx .
3141  * \li Syntax: buffer-save-as-default [<ARGS>]
3142  * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
3143                        you can find in document header of usual .lyx file.
3144  * \li Origin: leeming, 30 Mar 2004
3145  * \endvar
3146  */
3147                 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
3148 /*!
3149  * \var lyx::FuncCode lyx::LFUN_BUFFER_PARAMS_APPLY
3150  * \li Action: Apply the given settings to the current document.
3151  * \li Syntax: buffer-params-apply [<ARGS>]
3152  * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
3153                        you can find in document header of usual .lyx file.
3154  * \li Origin: leeming, 30 Mar 2004
3155  * \endvar
3156  */
3157                 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", NoInternal, Buffer },
3158
3159 /*!
3160  * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
3161  * \li Action: Inserts another LyX file.
3162  * \li Syntax: file-insert [<FILE>]
3163  * \li Params: <FILE>: Filename to be inserted.
3164  * \endvar
3165  */
3166                 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
3167 /*!
3168  * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
3169  * \li Action: Inserts plain text file.
3170  * \li Syntax: file-insert-plaintext [<FILE>]
3171  * \li Params: <FILE>: Filename to be inserted.
3172  * \li Origin: CFO-G, 19 Nov 1997
3173  * \endvar
3174  */
3175                 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
3176 /*!
3177  * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
3178  * \li Action: Inserts plain text file as paragraph (i.e. join lines).
3179  * \li Syntax: file-insert-plaintext-para [<FILE>]
3180  * \li Params: <FILE>: Filename to be inserted.
3181  * \li Origin: Levon, 14 Feb 2001
3182  * \endvar
3183  */
3184                 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
3185 /*!
3186  * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
3187  * \li Action: Open LyX document.
3188  * \li Syntax: file-open [<FILE>]
3189  * \li Params: <FILE>: Filename to be opened.
3190  * \endvar
3191  */
3192                 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
3193
3194 /*!
3195  * \var lyx::FuncCode lyx::LFUN_CALL
3196  * \li Action: Executes a command defined in a .def file.
3197  * \li Notion: The definitions are by default read from lib/commands/default.def.\n
3198                A .def file allows to define a command with \define "<NAME>" "<LFUN>"
3199                where <NAME> is the name of the new command and <LFUN> is the lfun code
3200                to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
3201                \def_file "FileName" allows to include another .def file. \n
3202                This is particularly useful in connection with toolbar buttons:
3203                Since the name of the button image for this lfun is 
3204                lib/images/commands/<NAME>.png this is the way to assign an image
3205                to a complex command-sequence.
3206  * \li Syntax: call <NAME>
3207  * \li Params: <NAME>: Name of the command that must be called.
3208  * \li Origin: broider, 2 Oct 2007
3209  * \endvar
3210  */
3211                 { LFUN_CALL, "call", NoBuffer, System },
3212 /*!
3213  * \var lyx::FuncCode lyx::LFUN_META_PREFIX
3214  * \li Action: Simulate halting Meta key (Alt key on PCs).
3215  * \li Notion: Used for buffer editation not for GUI control.
3216  * \li Syntax: meta-prefix
3217  * \endvar
3218  */
3219                 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
3220 /*!
3221  * \var lyx::FuncCode lyx::LFUN_CANCEL
3222  * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
3223  * \li Syntax: cancel
3224  * \endvar
3225  */
3226                 { LFUN_CANCEL, "cancel", NoBuffer, System },
3227
3228 /*!
3229  * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
3230  * \li Action: Switches the focus to the minibuffer so that the user can type
3231                in there. If necessary, it opens the minibuffer toolbar.
3232  * \li Notion: Usually bound to M-x shortcut.
3233  * \li Syntax: command-execute
3234  * \endvar
3235  */
3236                 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
3237
3238 /*!
3239  * \var lyx::FuncCode lyx::LFUN_COMMAND_PREFIX
3240  * \li Action: Return the current key sequence and available options as a string.
3241  * \li Notion: No options are added if no current map exists. \n
3242                This is probably usable only with connection to lyxserver.
3243  * \li Syntax: command-prefix
3244  * \endvar
3245  */
3246                 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
3247 /*!
3248  * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
3249  * \li Action: Run more commands (LFUN and its parameters) in a sequence.
3250  * \li Syntax: command-sequence <CMDS>
3251  * \li Params: <CMDS>: Sequence of commands separated by semicolons.
3252  * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
3253  * \li Origin: Andre, 11 Nov 1999
3254  * \endvar
3255  */
3256                 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
3257 /*!
3258  * \var lyx::FuncCode lyx::LFUN_COMMAND_ALTERNATIVES
3259  * \li Action: Runs the first listed command that is enabled.
3260  * \li Notion: This can be used to bind multiple functions to a single key,
3261                and then which one is used will depend upon the context.
3262  * \li Syntax: command-alternatives <CMDS>
3263  * \li Params: <CMDS>: Sequence of commands separated by semicolons.
3264  * \li Sample: command-alternatives completion-accept;cell-forward
3265  * \li Origin: rgh, 24 September 2008
3266  * \endvar
3267  */
3268                 { LFUN_COMMAND_ALTERNATIVES, "command-alternatives", NoBuffer, System },
3269 /*!
3270  * \var lyx::FuncCode lyx::LFUN_MESSAGE
3271  * \li Action: Shows message in statusbar (for script purposes).
3272  * \li Syntax: message <STRING>
3273  * \li Origin: Lgb, 8 Apr 2001
3274  * \endvar
3275  */
3276                 { LFUN_MESSAGE, "message", NoBuffer, System },
3277 /*!
3278  * \var lyx::FuncCode lyx::LFUN_DEBUG_LEVEL_SET
3279  * \li Action: Set debug output level.
3280  * \li Syntax: debug-level-set <LEVEL>
3281  * \li Params: <LEVEL>: comma separated list of levels or the correspondent number
3282                         of their combination. 0 is equivalent to disabling all debug
3283                         events. See lyx -dbg for the current list of debug levels
3284                         and their numbers.
3285  * \li Origin: sanda, 28 Dec 2009
3286  * \endvar
3287  */
3288                 { LFUN_DEBUG_LEVEL_SET, "debug-level-set", NoBuffer, System },
3289
3290 /*!
3291  * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
3292  * \li Action: Save user preferences.
3293  * \li Syntax: preferences-save
3294  * \li Origin: Lgb, 27 Nov 1999
3295  * \endvar
3296  */
3297                 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
3298 /*!
3299  * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
3300  * \li Action: Reconfigure the automatic settings.
3301  * \li Syntax: reconfigure
3302  * \li Origin: Asger, 14 Feb 1997
3303  * \endvar
3304  */
3305                 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
3306 /*!
3307  * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
3308  * \li Action: Apply the given settings to user preferences.
3309  * \li Syntax: lyxrc-apply <SETTINGS>
3310  * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
3311                            to get an idea which commands to use and their syntax.
3312                            #lyx::LyXRC::LyXRCTags has the list of possible commands.
3313  * \endvar
3314  */
3315                 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
3316 /*!
3317  * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
3318  * \li Action: Determine whether keep cursor inside the editing window regardless
3319                the scrollbar movement.
3320  * \li Syntax: toggle-cursor-follows-scrollbar
3321  * \li Origin: ARRae, 2 Dec 1997
3322  * \endvar
3323  */
3324                 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
3325 /*!
3326  * \var lyx::FuncCode lyx::LFUN_SET_COLOR
3327  * \li Action: Set the given LyX color to the color defined by the X11 name given.
3328  * \li Notion: A new color entry is created if the color is unknown.
3329                Color names can be stored as a part of user settings.
3330  * \li Syntax: set-color <LYX_NAME> <X11_NAME>
3331  * \li Origin: SLior, 11 Jun 2000
3332  * \endvar
3333  */
3334                 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
3335 /*!
3336  * \var lyx::FuncCode lyx::LFUN_STATISTICS
3337  * \li Action: Count the statistics (number of words and characters)
3338                in the document or in the given selection.
3339  * \li Notion: Note that this function gives the number of words/chars written,
3340                not the number of characters which will be typeset.
3341  * \li Syntax: statistics
3342  * \li Origin: lasgouttes, Jan 27 2004; sanda, Jan 8 2008
3343  * \endvar
3344  */
3345                 { LFUN_STATISTICS, "statistics", ReadOnly, System },
3346 /*!
3347  * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
3348  * \li Action: Show the inline completion at the cursor position.
3349  * \li Syntax: completion-inline
3350  * \li Origin: sts, Feb 19 2008
3351  * \endvar
3352  */
3353                 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
3354 /*!
3355  * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
3356  * \li Action: Show the completion popup at the cursor position.
3357  * \li Syntax: completion-popup
3358  * \li Origin: sts, Feb 19 2008
3359  * \endvar
3360  */
3361                 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
3362 /*!
3363  * \var lyx::FuncCode lyx::LFUN_COMPLETION_COMPLETE
3364  * \li Action: Try to complete the word or command at the cursor position.
3365  * \li Syntax: complete
3366  * \li Origin: sts, Feb 19 2008
3367  * \endvar
3368  */
3369                 { LFUN_COMPLETION_COMPLETE, "complete", SingleParUpdate, Edit },
3370
3371 /*!
3372  * \var lyx::FuncCode lyx::LFUN_COMPLETION_CANCEL
3373  * \li Action: Try to cancel completion, either the popup or the inline completion.
3374  * \li Syntax: completion-cancel
3375  * \li Origin: sts, Sep 07 2008
3376  * \endvar
3377  */
3378                 { LFUN_COMPLETION_CANCEL, "completion-cancel", SingleParUpdate, Edit },
3379 /*!
3380  * \var lyx::FuncCode lyx::LFUN_COMPLETION_ACCEPT
3381  * \li Action: Accept suggested completion.
3382  * \li Syntax: completion-accept
3383  * \li Origin: sanda, Sep 08 2008
3384  * \endvar
3385  */
3386                 { LFUN_COMPLETION_ACCEPT, "completion-accept", SingleParUpdate, Edit },
3387
3388
3389 /*!
3390  * \var lyx::FuncCode lyx::LFUN_BRANCH_ADD
3391  * \li Action: Add a branch to the buffer's BranchList.
3392  * \li Syntax: branch-add <BRANCH>
3393  * \li Params: <BRANCH>: Name of the branch to add
3394  * \li Origin: spitz, 7 Jul 2009
3395  * \endvar
3396  */
3397                 { LFUN_BRANCH_ADD, "branch-add", Noop, Buffer },
3398
3399
3400 /*!
3401  * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
3402  * \li Action: Activate the branch.
3403  * \li Syntax: branch-activate <BRANCH>
3404  * \li Params: <BRANCH>: The branch to activate
3405  * \li Sample: lyx -x "branch-activate answers" -e pdf2 finalexam.lyx \n
3406                could be used to export a pdf with the answers branch included
3407                without one's having to open LyX and activate the branch manually.
3408  * \li Origin: rgh, 27 May 2008
3409  * \endvar
3410  */
3411                 { LFUN_BRANCH_ACTIVATE, "branch-activate", AtPoint, Buffer },
3412 /*!
3413  * \var lyx::FuncCode lyx::LFUN_BRANCH_DEACTIVATE
3414  * \li Action: De-activate the branch.
3415  * \li Syntax: branch-deactivate <BRANCH>
3416  * \li Params: <BRANCH>: The branch to deactivate
3417  * \li Origin: rgh, 27 May 2008
3418  * \endvar
3419  */
3420                 { LFUN_BRANCH_DEACTIVATE, "branch-deactivate", AtPoint, Buffer },
3421
3422 /*!
3423  * \var lyx::FuncCode lyx::LFUN_BRANCHES_RENAME
3424  * \li Action: Rename all branches of a given name in a document.
3425  * \li Syntax: branches-rename <OLDNAME> <NEWNAME>
3426  * \li Params: <OLDNAME>: Current name of the branch to be renamed
3427  *             <NEWNAME>: New name of the branch
3428  * \li Origin: spitz, 9 Jul 2009
3429  * \endvar
3430  */
3431                 { LFUN_BRANCHES_RENAME, "branches-rename", Noop, Buffer },
3432 /*!
3433  * \var lyx::FuncCode lyx::LFUN_BRANCH_ADD_INSERT
3434  * \li Action: Create new branch and directly put the branch inset into
3435                the document.
3436  * \li Syntax: branch-add-insert [<NAME>]
3437  * \li Params: <NAME>: Branch name. If it is not specified, you will be asked.
3438  * \li Origin: sanda, 10 Jul 2009
3439  * \endvar
3440  */
3441                 { LFUN_BRANCH_ADD_INSERT, "branch-add-insert", Noop, Buffer },
3442
3443
3444 /*!
3445  * \var lyx::FuncCode lyx::LFUN_LABEL_COPY_AS_REF
3446  * \li Action: Copies the label at the cursor as a cross-reference to be pasted elsewhere.
3447  * \li Syntax: copy-label-as-reference <LABEL>
3448  * \li Params: <LABEL>: The label to copy (for multi-line math)
3449  * \li Origin: sts, 16 Nov 2008
3450  * \endvar
3451  */
3452                 { LFUN_LABEL_COPY_AS_REF, "copy-label-as-reference", ReadOnly | NoUpdate, Edit },
3453
3454 /*!
3455  * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT_AS_REF
3456  * \li Action: Inserts the label as a cross-reference at the position of the cursor.
3457  * \li Syntax: label-insert-as-reference
3458  * \li Origin: vfr, 7 Apr 2009
3459  * \endvar
3460  */
3461                 { LFUN_LABEL_INSERT_AS_REF, "label-insert-as-reference", Noop, Edit},
3462
3463 /*!
3464  * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_IN
3465  * \li Action: Increases the zoom of the screen fonts.
3466  * \li Syntax: buffer-zoom-in [<ZOOM>]
3467  * \li Params: <ZOOM>: The zoom in %, the default is 20.
3468  * \li Origin: vfr, 30 Mar 2009
3469  * \endvar
3470  */
3471                 { LFUN_BUFFER_ZOOM_IN, "buffer-zoom-in", ReadOnly, Buffer },
3472
3473 /*!
3474  * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_OUT
3475  * \li Action: Decreases the zoom of the screen fonts.
3476  * \li Syntax: buffer-zoom-out [<ZOOM>]
3477  * \li Params: <ZOOM>: The zoom in %, the default is 20.
3478  * \li Origin: vfr, 30 Mar 2009
3479  * \endvar
3480  */
3481                 { LFUN_BUFFER_ZOOM_OUT, "buffer-zoom-out", ReadOnly, Buffer },
3482
3483
3484
3485                 { LFUN_NOACTION, "", Noop, Hidden }
3486 #ifndef DOXYGEN_SHOULD_SKIP_THIS
3487         };
3488
3489         for (int i = 0; items[i].action != LFUN_NOACTION; ++i)
3490                 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
3491
3492         init = true;
3493 }
3494 #endif
3495
3496 LyXAction::LyXAction()
3497 {
3498         init();
3499 }
3500
3501
3502 FuncRequest LyXAction::lookupFunc(string const & func) const
3503 {
3504         string const func2 = trim(func);
3505
3506         if (func2.empty())
3507                 return FuncRequest(LFUN_NOACTION);
3508
3509         string cmd;
3510         string const arg = split(func2, cmd, ' ');
3511
3512         FuncMap::const_iterator const fit = lyx_func_map.find(cmd);
3513
3514         return fit != lyx_func_map.end() 
3515                         ? FuncRequest(fit->second, arg) 
3516                         : FuncRequest(LFUN_UNKNOWN_ACTION);
3517 }
3518
3519
3520 string const LyXAction::getActionName(FuncCode action) const
3521 {
3522         InfoMap::const_iterator const it = lyx_info_map.find(action);
3523         return it != lyx_info_map.end() ? it->second.name : string();
3524 }
3525
3526
3527 LyXAction::FuncType LyXAction::getActionType(FuncCode action) const
3528 {
3529         InfoMap::const_iterator const it = lyx_info_map.find(action);
3530         return it != lyx_info_map.end() ? it->second.type : Hidden;
3531 }
3532
3533
3534 bool LyXAction::funcHasFlag(FuncCode action,
3535                             LyXAction::FuncAttribs flag) const
3536 {
3537         InfoMap::const_iterator ici = lyx_info_map.find(action);
3538
3539         if (ici == lyx_info_map.end()) {
3540                 LYXERR0("action: " << action << " is not known.");
3541                 LASSERT(false, /**/);
3542         }
3543
3544         return ici->second.attrib & flag;
3545 }
3546
3547
3548 LyXAction::const_iterator LyXAction::func_begin() const
3549 {
3550         return lyx_func_map.begin();
3551 }
3552
3553
3554 LyXAction::const_iterator LyXAction::func_end() const
3555 {
3556         return lyx_func_map.end();
3557 }
3558
3559
3560 LyXErr & operator<<(LyXErr & l, FuncCode code)
3561 {
3562         if (l.enabled())
3563                 l.stream() << lyxaction.getActionName(code);
3564         return l;
3565 }
3566
3567 } // namespace lyx