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