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