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