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