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