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