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