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