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