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