]> git.lyx.org Git - lyx.git/blob - src/LyXAction.cpp
fix warning
[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  * \author Pavel Sanda
11  *
12  * Full author contact details are available in file CREDITS.
13  */
14
15 #include <config.h>
16
17 #include "LyXAction.h"
18
19 #include "FuncRequest.h"
20
21 #include "support/debug.h"
22 #include "support/lstrings.h"
23
24 #include "support/lassert.h"
25
26 using namespace std;
27 using namespace lyx::support;
28
29 namespace lyx {
30
31 /*
32      NAMING RULES FOR USER-COMMANDS
33      Here's the set of rules to apply when a new command name is introduced:
34
35      1) Use the object.event order. That is, use `word-forward'
36         instead of `forward-word'.
37      2) Don't introduce an alias for an already named object. Same for events.
38      3) Forward movement or focus is called `forward' (not `right').
39      4) Backward movement or focus is called `backward' (not `left').
40      5) Upward movement of focus is called `up'.
41      6) Downward movement is called `down'.
42      7) The begin of an object is called `begin' (not `start').
43      8) The end of an object is called `end'.
44
45      (May 19 1996, 12:04, RvdK)
46 */
47
48 /* LFUN documentation
49  *
50  * The documentation below is primarily description of purpose and syntax
51  * relating to the different LFUNs.
52  *
53  * Try to find an appropriate (thematical) place when adding the new LFUN
54  * and don't forget to add doxygen commentary.
55  *
56  * Doxygen template below. Some notes: Parameters should be set in uppercase
57  * and put in <BRACKETS>, [<PARAM>] means optional one.
58  */
59
60 /*!
61  * \var lyx::FuncCode lyx::LFUN_
62  * \li Action: 
63  * \li Notion: 
64  * \li Syntax: 
65  * \li Params: 
66  * \li Sample:
67  * \li Origin: 
68  * \endvar
69  */
70
71 LyXAction lyxaction;
72
73
74 void LyXAction::newFunc(FuncCode action, string const & name,
75                         unsigned int attrib, LyXAction::func_type type)
76 {
77         lyx_func_map[name] = action;
78         FuncInfo tmpinfo;
79         tmpinfo.name = name;
80         tmpinfo.attrib = attrib;
81         tmpinfo.type = type;
82         lyx_info_map[action] = tmpinfo;
83 }
84
85
86 // Needed for LFUNs documentation to be accepted, since doxygen won't take
87 // \var inside functions.
88 #ifndef DOXYGEN_SHOULD_SKIP_THIS
89 void LyXAction::init()
90 {
91         // This function was changed to use the array below in initalization
92         // instead of calling newFunc numerous times because of compilation
93         // times. Since the array is not static we get back the memory it
94         // occupies after the init is completed. It compiles several
95         // magnitudes faster.
96
97         static bool init;
98         if (init) return;
99
100         struct ev_item {
101                 FuncCode action;
102                 char const * name;
103                 unsigned int attrib;
104                 func_type type;
105         };
106
107         ev_item const items[] = {
108 #endif
109 /*!
110  * \var lyx::FuncCode lyx::LFUN_ACCENT_ACUTE
111  * \li Action: Adds an acute accent \htmlonly (&aacute;)\endhtmlonly
112                to the next character typed.
113  * \li Syntax: accent-acute
114  * \endvar
115  */
116                 { LFUN_ACCENT_ACUTE, "accent-acute", Noop, Edit },
117 /*!
118  * \var lyx::FuncCode lyx::LFUN_ACCENT_BREVE
119  * \li Action: Adds a breve accent \htmlonly (&#259;)\endhtmlonly
120                to the next character typed.
121  * \li Syntax: accent-breve
122  * \endvar
123  */
124                 { LFUN_ACCENT_BREVE, "accent-breve", Noop, Edit },
125 /*!
126  * \var lyx::FuncCode lyx::LFUN_ACCENT_CARON
127  * \li Action: Adds a caron \htmlonly (&#462;)\endhtmlonly
128                to the next character typed.
129  * \li Syntax: accent-caron
130  * \endvar
131  */
132                 { LFUN_ACCENT_CARON, "accent-caron", Noop, Edit },
133 /*!
134  * \var lyx::FuncCode lyx::LFUN_ACCENT_CEDILLA
135  * \li Action: Adds a cedilla \htmlonly (&ccedil;)\endhtmlonly
136                to the next character typed.
137  * \li Syntax: accent-cedilla
138  * \endvar
139  */
140                 { LFUN_ACCENT_CEDILLA, "accent-cedilla", Noop, Edit },
141 /*!
142  * \var lyx::FuncCode lyx::LFUN_ACCENT_CIRCLE
143  * \li Action: Adds a circle accent \htmlonly (&aring;)\endhtmlonly
144                to the next character typed.
145  * \li Syntax: accent-circle
146  * \endvar
147  */
148                 { LFUN_ACCENT_CIRCLE, "accent-circle", Noop, Edit },
149 /*!
150  * \var lyx::FuncCode lyx::LFUN_ACCENT_CIRCUMFLEX
151  * \li Action: Adds a circumflex \htmlonly (&ecirc;)\endhtmlonly
152                to the next character typed.
153  * \li Syntax: accent-circumflex
154  * \endvar
155  */
156                 { LFUN_ACCENT_CIRCUMFLEX, "accent-circumflex", Noop, Edit },
157 /*!
158  * \var lyx::FuncCode lyx::LFUN_ACCENT_DOT
159  * \li Action: Adds a dot accent \htmlonly (&#380;)\endhtmlonly
160                to the next character typed.
161  * \li Syntax: accent-dot
162  * \endvar
163  */
164                 { LFUN_ACCENT_DOT, "accent-dot", Noop, Edit },
165 /*!
166  * \var lyx::FuncCode lyx::LFUN_ACCENT_GRAVE
167  * \li Action: Adds a grave accent \htmlonly (&egrave;)\endhtmlonly
168                to the next character typed.
169  * \li Syntax: accent-grave
170  * \endvar
171  */
172                 { LFUN_ACCENT_GRAVE, "accent-grave", Noop, Edit },
173 /*!
174  * \var lyx::FuncCode lyx::LFUN_ACCENT_HUNGARIAN_UMLAUT
175  * \li Action: Adds a Hungarian umlaut \htmlonly (&#337;)\endhtmlonly
176                to the next character typed.
177  * \li Syntax: accent-grave
178  * \endvar
179  */
180                 { LFUN_ACCENT_HUNGARIAN_UMLAUT, "accent-hungarian-umlaut", Noop, Edit },
181 /*!
182  * \var lyx::FuncCode lyx::LFUN_ACCENT_MACRON
183  * \li Action: Adds a macron \htmlonly (&#257;)\endhtmlonly
184                to the next character typed.
185  * \li Syntax: accent-macron
186  * \endvar
187  */
188                 { LFUN_ACCENT_MACRON, "accent-macron", Noop, Edit },
189 /*!
190  * \var lyx::FuncCode lyx::LFUN_ACCENT_OGONEK
191  * \li Action: Adds an ogonek accent \htmlonly (&#261;)\endhtmlonly
192                to the next character typed.
193  * \li Syntax: accent-ogonek
194  * \endvar
195  */
196                 { LFUN_ACCENT_OGONEK, "accent-ogonek", Noop, Edit },
197 /*!
198  * \var lyx::FuncCode lyx::LFUN_ACCENT_TIE
199  * \li Action: Adds a tie \htmlonly (a&#865;)\endhtmlonly
200                over the next two character typed.
201  * \li Notion: The following char will finish the tie.
202  * \li Syntax: accent-tie
203  * \endvar
204  */
205                 { LFUN_ACCENT_TIE, "accent-tie", Noop, Edit },
206 /*!
207  * \var lyx::FuncCode lyx::LFUN_ACCENT_TILDE
208  * \li Action: Adds a tilde \htmlonly (&atilde;)\endhtmlonly
209                over the next character typed.
210  * \li Syntax: accent-tilde
211  * \endvar
212  */
213                 { LFUN_ACCENT_TILDE, "accent-tilde", Noop, Edit },
214 /*!
215  * \var lyx::FuncCode lyx::LFUN_ACCENT_UMLAUT
216  * \li Action: Adds an umlaut \htmlonly (&auml;)\endhtmlonly
217                over the next character typed.
218  * \li Syntax: accent-umlaut
219  * \endvar
220  */
221                 { LFUN_ACCENT_UMLAUT, "accent-umlaut", Noop, Edit },
222 /*!
223  * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERBAR
224  * \li Action: Adds a bar \htmlonly (a&#800;)\endhtmlonly
225                under the next character typed.
226  * \li Syntax: accent-underbar
227  * \endvar
228  */
229                 { LFUN_ACCENT_UNDERBAR, "accent-underbar", Noop, Edit },
230 /*!
231  * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERDOT
232  * \li Action: Adds a dot \htmlonly (&#7841;)\endhtmlonly
233                under the next character typed.
234  * \li Syntax: accent-underdot
235  * \endvar
236  */
237                 { LFUN_ACCENT_UNDERDOT, "accent-underdot", Noop, Edit },
238
239 /*!
240  * \var lyx::FuncCode lyx::LFUN_CAPTION_INSERT
241  * \li Action: Inserts a caption inset.
242  * \li Syntax: caption-insert
243  * \li Origin: Lgb, 18 Jul 2000
244  * \endvar
245  */
246                 { LFUN_CAPTION_INSERT, "caption-insert", Noop, Edit },
247 /*!
248  * \var lyx::FuncCode lyx::LFUN_DATE_INSERT
249  * \li Action: Inserts the current date.
250  * \li Syntax: date-insert [<ARG>]
251  * \li Params: <ARG>: Format of date. The default value (%x) can be set
252                      in Preferences->Date format. For possible formats
253                      see manual page of strftime function.
254  * \li Origin: jdblair, 31 Jan 2000
255  * \endvar
256  */
257                 { LFUN_DATE_INSERT, "date-insert", Noop, Edit },
258 /*!
259  * \var lyx::FuncCode lyx::LFUN_FOOTNOTE_INSERT
260  * \li Action: Inserts a footnote inset.
261  * \li Syntax: footnote-insert
262  * \li Origin: Jug, 7 Mar 2000
263  * \endvar
264  */
265                 { LFUN_FOOTNOTE_INSERT, "footnote-insert", Noop, Edit },
266 /*!
267  * \var lyx::FuncCode lyx::LFUN_ERT_INSERT
268  * \li Action: Inserts an ERT inset.
269  * \li Syntax: ert-insert
270  * \li Origin: Jug, 18 Feb 2000
271  * \endvar
272  */
273                 { LFUN_ERT_INSERT, "ert-insert", Noop, Edit },
274 /*!
275  * \var lyx::FuncCode lyx::LFUN_FLOAT_INSERT
276  * \li Action: Inserts a float inset.
277  * \li Syntax: float-insert <TYPE>
278  * \li Params: <TYPE>: type of float depends on the used textclass. Usually
279                        "algorithm", "table", "figure" parameters can be given.
280  * \li Origin: Lgb, 27 Jun 2000
281  * \endvar
282  */
283                 { LFUN_FLOAT_INSERT, "float-insert", Noop, Edit },
284 /*!
285  * \var lyx::FuncCode lyx::LFUN_FLOAT_WIDE_INSERT
286  * \li Action: Inserts float insets as in #LFUN_FLOAT_INSERT but span multiple columns.
287  * \li Notion: Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
288  * \li Syntax: float-wide-insert <TYPE>
289  * \li Params: <TYPE>: type of float depends on the used textclass. Usually
290                        "algorithm", "table", "figure" parameters can be given.
291  * \li Origin: Lgb, 31 Oct 2001
292  * \endvar
293  */
294                 { LFUN_FLOAT_WIDE_INSERT, "float-wide-insert", Noop, Edit },
295 /*!
296  * \var lyx::FuncCode lyx::LFUN_FLOAT_LIST_INSERT
297  * \li Action: Inserts the list of floats in the document.
298  * \li Syntax: float-list-insert <TYPE>
299  * \li Params: <TYPE>: type of float depends on the used textclass. Usually
300                        "algorithm", "table", "figure" parameters can be given.
301  * \li Origin: Lgb, 3 May 2001
302  * \endvar
303  */
304                 { LFUN_FLOAT_LIST_INSERT, "float-list-insert", Noop, Edit },
305 /*!
306  * \var lyx::FuncCode lyx::LFUN_WRAP_INSERT
307  * \li Action: Inserts floats wrapped by the text around.
308  * \li Syntax: wrap-insert <TYPE>
309  * \li Params: <TYPE>: table|figure
310  * \li Origin: Dekel, 7 Apr 2002
311  * \endvar
312  */
313                 { LFUN_WRAP_INSERT, "wrap-insert", Noop, Edit },
314 /*!
315  * \var lyx::FuncCode lyx::LFUN_OPTIONAL_INSERT
316  * \li Action: Inserts an optional-argument (short title) inset.
317  * \li Syntax: optional-insert
318  * \li Origin: vermeer, 12 Aug 2002
319  * \endvar
320  */
321                 { LFUN_OPTIONAL_INSERT, "optional-insert", Noop, Edit },
322 /*!
323  * \var lyx::FuncCode lyx::LFUN_LINE_INSERT
324  * \li Action: Inserts a horizontal line.
325  * \li Syntax: line-insert
326  * \li Origin: Andre, Oct 27 2003
327  * \endvar
328  */
329                 { LFUN_LINE_INSERT, "line-insert", Noop, Edit },
330 /*!
331  * \var lyx::FuncCode lyx::LFUN_NEWPAGE_INSERT
332  * \li Action: Inserts a new page.
333  * \li Syntax: newpage-insert <ARG>
334  * \li Params: <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
335  * \li Origin: uwestoehr, 24 Nov 2007
336  * \endvar
337  */
338                 { LFUN_NEWPAGE_INSERT, "newpage-insert", Noop, Edit },
339 /*!
340  * \var lyx::FuncCode lyx::LFUN_MARGINALNOTE_INSERT
341  * \li Action: Inserts a marginal note.
342  * \li Syntax: marginalnote-insert
343  * \li Origin: Lgb, 26 Jun 2000
344  * \endvar
345  */
346                 { LFUN_MARGINALNOTE_INSERT, "marginalnote-insert", Noop, Edit },
347 /*!
348  * \var lyx::FuncCode lyx::LFUN_UNICODE_INSERT
349  * \li Action: Inserts a single unicode character.
350  * \li Syntax: unicode-insert <CHAR>
351  * \li Params: <CHAR>: The character to insert, given as its code
352                        point, in hexadecimal.
353  * \li Sample: unicode-insert 0x0100
354  * \li Origin: Lgb, 22 Oct 2006
355  * \endvar
356  */
357                 { LFUN_UNICODE_INSERT, "unicode-insert", Noop, Edit },
358 /*!
359  * \var lyx::FuncCode lyx::LFUN_LISTING_INSERT
360  * \li Action: Inserts a new listings inset.
361  * \li Syntax: listing-insert
362  * \li Origin: Herbert, 10 Nov 2001; bpeng, 2 May 2007
363  * \endvar
364  */
365                 { LFUN_LISTING_INSERT, "listing-insert", Noop, Edit },
366 /*!
367  * \var lyx::FuncCode lyx::LFUN_QUOTE_INSERT
368  * \li Action: Inserts quotes according to the type and quote-language preference.
369  * \li Action: Currently  English, Swedish, German, Polish, French, Danish quotes
370                are distinguished.
371  * \li Syntax: quote-insert [<TYPE>]
372  * \li Params: <TYPE>: 'single' for single quotes, otherwise double quotes will be used.
373  * \endvar
374  */
375                 { LFUN_QUOTE_INSERT, "quote-insert", Noop, Edit },
376 /*!
377  * \var lyx::FuncCode lyx::LFUN_INFO_INSERT
378  * \li Action: Displays shortcuts, lyxrc, package and textclass availability and menu
379                information in a non-editable boxed InsetText.
380  * \li Notion: Apart from lfun arguments you can use the following method: \n
381                1. input the type and argument of this inset, e.g. "menu paste", in
382                the work area.\n
383                2. select the text and run info-insert lfun.
384  * \li Syntax: info-insert <TYPE> <ARG>
385  * \li Params: <TYPE>: shortcut|lyxrc|package|textclass|menu|buffer \n
386                <ARG>: argument for a given type. Look into InsetInfo.h for detailed
387                       description.
388  * \li Origin: bpeng, 7 Oct 2007
389  * \endvar
390  */
391                 { LFUN_INFO_INSERT, "info-insert", Noop, Edit },
392 /*!
393  * \var lyx::FuncCode lyx::LFUN_BRANCH_INSERT
394  * \li Action: Inserts branch inset.
395  * \li Syntax: branch-insert <BRANCH-NAME>
396  * \li Origin: vermeer, 17 Aug 2003
397  * \endvar
398  */
399                 { LFUN_BRANCH_INSERT, "branch-insert", Noop, Edit },
400 /*!
401  * \var lyx::FuncCode lyx::LFUN_BOX_INSERT
402  * \li Action: Inserts Box inset.
403  * \li Syntax: box-insert [<TYPE>]
404  * \li Params: <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox \n
405                        Framed is the default one.
406  * \li Origin: vermeer, 7 Oct 2003
407  * \endvar
408  */
409                 { LFUN_BOX_INSERT, "box-insert", Noop, Edit },
410 /*!
411  * \var lyx::FuncCode lyx::LFUN_FLEX_INSERT
412  * \li Action: Inserts CharStyle, Custom inset or XML short element.
413  * \li Notion: Look into the Customization manual for more information about
414                these elements.\n
415                To make this command enabled the layout file for the document
416                class you're using has to load the character styles. There are
417                a few contained in the Logical Markup module. You can also of
418                course create some yourself. \n
419                For dissolving the element see #LFUN_INSET_DISSOLVE.
420  * \li Syntax: flex-insert <TYPE:Name>
421  * \li Params: TYPE: CharStyle|Custom|Element|Standard \n
422                      Identifies whether this is a Character Style, a
423                      Custom Inset or an XML Element, and which dynamical 
424                      sub-menu this flex inset is in on the LyX menu tree. 
425                      If Standard (currently unused): none of these.
426                Name: This name must be defined either in your layout file
427                      or imported by some module. The definition is \n
428                      InsetLayout <TYPE:Name>
429  * \li Sample: flex-insert CharStyle:Code
430  * \endvar
431  */
432                 { LFUN_FLEX_INSERT, "flex-insert", Noop, Edit },
433 /*!
434  * \var lyx::FuncCode lyx::LFUN_SELF_INSERT
435  * \li Action: Inserts the given string (accordingly to the correct keymap).
436  * \li Notion: Automatically replace the currently selected text. Depends on lyxrc
437                settings "auto_region_delete".
438  * \li Syntax: self-insert <STRING>
439  * \endvar
440  */
441                 { LFUN_SELF_INSERT, "self-insert", SingleParUpdate, Hidden },
442 /*!
443  * \var lyx::FuncCode lyx::LFUN_SPACE_INSERT
444  * \li Action: Inserts one of horizontal space insets.
445  * \li Syntax: space-insert <NAME> [<LEN>]
446  * \li Params: <NAME>: normal, protected, thin, quad, qquad, enspace, enskip,
447                        negthinspace, hfill, hfill*, dotfill, hrulefill, hspace,
448                        hspace* \n
449                <LEN>: length for custom spaces (hspace, hspace* for protected)
450  * \li Origin: JSpitzm, 20 May 2003, Mar 17 2008
451  * \endvar
452  */
453                 { LFUN_SPACE_INSERT, "space-insert", Noop, Edit },
454 /*!
455  * \var lyx::FuncCode lyx::LFUN_HYPERLINK_INSERT
456  * \li Action: Inserts hyperlinks into the document (clickable in pdf output).
457  * \li Notion: Hyperlink target can be set via selection + hyperlink-insert function.
458  * \li Syntax: href-insert [<TARGET>]
459  * \li Origin: CFO-G, 21 Nov 1997
460  * \endvar
461  */
462                 { LFUN_HYPERLINK_INSERT, "href-insert", Noop, Edit },
463 /*!
464  * \var lyx::FuncCode lyx::LFUN_SPECIALCHAR_INSERT
465  * \li Action: Inserts various characters into the document.
466  * \li Syntax: specialchar-insert <CHAR>
467  * \li Params: <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots,
468                        end-of-sentence, menu-separator.
469  * \li Origin: JSpitzm, 6 Dec 2007
470  * \endvar
471  */
472                 { LFUN_SPECIALCHAR_INSERT, "specialchar-insert", Noop, Edit },
473 /*!
474  * \var lyx::FuncCode lyx::LFUN_TOC_INSERT
475  * \li Action: Inserts table of contents.
476  * \li Syntax: toc-insert
477  * \li Origin: Lgb, 27 May 97
478  * \endvar
479  */
480                 { LFUN_TOC_INSERT, "toc-insert", Noop, Edit },
481 /*!
482  * \var lyx::FuncCode lyx::LFUN_APPENDIX
483  * \li Action: Start (or remove) Appendix on the given cursor position.
484  * \li Syntax: appendix
485  * \li Origin: ettrich, 5 May 1998
486  * \endvar
487  */
488                 { LFUN_APPENDIX, "appendix", Noop, Edit },
489
490 /*!
491  * \var lyx::FuncCode lyx::LFUN_INDEX_INSERT
492  * \li Action: Inserts Index entry.
493  * \li Notion: It automatically takes the word on the cursor position.
494  * \li Syntax: index-insert
495  * \li Origin: leeming, 3 Aug 2000
496  * \endvar
497  */
498                 { LFUN_INDEX_INSERT, "index-insert", Noop, Edit },
499 /*!
500  * \var lyx::FuncCode lyx::LFUN_INDEX_PRINT
501  * \li Action: Inserts list of Index entries on a new page.
502  * \li Syntax: index-print
503  * \li Origin: Lgb, 27 Feb 1997
504  * \endvar
505  */
506                 { LFUN_INDEX_PRINT, "index-print", Noop, Edit },
507
508 /*!
509  * \var lyx::FuncCode lyx::LFUN_NOMENCL_INSERT
510  * \li Action: Inserts Nomenclature entry.
511  * \li Notion: It automatically takes the word on the cursor position if no symbol is given.
512  * \li Syntax: nomencl-insert [<SYMBOL>]
513  * \li Origin: Ugras, 4 Nov 2006
514  * \endvar
515  */
516                 { LFUN_NOMENCL_INSERT, "nomencl-insert", Noop, Edit },
517 /*!
518  * \var lyx::FuncCode lyx::LFUN_NOMENCLATURE_PRINT
519  * \li Action: Inserts list of Nomenclature entries.
520  * \li Syntax: nomenclature-print
521  * \li Origin: Ugras, 4 Nov 2006
522  * \endvar
523  */
524                 { LFUN_NOMENCL_PRINT, "nomencl-print", Noop, Edit },
525
526 /*!
527  * \var lyx::FuncCode lyx::LFUN_NOTE_INSERT
528  * \li Action: Inserts Note on the current cursor postion,
529                move selection inside the inset.
530  * \li Syntax: note-insert [<TYPE>]
531  * \li Params: <TYPE>: <Note|Greyedout|Comment> default: Note
532  * \endvar
533  */
534                 { LFUN_NOTE_INSERT, "note-insert", Noop, Edit },
535 /*!
536  * \var lyx::FuncCode lyx::LFUN_NOTE_NEXT
537  * \li Action: Moves the cursor to the begining of next Note inset.
538  * \li Syntax: note-next
539  * \endvar
540  */
541                 { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
542 /*!
543  * \var lyx::FuncCode lyx::LFUN_NOTES_MUTATE
544  * \li Action: Changes all Note insets of a particular type (source)
545                to a different type (target) fot the current document.
546  * \li Syntax: notes-mutate <SOURCE> <TARGET>
547  * \li Params: <SOURCE/TARGET>: Note|Comment|Greyedout
548  * \li Origin: sanda, 18 Jun 2008
549  * \endvar
550  */
551                 { LFUN_NOTES_MUTATE, "notes-mutate", Argument, Edit },
552 /*!
553  * \var lyx::FuncCode lyx::LFUN_NEWLINE_INSERT
554  * \li Action: Inserts a line break or new line.
555  * \li Syntax: newline-insert [<ARG>]
556  * \li Params: <ARG>: <newline|linebreak> default: newline
557  * \li Origin: JSpitzm, 25 Mar 2008
558  * \endvar
559  */
560                 { LFUN_NEWLINE_INSERT, "newline-insert", Noop, Edit },
561
562 /*!
563  * \var lyx::FuncCode lyx::LFUN_ESCAPE
564  * \li Action: Clears the selection. If no text is selected call #LFUN_FINISHED_FORWARD.
565  * \li Syntax: escape
566  * \li Origin: Lgb, 17 May 2001
567  * \endvar
568  */
569                 { LFUN_ESCAPE, "escape", ReadOnly, Edit },
570 /*!
571  * \var lyx::FuncCode lyx::LFUN_DOWN
572  * \li Action: Moves the cursor one line in downward direction.
573  * \li Syntax: down
574  * \endvar
575  */
576                 { LFUN_DOWN, "down", ReadOnly | NoUpdate, Edit },
577 /*!
578  * \var lyx::FuncCode lyx::LFUN_UP
579  * \li Action: Moves the cursor one line in upward direction.
580  * \li Syntax: up
581  * \endvar
582  */
583                 { LFUN_UP, "up", ReadOnly | NoUpdate, Edit },
584 /*!
585  * \var lyx::FuncCode lyx::LFUN_DOWN_SELECT
586  * \li Action: Moves the cursor one line in downward direction adding the current
587                position to the selection.
588  * \li Syntax: down-select
589  * \endvar
590  */
591                 { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, Edit },
592 /*!
593  * \var lyx::FuncCode lyx::LFUN_UP_SELECT
594  * \li Action: Moves the cursor one line in upward direction adding the current
595                position to the selection.
596  * \li Syntax: up-select
597  * \endvar
598  */
599                 { LFUN_UP_SELECT, "up-select", ReadOnly | SingleParUpdate, Edit },
600 /*!
601  * \var lyx::FuncCode lyx::SCREEN_DOWN
602  * \li Action: Moves the cursor one page in downward direction.
603  * \li Syntax: screen-down
604  * \endvar
605  */
606                 { LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit },
607 /*!
608  * \var lyx::FuncCode lyx::LFUN_SCREEN_UP
609  * \li Action: Moves the cursor one page in upward direction.
610  * \li Syntax: screen-up
611  * \endvar
612  */
613                 { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit },
614 /*!
615  * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN_SELECT
616  * \li Action: Moves the cursor one screen in downward direction adding the current
617                position to the selection.
618  * \li Syntax: screen-down-select
619  * \endvar
620  */
621                 { LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit },
622 /*!
623  * \var lyx::FuncCode lyx::LFUN_SCREEN_UP_SELECT
624  * \li Action: Moves the cursor one page in upward direction adding the current
625                position to the selection.
626  * \li Syntax: screen-up-select
627  * \endvar
628  */
629                 { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit },
630 /*!
631  * \var lyx::FuncCode lyx::LFUN_SCROLL
632  * \li Action: Scroll the buffer view.
633  * \li Notion: Only scrolls the screen up or down; does not move the cursor.
634  * \li Syntax: scroll <TYPE> <QUANTITY>
635  * \li Params: <TYPE>:  line|page\n
636                <QUANTITY>: up|down|<number>
637  * \li Origin: Abdel, Dec 27 2007
638  * \endvar
639  */
640                 { LFUN_SCROLL, "scroll", ReadOnly, Edit },
641 /*!
642  * \var lyx::FuncCode lyx::LFUN_SCREEN_RECENTER
643  * \li Action: Recenters the screen on the current cursor position.
644  * \li Syntax: screen-recenter
645  * \endvar
646  */
647                 { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit },
648
649 /*!
650  * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD
651  * \li Action: Moves the cursor one position logically backwards.
652  * \li Notion: This is not the action which should be bound to the arrow keys,
653                because backwards may be left or right, depending on the
654                language. The arrow keys should be bound to #LFUN_CHAR_LEFT or
655                #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
656  * \li Syntax: char-backward
657  * \endvar
658  */
659                 { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit },
660 /*!
661  * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD_SELECT
662  * \li Action: Moves the cursor one position logically backwards, adding
663                traversed position to the selection.
664  * \li Notion: See also #LFUN_CHAR_BACKWARD.
665  * \li Syntax: char-backward-select
666  * \endvar
667  */
668                 { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit },
669 /*!
670  * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_BACKWARD
671  * \li Action: Deletes one character in the backward direction (usually the "BackSpace" key).
672  * \li Syntax: char-delete-backward
673  * \endvar
674  */
675                 { LFUN_CHAR_DELETE_BACKWARD, "char-delete-backward", SingleParUpdate, Edit },
676 /*!
677  * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_FORWARD
678  * \li Action: Deletes one character in the backward direction (usually the "Delete" key).
679  * \li Syntax: char-delete-forward
680  * \endvar
681  */
682                 { LFUN_CHAR_DELETE_FORWARD, "char-delete-forward", SingleParUpdate, Edit },
683 /*!
684  * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD
685  * \li Action: Moves the cursor one position logically forward.
686  * \li Notion: This is not the action which should be bound to the arrow keys,
687                because forward may be left or right, depending on the language.
688                The arrow keys should be bound to #LFUN_CHAR_LEFT or
689                #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
690  * \li Syntax: char-forward
691  * \endvar
692  */
693                 { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit },
694 /*!
695  * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD_SELECT
696  * \li Action: Moves the cursor one position logically forward, adding
697                traversed position to the selection.
698  * \li Notion: See also #LFUN_CHAR_FORWARD.
699  * \li Syntax: char-forward-select
700  * \endvar
701  */
702                 { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit },
703 /*!
704  * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT
705  * \li Action: Moves the cursor one position "to the left".
706  * \li Notion: This is the action which should be taken when the "left" key
707                is pressed. Generally, it moves the cursor one position to the
708                left. However, in Bidi text this become slightly more
709                complicated, and there are different modes of cursor movement.
710                In "visual mode", this moves left, plain and simple. In "logical
711                mode", movement is logically forward in RTL paragraphs, and
712                logically backwards in LTR paragraphs.
713  * \li Syntax: char-left
714  * \endvar
715  */
716                 { LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit },
717 /*!
718  * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT_SELECT
719  * \li Action: Moves the cursor one position "to the left", adding 
720                traversed position to the selection.
721  * \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement.
722  * \li Syntax: char-left-select
723  * \endvar
724  */
725                 { LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit },
726 /*!
727  * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT
728  * \li Action: Moves the cursor one position "to the right".
729  * \li Notion: This is the action which should be taken when the "right" key
730                is pressed. Generally, it moves the cursor one position to the
731                right. However, in Bidi text this become slightly more
732                complicated, and there are different modes of cursor movement.
733                In "visual mode", this moves right, plain and simple. In "logical
734                mode", movement is logically forward in LTR paragraphs, and
735                logically backwards in RTL paragraphs.
736  * \li Syntax: char-right
737  * \endvar
738  */
739                 { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit },
740 /*!
741  * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT_SELECT
742  * \li Action: Moves the cursor one position "to the right", adding
743                traversed position to the selection.
744  * \li Notion: See also #LFUN_CHAR_RIGHT for exact details of the movement.
745  * \li Syntax: char-right-select
746  * \endvar
747  */
748                 { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit },
749
750 /*!
751  * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD
752  * \li Action: Moves the cursor to the logically previous beginning of a word.
753  * \li Notion: This is not the action which should be bound to the arrow keys,
754                because backwards may be left or right, depending on the
755                language. The arrow keys should be bound to #LFUN_WORD_LEFT or
756                #LFUN_WORD_RIGHT actions, which in turn may employ this one.
757  * \li Syntax: word-backward
758  * \endvar
759  */
760                 { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit },
761 /*!
762  * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD_SELECT
763  * \li Action: Moves the cursor to the logically previous beginning of a word,
764                            adding the logically traversed text to the selection.
765  * \li Notion: See also #LFUN_WORD_BACKWARD.
766  * \li Syntax: word-backward-select
767  * \endvar
768  */
769                 { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
770 /*!
771  * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_BACKWARD
772  * \li Action: Deletes characters to the begining of the word (usually the "C+BackSpace" key).
773  * \li Syntax: word-delete-backward
774  * \endvar
775  */
776                 { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
777 /*!
778  * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_FORWARD
779  * \li Action: Deletes characters to the end of the word (usually the "C+Delete" key).
780  * \li Syntax: word-delete-forward
781  * \endvar
782  */
783                 { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
784 /*!
785  * \var lyx::FuncCode lyx::LFUN_WORD_FIND_FORWARD
786  * \li Action: Search for a given string in forward direction.
787  * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
788  * \li Syntax: word-find-forward [<STRING>]
789  * \li Origin: Etienne, 16 Feb 1998
790  * \endvar
791  */
792                 { LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit },
793 /*!
794  * \var lyx::FuncCode lyx::LFUN_WORD_FIND_BACKWARD
795  * \li Action: Search for a given string in backward direction.
796  * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
797  * \li Syntax: word-find-backward [<STRING>]
798  * \li Origin: Etienne, 20 Feb 1998
799  * \endvar
800  */
801                 { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
802 /*!
803  * \var lyx::FuncCode lyx::LFUN_WORD_FIND
804  * \li Action: Search for next occurence of a string.
805  * \li Syntax: word-find [<DATA>]
806  * \li Params: <DATA>: data encoded from Find dialog (see #lyx::find2string()).
807                        If no parameter is given, search with last find-dialog
808                        data is used for search (i.e. find-next).
809  * \li Origin: Andre, Jan 7 2004
810  * \endvar
811  */
812                 { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
813 /*!
814  * \var lyx::FuncCode lyx::LFUN_WORD_FIND
815  * \li Action: Replace a string in the document.
816  * \li Syntax: word-replace [<DATA>]
817  * \li Params: <DATA>: data is of the form
818                        "<search> \n
819                         <replace> \n
820                         <casesensitive> <matchword> <all> <forward>"
821  * \li Origin: Andre, Jan 7 2004
822  * \endvar
823  */
824                 { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
825 /*!
826  * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD
827  * \li Action: Moves the cursor to the logically next beginning of a word.
828  * \li Notion: This is not the action which should be bound to the arrow keys,
829                because forward may be left or right, depending on the language.
830                The arrow keys should be bound to #LFUN_WORD_LEFT or
831                #LFUN_WORD_RIGHT actions, which in turn may employ this one.
832  * \li Syntax: word-forward
833  * \endvar
834  */
835                 { LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
836 /*!
837  * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD_SELECT
838  * \li Action: Moves the cursor to the logically next beginning of a word, 
839                            adding the logically traversed text to the selection.
840  * \li Notion: See also #LFUN_WORD_FORWARD.
841  * \li Syntax: word-forward-select
842  * \endvar
843  */
844                 { LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
845 /*!
846  * \var lyx::FuncCode lyx::LFUN_WORD_LEFT
847  * \li Action: Moves the cursor to the next beginning of a word "on the left".
848  * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
849                            "left" key is pressed. Generally, it moves the cursor to the 
850                            next beginning of a word on the left. However, in Bidi text this 
851                            become slightly more complicated, and there are different modes
852                            of cursor movement. In "visual mode", this moves left, plain and
853                            simple. In "logical mode", movement is logically forward in RTL
854                            paragraphs, and logically backwards in LTR paragraphs.
855  * \li Syntax: word-left
856  * \li Origin: dov, 28 Oct 2007
857  * \endvar
858  */
859                 { LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
860 /*!
861  * \var lyx::FuncCode lyx::LFUN_WORD_LEFT_SELECT
862  * \li Action: Moves the cursor to the next beginning of a word "on the left",
863                            adding *logically* traversed text to the selection.
864  * \li Notion: See also #LFUN_WORD_LEFT for exact details of the movement.
865  * \li Syntax: word-left-select
866  * \li Origin: dov, 28 Oct 2007
867  * \endvar
868  */
869                 { LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit },
870 /*!
871  * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT
872  * \li Action: Moves the cursor to the next beginning of a word "on the right".
873  * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
874                            "right" key is pressed. Generally, it moves the cursor to the 
875                            next beginning of a word on the right. However, in Bidi text 
876                            this become slightly more complicated, and there are different
877                            modes of cursor movement. In "visual mode", this moves right,
878                            plain and simple. In "logical mode", movement is logically 
879                            forward in LTR paragraphs, and logically backwards in RTL 
880                            paragraphs.
881  * \li Syntax: word-right
882  * \li Origin: dov, 28 Oct 2007
883  * \endvar
884  */
885                 { LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit },
886 /*!
887  * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT_SELECT
888  * \li Action: Moves the cursor to the next beginning of a word "on the right",
889                            adding *logically* traversed text to the selection.
890  * \li Notion: See also #LFUN_WORD_RIGHT for exact details of the movement.
891  * \li Syntax: word-right-select
892  * \li Origin: dov, 28 Oct 2007
893  * \endvar
894  */
895                 { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
896 /*!
897  * \var lyx::FuncCode lyx::LFUN_WORD_SELECT
898  * \li Action: Puts the word where the cursor stands into the selection.
899  * \li Syntax: word-select
900  * \li Origin: Andre, 11 Sep 2002
901  * \endvar
902  */
903                 { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
904 /*!
905  * \var lyx::FuncCode lyx::LFUN_WORD_CAPITALIZE
906  * \li Action: Capitalizes the words in the selection (i.e. the first letters)
907                or the letter on the cursor position.
908  * \li Syntax: word-capitalize
909  * \endvar
910  */
911                 { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
912 /*!
913  * \var lyx::FuncCode lyx::LFUN_WORD_UPCASE
914  * \li Action: Change the words in the selection or from the cursor position
915                to the end of word to the upper case.
916  * \li Syntax: word-upcase
917  * \endvar
918  */
919                 { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
920 /*!
921  * \var lyx::FuncCode lyx::LFUN_WORD_LOWCASE
922  * \li Action: Change the words in the selection or from the cursor position
923                to the end of word to the lower case.
924  * \li Syntax: word-lowcase
925  * \endvar
926  */
927                 { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
928 /*!
929  * \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
930  * \li Action: Look up thesaurus entries with respect to the word under the cursor.
931  * \li Syntax: thesaurus-entry
932  * \li Origin: Levon, 20 Jul 2001
933  * \endvar
934  */
935                 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
936 /*!
937  * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN
938  * \li Action: Move the cursor to the beginning of the document.
939  * \li Syntax: buffer-begin
940  * \endvar
941  */
942                 { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
943 /*!
944  * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN_SELECT
945  * \li Action: Move the cursor to the beginning of the document adding the
946                traversed text to the selection.
947  * \li Syntax: buffer-begin-select
948  * \endvar
949  */
950                 { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
951 /*!
952  * \var lyx::FuncCode lyx::LFUN_BUFFER_END
953  * \li Action: Move the cursor to the end of the document.
954  * \li Syntax: buffer-end
955  * \endvar
956  */
957                 { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
958 /*!
959  * \var lyx::FuncCode lyx::LFUN_BUFFER_END_SELECT
960  * \li Action: Move the cursor to the end of the document adding the
961                traversed text to the selection.
962  * \li Syntax: buffer-end-select
963  * \endvar
964  */
965                 { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
966
967 /*!
968  * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN
969  * \li Action: Move the cursor to the begining of the (screen) line.
970  * \li Syntax: line-begin
971  * \endvar
972  */
973                 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
974 /*!
975  * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN_SELECT
976  * \li Action: Move the cursor to the beginning of the (screen) line adding the
977                traversed text to the selection.
978  * \li Syntax: line-begin-select
979  * \endvar
980  */
981                 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
982 /*!
983  * \var lyx::FuncCode lyx::LFUN_LINE_END
984  * \li Action: Move the cursor to the end of the (screen) line.
985  * \li Syntax: line-end
986  * \endvar
987  */
988                 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
989 /*!
990  * \var lyx::FuncCode lyx::LFUN_LINE_END_SELECT
991  * \li Action: Move the cursor to the end of the (screen) line adding the
992                traversed text to the selection.
993  * \li Syntax: line-end-select
994  * \endvar
995  */
996                 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
997 /*!
998  * \var lyx::FuncCode lyx::LFUN_LINE_DELETE
999  * \li Action: Deletes the letters to the end of the (screen) line or
1000                deletes the selection.
1001  * \li Syntax: line-delete-forward
1002  * \endvar
1003  */
1004                 { LFUN_LINE_DELETE, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
1005 /*!
1006  * \var lyx::FuncCode lyx::LFUN_COPY
1007  * \li Action: Copies to the clipboard the last edit.
1008  * \li Syntax: copy
1009  * \endvar
1010  */
1011                 { LFUN_COPY, "copy", ReadOnly, Edit },
1012 /*!
1013  * \var lyx::FuncCode lyx::LFUN_CUT
1014  * \li Action: Cuts to the clipboard.
1015  * \li Syntax: cut
1016  * \endvar
1017  */
1018                 { LFUN_CUT, "cut", Noop, Edit },
1019 /*!
1020  * \var lyx::FuncCode lyx::LFUN_PASTE
1021  * \li Action: Pastes material from the active clipboard.
1022  * \li Syntax: paste [<TYPE>]
1023  * \li Params: <TYPE>: pdf|png|jpeg|linkback
1024  * \endvar
1025  */
1026                 { LFUN_PASTE, "paste", Noop, Edit },
1027 /*!
1028  * \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE
1029  * \li Action: Pastes text from the active clipboard.
1030  * \li Syntax: clipboard-paste [<ARG>]
1031  * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1032  * \li Origin: baum, 10 Jul 2006
1033  * \endvar
1034  */
1035                 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
1036 /*!
1037  * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
1038  * \li Action: Pastes the currently text selected text.
1039  * \li Notion: Primary selection mechanism is linux-only thing.
1040  * \li Syntax: primary-selection-paste [<ARG>]
1041  * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1042  * \endvar
1043  */
1044                 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
1045 /*!
1046  * \var lyx::FuncCode lyx::LFUN_UNDO
1047  * \li Action: Undoes the last edit.
1048  * \li Syntax: undo
1049  * \endvar
1050  */
1051                 { LFUN_UNDO, "undo", Noop, Edit },
1052 /*!
1053  * \var lyx::FuncCode lyx::LFUN_REDO
1054  * \li Action: Redoes the last thing undone.
1055  * \li Syntax: redo
1056  * \endvar
1057  */
1058                 { LFUN_REDO, "redo", Noop, Edit },
1059 /*!
1060  * \var lyx::FuncCode lyx::LFUN_REPEAT
1061  * \li Action: Repeat the given command.
1062  * \li Syntax: repeat <COUNT> <LFUN-COMMAND>
1063  * \li Origin: Andre, , 27 Oct 2003
1064  * \endvar
1065  */
1066                 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
1067 /*!
1068  * \var lyx::FuncCode lyx::LFUN_CHARS_TRANSPOSE
1069  * \li Action: Transposes the character at the cursor with the one before it.
1070  * \li Syntax: chars-transpose
1071  * \li Origin: Lgb, 25 Apr 2001
1072  * \endvar
1073  */
1074                 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
1075
1076 /*!
1077  * \var lyx::FuncCode lyx::LFUN_DEPTH_DECREMENT
1078  * \li Action: Decrease the nesting depth of the (selected) paragraph(s)
1079                inside lists.
1080  * \li Syntax: depth-decrement
1081  * \endvar
1082  */
1083                 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
1084 /*!
1085  * \var lyx::FuncCode lyx::LFUN_DEPTH_INCREMENT
1086  * \li Action: Increase the nesting depth of the (selected) paragraph(s)
1087                inside lists.
1088  * \li Syntax: depth-increment
1089  * \endvar
1090  */
1091                 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
1092
1093 /*!
1094  * \var lyx::FuncCode lyx::LFUN_FONT_BOLD
1095  * \li Action: Toggles the bold font (selection-wise).
1096  * \li Syntax: font-bold
1097  * \endvar
1098  */
1099                 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
1100 /*!
1101  * \var lyx::FuncCode lyx::LFUN_FONT_TYPEWRITER
1102  * \li Action: Toggles the typewriter family font (selection-wise).
1103  * \li Syntax: font-typewriter
1104  * \endvar
1105  */
1106                 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
1107 /*!
1108  * \var lyx::FuncCode lyx::LFUN_FONT_UNDERLINE
1109  * \li Action: Toggles underline in the font (selection-wise).
1110  * \li Syntax: font-underline
1111  * \endvar
1112  */
1113                 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
1114 /*!
1115  * \var lyx::FuncCode lyx::LFUN_FONT_EMPH
1116  * \li Action: Toggles the emphasis font style (selection-wise).
1117  * \li Syntax: font-emph
1118  * \endvar
1119  */
1120                 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
1121 /*!
1122  * \var lyx::FuncCode lyx::LFUN_FONT_NOUN
1123  * \li Action: Toggles Noun text style font (selection-wise).
1124  * \li Syntax: font-noun
1125  * \endvar
1126  */
1127                 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
1128 /*!
1129  * \var lyx::FuncCode lyx::LFUN_FONT_ROMAN
1130  * \li Action: Toggles Roman family font (selection-wise).
1131  * \li Syntax: font-roman
1132  * \endvar
1133  */
1134                 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
1135 /*!
1136  * \var lyx::FuncCode lyx::LFUN_FONT_SANS
1137  * \li Action: Toggles Sans Serif family font (selection-wise).
1138  * \li Syntax: font-sans
1139  * \endvar
1140  */
1141                 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
1142 /*!
1143  * \var lyx::FuncCode lyx::LFUN_FONT_FRAK
1144  * \li Action: Toggles Fraktur family font (math-mode, selection-wise).
1145  * \li Syntax: font-frak
1146  * \li Origin: vermeer, 10 Jan 2002
1147  * \endvar
1148  */
1149                 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
1150 /*!
1151  * \var lyx::FuncCode lyx::LFUN_FONT_ITAL
1152  * \li Action: Toggles Italics font shape (math-mode, selection-wise).
1153  * \li Syntax: font-ital
1154  * \li Origin: vermeer, 10 Jan 2002
1155  * \endvar
1156  */
1157                 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
1158 /*!
1159  * \var lyx::FuncCode lyx::LFUN_FONT_DEFAULT
1160  * \li Action: Reverts the settings of the font to the default values (selection-wise).
1161  * \li Syntax: font-default
1162  * \endvar
1163  */
1164                 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
1165 /*!
1166  * \var lyx::FuncCode lyx::LFUN_FONT_SIZE
1167  * \li Action: Sets font size according to lyx format string.
1168  * \li Syntax: font-size <SIZE>
1169  * \li Params: <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|\n
1170                        largest|huge|giant|increase|decrease|default
1171  * \endvar
1172  */
1173                 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
1174 /*!
1175  * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_APPLY
1176  * \li Action: Toggle user-defined (=last-time used) text style.
1177  * \li Notion: This style is set via #LFUN_TEXTSTYLE_UPDATE, which is
1178                automatically trigerred when using Text Style dialog.
1179  * \li Syntax: textstyle-apply
1180  * \li Origin: leeming, 12 Mar 2003
1181  * \endvar
1182  */
1183                 { LFUN_TEXTSTYLE_APPLY, "textstyle-apply", Noop, Layout },
1184 /*!
1185  * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_UPDATE
1186  * \li Action: Apply text style and update the settings to be used by #LFUN_TEXTSTYLE_APPLY.
1187  * \li Syntax: textstyle-update <FONT_INFO>
1188  * \li Params: <FONT_INFO>: specifies font atributes, e.g. family, series, shape,
1189                             size, emph, noun, underbar, number, color, language,
1190                             toggleall.\n
1191                             Use lyx -dbg action for exact syntax of text-style
1192                             dialog parameters.
1193  * \li Origin: leeming, 12 Mar 2003
1194  * \endvar
1195  */
1196                 { LFUN_TEXTSTYLE_UPDATE, "textstyle-update", Noop, Layout },
1197 /*!
1198  * \var lyx::FuncCode lyx::LFUN_SCREEN_FONT_UPDATE
1199  * \li Action: Update fonts and its metrics.
1200  * \li Notion: Automatically called after zoom, dpi, font names, or norm change.
1201  * \li Syntax: screen-font-update
1202  * \li Origin: ARRae, 13 Aug 2000
1203  * \endvar
1204  */
1205                 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
1206 /*!
1207  * \var lyx::FuncCode lyx::LFUN_FONT_STATE
1208  * \li Action: Returns the info about the current font.
1209  * \li Syntax: font-state
1210  * \endvar
1211  */
1212                 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
1213
1214 /*!
1215  * \var lyx::FuncCode lyx::LFUN_CITATION_INSERT
1216  * \li Action: Inserts citation from loaded citation database.
1217  * \li Syntax: citation-insert [<KEY>[|<TEXT_BEFORE>]]
1218  * \li Params: <KEY>: Citation (shortcut listed in available citations). \n
1219                <TEXT_BEFORE>: text which should appear before citation.
1220  * \li Origin: AAS, 97-02-23
1221  * \endvar
1222  */
1223                 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
1224 /*!
1225  * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_ADD
1226  * \li Action: Adds database, which will be used for bibtex citations.
1227  * \li Notion: Databases are added to the first BibTeX inset
1228                (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
1229  * \li Syntax: bibtex-database-add <DATABASE-NAME>
1230  * \li Origin: Ale, 30 May 1997
1231  * \endvar
1232  */
1233                 { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit },
1234 /*!
1235  * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_DEL
1236  * \li Action: Adds database, which will be used for bibtex citations.
1237  * \li Notion: Databases are deleted from the first BibTeX inset
1238                (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
1239  * \li Syntax: bibtex-database-del <DATABASE-NAME>
1240  * \li Origin: Ale, 30 May 1997
1241  * \endvar
1242  */
1243                 { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
1244
1245 /*!
1246  * \var lyx::FuncCode lyx::LFUN_LAYOUT
1247  * \li Action: Sets the layout (that is, environment) for the current paragraph.
1248  * \li Syntax: layout <LAYOUT>
1249  * \li Params: <LAYOUT>: the layout to use
1250  * \endvar
1251  */
1252                 { LFUN_LAYOUT, "layout", Noop, Layout },
1253 /*!
1254  * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH
1255  * \li Action: Launches the paragraph settings dialog.
1256  * \li Syntax: layout-paragraph
1257  * \endvar
1258  */
1259                 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
1260 /*!
1261  * \var lyx::FuncCode lyx::LFUN_LAYOUT_TABULAR
1262  * \li Action: Launches the tabular settings dialog.
1263  * \li Syntax: layout-tabular
1264  * \li Origin: Jug, 31 Jul 2000
1265  * \endvar
1266  */
1267                 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
1268 /*!
1269  * \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE
1270  * \li Action: Displays list of layout choices.
1271  * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
1272                dropbox allowing for choice of layout.
1273  * \li Syntax: drop-layouts-choice
1274  * \endvar
1275  */
1276                 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
1277 /*!
1278  * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
1279  * \li Action: Clears the module list.
1280  * \li Notion: Clears the list of included modules for the current buffer.
1281  * \li Syntax: layout-modules-clear
1282  * \li Origin: rgh, 25 August 2007
1283  * \endvar
1284  */
1285                 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", Noop, Layout },
1286 /*!
1287  * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULE_ADD
1288  * \li Action: Adds a module.
1289  * \li Notion: Adds a module to the list of included modules for the current buffer.
1290  * \li Syntax: layout-module-add <MODULE>
1291  * \li Params: <MODULE>: the module to be added
1292  * \li Origin: rgh, 25 August 2007
1293  * \endvar
1294  */
1295                 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", Noop, Layout },
1296 /*!
1297  * \var lyx::FuncCode lyx::LFUN_LAYOUT_RELOAD
1298  * \li Action: Reloads layout information.
1299  * \li Notion: Reloads all layout information for the current buffer from disk, thus
1300                recognizing any changes that have been made to layout files on the fly.
1301                This is intended to be used only by layout developers and should not be
1302                used when one is trying to do actual work.
1303  * \li Syntax: layout-reload
1304  * \li Origin: rgh, 3 September 2007
1305  * \endvar
1306  */
1307                 { LFUN_LAYOUT_RELOAD, "layout-reload", Noop, Layout },
1308 /*!
1309  * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
1310  * \li Action: Sets the text class for the current buffer.
1311  * \li Syntax: textclass-apply <TEXTCLASS>
1312  * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
1313                    the filename, minus the ".layout" extension.
1314  * \endvar
1315  */
1316                 { LFUN_TEXTCLASS_APPLY, "textclass-apply", Noop, Layout },
1317 /*!
1318  * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
1319  * \li Action: Loads information for a textclass from disk.
1320  * \li Syntax: textclass-load <TEXTCLASS>
1321  * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
1322                    the filename, minus the ".layout" extension.
1323  * \endvar
1324  */
1325                 { LFUN_TEXTCLASS_LOAD, "textclass-load", Noop, Layout },
1326
1327 /*!
1328  * \var lyx::FuncCode lyx::LFUN_MARK_OFF
1329  * \li Action: Disable selecting of text-region.
1330  * \li Syntax: mark-off
1331  * \endvar
1332  */
1333                 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
1334 /*!
1335  * \var lyx::FuncCode lyx::LFUN_MARK_ON
1336  * \li Action: Enable selecting of text-region.
1337  * \li Notion: After enabling you can simply move arrow keys to get selected region.
1338  * \li Syntax: mark-on
1339  * \endvar
1340  */
1341                 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
1342 /*!
1343  * \var lyx::FuncCode lyx::LFUN_MARK_TOGGLE
1344  * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
1345  * \li Syntax: mark-toggle
1346  * \li Origin: Andre, May 5 2006
1347  * \endvar
1348  */
1349                 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
1350                 
1351 /*!
1352  * \var lyx::FuncCode lyx::LFUN_MATH_DELIM
1353  * \li Action: Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
1354  * \li Syntax: math-delim [<LEFT>] [<RIGHT>]
1355  * \li Params: <LEFT/RIGHT>: Delimiters to be used. Each delimiter can be specified by
1356                              either a LaTeX name or a valid character.
1357                              ( is the default letter.
1358  * \li Sample: math-delim { rangle
1359  * \li Origin: Alejandro, 18 Jun 1996
1360  * \endvar
1361  */
1362                 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
1363 /*!
1364  * \var lyx::FuncCode lyx::LFUN_MATH_BIGDELIM
1365  * \li Action: Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
1366  * \li Syntax: math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
1367  * \li Params: <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r \n
1368                <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
1369  * \li Sample: math-bigdelim "Bigl" "\Downarrow" "Bigr" "\}"
1370  * \li Origin: Enrico & Georg, 7 May 2006
1371  * \endvar
1372  */
1373                 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
1374 /*!
1375  * \var lyx::FuncCode lyx::LFUN_MATH_DISPLAY
1376  * \li Action: Creates a new displayed equation in text mode.
1377                Toggles inlined/display formula in math mode.
1378  * \li Syntax: math-display [<ARG>]
1379  * \li Params: <ARG>: this argument will be passed to #LFUN_MATH_INSERT when creating
1380                       new equation from the text mode.
1381  * \li Origin: Alejandro, 18 Jun 1996
1382  * \endvar
1383  */
1384                 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
1385 /*!
1386  * \var lyx::FuncCode lyx::LFUN_MATH_INSERT
1387  * \li Action: Inserts math objects and symbols.
1388  * \li Syntax: math-insert <ARG>
1389  * \li Params: <ARG>: Symbol or LaTeX code to be inserted.
1390  * \endvar
1391  */
1392                 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
1393 /*!
1394  * \var lyx::FuncCode lyx::LFUN_MATH_SUBSCRIPT
1395  * \li Action: Enters subscript expression in math expression.
1396  * \li Syntax: math-subscript
1397  * \li Origin: vermeer, 12 Dec 2001
1398  * \endvar
1399  */
1400                 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
1401 /*!
1402  * \var lyx::FuncCode lyx::LFUN_MATH_SUPERSCRIPT
1403  * \li Action: Enters subscript expression in math expression.
1404  * \li Syntax: math-superscript
1405  * \li Origin: vermeer, 12 Dec 2001
1406  * \endvar
1407  */
1408                 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
1409 /*!
1410  * \var lyx::FuncCode lyx::LFUN_MATH_LIMITS
1411  * \li Action: Toggles the position of the limits from above/below to the right
1412                side an vice versa in integral symbol, a limit, a summation, etc.
1413  * \li Notion: Put the cursor before the symbol with the limits and then invoke
1414                math-limits.
1415  * \li Syntax: math-limits [<STATE>]
1416  * \li Params: <STATE>: limits|nolimits
1417  * \endvar
1418  */
1419                 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
1420 /*!
1421  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO
1422  * \li Action: Inserts a math macro definition at the cursor position in the text.
1423  * \li Syntax: math-macro <NAME> [<NARGS>] [def]
1424  * \li Params: <NAME>: The name of the macro, e.g. "mymacro".
1425                <NARGS>: The number of parameters of the macro. Default is 0.
1426                "def": Has no effect anymore, just for compatibility with former LyX versions.
1427  * \li Origin: ale, 10 May 1997;  sts, 21 Dec 2007
1428  * \endvar
1429  */
1430                 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
1431 /*!
1432  * \var lyx::FuncCode lyx::LFUN_MATH_MUTATE
1433  * \li Action: Mutates the type of math inset to the newly selected one.
1434  * \li Syntax: math-mutate <TYPE>
1435  * \li Params: <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
1436                        multline|gather|flalign
1437  * \li Origin: Andre, 23 May 2001
1438  * \endvar
1439  */
1440                 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
1441 /*!
1442  * \var lyx::FuncCode lyx::LFUN_MATH_SPACE
1443  * \li Action: Inserts space into math expression.
1444  * \li Notion: Use spacebar after entering this space to change type of space.
1445  * \li Syntax: math-space [<TYPE>]
1446  * \li Params: <TYPE>: negative spaces: !|negmedspace|negthickspace \n
1447                        positive spaces: ,|:|;|quad|qquad \n
1448                        "," used by default.
1449  * \li Origin: Andre, 25 Jul 2001; sanda, 16 Jun 2008
1450  * \endvar
1451  */
1452                 { LFUN_MATH_SPACE, "math-space", Noop, Math },
1453 /*!
1454  * \var lyx::FuncCode lyx::LFUN_MATH_MATRIX
1455  * \li Action: Inserts a matrix.
1456  * \li Syntax: math-matrix <COLS> <ROWS> [<ALIGN>]
1457  * \li Params: <ALIGN>: Alignment is a word composed of the vertical alignment
1458                         (b, c or t) (i.e. 1 char) and the horizontal alignments 
1459                         (l, c or r) (i.e. <COL> chars).
1460  * \li Sample: math-matrix 3 3 bccc
1461  * \endvar
1462  */
1463                 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
1464 /*!
1465  * \var lyx::FuncCode lyx::LFUN_MATH_MODE
1466  * \li Action: In text mode enters math mode (i.e. puts math insets on the current
1467                cursor position), in math mode enters text mode inside math expression.
1468  * \li Notion: If there is some selected text, it puts the text inside created math box.
1469  * \li Syntax: math-mode [<ARG>]
1470  * \li Params: <ARG>: eventual argument (LaTeX code) is passed to #LFUN_MATH_INSERT .
1471  * \li Origin: Alejandro, 4 Jun 1996
1472  * \endvar
1473  */
1474                 { LFUN_MATH_MODE, "math-mode", Noop, Math },
1475 /*!
1476  * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
1477  * \li Action: Toggles numbering of the current formula line.
1478  * \li Notion: Must be in display formula mode.
1479  * \li Syntax: math-number-line-toggle
1480  * \li Origin: Alejandro, 18 Jun 1996
1481  * \endvar
1482  */
1483                 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
1484 /*!
1485  * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
1486  * \li Action: Toggles numbering/labeling of the current formula.
1487  * \li Notion: Must be in display formula mode.
1488  * \li Syntax: math-number-toggle
1489  * \li Origin: Alejandro, 4 Jun 1996
1490  * \endvar
1491  */
1492                 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
1493 /*!
1494  * \var lyx::FuncCode lyx::LFUN_MATH_EXTERN
1495  * \li Action: Calls external program and passes the current expression/equation
1496                as an argument for the calculation in the format appropriate to the
1497                given language.
1498  * \li Notion: Selection can be used to determine the input for the external program.
1499  * \li Syntax: math-extern <LANG> [<COMMAND>]
1500  * \li Params: <LANG>: octave|maxima|maple|mathematica|script \n
1501                        where "script" stands fot the external script (normalized
1502                        expression will be passed)
1503  * \li Origin: Andre, 24 Apr 2001
1504  * \li Sample: math-extern maple simplify
1505  * \endvar
1506  */
1507                 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
1508 /*!
1509  * \var lyx::FuncCode lyx::LFUN_MATH_SIZE
1510  * \li Action: Changes arbitrarily the size used by math fonts inside a context.
1511  * \li Notion: Provides an interface to the LaTeX math mode font size commands.
1512  * \li Syntax: math-size <STYLE>
1513  * \li Params: <STYLE>: \displaystyle|\textstyle|\scriptstyle|\scriptscriptstyle
1514  * \li Origin: Alejandro, 15 Aug 1996; ps, 14 Jun 2008
1515  * \endvar
1516  */
1517                 { LFUN_MATH_SIZE, "math-size", Noop, Math },
1518 /*!
1519  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
1520  * \li Action: Unfold a Math Macro.
1521  * \li Notion: Unfold the Math Macro the cursor is in, i.e.
1522                display it as \foo.
1523  * \li Syntax: math-macro-unfold
1524  * \li Origin: sts, 06 January 2008
1525  * \endvar
1526  */
1527                 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
1528 /*!
1529  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
1530  * \li Action: Fold a Math Macro.
1531  * \li Notion: Fold the Math Macro the cursor is in if it was
1532                unfolded, i.e. displayed as \foo before.
1533  * \li Syntax: math-macro-fold
1534  * \li Origin: sts, 06 January 2008
1535  * \endvar
1536  */
1537                 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
1538 /*!
1539  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
1540  * \li Action: Add a parameter.
1541  * \li Notion: Add a parameter to a Math Macro.
1542  * \li Params: <NUM>: The number of the parameter behind which the new one
1543                will be added (1 for the first, i.e. use 0 for add a
1544                parameter at the left), defaults to the last one.
1545  * \li Syntax: math-macro-add-param <NUM>
1546  * \li Origin: sts, 06 January 2008
1547  * \endvar
1548  */
1549                 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
1550 /*!
1551  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
1552  * \li Action: Remove the last parameter.
1553  * \li Notion: Remove the last parameter of a Math Macro and
1554                remove its value in all instances of the macro
1555                in the buffer.
1556  * \li Params: <NUM>: The number of the parameter to be deleted (1 for
1557                the first), defaults to the last one.
1558  * \li Syntax: math-macro-remove-param <NUM>
1559  * \li Origin: sts, 06 January 2008
1560  * \endvar
1561  */
1562                 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
1563 /*!
1564  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
1565  * \li Action: Append a greedy parameter.
1566  * \li Notion: Append a greedy parameter to a Math Macro which
1567                eats the following mathed cell in every instance of
1568                the macro in the buffer.
1569  * \li Syntax: math-macro-append-greedy-param
1570  * \li Origin: sts, 06 January 2008
1571  * \endvar
1572  */
1573                 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
1574 /*!
1575  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
1576  * \li Action: Remove a greedy parameter.
1577  * \li Notion: Remove a greedy parameter of a Math Macro and spit
1578                out the values of it in every instance of the macro
1579                in the buffer. If it is an optional parameter the [valud]
1580                format is used.
1581  * \li Syntax: math-macro-remove-greedy-param
1582  * \li Origin: sts, 06 January 2008
1583  * \endvar
1584  */
1585                 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
1586 /*!
1587  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
1588  * \li Action: Make a parameter optional.
1589  * \li Notion: Turn the first non-optional parameter of a Math Macro
1590                into an optional parameter with a default value.
1591  * \li Syntax: math-macro-make-optional
1592  * \li Origin: sts, 06 January 2008
1593  * \endvar
1594  */
1595                 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
1596 /*!
1597  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
1598  * \li Action: Make a parameter non-optional.
1599  * \li Notion: Turn the last optional parameter of a Math Macro
1600                into a non-optional parameter. The default value is
1601                remembered to be reused later if the user changes his mind.
1602  * \li Syntax: math-macro-make-nonoptional
1603  * \li Origin: sts, 06 January 2008
1604  * \endvar
1605  */
1606                 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
1607 /*!
1608  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
1609  * \li Action: Add an optional parameter.
1610  * \li Notion: Insert an optional parameter just behind the
1611                already existing optional parameters.
1612  * \li Syntax: math-macro-add-optional-param
1613  * \li Origin: sts, 06 January 2008
1614  * \endvar
1615  */
1616                 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
1617 /*!
1618  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
1619  * \li Action: Remove the last optional parameter.
1620  * \li Notion: Remove the last optional parameter of a Math Macro and
1621                remove it in all the instances of the macro in the buffer.
1622  * \li Syntax: math-macro-remove-optional-param
1623  * \li Origin: sts, 06 January 2008
1624  * \endvar
1625  */
1626                 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
1627 /*!
1628  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
1629  * \li Action: Add a greedy optional parameter.
1630  * \li Notion: Add a greedy optional parameter which eats the value
1631                from the following cells in mathed which are in the [value]
1632                format.
1633  * \li Syntax: math-macro-add-greedy-optional-param
1634  * \li Origin: sts, 06 January 2008
1635  * \endvar
1636  */
1637                 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
1638 /*!
1639  * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
1640  * \li Action: Only active in Math Macro definition.
1641  * \li Notion: Dummy function which is only active in a Math Macro definition.
1642                It's used to toggle the Math Macro toolbar if the cursor moves
1643                into a Math Macro definition.
1644  * \li Syntax: in-mathmacrotemplate
1645  * \li Origin: sts, 06 January 2008
1646  * \endvar
1647  */
1648                 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
1649
1650 /*!
1651  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
1652  * \li Action: Moves the current paragraph downwards in the document.
1653  * \li Syntax: paragraph-move-down
1654  * \li Origin: Edwin, 8 Apr 2006
1655  * \endvar
1656  */
1657                 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
1658 /*!
1659  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
1660  * \li Action: Moves the current paragraph upwards in the document.
1661  * \li Syntax: paragraph-move-up
1662  * \li Origin: Edwin, 8 Apr 2006
1663  * \endvar
1664  */
1665                 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
1666
1667 /*!
1668  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP
1669  * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1670                in upward direction.
1671  * \li Syntax: paragraph-up
1672  * \li Origin: Asger, 1 Oct 1996
1673  * \endvar
1674  */
1675                 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
1676 /*!
1677  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP_SELECT
1678  * \li Action: Move the cursor and select the text to the next paragraph (or
1679                begining of the current one) in upward direction.
1680  * \li Syntax: paragraph-up-select
1681  * \li Origin: Asger, 1 Oct 1996
1682  * \endvar
1683  */
1684                 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
1685 /*!
1686  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN
1687  * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1688                in downward direction.
1689  * \li Syntax: paragraph-down
1690  * \li Origin: Asger, 1 Oct 1996
1691  * \endvar
1692  */
1693                 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
1694 /*!
1695  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN_SELECT
1696  * \li Action: Move the cursor and select the text to the next paragraph (or
1697                begining of the current one) in downward direction.
1698  * \li Syntax: paragraph-down-select
1699  * \li Origin: Asger, 1 Oct 1996
1700  * \endvar
1701  */
1702                 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
1703 /*!
1704  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
1705  * \li Action: Jump to a paragraph given by its id number and optionally the
1706                desired position within the paragraph.
1707  * \li Notion: Note that id number of paragraph is not the sequential number of paragraph
1708                seen on the screen. Moreover the id is unique for all opened buffers (documents).
1709  * \li Syntax: paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
1710  * \li Params: <PAR_ID_NUMBER>:  paragraph id \n
1711                <POSITION_IN_PAR>: desired position within the paragraph
1712  * \li Origin: Dekel, 26 Aug 2000
1713  * \endvar
1714  */
1715                 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly, Edit },
1716 /*!
1717  * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1718  * \li Action: Breaks the current paragraph at the current location.
1719  * \li Syntax: break-paragraph
1720  * \endvar
1721  */
1722                 { LFUN_PARAGRAPH_SPACING, "paragraph-spacing", Noop, Edit },
1723 /*!
1724  * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1725  * \li Action: Breaks the current paragraph at the current location.
1726  * \li Notion: Removes the selection.
1727  * \li Syntax: break-paragraph [<LAYOUT>]
1728  * \li Params: <LAYOUT>: "inverse" - decreases depth by one (or change layout
1729                          to default layout) when the cursor is at the end of
1730                          the line.
1731  * \endvar
1732  */
1733                 { LFUN_BREAK_PARAGRAPH, "break-paragraph", Noop, Edit },
1734 /*!
1735  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
1736  * \li Action: Change paragraph settings.
1737  * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
1738                This function only modifies, and does not override, existing settings.
1739                Note that the "leftindent" indent setting is deprecated.
1740  * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
1741  * \li Params: <INDENT>:  \\noindent|\\indent|\\indent-toggle|\\leftindent LENGTH\n
1742                <SPACING>: \\paragraph_spacing default|single|onehalf|double|other\n
1743                <ALIGN>:   \\align block|left|right|center|default\n
1744                <OTHERS>:  \\labelwidthstring WIDTH|\\start_of_appendix\n
1745  * \li Origin: rgh, Aug 15 2007
1746  * \endvar
1747  */
1748                 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
1749 /*!
1750  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
1751  * \li Action: Change paragraph settings.
1752  * \li Notion: Overwrite all nonspecified settings to the default ones.
1753                Use paragraph-params lfun if you don't want to overwrite others settings.
1754  * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
1755  * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
1756  * \li Origin: leeming, 30 Mar 2004
1757  * \endvar
1758  */
1759                 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
1760 /*!
1761  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UPDATE
1762  * \li Action: Updates the values inside the paragraph dialog from the paragraph.
1763  * \li Notion: This is internal LFUN, not to be used by users. Called internally
1764                by #LFUN_DIALOG_UPDATE.
1765  * \li Origin: leeming, 13 Mar 2003
1766  * \endvar
1767  */
1768                 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
1769
1770 /*!
1771  * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
1772  * \li Action: Move the current group in the upward direction in the
1773                structure of the document.
1774  * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1775                the whole substructure of the group.
1776  * \li Syntax: outline-up
1777  * \li Origin: Vermeer, 23 Mar 2006
1778  * \endvar
1779  */
1780                 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
1781 /*!
1782  * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
1783  * \li Action: Move the current group in the downward direction in the
1784                structure of the document.
1785  * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1786                the whole substructure of the group.
1787  * \li Syntax: outline-down
1788  * \li Origin: Vermeer, 23 Mar 2006
1789  * \endvar
1790  */
1791                 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
1792 /*!
1793  * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
1794  * \li Action: Moves the current group in the downward direction in the
1795                hierarchy of the document structure.
1796  * \li Notion: Part -> Chapter -> Section -> etc.
1797  * \li Syntax: outline-in
1798  * \li Origin: Vermeer, 23 Mar 2006
1799  * \endvar
1800  */
1801                 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
1802 /*!
1803  * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
1804  * \li Action: Moves the current group in the upward direction in the
1805                hierarchy of the document structure.
1806  * \li Notion: Part <- Chapter <- Section <- etc.
1807  * \li Syntax: outline-out
1808  * \li Origin: Vermeer, 23 Mar 2006
1809  * \endvar
1810  */
1811                 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
1812 /*!
1813  * \var lyx::FuncCode lyx::LFUN_INSET_EDIT
1814  * \li Action: Edit the inset at cursor with an external application,
1815  *             if one is attributed.
1816  * \li Syntax: inset-edit [<INSET_PARAMS>]
1817  * \li Params: <INSET_PARAMS>: Parameters for the inset. \n
1818                                Currently only the filename will be considered.
1819  * \li Origin: JSpitzm, 27 Apr 2006
1820  * \endvar
1821  */
1822                 { LFUN_INSET_EDIT, "inset-edit", Noop, Edit },
1823
1824 /*!
1825  * \var lyx::FuncCode lyx::LFUN_TABULAR_INSERT
1826  * \li Action: Inserts table into the document.
1827  * \li Syntax: tabular-insert [<ROWS> <COLUMNS>]
1828  * \li Params: In case no arguments are given show insert dialog.
1829  * \li Origin: Jug, 12 Apr 2000
1830  * \endvar
1831  */
1832                 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
1833 /*!
1834  * \var lyx::FuncCode lyx::LFUN_TABULAR_FEATURE
1835  * \li Action: Sets various features to the table/cell on the current cursor position.
1836  * \li Notion: Various math-environment features are handled here as well, e.g.
1837                add-vline-left/right for Grid/Cases environment
1838  * \li Syntax: tabular-feature <FEATURE> [<ARG>]
1839  * \li Params: <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|copy-column|
1840                        toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
1841                        align-left|align-right|align-center|align-block|valign-top|valign-bottom|
1842                        valign-middle|m-align-left|m-align-right|m-align-center|m-valign-top|
1843                        m-valign-bottom|m-valign-middle|multicolumn|set-all-lines|unset-all-lines|
1844                        set-longtabular|unset-longtabular|set-pwidth|set-mpwidth|
1845                        set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|
1846                        set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|
1847                        unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|
1848                        set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
1849                        set-special-column|set-special-multi|set-booktabs|unset-booktabs|
1850                        set-top-space|set-bottom-space|set-interline-space|set-border-lines \n
1851                 <ARG>: additional argument for some commands, use debug mode to explore its values.
1852  * \li Origin: Jug, 28 Jul 2000
1853  * \endvar
1854  */
1855                 { LFUN_TABULAR_FEATURE, "tabular-feature", Noop, Edit },
1856 /*!
1857  * \var lyx::FuncCode lyx::LFUN_CELL_BACKWARD
1858  * \li Action: Moves the cursor to the previous cell inside the table.
1859  * \li Syntax: cell-backward
1860  * \li Origin: Jug, 22 May 2000
1861  * \endvar
1862  */
1863                 { LFUN_CELL_BACKWARD, "cell-backward", Noop, Edit },
1864 /*!
1865  * \var lyx::FuncCode lyx::LFUN_CELL_FORWARD
1866  * \li Action: Moves the cursor to the next cell inside the table.
1867  * \li Syntax: cell-forward
1868  * \endvar
1869  */
1870                 { LFUN_CELL_FORWARD, "cell-forward", Noop, Edit },
1871 /*!
1872  * \var lyx::FuncCode lyx::LFUN_CELL_SPLIT
1873  * \li Action: Splits cell and shifts right part to the next cell (inside the math grid).
1874  * \li Syntax: cell-split
1875  * \li Origin: Ale, 15 May 1997
1876  * \endvar
1877  */
1878                 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
1879
1880 /*!
1881  * \var lyx::FuncCode lyx::LFUN_VC_REGISTER
1882  * \li Action: Register the document as an file inside version control system (RCS, CVS).
1883  * \li Notion: File is registered inside cvs, svn or rcs repository acording to the existence
1884                of cvs/svn/rcs entries in the document's directory. \n
1885                See LyX Extended Manual (Version Control Chapter) for additional information.
1886  * \li Syntax: vc-register
1887  * \li Origin: Lgb, 1 Jul 1997
1888  * \endvar
1889  */
1890                 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
1891 /*!
1892  * \var lyx::FuncCode lyx::LFUN_VC_CHECK_IN
1893  * \li Action: Checks-in/commits the changes of the registered file to the repository.
1894  * \li Notion: In RCS case this also unlocks the file.
1895  * \li Syntax: vc-check-in
1896  * \li Origin: Lgb, 1 Jul 1997
1897  * \endvar
1898  */
1899                 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
1900 /*!
1901  * \var lyx::FuncCode lyx::LFUN_VC_CHECK_OUT
1902  * \li Action: Checks-out the document for edit (and locks it for RCS).
1903  * \li Notion: This is implemented only for RCS and SVN, not CVS.
1904  * \li Syntax: vc-check-out
1905  * \li Origin: Lgb, 1 Jul 1997
1906  * \endvar
1907  */
1908                 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
1909 /*!
1910  * \var lyx::FuncCode lyx::LFUN_VC_REVERT
1911  * \li Action: Reverts the document to the last check-in/commit in VCS.
1912  * \li Syntax: vc-revert
1913  * \li Origin: Lgb, 1 Jul 1997
1914  * \endvar
1915  */
1916                 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
1917 /*!
1918  * \var lyx::FuncCode lyx::LFUN_VC_UNDO_LAST
1919  * \li Action: Undo last check-in.
1920  * \li Notion: This is currently implemented only for RCS.
1921  * \li Syntax: vc-check-out
1922  * \li Origin: Lgb, 1 Jul 1997
1923  * \endvar
1924  */
1925                 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
1926
1927 /*!
1928  * \var lyx::FuncCode lyx::LFUN_CHANGES_TRACK
1929  * \li Action: Toggles change tracking to on/off.
1930  * \li Syntax: changes-track
1931  * \li Origin: levon, 1 Oct 2002
1932  * \endvar
1933  */
1934                 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
1935 /*!
1936  * \var lyx::FuncCode lyx::LFUN_CHANGES_OUTPUT
1937  * \li Action: Toggles showing of change tracking in typesetted output.
1938  * \li Syntax: changes-output
1939  * \li Origin: jspitzm, 21 Jan 2005
1940  * \endvar
1941  */
1942                 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
1943 /*!
1944  * \var lyx::FuncCode lyx::LFUN_CHANGE_NEXT
1945  * \li Action: Moves the cursor to the position of the next change
1946                of the change tracking records.
1947  * \li Syntax: change-next
1948  * \li Origin: schmitt, 4 Oct 2006
1949  * \endvar
1950  */
1951                 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
1952 /*!
1953  * \var lyx::FuncCode lyx::LFUN_CHANGES_MERGE
1954  * \li Action: Open change tracking dialog for merging and moves the cursor
1955                to the position of the next change.
1956  * \li Syntax: changes-merge
1957  * \li Origin: Levon, 16 Oct 2002
1958  * \endvar
1959  */
1960                 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
1961 /*!
1962  * \var lyx::FuncCode lyx::LFUN_CHANGE_ACCEPT
1963  * \li Action: Accepts tracked change inside the selection.
1964  * \li Syntax: change-accept
1965  * \li Origin: Levon, 16 Oct 2002
1966  * \endvar
1967  */
1968                 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
1969 /*!
1970  * \var lyx::FuncCode lyx::LFUN_CHANGE_REJECT
1971  * \li Action: Rejects tracked change inside the selection.
1972  * \li Syntax: change-accept
1973  * \li Origin: Levon, 16 Oct 2002
1974  * \endvar
1975  */
1976                 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
1977 /*!
1978  * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_ACCEPT
1979  * \li Action: Accepts all tracked changes in the document.
1980  * \li Syntax: all-changes-accept
1981  * \li Origin: Levon, 16 Oct 2002
1982  * \endvar
1983  */
1984                 { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
1985 /*!
1986  * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_REJECT
1987  * \li Action: Rejects all tracked changes in the document.
1988  * \li Notion: Reject does not work recursively; the user may have to repeat the operation.
1989  * \li Syntax: all-changes-reject
1990  * \li Origin: Levon, 16 Oct 2002
1991  * \endvar
1992  */
1993                 { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
1994
1995 /*!
1996  * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
1997  * \li Action: Apply data for an inset.
1998  * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
1999                be applied. This is either changed to #LFUN_INSET_MODIFY or
2000                #LFUN_INSET_INSERT depending on the context where it is called.
2001  * \li Syntax: inset-apply <ARGS>
2002  * \li Params: See #LFUN_INSET_INSERT .
2003  * \endvar
2004  */
2005                 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
2006 /*!
2007  * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE
2008  * \li Action: Dissolve the current inset into text.
2009  * \li Syntax: inset-dissolve [<INSET>]
2010  * \li Params: <INSET>: this can be used to make sure the right kind of inset
2011                         is dissolved. For example "dissolve" entry in the charstyles
2012                         sub-menu should only dissolve the charstyle inset, even if the
2013                         cursor is inside several nested insets of different type.\n
2014                         For values see #lyx::InsetLayout::lyxtype_ .
2015  * \li Origin: JSpitz, 7 Aug 2006
2016  * \endvar
2017  */
2018                 { LFUN_INSET_DISSOLVE, "inset-dissolve", Noop, Edit },
2019 /*!
2020  * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
2021  * \li Action: Insert new inset (type given by the parameters).
2022  * \li Syntax: inset-insert <INSET> <ARGS>
2023  * \li Params: <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics|
2024                          hyperlink|include|index|label|nomencl|vspace|ref|toc>\n
2025                <ARGS>: depends on the given inset. Use "lyx -dbg action" to
2026                        explore.
2027  * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
2028                where <label name> is the name of the referenced label and
2029                <Format> is one of the following: \n
2030                ref -- <reference> \n
2031                eqref -- (<reference>) \n
2032                pageref -- <page> \n
2033                vpageref -- on <page> \n
2034                vref -- <reference> on <page> \n
2035                prettyref -- Formatted reference
2036  * \endvar
2037  */
2038                 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
2039 /*!
2040  * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
2041  * \li Action: Modify existing inset.
2042  * \li Notion: Used for label, floats, listings, box, branch, external, wrap
2043                bibtex, ert, command, graphics, note, space, vspace, tabular,
2044                bibitem, inlude, ref insets.
2045  * \li Syntax: inset-modify <INSET> <ARGS>
2046  * \li Params: See #LFUN_INSET_INSERT for further details.
2047  * \endvar
2048  */
2049                 { LFUN_INSET_MODIFY, "", Noop, Hidden },
2050 /*!
2051  * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_MODIFY
2052  * \li Action: Modify the inset at cursor position, if there is one.
2053  * \li Notion: Used for label, floats, listings, box, branch, external, wrap
2054                bibtex, ert, command, graphics, note, space, vspace, tabular,
2055                bibitem, inlude, ref insets.
2056  * \li Syntax: next-inset-modify <INSET> <ARGS>
2057  * \li Syntax: next-inset-modify changetype <TYPE>
2058  * \li Params: See #LFUN_INSET_INSERT for further details.
2059  * \li Origin: JSpitzm, 23 Mar 2008
2060  * \endvar
2061  */
2062                 { LFUN_NEXT_INSET_MODIFY, "next-inset-modify", ReadOnly, Edit },
2063 /*!
2064  * \var lyx::FuncCode lyx::LFUN_INSET_DIALOG_UPDATE
2065  * \li Action: Updates the values inside the dialog from the inset.
2066  * \li Notion: This is internal LFUN, not to be used by users. Called internally
2067                by #LFUN_DIALOG_UPDATE
2068  * \li Params: <DIALOG-NAME>
2069  * \li Origin: leeming, 25 Feb 2003
2070  * \endvar
2071  */
2072                 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
2073 /*!
2074  * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
2075  * \li Action: Open the inset's properties dialog.
2076  * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
2077  * \li Syntax: inset-settings <INSET>
2078  * \li Params: <INSET>: <box|branch|ert|float|listings|note|tabular|wrap>
2079  * \endvar
2080  */
2081                 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly, Edit },
2082 /*!
2083  * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_TOGGLE
2084  * \li Action: Toggles the inset at cursor position. For collapsables, this means it will
2085                be (un-)collapsed, in case of other insets, the editing widget (dialog) will
2086                be entered. Also cf. #LFUN_INSET_SETTINGS.
2087  * \li Notion: Used for label, floats, listings, box, branch, external, wrap
2088                bibtex, ert, command, graphics, note, space, vspace, tabular,
2089                bibitem, inlude, ref insets.
2090  * \li Syntax: next-inset-toggle <ARG>
2091  * \li Params: <ARG>: these are passed as arguments to #LFUN_INSET_TOGGLE .
2092  * \li Origin: leeming, 30 Mar 2004
2093  * \endvar
2094  */
2095                 { LFUN_NEXT_INSET_TOGGLE, "next-inset-toggle", ReadOnly, Edit },
2096 /*!
2097  * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
2098  * \li Action: Toggles the collapsable inset we are currently in.
2099  * \li Syntax: inset-toggle [<ARG>]
2100  * \li Params: <ARG>: <open|close|toggle|assign>. \n
2101                open/close/toggle are for collapsable insets. close can be currently used
2102                by #LFUN_NEXT_INSET_TOGGLE. toggle is used when no argument is given.\n
2103                assign is for branch inset.
2104  * \li Origin: lasgouttes, 19 Jul 2001
2105  * \endvar
2106  */
2107                 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly, Hidden },
2108 /*!
2109  * \var lyx::FuncCode lyx::LFUN_ALL_INSETS_TOGGLE
2110  * \li Action: Toggles (open/closes) all collapsable insets (of a given type) in the document.
2111  * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
2112  * \li Syntax: all-insets-toggle <STATE> <INSET>
2113  * \li Params: <STATE>: <toggle|open|close> default: toggle \n
2114                <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all insets
2115  * \li Origin: leeming, 30 Mar 2004
2116  * \endvar
2117  */
2118                 { LFUN_ALL_INSETS_TOGGLE, "all-insets-toggle", ReadOnly, Edit },
2119 /*!
2120  * \var lyx::FuncCode lyx::LFUN_GRAPHICS_GROUPS_UNIFY
2121  * \li Action: Unify all graphics insets with the one given as an parameter.
2122  * \li Notion: This is internally used for synchronize certain group of graphics insets.
2123  * \li Syntax: graphics-groups-unigfy <GRAPHICS_PARAMS>
2124  * \li Params: <GRAPHICS_PARAMS>: Parameters for graphics inset
2125                                   (syntax can be seen in .lyx files).
2126  * \li Origin: sanda, 6 May 2008
2127  * \endvar
2128  */
2129                 { LFUN_GRAPHICS_GROUPS_UNIFY, "graphics-groups-unify", Argument, Edit },
2130 /*!
2131  * \var lyx::FuncCode lyx::LFUN_SET_GRAPHICS_GROUP
2132  * \li Action: Set the group for the graphics inset on the cursor position.
2133  * \li Syntax: set-graphics-group [<GROUP>]
2134  * \li Params: <GROUP>: Id for an existing group. In case tthe Id is an empty string,
2135                         the graphics inset is removed from the current group.
2136  * \li Origin: sanda, 6 May 2008
2137  * \endvar
2138  */
2139                 { LFUN_SET_GRAPHICS_GROUP, "set-graphics-group", Noop, Edit },
2140
2141 /*!
2142  * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
2143  * \li Action: Moves the cursor out of the current slice, going forward.
2144  * \li Notion: Cursor movement within an inset may be different than cursor
2145                movement in the surrounding text. This action should be called
2146                automatically by the cursor movement within the inset, when
2147                movement within the inset has ceased (reached the end of the
2148                last paragraph, for example), in order to move correctly
2149                back into the surrounding text.
2150  * \endvar
2151  */
2152                 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
2153 /*!
2154  * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
2155  * \li Action: Moves the cursor out of the current slice, going backwards.
2156  * \li Notion: See also #LFUN_FINISHED_FORWARD.
2157  * \endvar
2158  */
2159                 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
2160 /*!
2161  * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
2162  * \li Action: Moves the cursor out of the current slice, going right.
2163  * \li Notion: See also #LFUN_FINISHED_FORWARD
2164  * \endvar
2165  */
2166                 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
2167 /*!
2168  * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
2169  * \li Action: Moves the cursor out of the current slice, going left.
2170  * \li Notion: See also #LFUN_FINISHED_FORWARD.
2171  * \endvar
2172  */
2173                 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
2174
2175 /*!
2176  * \var lyx::FuncCode lyx::LFUN_LANGUAGE
2177  * \li Action: Set language from the current cursor position.
2178  * \li Syntax: language <LANG>
2179  * \li Params: <LANG>: Requested language. Look in lib/languages for
2180                        the list.
2181  * \li Origin: Dekel, 2 Mar 2000
2182  * \endvar
2183  */
2184                 { LFUN_LANGUAGE, "language", Noop, Edit },
2185
2186 /*!
2187  * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
2188  * \li Action: Goto a label.
2189  * \li Syntax: label-goto [<LABEL>]
2190  * \li Params: <LABEL>: Requested label. If no label is given and refernce
2191                         is on cursor position, Bookmark 0 is saved and
2192                         cursor moves to the position of referenced label.
2193  * \li Origin: Ale, 6 Aug 1997
2194  * \endvar
2195  */
2196                 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
2197 /*!
2198  * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT
2199  * \li Action: Inserts label to text or displayed formula.
2200  * \li Syntax: label-insert [<LABEL>]
2201  * \li Params: <LABEL>: Requested label. If no label is given dialog requesting
2202                         name will be opened.
2203  * \endvar
2204  */
2205                 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
2206 /*!
2207  * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
2208  * \li Action: Go to the next label or cross-reference.
2209  * \li Syntax: reference-next
2210  * \li Origin: Dekel, 14 Jan 2001
2211  * \endvar
2212  */
2213                 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
2214
2215 /*!
2216  * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
2217  * \li Action: Goto a bookmark.
2218  * \li Notion: Moves the cursor to the numbered bookmark, opening the file
2219                if necessary. Note that bookmarsk are saved per-session, not
2220                per file.
2221  * \li Syntax: bookmark-goto <NUMBER>
2222  * \li Params: <NUMBER>: the number of the bookmark to restore.
2223  * \li Origin: Dekel, 27 January 2001
2224  * \endvar
2225  */
2226                 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
2227 /*!
2228  * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
2229  * \li Action: Save a bookmark.
2230  * \li Notion: Saves a numbered bookmark to the sessions file. The number
2231                must be between 1 and 9, inclusive. Note that bookmarks are
2232                saved per-session, not per file.
2233  * \li Syntax: bookmark-save <NUMBER>
2234  * \li Params: <NUMBER>: the number of the bookmark to save.
2235  * \li Origin: Dekel, 27 January 2001
2236  * \endvar
2237  */
2238                 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
2239 /*!
2240  * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
2241  * \li Action: Clears the list of saved bookmarks.
2242  * \li Syntax: bookmark-clear
2243  * \li Origin: bpeng, 31 October 2006
2244  * \endvar
2245  */
2246                 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
2247
2248 /*!
2249  * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
2250  * \li Action: Open the given help file according to the language setting.
2251  * \li Syntax: help-open <FILE>[.lyx]
2252  * \li Params: <FILE>: any document from (/usr/share/)doc directory.
2253  * \li Origin: Jug, 27 Jun 1999
2254  * \endvar
2255  */
2256                 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
2257 /*!
2258  * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
2259  * \li Action: Terminates the current LyX instance.
2260  * \li Notion: Terminates the current LyX instance, asking whether to save
2261                modified documents, etc.
2262  * \li Syntax: lyx-quit
2263  * \endvar
2264  */
2265                 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
2266 /*!
2267  * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
2268  * \li Action: Toggles visibility of a given toolbar between on/off/auto.
2269  * \li Notion: Skiping "auto" when allowauto is false.
2270  * \li Syntax: toolbar-toggle <NAME> [allowauto]
2271  * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|
2272                        minibuffer|review|view/update|math_panels|vcs
2273  * \li Origin: Edwin, 21 May 2007
2274  * \endvar
2275  */
2276                 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
2277 /*!
2278  * \var lyx::FuncCode lyx::LFUN_MENU_OPEN
2279  * \li Action: Opens the menu given by its name.
2280  * \li Syntax: menu-open <NAME>
2281  * \li Params: <NAME>: menu name. See various .inc files in lib/ui for candidates.
2282  * \endvar
2283  */
2284                 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
2285 /*!
2286  * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
2287  * \li Action: Various UI visibility-toggling actions.
2288  * \li Syntax: ui-toggle <statusbar|menubar|frame|fullscreen>
2289  * \li Params: statusbar  : Toggle visibility of the statusbar.\n
2290                menubar    : Toggle visibility of the menubar.\n
2291                scrollbar  : Toggle visibility of the scrollbar.\n
2292                frame      : Toggle visibility of the frames around editing window.\n
2293                fullscreen : Toggle fullscreen mode. This also covers calling the
2294                             previous functions. However #LFUN_TOOLBAR_TOGGLE for the
2295                             custom tweaks of the toolbars should be used.
2296  * \li Origin: sanda, 9 Feb 2007
2297  * \endvar
2298  */
2299                 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
2300
2301 /*!
2302  * \var lyx::FuncCode lyx::WINDOW_NEW
2303  * \li Action: Creates new empty LyX window.
2304  * \li Notion: Already opened documents from the previous window can be found under View menu.
2305  * \li Syntax: window-new [<GEOMETRY>]
2306  * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently 
2307                            accepted only on Windows platform.
2308  * \li Origin: Abdel, 21 Oct 2006
2309  * \endvar
2310  */
2311                 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
2312 /*!
2313  * \var lyx::FuncCode lyx::LFUN_WINDOW_CLOSE
2314  * \li Action: Closes the current LyX window.
2315  * \li Syntax: window-close
2316  * \li Origin: Abdel, 23 Oct 2006
2317  * \endvar
2318  */
2319                 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
2320
2321 /*!
2322  * \var lyx::FuncCode lyx::LFUN_SPLIT_VIEW
2323  * \li Action: Creates another split view of current buffer.
2324  * \li Notion: All split views act in the same way indpendently.
2325  * \li Syntax: split-view <vertical|horizontal>
2326  * \li Params: horizontal : The work areas are laid out side by side.\n
2327                vertical   : The work areas laid out vertically.
2328  * \li Origin: Abdel, 20 Feb 2008
2329  * \endvar
2330  */
2331                 { LFUN_SPLIT_VIEW, "split-view", ReadOnly, Buffer },
2332
2333 /*!
2334  * \var lyx::FuncCode lyx::LFUN_CLOSE_TAB_GROUP
2335  * \li Action: Close the current tab group.
2336  * \li Notion: This only closes the work areas, not the buffer themselves.
2337                The still opened buffers can be visualized in another tab group.
2338  * \li Syntax: close-tab-group
2339  * \li Origin: Abdel, 21 Feb 2008
2340  * \endvar
2341  */
2342                 { LFUN_CLOSE_TAB_GROUP, "close-tab-group", ReadOnly, Buffer },
2343 /*!
2344  * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW
2345  * \li Action: Shows hidden dialog or create new one for a given function/inset settings etc.
2346  * \li Syntax: dialog-show <NAME> [<DATA>]
2347  * \li Params: <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|\n
2348                document|errorlist|ert|external|file|findreplace|float|graphics|\n
2349                include|index|info|nomenclature|label|log|mathdelimiter|mathmatrix|\n
2350                note|paragraph|prefs|print|ref|sendto|space|spellchecker|symbols|\n
2351                tabular|tabularcreate|thesaurus|texinfo|toc|href|view-source|vspace\n
2352                wrap|listings|<SPECIAL> \n
2353                <SPECIAL>: latexlog|vclog \n
2354                <DATA>: data, usually settings for the given dialog. Use debug mode for the
2355                        details.
2356  * \li Origin: leeming, 17 Jun 2003
2357  * \endvar
2358  */
2359                 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
2360 /*!
2361  * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW_NEW_INSET
2362  * \li Action: Shows hidden dialog or create new one for a given inset settings etc.
2363  * \li Notion: Internally uses #LFUN_DIALOG_SHOW with processed data for a given inset.
2364  * \li Syntax: dialog-show-new-inset <NAME> [<DATA>]
2365  * \li Params: See #LFUN_DIALOG_SHOW .
2366  * \li Origin: leeming, 25 Feb 2003
2367  * \endvar
2368  */
2369                 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
2370 /*!
2371  * \var lyx::FuncCode lyx::LFUN_DIALOG_UPDATE
2372  * \li Action: Updates the dialog values from the inset/paragraph/document.
2373  * \li Syntax: dialog-update <NAME>
2374  * \li Params: <NAME>: paragraph|prefs|<INSET> \n
2375                <INSET>: inset name
2376  * \li Origin: leeming, 25 Feb 2003
2377  * \endvar
2378  */
2379                 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
2380 /*!
2381  * \var lyx::FuncCode lyx::LFUN_DIALOG_HIDE
2382  * \li Action: Hides showed dialog. Counterpart to #LFUN_DIALOG_SHOW .
2383  * \li Syntax: dialog-hide <NAME>
2384  * \li Params: See #LFUN_DIALOG_SHOW .
2385  * \li Origin: leeming, 25 Feb 2003
2386  * \endvar
2387  */
2388                 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
2389 /*!
2390  * \var lyx::FuncCode lyx::LFUN_DIALOG_TOGGLE
2391  * \li Action: Toggles dialog between showed/hidden state.
2392  * \li Notion: Internally uses #LFUN_DIALOG_SHOW , #LFUN_DIALOG_HIDE .
2393  * \li Syntax: dialog-toggle <NAME> [<DATA>]
2394  * \li Params: See #LFUN_DIALOG_SHOW .
2395  * \li Origin: JSpitzm, 30 Apr 2007
2396  * \endvar
2397  */
2398                 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
2399 /*!
2400  * \var lyx::FuncCode lyx::LFUN_DIALOG_DISCONNECT_INSET
2401  * \li Action: Closes opened connection to opened inset.
2402  * \li Notion: Connection is used for apply functions.
2403  * \li Syntax: dialog-disconnect-inset <INSET-NAME>
2404  * \li Origin: leeming, 25 Feb 2003
2405  * \endvar
2406  */
2407                 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
2408
2409 /*!
2410  * \var lyx::FuncCode lyx::LFUN_MOUSE_PRESS
2411  * \li Action: This function is called when mouse button is pressed (inside workarea).
2412                Action depends on the context.
2413  * \li Notion: This is internal LFUN, not to be used by users.
2414  * \li Origin: Andre, 9 Aug 2002
2415  * \endvar
2416  */
2417                 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
2418 /*!
2419  * \var lyx::FuncCode lyx::LFUN_MOUSE_DOUBLE
2420  * \li Action: This function is called when double click on mouse button is
2421                pressed (inside workarea). Action depends on the context.
2422  * \li Notion: This is internal LFUN, not to be used by users.
2423  * \li Origin: Andre, 9 Aug 2002
2424  * \endvar
2425  */
2426                 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
2427 /*!
2428  * \var lyx::FuncCode lyx::LFUN_MOUSE_TRIPLE
2429  * \li Action: This function is called when triple click on mouse button is
2430                pressed (inside workarea). Action depends on the context.
2431  * \li Notion: This is internal LFUN, not to be used by users.
2432  * \li Origin: Andre, 9 Aug 2002
2433  * \endvar
2434  */
2435                 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
2436 /*!
2437  * \var lyx::FuncCode lyx::LFUN_MOUSE_MOTION
2438  * \li Action: This function is called when mouse cursor is moving over the text.
2439                Action depends on the context.
2440  * \li Notion: This is internal LFUN, not to be used by users.
2441  * \li Origin: Andre, 9 Aug 2002
2442  * \endvar
2443  */
2444                 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
2445 /*!
2446  * \var lyx::FuncCode lyx::LFUN_MOUSE_RELEASE
2447  * \li Action: This function is called when mouse button is released (inside workarea).
2448                Action depends on the context.
2449  * \li Notion: This is internal LFUN, not to be used by users.
2450  * \li Origin: Andre, 9 Aug 2002
2451  * \endvar
2452  */
2453                 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
2454
2455 /*!
2456  * \var lyx::FuncCode lyx::LFUN_KEYMAP_OFF
2457  * \li Action: Turn off the loaded keyboard map.
2458  * \li Syntax: keymap-off
2459  * \endvar
2460  */
2461                 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
2462 /*!
2463  * \var lyx::FuncCode lyx::LFUN_KEYMAP_PRIMARY
2464  * \li Action: Turn on the primary keyboard map.
2465  * \li Notion: Maps were widely used in past, when X-windows didn't have nowadays
2466                keyboard support. They can be still used to maintain uniform keyboard
2467                layout across the various plaforms.\n
2468                The language is to be set in the Preferences dialog.
2469  * \li Syntax: keymap-primary
2470  * \endvar
2471  */
2472                 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
2473 /*!
2474  * \var lyx::FuncCode lyx::LFUN_KEYMAP_SECONDARY
2475  * \li Action: Turn on the secondary keyboard map.
2476  * \li Syntax: keymap-secondary
2477  * \endvar
2478  */
2479                 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
2480 /*!
2481  * \var lyx::FuncCode lyx::LFUN_KEYMAP_TOGGLE
2482  * \li Action: Toggles keyboard maps (first/second/off).
2483  * \li Syntax: keymap-toggle
2484  * \li Origin: leeming, 30 Mar 2004
2485  * \endvar
2486  */
2487                 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
2488
2489 /*!
2490  * \var lyx::FuncCode lyx::LFUN_SERVER_GET_LAYOUT
2491  * \li Action: Returns the current layout (that is environment) name
2492                on the cursor position.
2493  * \li Syntax: server-get-layout
2494  * \endvar
2495  */
2496                 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
2497 /*!
2498  * \var lyx::FuncCode lyx::LFUN_SERVER_GET_FILENAME
2499  * \li Action: Returns path and file name of the currently edited document.
2500  * \li Syntax: server-get-filename
2501  * \endvar
2502  */
2503                 { LFUN_SERVER_GET_FILENAME, "server-get-filename", ReadOnly, System },
2504 /*!
2505  * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
2506  * \li Action: Sets the cursor position based on the row number of generated TeX file.
2507  * \li Syntax: server-goto-file-row <LYX_FILE_NAME> <ROW_NUMBER>
2508  * \li Origin: Edmar, 23 Dec 1998
2509  * \endvar
2510  */
2511                 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly, System },
2512 /*!
2513  * \var lyx::FuncCode lyx::LFUN_SERVER_NOTIFY
2514  * \li Action: Sends notify message about the last key-sequence to client.
2515  * \li Notion: This can be used to grab last key-sequence used inside the LyX window.
2516  * \li Syntax: server-notify
2517  * \endvar
2518  */
2519                 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
2520 /*!
2521  * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
2522  * \li Action: Sets the cursor position based on the editing area coordinates
2523                (similar as clicking on that point with left mouse button).
2524  * \li Syntax: server-set-xy <X> <Y>
2525  * \endvar
2526  */
2527                 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
2528 /*!
2529  * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
2530  * \li Action: Returns the coordinates of cursor position in the editing area.
2531  * \li Syntax: server-get-xy
2532  * \endvar
2533  */
2534                 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
2535
2536 /*!
2537  * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
2538  * \li Action: Generates the code (literate programming).
2539  * \li Notion: Latex file with extension \literate_extension is generated.
2540                Then LyX invokes \build_command (with a default of``make'') to generate the code and
2541                \build_error_filter to process the compilation error messages. \n
2542                In case you want to process your literate file with a script, or some other program,
2543                just insert in your lyxrc file an entry with:\n
2544                \build_command "my_script my_arguments" \n
2545                The \build_error_filter differs from the \literate_error_filter only in that the
2546                former will identify error messages from your compiler.
2547  * \li Syntax: build-program
2548  * \endvar
2549  */
2550                 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
2551
2552 /*!
2553  * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
2554  * \li Action: Saves the current buffer to a temporary file.
2555  * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
2556                is called automatically by LyX, to "autosave" the current buffer.
2557  * \li Syntax: buffer-auto-save
2558  * \endvar
2559  */
2560                 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
2561 /*!
2562  * \var lyx::FuncCode lyx::LFUN_BUFFER_CHILD_OPEN
2563  * \li Action: Loads the given child document.
2564  * \li Notion: The current document is treated as a parent.
2565  * \li Syntax: buffer-child-open <FILE>
2566  * \li Params: <FILE>: Filename of the child. The directory of the parent is assumed by default.
2567  * \li Origin: Ale, 28 May 1997
2568  * \endvar
2569  */
2570                 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
2571 /*!
2572  * \var lyx::FuncCode lyx::LFUN_BUFFER_CHKTEX
2573  * \li Action: Runs chktex for the current document.
2574  * \li Syntax: buffer-chktex
2575  * \li Origin: Asger, 30 Oct 1997
2576  * \endvar
2577  */
2578                 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
2579 /*!
2580  * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
2581  * \li Action: Toggles compression of the current document on/off.
2582  * \li Syntax: buffer-toggle-compression
2583  * \li Origin: bpeng, 27 Apr 2006
2584  * \endvar
2585  */
2586                 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
2587 /*!
2588  * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
2589  * \li Action: Closes the current buffer.
2590  * \li Notion: Closes the current buffer, asking whether to save it, etc,
2591                if the buffer has been modified.
2592  * \li Syntax: buffer-close
2593  * \endvar
2594  */
2595                 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
2596 /*!
2597  * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
2598  * \li Action: Exports the current buffer (document) to the given format.
2599  * \li Syntax: buffer-export <FORMAT>
2600  * \li Params: <FORMAT> is either "custom" or one of the formats which you
2601                         can find in Tools->Preferences->File formats->Format.
2602                         Usual format you will enter is "pdf2" (pdflatex),
2603                         "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
2604                         In case of "custom" you will be asked for a format you
2605                         want to start from and for the command that you want to
2606                         apply to this format. Internally the control is then passed
2607                         to #LFUN_BUFFER_EXPORT_CUSTOM.
2608  * \li Origin: Lgb, 29 Jul 1997
2609  * \endvar
2610  */
2611                 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
2612 /*!
2613  * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
2614  * \li Action: Exports the current buffer (document) from the given format using
2615                the given command on it.
2616  * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
2617  * \li Params: <FORMAT> format to start from (LyX will care to produce such
2618                         intermediate file).\n
2619                <COMMAND> this command will be launched on the file. Note that you can
2620                use "$$FName" string to qualify the intermediate file.
2621  * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
2622  * \li Origin: leeming, 27 Mar 2004
2623  * \endvar
2624  */
2625                 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
2626 /*!
2627  * \var lyx::FuncCode lyx::LFUN_BUFFER_PRINT
2628  * \li Action: Prints the current document.
2629  * \li Notion: Many settings can be given via the preferences dialog.
2630  * \li Syntax: buffer-print <TARGET> <TARGET-NAME> <COMMAND>
2631  * \li Params: <TARGET> is either "printer" or "file".\n
2632                <TARGER-NAME> is either "default" or file name or printer name.\n
2633                <COMMAND> command ensuring the printing job.
2634  * \li Sample: buffer-print file "/trash/newfile1.ps" "dvips"
2635  * \li Origin: leeming, 28 Mar 2004
2636  * \endvar
2637  */
2638                 { LFUN_BUFFER_PRINT, "buffer-print", ReadOnly, Buffer },
2639 /*!
2640  * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
2641  * \li Action: Import a given file as a lyx document.
2642  * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
2643                defined convertors in preferences. Look into File->Import menu to get
2644                an idea of the currently active import formats.
2645  * \li Syntax: buffer-import <FORMAT> [<FILE>]
2646  * \li Origin: Asger, 24 Jul 1998
2647  * \endvar
2648  */
2649                 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
2650 /*!
2651  * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
2652  * \li Action: Creates a new buffer (that is, document).
2653  * \li Notion: Implicit path can be set in Preferences dialog.
2654  * \li Syntax: buffer-new [<FILE>]
2655  * \li Params: <FILE>: filename of created file with absolute path.
2656  * \endvar
2657  */
2658                 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
2659 /*!
2660  * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
2661  * \li Action: Creates a new buffer (that is, document) from a template.
2662  * \li Notion: Path for new files and templates can be set in Preferences dialog.
2663                Template will be asked for via Open-dialog.
2664  * \li Syntax: buffer-new-template [<FILE>]
2665  * \li Params: <FILE>: filename of created file with absolute path.
2666  * \endvar
2667  */
2668                 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
2669 /*!
2670  * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
2671  * \li Action: Reverts opened document.
2672  * \li Syntax: buffer-reload
2673  * \li Origin: Asger, 2 Feb 1997
2674  * \endvar
2675  */
2676                 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
2677 /*!
2678  * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
2679  * \li Action: Switch to the given buffer.
2680  * \li Notion: This is useful also in case you need simultaneously more views of the edited
2681                document in different LyX windows.
2682  * \li Syntax: buffer-new-template <BUFFER>
2683  * \li Params: <BUFFER>: already opened document which is to be shown.
2684  * \endvar
2685  */
2686                 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
2687 /*!
2688  * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
2689  * \li Action: Toggle editing mode of the current document between read/write and read-only.
2690  * \li Notion: In the ->Readonly mode checks-in/commits the data if the file is under version control.
2691                In the Readonly-> mode checkouts the data from repository. \n
2692                If these operations fail, buffer won't be toggled.
2693  * \li Syntax: buffer-toggle-read-only
2694  * \li Origin: Lgb, 27 May 1997
2695  * \endvar
2696  */
2697                 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
2698 /*!
2699  * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
2700  * \li Action: Displays current buffer in chosen format.
2701  * \li Notion: Displays the contents of the current buffer in the chosen
2702                format, for example, PDF or DVI. This runs the necessary
2703                converter, calls the defined viewer, and so forth.
2704  * \li Syntax: buffer-view <FORMAT>
2705  * \li Params: <FORMAT>: The format to display, where this is one of the
2706                          formats defined (in the current GUI) in the
2707                          Tools>Preferences>File Formats dialog.
2708  * \endvar
2709  */
2710                 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
2711 /*!
2712  * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
2713  * \li Action: Exports the current document and put the result into the
2714                temporary directory.
2715  * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
2716                the output will be rewriten - updated. This is useful in case your viewer
2717                is able to detect such changes (e.g. ghostview for postscript).
2718  * \li Syntax: buffer-update <FORMAT>
2719  * \li Params: <FORMAT>: The format to display, where this is one of the
2720                          formats defined (in the current GUI) in the
2721                          Tools>Preferences>File Formats dialog.
2722  * \li Origin: Dekel, 5 Aug 2000
2723  * \endvar
2724  */
2725                 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
2726
2727 /*!
2728  * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
2729  * \li Action: Saves the current buffer.
2730  * \li Notion: Saves the current buffer to disk, using the filename that
2731                is already associated with the buffer, asking for one if
2732                none is yet assigned.
2733  * \li Syntax: buffer-write
2734  * \endvar
2735  */
2736                 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
2737 /*!
2738  * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
2739  * \li Action: Rename and save current buffer.
2740  * \li Syntax: buffer-write-as <FILENAME>
2741  * \li Params: <FILENAME>: New name of the buffer/file. A relative path
2742                is with respect to the original location of the buffer/file.
2743  * \endvar
2744  */
2745                 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
2746 /*!
2747  * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
2748  * \li Action: Save all changed documents.
2749  * \li Syntax: buffer-write-all
2750  * \li Origin: rgh, gpothier 6 Aug 2007
2751  * \endvar
2752  */
2753                 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
2754 /*!
2755  * \var lyx::FuncCode lyx::LFUN_BUFFER_NEXT
2756  * \li Action: Switch to the next opened document.
2757  * \li Notion: Note that this does not necessarily mean next in tabbar
2758                (for full list see View menu).
2759  * \li Syntax: buffer-next
2760  * \endvar
2761  */
2762                 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
2763 /*!
2764  * \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS
2765  * \li Action: Switch to the previous opened document.
2766  * \li Syntax: buffer-previous
2767  * \endvar
2768  */
2769                 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
2770 /*!
2771  * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
2772  * \li Action: When run from a child document, this updates (exports) document built
2773                 from the master buffer. If a master is not found, it updates the
2774                 current buffer.
2775  * \li Syntax: master-buffer-update
2776  * \li Origin: Tommaso, 20 Sep 2007
2777  * \endvar
2778  */
2779                 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
2780 /*!
2781  * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
2782  * \li Action: When run from a child document, this command shows a preview built
2783                from the master buffer. If a master is not found, it previews the
2784                current buffer.
2785  * \li Syntax: master-buffer-view
2786  * \li Origin: Tommaso, 20 Sep 2007
2787  * \endvar
2788  */
2789                 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
2790 /*!
2791  * \var lyx::FuncCode lyx::LFUN_BUFFER_LANGUAGE
2792  * \li Action: Set language of the current document.
2793  * \li Syntax: buffer-language <LANG>
2794  * \li Params: <LANG>: language name. See lib/languages for list.
2795  * \li Origin: leeming, 30 Mar 2004
2796  * \endvar
2797  */
2798                 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
2799 /*!
2800  * \var lyx::FuncCode lyx::LFUN_BUFFER_SAVE_AS_DEFAULT
2801  * \li Action: Save the current document settings as default.
2802  * \li Notion: The file will will be saved into ~/.lyx/templates/defaults.lyx .
2803  * \li Syntax: buffer-save-as-default [<ARGS>]
2804  * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
2805                        you can find in document header of usual .lyx file.
2806  * \li Origin: leeming, 30 Mar 2004
2807  * \endvar
2808  */
2809                 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
2810 /*!
2811  * \var lyx::FuncCode lyx::LFUN_BUFFER_PARAMS_APPLY
2812  * \li Action: Apply the given settings to the current document.
2813  * \li Syntax: buffer-params-apply [<ARGS>]
2814  * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
2815                        you can find in document header of usual .lyx file.
2816  * \li Origin: leeming, 30 Mar 2004
2817  * \endvar
2818  */
2819                 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", Noop, Buffer },
2820
2821 /*!
2822  * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
2823  * \li Action: Inserts another LyX file.
2824  * \li Syntax: file-insert [<FILE>]
2825  * \li Params: <FILE>: Filename to be inserted.
2826  * \endvar
2827  */
2828                 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
2829 /*!
2830  * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
2831  * \li Action: Inserts plain text file.
2832  * \li Syntax: file-insert-plaintext [<FILE>]
2833  * \li Params: <FILE>: Filename to be inserted.
2834  * \li Origin: CFO-G, 19 Nov 1997
2835  * \endvar
2836  */
2837                 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
2838 /*!
2839  * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
2840  * \li Action: Inserts plain text file as paragraph (i.e. join lines).
2841  * \li Syntax: file-insert-plaintext-para [<FILE>]
2842  * \li Params: <FILE>: Filename to be inserted.
2843  * \li Origin: Levon, 14 Feb 2001
2844  * \endvar
2845  */
2846                 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
2847 /*!
2848  * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
2849  * \li Action: Open LyX document.
2850  * \li Syntax: file-open [<FILE>]
2851  * \li Params: <FILE>: Filename to be opened.
2852  * \endvar
2853  */
2854                 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
2855
2856 /*!
2857  * \var lyx::FuncCode lyx::LFUN_CALL
2858  * \li Action: Executes a command defined in a .def file.
2859  * \li Notion: The definitions are by default read from lib/commands/default.def.\n
2860                A .def file allows to define a command with \\define "<NAME>" "<LFUN>"
2861                where <NAME> is the name of the new command and <LFUN> is the lfun code
2862                to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
2863                \\def_file "FileName" allows to include another .def file. \n
2864                This is particularly useful in connection with toolbar buttons:
2865                Since the name of the button image for this lfun is 
2866                lib/images/commands/<NAME>.png this is the way to assign an image
2867                to a complex command-sequence.
2868  * \li Syntax: call <NAME>
2869  * \li Params: <NAME>: Name of the command that must be called.
2870  * \li Origin: broider, 2 Oct 2007
2871  * \endvar
2872  */
2873                 { LFUN_CALL, "call", NoBuffer, System },
2874 /*!
2875  * \var lyx::FuncCode lyx::LFUN_META_PREFIX
2876  * \li Action: Simulate halting Meta key (Alt key on PCs).
2877  * \li Notion: Used for buffer editation not for GUI control.
2878  * \li Syntax: meta-prefix
2879  * \endvar
2880  */
2881                 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
2882 /*!
2883  * \var lyx::FuncCode lyx::LFUN_CANCEL
2884  * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
2885  * \li Syntax: cancel
2886  * \endvar
2887  */
2888                 { LFUN_CANCEL, "cancel", NoBuffer, System },
2889
2890 /*!
2891  * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
2892  * \li Action: Opens the minibuffer toolbar so that the user can type in there.
2893  * \li Notion: Usually bound to M-x shortcut.
2894  * \li Syntax: command-execute
2895  * \endvar
2896  */
2897                 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
2898 /*!
2899  * \var lyx::FuncCode lyx::LFUN_COMMAND_PREFIX
2900  * \li Action: Return the current key sequence and available options as a string.
2901  * \li Notion: No options are added if no current map exists. \n
2902                This is probably usable only with connection to lyxserver.
2903  * \li Syntax: command-prefix
2904  * \endvar
2905  */
2906                 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
2907 /*!
2908  * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
2909  * \li Action: Run more commands (LFUN and its parameters) in a sequence.
2910  * \li Syntax: command-sequence <CMDS>
2911  * \li Params: <CMDS>: Sequence of commands separated by semicolons.
2912  * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
2913  * \li Origin: Andre, 11 Nov 1999
2914  * \endvar
2915  */
2916                 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
2917 /*!
2918  * \var lyx::FuncCode lyx::LFUN_MESSAGE
2919  * \li Action: Shows message in statusbar (for script purposes).
2920  * \li Syntax: message <STRING>
2921  * \li Origin: Lgb, 8 Apr 2001
2922  * \endvar
2923  */
2924                 { LFUN_MESSAGE, "message", NoBuffer, System },
2925 /*!
2926  * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
2927  * \li Action: Save user preferences.
2928  * \li Syntax: preferences-save
2929  * \li Origin: Lgb, 27 Nov 1999
2930  * \endvar
2931  */
2932                 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
2933 /*!
2934  * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
2935  * \li Action: Reconfigure the automatic settings.
2936  * \li Syntax: reconfigure
2937  * \li Origin: Asger, 14 Feb 1997
2938  * \endvar
2939  */
2940                 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
2941 /*!
2942  * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
2943  * \li Action: Apply the given settings to user preferences.
2944  * \li Syntax: lyxrc-apply <SETTINGS>
2945  * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
2946                            to get an idea which commands to use and their syntax.
2947                            #lyx::LyXRC::LyXRCTags has the list of possible commands.
2948  * \endvar
2949  */
2950                 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
2951 /*!
2952  * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
2953  * \li Action: Determine whether keep cursor inside the editing window regardless
2954                the scrollbar movement.
2955  * \li Syntax: toggle-cursor-follows-scrollbar
2956  * \li Origin: ARRae, 2 Dec 1997
2957  * \endvar
2958  */
2959                 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
2960 /*!
2961  * \var lyx::FuncCode lyx::LFUN_SET_COLOR
2962  * \li Action: Set the given LyX color to the color defined by the X11 name given.
2963  * \li Notion: A new color entry is created if the color is unknown.
2964                Color names can be stored as a part of user settings.
2965  * \li Syntax: set-color <LYX_NAME> <X11_NAME>
2966  * \li Origin: SLior, 11 Jun 2000
2967  * \endvar
2968  */
2969                 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
2970 /*!
2971  * \var lyx::FuncCode lyx::LFUN_STATISTICS
2972  * \li Action: Count the statistics (number of words and characters)
2973                in the document or in the given selection.
2974  * \li Notion: Note that this function gives the number of words/chars written,
2975                not the number of characters which will be typeset.
2976  * \li Syntax: statistics
2977  * \li Origin: lasgouttes, Jan 27 2004; sanda, Jan 8 2008
2978  * \endvar
2979  */
2980                 { LFUN_STATISTICS, "statistics", ReadOnly, System },
2981 /*!
2982  * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
2983  * \li Action: Show the inline completion at the cursor position.
2984  * \li Syntax: completion-inline
2985  * \li Origin: sts, Feb 19 2008
2986  * \endvar
2987  */
2988                 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
2989 /*!
2990  * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
2991  * \li Action: Show the completion popup at the cursor position.
2992  * \li Syntax: completion-popup
2993  * \li Origin: sts, Feb 19 2008
2994  * \endvar
2995  */
2996                 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
2997 /*!
2998  * \var lyx::FuncCode lyx::LFUN_COMPLETION_COMPLETE
2999  * \li Action: Try to complete the word or command at the cursor position.
3000  * \li Syntax: complete
3001  * \li Origin: sts, Feb 19 2008
3002  * \endvar
3003  */
3004                 { LFUN_COMPLETION_COMPLETE, "complete", SingleParUpdate, Edit },
3005
3006 /*!
3007  * \var lyx::FuncCode lyx::LFUN_COMPLETION_CANCEL
3008  * \li Action: Try to cancel completion, either the popup or the inline completion
3009  * \li Syntax: completion-cancel
3010  * \li Origin: sts, Sep 07 2008
3011  * \endvar
3012  */
3013                 { LFUN_COMPLETION_CANCEL, "completion-cancel", SingleParUpdate, Edit },
3014 /*!
3015  * \var lyx::FuncCode lyx::LFUN_COMPLETION_ACCEPT
3016  * \li Action: Accept suggested completion.
3017  * \li Syntax: completion-accept
3018  * \li Origin: sanda, Sep 08 2008
3019  * \endvar
3020  */
3021                 { LFUN_COMPLETION_ACCEPT, "completion-accept", SingleParUpdate, Edit },
3022
3023
3024 /*!
3025  * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
3026  * \li Action: Activate the branch
3027  * \li Syntax: branch-activate <BRANCH>
3028  * \li Params: <BRANCH>: The branch to activate
3029  * \li Sample: lyx -e pdf2 -x "branch-activate answers" finalexam.lyx \n
3030                could be used to export a pdf with the answers branch included
3031                without one's having to open LyX and activate the branch manually.
3032  * \li Origin: rgh, 27 May 2008
3033  * \endvar
3034  */
3035                 { LFUN_BRANCH_ACTIVATE, "branch-activate", Argument, Buffer },
3036 /*!
3037  * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
3038  * \li Action: De-activate the branch
3039  * \li Syntax: branch-deactivate <BRANCH>
3040  * \li Params: <BRANCH>: The branch to deactivate
3041  * \li Origin: rgh, 27 May 2008
3042  * \endvar
3043  */
3044                 { LFUN_BRANCH_DEACTIVATE, "branch-deactivate", Argument, Buffer },
3045
3046                 { LFUN_NOACTION, "", Noop, Hidden }
3047 #ifndef DOXYGEN_SHOULD_SKIP_THIS
3048         };
3049
3050         for (int i = 0; items[i].action != LFUN_NOACTION; ++i) {
3051                 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
3052         }
3053
3054         init = true;
3055 }
3056 #endif
3057
3058 LyXAction::LyXAction()
3059 {
3060         init();
3061 }
3062
3063
3064 // Returns an action tag from a string.
3065 FuncRequest LyXAction::lookupFunc(string const & func) const
3066 {
3067         string const func2 = trim(func);
3068
3069         if (func2.empty()) {
3070                 return FuncRequest(LFUN_NOACTION);
3071         }
3072
3073         string cmd;
3074         string const arg = split(func2, cmd, ' ');
3075
3076         func_map::const_iterator fit = lyx_func_map.find(cmd);
3077
3078         return fit != lyx_func_map.end() ? FuncRequest(fit->second, arg) : FuncRequest(LFUN_UNKNOWN_ACTION);
3079 }
3080
3081
3082 string const LyXAction::getActionName(FuncCode action) const
3083 {
3084         info_map::const_iterator const it = lyx_info_map.find(action);
3085         return it != lyx_info_map.end() ? it->second.name : string();
3086 }
3087
3088
3089 LyXAction::func_type const LyXAction::getActionType(FuncCode action) const
3090 {
3091         info_map::const_iterator const it = lyx_info_map.find(action);
3092         return it != lyx_info_map.end() ? it->second.type : Hidden;
3093 }
3094
3095
3096 bool LyXAction::funcHasFlag(FuncCode action,
3097                             LyXAction::func_attrib flag) const
3098 {
3099         info_map::const_iterator ici = lyx_info_map.find(action);
3100
3101         if (ici == lyx_info_map.end()) {
3102                 LYXERR0("action: " << action << " is not known.");
3103                 LASSERT(false, /**/);
3104         }
3105
3106         return ici->second.attrib & flag;
3107 }
3108
3109
3110 LyXAction::const_func_iterator LyXAction::func_begin() const
3111 {
3112         return lyx_func_map.begin();
3113 }
3114
3115
3116 LyXAction::const_func_iterator LyXAction::func_end() const
3117 {
3118         return lyx_func_map.end();
3119 }
3120
3121
3122 } // namespace lyx