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