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