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