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