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