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