]> 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 /*!
920  * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN
921  * \li Action: Move the cursor to the beginning of the document.
922  * \li Syntax: buffer-begin
923  * \endvar
924  */
925                 { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
926 /*!
927  * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN_SELECT
928  * \li Action: Move the cursor to the beginning of the document adding the
929                traversed text to the selection.
930  * \li Syntax: buffer-begin-select
931  * \endvar
932  */
933                 { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
934 /*!
935  * \var lyx::FuncCode lyx::LFUN_BUFFER_END
936  * \li Action: Move the cursor to the end of the document.
937  * \li Syntax: buffer-end
938  * \endvar
939  */
940                 { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
941 /*!
942  * \var lyx::FuncCode lyx::LFUN_BUFFER_END_SELECT
943  * \li Action: Move the cursor to the end of the document adding the
944                traversed text to the selection.
945  * \li Syntax: buffer-end-select
946  * \endvar
947  */
948                 { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
949
950                 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
951                 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
952                 { LFUN_LINE_DELETE, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
953                 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
954                 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
955 /*!
956  * \var lyx::FuncCode lyx::LFUN_COPY
957  * \li Action: Copies to the clipboard the last edit.
958  * \li Syntax: copy
959  * \endvar
960  */
961                 { LFUN_COPY, "copy", ReadOnly, Edit },
962 /*!
963  * \var lyx::FuncCode lyx::LFUN_CUT
964  * \li Action: Cuts to the clipboard.
965  * \li Syntax: cut
966  * \endvar
967  */
968                 { LFUN_CUT, "cut", Noop, Edit },
969 /*!
970  * \var lyx::FuncCode lyx::LFUN_PASTE
971  * \li Action: Pastes from the active clipboard.
972  * \li Syntax: paste
973  * \endvar
974  */
975                 { LFUN_PASTE, "paste", Noop, Edit },
976                 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
977 /*!
978  * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
979  * \li Action: Pastes the material currently selected.
980  * \li Syntax: primary-selection-paste
981  * \endvar
982  */
983                 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
984 /*!
985  * \var lyx::FuncCode lyx::LFUN_UNDO
986  * \li Action: Undoes the last edit.
987  * \li Syntax: undo
988  * \endvar
989  */
990                 { LFUN_UNDO, "undo", Noop, Edit },
991 /*!
992  * \var lyx::FuncCode lyx::LFUN_REDO
993  * \li Action: Redoes the last thing undone.
994  * \li Syntax: redo
995  * \endvar
996  */
997                 { LFUN_REDO, "redo", Noop, Edit },
998 /*!
999  * \var lyx::FuncCode lyx::LFUN_REPEAT
1000  * \li Action: Repeat the given command.
1001  * \li Syntax: repeat <COUNT> <LFUN-COMMAND>
1002  * \li Author: poenitz, 27 Oct 2003
1003  * \endvar
1004  */
1005                 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
1006 /*!
1007  * \var lyx::FuncCode lyx::LFUN_CHARS_TRANSPOSE
1008  * \li Action: Transposes the character at the cursor with the one before it.
1009  * \li Syntax: chars-transpose
1010  * \li Author: Lgb, 25 Apr 2001
1011  * \endvar
1012  */
1013                 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
1014
1015                 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
1016                 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
1017                 { LFUN_ENVIRONMENT_INSERT, "environment-insert", Noop, Edit },
1018
1019 /*!
1020  * \var lyx::FuncCode lyx::LFUN_FONT_BOLD
1021  * \li Action: Toggles the bold font (selection-wise).
1022  * \li Syntax: font-bold
1023  * \endvar
1024  */
1025                 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
1026 /*!
1027  * \var lyx::FuncCode lyx::LFUN_FONT_TYPEWRITER
1028  * \li Action: Toggles the typewriter family font (selection-wise).
1029  * \li Syntax: font-typewriter
1030  * \endvar
1031  */
1032                 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
1033 /*!
1034  * \var lyx::FuncCode lyx::LFUN_FONT_UNDERLINE
1035  * \li Action: Toggles underline in the font (selection-wise).
1036  * \li Syntax: font-underline
1037  * \endvar
1038  */
1039                 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
1040 /*!
1041  * \var lyx::FuncCode lyx::LFUN_FONT_EMPH
1042  * \li Action: Toggles the emphasis font style (selection-wise).
1043  * \li Syntax: font-emph
1044  * \endvar
1045  */
1046                 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
1047 /*!
1048  * \var lyx::FuncCode lyx::LFUN_FONT_NOUN
1049  * \li Action: Toggles Noun text style font (selection-wise).
1050  * \li Syntax: font-noun
1051  * \endvar
1052  */
1053                 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
1054 /*!
1055  * \var lyx::FuncCode lyx::LFUN_FONT_ROMAN
1056  * \li Action: Toggles Roman family font (selection-wise).
1057  * \li Syntax: font-roman
1058  * \endvar
1059  */
1060                 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
1061 /*!
1062  * \var lyx::FuncCode lyx::LFUN_FONT_SANS
1063  * \li Action: Toggles Sans Serif family font (selection-wise).
1064  * \li Syntax: font-sans
1065  * \endvar
1066  */
1067                 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
1068 /*!
1069  * \var lyx::FuncCode lyx::LFUN_FONT_FRAK
1070  * \li Action: Toggles Fraktur family font (math-mode, selection-wise).
1071  * \li Syntax: font-frak
1072  * \li Origin: vermeer, 10 Jan 2002
1073  * \endvar
1074  */
1075                 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
1076 /*!
1077  * \var lyx::FuncCode lyx::LFUN_FONT_ITAL
1078  * \li Action: Toggles Italics font shape (math-mode, selection-wise).
1079  * \li Syntax: font-ital
1080  * \li Origin: vermeer, 10 Jan 2002
1081  * \endvar
1082  */
1083                 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
1084 /*!
1085  * \var lyx::FuncCode lyx::LFUN_FONT_DEFAULT
1086  * \li Action: Reverts the settings of the font to the default values (selection-wise).
1087  * \li Syntax: font-default
1088  * \endvar
1089  */
1090                 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
1091                 { LFUN_FONT_FREE_APPLY, "font-free-apply", Noop, Layout },
1092                 { LFUN_FONT_FREE_UPDATE, "font-free-update", Noop, Layout },
1093                 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
1094                 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
1095 /*!
1096  * \var lyx::FuncCode lyx::LFUN_FONT_STATE
1097  * \li Action: Returns the info about the current font.
1098  * \li Syntax: font-state
1099  * \endvar
1100  */
1101                 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
1102
1103                 { LFUN_BIBITEM_INSERT, "bibitem-insert", Noop, Edit },
1104                 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
1105                 { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit },
1106                 { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
1107
1108 /*!
1109  * \var lyx::FuncCode lyx::LFUN_LAYOUT
1110  * \li Action: Sets the layout (that is, environment) for the current paragraph.
1111  * \li Syntax: layout <LAYOUT>
1112  * \li Params: <LAYOUT>: the layout to use
1113  * \endvar
1114  */
1115                 { LFUN_LAYOUT, "layout", Noop, Layout },
1116 /*!
1117  * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH
1118  * \li Action: Launches the paragraph settings dialog.
1119  * \li Syntax: layout-paragraph
1120  * \endvar
1121  */
1122                 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
1123 /*!
1124  * \var lyx::FuncCode lyx::LFUN_LAYOUT_TABULAR
1125  * \li Action: Launches the tabular settings dialog.
1126  * \li Syntax: layout-tabular
1127  * \li Origin: Jug, 31 Jul 2000
1128  * \endvar
1129  */
1130                 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
1131 /*!
1132  * \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE
1133  * \li Action: Displays list of layout choices.
1134  * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
1135                dropbox allowing for choice of layout.
1136  * \li Syntax: drop-layouts-choice
1137  * \endvar
1138  */
1139                 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
1140 /*!
1141  * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
1142  * \li Action: Clears the module list.
1143  * \li Notion: Clears the list of included modules for the current buffer.
1144  * \li Syntax: layout-modules-clear
1145  * \li Origin: rgh, 25 August 2007
1146  * \endvar
1147  */
1148                 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", Noop, Layout },
1149 /*!
1150  * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULE_ADD
1151  * \li Action: Adds a module.
1152  * \li Notion: Adds a module to the list of included modules for the current buffer.
1153  * \li Syntax: layout-module-add <MODULE>
1154  * \li Params: <MODULE>: the module to be added
1155  * \li Origin: rgh, 25 August 2007
1156  * \endvar
1157  */
1158                 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", Noop, Layout },
1159 /*!
1160  * \var lyx::FuncCode lyx::LFUN_LAYOUT_RELOAD
1161  * \li Action: Reloads layout information.
1162  * \li Notion: Reloads all layout information for the current buffer from disk, thus
1163                recognizing any changes that have been made to layout files on the fly.
1164                This is intended to be used only by layout developers and should not be
1165                used when one is trying to do actual work.
1166  * \li Syntax: layout-reload
1167  * \li Origin: rgh, 3 September 2007
1168  * \endvar
1169  */
1170                 { LFUN_LAYOUT_RELOAD, "layout-reload", Noop, Layout },
1171 /*!
1172  * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
1173  * \li Action: Sets the text class for the current buffer.
1174  * \li Syntax: textclass-apply <TEXTCLASS>
1175  * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
1176                    the filename, minus the ".layout" extension.
1177  * \endvar
1178  */
1179                 { LFUN_TEXTCLASS_APPLY, "textclass-apply", Noop, Layout },
1180 /*!
1181  * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
1182  * \li Action: Loads information for a textclass from disk.
1183  * \li Syntax: textclass-load <TEXTCLASS>
1184  * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
1185                    the filename, minus the ".layout" extension.
1186  * \endvar
1187  */
1188                 { LFUN_TEXTCLASS_LOAD, "textclass-load", Noop, Layout },
1189
1190 /*!
1191  * \var lyx::FuncCode lyx::LFUN_MARK_OFF
1192  * \li Action: Disable selecting of text-region.
1193  * \li Syntax: mark-off
1194  * \endvar
1195  */
1196                 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
1197 /*!
1198  * \var lyx::FuncCode lyx::LFUN_MARK_ON
1199  * \li Action: Enable selecting of text-region.
1200  * \li Notion: After enabling you can simply move arrow keys to get selected region.
1201  * \li Syntax: mark-on
1202  * \endvar
1203  */
1204                 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
1205 /*!
1206  * \var lyx::FuncCode lyx::LFUN_MARK_TOGGLE
1207  * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
1208  * \li Syntax: mark-toggle
1209  * \li Origin: poenitz, May 5 2006
1210  * \endvar
1211  */
1212                 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
1213                 
1214                 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
1215                 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
1216                 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
1217                 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
1218                 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
1219                 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
1220                 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
1221                 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
1222                 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
1223                 { LFUN_MATH_SPACE, "math-space", Noop, Math },
1224                 { LFUN_MATH_IMPORT_SELECTION, "math-import-selection", Noop, Math },
1225                 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
1226                 { LFUN_MATH_MODE, "math-mode", Noop, Math },
1227 /*!
1228  * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
1229  * \li Action: Toggles numbering of the current formula line.
1230  * \li Notion: Must be in display formula mode.
1231  * \li Syntax: math-number-line-toggle
1232  * \li Origin: Alejandro 18 Jun 1996
1233  * \endvar
1234  */
1235                 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
1236 /*!
1237  * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
1238  * \li Action: Toggles numbering/labeling of the current formula.
1239  * \li Notion: Must be in display formula mode.
1240  * \li Syntax: math-number-toggle
1241  * \li Origin: Alejandro 4 Jun 1996
1242  * \endvar
1243  */
1244                 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
1245                 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
1246                 { LFUN_MATH_SIZE, "math-size", Noop, Math },
1247 /*!
1248  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
1249  * \li Action: Unfold a Math Macro.
1250  * \li Notion: Unfold the Math Macro the cursor is in, i.e.
1251                display it as \foo.
1252  * \li Syntax: math-macro-unfold
1253  * \li Origin: sts, 06 January 2008
1254  * \endvar
1255  */
1256                 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
1257 /*!
1258  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
1259  * \li Action: Fold a Math Macro.
1260  * \li Notion: Fold the Math Macro the cursor is in if it was
1261                unfolded, i.e. displayed as \foo before.
1262  * \li Syntax: math-macro-fold
1263  * \li Origin: sts, 06 January 2008
1264  * \endvar
1265  */
1266                 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
1267 /*!
1268  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
1269  * \li Action: Add a parameter.
1270  * \li Notion: Add a parameter to a Math Macro.
1271  * \li Params: <NUM>: The number of the parameter behind which the new one
1272                will be added (1 for the first, i.e. use 0 for add a
1273                parameter at the left), defaults to the last one.
1274  * \li Syntax: math-macro-add-param <NUM>
1275  * \li Origin: sts, 06 January 2008
1276  * \endvar
1277  */
1278                 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
1279 /*!
1280  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
1281  * \li Action: Remove the last parameter.
1282  * \li Notion: Remove the last parameter of a Math Macro and
1283                remove its value in all instances of the macro
1284                in the buffer.
1285  * \li Params: <NUM>: The number of the parameter to be deleted (1 for
1286                the first), defaults to the last one.
1287  * \li Syntax: math-macro-remove-param <NUM>
1288  * \li Origin: sts, 06 January 2008
1289  * \endvar
1290  */
1291                 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
1292 /*!
1293  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
1294  * \li Action: Append a greedy parameter.
1295  * \li Notion: Append a greedy parameter to a Math Macro which
1296                eats the following mathed cell in every instance of
1297                the macro in the buffer.
1298  * \li Syntax: math-macro-append-greedy-param
1299  * \li Origin: sts, 06 January 2008
1300  * \endvar
1301  */
1302                 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
1303 /*!
1304  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
1305  * \li Action: Remove a greedy parameter.
1306  * \li Notion: Remove a greedy parameter of a Math Macro and spit
1307                out the values of it in every instance of the macro
1308                in the buffer. If it is an optional parameter the [valud]
1309                format is used.
1310  * \li Syntax: math-macro-remove-greedy-param
1311  * \li Origin: sts, 06 January 2008
1312  * \endvar
1313  */
1314                 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
1315 /*!
1316  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
1317  * \li Action: Make a parameter optional.
1318  * \li Notion: Turn the first non-optional parameter of a Math Macro
1319                into an optional parameter with a default value.
1320  * \li Syntax: math-macro-make-optional
1321  * \li Origin: sts, 06 January 2008
1322  * \endvar
1323  */
1324                 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
1325 /*!
1326  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
1327  * \li Action: Make a parameter non-optional.
1328  * \li Notion: Turn the last optional parameter of a Math Macro
1329                into a non-optional parameter. The default value is
1330                remembered to be reused later if the user changes his mind.
1331  * \li Syntax: math-macro-make-nonoptional
1332  * \li Origin: sts, 06 January 2008
1333  * \endvar
1334  */
1335                 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
1336 /*!
1337  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
1338  * \li Action: Add an optional parameter.
1339  * \li Notion: Insert an optional parameter just behind the
1340                already existing optional parameters.
1341  * \li Syntax: math-macro-add-optional-param
1342  * \li Origin: sts, 06 January 2008
1343  * \endvar
1344  */
1345                 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
1346 /*!
1347  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
1348  * \li Action: Remove the last optional parameter.
1349  * \li Notion: Remove the last optional parameter of a Math Macro and
1350                remove it in all the instances of the macro in the buffer.
1351  * \li Syntax: math-macro-remove-optional-param
1352  * \li Origin: sts, 06 January 2008
1353  * \endvar
1354  */
1355                 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
1356 /*!
1357  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
1358  * \li Action: Add a greedy optional parameter.
1359  * \li Notion: Add a greedy optional parameter which eats the value
1360                from the following cells in mathed which are in the [value]
1361                format.
1362  * \li Syntax: math-macro-add-greedy-optional-param
1363  * \li Origin: sts, 06 January 2008
1364  * \endvar
1365  */
1366                 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
1367 /*!
1368  * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
1369  * \li Action: Only active in Math Macro definition.
1370  * \li Notion: Dummy function which is only active in a Math Macro definition.
1371                It's used to toggle the Math Macro toolbar if the cursor moves
1372                into a Math Macro definition.
1373  * \li Syntax: in-mathmacrotemplate
1374  * \li Origin: sts, 06 January 2008
1375  * \endvar
1376  */
1377                 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
1378
1379 /*!
1380  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
1381  * \li Action: Moves the current paragraph downwards in the document.
1382  * \li Syntax: paragraph-move-down
1383  * \li Origin: Edwin, 8 Apr 2006
1384  * \endvar
1385  */
1386                 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
1387 /*!
1388  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
1389  * \li Action: Moves the current paragraph upwards in the document.
1390  * \li Syntax: paragraph-move-up
1391  * \li Origin: Edwin, 8 Apr 2006
1392  * \endvar
1393  */
1394                 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
1395
1396 /*!
1397  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP
1398  * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1399                in upward direction.
1400  * \li Syntax: paragraph-up
1401  * \li Origin: Asger, 1 Oct 1996
1402  * \endvar
1403  */
1404                 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
1405 /*!
1406  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP_SELECT
1407  * \li Action: Move the cursor and select the text to the next paragraph (or
1408                begining of the current one) in upward direction.
1409  * \li Syntax: paragraph-up-select
1410  * \li Origin: Asger, 1 Oct 1996
1411  * \endvar
1412  */
1413                 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
1414 /*!
1415  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN
1416  * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1417                in downward direction.
1418  * \li Syntax: paragraph-down
1419  * \li Origin: Asger, 1 Oct 1996
1420  * \endvar
1421  */
1422                 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
1423 /*!
1424  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN_SELECT
1425  * \li Action: Move the cursor and select the text to the next paragraph (or
1426                begining of the current one) in downward direction.
1427  * \li Syntax: paragraph-down-select
1428  * \li Origin: Asger, 1 Oct 1996
1429  * \endvar
1430  */
1431                 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
1432 /*!
1433  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
1434  * \li Action: Jump to a paragraph given by its id number and optionally the
1435                desired position within the paragraph.
1436  * \li Notion: Note that id number of paragraph is not the sequential number of paragraph
1437                seen on the screen. Moreover the id is unique for all opened buffers (documents).
1438  * \li Syntax: paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
1439  * \li Params: <PAR_ID_NUMBER>:  paragraph id
1440                <POSITION_IN_PAR>: desired position within the paragraph
1441  * \li Origin: Dekel, 26 Aug 2000
1442  * \endvar
1443  */
1444                 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly, Edit },
1445 /*!
1446  * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1447  * \li Action: Breaks the current paragraph at the current location.
1448  * \li Syntax: break-paragraph
1449  * \endvar
1450  */
1451                 { LFUN_PARAGRAPH_SPACING, "paragraph-spacing", Noop, Edit },
1452 /*!
1453  * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1454  * \li Action: Breaks the current paragraph at the current location.
1455  * \li Notion: Removes the selection.
1456  * \li Syntax: break-paragraph [<LAYOUT>]
1457  * \li Params: <LAYOUT>: "inverse" - decreases depth by one (or change layout
1458                          to default layout) when the cursor is at the end of
1459                          the line.
1460  * \endvar
1461  */
1462                 { LFUN_BREAK_PARAGRAPH, "break-paragraph", Noop, Edit },
1463 /*!
1464  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
1465  * \li Action: Change paragraph settings.
1466  * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
1467                This function only modifies, and does not override, existing settings.
1468                Note that the "leftindent" indent setting is deprecated.
1469  * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
1470  * \li Params: <INDENT>:  \\noindent|\\indent|\\indent-toggle|\\leftindent LENGTH\n
1471                <SPACING>: \\paragraph_spacing default|single|onehalf|double|other\n
1472                <ALIGN>:   \\align block|left|right|center|default\n
1473                <OTHERS>:  \\labelwidthstring WIDTH|\\start_of_appendix\n
1474  * \li Origin: rgh, Aug 15 2007
1475  * \endvar
1476  */
1477                 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
1478 /*!
1479  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
1480  * \li Action: Change paragraph settings.
1481  * \li Notion: Overwrite all nonspecified settings to the default ones.
1482                Use paragraph-params lfun if you don't want to overwrite others settings.
1483  * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
1484  * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
1485  * \li Origin: leeming, 30 Mar 2004
1486  * \endvar
1487  */
1488                 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
1489                 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
1490
1491 /*!
1492  * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
1493  * \li Action: Move the current group in the upward direction in the
1494                structure of the document.
1495  * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1496                the whole substructure of the group.
1497  * \li Syntax: outline-up
1498  * \li Origin: Vermeer, 23 Mar 2006
1499  * \endvar
1500  */
1501                 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
1502 /*!
1503  * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
1504  * \li Action: Move the current group in the downward direction in the
1505                structure of the document.
1506  * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1507                the whole substructure of the group.
1508  * \li Syntax: outline-down
1509  * \li Origin: Vermeer, 23 Mar 2006
1510  * \endvar
1511  */
1512                 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
1513 /*!
1514  * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
1515  * \li Action: Moves the current group in the downward direction in the
1516                hierarchy of the document structure.
1517  * \li Notion: Part -> Chapter -> Section -> etc.
1518  * \li Syntax: outline-in
1519  * \li Origin: Vermeer, 23 Mar 2006
1520  * \endvar
1521  */
1522                 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
1523 /*!
1524  * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
1525  * \li Action: Moves the current group in the upward direction in the
1526                hierarchy of the document structure.
1527  * \li Notion: Part <- Chapter <- Section <- etc.
1528  * \li Syntax: outline-out
1529  * \li Origin: Vermeer, 23 Mar 2006
1530  * \endvar
1531  */
1532                 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
1533 /*!
1534  * \var lyx::FuncCode lyx::LFUN_INSET_EDIT
1535  * \li Action: Edit the inset at cursor with an external application,
1536  *             if one is attributed.
1537  * \li Syntax: inset-edit [<INSET_PARAMS>]
1538  * \li Params: <INSET_PARAMS>: Parameters for the inset.
1539                                Currently only the filename will be considered.
1540  * \li Origin: JSpitzm, 27 Apr 2006
1541  * \endvar
1542  */
1543                 { LFUN_INSET_EDIT, "inset-edit", Noop, Edit },
1544
1545                 { LFUN_CELL_BACKWARD, "cell-backward", Noop, Edit },
1546                 { LFUN_CELL_FORWARD, "cell-forward", Noop, Edit },
1547                 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
1548                 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
1549                 { LFUN_TABULAR_FEATURE, "tabular-feature", Noop, Edit },
1550
1551                 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
1552                 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
1553                 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
1554                 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
1555                 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
1556
1557                 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
1558                 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
1559                 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
1560                 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
1561                 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
1562                 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
1563                 { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
1564                 { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
1565
1566 /*!
1567  * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
1568  * \li Action: Apply data for an inset.
1569  * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
1570                be applied. This is either changed to #LFUN_INSET_MODIFY or
1571                #LFUN_INSET_INSERT depending on the context where it is called.
1572  * \li Syntax: inset-apply <ARGS>
1573  * \li Params: See #LFUN_INSET_INSERT .
1574  * \endvar
1575  */
1576                 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
1577 /*!
1578  * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE
1579  * \li Action: Dissolve the current inset into text.
1580  * \li Syntax: inset-dissolve [<INSET>]
1581  * \li Params: <INSET>: this can be used to make sure the right kind of inset
1582                         is dissolved. For example "dissolve" entry in the charstyles
1583                         sub-menu should only dissolve the charstyle inset, even if the
1584                         cursor is inside several nested insets of different type.\n
1585                         For values see #lyx::InsetLayout::lyxtype_ .
1586  * \li Author: JSpitz, 7 Aug 2006
1587  * \endvar
1588  */
1589                 { LFUN_INSET_DISSOLVE, "inset-dissolve", Noop, Edit },
1590 /*!
1591  * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
1592  * \li Action: Insert new inset (type given by the parameters).
1593  * \li Syntax: inset-insert <INSET> <ARGS>
1594  * \li Params: <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics|
1595                          hyperlink|include|index|label|nomencl|vspace|ref|toc>\n
1596                <ARGS>: depends on the given inset. Use "lyx -dbg action" to
1597                        explore.
1598  * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
1599                where <label name> is the name of the referenced label and
1600                <Format> is one of the following: \n
1601                ref -- <reference> \n
1602                eqref -- (<reference>) \n
1603                pageref -- <page> \n
1604                vpageref -- on <page> \n
1605                vref -- <reference> on <page> \n
1606                prettyref -- Formatted reference
1607  * \endvar
1608  */
1609                 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
1610 /*!
1611  * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
1612  * \li Action: Modify existing inset.
1613  * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1614                bibtex, ert, command, graphics, note, space, vspace, tabular,
1615                bibitem, inlude, ref insets.
1616  * \li Syntax: inset-modify <INSET> <ARGS>
1617  * \li Params: See #LFUN_INSET_INSERT for further details.
1618  * \endvar
1619  */
1620                 { LFUN_INSET_MODIFY, "", Noop, Hidden },
1621 /*!
1622  * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_MODIFY
1623  * \li Action: Modify the inset at cursor position, if there is one.
1624  * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1625                bibtex, ert, command, graphics, note, space, vspace, tabular,
1626                bibitem, inlude, ref insets.
1627  * \li Syntax: next-inset-modify <INSET> <ARGS> or next-inset-modify changetype <TYPE>
1628  * \li Params: See #LFUN_INSET_INSERT for further details.
1629  * \li Origin: JSpitzm, 23 Mar 2008
1630  * \endvar
1631  */
1632                 { LFUN_NEXT_INSET_MODIFY, "next-inset-modify", ReadOnly, Edit },
1633                 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
1634 /*!
1635  * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
1636  * \li Action: Open the inset's properties dialog.
1637  * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
1638  * \li Syntax: inset-settings <INSET>
1639  * \li Params: <INSET>: <box|branch|ert|float|listings|note|tabular|wrap>
1640  * \endvar
1641  */
1642                 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly, Edit },
1643 /*!
1644  * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_TOGGLE
1645  * \li Action: Toggles the inset at cursor position. For collapsables, this means it will
1646                be (un-)collapsed, in case of other insets, the editing widget (dialog) will
1647                be entered. Also cf. #LFUN_INSET_SETTINGS.
1648  * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1649                bibtex, ert, command, graphics, note, space, vspace, tabular,
1650                bibitem, inlude, ref insets.
1651  * \li Syntax: next-inset-toggle <ARG>
1652  * \li Params: <ARG>: these are passed as arguments to #LFUN_INSET_TOGGLE .
1653  * \li Origin: leeming, 30 Mar 2004
1654  * \endvar
1655  */
1656                 { LFUN_NEXT_INSET_TOGGLE, "next-inset-toggle", ReadOnly, Edit },
1657 /*!
1658  * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
1659  * \li Action: Toggles the collapsable inset we are currently in.
1660  * \li Syntax: inset-toggle [<ARG>]
1661  * \li Params: <ARG>: <open|close|toggle|assign>. \n
1662                open/close/toggle are for collapsable insets. close can be currently used
1663                by #LFUN_NEXT_INSET_TOGGLE. toggle is used when no argument is given.\n
1664                assign is for branch inset.
1665  * \li Origin: lasgouttes, 19 Jul 2001
1666  * \endvar
1667  */
1668                 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly, Hidden },
1669 /*!
1670  * \var lyx::FuncCode lyx::LFUN_ALL_INSETS_TOGGLE
1671  * \li Action: Toggles (open/closes) all collapsable insets (of a given type) in the document.
1672  * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
1673  * \li Syntax: all-insets-toggle <STATE> <INSET>
1674  * \li Params: <STATE>: <toggle|open|close> default: toggle \n
1675                <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all insets \n
1676  * \li Origin: leeming, 30 Mar 2004
1677  * \endvar
1678  */
1679                 { LFUN_ALL_INSETS_TOGGLE, "all-insets-toggle", ReadOnly, Edit },
1680 /*!
1681  * \var lyx::FuncCode lyx::LFUN_GRAPHICS_GROUPS_UNIFY
1682  * \li Action: Unify all graphics insets with the one given as an parameter.
1683  * \li Notion: This is internally used for synchronize certain group of graphics insets.
1684  * \li Syntax: graphics-groups-unigfy <GRAPHICS_PARAMS>
1685  * \li Params: <GRAPHICS_PARAMS>: Parameters for graphics inset
1686                                   (syntax can be seen in .lyx files).
1687  * \li Origin: sanda, 6 May 2008
1688  * \endvar
1689  */
1690                 { LFUN_GRAPHICS_GROUPS_UNIFY, "graphics-groups-unify", ReadOnly, Edit },
1691 /*!
1692  * \var lyx::FuncCode lyx::LFUN_SET_GRAPHICS_GROUP
1693  * \li Action: Set the group for the graphics inset on the cursor position.
1694  * \li Syntax: set-graphics-group [<GROUP>]
1695  * \li Params: <GROUP>: Id for an existing group. In case tthe Id is an empty string,
1696                         the graphics inset is removed from the current group.
1697  * \li Origin: sanda, 6 May 2008
1698  * \endvar
1699  */
1700                 { LFUN_SET_GRAPHICS_GROUP, "set-graphics-group", ReadOnly, Edit },
1701
1702 /*!
1703  * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
1704  * \li Action: Moves the cursor out of the current slice, going forward.
1705  * \li Notion: Cursor movement within an inset may be different than cursor
1706                movement in the surrounding text. This action should be called
1707                automatically by the cursor movement within the inset, when
1708                movement within the inset has ceased (reached the end of the
1709                last paragraph, for example), in order to move correctly
1710                back into the surrounding text.
1711  * \endvar
1712  */
1713                 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
1714 /*!
1715  * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
1716  * \li Action: Moves the cursor out of the current slice, going backwards.
1717  * \li Notion: See also #LFUN_FINISHED_FORWARD.
1718  * \endvar
1719  */
1720                 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
1721 /*!
1722  * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
1723  * \li Action: Moves the cursor out of the current slice, going right.
1724  * \li Notion: See also #LFUN_FINISHED_FORWARD
1725  * \endvar
1726  */
1727                 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
1728 /*!
1729  * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
1730  * \li Action: Moves the cursor out of the current slice, going left.
1731  * \li Notion: See also #LFUN_FINISHED_FORWARD.
1732  * \endvar
1733  */
1734                 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
1735
1736                 { LFUN_LANGUAGE, "language", Noop, Edit },
1737
1738 /*!
1739  * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
1740  * \li Action: Goto a label.
1741  * \li Syntax: label-goto [<LABEL>]
1742  * \li Params: <LABEL>: Requested label. If no label is given and refernce
1743                         is on cursor position, Bookmark 0 is saved and
1744                         cursor moves to the position of referenced label.
1745  * \li Origin: Ale, 6 Aug 1997
1746  * \endvar
1747  */
1748                 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
1749 /*!
1750  * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT
1751  * \li Action: Inserts label to text or displayed formula.
1752  * \li Syntax: label-insert [<LABEL>]
1753  * \li Params: <LABEL>: Requested label. If no label is given dialog requesting
1754                         name will be opened.
1755  * \endvar
1756  */
1757                 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
1758 /*!
1759  * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
1760  * \li Action: Go to the next label or cross-reference.
1761  * \li Syntax: reference-next
1762  * \li Origin: Dekel, 14 Jan 2001
1763  * \endvar
1764  */
1765                 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
1766
1767 /*!
1768  * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
1769  * \li Action: Goto a bookmark.
1770  * \li Notion: Moves the cursor to the numbered bookmark, opening the file
1771                if necessary. Note that bookmarsk are saved per-session, not
1772                per file.
1773  * \li Syntax: bookmark-goto <NUMBER>
1774  * \li Params: <NUMBER>: the number of the bookmark to restore.
1775  * \li Origin: Dekel, 27 January 2001
1776  * \endvar
1777  */
1778                 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
1779 /*!
1780  * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
1781  * \li Action: Save a bookmark.
1782  * \li Notion: Saves a numbered bookmark to the sessions file. The number
1783                must be between 1 and 9, inclusive. Note that bookmarks are
1784                saved per-session, not per file.
1785  * \li Syntax: bookmark-save <NUMBER>
1786  * \li Params: <NUMBER>: the number of the bookmark to save.
1787  * \li Origin: Dekel, 27 January 2001
1788  * \endvar
1789  */
1790                 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
1791 /*!
1792  * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
1793  * \li Action: Clears the list of saved bookmarks.
1794  * \li Syntax: bookmark-clear
1795  * \li Origin: bpeng, 31 October 2006
1796  * \endvar
1797  */
1798                 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
1799
1800 /*!
1801  * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
1802  * \li Action: Open the given help file according to the language setting.
1803  * \li Syntax: help-open <FILE>[.lyx]
1804  * \li Params: <FILE>: any document from (/usr/share/)doc directory.
1805  * \li Author: Jug, 27 Jun 1999
1806  * \endvar
1807  */
1808                 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
1809 /*!
1810  * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
1811  * \li Action: Terminates the current LyX instance.
1812  * \li Notion: Terminates the current LyX instance, asking whether to save
1813                modified documents, etc.
1814  * \li Syntax: lyx-quit
1815  * \endvar
1816  */
1817                 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
1818 /*!
1819  * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
1820  * \li Action: Toggles visibility of a given toolbar between on/off/auto.
1821  * \li Notion: Skiping "auto" when allowauto is false.
1822  * \li Syntax: toolbar-toggle <NAME> [allowauto]
1823  * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|
1824                        minibuffer|review|view/update|math_panels
1825  * \li Origin: Edwin, 21 May 2007
1826  * \endvar
1827  */
1828                 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
1829 /*!
1830  * \var lyx::FuncCode lyx::LFUN_MENU_OPEN
1831  * \li Action: Opens the menu given by its name.
1832  * \li Syntax: menu-open <NAME>
1833  * \li Params: <NAME>: menu name. See various .inc files in lib/ui for candidates.
1834  * \endvar
1835  */
1836                 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
1837 /*!
1838  * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
1839  * \li Action: Various UI visibility-toggling actions.
1840  * \li Syntax: ui-toggle <statusbar|menubar|frame|fullscreen>
1841  * \li Params: statusbar  : Toggle visibility of the statusbar.\n
1842                menubar    : Toggle visibility of the menubar.\n
1843                scrollbar  : Toggle visibility of the scrollbar.\n
1844                frame      : Toggle visibility of the frames around editing window.\n
1845                fullscreen : Toggle fullscreen mode. This also covers calling the
1846                             previous functions. However #LFUN_TOOLBAR_TOGGLE for the
1847                             custom tweaks of the toolbars should be used.
1848  * \li Origin: ps, 9 Feb 2007
1849  * \endvar
1850  */
1851                 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
1852
1853 /*!
1854  * \var lyx::FuncCode lyx::WINDOW_NEW
1855  * \li Action: Creates new empty LyX window.
1856  * \li Notion: Already opened documents from the previous window can be found under View menu.
1857  * \li Syntax: window-new [<GEOMETRY>]
1858  * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently 
1859                            accepted only on Windows platform.
1860  * \li Origin: Abdel, 21 Oct 2006
1861  * \endvar
1862  */
1863                 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
1864 /*!
1865  * \var lyx::FuncCode lyx::LFUN_WINDOW_CLOSE
1866  * \li Action: Closes the current LyX window.
1867  * \li Syntax: window-close
1868  * \li Origin: Abdel, 23 Oct 2006
1869  * \endvar
1870  */
1871                 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
1872
1873 /*!
1874  * \var lyx::FuncCode lyx::LFUN_SPLIT_VIEW
1875  * \li Action: Creates another split view of current buffer.
1876  * \li Notion: All split views act in the same way indpendently.
1877  * \li Syntax: split-view <vertical|horizontal>
1878  * \li Params: horizontal : The work areas are laid out side by side.\n
1879                vertical   : The work areas laid out vertically.\n
1880  * \li Origin: abdel, 20 Feb 2008
1881  * \endvar
1882  */
1883                 { LFUN_SPLIT_VIEW, "split-view", ReadOnly, Buffer },
1884
1885 /*!
1886  * \var lyx::FuncCode lyx::LFUN_CLOSE_TAB_GROUP
1887  * \li Action: Close the current tab group.
1888  * \li Notion: This only closes the work areas, not the buffer themselves.
1889                The still opened buffers can be visualized in another tab group.
1890  * \li Syntax: close-tab-group
1891  * \li Origin: abdel, 21 Feb 2008
1892  * \endvar
1893  */
1894                 { LFUN_CLOSE_TAB_GROUP, "close-tab-group", ReadOnly, Buffer },
1895                 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
1896                 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
1897                 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
1898                 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
1899                 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
1900                 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
1901
1902                 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
1903                 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
1904                 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
1905                 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
1906                 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
1907
1908                 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
1909                 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
1910                 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
1911                 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
1912
1913                 { LFUN_SERVER_CHAR_AFTER, "server-char-after", ReadOnly, System },
1914                 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
1915                 { LFUN_SERVER_GET_NAME, "server-get-name", ReadOnly, System },
1916 /*!
1917  * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
1918  * \li Action: Sets the cursor position based on the row number of generated TeX file.
1919  * \li Syntax: server-goto-file-row <LYX_FILE_NAME> <ROW_NUMBER>
1920  * \li Origin: Edmar, 23 Dec 1998
1921  * \endvar
1922  */
1923                 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly, System },
1924                 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
1925 /*!
1926  * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
1927  * \li Action: Sets the cursor position based on the editing area coordinates
1928                (similar as clicking on that point with left mouse button).
1929  * \li Syntax: server-set-xy <X> <Y>
1930  * \endvar
1931  */
1932                 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
1933 /*!
1934  * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
1935  * \li Action: Returns the coordinates of cursor position in the editing area.
1936  * \li Syntax: server-get-xy
1937  * \endvar
1938  */
1939                 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
1940
1941 /*!
1942  * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
1943  * \li Action: Generates the code (literate programming).
1944  * \li Notion: Latex file with extension \literate_extension is generated.
1945                Then LyX invokes \build_command (with a default of``make'') to generate the code and
1946                \build_error_filter to process the compilation error messages. \n
1947                In case you want to process your literate file with a script, or some other program,
1948                just insert in your lyxrc file an entry with:\n
1949                \build_command "my_script my_arguments" \n
1950                The \build_error_filter differs from the \literate_error_filter only in that the
1951                former will identify error messages from your compiler.
1952  * \li Syntax: build-program
1953  * \endvar
1954  */
1955                 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
1956
1957 /*!
1958  * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
1959  * \li Action: Saves the current buffer to a temporary file.
1960  * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
1961                is called automatically by LyX, to "autosave" the current buffer.
1962  * \li Syntax: buffer-auto-save
1963  * \endvar
1964  */
1965                 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
1966 /*!
1967  * \var lyx::FuncCode lyx::LFUN_BUFFER_CHILD_OPEN
1968  * \li Action: Loads the given child document.
1969  * \li Notion: The current document is treated as a parent.
1970  * \li Syntax: buffer-child-open <FILE>
1971  * \li Params: <FILE>: Filename of the child. The directory of the parent is assumed by default.
1972  * \li Origin: Ale, 28 May 1997
1973  * \endvar
1974  */
1975                 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
1976 /*!
1977  * \var lyx::FuncCode lyx::LFUN_BUFFER_CHKTEX
1978  * \li Action: Runs chktex for the current document.
1979  * \li Syntax: buffer-chktex
1980  * \li Origin: Asger, 30 Oct 1997
1981  * \endvar
1982  */
1983                 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
1984 /*!
1985  * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
1986  * \li Action: Toggles compression of the current document on/off.
1987  * \li Syntax: buffer-toggle-compression
1988  * \li Origin: bpeng, 27 Apr 2006
1989  * \endvar
1990  */
1991                 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
1992 /*!
1993  * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
1994  * \li Action: Closes the current buffer.
1995  * \li Notion: Closes the current buffer, asking whether to save it, etc,
1996                if the buffer has been modified.
1997  * \li Syntax: buffer-close
1998  * \endvar
1999  */
2000                 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
2001 /*!
2002  * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
2003  * \li Action: Exports the current buffer (document) to the given format.
2004  * \li Syntax: buffer-export <FORMAT>
2005  * \li Params: <FORMAT> is either "custom" or one of the formats which you
2006                         can find in Tools->Preferences->File formats->Format.
2007                         Usual format you will enter is "pdf2" (pdflatex),
2008                         "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
2009                         In case of "custom" you will be asked for a format you
2010                         want to start from and for the command that you want to
2011                         apply to this format. Internally the control is then passed
2012                         to #LFUN_BUFFER_EXPORT_CUSTOM.
2013  * \li Origin: Lgb, 29 Jul 1997
2014  * \endvar
2015  */
2016                 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
2017 /*!
2018  * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
2019  * \li Action: Exports the current buffer (document) from the given format using
2020                the given command on it.
2021  * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
2022  * \li Params: <FORMAT> format to start from (LyX will care to produce such
2023                         intermediate file).\n
2024                <COMMAND> this command will be launched on the file. Note that you can
2025                use "$$FName" string to qualify the intermediate file.
2026  * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
2027  * \li Origin: leeming, 27 Mar 2004
2028  * \endvar
2029  */
2030                 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
2031 /*!
2032  * \var lyx::FuncCode lyx::LFUN_BUFFER_PRINT
2033  * \li Action: Prints the current document.
2034  * \li Notion: Many settings can be given via the preferences dialog.
2035  * \li Syntax: buffer-print <TARGET> <TARGET-NAME> <COMMAND>
2036  * \li Params: <TARGET> is either "printer" or "file".\n
2037                <TARGER-NAME> is either "default" or file name or printer name.\n
2038                <COMMAND> command ensuring the printing job.
2039  * \li Sample: buffer-print file "/trash/newfile1.ps" "dvips"
2040  * \li Origin: leeming, 28 Mar 2004
2041  * \endvar
2042  */
2043                 { LFUN_BUFFER_PRINT, "buffer-print", ReadOnly, Buffer },
2044 /*!
2045  * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
2046  * \li Action: Import a given file as a lyx document.
2047  * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
2048                defined convertors in preferences. Look into File->Import menu to get
2049                an idea of the currently active import formats.
2050  * \li Syntax: buffer-import <FORMAT> [<FILE>]
2051  * \li Origin: Asger, 24 Jul 1998
2052  * \endvar
2053  */
2054                 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
2055 /*!
2056  * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
2057  * \li Action: Creates a new buffer (that is, document).
2058  * \li Notion: Implicit path can be set in Preferences dialog.
2059  * \li Syntax: buffer-new [<FILE>]
2060  * \li Params: <FILE>: filename of created file with absolute path.
2061  * \endvar
2062  */
2063                 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
2064 /*!
2065  * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
2066  * \li Action: Creates a new buffer (that is, document) from a template.
2067  * \li Notion: Path for new files and templates can be set in Preferences dialog.
2068                Template will be asked for via Open-dialog.
2069  * \li Syntax: buffer-new-template [<FILE>]
2070  * \li Params: <FILE>: filename of created file with absolute path.
2071  * \endvar
2072  */
2073                 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
2074 /*!
2075  * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
2076  * \li Action: Reverts opened document.
2077  * \li Syntax: buffer-reload
2078  * \li Origin: Asger, 2 Feb 1997
2079  * \endvar
2080  */
2081                 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
2082 /*!
2083  * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
2084  * \li Action: Switch to the given buffer.
2085  * \li Notion: This is useful also in case you need simultaneously more views of the edited
2086                document in different LyX windows.
2087  * \li Syntax: buffer-new-template <BUFFER>
2088  * \li Params: <BUFFER>: already opened document which is to be shown.
2089  * \endvar
2090  */
2091                 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
2092 /*!
2093  * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
2094  * \li Action: Toggle editing mode of the current document between read/write and read-only.
2095  * \li Syntax: buffer-toggle-read-only
2096  * \li Origin: Lgb, 27 May 1997
2097  * \endvar
2098  */
2099                 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
2100 /*!
2101  * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
2102  * \li Action: Displays current buffer in chosen format.
2103  * \li Notion: Displays the contents of the current buffer in the chosen
2104                format, for example, PDF or DVI. This runs the necessary
2105                converter, calls the defined viewer, and so forth.
2106  * \li Syntax: buffer-view <FORMAT>
2107  * \li Params: <FORMAT>: The format to display, where this is one of the
2108                          formats defined (in the current GUI) in the
2109                          Tools>Preferences>File Formats dialog.
2110  * \endvar
2111  */
2112                 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
2113 /*!
2114  * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
2115  * \li Action: Exports the current document and put the result into the
2116                temporary directory.
2117  * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
2118                the output will be rewriten - updated. This is useful in case your viewer
2119                is able to detect such changes (e.g. ghostview for postscript).
2120  * \li Syntax: buffer-update <FORMAT>
2121  * \li Params: <FORMAT>: The format to display, where this is one of the
2122                          formats defined (in the current GUI) in the
2123                          Tools>Preferences>File Formats dialog.
2124  * \li Origin: Dekel, 5 Aug 2000
2125  * \endvar
2126  */
2127                 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
2128
2129 /*!
2130  * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
2131  * \li Action: Saves the current buffer.
2132  * \li Notion: Saves the current buffer to disk, using the filename that
2133                is already associated with the buffer, asking for one if
2134                none is yet assigned.
2135  * \li Syntax: buffer-write
2136  * \endvar
2137  */
2138                 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
2139 /*!
2140  * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
2141  * \li Action: Rename and save current buffer.
2142  * \li Syntax: buffer-write-as <FILENAME>
2143  * \li Params: <FILENAME>: New name of the buffer/file. A relative path
2144                is with respect to the original location of the buffer/file.
2145  * \endvar
2146  */
2147                 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
2148 /*!
2149  * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
2150  * \li Action: Save all changed documents.
2151  * \li Syntax: buffer-write-all
2152  * \li Origin: rgh, gpothier 6 Aug 2007
2153  * \endvar
2154  */
2155                 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
2156 /*!
2157  * \var lyx::FuncCode lyx::LFUN_BUFFER_NEXT
2158  * \li Action: Switch to the next opened document.
2159  * \li Notion: Note that this does not necessarily mean next in tabbar
2160                (for full list see View menu).
2161  * \li Syntax: buffer-next
2162  * \endvar
2163  */
2164                 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
2165 /*!
2166  * \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS
2167  * \li Action: Switch to the previous opened document.
2168  * \li Syntax: buffer-previous
2169  * \endvar
2170  */
2171                 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
2172 /*!
2173  * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
2174  * \li Action: When run from a child document, this updates (exports) document built
2175                 from the master buffer. If a master is not found, it updates the
2176                 current buffer.
2177  * \li Syntax: master-buffer-update
2178  * \li Author: Tommaso, 20 Sep 2007
2179  * \endvar
2180  */
2181                 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
2182 /*!
2183  * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
2184  * \li Action: When run from a child document, this command shows a preview built
2185                from the master buffer. If a master is not found, it previews the
2186                current buffer.
2187  * \li Syntax: master-buffer-view
2188  * \li Author: Tommaso, 20 Sep 2007
2189  * \endvar
2190  */
2191                 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
2192 /*!
2193  * \var lyx::FuncCode lyx::LFUN_BUFFER_LANGUAGE
2194  * \li Action: Set language of the current document.
2195  * \li Syntax: buffer-language <LANG>
2196  * \li Params: <LANG>: language name. See lib/languages for list.
2197  * \li Author: leeming, 30 Mar 2004
2198  * \endvar
2199  */
2200                 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
2201 /*!
2202  * \var lyx::FuncCode lyx::LFUN_BUFFER_SAVE_AS_DEFAULT
2203  * \li Action: Save the current document settings as default.
2204  * \li Notion: The file will will be saved into ~/.lyx/templates/defaults.lyx .
2205  * \li Syntax: buffer-save-as-default [<ARGS>]
2206  * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
2207                        you can find in document header of usual .lyx file.
2208  * \li Author: leeming, 30 Mar 2004
2209  * \endvar
2210  */
2211                 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
2212 /*!
2213  * \var lyx::FuncCode lyx::LFUN_BUFFER_PARAMS_APPLY
2214  * \li Action: Apply the given settings to the current document.
2215  * \li Syntax: buffer-params-apply [<ARGS>]
2216  * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
2217                        you can find in document header of usual .lyx file.
2218  * \li Author: leeming, 30 Mar 2004
2219  * \endvar
2220  */
2221                 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", Noop, Buffer },
2222
2223 /*!
2224  * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
2225  * \li Action: Inserts another LyX file.
2226  * \li Syntax: file-insert [<FILE>]
2227  * \li Params: <FILE>: Filename to be inserted.
2228  * \endvar
2229  */
2230                 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
2231 /*!
2232  * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
2233  * \li Action: Inserts plain text file.
2234  * \li Syntax: file-insert-plaintext [<FILE>]
2235  * \li Params: <FILE>: Filename to be inserted.
2236  * \li Origin: CFO-G, 19 Nov 1997
2237  * \endvar
2238  */
2239                 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
2240 /*!
2241  * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
2242  * \li Action: Inserts plain text file as paragraph (i.e. join lines).
2243  * \li Syntax: file-insert-plaintext-para [<FILE>]
2244  * \li Params: <FILE>: Filename to be inserted.
2245  * \li Origin: Levon, 14 Feb 2001
2246  * \endvar
2247  */
2248                 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
2249 /*!
2250  * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
2251  * \li Action: Open LyX document.
2252  * \li Syntax: file-open [<FILE>]
2253  * \li Params: <FILE>: Filename to be opened.
2254  * \endvar
2255  */
2256                 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
2257
2258 /*!
2259  * \var lyx::FuncCode lyx::LFUN_CALL
2260  * \li Action: Executes a command defined in a .def file.
2261  * \li Notion: The definitions are by default read from lib/commands/default.def.\n
2262                A .def file allows to define a command with \\define "<NAME>" "<LFUN>"
2263                where <NAME> is the name of the new command and <LFUN> is the lfun code
2264                to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
2265                \\def_file "FileName" allows to include another .def file. \n
2266                This is particularly useful in connection with toolbar buttons:
2267                Since the name of the button image for this lfun is 
2268                lib/images/commands/<NAME>.png this is the way to assign an image
2269                to a complex command-sequence.
2270  * \li Syntax: call <NAME>
2271  * \li Params: <NAME>: Name of the command that must be called.
2272  * \li Origin: broider, 2 Oct 2007
2273  * \endvar
2274  */
2275                 { LFUN_CALL, "call", NoBuffer, System },
2276 /*!
2277  * \var lyx::FuncCode lyx::LFUN_META_PREFIX
2278  * \li Action: Simulate halting Meta key (Alt key on PCs).
2279  * \li Notion: Used for buffer editation not for GUI control.
2280  * \li Syntax: meta-prefix
2281  * \endvar
2282  */
2283                 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
2284 /*!
2285  * \var lyx::FuncCode lyx::LFUN_CANCEL
2286  * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
2287  * \li Syntax: cancel
2288  * \endvar
2289  */
2290                 { LFUN_CANCEL, "cancel", NoBuffer, System },
2291
2292 /*!
2293  * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
2294  * \li Action: Opens the minibuffer toolbar so that the user can type in there.
2295  * \li Notion: Usually bound to M-x shortcut.
2296  * \li Syntax: command-execute
2297  * \endvar
2298  */
2299                 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
2300                 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
2301 /*!
2302  * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
2303  * \li Action: Run more commands (LFUN and its parameters) in a sequence.
2304  * \li Syntax: command-sequence <CMDS>
2305  * \li Params: <CMDS>: Sequence of commands separated by semicolons.
2306  * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
2307  * \li Origin: Andre', 11 Nov 1999
2308  * \endvar
2309  */
2310                 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
2311 /*!
2312  * \var lyx::FuncCode lyx::LFUN_MESSAGE
2313  * \li Action: Shows message in statusbar (for script purposes).
2314  * \li Syntax: message <STRING>
2315  * \li Origin: Lgb, 8 Apr 2001
2316  * \endvar
2317  */
2318                 { LFUN_MESSAGE, "message", NoBuffer, System },
2319 /*!
2320  * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
2321  * \li Action: Save user preferences.
2322  * \li Syntax: preferences-save
2323  * \li Origin: Lgb, 27 Nov 1999
2324  * \endvar
2325  */
2326                 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
2327 /*!
2328  * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
2329  * \li Action: Reconfigure the automatic settings.
2330  * \li Syntax: reconfigure
2331  * \li Origin: Asger, 14 Feb 1997
2332  * \endvar
2333  */
2334                 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
2335 /*!
2336  * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
2337  * \li Action: Apply the given settings to user preferences.
2338  * \li Syntax: lyxrc-apply <SETTINGS>
2339  * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
2340                            to get an idea which commands to use and their syntax.
2341                            #lyx::LyXRC::LyXRCTags has the list of possible commands.
2342  * \endvar
2343  */
2344                 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
2345 /*!
2346  * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
2347  * \li Action: Determine whether keep cursor inside the editing window regardless
2348                the scrollbar movement.
2349  * \li Syntax: toggle-cursor-follows-scrollbar
2350  * \li Origin: ARRae, 2 Dec 1997
2351  * \endvar
2352  */
2353                 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
2354 /*!
2355  * \var lyx::FuncCode lyx::LFUN_SET_COLOR
2356  * \li Action: Set the given LyX color to the color defined by the X11 name given.
2357  * \li Notion: A new color entry is created if the color is unknown.
2358                Color names can be stored as a part of user settings.
2359  * \li Syntax: set-color <LYX_NAME> <X11_NAME>
2360  * \li Origin: SLior, 11 Jun 2000
2361  * \endvar
2362  */
2363                 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
2364 /*!
2365  * \var lyx::FuncCode lyx::LFUN_STATISTICS
2366  * \li Action: Count the statistics (number of words and characters)
2367                in the document or in the given selection.
2368  * \li Notion: Note that this function gives the number of words/chars written,
2369                not the number of characters which will be typeset.
2370  * \li Syntax: statistics
2371  * \li Origin: lasgouttes, Jan 27 2004; ps, Jan 8 2008
2372  * \endvar
2373  */
2374                 { LFUN_STATISTICS, "statistics", ReadOnly, System },
2375 /*!
2376  * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
2377  * \li Action: Show the inline completion at the cursor position.
2378  * \li Syntax: completion-inline
2379  * \li Origin: sts, Feb 19 2008
2380  * \endvar
2381  */
2382                 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
2383 /*!
2384  * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
2385  * \li Action: Show the completion popup at the cursor position.
2386  * \li Syntax: completion-popup
2387  * \li Origin: sts, Feb 19 2008
2388  * \endvar
2389  */
2390                 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
2391 /*!
2392  * \var lyx::FuncCode lyx::LFUN_COMPLETION_COMPLETE
2393  * \li Action: Try to complete the word or command at the cursor position.
2394  * \li Syntax: completion-complete
2395  * \li Origin: sts, Feb 19 2008
2396  * \endvar
2397  */
2398                 { LFUN_COMPLETION_COMPLETE, "complete", SingleParUpdate, Edit },
2399 /*!
2400  * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
2401  * \li Action: Activate the branch
2402  * \li Syntax: branch-activate <BRANCH>
2403  * \li Params: <BRANCH>: The branch to activate
2404  * \li Sample: lyx -e pdf2 -x "branch-activate answers" finalexam.lyx \n
2405                could be used to export a pdf with the answers branch included
2406                without one's having to open LyX and activate the branch manually.
2407  * \li Origin: rgh, 27 May 2008
2408  * \endvar
2409  */
2410                 { LFUN_BRANCH_ACTIVATE, "branch-activate", Argument, Buffer },
2411 /*!
2412  * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
2413  * \li Action: De-activate the branch
2414  * \li Syntax: branch-deactivate <BRANCH>
2415  * \li Params: <BRANCH>: The branch to deactivate
2416  * \li Origin: rgh, 27 May 2008
2417  * \endvar
2418  */
2419                 { LFUN_BRANCH_DEACTIVATE, "branch-deactivate", Argument, Buffer },
2420
2421                 { LFUN_NOACTION, "", Noop, Hidden }
2422 #ifndef DOXYGEN_SHOULD_SKIP_THIS
2423         };
2424
2425         for (int i = 0; items[i].action != LFUN_NOACTION; ++i) {
2426                 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
2427         }
2428
2429         init = true;
2430 }
2431 #endif
2432
2433 LyXAction::LyXAction()
2434 {
2435         init();
2436 }
2437
2438
2439 // Returns an action tag from a string.
2440 FuncRequest LyXAction::lookupFunc(string const & func) const
2441 {
2442         string const func2 = trim(func);
2443
2444         if (func2.empty()) {
2445                 return FuncRequest(LFUN_NOACTION);
2446         }
2447
2448         string cmd;
2449         string const arg = split(func2, cmd, ' ');
2450
2451         func_map::const_iterator fit = lyx_func_map.find(cmd);
2452
2453         return fit != lyx_func_map.end() ? FuncRequest(fit->second, arg) : FuncRequest(LFUN_UNKNOWN_ACTION);
2454 }
2455
2456
2457 string const LyXAction::getActionName(FuncCode action) const
2458 {
2459         info_map::const_iterator const it = lyx_info_map.find(action);
2460         return it != lyx_info_map.end() ? it->second.name : string();
2461 }
2462
2463
2464 LyXAction::func_type const LyXAction::getActionType(FuncCode action) const
2465 {
2466         info_map::const_iterator const it = lyx_info_map.find(action);
2467         return it != lyx_info_map.end() ? it->second.type : Hidden;
2468 }
2469
2470
2471 bool LyXAction::funcHasFlag(FuncCode action,
2472                             LyXAction::func_attrib flag) const
2473 {
2474         info_map::const_iterator ici = lyx_info_map.find(action);
2475
2476         if (ici == lyx_info_map.end()) {
2477                 LYXERR0("action: " << action << " is not known.");
2478                 LASSERT(false, /**/);
2479         }
2480
2481         return ici->second.attrib & flag;
2482 }
2483
2484
2485 LyXAction::const_func_iterator LyXAction::func_begin() const
2486 {
2487         return lyx_func_map.begin();
2488 }
2489
2490
2491 LyXAction::const_func_iterator LyXAction::func_end() const
2492 {
2493         return lyx_func_map.end();
2494 }
2495
2496
2497 } // namespace lyx