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