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