]> git.lyx.org Git - lyx.git/blob - src/LyXAction.cpp
* Doxy.
[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                For dissolving the element see #LFUN_INSET_DISSOLVE.
413  * \li Syntax: flex-insert <TYPE:Name>
414  * \li Params: TYPE: CharStyle|Custom|Element|Standard
415                      Identifies whether this is a Character Style, a
416                      Custom Inset or an XML Element, and which dynamical 
417                      sub-menu this flex inset is in on the LyX menu tree. 
418                      If Standard (currently unused): none of these.
419                Name: This name must be defined either in your layout file
420                      or imported by some module. The definition is\n
421                      InsetLayout <TYPE:Name>
422  * \li Sample: flex-insert CharStyle:Code
423  * \endvar
424  */
425                 { LFUN_FLEX_INSERT, "flex-insert", Noop, Edit },
426 /*!
427  * \var lyx::FuncCode lyx::LFUN_SELF_INSERT
428  * \li Action: Inserts the given string (accordingly to the correct keymap).
429  * \li Notion: Automatically replace the currently selected text. Depends on lyxrc
430                settings "auto_region_delete".
431  * \li Syntax: self-insert <STRING>
432  * \endvar
433  */
434                 { LFUN_SELF_INSERT, "self-insert", SingleParUpdate, Hidden },
435 /*!
436  * \var lyx::FuncCode lyx::LFUN_SPACE_INSERT
437  * \li Action: Inserts one of horizontal space insets.
438  * \li Syntax: space-insert <NAME> [<LEN>]
439  * \li Params: <NAME>: normal, protected, thin, quad, qquad, enspace, enskip,
440                        negthinspace, hfill, hfill*, dotfill, hrulefill, hspace,
441                        hspace* \n
442                <LEN>: length for custom spaces (hspace, hspace* for protected)
443  * \li Origin: JSpitzm, 20 May 2003, Mar 17 2008
444  * \endvar
445  */
446                 { LFUN_SPACE_INSERT, "space-insert", Noop, Edit },
447 /*!
448  * \var lyx::FuncCode lyx::LFUN_HYPERLINK_INSERT
449  * \li Action: Inserts hyperlinks into the document (clickable in pdf output).
450  * \li Notion: Hyperlink target can be set via selection + hyperlink-insert function.
451  * \li Syntax: href-insert [<TARGET>]
452  * \li Origin: CFO-G, 21 Nov 1997
453  * \endvar
454  */
455                 { LFUN_HYPERLINK_INSERT, "href-insert", Noop, Edit },
456 /*!
457  * \var lyx::FuncCode lyx::LFUN_SPECIALCHAR_INSERT
458  * \li Action: Inserts various characters into the document.
459  * \li Syntax: specialchar-insert <CHAR>
460  * \li Params: <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots,
461                        end-of-sentence, menu-separator.
462  * \li Origin: JSpitzm, 6 Dec 2007
463  * \endvar
464  */
465                 { LFUN_SPECIALCHAR_INSERT, "specialchar-insert", Noop, Edit },
466 /*!
467  * \var lyx::FuncCode lyx::LFUN_TOC_INSERT
468  * \li Action: Inserts table of contents.
469  * \li Syntax: toc-insert
470  * \li Origin: Lgb, 27 May 97
471  * \endvar
472  */
473                 { LFUN_TOC_INSERT, "toc-insert", Noop, Edit },
474 /*!
475  * \var lyx::FuncCode lyx::LFUN_APPENDIX
476  * \li Action: Start (or remove) Appendix on the given cursor position.
477  * \li Syntax: appendix
478  * \li Origin: ettrich, 5 May 1998
479  * \endvar
480  */
481                 { LFUN_APPENDIX, "appendix", Noop, Edit },
482
483 /*!
484  * \var lyx::FuncCode lyx::LFUN_INDEX_INSERT
485  * \li Action: Inserts Index entry.
486  * \li Notion: It automatically takes the word on the cursor position.
487  * \li Syntax: index-insert
488  * \li Origin: Angus, 3 Aug 2000
489  * \endvar
490  */
491                 { LFUN_INDEX_INSERT, "index-insert", Noop, Edit },
492 /*!
493  * \var lyx::FuncCode lyx::LFUN_INDEX_PRINT
494  * \li Action: Inserts list of Index entries on a new page.
495  * \li Syntax: index-print
496  * \li Origin: Lgb, 27 Feb 1997
497  * \endvar
498  */
499                 { LFUN_INDEX_PRINT, "index-print", Noop, Edit },
500
501 /*!
502  * \var lyx::FuncCode lyx::LFUN_NOMENCL_INSERT
503  * \li Action: Inserts Nomenclature entry.
504  * \li Notion: It automatically takes the word on the cursor position if no symbol is given.
505  * \li Syntax: nomencl-insert [<SYMBOL>]
506  * \li Origin: Ugras, 4 Nov 2006
507  * \endvar
508  */
509                 { LFUN_NOMENCL_INSERT, "nomencl-insert", Noop, Edit },
510 /*!
511  * \var lyx::FuncCode lyx::LFUN_NOMENCLATURE_PRINT
512  * \li Action: Inserts list of Nomenclature entries.
513  * \li Syntax: nomenclature-print
514  * \li Origin: Ugras, 4 Nov 2006
515  * \endvar
516  */
517                 { LFUN_NOMENCL_PRINT, "nomencl-print", Noop, Edit },
518
519 /*!
520  * \var lyx::FuncCode lyx::LFUN_NOTE_INSERT
521  * \li Action: Inserts Note on the current cursor postion,
522                move selection inside the inset.
523  * \li Syntax: note-insert [<TYPE>]
524  * \li Params: <TYPE>: <Note|Greyedout|Comment> default: Note
525  * \endvar
526  */
527                 { LFUN_NOTE_INSERT, "note-insert", Noop, Edit },
528 /*!
529  * \var lyx::FuncCode lyx::LFUN_NOTE_NEXT
530  * \li Action: Moves the cursor to the begining of next Note inset.
531  * \li Syntax: note-next
532  * \endvar
533  */
534                 { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
535 /*!
536  * \var lyx::FuncCode lyx::LFUN_NEWLINE_INSERT
537  * \li Action: Inserts a line break or new line.
538  * \li Syntax: newline-insert [<ARG>]
539  * \li Params: <ARG>: <newline|linebreak> default: newline
540  * \li Origin: JSpitzm, 25 Mar 2008
541  * \endvar
542  */
543                 { LFUN_NEWLINE_INSERT, "newline-insert", Noop, Edit },
544
545 /*!
546  * \var lyx::FuncCode lyx::LFUN_ESCAPE
547  * \li Action: Clears the selection. If no text is selected call #LFUN_FINISHED_FORWARD.
548  * \li Syntax: escape
549  * \li Origin: Lgb, 17 May 2001
550  * \endvar
551  */
552                 { LFUN_ESCAPE, "escape", ReadOnly, Edit },
553 /*!
554  * \var lyx::FuncCode lyx::LFUN_DOWN
555  * \li Action: Moves the cursor one line in downward direction.
556  * \li Syntax: down
557  * \endvar
558  */
559                 { LFUN_DOWN, "down", ReadOnly | NoUpdate, Edit },
560 /*!
561  * \var lyx::FuncCode lyx::LFUN_UP
562  * \li Action: Moves the cursor one line in upward direction.
563  * \li Syntax: up
564  * \endvar
565  */
566                 { LFUN_UP, "up", ReadOnly | NoUpdate, Edit },
567 /*!
568  * \var lyx::FuncCode lyx::LFUN_DOWN_SELECT
569  * \li Action: Moves the cursor one line in downward direction adding the current
570                position to the selection.
571  * \li Syntax: down-select
572  * \endvar
573  */
574                 { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, Edit },
575 /*!
576  * \var lyx::FuncCode lyx::LFUN_UP_SELECT
577  * \li Action: Moves the cursor one line in upward direction adding the current
578                position to the selection.
579  * \li Syntax: up-select
580  * \endvar
581  */
582                 { LFUN_UP_SELECT, "up-select", ReadOnly | SingleParUpdate, Edit },
583 /*!
584  * \var lyx::FuncCode lyx::SCREEN_DOWN
585  * \li Action: Moves the cursor one page in downward direction.
586  * \li Syntax: screen-down
587  * \endvar
588  */
589                 { LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit },
590 /*!
591  * \var lyx::FuncCode lyx::LFUN_SCREEN_UP
592  * \li Action: Moves the cursor one page in upward direction.
593  * \li Syntax: screen-up
594  * \endvar
595  */
596                 { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit },
597 /*!
598  * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN_SELECT
599  * \li Action: Moves the cursor one screen in downward direction adding the current
600                position to the selection.
601  * \li Syntax: screen-down-select
602  * \endvar
603  */
604                 { LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit },
605 /*!
606  * \var lyx::FuncCode lyx::LFUN_SCREEN_UP_SELECT
607  * \li Action: Moves the cursor one page in upward direction adding the current
608                position to the selection.
609  * \li Syntax: screen-up-select
610  * \endvar
611  */
612                 { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit },
613 /*!
614  * \var lyx::FuncCode lyx::LFUN_SCROLL
615  * \li Action: Scroll the buffer view.
616  * \li Notion: Only scrolls the screen up or down; does not move the cursor.
617  * \li Syntax: scroll <TYPE> <QUANTITY>
618  * \li Params: <TYPE>:  line|page\n
619                <QUANTITY>: up|down|<number>
620  * \li Origin: Abdelrazak Younes, Dec 27 2007
621  * \endvar
622  */
623                 { LFUN_SCROLL, "scroll", ReadOnly, Edit },
624 /*!
625  * \var lyx::FuncCode lyx::LFUN_SCREEN_RECENTER
626  * \li Action: Recenters the screen on the current cursor position.
627  * \li Syntax: screen-recenter
628  * \endvar
629  */
630                 { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit },
631
632 /*!
633  * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD
634  * \li Action: Moves the cursor one position logically backwards.
635  * \li Notion: This is not the action which should be bound to the arrow keys,
636                because backwards may be left or right, depending on the
637                language. The arrow keys should be bound to #LFUN_CHAR_LEFT or
638                #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
639  * \li Syntax: char-backward
640  * \endvar
641  */
642                 { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit },
643 /*!
644  * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD_SELECT
645  * \li Action: Moves the cursor one position logically backwards, adding
646                traversed position to the selection.
647  * \li Notion: See also #LFUN_CHAR_BACKWARD.
648  * \li Syntax: char-backward-select
649  * \endvar
650  */
651                 { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit },
652 /*!
653  * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_BACKWARD
654  * \li Action: Deletes one character in the backward direction (usually the "BackSpace" key).
655  * \li Syntax: char-delete-backward
656  * \endvar
657  */
658                 { LFUN_CHAR_DELETE_BACKWARD, "char-delete-backward", SingleParUpdate, Edit },
659 /*!
660  * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_FORWARD
661  * \li Action: Deletes one character in the backward direction (usually the "Delete" key).
662  * \li Syntax: char-delete-forward
663  * \endvar
664  */
665                 { LFUN_CHAR_DELETE_FORWARD, "char-delete-forward", SingleParUpdate, Edit },
666 /*!
667  * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD
668  * \li Action: Moves the cursor one position logically forward.
669  * \li Notion: This is not the action which should be bound to the arrow keys,
670                because forward may be left or right, depending on the language.
671                The arrow keys should be bound to #LFUN_CHAR_LEFT or
672                #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
673  * \li Syntax: char-forward
674  * \endvar
675  */
676                 { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit },
677 /*!
678  * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD_SELECT
679  * \li Action: Moves the cursor one position logically forward, adding
680                traversed position to the selection.
681  * \li Notion: See also #LFUN_CHAR_FORWARD.
682  * \li Syntax: char-forward-select
683  * \endvar
684  */
685                 { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit },
686 /*!
687  * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT
688  * \li Action: Moves the cursor one position "to the left".
689  * \li Notion: This is the action which should be taken when the "left" key
690                is pressed. Generally, it moves the cursor one position to the
691                left. However, in Bidi text this become slightly more
692                complicated, and there are different modes of cursor movement.
693                In "visual mode", this moves left, plain and simple. In "logical
694                mode", movement is logically forward in RTL paragraphs, and
695                logically backwards in LTR paragraphs.
696  * \li Syntax: char-left
697  * \endvar
698  */
699                 { LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit },
700 /*!
701  * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT_SELECT
702  * \li Action: Moves the cursor one position "to the left", adding 
703                traversed position to the selection.
704  * \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement.
705  * \li Syntax: char-left-select
706  * \endvar
707  */
708                 { LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit },
709 /*!
710  * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT
711  * \li Action: Moves the cursor one position "to the right".
712  * \li Notion: This is the action which should be taken when the "right" key
713                is pressed. Generally, it moves the cursor one position to the
714                right. However, in Bidi text this become slightly more
715                complicated, and there are different modes of cursor movement.
716                In "visual mode", this moves right, plain and simple. In "logical
717                mode", movement is logically forward in LTR paragraphs, and
718                logically backwards in RTL paragraphs.
719  * \li Syntax: char-right
720  * \endvar
721  */
722                 { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit },
723 /*!
724  * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT_SELECT
725  * \li Action: Moves the cursor one position "to the right", adding
726                traversed position to the selection.
727  * \li Notion: See also #LFUN_CHAR_RIGHT for exact details of the movement.
728  * \li Syntax: char-right-select
729  * \endvar
730  */
731                 { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit },
732
733 /*!
734  * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD
735  * \li Action: Moves the cursor to the logically previous beginning of a word.
736  * \li Notion: This is not the action which should be bound to the arrow keys,
737                because backwards may be left or right, depending on the
738                language. The arrow keys should be bound to #LFUN_WORD_LEFT or
739                #LFUN_WORD_RIGHT actions, which in turn may employ this one.
740  * \li Syntax: word-backward
741  * \endvar
742  */
743                 { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit },
744 /*!
745  * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD_SELECT
746  * \li Action: Moves the cursor to the logically previous beginning of a word,
747                            adding the logically traversed text to the selection.
748  * \li Notion: See also #LFUN_WORD_BACKWARD.
749  * \li Syntax: word-backward-select
750  * \endvar
751  */
752                 { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
753 /*!
754  * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_BACKWARD
755  * \li Action: Deletes characters to the begining of the word (usually the "C+BackSpace" key).
756  * \li Syntax: word-delete-backward
757  * \endvar
758  */
759                 { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
760 /*!
761  * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_FORWARD
762  * \li Action: Deletes characters to the end of the word (usually the "C+Delete" key).
763  * \li Syntax: word-delete-forward
764  * \endvar
765  */
766                 { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
767 /*!
768  * \var lyx::FuncCode lyx::LFUN_WORD_FIND_FORWARD
769  * \li Action: Search for a given string in forward direction.
770  * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
771  * \li Syntax: word-find-forward [<STRING>]
772  * \li Origin: Etienne, 16 Feb 1998
773  * \endvar
774  */
775                 { LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit },
776 /*!
777  * \var lyx::FuncCode lyx::LFUN_WORD_FIND_BACKWARD
778  * \li Action: Search for a given string in backward direction.
779  * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
780  * \li Syntax: word-find-backward [<STRING>]
781  * \li Origin: Etienne, 20 Feb 1998
782  * \endvar
783  */
784                 { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
785 /*!
786  * \var lyx::FuncCode lyx::LFUN_WORD_FIND
787  * \li Action: Search for next occurence of a string.
788  * \li Syntax: word-find [<DATA>]
789  * \li Params: <DATA>: data encoded from Find dialog (see #lyx::find2string()).
790                        If no parameter is given, search with last find-dialog
791                        data is used for search (i.e. find-next).
792  * \li Origin: poenitz, Jan 7 2004
793  * \endvar
794  */
795                 { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
796 /*!
797  * \var lyx::FuncCode lyx::LFUN_WORD_FIND
798  * \li Action: Replace a string in the document.
799  * \li Syntax: word-replace [<DATA>]
800  * \li Params: <DATA>: data is of the form
801                        "<search> \n
802                         <replace> \n
803                         <casesensitive> <matchword> <all> <forward>"
804  * \li Origin: poenitz, Jan 7 2004
805  * \endvar
806  */
807                 { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
808 /*!
809  * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD
810  * \li Action: Moves the cursor to the logically next beginning of a word.
811  * \li Notion: This is not the action which should be bound to the arrow keys,
812                because forward may be left or right, depending on the language.
813                The arrow keys should be bound to #LFUN_WORD_LEFT or
814                #LFUN_WORD_RIGHT actions, which in turn may employ this one.
815  * \li Syntax: word-forward
816  * \endvar
817  */
818                 { LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
819 /*!
820  * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD_SELECT
821  * \li Action: Moves the cursor to the logically next beginning of a word, 
822                            adding the logically traversed text to the selection.
823  * \li Notion: See also #LFUN_WORD_FORWARD.
824  * \li Syntax: word-forward-select
825  * \endvar
826  */
827                 { LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
828 /*!
829  * \var lyx::FuncCode lyx::LFUN_WORD_LEFT
830  * \li Action: Moves the cursor to the next beginning of a word "on the left".
831  * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
832                            "left" key is pressed. Generally, it moves the cursor to the 
833                            next beginning of a word on the left. However, in Bidi text this 
834                            become slightly more complicated, and there are different modes
835                            of cursor movement. In "visual mode", this moves left, plain and
836                            simple. In "logical mode", movement is logically forward in RTL
837                            paragraphs, and logically backwards in LTR paragraphs.
838  * \li Syntax: word-left
839  * \li Origin: dov, 28 Oct 2007
840  * \endvar
841  */
842                 { LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
843 /*!
844  * \var lyx::FuncCode lyx::LFUN_WORD_LEFT_SELECT
845  * \li Action: Moves the cursor to the next beginning of a word "on the left",
846                            adding *logically* traversed text to the selection.
847  * \li Notion: See also #LFUN_WORD_LEFT for exact details of the movement.
848  * \li Syntax: word-left-select
849  * \li Origin: dov, 28 Oct 2007
850  * \endvar
851  */
852                 { LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit },
853 /*!
854  * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT
855  * \li Action: Moves the cursor to the next beginning of a word "on the right".
856  * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
857                            "right" key is pressed. Generally, it moves the cursor to the 
858                            next beginning of a word on the right. However, in Bidi text 
859                            this become slightly more complicated, and there are different
860                            modes of cursor movement. In "visual mode", this moves right,
861                            plain and simple. In "logical mode", movement is logically 
862                            forward in LTR paragraphs, and logically backwards in RTL 
863                            paragraphs.
864  * \li Syntax: word-right
865  * \li Origin: dov, 28 Oct 2007
866  * \endvar
867  */
868                 { LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit },
869 /*!
870  * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT_SELECT
871  * \li Action: Moves the cursor to the next beginning of a word "on the right",
872                            adding *logically* traversed text to the selection.
873  * \li Notion: See also #LFUN_WORD_RIGHT for exact details of the movement.
874  * \li Syntax: word-right-select
875  * \li Origin: dov, 28 Oct 2007
876  * \endvar
877  */
878                 { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
879 /*!
880  * \var lyx::FuncCode lyx::LFUN_WORD_SELECT
881  * \li Action: Puts the word where the cursor stands into the selection.
882  * \li Syntax: word-select
883  * \li Author: Andre, 11 Sep 2002
884  * \endvar
885  */
886                 { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
887 /*!
888  * \var lyx::FuncCode lyx::LFUN_WORD_CAPITALIZE
889  * \li Action: Capitalizes the words in the selection (i.e. the first letters)
890                or the letter on the cursor position.
891  * \li Syntax: word-capitalize
892  * \endvar
893  */
894                 { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
895 /*!
896  * \var lyx::FuncCode lyx::LFUN_WORD_UPCASE
897  * \li Action: Change the words in the selection or from the cursor position
898                to the end of word to the upper case.
899  * \li Syntax: word-upcase
900  * \endvar
901  */
902                 { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
903 /*!
904  * \var lyx::FuncCode lyx::LFUN_WORD_LOWCASE
905  * \li Action: Change the words in the selection or from the cursor position
906                to the end of word to the lower case.
907  * \li Syntax: word-lowcase
908  * \endvar
909  */
910                 { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
911 /*!
912  * \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
913  * \li Action: Look up thesaurus entries with respect to the word under the cursor.
914  * \li Syntax: thesaurus-entry
915  * \li Origin: Levon, 20 Jul 2001
916  * \endvar
917  */
918                 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
919                 { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
920                 { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
921                 { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
922                 { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
923
924                 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
925                 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
926                 { LFUN_LINE_DELETE, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
927                 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
928                 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
929 /*!
930  * \var lyx::FuncCode lyx::LFUN_COPY
931  * \li Action: Copies to the clipboard the last edit.
932  * \li Syntax: copy
933  * \endvar
934  */
935                 { LFUN_COPY, "copy", ReadOnly, Edit },
936 /*!
937  * \var lyx::FuncCode lyx::LFUN_CUT
938  * \li Action: Cuts to the clipboard.
939  * \li Syntax: cut
940  * \endvar
941  */
942                 { LFUN_CUT, "cut", Noop, Edit },
943 /*!
944  * \var lyx::FuncCode lyx::LFUN_PASTE
945  * \li Action: Pastes from the active clipboard.
946  * \li Syntax: paste
947  * \endvar
948  */
949                 { LFUN_PASTE, "paste", Noop, Edit },
950                 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
951 /*!
952  * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
953  * \li Action: Pastes the material currently selected.
954  * \li Syntax: primary-selection-paste
955  * \endvar
956  */
957                 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
958 /*!
959  * \var lyx::FuncCode lyx::LFUN_UNDO
960  * \li Action: Undoes the last edit.
961  * \li Syntax: undo
962  * \endvar
963  */
964                 { LFUN_UNDO, "undo", Noop, Edit },
965 /*!
966  * \var lyx::FuncCode lyx::LFUN_REDO
967  * \li Action: Redoes the last thing undone.
968  * \li Syntax: redo
969  * \endvar
970  */
971                 { LFUN_REDO, "redo", Noop, Edit },
972 /*!
973  * \var lyx::FuncCode lyx::LFUN_REPEAT
974  * \li Action: Repeat the given command.
975  * \li Syntax: repeat <COUNT> <LFUN-COMMAND>
976  * \li Author: poenitz, 27 Oct 2003
977  * \endvar
978  */
979                 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
980 /*!
981  * \var lyx::FuncCode lyx::LFUN_CHARS_TRANSPOSE
982  * \li Action: Transposes the character at the cursor with the one before it.
983  * \li Syntax: chars-transpose
984  * \li Author: Lgb, 25 Apr 2001
985  * \endvar
986  */
987                 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
988
989                 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
990                 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
991                 { LFUN_ENVIRONMENT_INSERT, "environment-insert", Noop, Edit },
992
993 /*!
994  * \var lyx::FuncCode lyx::LFUN_FONT_BOLD
995  * \li Action: Toggles the bold font (selection-wise).
996  * \li Syntax: font-bold
997  * \endvar
998  */
999                 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
1000 /*!
1001  * \var lyx::FuncCode lyx::LFUN_FONT_TYPEWRITER
1002  * \li Action: Toggles the typewriter family font (selection-wise).
1003  * \li Syntax: font-typewriter
1004  * \endvar
1005  */
1006                 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
1007 /*!
1008  * \var lyx::FuncCode lyx::LFUN_FONT_UNDERLINE
1009  * \li Action: Toggles underline in the font (selection-wise).
1010  * \li Syntax: font-underline
1011  * \endvar
1012  */
1013                 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
1014 /*!
1015  * \var lyx::FuncCode lyx::LFUN_FONT_EMPH
1016  * \li Action: Toggles the emphasis font style (selection-wise).
1017  * \li Syntax: font-emph
1018  * \endvar
1019  */
1020                 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
1021 /*!
1022  * \var lyx::FuncCode lyx::LFUN_FONT_NOUN
1023  * \li Action: Toggles Noun text style font (selection-wise).
1024  * \li Syntax: font-noun
1025  * \endvar
1026  */
1027                 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
1028 /*!
1029  * \var lyx::FuncCode lyx::LFUN_FONT_ROMAN
1030  * \li Action: Toggles Roman family font (selection-wise).
1031  * \li Syntax: font-roman
1032  * \endvar
1033  */
1034                 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
1035 /*!
1036  * \var lyx::FuncCode lyx::LFUN_FONT_SANS
1037  * \li Action: Toggles Sans Serif family font (selection-wise).
1038  * \li Syntax: font-sans
1039  * \endvar
1040  */
1041                 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
1042 /*!
1043  * \var lyx::FuncCode lyx::LFUN_FONT_FRAK
1044  * \li Action: Toggles Fraktur family font (math-mode, selection-wise).
1045  * \li Syntax: font-frak
1046  * \li Origin: vermeer, 10 Jan 2002
1047  * \endvar
1048  */
1049                 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
1050 /*!
1051  * \var lyx::FuncCode lyx::LFUN_FONT_ITAL
1052  * \li Action: Toggles Italics font shape (math-mode, selection-wise).
1053  * \li Syntax: font-ital
1054  * \li Origin: vermeer, 10 Jan 2002
1055  * \endvar
1056  */
1057                 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
1058 /*!
1059  * \var lyx::FuncCode lyx::LFUN_FONT_DEFAULT
1060  * \li Action: Reverts the settings of the font to the default values (selection-wise).
1061  * \li Syntax: font-default
1062  * \endvar
1063  */
1064                 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
1065                 { LFUN_FONT_FREE_APPLY, "font-free-apply", Noop, Layout },
1066                 { LFUN_FONT_FREE_UPDATE, "font-free-update", Noop, Layout },
1067                 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
1068                 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
1069 /*!
1070  * \var lyx::FuncCode lyx::LFUN_FONT_STATE
1071  * \li Action: Returns the info about the current font.
1072  * \li Syntax: font-state
1073  * \endvar
1074  */
1075                 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
1076
1077                 { LFUN_BIBITEM_INSERT, "bibitem-insert", Noop, Edit },
1078                 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
1079                 { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit },
1080                 { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
1081
1082 /*!
1083  * \var lyx::FuncCode lyx::LFUN_LAYOUT
1084  * \li Action: Sets the layout (that is, environment) for the current paragraph.
1085  * \li Syntax: layout <LAYOUT>
1086  * \li Params: <LAYOUT>: the layout to use
1087  * \endvar
1088  */
1089                 { LFUN_LAYOUT, "layout", Noop, Layout },
1090 /*!
1091  * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH
1092  * \li Action: Launches the paragraph settings dialog.
1093  * \li Syntax: layout-paragraph
1094  * \endvar
1095  */
1096                 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
1097 /*!
1098  * \var lyx::FuncCode lyx::LFUN_LAYOUT_TABULAR
1099  * \li Action: Launches the tabular settings dialog.
1100  * \li Syntax: layout-tabular
1101  * \li Origin: Jug, 31 Jul 2000
1102  * \endvar
1103  */
1104                 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
1105 /*!
1106  * \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE
1107  * \li Action: Displays list of layout choices.
1108  * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
1109                dropbox allowing for choice of layout.
1110  * \li Syntax: drop-layouts-choice
1111  * \endvar
1112  */
1113                 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
1114 /*!
1115  * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
1116  * \li Action: Clears the module list.
1117  * \li Notion: Clears the list of included modules for the current buffer.
1118  * \li Syntax: layout-modules-clear
1119  * \li Origin: rgh, 25 August 2007
1120  * \endvar
1121  */
1122                 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", Noop, Layout },
1123 /*!
1124  * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULE_ADD
1125  * \li Action: Adds a module.
1126  * \li Notion: Adds a module to the list of included modules for the current buffer.
1127  * \li Syntax: layout-module-add <MODULE>
1128  * \li Params: <MODULE>: the module to be added
1129  * \li Origin: rgh, 25 August 2007
1130  * \endvar
1131  */
1132                 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", Noop, Layout },
1133 /*!
1134  * \var lyx::FuncCode lyx::LFUN_LAYOUT_RELOAD
1135  * \li Action: Reloads layout information.
1136  * \li Notion: Reloads all layout information for the current buffer from disk, thus
1137                recognizing any changes that have been made to layout files on the fly.
1138                This is intended to be used only by layout developers and should not be
1139                used when one is trying to do actual work.
1140  * \li Syntax: layout-reload
1141  * \li Origin: rgh, 3 September 2007
1142  * \endvar
1143  */
1144                 { LFUN_LAYOUT_RELOAD, "layout-reload", Noop, Layout },
1145 /*!
1146  * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
1147  * \li Action: Sets the text class for the current buffer.
1148  * \li Syntax: textclass-apply <TEXTCLASS>
1149  * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
1150                    the filename, minus the ".layout" extension.
1151  * \endvar
1152  */
1153                 { LFUN_TEXTCLASS_APPLY, "textclass-apply", Noop, Layout },
1154 /*!
1155  * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
1156  * \li Action: Loads information for a textclass from disk.
1157  * \li Syntax: textclass-load <TEXTCLASS>
1158  * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
1159                    the filename, minus the ".layout" extension.
1160  * \endvar
1161  */
1162                 { LFUN_TEXTCLASS_LOAD, "textclass-load", Noop, Layout },
1163
1164 /*!
1165  * \var lyx::FuncCode lyx::LFUN_MARK_OFF
1166  * \li Action: Disable selecting of text-region.
1167  * \li Syntax: mark-off
1168  * \endvar
1169  */
1170                 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
1171 /*!
1172  * \var lyx::FuncCode lyx::LFUN_MARK_ON
1173  * \li Action: Enable selecting of text-region.
1174  * \li Notion: After enabling you can simply move arrow keys to get selected region.
1175  * \li Syntax: mark-on
1176  * \endvar
1177  */
1178                 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
1179 /*!
1180  * \var lyx::FuncCode lyx::LFUN_MARK_TOGGLE
1181  * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
1182  * \li Syntax: mark-toggle
1183  * \li Origin: poenitz, May 5 2006
1184  * \endvar
1185  */
1186                 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
1187                 
1188                 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
1189                 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
1190                 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
1191                 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
1192                 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
1193                 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
1194                 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
1195                 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
1196                 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
1197                 { LFUN_MATH_SPACE, "math-space", Noop, Math },
1198                 { LFUN_MATH_IMPORT_SELECTION, "math-import-selection", Noop, Math },
1199                 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
1200                 { LFUN_MATH_MODE, "math-mode", Noop, Math },
1201 /*!
1202  * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
1203  * \li Action: Toggles numbering of the current formula line.
1204  * \li Notion: Must be in display formula mode.
1205  * \li Syntax: math-number-line-toggle
1206  * \li Origin: Alejandro 18 Jun 1996
1207  * \endvar
1208  */
1209                 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
1210 /*!
1211  * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
1212  * \li Action: Toggles numbering/labeling of the current formula.
1213  * \li Notion: Must be in display formula mode.
1214  * \li Syntax: math-number-toggle
1215  * \li Origin: Alejandro 4 Jun 1996
1216  * \endvar
1217  */
1218                 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
1219                 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
1220                 { LFUN_MATH_SIZE, "math-size", Noop, Math },
1221 /*!
1222  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
1223  * \li Action: Unfold a Math Macro.
1224  * \li Notion: Unfold the Math Macro the cursor is in, i.e.
1225                display it as \foo.
1226  * \li Syntax: math-macro-unfold
1227  * \li Origin: sts, 06 January 2008
1228  * \endvar
1229  */
1230                 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
1231 /*!
1232  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
1233  * \li Action: Fold a Math Macro.
1234  * \li Notion: Fold the Math Macro the cursor is in if it was
1235                unfolded, i.e. displayed as \foo before.
1236  * \li Syntax: math-macro-fold
1237  * \li Origin: sts, 06 January 2008
1238  * \endvar
1239  */
1240                 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
1241 /*!
1242  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
1243  * \li Action: Add a parameter.
1244  * \li Notion: Add a parameter to a Math Macro.
1245  * \li Params: <NUM>: The number of the parameter behind which the new one
1246                will be added (1 for the first, i.e. use 0 for add a
1247                parameter at the left), defaults to the last one.
1248  * \li Syntax: math-macro-add-param <NUM>
1249  * \li Origin: sts, 06 January 2008
1250  * \endvar
1251  */
1252                 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
1253 /*!
1254  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
1255  * \li Action: Remove the last parameter.
1256  * \li Notion: Remove the last parameter of a Math Macro and
1257                remove its value in all instances of the macro
1258                in the buffer.
1259  * \li Params: <NUM>: The number of the parameter to be deleted (1 for
1260                the first), defaults to the last one.
1261  * \li Syntax: math-macro-remove-param <NUM>
1262  * \li Origin: sts, 06 January 2008
1263  * \endvar
1264  */
1265                 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
1266 /*!
1267  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
1268  * \li Action: Append a greedy parameter.
1269  * \li Notion: Append a greedy parameter to a Math Macro which
1270                eats the following mathed cell in every instance of
1271                the macro in the buffer.
1272  * \li Syntax: math-macro-append-greedy-param
1273  * \li Origin: sts, 06 January 2008
1274  * \endvar
1275  */
1276                 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
1277 /*!
1278  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
1279  * \li Action: Remove a greedy parameter.
1280  * \li Notion: Remove a greedy parameter of a Math Macro and spit
1281                out the values of it in every instance of the macro
1282                in the buffer. If it is an optional parameter the [valud]
1283                format is used.
1284  * \li Syntax: math-macro-remove-greedy-param
1285  * \li Origin: sts, 06 January 2008
1286  * \endvar
1287  */
1288                 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
1289 /*!
1290  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
1291  * \li Action: Make a parameter optional.
1292  * \li Notion: Turn the first non-optional parameter of a Math Macro
1293                into an optional parameter with a default value.
1294  * \li Syntax: math-macro-make-optional
1295  * \li Origin: sts, 06 January 2008
1296  * \endvar
1297  */
1298                 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
1299 /*!
1300  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
1301  * \li Action: Make a parameter non-optional.
1302  * \li Notion: Turn the last optional parameter of a Math Macro
1303                into a non-optional parameter. The default value is
1304                remembered to be reused later if the user changes his mind.
1305  * \li Syntax: math-macro-make-nonoptional
1306  * \li Origin: sts, 06 January 2008
1307  * \endvar
1308  */
1309                 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
1310 /*!
1311  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
1312  * \li Action: Add an optional parameter.
1313  * \li Notion: Insert an optional parameter just behind the
1314                already existing optional parameters.
1315  * \li Syntax: math-macro-add-optional-param
1316  * \li Origin: sts, 06 January 2008
1317  * \endvar
1318  */
1319                 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
1320 /*!
1321  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
1322  * \li Action: Remove the last optional parameter.
1323  * \li Notion: Remove the last optional parameter of a Math Macro and
1324                remove it in all the instances of the macro in the buffer.
1325  * \li Syntax: math-macro-remove-optional-param
1326  * \li Origin: sts, 06 January 2008
1327  * \endvar
1328  */
1329                 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
1330 /*!
1331  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
1332  * \li Action: Add a greedy optional parameter.
1333  * \li Notion: Add a greedy optional parameter which eats the value
1334                from the following cells in mathed which are in the [value]
1335                format.
1336  * \li Syntax: math-macro-add-greedy-optional-param
1337  * \li Origin: sts, 06 January 2008
1338  * \endvar
1339  */
1340                 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
1341 /*!
1342  * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
1343  * \li Action: Only active in Math Macro definition.
1344  * \li Notion: Dummy function which is only active in a Math Macro definition.
1345                It's used to toggle the Math Macro toolbar if the cursor moves
1346                into a Math Macro definition.
1347  * \li Syntax: in-mathmacrotemplate
1348  * \li Origin: sts, 06 January 2008
1349  * \endvar
1350  */
1351                 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
1352
1353 /*!
1354  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
1355  * \li Action: Moves the current paragraph downwards in the document.
1356  * \li Syntax: paragraph-move-down
1357  * \li Origin: Edwin, 8 Apr 2006
1358  * \endvar
1359  */
1360                 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
1361 /*!
1362  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
1363  * \li Action: Moves the current paragraph upwards in the document.
1364  * \li Syntax: paragraph-move-up
1365  * \li Origin: Edwin, 8 Apr 2006
1366  * \endvar
1367  */
1368                 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
1369
1370 /*!
1371  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP
1372  * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1373                in upward direction.
1374  * \li Syntax: paragraph-up
1375  * \li Origin: Asger, 1 Oct 1996
1376  * \endvar
1377  */
1378                 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
1379 /*!
1380  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP_SELECT
1381  * \li Action: Move the cursor and select the text to the next paragraph (or
1382                begining of the current one) in upward direction.
1383  * \li Syntax: paragraph-up-select
1384  * \li Origin: Asger, 1 Oct 1996
1385  * \endvar
1386  */
1387                 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
1388 /*!
1389  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN
1390  * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1391                in downward direction.
1392  * \li Syntax: paragraph-down
1393  * \li Origin: Asger, 1 Oct 1996
1394  * \endvar
1395  */
1396                 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
1397 /*!
1398  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN_SELECT
1399  * \li Action: Move the cursor and select the text to the next paragraph (or
1400                begining of the current one) in downward direction.
1401  * \li Syntax: paragraph-down-select
1402  * \li Origin: Asger, 1 Oct 1996
1403  * \endvar
1404  */
1405                 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
1406 /*!
1407  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
1408  * \li Action: Jump to a paragraph given by its id number and optionally the
1409                desired position within the paragraph.
1410  * \li Notion: Note that id number of paragraph is not the sequential number of paragraph
1411                seen on the screen. Moreover the id is unique for all opened buffers (documents).
1412  * \li Syntax: paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
1413  * \li Params: <PAR_ID_NUMBER>:  paragraph id
1414                <POSITION_IN_PAR>: desired position within the paragraph
1415  * \li Origin: Dekel, 26 Aug 2000
1416  * \endvar
1417  */
1418                 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly, Edit },
1419 /*!
1420  * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1421  * \li Action: Breaks the current paragraph at the current location.
1422  * \li Syntax: break-paragraph
1423  * \endvar
1424  */
1425                 { LFUN_PARAGRAPH_SPACING, "paragraph-spacing", Noop, Edit },
1426 /*!
1427  * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1428  * \li Action: Breaks the current paragraph at the current location.
1429  * \li Notion: Removes the selection.
1430  * \li Syntax: break-paragraph [<LAYOUT>]
1431  * \li Params: <LAYOUT>: "inverse" - decreases depth by one (or change layout
1432                          to default layout) when the cursor is at the end of
1433                          the line.
1434  * \endvar
1435  */
1436                 { LFUN_BREAK_PARAGRAPH, "break-paragraph", Noop, Edit },
1437 /*!
1438  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
1439  * \li Action: Change paragraph settings.
1440  * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
1441                This function only modifies, and does not override, existing settings.
1442                Note that the "leftindent" indent setting is deprecated.
1443  * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
1444  * \li Params: <INDENT>:  \\noindent|\\indent|\\indent-toggle|\\leftindent LENGTH\n
1445                <SPACING>: \\paragraph_spacing default|single|onehalf|double|other\n
1446                <ALIGN>:   \\align block|left|right|center|default\n
1447                <OTHERS>:  \\labelwidthstring WIDTH|\\start_of_appendix\n
1448  * \li Origin: rgh, Aug 15 2007
1449  * \endvar
1450  */
1451                 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
1452 /*!
1453  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
1454  * \li Action: Change paragraph settings.
1455  * \li Notion: Overwrite all nonspecified settings to the default ones.
1456                Use paragraph-params lfun if you don't want to overwrite others settings.
1457  * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
1458  * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
1459  * \li Origin: leeming, 30 Mar 2004
1460  * \endvar
1461  */
1462                 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
1463                 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
1464
1465 /*!
1466  * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
1467  * \li Action: Move the current group in the upward direction in the
1468                structure of the document.
1469  * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1470                the whole substructure of the group.
1471  * \li Syntax: outline-up
1472  * \li Origin: Vermeer, 23 Mar 2006
1473  * \endvar
1474  */
1475                 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
1476 /*!
1477  * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
1478  * \li Action: Move the current group in the downward direction in the
1479                structure of the document.
1480  * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1481                the whole substructure of the group.
1482  * \li Syntax: outline-down
1483  * \li Origin: Vermeer, 23 Mar 2006
1484  * \endvar
1485  */
1486                 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
1487 /*!
1488  * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
1489  * \li Action: Moves the current group in the downward direction in the
1490                hierarchy of the document structure.
1491  * \li Notion: Part -> Chapter -> Section -> etc.
1492  * \li Syntax: outline-in
1493  * \li Origin: Vermeer, 23 Mar 2006
1494  * \endvar
1495  */
1496                 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
1497 /*!
1498  * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
1499  * \li Action: Moves the current group in the upward direction in the
1500                hierarchy of the document structure.
1501  * \li Notion: Part <- Chapter <- Section <- etc.
1502  * \li Syntax: outline-out
1503  * \li Origin: Vermeer, 23 Mar 2006
1504  * \endvar
1505  */
1506                 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
1507 /*!
1508  * \var lyx::FuncCode lyx::LFUN_INSET_EDIT
1509  * \li Action: Edit the inset at cursor with an external application,
1510  *             if one is attributed.
1511  * \li Syntax: inset-edit [<INSET_PARAMS>]
1512  * \li Params: <INSET_PARAMS>: Parameters for the inset.
1513                                Currently only the filename will be considered.
1514  * \li Origin: JSpitzm, 27 Apr 2006
1515  * \endvar
1516  */
1517                 { LFUN_INSET_EDIT, "inset-edit", Noop, Edit },
1518
1519                 { LFUN_CELL_BACKWARD, "cell-backward", Noop, Edit },
1520                 { LFUN_CELL_FORWARD, "cell-forward", Noop, Edit },
1521                 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
1522                 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
1523                 { LFUN_TABULAR_FEATURE, "tabular-feature", Noop, Edit },
1524
1525                 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
1526                 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
1527                 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
1528                 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
1529                 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
1530
1531                 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
1532                 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
1533                 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
1534                 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
1535                 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
1536                 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
1537                 { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
1538                 { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
1539
1540 /*!
1541  * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
1542  * \li Action: Apply data for an inset.
1543  * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
1544                be applied. This is either changed to #LFUN_INSET_MODIFY or
1545                #LFUN_INSET_INSERT depending on the context where it is called.
1546  * \li Syntax: inset-apply <ARGS>
1547  * \li Params: See #LFUN_INSET_INSERT .
1548  * \endvar
1549  */
1550                 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
1551 /*!
1552  * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE
1553  * \li Action: Dissolve the current inset into text.
1554  * \li Syntax: inset-dissolve [<INSET>]
1555  * \li Params: <INSET>: this can be used to make sure the right kind of inset
1556                         is dissolved. For example "dissolve" entry in the charstyles
1557                         sub-menu should only dissolve the charstyle inset, even if the
1558                         cursor is inside several nested insets of different type.\n
1559                         For values see #lyx::InsetLayout::lyxtype_ .
1560  * \li Author: JSpitz, 7 Aug 2006
1561  * \endvar
1562  */
1563                 { LFUN_INSET_DISSOLVE, "inset-dissolve", Noop, Edit },
1564 /*!
1565  * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
1566  * \li Action: Insert new inset (type given by the parameters).
1567  * \li Syntax: inset-insert <INSET> <ARGS>
1568  * \li Params: <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics|
1569                          hyperlink|include|index|label|nomencl|vspace|ref|toc>\n
1570                <ARGS>: depends on the given inset. Use "lyx -dbg action" to
1571                        explore.
1572  * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
1573                where <label name> is the name of the referenced label and
1574                <Format> is one of the following: \n
1575                ref -- <reference> \n
1576                eqref -- (<reference>) \n
1577                pageref -- <page> \n
1578                vpageref -- on <page> \n
1579                vref -- <reference> on <page> \n
1580                prettyref -- Formatted reference
1581  * \endvar
1582  */
1583                 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
1584 /*!
1585  * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
1586  * \li Action: Modify existing inset.
1587  * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1588                bibtex, ert, command, graphics, note, space, vspace, tabular,
1589                bibitem, inlude, ref insets.
1590  * \li Syntax: inset-modify <INSET> <ARGS>
1591  * \li Params: See #LFUN_INSET_INSERT for further details.
1592  * \endvar
1593  */
1594                 { LFUN_INSET_MODIFY, "", Noop, Hidden },
1595 /*!
1596  * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_MODIFY
1597  * \li Action: Modify the inset at cursor position, if there is one.
1598  * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1599                bibtex, ert, command, graphics, note, space, vspace, tabular,
1600                bibitem, inlude, ref insets.
1601  * \li Syntax: next-inset-modify <INSET> <ARGS> or next-inset-modify changetype <TYPE>
1602  * \li Params: See #LFUN_INSET_INSERT for further details.
1603  * \li Origin: JSpitzm, 23 Mar 2008
1604  * \endvar
1605  */
1606                 { LFUN_NEXT_INSET_MODIFY, "next-inset-modify", ReadOnly, Edit },
1607                 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
1608 /*!
1609  * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
1610  * \li Action: Open the inset's properties dialog.
1611  * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
1612  * \li Syntax: inset-settings <INSET>
1613  * \li Params: <INSET>: <box|branch|ert|float|listings|note|tabular|wrap>
1614  * \endvar
1615  */
1616                 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly, Edit },
1617 /*!
1618  * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_TOGGLE
1619  * \li Action: Toggles the inset at cursor position. For collapsables, this means it will
1620                be (un-)collapsed, in case of other insets, the editing widget (dialog) will
1621                be entered. Also cf. #LFUN_INSET_SETTINGS.
1622  * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1623                bibtex, ert, command, graphics, note, space, vspace, tabular,
1624                bibitem, inlude, ref insets.
1625  * \li Syntax: next-inset-toggle <ARG>
1626  * \li Params: <ARG>: these are passed as arguments to #LFUN_INSET_TOGGLE .
1627  * \li Origin: leeming, 30 Mar 2004
1628  * \endvar
1629  */
1630                 { LFUN_NEXT_INSET_TOGGLE, "next-inset-toggle", ReadOnly, Edit },
1631 /*!
1632  * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
1633  * \li Action: Toggles the collapsable inset we are currently in.
1634  * \li Syntax: inset-toggle [<ARG>]
1635  * \li Params: <ARG>: <open|close|toggle|assign>. \n
1636                open/close/toggle are for collapsable insets. close can be currently used
1637                by #LFUN_NEXT_INSET_TOGGLE. toggle is used when no argument is given.\n
1638                assign is for branch inset.
1639  * \li Origin: lasgouttes, 19 Jul 2001
1640  * \endvar
1641  */
1642                 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly, Hidden },
1643 /*!
1644  * \var lyx::FuncCode lyx::LFUN_ALL_INSETS_TOGGLE
1645  * \li Action: Toggles (open/closes) all collapsable insets (of a given type) in the document.
1646  * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
1647  * \li Syntax: all-insets-toggle <STATE> <INSET>
1648  * \li Params: <STATE>: <toggle|open|close> default: toggle \n
1649                <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all insets \n
1650  * \li Origin: leeming, 30 Mar 2004
1651  * \endvar
1652  */
1653                 { LFUN_ALL_INSETS_TOGGLE, "all-insets-toggle", ReadOnly, Edit },
1654 /*!
1655  * \var lyx::FuncCode lyx::LFUN_GRAPHICS_GROUPS_UNIFY
1656  * \li Action: Unify all graphics insets with the one given as an parameter.
1657  * \li Notion: This is internally used for synchronize certain group of graphics insets.
1658  * \li Syntax: graphics-groups-unigfy <GRAPHICS_PARAMS>
1659  * \li Params: <GRAPHICS_PARAMS>: Parameters for graphics inset
1660                                   (syntax can be seen in .lyx files).
1661  * \li Origin: sanda, 6 May 2008
1662  * \endvar
1663  */
1664                 { LFUN_GRAPHICS_GROUPS_UNIFY, "graphics-groups-unify", ReadOnly, Edit },
1665 /*!
1666  * \var lyx::FuncCode lyx::LFUN_SET_GRAPHICS_GROUP
1667  * \li Action: Set the group for the graphics inset on the cursor position.
1668  * \li Syntax: set-graphics-group [<GROUP>]
1669  * \li Params: <GROUP>: Id for an existing group. In case tthe Id is an empty string,
1670                         the graphics inset is removed from the current group.
1671  * \li Origin: sanda, 6 May 2008
1672  * \endvar
1673  */
1674                 { LFUN_SET_GRAPHICS_GROUP, "set-graphics-group", ReadOnly, Edit },
1675
1676 /*!
1677  * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
1678  * \li Action: Moves the cursor out of the current slice, going forward.
1679  * \li Notion: Cursor movement within an inset may be different than cursor
1680                movement in the surrounding text. This action should be called
1681                automatically by the cursor movement within the inset, when
1682                movement within the inset has ceased (reached the end of the
1683                last paragraph, for example), in order to move correctly
1684                back into the surrounding text.
1685  * \endvar
1686  */
1687                 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
1688 /*!
1689  * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
1690  * \li Action: Moves the cursor out of the current slice, going backwards.
1691  * \li Notion: See also #LFUN_FINISHED_FORWARD.
1692  * \endvar
1693  */
1694                 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
1695 /*!
1696  * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
1697  * \li Action: Moves the cursor out of the current slice, going right.
1698  * \li Notion: See also #LFUN_FINISHED_FORWARD
1699  * \endvar
1700  */
1701                 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
1702 /*!
1703  * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
1704  * \li Action: Moves the cursor out of the current slice, going left.
1705  * \li Notion: See also #LFUN_FINISHED_FORWARD.
1706  * \endvar
1707  */
1708                 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
1709
1710                 { LFUN_LANGUAGE, "language", Noop, Edit },
1711
1712 /*!
1713  * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
1714  * \li Action: Goto a label.
1715  * \li Syntax: label-goto [<LABEL>]
1716  * \li Params: <LABEL>: Requested label. If no label is given and refernce
1717                         is on cursor position, Bookmark 0 is saved and
1718                         cursor moves to the position of referenced label.
1719  * \li Origin: Ale, 6 Aug 1997
1720  * \endvar
1721  */
1722                 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
1723 /*!
1724  * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT
1725  * \li Action: Inserts label to text or displayed formula.
1726  * \li Syntax: label-insert [<LABEL>]
1727  * \li Params: <LABEL>: Requested label. If no label is given dialog requesting
1728                         name will be opened.
1729  * \endvar
1730  */
1731                 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
1732 /*!
1733  * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
1734  * \li Action: Go to the next label or cross-reference.
1735  * \li Syntax: reference-next
1736  * \li Origin: Dekel, 14 Jan 2001
1737  * \endvar
1738  */
1739                 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
1740
1741 /*!
1742  * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
1743  * \li Action: Goto a bookmark.
1744  * \li Notion: Moves the cursor to the numbered bookmark, opening the file
1745                if necessary. Note that bookmarsk are saved per-session, not
1746                per file.
1747  * \li Syntax: bookmark-goto <NUMBER>
1748  * \li Params: <NUMBER>: the number of the bookmark to restore.
1749  * \li Origin: Dekel, 27 January 2001
1750  * \endvar
1751  */
1752                 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
1753 /*!
1754  * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
1755  * \li Action: Save a bookmark.
1756  * \li Notion: Saves a numbered bookmark to the sessions file. The number
1757                must be between 1 and 9, inclusive. Note that bookmarks are
1758                saved per-session, not per file.
1759  * \li Syntax: bookmark-save <NUMBER>
1760  * \li Params: <NUMBER>: the number of the bookmark to save.
1761  * \li Origin: Dekel, 27 January 2001
1762  * \endvar
1763  */
1764                 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
1765 /*!
1766  * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
1767  * \li Action: Clears the list of saved bookmarks.
1768  * \li Syntax: bookmark-clear
1769  * \li Origin: bpeng, 31 October 2006
1770  * \endvar
1771  */
1772                 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
1773
1774 /*!
1775  * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
1776  * \li Action: Open the given help file according to the language setting.
1777  * \li Syntax: help-open <FILE>[.lyx]
1778  * \li Params: <FILE>: any document from (/usr/share/)doc directory.
1779  * \li Author: Jug, 27 Jun 1999
1780  * \endvar
1781  */
1782                 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
1783 /*!
1784  * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
1785  * \li Action: Terminates the current LyX instance.
1786  * \li Notion: Terminates the current LyX instance, asking whether to save
1787                modified documents, etc.
1788  * \li Syntax: lyx-quit
1789  * \endvar
1790  */
1791                 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
1792 /*!
1793  * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
1794  * \li Action: Toggles visibility of a given toolbar between on/off/auto.
1795  * \li Notion: Skiping "auto" when allowauto is false.
1796  * \li Syntax: toolbar-toggle <NAME> [allowauto]
1797  * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|
1798                        minibuffer|review|view/update|math_panels
1799  * \li Origin: Edwin, 21 May 2007
1800  * \endvar
1801  */
1802                 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
1803 /*!
1804  * \var lyx::FuncCode lyx::LFUN_MENU_OPEN
1805  * \li Action: Opens the menu given by its name.
1806  * \li Syntax: menu-open <NAME>
1807  * \li Params: <NAME>: menu name. See various .inc files in lib/ui for candidates.
1808  * \endvar
1809  */
1810                 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
1811 /*!
1812  * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
1813  * \li Action: Various UI visibility-toggling actions.
1814  * \li Syntax: ui-toggle <statusbar|menubar|frame|fullscreen>
1815  * \li Params: statusbar  : Toggle visibility of the statusbar.\n
1816                menubar    : Toggle visibility of the menubar.\n
1817                scrollbar  : Toggle visibility of the scrollbar.\n
1818                frame      : Toggle visibility of the frames around editing window.\n
1819                fullscreen : Toggle fullscreen mode. This also covers calling the
1820                             previous functions. However #LFUN_TOOLBAR_TOGGLE for the
1821                             custom tweaks of the toolbars should be used.
1822  * \li Origin: ps, 9 Feb 2007
1823  * \endvar
1824  */
1825                 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
1826
1827 /*!
1828  * \var lyx::FuncCode lyx::WINDOW_NEW
1829  * \li Action: Creates new empty LyX window.
1830  * \li Notion: Already opened documents from the previous window can be found under View menu.
1831  * \li Syntax: window-new [<GEOMETRY>]
1832  * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently 
1833                            accepted only on Windows platform.
1834  * \li Origin: Abdel, 21 Oct 2006
1835  * \endvar
1836  */
1837                 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
1838 /*!
1839  * \var lyx::FuncCode lyx::LFUN_WINDOW_CLOSE
1840  * \li Action: Closes the current LyX window.
1841  * \li Syntax: window-close
1842  * \li Origin: Abdel, 23 Oct 2006
1843  * \endvar
1844  */
1845                 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
1846
1847 /*!
1848  * \var lyx::FuncCode lyx::LFUN_SPLIT_VIEW
1849  * \li Action: Creates another split view of current buffer.
1850  * \li Notion: All split views act in the same way indpendently.
1851  * \li Syntax: split-view <vertical|horizontal>
1852  * \li Params: horizontal : The work areas are laid out side by side.\n
1853                vertical   : The work areas laid out vertically.\n
1854  * \li Origin: abdel, 20 Feb 2008
1855  * \endvar
1856  */
1857                 { LFUN_SPLIT_VIEW, "split-view", ReadOnly, Buffer },
1858
1859 /*!
1860  * \var lyx::FuncCode lyx::LFUN_CLOSE_TAB_GROUP
1861  * \li Action: Close the current tab group.
1862  * \li Notion: This only closes the work areas, not the buffer themselves.
1863                The still opened buffers can be visualized in another tab group.
1864  * \li Syntax: close-tab-group
1865  * \li Origin: abdel, 21 Feb 2008
1866  * \endvar
1867  */
1868                 { LFUN_CLOSE_TAB_GROUP, "close-tab-group", ReadOnly, Buffer },
1869                 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
1870                 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
1871                 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
1872                 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
1873                 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
1874                 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
1875
1876                 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
1877                 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
1878                 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
1879                 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
1880                 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
1881
1882                 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
1883                 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
1884                 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
1885                 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
1886
1887                 { LFUN_SERVER_CHAR_AFTER, "server-char-after", ReadOnly, System },
1888                 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
1889                 { LFUN_SERVER_GET_NAME, "server-get-name", ReadOnly, System },
1890 /*!
1891  * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
1892  * \li Action: Sets the cursor position based on the row number of generated TeX file.
1893  * \li Syntax: server-goto-file-row <LYX_FILE_NAME> <ROW_NUMBER>
1894  * \li Origin: Edmar, 23 Dec 1998
1895  * \endvar
1896  */
1897                 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly, System },
1898                 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
1899 /*!
1900  * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
1901  * \li Action: Sets the cursor position based on the editing area coordinates
1902                (similar as clicking on that point with left mouse button).
1903  * \li Syntax: server-set-xy <X> <Y>
1904  * \endvar
1905  */
1906                 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
1907 /*!
1908  * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
1909  * \li Action: Returns the coordinates of cursor position in the editing area.
1910  * \li Syntax: server-get-xy
1911  * \endvar
1912  */
1913                 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
1914
1915 /*!
1916  * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
1917  * \li Action: Generates the code (literate programming).
1918  * \li Notion: Latex file with extension \literate_extension is generated.
1919                Then LyX invokes \build_command (with a default of``make'') to generate the code and
1920                \build_error_filter to process the compilation error messages. \n
1921                In case you want to process your literate file with a script, or some other program,
1922                just insert in your lyxrc file an entry with:\n
1923                \build_command "my_script my_arguments" \n
1924                The \build_error_filter differs from the \literate_error_filter only in that the
1925                former will identify error messages from your compiler.
1926  * \li Syntax: build-program
1927  * \endvar
1928  */
1929                 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
1930
1931 /*!
1932  * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
1933  * \li Action: Saves the current buffer to a temporary file.
1934  * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
1935                is called automatically by LyX, to "autosave" the current buffer.
1936  * \li Syntax: buffer-auto-save
1937  * \endvar
1938  */
1939                 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
1940 /*!
1941  * \var lyx::FuncCode lyx::LFUN_BUFFER_CHILD_OPEN
1942  * \li Action: Loads the given child document.
1943  * \li Notion: The current document is treated as a parent.
1944  * \li Syntax: buffer-child-open <FILE>
1945  * \li Params: <FILE>: Filename of the child. The directory of the parent is assumed by default.
1946  * \li Origin: Ale, 28 May 1997
1947  * \endvar
1948  */
1949                 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
1950 /*!
1951  * \var lyx::FuncCode lyx::LFUN_BUFFER_CHKTEX
1952  * \li Action: Runs chktex for the current document.
1953  * \li Syntax: buffer-chktex
1954  * \li Origin: Asger, 30 Oct 1997
1955  * \endvar
1956  */
1957                 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
1958 /*!
1959  * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
1960  * \li Action: Toggles compression of the current document on/off.
1961  * \li Syntax: buffer-toggle-compression
1962  * \li Origin: bpeng, 27 Apr 2006
1963  * \endvar
1964  */
1965                 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
1966 /*!
1967  * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
1968  * \li Action: Closes the current buffer.
1969  * \li Notion: Closes the current buffer, asking whether to save it, etc,
1970                if the buffer has been modified.
1971  * \li Syntax: buffer-close
1972  * \endvar
1973  */
1974                 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
1975 /*!
1976  * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
1977  * \li Action: Exports the current buffer (document) to the given format.
1978  * \li Syntax: buffer-export <FORMAT>
1979  * \li Params: <FORMAT> is either "custom" or one of the formats which you
1980                         can find in Tools->Preferences->File formats->Format.
1981                         Usual format you will enter is "pdf2" (pdflatex),
1982                         "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
1983                         In case of "custom" you will be asked for a format you
1984                         want to start from and for the command that you want to
1985                         apply to this format. Internally the control is then passed
1986                         to #LFUN_BUFFER_EXPORT_CUSTOM.
1987  * \li Origin: Lgb, 29 Jul 1997
1988  * \endvar
1989  */
1990                 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
1991 /*!
1992  * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
1993  * \li Action: Exports the current buffer (document) from the given format using
1994                the given command on it.
1995  * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
1996  * \li Params: <FORMAT> format to start from (LyX will care to produce such
1997                         intermediate file).\n
1998                <COMMAND> this command will be launched on the file. Note that you can
1999                use "$$FName" string to qualify the intermediate file.
2000  * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
2001  * \li Origin: leeming, 27 Mar 2004
2002  * \endvar
2003  */
2004                 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
2005 /*!
2006  * \var lyx::FuncCode lyx::LFUN_BUFFER_PRINT
2007  * \li Action: Prints the current document.
2008  * \li Notion: Many settings can be given via the preferences dialog.
2009  * \li Syntax: buffer-print <TARGET> <TARGET-NAME> <COMMAND>
2010  * \li Params: <TARGET> is either "printer" or "file".\n
2011                <TARGER-NAME> is either "default" or file name or printer name.\n
2012                <COMMAND> command ensuring the printing job.
2013  * \li Sample: buffer-print file "/trash/newfile1.ps" "dvips"
2014  * \li Origin: leeming, 28 Mar 2004
2015  * \endvar
2016  */
2017                 { LFUN_BUFFER_PRINT, "buffer-print", ReadOnly, Buffer },
2018 /*!
2019  * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
2020  * \li Action: Import a given file as a lyx document.
2021  * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
2022                defined convertors in preferences. Look into File->Import menu to get
2023                an idea of the currently active import formats.
2024  * \li Syntax: buffer-import <FORMAT> [<FILE>]
2025  * \li Origin: Asger, 24 Jul 1998
2026  * \endvar
2027  */
2028                 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
2029 /*!
2030  * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
2031  * \li Action: Creates a new buffer (that is, document).
2032  * \li Notion: Implicit path can be set in Preferences dialog.
2033  * \li Syntax: buffer-new [<FILE>]
2034  * \li Params: <FILE>: filename of created file with absolute path.
2035  * \endvar
2036  */
2037                 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
2038 /*!
2039  * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
2040  * \li Action: Creates a new buffer (that is, document) from a template.
2041  * \li Notion: Path for new files and templates can be set in Preferences dialog.
2042                Template will be asked for via Open-dialog.
2043  * \li Syntax: buffer-new-template [<FILE>]
2044  * \li Params: <FILE>: filename of created file with absolute path.
2045  * \endvar
2046  */
2047                 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
2048 /*!
2049  * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
2050  * \li Action: Reverts opened document.
2051  * \li Syntax: buffer-reload
2052  * \li Origin: Asger, 2 Feb 1997
2053  * \endvar
2054  */
2055                 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
2056 /*!
2057  * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
2058  * \li Action: Switch to the given buffer.
2059  * \li Notion: This is useful also in case you need simultaneously more views of the edited
2060                document in different LyX windows.
2061  * \li Syntax: buffer-new-template <BUFFER>
2062  * \li Params: <BUFFER>: already opened document which is to be shown.
2063  * \endvar
2064  */
2065                 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
2066 /*!
2067  * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
2068  * \li Action: Toggle editing mode of the current document between read/write and read-only.
2069  * \li Syntax: buffer-toggle-read-only
2070  * \li Origin: Lgb, 27 May 1997
2071  * \endvar
2072  */
2073                 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
2074 /*!
2075  * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
2076  * \li Action: Displays current buffer in chosen format.
2077  * \li Notion: Displays the contents of the current buffer in the chosen
2078                format, for example, PDF or DVI. This runs the necessary
2079                converter, calls the defined viewer, and so forth.
2080  * \li Syntax: buffer-view <FORMAT>
2081  * \li Params: <FORMAT>: The format to display, where this is one of the
2082                          formats defined (in the current GUI) in the
2083                          Tools>Preferences>File Formats dialog.
2084  * \endvar
2085  */
2086                 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
2087 /*!
2088  * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
2089  * \li Action: Exports the current document and put the result into the
2090                temporary directory.
2091  * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
2092                the output will be rewriten - updated. This is useful in case your viewer
2093                is able to detect such changes (e.g. ghostview for postscript).
2094  * \li Syntax: buffer-update <FORMAT>
2095  * \li Params: <FORMAT>: The format to display, where this is one of the
2096                          formats defined (in the current GUI) in the
2097                          Tools>Preferences>File Formats dialog.
2098  * \li Origin: Dekel, 5 Aug 2000
2099  * \endvar
2100  */
2101                 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
2102
2103 /*!
2104  * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
2105  * \li Action: Saves the current buffer.
2106  * \li Notion: Saves the current buffer to disk, using the filename that
2107                is already associated with the buffer, asking for one if
2108                none is yet assigned.
2109  * \li Syntax: buffer-write
2110  * \endvar
2111  */
2112                 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
2113 /*!
2114  * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
2115  * \li Action: Rename and save current buffer.
2116  * \li Syntax: buffer-write-as <FILENAME>
2117  * \li Params: <FILENAME>: New name of the buffer/file. A relative path
2118                is with respect to the original location of the buffer/file.
2119  * \endvar
2120  */
2121                 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
2122 /*!
2123  * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
2124  * \li Action: Save all changed documents.
2125  * \li Syntax: buffer-write-all
2126  * \li Origin: rgh, gpothier 6 Aug 2007
2127  * \endvar
2128  */
2129                 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
2130 /*!
2131  * \var lyx::FuncCode lyx::LFUN_BUFFER_NEXT
2132  * \li Action: Switch to the next opened document.
2133  * \li Notion: Note that this does not necessarily mean next in tabbar
2134                (for full list see View menu).
2135  * \li Syntax: buffer-next
2136  * \endvar
2137  */
2138                 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
2139 /*!
2140  * \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS
2141  * \li Action: Switch to the previous opened document.
2142  * \li Syntax: buffer-previous
2143  * \endvar
2144  */
2145                 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
2146 /*!
2147  * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
2148  * \li Action: When run from a child document, this updates (exports) document built
2149                 from the master buffer. If a master is not found, it updates the
2150                 current buffer.
2151  * \li Syntax: master-buffer-update
2152  * \li Author: Tommaso, 20 Sep 2007
2153  * \endvar
2154  */
2155                 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
2156 /*!
2157  * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
2158  * \li Action: When run from a child document, this command shows a preview built
2159                from the master buffer. If a master is not found, it previews the
2160                current buffer.
2161  * \li Syntax: master-buffer-view
2162  * \li Author: Tommaso, 20 Sep 2007
2163  * \endvar
2164  */
2165                 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
2166 /*!
2167  * \var lyx::FuncCode lyx::LFUN_BUFFER_LANGUAGE
2168  * \li Action: Set language of the current document.
2169  * \li Syntax: buffer-language <LANG>
2170  * \li Params: <LANG>: language name. See lib/languages for list.
2171  * \li Author: leeming, 30 Mar 2004
2172  * \endvar
2173  */
2174                 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
2175 /*!
2176  * \var lyx::FuncCode lyx::LFUN_BUFFER_SAVE_AS_DEFAULT
2177  * \li Action: Save the current document settings as default.
2178  * \li Notion: The file will will be saved into ~/.lyx/templates/defaults.lyx .
2179  * \li Syntax: buffer-save-as-default [<ARGS>]
2180  * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
2181                        you can find in document header of usual .lyx file.
2182  * \li Author: leeming, 30 Mar 2004
2183  * \endvar
2184  */
2185                 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
2186 /*!
2187  * \var lyx::FuncCode lyx::LFUN_BUFFER_PARAMS_APPLY
2188  * \li Action: Apply the given settings to the current document.
2189  * \li Syntax: buffer-params-apply [<ARGS>]
2190  * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
2191                        you can find in document header of usual .lyx file.
2192  * \li Author: leeming, 30 Mar 2004
2193  * \endvar
2194  */
2195                 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", Noop, Buffer },
2196
2197 /*!
2198  * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
2199  * \li Action: Inserts another LyX file.
2200  * \li Syntax: file-insert [<FILE>]
2201  * \li Params: <FILE>: Filename to be inserted.
2202  * \endvar
2203  */
2204                 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
2205 /*!
2206  * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
2207  * \li Action: Inserts plain text file.
2208  * \li Syntax: file-insert-plaintext [<FILE>]
2209  * \li Params: <FILE>: Filename to be inserted.
2210  * \li Origin: CFO-G, 19 Nov 1997
2211  * \endvar
2212  */
2213                 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
2214 /*!
2215  * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
2216  * \li Action: Inserts plain text file as paragraph (i.e. join lines).
2217  * \li Syntax: file-insert-plaintext-para [<FILE>]
2218  * \li Params: <FILE>: Filename to be inserted.
2219  * \li Origin: Levon, 14 Feb 2001
2220  * \endvar
2221  */
2222                 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
2223 /*!
2224  * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
2225  * \li Action: Open LyX document.
2226  * \li Syntax: file-open [<FILE>]
2227  * \li Params: <FILE>: Filename to be opened.
2228  * \endvar
2229  */
2230                 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
2231
2232 /*!
2233  * \var lyx::FuncCode lyx::LFUN_CALL
2234  * \li Action: Executes a command defined in a .def file.
2235  * \li Notion: The definitions are by default read from lib/commands/default.def.\n
2236                A .def file allows to define a command with \\define "<NAME>" "<LFUN>"
2237                where <NAME> is the name of the new command and <LFUN> is the lfun code
2238                to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
2239                \\def_file "FileName" allows to include another .def file. \n
2240                This is particularly useful in connection with toolbar buttons:
2241                Since the name of the button image for this lfun is 
2242                lib/images/commands/<NAME>.png this is the way to assign an image
2243                to a complex command-sequence.
2244  * \li Syntax: call <NAME>
2245  * \li Params: <NAME>: Name of the command that must be called.
2246  * \li Origin: broider, 2 Oct 2007
2247  * \endvar
2248  */
2249                 { LFUN_CALL, "call", NoBuffer, System },
2250 /*!
2251  * \var lyx::FuncCode lyx::LFUN_META_PREFIX
2252  * \li Action: Simulate halting Meta key (Alt key on PCs).
2253  * \li Notion: Used for buffer editation not for GUI control.
2254  * \li Syntax: meta-prefix
2255  * \endvar
2256  */
2257                 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
2258 /*!
2259  * \var lyx::FuncCode lyx::LFUN_CANCEL
2260  * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
2261  * \li Syntax: cancel
2262  * \endvar
2263  */
2264                 { LFUN_CANCEL, "cancel", NoBuffer, System },
2265
2266 /*!
2267  * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
2268  * \li Action: Opens the minibuffer toolbar so that the user can type in there.
2269  * \li Notion: Usually bound to M-x shortcut.
2270  * \li Syntax: command-execute
2271  * \endvar
2272  */
2273                 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
2274                 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
2275 /*!
2276  * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
2277  * \li Action: Run more commands (LFUN and its parameters) in a sequence.
2278  * \li Syntax: command-sequence <CMDS>
2279  * \li Params: <CMDS>: Sequence of commands separated by semicolons.
2280  * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
2281  * \li Origin: Andre', 11 Nov 1999
2282  * \endvar
2283  */
2284                 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
2285 /*!
2286  * \var lyx::FuncCode lyx::LFUN_MESSAGE
2287  * \li Action: Shows message in statusbar (for script purposes).
2288  * \li Syntax: message <STRING>
2289  * \li Origin: Lgb, 8 Apr 2001
2290  * \endvar
2291  */
2292                 { LFUN_MESSAGE, "message", NoBuffer, System },
2293 /*!
2294  * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
2295  * \li Action: Save user preferences.
2296  * \li Syntax: preferences-save
2297  * \li Origin: Lgb, 27 Nov 1999
2298  * \endvar
2299  */
2300                 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
2301 /*!
2302  * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
2303  * \li Action: Reconfigure the automatic settings.
2304  * \li Syntax: reconfigure
2305  * \li Origin: Asger, 14 Feb 1997
2306  * \endvar
2307  */
2308                 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
2309 /*!
2310  * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
2311  * \li Action: Apply the given settings to user preferences.
2312  * \li Syntax: lyxrc-apply <SETTINGS>
2313  * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
2314                            to get an idea which commands to use and their syntax.
2315                            #lyx::LyXRC::LyXRCTags has the list of possible commands.
2316  * \endvar
2317  */
2318                 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
2319 /*!
2320  * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
2321  * \li Action: Determine whether keep cursor inside the editing window regardless
2322                the scrollbar movement.
2323  * \li Syntax: toggle-cursor-follows-scrollbar
2324  * \li Origin: ARRae, 2 Dec 1997
2325  * \endvar
2326  */
2327                 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
2328 /*!
2329  * \var lyx::FuncCode lyx::LFUN_SET_COLOR
2330  * \li Action: Set the given LyX color to the color defined by the X11 name given.
2331  * \li Notion: A new color entry is created if the color is unknown.
2332                Color names can be stored as a part of user settings.
2333  * \li Syntax: set-color <LYX_NAME> <X11_NAME>
2334  * \li Origin: SLior, 11 Jun 2000
2335  * \endvar
2336  */
2337                 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
2338 /*!
2339  * \var lyx::FuncCode lyx::LFUN_STATISTICS
2340  * \li Action: Count the statistics (number of words and characters)
2341                in the document or in the given selection.
2342  * \li Notion: Note that this function gives the number of words/chars written,
2343                not the number of characters which will be typeset.
2344  * \li Syntax: statistics
2345  * \li Origin: lasgouttes, Jan 27 2004; ps, Jan 8 2008
2346  * \endvar
2347  */
2348                 { LFUN_STATISTICS, "statistics", ReadOnly, System },
2349 /*!
2350  * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
2351  * \li Action: Show the inline completion at the cursor position.
2352  * \li Syntax: completion-inline
2353  * \li Origin: sts, Feb 19 2008
2354  * \endvar
2355  */
2356                 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
2357 /*!
2358  * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
2359  * \li Action: Show the completion popup at the cursor position.
2360  * \li Syntax: completion-popup
2361  * \li Origin: sts, Feb 19 2008
2362  * \endvar
2363  */
2364                 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
2365 /*!
2366  * \var lyx::FuncCode lyx::LFUN_COMPLETION_COMPLETE
2367  * \li Action: Try to complete the word or command at the cursor position.
2368  * \li Syntax: completion-complete
2369  * \li Origin: sts, Feb 19 2008
2370  * \endvar
2371  */
2372                 { LFUN_COMPLETION_COMPLETE, "complete", SingleParUpdate, Edit },
2373 /*!
2374  * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
2375  * \li Action: Activate the branch
2376  * \li Syntax: branch-activate <BRANCH>
2377  * \li Params: <BRANCH>: The branch to activate
2378  * \li Sample: lyx -e pdf2 -x "branch-activate answers" finalexam.lyx \n
2379                could be used to export a pdf with the answers branch included
2380                without one's having to open LyX and activate the branch manually.
2381  * \li Origin: rgh, 27 May 2008
2382  * \endvar
2383  */
2384                 { LFUN_BRANCH_ACTIVATE, "branch-activate", Argument, Buffer },
2385 /*!
2386  * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
2387  * \li Action: De-activate the branch
2388  * \li Syntax: branch-deactivate <BRANCH>
2389  * \li Params: <BRANCH>: The branch to deactivate
2390  * \li Origin: rgh, 27 May 2008
2391  * \endvar
2392  */
2393                 { LFUN_BRANCH_DEACTIVATE, "branch-deactivate", Argument, Buffer },
2394
2395                 { LFUN_NOACTION, "", Noop, Hidden }
2396 #ifndef DOXYGEN_SHOULD_SKIP_THIS
2397         };
2398
2399         for (int i = 0; items[i].action != LFUN_NOACTION; ++i) {
2400                 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
2401         }
2402
2403         init = true;
2404 }
2405 #endif
2406
2407 LyXAction::LyXAction()
2408 {
2409         init();
2410 }
2411
2412
2413 // Returns an action tag from a string.
2414 FuncRequest LyXAction::lookupFunc(string const & func) const
2415 {
2416         string const func2 = trim(func);
2417
2418         if (func2.empty()) {
2419                 return FuncRequest(LFUN_NOACTION);
2420         }
2421
2422         string cmd;
2423         string const arg = split(func2, cmd, ' ');
2424
2425         func_map::const_iterator fit = lyx_func_map.find(cmd);
2426
2427         return fit != lyx_func_map.end() ? FuncRequest(fit->second, arg) : FuncRequest(LFUN_UNKNOWN_ACTION);
2428 }
2429
2430
2431 string const LyXAction::getActionName(FuncCode action) const
2432 {
2433         info_map::const_iterator const it = lyx_info_map.find(action);
2434         return it != lyx_info_map.end() ? it->second.name : string();
2435 }
2436
2437
2438 LyXAction::func_type const LyXAction::getActionType(FuncCode action) const
2439 {
2440         info_map::const_iterator const it = lyx_info_map.find(action);
2441         return it != lyx_info_map.end() ? it->second.type : Hidden;
2442 }
2443
2444
2445 bool LyXAction::funcHasFlag(FuncCode action,
2446                             LyXAction::func_attrib flag) const
2447 {
2448         info_map::const_iterator ici = lyx_info_map.find(action);
2449
2450         if (ici == lyx_info_map.end()) {
2451                 LYXERR0("action: " << action << " is not known.");
2452                 LASSERT(false, /**/);
2453         }
2454
2455         return ici->second.attrib & flag;
2456 }
2457
2458
2459 LyXAction::const_func_iterator LyXAction::func_begin() const
2460 {
2461         return lyx_func_map.begin();
2462 }
2463
2464
2465 LyXAction::const_func_iterator LyXAction::func_end() const
2466 {
2467         return lyx_func_map.end();
2468 }
2469
2470
2471 } // namespace lyx