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