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