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