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