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