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