]> git.lyx.org Git - lyx.git/blob - src/LyXAction.cpp
* Doxy.
[lyx.git] / src / LyXAction.cpp
1 /*!
2  * \file LyXAction.cpp
3  * This file is part of LyX, the document processor.
4  * Licence details can be found in the file COPYING.
5  *
6  * \author Lars Gullik Bjønnes
7  * \author Jean-Marc Lasgouttes
8  * \author John Levon
9  * \author André Pönitz
10  *
11  * Full author contact details are available in file CREDITS.
12  */
13
14 #include <config.h>
15
16 #include "LyXAction.h"
17
18 #include "FuncRequest.h"
19
20 #include "support/debug.h"
21 #include "support/lstrings.h"
22
23 #include "support/lassert.h"
24
25 using namespace std;
26 using namespace lyx::support;
27
28 namespace lyx {
29
30 /*
31      NAMING RULES FOR USER-COMMANDS
32      Here's the set of rules to apply when a new command name is introduced:
33
34      1) Use the object.event order. That is, use `word-forward'
35         instead of `forward-word'.
36      2) Don't introduce an alias for an already named object. Same for events.
37      3) Forward movement or focus is called `forward' (not `right').
38      4) Backward movement or focus is called `backward' (not `left').
39      5) Upward movement of focus is called `up'.
40      6) Downward movement is called `down'.
41      7) The begin of an object is called `begin' (not `start').
42      8) The end of an object is called `end'.
43
44      (May 19 1996, 12:04, RvdK)
45 */
46
47 /* LFUN documentation (a start at least, Chr 2007-08-12)
48  *
49  * The documentation below is primarily notes about restrictions and
50  * oddities relating to the different LFUNs.
51  *
52  * Try to find an appropriate (thematical) place when adding the new LFUN.
53  *
54  * Doxygen template below. Some notes: Parameters should be set in uppercase
55  * and put in <BRACKETS>, as so.
56  */
57
58 /*!
59  * \var lyx::FuncCode lyx::LFUN_
60  * \li Action: 
61  * \li Notion: 
62  * \li Syntax: 
63  * \li Params: 
64  * \li Sample:
65  * \li Origin: 
66  * \endvar
67  */
68
69 LyXAction lyxaction;
70
71
72 void LyXAction::newFunc(FuncCode action, string const & name,
73                         unsigned int attrib, LyXAction::func_type type)
74 {
75         lyx_func_map[name] = action;
76         FuncInfo tmpinfo;
77         tmpinfo.name = name;
78         tmpinfo.attrib = attrib;
79         tmpinfo.type = type;
80         lyx_info_map[action] = tmpinfo;
81 }
82
83
84 // Needed for LFUNs documentation to be accepted, since doxygen won't take
85 // \var inside functions.
86 #ifndef DOXYGEN_SHOULD_SKIP_THIS
87 void LyXAction::init()
88 {
89         // This function was changed to use the array below in initalization
90         // instead of calling newFunc numerous times because of compilation
91         // times. Since the array is not static we get back the memory it
92         // occupies after the init is completed. It compiles several
93         // magnitudes faster.
94
95         static bool init;
96         if (init) return;
97
98         struct ev_item {
99                 FuncCode action;
100                 char const * name;
101                 unsigned int attrib;
102                 func_type type;
103         };
104
105         ev_item const items[] = {
106 #endif
107 /*!
108  * \var lyx::FuncCode lyx::LFUN_ACCENT_ACUTE
109  * \li Action: Adds an acute accent \htmlonly (&aacute;)\endhtmlonly
110                to the next character typed.
111  * \li Syntax: accent-acute
112  * \endvar
113  */
114                 { LFUN_ACCENT_ACUTE, "accent-acute", Noop, Edit },
115 /*!
116  * \var lyx::FuncCode lyx::LFUN_ACCENT_BREVE
117  * \li Action: Adds a breve accent \htmlonly (&#259;)\endhtmlonly
118                to the next character typed.
119  * \li Syntax: accent-breve
120  * \endvar
121  */
122                 { LFUN_ACCENT_BREVE, "accent-breve", Noop, Edit },
123 /*!
124  * \var lyx::FuncCode lyx::LFUN_ACCENT_CARON
125  * \li Action: Adds a caron \htmlonly (&#462;)\endhtmlonly
126                to the next character typed.
127  * \li Syntax: accent-caron
128  * \endvar
129  */
130                 { LFUN_ACCENT_CARON, "accent-caron", Noop, Edit },
131 /*!
132  * \var lyx::FuncCode lyx::LFUN_ACCENT_CEDILLA
133  * \li Action: Adds a cedilla \htmlonly (&ccedil;)\endhtmlonly
134                to the next character typed.
135  * \li Syntax: accent-cedilla
136  * \endvar
137  */
138                 { LFUN_ACCENT_CEDILLA, "accent-cedilla", Noop, Edit },
139 /*!
140  * \var lyx::FuncCode lyx::LFUN_ACCENT_CIRCLE
141  * \li Action: Adds a circle accent \htmlonly (&aring;)\endhtmlonly
142                to the next character typed.
143  * \li Syntax: accent-circle
144  * \endvar
145  */
146                 { LFUN_ACCENT_CIRCLE, "accent-circle", Noop, Edit },
147 /*!
148  * \var lyx::FuncCode lyx::LFUN_ACCENT_CIRCUMFLEX
149  * \li Action: Adds a circumflex \htmlonly (&ecirc;)\endhtmlonly
150                to the next character typed.
151  * \li Syntax: accent-circumflex
152  * \endvar
153  */
154                 { LFUN_ACCENT_CIRCUMFLEX, "accent-circumflex", Noop, Edit },
155 /*!
156  * \var lyx::FuncCode lyx::LFUN_ACCENT_DOT
157  * \li Action: Adds a dot accent \htmlonly (&#380;)\endhtmlonly
158                to the next character typed.
159  * \li Syntax: accent-dot
160  * \endvar
161  */
162                 { LFUN_ACCENT_DOT, "accent-dot", Noop, Edit },
163 /*!
164  * \var lyx::FuncCode lyx::LFUN_ACCENT_GRAVE
165  * \li Action: Adds a grave accent \htmlonly (&egrave;)\endhtmlonly
166                to the next character typed.
167  * \li Syntax: accent-grave
168  * \endvar
169  */
170                 { LFUN_ACCENT_GRAVE, "accent-grave", Noop, Edit },
171 /*!
172  * \var lyx::FuncCode lyx::LFUN_ACCENT_HUNGARIAN_UMLAUT
173  * \li Action: Adds a Hungarian umlaut \htmlonly (&#337;)\endhtmlonly
174                to the next character typed.
175  * \li Syntax: accent-grave
176  * \endvar
177  */
178                 { LFUN_ACCENT_HUNGARIAN_UMLAUT, "accent-hungarian-umlaut", Noop, Edit },
179 /*!
180  * \var lyx::FuncCode lyx::LFUN_ACCENT_MACRON
181  * \li Action: Adds a macron \htmlonly (&#257;)\endhtmlonly
182                to the next character typed.
183  * \li Syntax: accent-macron
184  * \endvar
185  */
186                 { LFUN_ACCENT_MACRON, "accent-macron", Noop, Edit },
187 /*!
188  * \var lyx::FuncCode lyx::LFUN_ACCENT_OGONEK
189  * \li Action: Adds an ogonek accent \htmlonly (&#261;)\endhtmlonly
190                to the next character typed.
191  * \li Syntax: accent-ogonek
192  * \endvar
193  */
194                 { LFUN_ACCENT_OGONEK, "accent-ogonek", Noop, Edit },
195 /*!
196  * \var lyx::FuncCode lyx::LFUN_ACCENT_TIE
197  * \li Action: Adds a tie \htmlonly (a&#865;)\endhtmlonly
198                over the next two character typed.
199  * \li Notion: the following char will finish the tie.
200  * \li Syntax: accent-tie
201  * \endvar
202  */
203                 { LFUN_ACCENT_TIE, "accent-tie", Noop, Edit },
204 /*!
205  * \var lyx::FuncCode lyx::LFUN_ACCENT_TILDE
206  * \li Action: Adds a tilde \htmlonly (&atilde;)\endhtmlonly
207                over the next character typed.
208  * \li Syntax: accent-tilde
209  * \endvar
210  */
211                 { LFUN_ACCENT_TILDE, "accent-tilde", Noop, Edit },
212 /*!
213  * \var lyx::FuncCode lyx::LFUN_ACCENT_UMLAUT
214  * \li Action: Adds an umlaut \htmlonly (&auml;)\endhtmlonly
215                over the next character typed.
216  * \li Syntax: accent-umlaut
217  * \endvar
218  */
219                 { LFUN_ACCENT_UMLAUT, "accent-umlaut", Noop, Edit },
220 /*!
221  * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERBAR
222  * \li Action: Adds a bar \htmlonly (a&#800;)\endhtmlonly
223                under the next character typed.
224  * \li Syntax: accent-underbar
225  * \endvar
226  */
227                 { LFUN_ACCENT_UNDERBAR, "accent-underbar", Noop, Edit },
228 /*!
229  * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERDOT
230  * \li Action: Adds a dot \htmlonly (&#7841;)\endhtmlonly
231                under the next character typed.
232  * \li Syntax: accent-underdot
233  * \endvar
234  */
235                 { LFUN_ACCENT_UNDERDOT, "accent-underdot", Noop, Edit },
236
237 /*!
238  * \var lyx::FuncCode lyx::LFUN_CAPTION_INSERT
239  * \li Action: Inserts a caption inset.
240  * \li Syntax: caption-insert
241  * \li Origin: Lgb, 18 Jul 2000
242  * \endvar
243  */
244                 { LFUN_CAPTION_INSERT, "caption-insert", Noop, Edit },
245 /*!
246  * \var lyx::FuncCode lyx::LFUN_DATE_INSERT
247  * \li Action: Inserts the current date.
248  * \li Syntax: date-insert [<ARG>]
249  * \li Params: <ARG>: Format of date. The default value (%x) can be set
250                      in Preferences->Date format. For possible formats
251                      see manual page of strftime function.
252  * \li Origin: jdblair, 31 Jan 2000
253  * \endvar
254  */
255                 { LFUN_DATE_INSERT, "date-insert", Noop, Edit },
256 /*!
257  * \var lyx::FuncCode lyx::LFUN_FOOTNOTE_INSERT
258  * \li Action: Inserts a footnote inset.
259  * \li Syntax: footnote-insert
260  * \li Origin: Jug, 7 Mar 2000
261  * \endvar
262  */
263                 { LFUN_FOOTNOTE_INSERT, "footnote-insert", Noop, Edit },
264 /*!
265  * \var lyx::FuncCode lyx::LFUN_ERT_INSERT
266  * \li Action: Inserts an ERT inset.
267  * \li Syntax: ert-insert
268  * \li Origin: Jug, 18 Feb 2000
269  * \endvar
270  */
271                 { LFUN_ERT_INSERT, "ert-insert", Noop, Edit },
272                 { LFUN_FLOAT_INSERT, "float-insert", Noop, Edit },
273                 { LFUN_FLOAT_WIDE_INSERT, "float-wide-insert", Noop, Edit },
274                 { LFUN_WRAP_INSERT, "wrap-insert", Noop, Edit },
275 /*!
276  * \var lyx::FuncCode lyx::LFUN_OPTIONAL_INSERT
277  * \li Action: Inserts an optional-argument (short title) inset.
278  * \li Syntax: optional-insert
279  * \li Origin: Martin, 12 Aug 2002
280  * \endvar
281  */
282                 { LFUN_OPTIONAL_INSERT, "optional-insert", Noop, Edit },
283 /*!
284  * \var lyx::FuncCode lyx::LFUN_LINE_INSERT
285  * \li Action: Inserts a horizontal line.
286  * \li Syntax: line-insert
287  * \li Origin: poenitz,  Oct 27 2003
288  * \endvar
289  */
290                 { LFUN_LINE_INSERT, "line-insert", Noop, Edit },
291 /*!
292  * \var lyx::FuncCode lyx::LFUN_NEWPAGE_INSERT
293  * \li Action: Inserts a new page.
294  * \li Syntax: newpage-insert<ARG>
295  * \li Params: <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
296  * \li Origin: uwestoehr, 24 Nov 2007
297  * \endvar
298  */
299                 { LFUN_NEWPAGE_INSERT, "newpage-insert", Noop, Edit },
300 /*!
301  * \var lyx::FuncCode lyx::LFUN_MARGINALNOTE_INSERT
302  * \li Action: Inserts a marginal note.
303  * \li Syntax: marginalnote-insert
304  * \li Origin: Lgb, 26 Jun 2000
305  * \endvar
306  */
307                 { LFUN_MARGINALNOTE_INSERT, "marginalnote-insert", Noop, Edit },
308 /*!
309  * \var lyx::FuncCode lyx::LFUN_UNICODE_INSERT
310  * \li Action: Inserts a single unicode character.
311  * \li Syntax: unicode-insert <CHAR>
312  * \li Params: <CHAR>: The character to insert, given as its code
313                        point, in hexadecimal, e.g.: unicode-insert 0x0100.
314  * \li Origin: Lgb, 22 Oct 2006
315  * \endvar
316  */
317                 { LFUN_UNICODE_INSERT, "unicode-insert", Noop, Edit },
318 /*!
319  * \var lyx::FuncCode lyx::LFUN_LISTING_INSERT
320  * \li Action: Inserts a new listings inset.
321  * \li Syntax: listing-insert
322  * \li Origin: Herbert, 10 Nov 2001; bpeng, 2 May 2007
323  * \endvar
324  */
325                 { LFUN_LISTING_INSERT, "listing-insert", Noop, Edit },
326 /*!
327  * \var lyx::FuncCode lyx::LFUN_QUOTE_INSERT
328  * \li Action: Inserts quotes according to the type and quote-language preference.
329  * \li Action: Currently  English, Swedish, German, Polish, French, Danish quotes
330                are distinguished.
331  * \li Syntax: quote-insert [<TYPE>]
332  * \li Params: TYPE: 'single' for single quotes, otherwise double quotes will be used.
333  * \endvar
334  */
335                 { LFUN_QUOTE_INSERT, "quote-insert", Noop, Edit },
336 /*!
337  * \var lyx::FuncCode lyx::LFUN_INFO_INSERT
338  * \li Action: Displays shortcuts, lyxrc, package and textclass availability and menu
339                information in a non-editable boxed InsetText.
340  * \li Notion: Apart from lfun arguments you can use the following method: \n
341                1. input the type and argument of this inset, e.g. "menu paste", in
342                the work area.\n
343                2. select the text and run info-insert lfun.\n
344  * \li Syntax: info-insert <TYPE> <ARG>
345  * \li Params: <TYPE>: shortcut|lyxrc|package|textclass|menu|buffer \n
346                <ARG>: argument for a given type. Look into InsetInfo.h for detailed
347                       description.
348  * \li Origin: bpeng, 7 Oct 2007
349  * \endvar
350  */
351                 { LFUN_INFO_INSERT, "info-insert", Noop, Edit },
352 /*!
353  * \var lyx::FuncCode lyx::LFUN_BRANCH_INSERT
354  * \li Action: Inserts branch inset.
355  * \li Syntax: branch-insert <BRANCH-NAME>
356  * \li Origin: vermeer, 17 Aug 2003
357  * \endvar
358  */
359                 { LFUN_BRANCH_INSERT, "branch-insert", Noop, Edit },
360 /*!
361  * \var lyx::FuncCode lyx::LFUN_BOX_INSERT
362  * \li Action: Inserts Box inset.
363  * \li Syntax: box-insert [<TYPE>]
364  * \li Params: <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox \n
365                        Framed is the default one.
366  * \li Origin: vermeer, 7 Oct 2003
367  * \endvar
368  */
369                 { LFUN_BOX_INSERT, "box-insert", Noop, Edit },
370 /*!
371  * \var lyx::FuncCode lyx::LFUN_FLEX_INSERT
372  * \li Action: Inserts CharStyle, Custom inset or XML short element.
373  * \li Notion: Look into the Customization manual for more information about
374                these elements.\n
375                For dissolving the element see #LFUN_INSET_DISSOLVE.
376  * \li Syntax: flex-insert <TYPE:Name>
377  * \li Params: TYPE: CharStyle|Custom|Element|Standard
378                      Identifies whether this is a Character Style, a
379                      Custom Inset or an XML Element, and which dynamical 
380                      sub-menu this flex inset is in on the LyX menu tree. 
381                      If Standard (currently unused): none of these.
382                Name: This name must be defined either in your layout file
383                      or imported by some module. The definition is\n
384                      InsetLayout <TYPE:Name>
385  * \li Sample: flex-insert CharStyle:Code
386  * \endvar
387  */
388                 { LFUN_FLEX_INSERT, "flex-insert", Noop, Edit },
389                 { LFUN_SELF_INSERT, "self-insert", SingleParUpdate, Hidden },
390 /*!
391  * \var lyx::FuncCode lyx::LFUN_SPACE_INSERT
392  * \li Action: Inserts one of horizontal space insets.
393  * \li Syntax: space-insert <NAME> [<LEN>]
394  * \li Params: <NAME>: normal, protected, thin, quad, qquad, enspace, enskip,
395                        negthinspace, hfill, hfill*, dotfill, hrulefill, hspace,
396                        hspace* \n
397                <LEN>: length for custom spaces (hspace, hspace* for protected)
398  * \li Origin: JSpitzm, 20 May 2003, Mar 17 2008
399  * \endvar
400  */
401                 { LFUN_SPACE_INSERT, "space-insert", Noop, Edit },
402 /*!
403  * \var lyx::FuncCode lyx::LFUN_HYPERLINK_INSERT
404  * \li Action: Inserts hyperlinks into the document (clickable in pdf output).
405  * \li Notion: Hyperlink target can be set via selection + hyperlink-insert function.
406  * \li Syntax: href-insert [<TARGET>]
407  * \li Origin: CFO-G, 21 Nov 1997
408  * \endvar
409  */
410                 { LFUN_HYPERLINK_INSERT, "href-insert", Noop, Edit },
411 /*!
412  * \var lyx::FuncCode lyx::LFUN_SPECIALCHAR_INSERT
413  * \li Action: Inserts various characters into the document.
414  * \li Syntax: specialchar-insert <CHAR>
415  * \li Params: <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots,
416                        end-of-sentence, menu-separator.
417  * \li Origin: JSpitzm, 6 Dec 2007
418  * \endvar
419  */
420                 { LFUN_SPECIALCHAR_INSERT, "specialchar-insert", Noop, Edit },
421                 { LFUN_TOC_INSERT, "toc-insert", Noop, Edit },
422 /*!
423  * \var lyx::FuncCode lyx::LFUN_APPENDIX
424  * \li Action: Start (or remove) Appendix on the given cursor position.
425  * \li Syntax: appendix
426  * \li Origin: ettrich, 5 May 1998
427  * \endvar
428  */
429                 { LFUN_APPENDIX, "appendix", Noop, Edit },
430
431                 { LFUN_INDEX_INSERT, "index-insert", Noop, Edit },
432                 { LFUN_INDEX_PRINT, "index-print", Noop, Edit },
433
434                 { LFUN_NOMENCL_INSERT, "nomencl-insert", Noop, Edit },
435                 { LFUN_NOMENCL_PRINT, "nomencl-print", Noop, Edit },
436
437                 { LFUN_NOTE_INSERT, "note-insert", Noop, Edit },
438                 { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
439 /*!
440  * \var lyx::FuncCode lyx::LFUN_NEWLINE_INSERT
441  * \li Action: Inserts a line break or new line.
442  * \li Syntax: newline-insert <ARG>
443  * \li Params: <ARG>: <newline|linebreak> default: newline
444  * \li Origin: JSpitzm, 25 Mar 2008
445  * \endvar
446  */
447                 { LFUN_NEWLINE_INSERT, "newline-insert", Noop, Edit },
448
449
450 #if 0
451                 { LFUN_LIST_INSERT, "list-insert", Noop, Edit },
452 #endif
453
454                 { LFUN_DELETE_BACKWARD_SKIP, "delete-backward-skip", Noop, Edit },
455                 { LFUN_DELETE_FORWARD_SKIP, "delete-forward-skip", Noop, Edit },
456                 { LFUN_DOWN, "down", ReadOnly | NoUpdate, Edit },
457                 { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, Edit },
458                 { LFUN_UP, "up", ReadOnly | NoUpdate, Edit },
459                 { LFUN_UP_SELECT, "up-select", ReadOnly | SingleParUpdate, Edit },
460                 { LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit },
461                 { LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit },
462 /*!
463  * \var lyx::FuncCode lyx::LFUN_SCROLL
464  * \li Action: Scroll the buffer view.
465  * \li Notion: Only scrolls the screen up or down; does not move the cursor.
466  * \li Syntax: scroll <TYPE> <QUANTITY>
467  * \li Params: <TYPE>:  line|page\n
468                <QUANTITY>: up|down|<number>
469  * \li Origin: Abdelrazak Younes, Dec 27 2007
470  * \endvar
471  */
472                 { LFUN_SCROLL, "scroll", ReadOnly, Edit },
473 /*!
474  * \var lyx::FuncCode lyx::LFUN_SCREEN_RECENTER
475  * \li Action: Recenters the screen on the current cursor position.
476  * \li Syntax: screen-recenter
477  * \endvar
478  */
479                 { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit },
480                 { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit },
481                 { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit },
482
483                 { LFUN_ERROR_NEXT, "error-next", ReadOnly, Edit },
484 /*!
485  * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD
486  * \li Action: Moves the cursor one position logically backwards.
487  * \li Notion: This is not the action which should be bound to the arrow keys,
488                because backwards may be left or right, depending on the
489                language. The arrow keys should be bound to #LFUN_CHAR_LEFT or
490                #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
491  * \li Syntax: char-backward
492  * \endvar
493  */
494                 { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit },
495 /*!
496  * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD_SELECT
497  * \li Action: Moves the cursor one position logically backwards, adding
498                traversed position to the selection.
499  * \li Notion: See also #LFUN_CHAR_BACKWARD.
500  * \li Syntax: char-backward-select
501  * \endvar
502  */
503                 { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit },
504                 { LFUN_CHAR_DELETE_BACKWARD, "delete-backward", SingleParUpdate, Edit },
505                 { LFUN_CHAR_DELETE_FORWARD, "delete-forward", SingleParUpdate, Edit },
506 /*!
507  * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD
508  * \li Action: Moves the cursor one position logically forward.
509  * \li Notion: This is not the action which should be bound to the arrow keys,
510                because forward may be left or right, depending on the language.
511                The arrow keys should be bound to #LFUN_CHAR_LEFT or
512                #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
513  * \li Syntax: char-forward
514  * \endvar
515  */
516                 { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit },
517 /*!
518  * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD_SELECT
519  * \li Action: Moves the cursor one position logically forward, adding
520                traversed position to the selection.
521  * \li Notion: See also #LFUN_CHAR_FORWARD.
522  * \li Syntax: char-forward-select
523  * \endvar
524  */
525                 { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit },
526 /*!
527  * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT
528  * \li Action: Moves the cursor one position "to the left".
529  * \li Notion: This is the action which should be taken when the "left" key
530                is pressed. Generally, it moves the cursor one position to the
531                left. However, in Bidi text this become slightly more
532                complicated, and there are different modes of cursor movement.
533                In "visual mode", this moves left, plain and simple. In "logical
534                mode", movement is logically forward in RTL paragraphs, and
535                logically backwards in LTR paragraphs.
536  * \li Syntax: char-left
537  * \endvar
538  */
539                 { LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit },
540 /*!
541  * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT_SELECT
542  * \li Action: Moves the cursor one position "to the left", adding 
543                traversed position to the selection.
544  * \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement.
545  * \li Syntax: char-left-select
546  * \endvar
547  */
548                 { LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit },
549 /*!
550  * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT
551  * \li Action: Moves the cursor one position "to the right".
552  * \li Notion: This is the action which should be taken when the "right" key
553                is pressed. Generally, it moves the cursor one position to the
554                right. However, in Bidi text this become slightly more
555                complicated, and there are different modes of cursor movement.
556                In "visual mode", this moves right, plain and simple. In "logical
557                mode", movement is logically forward in LTR paragraphs, and
558                logically backwards in RTL paragraphs.
559  * \li Syntax: char-right
560  * \endvar
561  */
562                 { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit },
563 /*!
564  * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT_SELECT
565  * \li Action: Moves the cursor one position "to the right", adding
566                traversed position to the selection.
567  * \li Notion: See also #LFUN_CHAR_RIGHT for exact details of the movement.
568  * \li Syntax: char-right-select
569  * \endvar
570  */
571                 { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit },
572
573 /*!
574  * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD
575  * \li Action: Moves the cursor to the logically previous beginning of a word.
576  * \li Notion: This is not the action which should be bound to the arrow keys,
577                because backwards may be left or right, depending on the
578                language. The arrow keys should be bound to #LFUN_WORD_LEFT or
579                #LFUN_WORD_RIGHT actions, which in turn may employ this one.
580  * \li Syntax: word-backward
581  * \endvar
582  */
583                 { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit },
584 /*!
585  * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD_SELECT
586  * \li Action: Moves the cursor to the logically previous beginning of a word,
587                            adding the logically traversed text to the selection.
588  * \li Notion: See also #LFUN_WORD_BACKWARD.
589  * \li Syntax: word-backward-select
590  * \endvar
591  */
592                 { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
593                 { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
594                 { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
595                 { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
596 /*!
597  * \var lyx::FuncCode lyx::LFUN_WORD_FIND_FORWARD
598  * \li Action: Search for a given string in forward direction.
599  * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
600  * \li Syntax: word-find-forward [<STRING>]
601  * \li Origin: Etienne, 16 Feb 1998
602  * \endvar
603  */
604                 { LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit },
605 /*!
606  * \var lyx::FuncCode lyx::LFUN_WORD_FIND_BACKWARD
607  * \li Action: Search for a given string in backward direction.
608  * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
609  * \li Syntax: word-find-backward [<STRING>]
610  * \li Origin: Etienne, 20 Feb 1998
611  * \endvar
612  */
613                 { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
614 /*!
615  * \var lyx::FuncCode lyx::LFUN_WORD_FIND
616  * \li Action: Search for next occurence of a string.
617  * \li Syntax: word-find [<DATA>]
618  * \li Params: <DATA>: data encoded from Find dialog (see #lyx::find2string()).
619                        If no parameter is given, search with last find-dialog
620                        data is used for search (i.e. find-next).
621  * \li Origin: poenitz, Jan 7 2004
622  * \endvar
623  */
624                 { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
625                 { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
626 /*!
627  * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD
628  * \li Action: Moves the cursor to the logically next beginning of a word.
629  * \li Notion: This is not the action which should be bound to the arrow keys,
630                because forward may be left or right, depending on the language.
631                The arrow keys should be bound to #LFUN_WORD_LEFT or
632                #LFUN_WORD_RIGHT actions, which in turn may employ this one.
633  * \li Syntax: word-forward
634  * \endvar
635  */
636                 { LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
637 /*!
638  * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD_SELECT
639  * \li Action: Moves the cursor to the logically next beginning of a word, 
640                            adding the logically traversed text to the selection.
641  * \li Notion: See also #LFUN_WORD_FORWARD.
642  * \li Syntax: word-forward-select
643  * \endvar
644  */
645                 { LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
646 /*!
647  * \var lyx::FuncCode lyx::LFUN_WORD_LEFT
648  * \li Action: Moves the cursor to the next beginning of a word "on the left".
649  * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
650                            "left" key is pressed. Generally, it moves the cursor to the 
651                            next beginning of a word on the left. However, in Bidi text this 
652                            become slightly more complicated, and there are different modes
653                            of cursor movement. In "visual mode", this moves left, plain and
654                            simple. In "logical mode", movement is logically forward in RTL
655                            paragraphs, and logically backwards in LTR paragraphs.
656  * \li Syntax: word-left
657  * \li Origin: dov, 28 Oct 2007
658  * \endvar
659  */
660                 { LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
661 /*!
662  * \var lyx::FuncCode lyx::LFUN_WORD_LEFT_SELECT
663  * \li Action: Moves the cursor to the next beginning of a word "on the left",
664                            adding *logically* traversed text to the selection.
665  * \li Notion: See also #LFUN_WORD_LEFT for exact details of the movement.
666  * \li Syntax: word-left-select
667  * \li Origin: dov, 28 Oct 2007
668  * \endvar
669  */
670                 { LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit },
671                 { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
672 /*!
673  * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT
674  * \li Action: Moves the cursor to the next beginning of a word "on the right".
675  * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
676                            "right" key is pressed. Generally, it moves the cursor to the 
677                            next beginning of a word on the right. However, in Bidi text 
678                            this become slightly more complicated, and there are different
679                            modes of cursor movement. In "visual mode", this moves right,
680                            plain and simple. In "logical mode", movement is logically 
681                            forward in LTR paragraphs, and logically backwards in RTL 
682                            paragraphs.
683  * \li Syntax: word-right
684  * \li Origin: dov, 28 Oct 2007
685  * \endvar
686  */
687                 { LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit },
688 /*!
689  * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT_SELECT
690  * \li Action: Moves the cursor to the next beginning of a word "on the right",
691                            adding *logically* traversed text to the selection.
692  * \li Notion: See also #LFUN_WORD_RIGHT for exact details of the movement.
693  * \li Syntax: word-right-select
694  * \li Origin: dov, 28 Oct 2007
695  * \endvar
696  */
697                 { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
698                 { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
699                 { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
700 /*!
701  * \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
702  * \li Action: Look up thesaurus entries with respect to the word under the cursor.
703  * \li Syntax: thesaurus-entry
704  * \li Origin: Levon, 20 Jul 2001
705  * \endvar
706  */
707                 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
708                 { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
709                 { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
710                 { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
711                 { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
712
713                 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
714                 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
715                 { LFUN_LINE_DELETE, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
716                 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
717                 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
718 /*!
719  * \var lyx::FuncCode lyx::LFUN_COPY
720  * \li Action: Copies to the clipboard the last edit.
721  * \li Syntax: copy
722  * \endvar
723  */
724                 { LFUN_COPY, "copy", ReadOnly, Edit },
725 /*!
726  * \var lyx::FuncCode lyx::LFUN_CUT
727  * \li Action: Cuts to the clipboard.
728  * \li Syntax: cut
729  * \endvar
730  */
731                 { LFUN_CUT, "cut", Noop, Edit },
732 /*!
733  * \var lyx::FuncCode lyx::LFUN_PASTE
734  * \li Action: Pastes from the active clipboard.
735  * \li Syntax: paste
736  * \endvar
737  */
738                 { LFUN_PASTE, "paste", Noop, Edit },
739                 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
740 /*!
741  * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
742  * \li Action: Pastes the material currently selected.
743  * \li Syntax: primary-selection-paste
744  * \endvar
745  */
746                 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
747 /*!
748  * \var lyx::FuncCode lyx::LFUN_UNDO
749  * \li Action: Undoes the last edit.
750  * \li Syntax: undo
751  * \endvar
752  */
753                 { LFUN_UNDO, "undo", Noop, Edit },
754 /*!
755  * \var lyx::FuncCode lyx::LFUN_REDO
756  * \li Action: Redoes the last thing undone.
757  * \li Syntax: redo
758  * \endvar
759  */
760                 { LFUN_REDO, "redo", Noop, Edit },
761 /*!
762  * \var lyx::FuncCode lyx::LFUN_REPEAT
763  * \li Action: Repeat the given command.
764  * \li Syntax: repeat <COUNT> <LFUN-COMMAND>
765  * \li Author: poenitz, 27 Oct 2003
766  * \endvar
767  */
768                 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
769                 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
770
771                 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
772                 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
773                 { LFUN_ENVIRONMENT_INSERT, "environment-insert", Noop, Edit },
774
775                 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
776                 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
777                 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
778                 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
779                 { LFUN_FONT_FREE_APPLY, "font-free-apply", Noop, Layout },
780                 { LFUN_FONT_FREE_UPDATE, "font-free-update", Noop, Layout },
781                 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
782                 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
783                 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
784                 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
785                 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
786                 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
787                 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
788                 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
789                 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
790
791                 { LFUN_BIBITEM_INSERT, "bibitem-insert", Noop, Edit },
792                 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
793                 { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit },
794                 { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
795
796 /*!
797  * \var lyx::FuncCode lyx::LFUN_LAYOUT
798  * \li Action: Sets the layout (that is, environment) for the current paragraph.
799  * \li Syntax: layout <LAYOUT>
800  * \li Params: <LAYOUT>: the layout to use
801  * \endvar
802  */
803                 { LFUN_LAYOUT, "layout", Noop, Layout },
804 /*!
805  * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH
806  * \li Action: Launches the paragraph settings dialog.
807  * \li Syntax: layout-paragraph
808  * \endvar
809  */
810                 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
811                 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
812 /*!
813  * \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE
814  * \li Action: Displays list of layout choices.
815  * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
816                dropbox allowing for choice of layout.
817  * \li Syntax: drop-layouts-choice
818  * \endvar
819  */
820                 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
821 /*!
822  * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
823  * \li Action: Clears the module list.
824  * \li Notion: Clears the list of included modules for the current buffer.
825  * \li Syntax: layout-modules-clear
826  * \li Origin: rgh, 25 August 2007
827  * \endvar
828  */
829                 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", Noop, Layout },
830 /*!
831  * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULE_ADD
832  * \li Action: Adds a module.
833  * \li Notion: Adds a module to the list of included modules for the current buffer.
834  * \li Syntax: layout-module-add <MODULE>
835  * \li Params: <MODULE>: the module to be added
836  * \li Origin: rgh, 25 August 2007
837  * \endvar
838  */
839                 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", Noop, Layout },
840 /*!
841  * \var lyx::FuncCode lyx::LFUN_LAYOUT_RELOAD
842  * \li Action: Reloads layout information.
843  * \li Notion: Reloads all layout information for the current buffer from disk, thus
844                recognizing any changes that have been made to layout files on the fly.
845                This is intended to be used only by layout developers and should not be
846                used when one is trying to do actual work.
847  * \li Syntax: layout-reload
848  * \li Origin: rgh, 3 September 2007
849  * \endvar
850  */
851                 { LFUN_LAYOUT_RELOAD, "layout-reload", Noop, Layout },
852 /*!
853  * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
854  * \li Action: Sets the text class for the current buffer.
855  * \li Syntax: textclass-apply <TEXTCLASS>
856  * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
857                    the filename, minus the ".layout" extension.
858  * \endvar
859  */
860                 { LFUN_TEXTCLASS_APPLY, "textclass-apply", Noop, Layout },
861 /*!
862  * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
863  * \li Action: Loads information for a textclass from disk.
864  * \li Syntax: textclass-load <TEXTCLASS>
865  * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
866                    the filename, minus the ".layout" extension.
867  * \endvar
868  */
869                 { LFUN_TEXTCLASS_LOAD, "textclass-load", Noop, Layout },
870
871 /*!
872  * \var lyx::FuncCode lyx::LFUN_MARK_OFF
873  * \li Action: Disable selecting of text-region.
874  * \li Syntax: mark-off
875  * \endvar
876  */
877                 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
878 /*!
879  * \var lyx::FuncCode lyx::LFUN_MARK_ON
880  * \li Action: Enable selecting of text-region.
881  * \li Notion: After enabling you can simply move arrow keys to get selected region.
882  * \li Syntax: mark-on
883  * \endvar
884  */
885                 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
886 /*!
887  * \var lyx::FuncCode lyx::LFUN_MARK_TOGGLE
888  * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
889  * \li Syntax: mark-toggle
890  * \li Origin: poenitz, May 5 2006
891  * \endvar
892  */
893                 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
894                 
895                 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
896                 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
897                 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
898                 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
899                 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
900                 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
901                 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
902                 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
903                 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
904                 { LFUN_MATH_SPACE, "math-space", Noop, Math },
905                 { LFUN_MATH_IMPORT_SELECTION, "math-import-selection", Noop, Math },
906                 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
907                 { LFUN_MATH_MODE, "math-mode", Noop, Math },
908 /*!
909  * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
910  * \li Action: Toggles numbering of the current formula line.
911  * \li Notion: Must be in display formula mode.
912  * \li Syntax: math-number-line-toggle
913  * \li Origin: Alejandro 18 Jun 1996
914  * \endvar
915  */
916                 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
917 /*!
918  * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
919  * \li Action: Toggles numbering/labeling of the current formula.
920  * \li Notion: Must be in display formula mode.
921  * \li Syntax: math-number-toggle
922  * \li Origin: Alejandro 4 Jun 1996
923  * \endvar
924  */
925                 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
926                 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
927                 { LFUN_MATH_SIZE, "math-size", Noop, Math },
928 /*!
929  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
930  * \li Action: Unfold a Math Macro.
931  * \li Notion: Unfold the Math Macro the cursor is in, i.e.
932                display it as \foo.
933  * \li Syntax: math-macro-unfold
934  * \li Origin: sts, 06 January 2008
935  * \endvar
936  */
937                 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
938 /*!
939  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
940  * \li Action: Fold a Math Macro.
941  * \li Notion: Fold the Math Macro the cursor is in if it was
942                unfolded, i.e. displayed as \foo before.
943  * \li Syntax: math-macro-fold
944  * \li Origin: sts, 06 January 2008
945  * \endvar
946  */
947                 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
948 /*!
949  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
950  * \li Action: Add a parameter.
951  * \li Notion: Add a parameter to a Math Macro.
952  * \li Params: <NUM>: The number of the parameter behind which the new one
953                will be added (1 for the first, i.e. use 0 for add a
954                parameter at the left), defaults to the last one.
955  * \li Syntax: math-macro-add-param <NUM>
956  * \li Origin: sts, 06 January 2008
957  * \endvar
958  */
959                 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
960 /*!
961  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
962  * \li Action: Remove the last parameter.
963  * \li Notion: Remove the last parameter of a Math Macro and
964                remove its value in all instances of the macro
965                in the buffer.
966  * \li Params: <NUM>: The number of the parameter to be deleted (1 for
967                the first), defaults to the last one.
968  * \li Syntax: math-macro-remove-param <NUM>
969  * \li Origin: sts, 06 January 2008
970  * \endvar
971  */
972                 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
973 /*!
974  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
975  * \li Action: Append a greedy parameter.
976  * \li Notion: Append a greedy parameter to a Math Macro which
977                eats the following mathed cell in every instance of
978                the macro in the buffer.
979  * \li Syntax: math-macro-append-greedy-param
980  * \li Origin: sts, 06 January 2008
981  * \endvar
982  */
983                 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
984 /*!
985  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
986  * \li Action: Remove a greedy parameter.
987  * \li Notion: Remove a greedy parameter of a Math Macro and spit
988                out the values of it in every instance of the macro
989                in the buffer. If it is an optional parameter the [valud]
990                format is used.
991  * \li Syntax: math-macro-remove-greedy-param
992  * \li Origin: sts, 06 January 2008
993  * \endvar
994  */
995                 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
996 /*!
997  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
998  * \li Action: Make a parameter optional.
999  * \li Notion: Turn the first non-optional parameter of a Math Macro
1000                into an optional parameter with a default value.
1001  * \li Syntax: math-macro-make-optional
1002  * \li Origin: sts, 06 January 2008
1003  * \endvar
1004  */
1005                 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
1006 /*!
1007  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
1008  * \li Action: Make a parameter non-optional.
1009  * \li Notion: Turn the last optional parameter of a Math Macro
1010                into a non-optional parameter. The default value is
1011                remembered to be reused later if the user changes his mind.
1012  * \li Syntax: math-macro-make-nonoptional
1013  * \li Origin: sts, 06 January 2008
1014  * \endvar
1015  */
1016                 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
1017 /*!
1018  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
1019  * \li Action: Add an optional parameter.
1020  * \li Notion: Insert an optional parameter just behind the
1021                already existing optional parameters.
1022  * \li Syntax: math-macro-add-optional-param
1023  * \li Origin: sts, 06 January 2008
1024  * \endvar
1025  */
1026                 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
1027 /*!
1028  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
1029  * \li Action: Remove the last optional parameter.
1030  * \li Notion: Remove the last optional parameter of a Math Macro and
1031                remove it in all the instances of the macro in the buffer.
1032  * \li Syntax: math-macro-remove-optional-param
1033  * \li Origin: sts, 06 January 2008
1034  * \endvar
1035  */
1036                 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
1037 /*!
1038  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
1039  * \li Action: Add a greedy optional parameter.
1040  * \li Notion: Add a greedy optional parameter which eats the value
1041                from the following cells in mathed which are in the [value]
1042                format.
1043  * \li Syntax: math-macro-add-greedy-optional-param
1044  * \li Origin: sts, 06 January 2008
1045  * \endvar
1046  */
1047                 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
1048 /*!
1049  * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
1050  * \li Action: Only active in Math Macro definition.
1051  * \li Notion: Dummy function which is only active in a Math Macro definition.
1052                It's used to toggle the Math Macro toolbar if the cursor moves
1053                into a Math Macro definition.
1054  * \li Syntax: in-mathmacrotemplate
1055  * \li Origin: sts, 06 January 2008
1056  * \endvar
1057  */
1058                 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
1059
1060 /*!
1061  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
1062  * \li Action: Moves the current paragraph downwards in the document.
1063  * \li Syntax: paragraph-move-down
1064  * \li Origin: Edwin, 8 Apr 2006
1065  * \endvar
1066  */
1067                 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
1068 /*!
1069  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
1070  * \li Action: Moves the current paragraph upwards in the document.
1071  * \li Syntax: paragraph-move-up
1072  * \li Origin: Edwin, 8 Apr 2006
1073  * \endvar
1074  */
1075                 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
1076
1077 /*!
1078  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP
1079  * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1080                in upward direction.
1081  * \li Syntax: paragraph-up
1082  * \li Origin: Asger, 1 Oct 1996
1083  * \endvar
1084  */
1085                 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
1086 /*!
1087  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP_SELECT
1088  * \li Action: Move the cursor and select the text to the next paragraph (or
1089                begining of the current one) in upward direction.
1090  * \li Syntax: paragraph-up-select
1091  * \li Origin: Asger, 1 Oct 1996
1092  * \endvar
1093  */
1094                 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
1095 /*!
1096  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN
1097  * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1098                in downward direction.
1099  * \li Syntax: paragraph-down
1100  * \li Origin: Asger, 1 Oct 1996
1101  * \endvar
1102  */
1103                 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
1104 /*!
1105  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN_SELECT
1106  * \li Action: Move the cursor and select the text to the next paragraph (or
1107                begining of the current one) in downward direction.
1108  * \li Syntax: paragraph-down-select
1109  * \li Origin: Asger, 1 Oct 1996
1110  * \endvar
1111  */
1112                 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
1113 /*!
1114  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
1115  * \li Action: Jump to a paragraph given by its id number and optionally the
1116                desired position within the paragraph.
1117  * \li Notion: Note that id number of paragraph is not the sequential number of paragraph
1118                seen on the screen. Moreover the id is unique for all opened buffers (documents).
1119  * \li Syntax: paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
1120  * \li Params: <PAR_ID_NUMBER>:  paragraph id
1121                <POSITION_IN_PAR>: desired position within the paragraph
1122  * \li Origin: Dekel, 26 Aug 2000
1123  * \endvar
1124  */
1125                 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly, Edit },
1126 /*!
1127  * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1128  * \li Action: Breaks the current paragraph at the current location.
1129  * \li Syntax: break-paragraph
1130  * \endvar
1131  */
1132                 { LFUN_PARAGRAPH_SPACING, "paragraph-spacing", Noop, Edit },
1133                 { LFUN_BREAK_PARAGRAPH, "break-paragraph", Noop, Edit },
1134 /*!
1135  * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH_SKIP
1136  * \li Action: Breaks the current paragraph at the current location,
1137                unless used at the beginning of a line, where it sets
1138                the label width string to empty.
1139  * \li Syntax: break-paragraph-skip
1140  * \endvar
1141  */
1142                 { LFUN_BREAK_PARAGRAPH_SKIP, "break-paragraph-skip", Noop, Edit },
1143 /*!
1144  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
1145  * \li Action: Change paragraph settings.
1146  * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
1147                This function only modifies, and does not override, existing settings.
1148                Note that the "leftindent" indent setting is deprecated.
1149  * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
1150  * \li Params: <INDENT>:  \\noindent|\\indent|\\indent-toggle|\\leftindent LENGTH\n
1151                <SPACING>: \\paragraph_spacing default|single|onehalf|double|other\n
1152                <ALIGN>:   \\align block|left|right|center|default\n
1153                <OTHERS>:  \\labelwidthstring WIDTH|\\start_of_appendix\n
1154  * \li Origin: rgh, Aug 15 2007
1155  * \endvar
1156  */
1157                 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
1158 /*!
1159  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
1160  * \li Action: Change paragraph settings.
1161  * \li Notion: Overwrite all nonspecified settings to the default ones.
1162                Use paragraph-params lfun if you don't want to overwrite others settings.
1163  * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
1164  * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
1165  * \li Origin: leeming, 30 Mar 2004
1166  * \endvar
1167  */
1168                 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
1169                 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
1170
1171 /*!
1172  * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
1173  * \li Action: Move the current group in the upward direction in the
1174                structure of the document.
1175  * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1176                the whole substructure of the group.
1177  * \li Syntax: outline-up
1178  * \li Origin: Vermeer, 23 Mar 2006
1179  * \endvar
1180  */
1181                 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
1182 /*!
1183  * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
1184  * \li Action: Move the current group in the downward direction in the
1185                structure of the document.
1186  * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1187                the whole substructure of the group.
1188  * \li Syntax: outline-down
1189  * \li Origin: Vermeer, 23 Mar 2006
1190  * \endvar
1191  */
1192                 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
1193 /*!
1194  * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
1195  * \li Action: Moves the current group in the downward direction in the
1196                hierarchy of the document structure.
1197  * \li Notion: Part -> Chapter -> Section -> etc.
1198  * \li Syntax: outline-in
1199  * \li Origin: Vermeer, 23 Mar 2006
1200  * \endvar
1201  */
1202                 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
1203 /*!
1204  * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
1205  * \li Action: Moves the current group in the upward direction in the
1206                hierarchy of the document structure.
1207  * \li Notion: Part <- Chapter <- Section <- etc.
1208  * \li Syntax: outline-out
1209  * \li Origin: Vermeer, 23 Mar 2006
1210  * \endvar
1211  */
1212                 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
1213 /*!
1214  * \var lyx::FuncCode lyx::LFUN_INSET_EDIT
1215  * \li Action: Edit the inset at cursor with an external application,
1216  *             if one is attributed.
1217  * \li Syntax: inset-edit [<INSET_PARAMS>]
1218  * \li Params: <INSET_PARAMS>: Parameters for the inset.
1219                                Currently only the filename will be considered.
1220  * \li Origin: JSpitzm, 27 Apr 2006
1221  * \endvar
1222  */
1223                 { LFUN_INSET_EDIT, "inset-edit", Noop, Edit },
1224
1225                 { LFUN_CELL_BACKWARD, "cell-backward", Noop, Edit },
1226                 { LFUN_CELL_FORWARD, "cell-forward", Noop, Edit },
1227                 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
1228                 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
1229                 { LFUN_TABULAR_FEATURE, "tabular-feature", Noop, Edit },
1230
1231                 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
1232                 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
1233                 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
1234                 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
1235                 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
1236
1237                 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
1238                 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
1239                 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
1240                 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
1241                 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
1242                 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
1243                 { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
1244                 { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
1245
1246 /*!
1247  * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
1248  * \li Action: Apply data for an inset.
1249  * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
1250                be applied. This is either changed to #LFUN_INSET_MODIFY or
1251                #LFUN_INSET_INSERT depending on the context where it is called.
1252  * \li Syntax: inset-apply <ARGS>
1253  * \li Params: See #LFUN_INSET_INSERT .
1254  * \endvar
1255  */
1256                 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
1257 /*!
1258  * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE
1259  * \li Action: Dissolve the current inset into text.
1260  * \li Syntax: inset-dissolve [<INSET>]
1261  * \li Params: <INSET>: this can be used to make sure the right kind of inset
1262                         is dissolved. For example "dissolve" entry in the charstyles
1263                         sub-menu should only dissolve the charstyle inset, even if the
1264                         cursor is inside several nested insets of different type.\n
1265                         For values see #lyx::InsetLayout::lyxtype_ .
1266  * \li Author: JSpitz, 7 Aug 2006
1267  * \endvar
1268  */
1269                 { LFUN_INSET_DISSOLVE, "inset-dissolve", Noop, Edit },
1270 /*!
1271  * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
1272  * \li Action: Insert new inset (type given by the parameters).
1273  * \li Syntax: inset-insert <INSET> <ARGS>
1274  * \li Params: <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics|
1275                          hyperlink|include|index|label|nomencl|vspace|ref|toc>\n
1276                <ARGS>: depends on the given inset. Use "lyx -dbg action" to
1277                        explore.
1278  * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
1279                where <label name> is the name of the referenced label and
1280                <Format> is one of the following: \n
1281                ref -- <reference> \n
1282                eqref -- (<reference>) \n
1283                pageref -- <page> \n
1284                vpageref -- on <page> \n
1285                vref -- <reference> on <page> \n
1286                prettyref -- Formatted reference
1287  * \endvar
1288  */
1289                 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
1290 /*!
1291  * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
1292  * \li Action: Modify existing inset.
1293  * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1294                bibtex, ert, command, graphics, note, space, vspace, tabular,
1295                bibitem, inlude, ref insets.
1296  * \li Syntax: inset-modify <INSET> <ARGS>
1297  * \li Params: See #LFUN_INSET_INSERT for further details.
1298  * \endvar
1299  */
1300                 { LFUN_INSET_MODIFY, "", Noop, Hidden },
1301 /*!
1302  * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_MODIFY
1303  * \li Action: Modify the inset at cursor position, if there is one.
1304  * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1305                bibtex, ert, command, graphics, note, space, vspace, tabular,
1306                bibitem, inlude, ref insets.
1307  * \li Syntax: next-inset-modify <INSET> <ARGS> or next-inset-modify changetype <TYPE>
1308  * \li Params: See #LFUN_INSET_INSERT for further details.
1309  * \li Origin: JSpitzm, 23 Mar 2008
1310  * \endvar
1311  */
1312                 { LFUN_NEXT_INSET_MODIFY, "next-inset-modify", ReadOnly, Edit },
1313                 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
1314 /*!
1315  * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
1316  * \li Action: Open the inset's properties dialog.
1317  * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
1318  * \li Syntax: inset-settings <INSET>
1319  * \li Params: <INSET>: <box|branch|ert|float|listings|note|tabular|wrap>
1320  * \endvar
1321  */
1322                 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly, Edit },
1323 /*!
1324  * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_TOGGLE
1325  * \li Action: Toggles the inset at cursor position. For collapsables, this means it will
1326                be (un-)collapsed, in case of other insets, the editing widget (dialog) will
1327                be entered. Also cf. #LFUN_INSET_SETTINGS.
1328  * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1329                bibtex, ert, command, graphics, note, space, vspace, tabular,
1330                bibitem, inlude, ref insets.
1331  * \li Syntax: next-inset-toggle <ARG>
1332  * \li Params: <ARG>: these are passed as arguments to #LFUN_INSET_TOGGLE .
1333  * \li Origin: leeming, 30 Mar 2004
1334  * \endvar
1335  */
1336                 { LFUN_NEXT_INSET_TOGGLE, "next-inset-toggle", ReadOnly, Edit },
1337 /*!
1338  * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
1339  * \li Action: Toggles the collapsable inset we are currently in.
1340  * \li Syntax: inset-toggle [<ARG>]
1341  * \li Params: <ARG>: <open|close|toggle|assign>. \n
1342                open/close/toggle are for collapsable insets. close can be currently used
1343                by #LFUN_NEXT_INSET_TOGGLE. toggle is used when no argument is given.\n
1344                assign is for branch inset.
1345  * \li Origin: lasgouttes, 19 Jul 2001
1346  * \endvar
1347  */
1348                 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly, Hidden },
1349 /*!
1350  * \var lyx::FuncCode lyx::LFUN_ALL_INSETS_TOGGLE
1351  * \li Action: Toggles (open/closes) all collapsable insets (of a given type) in the document.
1352  * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
1353  * \li Syntax: all-insets-toggle <STATE> <INSET>
1354  * \li Params: <STATE>: <toggle|open|close> default: toggle \n
1355                <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all insets \n
1356  * \li Origin: leeming, 30 Mar 2004
1357  * \endvar
1358  */
1359                 { LFUN_ALL_INSETS_TOGGLE, "all-insets-toggle", ReadOnly, Edit },
1360 /*!
1361  * \var lyx::FuncCode lyx::LFUN_GRAPHICS_GROUPS_UNIFY
1362  * \li Action: Unify all graphics insets with the one given as an parameter.
1363  * \li Notion: This is internally used for synchronize certain group of graphics insets.
1364  * \li Syntax: graphics-groups-unigfy <GRAPHICS_PARAMS>
1365  * \li Params: <GRAPHICS_PARAMS>: Parameters for graphics inset
1366                                   (syntax can be seen in .lyx files).
1367  * \li Origin: sanda, 6 May 2008
1368  * \endvar
1369  */
1370                 { LFUN_GRAPHICS_GROUPS_UNIFY, "graphics-groups-unify", ReadOnly, Edit },
1371 /*!
1372  * \var lyx::FuncCode lyx::LFUN_SET_GRAPHICS_GROUP
1373  * \li Action: Set the group for the graphics inset on the cursor position.
1374  * \li Syntax: set-graphics-group [<GROUP>]
1375  * \li Params: <GROUP>: Id for an existing group. In case tthe Id is an empty string,
1376                         the graphics inset is removed from the current group.
1377  * \li Origin: sanda, 6 May 2008
1378  * \endvar
1379  */
1380                 { LFUN_SET_GRAPHICS_GROUP, "set-graphics-group", ReadOnly, Edit },
1381
1382 /*!
1383  * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
1384  * \li Action: Moves the cursor out of the current slice, going forward.
1385  * \li Notion: Cursor movement within an inset may be different than cursor
1386                movement in the surrounding text. This action should be called
1387                automatically by the cursor movement within the inset, when
1388                movement within the inset has ceased (reached the end of the
1389                last paragraph, for example), in order to move correctly
1390                back into the surrounding text.
1391  * \endvar
1392  */
1393                 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
1394 /*!
1395  * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
1396  * \li Action: Moves the cursor out of the current slice, going backwards.
1397  * \li Notion: See also #LFUN_FINISHED_FORWARD.
1398  * \endvar
1399  */
1400                 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
1401 /*!
1402  * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
1403  * \li Action: Moves the cursor out of the current slice, going right.
1404  * \li Notion: See also #LFUN_FINISHED_FORWARD
1405  * \endvar
1406  */
1407                 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
1408 /*!
1409  * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
1410  * \li Action: Moves the cursor out of the current slice, going left.
1411  * \li Notion: See also #LFUN_FINISHED_FORWARD.
1412  * \endvar
1413  */
1414                 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
1415
1416                 { LFUN_LANGUAGE, "language", Noop, Edit },
1417
1418 /*!
1419  * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
1420  * \li Action: Goto a label.
1421  * \li Syntax: label-goto [<LABEL>]
1422  * \li Params: <LABEL>: Requested label. If no label is given and refernce
1423                         is on cursor position, Bookmark 0 is saved and
1424                         cursor moves to the position of referenced label.
1425  * \li Origin: Ale, 6 Aug 1997
1426  * \endvar
1427  */
1428                 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
1429 /*!
1430  * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT
1431  * \li Action: Inserts label to text or displayed formula.
1432  * \li Syntax: label-insert [<LABEL>]
1433  * \li Params: <LABEL>: Requested label. If no label is given dialog requesting
1434                         name will be opened.
1435  * \endvar
1436  */
1437                 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
1438 /*!
1439  * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
1440  * \li Action: Go to the next label or cross-reference.
1441  * \li Syntax: reference-next
1442  * \li Origin: Dekel, 14 Jan 2001
1443  * \endvar
1444  */
1445                 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
1446
1447 /*!
1448  * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
1449  * \li Action: Goto a bookmark.
1450  * \li Notion: Moves the cursor to the numbered bookmark, opening the file
1451                if necessary. Note that bookmarsk are saved per-session, not
1452                per file.
1453  * \li Syntax: bookmark-goto <NUMBER>
1454  * \li Params: <NUMBER>: the number of the bookmark to restore.
1455  * \li Origin: Dekel, 27 January 2001
1456  * \endvar
1457  */
1458                 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
1459 /*!
1460  * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
1461  * \li Action: Save a bookmark.
1462  * \li Notion: Saves a numbered bookmark to the sessions file. The number
1463                must be between 1 and 9, inclusive. Note that bookmarks are
1464                saved per-session, not per file.
1465  * \li Syntax: bookmark-save <NUMBER>
1466  * \li Params: <NUMBER>: the number of the bookmark to save.
1467  * \li Origin: Dekel, 27 January 2001
1468  * \endvar
1469  */
1470                 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
1471 /*!
1472  * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
1473  * \li Action: Clears the list of saved bookmarks.
1474  * \li Syntax: bookmark-clear
1475  * \li Origin: bpeng, 31 October 2006
1476  * \endvar
1477  */
1478                 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
1479
1480 /*!
1481  * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
1482  * \li Action: Open the given help file according to the language setting.
1483  * \li Syntax: help-open <FILE>[.lyx]
1484  * \li Params: <FILE>: any document from (/usr/share/)doc directory.
1485  * \li Author: Jug, 27 Jun 1999
1486  * \endvar
1487  */
1488                 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
1489 /*!
1490  * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
1491  * \li Action: Terminates the current LyX instance.
1492  * \li Notion: Terminates the current LyX instance, asking whether to save
1493                modified documents, etc.
1494  * \li Syntax: lyx-quit
1495  * \endvar
1496  */
1497                 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
1498 /*!
1499  * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
1500  * \li Action: Toggles visibility of a given toolbar between on/off/auto.
1501  * \li Notion: Skiping "auto" when allowauto is false.
1502  * \li Syntax: toolbar-toggle <NAME> [allowauto]
1503  * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|
1504                        minibuffer|review|view/update|math_panels
1505  * \li Origin: Edwin, 21 May 2007
1506  * \endvar
1507  */
1508                 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
1509 /*!
1510  * \var lyx::FuncCode lyx::LFUN_MENU_OPEN
1511  * \li Action: Opens the menu given by its name.
1512  * \li Syntax: menu-open <NAME>
1513  * \li Params: <NAME>: menu name. See various .inc files in lib/ui for candidates.
1514  * \endvar
1515  */
1516                 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
1517 /*!
1518  * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
1519  * \li Action: Various UI visibility-toggling actions.
1520  * \li Syntax: ui-toggle <statusbar|menubar|frame|fullscreen>
1521  * \li Params: statusbar  : Toggle visibility of the statusbar.\n
1522                menubar    : Toggle visibility of the menubar.\n
1523                scrollbar  : Toggle visibility of the scrollbar.\n
1524                frame      : Toggle visibility of the frames around editing window.\n
1525                fullscreen : Toggle fullscreen mode. This also covers calling the
1526                             previous functions. However #LFUN_TOOLBAR_TOGGLE for the
1527                             custom tweaks of the toolbars should be used.
1528  * \li Origin: ps, 9 Feb 2007
1529  * \endvar
1530  */
1531                 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
1532
1533 /*!
1534  * \var lyx::FuncCode lyx::WINDOW_NEW
1535  * \li Action: Creates new empty LyX window.
1536  * \li Notion: Already opened documents from the previous window can be found under View menu.
1537  * \li Syntax: window-new [<GEOMETRY>]
1538  * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently 
1539                            accepted only on Windows platform.
1540  * \li Origin: Abdel, 21 Oct 2006
1541  * \endvar
1542  */
1543                 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
1544 /*!
1545  * \var lyx::FuncCode lyx::LFUN_WINDOW_CLOSE
1546  * \li Action: Closes the current LyX window.
1547  * \li Syntax: window-close
1548  * \li Origin: Abdel, 23 Oct 2006
1549  * \endvar
1550  */
1551                 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
1552
1553 /*!
1554  * \var lyx::FuncCode lyx::LFUN_SPLIT_VIEW
1555  * \li Action: Creates another split view of current buffer.
1556  * \li Notion: All split views act in the same way indpendently.
1557  * \li Syntax: split-view <vertical|horizontal>
1558  * \li Params: horizontal : The work areas are laid out side by side.\n
1559                vertical   : The work areas laid out vertically.\n
1560  * \li Origin: abdel, 20 Feb 2008
1561  * \endvar
1562  */
1563                 { LFUN_SPLIT_VIEW, "split-view", ReadOnly, Buffer },
1564
1565 /*!
1566  * \var lyx::FuncCode lyx::LFUN_CLOSE_TAB_GROUP
1567  * \li Action: Close the current tab group.
1568  * \li Notion: This only closes the work areas, not the buffer themselves.
1569                The still opened buffers can be visualized in another tab group.
1570  * \li Syntax: close-tab-group
1571  * \li Origin: abdel, 21 Feb 2008
1572  * \endvar
1573  */
1574                 { LFUN_CLOSE_TAB_GROUP, "close-tab-group", ReadOnly, Buffer },
1575                 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
1576                 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
1577                 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
1578                 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
1579                 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
1580                 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
1581
1582                 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
1583                 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
1584                 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
1585                 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
1586                 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
1587
1588                 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
1589                 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
1590                 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
1591                 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
1592
1593                 { LFUN_MESSAGE, "message", NoBuffer, System },
1594                 { LFUN_FLOAT_LIST, "float-list", Noop, Edit },
1595                 { LFUN_ESCAPE, "escape", ReadOnly, Edit },
1596
1597                 { LFUN_SERVER_CHAR_AFTER, "server-char-after", ReadOnly, System },
1598                 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
1599                 { LFUN_SERVER_GET_NAME, "server-get-name", ReadOnly, System },
1600 /*!
1601  * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
1602  * \li Action: Sets the cursor position based on the row number of generated TeX file.
1603  * \li Syntax: server-goto-file-row <LYX_FILE_NAME> <ROW_NUMBER>
1604  * \li Origin: Edmar, 23 Dec 1998
1605  * \endvar
1606  */
1607                 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly, System },
1608                 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
1609 /*!
1610  * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
1611  * \li Action: Sets the cursor position based on the editing area coordinates
1612                (similar as clicking on that point with left mouse button).
1613  * \li Syntax: server-set-xy <X> <Y>
1614  * \endvar
1615  */
1616                 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
1617 /*!
1618  * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
1619  * \li Action: Returns the coordinates of cursor position in the editing area.
1620  * \li Syntax: server-get-xy
1621  * \endvar
1622  */
1623                 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
1624
1625 /*!
1626  * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
1627  * \li Action: Generates the code (literate programming).
1628  * \li Notion: Latex file with extension \literate_extension is generated.
1629                Then LyX invokes \build_command (with a default of``make'') to generate the code and
1630                \build_error_filter to process the compilation error messages. \n
1631                In case you want to process your literate file with a script, or some other program,
1632                just insert in your lyxrc file an entry with:\n
1633                \build_command "my_script my_arguments" \n
1634                The \build_error_filter differs from the \literate_error_filter only in that the
1635                former will identify error messages from your compiler.
1636  * \li Syntax: build-program
1637  * \endvar
1638  */
1639                 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
1640
1641 /*!
1642  * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
1643  * \li Action: Saves the current buffer to a temporary file.
1644  * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
1645                is called automatically by LyX, to "autosave" the current buffer.
1646  * \li Syntax: buffer-auto-save
1647  * \endvar
1648  */
1649                 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
1650 /*!
1651  * \var lyx::FuncCode lyx::LFUN_BUFFER_CHILD_OPEN
1652  * \li Action: Loads the given child document.
1653  * \li Notion: The current document is treated as a parent.
1654  * \li Syntax: buffer-child-open <FILE>
1655  * \li Params: <FILE>: Filename of the child. The directory of the parent is assumed by default.
1656  * \li Origin: Ale, 28 May 1997
1657  * \endvar
1658  */
1659                 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
1660 /*!
1661  * \var lyx::FuncCode lyx::LFUN_BUFFER_CHKTEX
1662  * \li Action: Runs chktex for the current document.
1663  * \li Syntax: buffer-chktex
1664  * \li Origin: Asger, 30 Oct 1997
1665  * \endvar
1666  */
1667                 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
1668 /*!
1669  * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
1670  * \li Action: Toggles compression of the current document on/off.
1671  * \li Syntax: buffer-toggle-compression
1672  * \li Origin: bpeng, 27 Apr 2006
1673  * \endvar
1674  */
1675                 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
1676 /*!
1677  * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
1678  * \li Action: Closes the current buffer.
1679  * \li Notion: Closes the current buffer, asking whether to save it, etc,
1680                if the buffer has been modified.
1681  * \li Syntax: buffer-close
1682  * \endvar
1683  */
1684                 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
1685 /*!
1686  * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
1687  * \li Action: Exports the current buffer (document) to the given format.
1688  * \li Syntax: buffer-export <FORMAT>
1689  * \li Params: <FORMAT> is either "custom" or one of the formats which you
1690                         can find in Tools->Preferences->File formats->Format.
1691                         Usual format you will enter is "pdf2" (pdflatex),
1692                         "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
1693                         In case of "custom" you will be asked for a format you
1694                         want to start from and for the command that you want to
1695                         apply to this format. Internally the control is then passed
1696                         to #LFUN_BUFFER_EXPORT_CUSTOM.
1697  * \li Origin: Lgb, 29 Jul 1997
1698  * \endvar
1699  */
1700                 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
1701 /*!
1702  * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
1703  * \li Action: Exports the current buffer (document) from the given format using
1704                the given command on it.
1705  * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
1706  * \li Params: <FORMAT> format to start from (LyX will care to produce such
1707                         intermediate file).\n
1708                <COMMAND> this command will be launched on the file. Note that you can
1709                use "$$FName" string to qualify the intermediate file.
1710  * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
1711  * \li Origin: leeming, 27 Mar 2004
1712  * \endvar
1713  */
1714                 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
1715 /*!
1716  * \var lyx::FuncCode lyx::LFUN_BUFFER_PRINT
1717  * \li Action: Prints the current document.
1718  * \li Notion: Many settings can be given via the preferences dialog.
1719  * \li Syntax: buffer-print <TARGET> <TARGET-NAME> <COMMAND>
1720  * \li Params: <TARGET> is either "printer" or "file".\n
1721                <TARGER-NAME> is either "default" or file name or printer name.\n
1722                <COMMAND> command ensuring the printing job.
1723  * \li Sample: buffer-print file "/trash/newfile1.ps" "dvips"
1724  * \li Origin: leeming, 28 Mar 2004
1725  * \endvar
1726  */
1727                 { LFUN_BUFFER_PRINT, "buffer-print", ReadOnly, Buffer },
1728 /*!
1729  * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
1730  * \li Action: Import a given file as a lyx document.
1731  * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
1732                defined convertors in preferences. Look into File->Import menu to get
1733                an idea of the currently active import formats.
1734  * \li Syntax: buffer-import <FORMAT> [<FILE>]
1735  * \li Origin: Asger, 24 Jul 1998
1736  * \endvar
1737  */
1738                 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
1739 /*!
1740  * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
1741  * \li Action: Creates a new buffer (that is, document).
1742  * \li Notion: Implicit path can be set in Preferences dialog.
1743  * \li Syntax: buffer-new [<FILE>]
1744  * \li Params: <FILE>: filename of created file with absolute path.
1745  * \endvar
1746  */
1747                 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
1748 /*!
1749  * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
1750  * \li Action: Creates a new buffer (that is, document) from a template.
1751  * \li Notion: Path for new files and templates can be set in Preferences dialog.
1752                Template will be asked for via Open-dialog.
1753  * \li Syntax: buffer-new-template [<FILE>]
1754  * \li Params: <FILE>: filename of created file with absolute path.
1755  * \endvar
1756  */
1757                 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
1758 /*!
1759  * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
1760  * \li Action: Reverts opened document.
1761  * \li Syntax: buffer-reload
1762  * \li Origin: Asger, 2 Feb 1997
1763  * \endvar
1764  */
1765                 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
1766 /*!
1767  * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
1768  * \li Action: Switch to the given buffer.
1769  * \li Notion: This is useful also in case you need simultaneously more views of the edited
1770                document in different LyX windows.
1771  * \li Syntax: buffer-new-template <BUFFER>
1772  * \li Params: <BUFFER>: already opened document which is to be shown.
1773  * \endvar
1774  */
1775                 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
1776 /*!
1777  * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
1778  * \li Action: Toggle editing mode of the current document between read/write and read-only.
1779  * \li Syntax: buffer-toggle-read-only
1780  * \li Origin: Lgb, 27 May 1997
1781  * \endvar
1782  */
1783                 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
1784 /*!
1785  * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
1786  * \li Action: Displays current buffer in chosen format.
1787  * \li Notion: Displays the contents of the current buffer in the chosen
1788                format, for example, PDF or DVI. This runs the necessary
1789                converter, calls the defined viewer, and so forth.
1790  * \li Syntax: buffer-view <FORMAT>
1791  * \li Params: <FORMAT>: The format to display, where this is one of the
1792                          formats defined (in the current GUI) in the
1793                          Tools>Preferences>File Formats dialog.
1794  * \endvar
1795  */
1796                 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
1797 /*!
1798  * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
1799  * \li Action: Exports the current document and put the result into the
1800                temporary directory.
1801  * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
1802                the output will be rewriten - updated. This is useful in case your viewer
1803                is able to detect such changes (e.g. ghostview for postscript).
1804  * \li Syntax: buffer-update <FORMAT>
1805  * \li Params: <FORMAT>: The format to display, where this is one of the
1806                          formats defined (in the current GUI) in the
1807                          Tools>Preferences>File Formats dialog.
1808  * \li Origin: Dekel, 5 Aug 2000
1809  * \endvar
1810  */
1811                 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
1812
1813 /*!
1814  * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
1815  * \li Action: Saves the current buffer.
1816  * \li Notion: Saves the current buffer to disk, using the filename that
1817                is already associated with the buffer, asking for one if
1818                none is yet assigned.
1819  * \li Syntax: buffer-write
1820  * \endvar
1821  */
1822                 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
1823 /*!
1824  * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
1825  * \li Action: Rename and save current buffer.
1826  * \li Syntax: buffer-write-as <FILENAME>
1827  * \li Params: <FILENAME>: New name of the buffer/file. A relative path
1828                is with respect to the original location of the buffer/file.
1829  * \endvar
1830  */
1831                 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
1832 /*!
1833  * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
1834  * \li Action: Save all changed documents.
1835  * \li Syntax: buffer-write-all
1836  * \li Origin: rgh, gpothier 6 Aug 2007
1837  * \endvar
1838  */
1839                 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
1840 /*!
1841  * \var lyx::FuncCode lyx::LFUN_BUFFER_NEXT
1842  * \li Action: Switch to the next opened document.
1843  * \li Notion: Note that this does not necessarily mean next in tabbar
1844                (for full list see View menu).
1845  * \li Syntax: buffer-next
1846  * \endvar
1847  */
1848                 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
1849 /*!
1850  * \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS
1851  * \li Action: Switch to the previous opened document.
1852  * \li Syntax: buffer-previous
1853  * \endvar
1854  */
1855                 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
1856 /*!
1857  * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
1858  * \li Action: When run from a child document, this updates (exports) document built
1859                 from the master buffer. If a master is not found, it updates the
1860                 current buffer.
1861  * \li Syntax: master-buffer-update
1862  * \li Author: Tommaso, 20 Sep 2007
1863  * \endvar
1864  */
1865                 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
1866 /*!
1867  * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
1868  * \li Action: When run from a child document, this command shows a preview built
1869                from the master buffer. If a master is not found, it previews the
1870                current buffer.
1871  * \li Syntax: master-buffer-view
1872  * \li Author: Tommaso, 20 Sep 2007
1873  * \endvar
1874  */
1875                 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
1876 /*!
1877  * \var lyx::FuncCode lyx::LFUN_BUFFER_LANGUAGE
1878  * \li Action: Set language of the current document.
1879  * \li Syntax: buffer-language <LANG>
1880  * \li Params: <LANG>: language name. See lib/languages for list.
1881  * \li Author: leeming, 30 Mar 2004
1882  * \endvar
1883  */
1884                 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
1885 /*!
1886  * \var lyx::FuncCode lyx::LFUN_BUFFER_SAVE_AS_DEFAULT
1887  * \li Action: Save the current document settings as default.
1888  * \li Notion: The file will will be saved into ~/.lyx/templates/defaults.lyx .
1889  * \li Syntax: buffer-save-as-default [<ARGS>]
1890  * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
1891                        you can find in document header of usual .lyx file.
1892  * \li Author: leeming, 30 Mar 2004
1893  * \endvar
1894  */
1895                 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
1896 /*!
1897  * \var lyx::FuncCode lyx::LFUN_BUFFER_PARAMS_APPLY
1898  * \li Action: Apply the given settings to the current document.
1899  * \li Syntax: buffer-params-apply [<ARGS>]
1900  * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
1901                        you can find in document header of usual .lyx file.
1902  * \li Author: leeming, 30 Mar 2004
1903  * \endvar
1904  */
1905                 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", Noop, Buffer },
1906
1907 /*!
1908  * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
1909  * \li Action: Inserts another LyX file.
1910  * \li Syntax: file-insert [<FILE>]
1911  * \li Params: <FILE>: Filename to be inserted.
1912  * \endvar
1913  */
1914                 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
1915 /*!
1916  * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
1917  * \li Action: Inserts plain text file.
1918  * \li Syntax: file-insert-plaintext [<FILE>]
1919  * \li Params: <FILE>: Filename to be inserted.
1920  * \li Origin: CFO-G, 19 Nov 1997
1921  * \endvar
1922  */
1923                 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
1924 /*!
1925  * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
1926  * \li Action: Inserts plain text file as paragraph (i.e. join lines).
1927  * \li Syntax: file-insert-plaintext-para [<FILE>]
1928  * \li Params: <FILE>: Filename to be inserted.
1929  * \li Origin: Levon, 14 Feb 2001
1930  * \endvar
1931  */
1932                 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
1933 /*!
1934  * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
1935  * \li Action: Open LyX document.
1936  * \li Syntax: file-open [<FILE>]
1937  * \li Params: <FILE>: Filename to be opened.
1938  * \endvar
1939  */
1940                 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
1941
1942 /*!
1943  * \var lyx::FuncCode lyx::LFUN_CALL
1944  * \li Action: Executes a command defined in a .def file.
1945  * \li Notion: The definitions are by default read from lib/commands/default.def.\n
1946                A .def file allows to define a command with \\define "<NAME>" "<LFUN>"
1947                where <NAME> is the name of the new command and <LFUN> is the lfun code
1948                to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
1949                \\def_file "FileName" allows to include another .def file. \n
1950                This is particularly useful in connection with toolbar buttons:
1951                Since the name of the button image for this lfun is 
1952                lib/images/commands/<NAME>.png this is the way to assign an image
1953                to a complex command-sequence.
1954  * \li Syntax: call <NAME>
1955  * \li Params: <NAME>: Name of the command that must be called.
1956  * \li Origin: broider, 2 Oct 2007
1957  * \endvar
1958  */
1959                 { LFUN_CALL, "call", NoBuffer, System },
1960 /*!
1961  * \var lyx::FuncCode lyx::LFUN_META_PREFIX
1962  * \li Action: Simulate halting Meta key (Alt key on PCs).
1963  * \li Notion: Used for buffer editation not for GUI control.
1964  * \li Syntax: meta-prefix
1965  * \endvar
1966  */
1967                 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
1968 /*!
1969  * \var lyx::FuncCode lyx::LFUN_CANCEL
1970  * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
1971  * \li Syntax: cancel
1972  * \endvar
1973  */
1974                 { LFUN_CANCEL, "cancel", NoBuffer, System },
1975
1976 /*!
1977  * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
1978  * \li Action: Opens the minibuffer toolbar so that the user can type in there.
1979  * \li Notion: Usually bound to M-x shortcut.
1980  * \li Syntax: command-execute
1981  * \endvar
1982  */
1983                 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
1984                 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
1985 /*!
1986  * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
1987  * \li Action: Run more commands (LFUN and its parameters) in a sequence.
1988  * \li Syntax: command-sequence <CMDS>
1989  * \li Params: <CMDS>: Sequence of commands separated by semicolons.
1990  * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
1991  * \li Origin: Andre', 11 Nov 1999
1992  * \endvar
1993  */
1994                 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
1995
1996 /*!
1997  * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
1998  * \li Action: Save user preferences.
1999  * \li Syntax: preferences-save
2000  * \li Origin: Lgb, 27 Nov 1999
2001  * \endvar
2002  */
2003                 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
2004 /*!
2005  * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
2006  * \li Action: Reconfigure the automatic settings.
2007  * \li Syntax: reconfigure
2008  * \li Origin: Asger, 14 Feb 1997
2009  * \endvar
2010  */
2011                 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
2012 /*!
2013  * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
2014  * \li Action: Apply the given settings to user preferences.
2015  * \li Syntax: lyxrc-apply <SETTINGS>
2016  * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
2017                            to get an idea which commands to use and their syntax.
2018                            #lyx::LyXRC::LyXRCTags has the list of possible commands.
2019  * \endvar
2020  */
2021                 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
2022 /*!
2023  * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
2024  * \li Action: Determine whether keep cursor inside the editing window regardless
2025                the scrollbar movement.
2026  * \li Syntax: toggle-cursor-follows-scrollbar
2027  * \li Origin: ARRae, 2 Dec 1997
2028  * \endvar
2029  */
2030                 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
2031 /*!
2032  * \var lyx::FuncCode lyx::LFUN_SET_COLOR
2033  * \li Action: Set the given LyX color to the color defined by the X11 name given.
2034  * \li Notion: A new color entry is created if the color is unknown.
2035                Color names can be stored as a part of user settings.
2036  * \li Syntax: set-color <LYX_NAME> <X11_NAME>
2037  * \li Origin: SLior, 11 Jun 2000
2038  * \endvar
2039  */
2040                 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
2041 /*!
2042  * \var lyx::FuncCode lyx::LFUN_STATISTICS
2043  * \li Action: Count the statistics (number of words and characters)
2044                in the document or in the given selection.
2045  * \li Notion: Note that this function gives the number of words/chars written,
2046                not the number of characters which will be typeset.
2047  * \li Syntax: statistics
2048  * \li Origin: lasgouttes, Jan 27 2004; ps, Jan 8 2008
2049  * \endvar
2050  */
2051                 { LFUN_STATISTICS, "statistics", ReadOnly, System },
2052 /*!
2053  * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
2054  * \li Action: Show the inline completion at the cursor position.
2055  * \li Syntax: completion-inline
2056  * \li Origin: sts, Feb 19 2008
2057  * \endvar
2058  */
2059                 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
2060 /*!
2061  * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
2062  * \li Action: Show the completion popup at the cursor position.
2063  * \li Syntax: completion-popup
2064  * \li Origin: sts, Feb 19 2008
2065  * \endvar
2066  */
2067                 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
2068 /*!
2069  * \var lyx::FuncCode lyx::LFUN_COMPLETION_COMPLETE
2070  * \li Action: Try to complete the word or command at the cursor position.
2071  * \li Syntax: completion-complete
2072  * \li Origin: sts, Feb 19 2008
2073  * \endvar
2074  */
2075                 { LFUN_COMPLETION_COMPLETE, "complete", SingleParUpdate, Edit },
2076
2077                 { LFUN_NOACTION, "", Noop, Hidden }
2078 #ifndef DOXYGEN_SHOULD_SKIP_THIS
2079         };
2080
2081         for (int i = 0; items[i].action != LFUN_NOACTION; ++i) {
2082                 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
2083         }
2084
2085         init = true;
2086 }
2087 #endif
2088
2089 LyXAction::LyXAction()
2090 {
2091         init();
2092 }
2093
2094
2095 // Returns an action tag from a string.
2096 FuncRequest LyXAction::lookupFunc(string const & func) const
2097 {
2098         string const func2 = trim(func);
2099
2100         if (func2.empty()) {
2101                 return FuncRequest(LFUN_NOACTION);
2102         }
2103
2104         string cmd;
2105         string const arg = split(func2, cmd, ' ');
2106
2107         func_map::const_iterator fit = lyx_func_map.find(cmd);
2108
2109         return fit != lyx_func_map.end() ? FuncRequest(fit->second, arg) : FuncRequest(LFUN_UNKNOWN_ACTION);
2110 }
2111
2112
2113 string const LyXAction::getActionName(FuncCode action) const
2114 {
2115         info_map::const_iterator const it = lyx_info_map.find(action);
2116         return it != lyx_info_map.end() ? it->second.name : string();
2117 }
2118
2119
2120 LyXAction::func_type const LyXAction::getActionType(FuncCode action) const
2121 {
2122         info_map::const_iterator const it = lyx_info_map.find(action);
2123         return it != lyx_info_map.end() ? it->second.type : Hidden;
2124 }
2125
2126
2127 bool LyXAction::funcHasFlag(FuncCode action,
2128                             LyXAction::func_attrib flag) const
2129 {
2130         info_map::const_iterator ici = lyx_info_map.find(action);
2131
2132         if (ici == lyx_info_map.end()) {
2133                 LYXERR0("action: " << action << " is not known.");
2134                 LASSERT(false, /**/);
2135         }
2136
2137         return ici->second.attrib & flag;
2138 }
2139
2140
2141 LyXAction::const_func_iterator LyXAction::func_begin() const
2142 {
2143         return lyx_func_map.begin();
2144 }
2145
2146
2147 LyXAction::const_func_iterator LyXAction::func_end() const
2148 {
2149         return lyx_func_map.end();
2150 }
2151
2152
2153 } // namespace lyx