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