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