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