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