]> git.lyx.org Git - lyx.git/blob - src/LyXAction.cpp
* Doxy.
[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                 { LFUN_FLOAT_INSERT, "float-insert", Noop, Edit },
273                 { LFUN_FLOAT_WIDE_INSERT, "float-wide-insert", Noop, Edit },
274                 { LFUN_WRAP_INSERT, "wrap-insert", Noop, Edit },
275 /*!
276  * \var lyx::FuncCode lyx::LFUN_OPTIONAL_INSERT
277  * \li Action: Inserts an optional-argument (short title) inset.
278  * \li Syntax: optional-insert
279  * \li Origin: Martin, 12 Aug 2002
280  * \endvar
281  */
282                 { LFUN_OPTIONAL_INSERT, "optional-insert", Noop, Edit },
283 /*!
284  * \var lyx::FuncCode lyx::LFUN_LINE_INSERT
285  * \li Action: Inserts a horizontal line.
286  * \li Syntax: line-insert
287  * \li Origin: poenitz,  Oct 27 2003
288  * \endvar
289  */
290                 { LFUN_LINE_INSERT, "line-insert", Noop, Edit },
291 /*!
292  * \var lyx::FuncCode lyx::LFUN_NEWPAGE_INSERT
293  * \li Action: Inserts a new page.
294  * \li Syntax: newpage-insert<ARG>
295  * \li Params: <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
296  * \li Origin: uwestoehr, 24 Nov 2007
297  * \endvar
298  */
299                 { LFUN_NEWPAGE_INSERT, "newpage-insert", Noop, Edit },
300 /*!
301  * \var lyx::FuncCode lyx::LFUN_MARGINALNOTE_INSERT
302  * \li Action: Inserts a marginal note.
303  * \li Syntax: marginalnote-insert
304  * \li Origin: Lgb, 26 Jun 2000
305  * \endvar
306  */
307                 { LFUN_MARGINALNOTE_INSERT, "marginalnote-insert", Noop, Edit },
308 /*!
309  * \var lyx::FuncCode lyx::LFUN_UNICODE_INSERT
310  * \li Action: Inserts a single unicode character.
311  * \li Syntax: unicode-insert <CHAR>
312  * \li Params: <CHAR>: The character to insert, given as its code
313                        point, in hexadecimal, e.g.: unicode-insert 0x0100.
314  * \li Origin: Lgb, 22 Oct 2006
315  * \endvar
316  */
317                 { LFUN_UNICODE_INSERT, "unicode-insert", Noop, Edit },
318 /*!
319  * \var lyx::FuncCode lyx::LFUN_LISTING_INSERT
320  * \li Action: Inserts a new listings inset.
321  * \li Syntax: listing-insert
322  * \li Origin: Herbert, 10 Nov 2001; bpeng, 2 May 2007
323  * \endvar
324  */
325                 { LFUN_LISTING_INSERT, "listing-insert", Noop, Edit },
326 /*!
327  * \var lyx::FuncCode lyx::LFUN_QUOTE_INSERT
328  * \li Action: Inserts quotes according to the type and quote-language preference.
329  * \li Action: Currently  English, Swedish, German, Polish, French, Danish quotes
330                are distinguished.
331  * \li Syntax: quote-insert [<TYPE>]
332  * \li Params: TYPE: 'single' for single quotes, otherwise double quotes will be used.
333  * \endvar
334  */
335                 { LFUN_QUOTE_INSERT, "quote-insert", Noop, Edit },
336 /*!
337  * \var lyx::FuncCode lyx::LFUN_INFO_INSERT
338  * \li Action: Displays shortcuts, lyxrc, package and textclass availability and menu
339                information in a non-editable boxed InsetText.
340  * \li Notion: Apart from lfun arguments you can use the following method: \n
341                1. input the type and argument of this inset, e.g. "menu paste", in
342                the work area.\n
343                2. select the text and run info-insert lfun.\n
344  * \li Syntax: info-insert <TYPE> <ARG>
345  * \li Params: <TYPE>: shortcut|lyxrc|package|textclass|menu|buffer \n
346                <ARG>: argument for a given type. Look into InsetInfo.h for detailed
347                       description.
348  * \li Origin: bpeng, 7 Oct 2007
349  * \endvar
350  */
351                 { LFUN_INFO_INSERT, "info-insert", Noop, Edit },
352 /*!
353  * \var lyx::FuncCode lyx::LFUN_BRANCH_INSERT
354  * \li Action: Inserts branch inset.
355  * \li Syntax: branch-insert <BRANCH-NAME>
356  * \li Origin: vermeer, 17 Aug 2003
357  * \endvar
358  */
359                 { LFUN_BRANCH_INSERT, "branch-insert", Noop, Edit },
360 /*!
361  * \var lyx::FuncCode lyx::LFUN_BOX_INSERT
362  * \li Action: Inserts Box inset.
363  * \li Syntax: box-insert [<TYPE>]
364  * \li Params: <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox \n
365                        Framed is the default one.
366  * \li Origin: vermeer, 7 Oct 2003
367  * \endvar
368  */
369                 { LFUN_BOX_INSERT, "box-insert", Noop, Edit },
370 /*!
371  * \var lyx::FuncCode lyx::LFUN_FLEX_INSERT
372  * \li Action: Inserts CharStyle, Custom inset or XML short element.
373  * \li Notion: Look into the Customization manual for more information about
374                these elements.\n
375                For dissolving the element see #LFUN_INSET_DISSOLVE.
376  * \li Syntax: flex-insert <TYPE:Name>
377  * \li Params: TYPE: CharStyle|Custom|Element|Standard
378                      Identifies whether this is a Character Style, a
379                      Custom Inset or an XML Element, and which dynamical 
380                      sub-menu this flex inset is in on the LyX menu tree. 
381                      If Standard (currently unused): none of these.
382                Name: This name must be defined either in your layout file
383                      or imported by some module. The definition is\n
384                      InsetLayout <TYPE:Name>
385  * \li Sample: flex-insert CharStyle:Code
386  * \endvar
387  */
388                 { LFUN_FLEX_INSERT, "flex-insert", Noop, Edit },
389 /*!
390  * \var lyx::FuncCode lyx::LFUN_SELF_INSERT
391  * \li Action: Inserts the given string (accordingly to the correct keymap).
392  * \li Syntax: self-insert <STRING>
393  * \endvar
394  */
395                 { LFUN_SELF_INSERT, "self-insert", SingleParUpdate, Hidden },
396 /*!
397  * \var lyx::FuncCode lyx::LFUN_SPACE_INSERT
398  * \li Action: Inserts one of horizontal space insets.
399  * \li Syntax: space-insert <NAME> [<LEN>]
400  * \li Params: <NAME>: normal, protected, thin, quad, qquad, enspace, enskip,
401                        negthinspace, hfill, hfill*, dotfill, hrulefill, hspace,
402                        hspace* \n
403                <LEN>: length for custom spaces (hspace, hspace* for protected)
404  * \li Origin: JSpitzm, 20 May 2003, Mar 17 2008
405  * \endvar
406  */
407                 { LFUN_SPACE_INSERT, "space-insert", Noop, Edit },
408 /*!
409  * \var lyx::FuncCode lyx::LFUN_HYPERLINK_INSERT
410  * \li Action: Inserts hyperlinks into the document (clickable in pdf output).
411  * \li Notion: Hyperlink target can be set via selection + hyperlink-insert function.
412  * \li Syntax: href-insert [<TARGET>]
413  * \li Origin: CFO-G, 21 Nov 1997
414  * \endvar
415  */
416                 { LFUN_HYPERLINK_INSERT, "href-insert", Noop, Edit },
417 /*!
418  * \var lyx::FuncCode lyx::LFUN_SPECIALCHAR_INSERT
419  * \li Action: Inserts various characters into the document.
420  * \li Syntax: specialchar-insert <CHAR>
421  * \li Params: <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots,
422                        end-of-sentence, menu-separator.
423  * \li Origin: JSpitzm, 6 Dec 2007
424  * \endvar
425  */
426                 { LFUN_SPECIALCHAR_INSERT, "specialchar-insert", Noop, Edit },
427 /*!
428  * \var lyx::FuncCode lyx::LFUN_TOC_INSERT
429  * \li Action: Inserts table of contents.
430  * \li Syntax: toc-insert
431  * \li Origin: Lgb, 27 May 97
432  * \endvar
433  */
434                 { LFUN_TOC_INSERT, "toc-insert", Noop, Edit },
435 /*!
436  * \var lyx::FuncCode lyx::LFUN_APPENDIX
437  * \li Action: Start (or remove) Appendix on the given cursor position.
438  * \li Syntax: appendix
439  * \li Origin: ettrich, 5 May 1998
440  * \endvar
441  */
442                 { LFUN_APPENDIX, "appendix", Noop, Edit },
443
444                 { LFUN_INDEX_INSERT, "index-insert", Noop, Edit },
445                 { LFUN_INDEX_PRINT, "index-print", Noop, Edit },
446
447                 { LFUN_NOMENCL_INSERT, "nomencl-insert", Noop, Edit },
448                 { LFUN_NOMENCL_PRINT, "nomencl-print", Noop, Edit },
449
450                 { LFUN_NOTE_INSERT, "note-insert", Noop, Edit },
451                 { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
452 /*!
453  * \var lyx::FuncCode lyx::LFUN_NEWLINE_INSERT
454  * \li Action: Inserts a line break or new line.
455  * \li Syntax: newline-insert <ARG>
456  * \li Params: <ARG>: <newline|linebreak> default: newline
457  * \li Origin: JSpitzm, 25 Mar 2008
458  * \endvar
459  */
460                 { LFUN_NEWLINE_INSERT, "newline-insert", Noop, Edit },
461
462
463 #if 0
464                 { LFUN_LIST_INSERT, "list-insert", Noop, Edit },
465 #endif
466
467 /*!
468  * \var lyx::FuncCode lyx::LFUN_ESCAPE
469  * \li Action: Clears the selection. If no text is selected call #LFUN_FINISHED_FORWARD.
470  * \li Syntax: escape
471  * \li Origin: Lgb, 17 May 2001
472  * \endvar
473  */
474                 { LFUN_ESCAPE, "escape", ReadOnly, Edit },
475                 { LFUN_DELETE_BACKWARD_SKIP, "delete-backward-skip", Noop, Edit },
476                 { LFUN_DELETE_FORWARD_SKIP, "delete-forward-skip", Noop, Edit },
477                 { LFUN_DOWN, "down", ReadOnly | NoUpdate, Edit },
478                 { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, Edit },
479                 { LFUN_UP, "up", ReadOnly | NoUpdate, Edit },
480                 { LFUN_UP_SELECT, "up-select", ReadOnly | SingleParUpdate, Edit },
481                 { LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit },
482                 { LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit },
483 /*!
484  * \var lyx::FuncCode lyx::LFUN_SCROLL
485  * \li Action: Scroll the buffer view.
486  * \li Notion: Only scrolls the screen up or down; does not move the cursor.
487  * \li Syntax: scroll <TYPE> <QUANTITY>
488  * \li Params: <TYPE>:  line|page\n
489                <QUANTITY>: up|down|<number>
490  * \li Origin: Abdelrazak Younes, Dec 27 2007
491  * \endvar
492  */
493                 { LFUN_SCROLL, "scroll", ReadOnly, Edit },
494 /*!
495  * \var lyx::FuncCode lyx::LFUN_SCREEN_RECENTER
496  * \li Action: Recenters the screen on the current cursor position.
497  * \li Syntax: screen-recenter
498  * \endvar
499  */
500                 { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit },
501                 { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit },
502                 { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit },
503
504                 { LFUN_ERROR_NEXT, "error-next", ReadOnly, Edit },
505 /*!
506  * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD
507  * \li Action: Moves the cursor one position logically backwards.
508  * \li Notion: This is not the action which should be bound to the arrow keys,
509                because backwards may be left or right, depending on the
510                language. The arrow keys should be bound to #LFUN_CHAR_LEFT or
511                #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
512  * \li Syntax: char-backward
513  * \endvar
514  */
515                 { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit },
516 /*!
517  * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD_SELECT
518  * \li Action: Moves the cursor one position logically backwards, adding
519                traversed position to the selection.
520  * \li Notion: See also #LFUN_CHAR_BACKWARD.
521  * \li Syntax: char-backward-select
522  * \endvar
523  */
524                 { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit },
525                 { LFUN_CHAR_DELETE_BACKWARD, "delete-backward", SingleParUpdate, Edit },
526                 { LFUN_CHAR_DELETE_FORWARD, "delete-forward", SingleParUpdate, Edit },
527 /*!
528  * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD
529  * \li Action: Moves the cursor one position logically forward.
530  * \li Notion: This is not the action which should be bound to the arrow keys,
531                because forward may be left or right, depending on the language.
532                The arrow keys should be bound to #LFUN_CHAR_LEFT or
533                #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
534  * \li Syntax: char-forward
535  * \endvar
536  */
537                 { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit },
538 /*!
539  * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD_SELECT
540  * \li Action: Moves the cursor one position logically forward, adding
541                traversed position to the selection.
542  * \li Notion: See also #LFUN_CHAR_FORWARD.
543  * \li Syntax: char-forward-select
544  * \endvar
545  */
546                 { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit },
547 /*!
548  * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT
549  * \li Action: Moves the cursor one position "to the left".
550  * \li Notion: This is the action which should be taken when the "left" key
551                is pressed. Generally, it moves the cursor one position to the
552                left. However, in Bidi text this become slightly more
553                complicated, and there are different modes of cursor movement.
554                In "visual mode", this moves left, plain and simple. In "logical
555                mode", movement is logically forward in RTL paragraphs, and
556                logically backwards in LTR paragraphs.
557  * \li Syntax: char-left
558  * \endvar
559  */
560                 { LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit },
561 /*!
562  * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT_SELECT
563  * \li Action: Moves the cursor one position "to the left", adding 
564                traversed position to the selection.
565  * \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement.
566  * \li Syntax: char-left-select
567  * \endvar
568  */
569                 { LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit },
570 /*!
571  * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT
572  * \li Action: Moves the cursor one position "to the right".
573  * \li Notion: This is the action which should be taken when the "right" key
574                is pressed. Generally, it moves the cursor one position to the
575                right. However, in Bidi text this become slightly more
576                complicated, and there are different modes of cursor movement.
577                In "visual mode", this moves right, plain and simple. In "logical
578                mode", movement is logically forward in LTR paragraphs, and
579                logically backwards in RTL paragraphs.
580  * \li Syntax: char-right
581  * \endvar
582  */
583                 { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit },
584 /*!
585  * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT_SELECT
586  * \li Action: Moves the cursor one position "to the right", adding
587                traversed position to the selection.
588  * \li Notion: See also #LFUN_CHAR_RIGHT for exact details of the movement.
589  * \li Syntax: char-right-select
590  * \endvar
591  */
592                 { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit },
593
594 /*!
595  * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD
596  * \li Action: Moves the cursor to the logically previous beginning of a word.
597  * \li Notion: This is not the action which should be bound to the arrow keys,
598                because backwards may be left or right, depending on the
599                language. The arrow keys should be bound to #LFUN_WORD_LEFT or
600                #LFUN_WORD_RIGHT actions, which in turn may employ this one.
601  * \li Syntax: word-backward
602  * \endvar
603  */
604                 { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit },
605 /*!
606  * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD_SELECT
607  * \li Action: Moves the cursor to the logically previous beginning of a word,
608                            adding the logically traversed text to the selection.
609  * \li Notion: See also #LFUN_WORD_BACKWARD.
610  * \li Syntax: word-backward-select
611  * \endvar
612  */
613                 { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
614                 { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
615                 { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
616                 { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
617 /*!
618  * \var lyx::FuncCode lyx::LFUN_WORD_FIND_FORWARD
619  * \li Action: Search for a given string in forward direction.
620  * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
621  * \li Syntax: word-find-forward [<STRING>]
622  * \li Origin: Etienne, 16 Feb 1998
623  * \endvar
624  */
625                 { LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit },
626 /*!
627  * \var lyx::FuncCode lyx::LFUN_WORD_FIND_BACKWARD
628  * \li Action: Search for a given string in backward direction.
629  * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
630  * \li Syntax: word-find-backward [<STRING>]
631  * \li Origin: Etienne, 20 Feb 1998
632  * \endvar
633  */
634                 { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
635 /*!
636  * \var lyx::FuncCode lyx::LFUN_WORD_FIND
637  * \li Action: Search for next occurence of a string.
638  * \li Syntax: word-find [<DATA>]
639  * \li Params: <DATA>: data encoded from Find dialog (see #lyx::find2string()).
640                        If no parameter is given, search with last find-dialog
641                        data is used for search (i.e. find-next).
642  * \li Origin: poenitz, Jan 7 2004
643  * \endvar
644  */
645                 { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
646                 { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
647 /*!
648  * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD
649  * \li Action: Moves the cursor to the logically next beginning of a word.
650  * \li Notion: This is not the action which should be bound to the arrow keys,
651                because forward may be left or right, depending on the language.
652                The arrow keys should be bound to #LFUN_WORD_LEFT or
653                #LFUN_WORD_RIGHT actions, which in turn may employ this one.
654  * \li Syntax: word-forward
655  * \endvar
656  */
657                 { LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
658 /*!
659  * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD_SELECT
660  * \li Action: Moves the cursor to the logically next beginning of a word, 
661                            adding the logically traversed text to the selection.
662  * \li Notion: See also #LFUN_WORD_FORWARD.
663  * \li Syntax: word-forward-select
664  * \endvar
665  */
666                 { LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
667 /*!
668  * \var lyx::FuncCode lyx::LFUN_WORD_LEFT
669  * \li Action: Moves the cursor to the next beginning of a word "on the left".
670  * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
671                            "left" key is pressed. Generally, it moves the cursor to the 
672                            next beginning of a word on the left. However, in Bidi text this 
673                            become slightly more complicated, and there are different modes
674                            of cursor movement. In "visual mode", this moves left, plain and
675                            simple. In "logical mode", movement is logically forward in RTL
676                            paragraphs, and logically backwards in LTR paragraphs.
677  * \li Syntax: word-left
678  * \li Origin: dov, 28 Oct 2007
679  * \endvar
680  */
681                 { LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
682 /*!
683  * \var lyx::FuncCode lyx::LFUN_WORD_LEFT_SELECT
684  * \li Action: Moves the cursor to the next beginning of a word "on the left",
685                            adding *logically* traversed text to the selection.
686  * \li Notion: See also #LFUN_WORD_LEFT for exact details of the movement.
687  * \li Syntax: word-left-select
688  * \li Origin: dov, 28 Oct 2007
689  * \endvar
690  */
691                 { LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit },
692                 { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
693 /*!
694  * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT
695  * \li Action: Moves the cursor to the next beginning of a word "on the right".
696  * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
697                            "right" key is pressed. Generally, it moves the cursor to the 
698                            next beginning of a word on the right. However, in Bidi text 
699                            this become slightly more complicated, and there are different
700                            modes of cursor movement. In "visual mode", this moves right,
701                            plain and simple. In "logical mode", movement is logically 
702                            forward in LTR paragraphs, and logically backwards in RTL 
703                            paragraphs.
704  * \li Syntax: word-right
705  * \li Origin: dov, 28 Oct 2007
706  * \endvar
707  */
708                 { LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit },
709 /*!
710  * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT_SELECT
711  * \li Action: Moves the cursor to the next beginning of a word "on the right",
712                            adding *logically* traversed text to the selection.
713  * \li Notion: See also #LFUN_WORD_RIGHT for exact details of the movement.
714  * \li Syntax: word-right-select
715  * \li Origin: dov, 28 Oct 2007
716  * \endvar
717  */
718                 { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
719                 { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
720                 { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
721 /*!
722  * \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
723  * \li Action: Look up thesaurus entries with respect to the word under the cursor.
724  * \li Syntax: thesaurus-entry
725  * \li Origin: Levon, 20 Jul 2001
726  * \endvar
727  */
728                 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
729                 { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
730                 { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
731                 { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
732                 { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
733
734                 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
735                 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
736                 { LFUN_LINE_DELETE, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
737                 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
738                 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
739 /*!
740  * \var lyx::FuncCode lyx::LFUN_COPY
741  * \li Action: Copies to the clipboard the last edit.
742  * \li Syntax: copy
743  * \endvar
744  */
745                 { LFUN_COPY, "copy", ReadOnly, Edit },
746 /*!
747  * \var lyx::FuncCode lyx::LFUN_CUT
748  * \li Action: Cuts to the clipboard.
749  * \li Syntax: cut
750  * \endvar
751  */
752                 { LFUN_CUT, "cut", Noop, Edit },
753 /*!
754  * \var lyx::FuncCode lyx::LFUN_PASTE
755  * \li Action: Pastes from the active clipboard.
756  * \li Syntax: paste
757  * \endvar
758  */
759                 { LFUN_PASTE, "paste", Noop, Edit },
760                 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
761 /*!
762  * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
763  * \li Action: Pastes the material currently selected.
764  * \li Syntax: primary-selection-paste
765  * \endvar
766  */
767                 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
768 /*!
769  * \var lyx::FuncCode lyx::LFUN_UNDO
770  * \li Action: Undoes the last edit.
771  * \li Syntax: undo
772  * \endvar
773  */
774                 { LFUN_UNDO, "undo", Noop, Edit },
775 /*!
776  * \var lyx::FuncCode lyx::LFUN_REDO
777  * \li Action: Redoes the last thing undone.
778  * \li Syntax: redo
779  * \endvar
780  */
781                 { LFUN_REDO, "redo", Noop, Edit },
782 /*!
783  * \var lyx::FuncCode lyx::LFUN_REPEAT
784  * \li Action: Repeat the given command.
785  * \li Syntax: repeat <COUNT> <LFUN-COMMAND>
786  * \li Author: poenitz, 27 Oct 2003
787  * \endvar
788  */
789                 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
790 /*!
791  * \var lyx::FuncCode lyx::LFUN_CHARS_TRANSPOSE
792  * \li Action: Transposes the character at the cursor with the one before it.
793  * \li Syntax: chars-transpose
794  * \li Author: Lgb, 25 Apr 2001
795  * \endvar
796  */
797                 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
798
799                 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
800                 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
801                 { LFUN_ENVIRONMENT_INSERT, "environment-insert", Noop, Edit },
802
803 /*!
804  * \var lyx::FuncCode lyx::LFUN_FONT_BOLD
805  * \li Action: Toggles the bold font (selection-wise).
806  * \li Syntax: font-bold
807  * \endvar
808  */
809                 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
810 /*!
811  * \var lyx::FuncCode lyx::LFUN_FONT_TYPEWRITER
812  * \li Action: Toggles the typewriter family font (selection-wise).
813  * \li Syntax: font-typewriter
814  * \endvar
815  */
816                 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
817 /*!
818  * \var lyx::FuncCode lyx::LFUN_FONT_UNDERLINE
819  * \li Action: Toggles underline in the font (selection-wise).
820  * \li Syntax: font-underline
821  * \endvar
822  */
823                 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
824 /*!
825  * \var lyx::FuncCode lyx::LFUN_FONT_EMPH
826  * \li Action: Toggles the emphasis font style (selection-wise).
827  * \li Syntax: font-emph
828  * \endvar
829  */
830                 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
831 /*!
832  * \var lyx::FuncCode lyx::LFUN_FONT_NOUN
833  * \li Action: Toggles Noun text style font (selection-wise).
834  * \li Syntax: font-noun
835  * \endvar
836  */
837                 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
838 /*!
839  * \var lyx::FuncCode lyx::LFUN_FONT_ROMAN
840  * \li Action: Toggles Roman family font (selection-wise).
841  * \li Syntax: font-roman
842  * \endvar
843  */
844                 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
845 /*!
846  * \var lyx::FuncCode lyx::LFUN_FONT_SANS
847  * \li Action: Toggles Sans Serif family font (selection-wise).
848  * \li Syntax: font-sans
849  * \endvar
850  */
851                 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
852 /*!
853  * \var lyx::FuncCode lyx::LFUN_FONT_FRAK
854  * \li Action: Toggles Fraktur family font (math-mode, selection-wise).
855  * \li Syntax: font-frak
856  * \li Origin: vermeer, 10 Jan 2002
857  * \endvar
858  */
859                 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
860 /*!
861  * \var lyx::FuncCode lyx::LFUN_FONT_ITAL
862  * \li Action: Toggles Italics font shape (math-mode, selection-wise).
863  * \li Syntax: font-ital
864  * \li Origin: vermeer, 10 Jan 2002
865  * \endvar
866  */
867                 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
868 /*!
869  * \var lyx::FuncCode lyx::LFUN_FONT_DEFAULT
870  * \li Action: Reverts the settings of the font to the default values (selection-wise).
871  * \li Syntax: font-default
872  * \endvar
873  */
874                 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
875                 { LFUN_FONT_FREE_APPLY, "font-free-apply", Noop, Layout },
876                 { LFUN_FONT_FREE_UPDATE, "font-free-update", Noop, Layout },
877                 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
878                 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
879 /*!
880  * \var lyx::FuncCode lyx::LFUN_FONT_STATE
881  * \li Action: Returns the info about the current font.
882  * \li Syntax: font-state
883  * \endvar
884  */
885                 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
886
887                 { LFUN_BIBITEM_INSERT, "bibitem-insert", Noop, Edit },
888                 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
889                 { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit },
890                 { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
891
892 /*!
893  * \var lyx::FuncCode lyx::LFUN_LAYOUT
894  * \li Action: Sets the layout (that is, environment) for the current paragraph.
895  * \li Syntax: layout <LAYOUT>
896  * \li Params: <LAYOUT>: the layout to use
897  * \endvar
898  */
899                 { LFUN_LAYOUT, "layout", Noop, Layout },
900 /*!
901  * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH
902  * \li Action: Launches the paragraph settings dialog.
903  * \li Syntax: layout-paragraph
904  * \endvar
905  */
906                 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
907                 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
908 /*!
909  * \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE
910  * \li Action: Displays list of layout choices.
911  * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
912                dropbox allowing for choice of layout.
913  * \li Syntax: drop-layouts-choice
914  * \endvar
915  */
916                 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
917 /*!
918  * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
919  * \li Action: Clears the module list.
920  * \li Notion: Clears the list of included modules for the current buffer.
921  * \li Syntax: layout-modules-clear
922  * \li Origin: rgh, 25 August 2007
923  * \endvar
924  */
925                 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", Noop, Layout },
926 /*!
927  * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULE_ADD
928  * \li Action: Adds a module.
929  * \li Notion: Adds a module to the list of included modules for the current buffer.
930  * \li Syntax: layout-module-add <MODULE>
931  * \li Params: <MODULE>: the module to be added
932  * \li Origin: rgh, 25 August 2007
933  * \endvar
934  */
935                 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", Noop, Layout },
936 /*!
937  * \var lyx::FuncCode lyx::LFUN_LAYOUT_RELOAD
938  * \li Action: Reloads layout information.
939  * \li Notion: Reloads all layout information for the current buffer from disk, thus
940                recognizing any changes that have been made to layout files on the fly.
941                This is intended to be used only by layout developers and should not be
942                used when one is trying to do actual work.
943  * \li Syntax: layout-reload
944  * \li Origin: rgh, 3 September 2007
945  * \endvar
946  */
947                 { LFUN_LAYOUT_RELOAD, "layout-reload", Noop, Layout },
948 /*!
949  * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
950  * \li Action: Sets the text class for the current buffer.
951  * \li Syntax: textclass-apply <TEXTCLASS>
952  * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
953                    the filename, minus the ".layout" extension.
954  * \endvar
955  */
956                 { LFUN_TEXTCLASS_APPLY, "textclass-apply", Noop, Layout },
957 /*!
958  * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
959  * \li Action: Loads information for a textclass from disk.
960  * \li Syntax: textclass-load <TEXTCLASS>
961  * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
962                    the filename, minus the ".layout" extension.
963  * \endvar
964  */
965                 { LFUN_TEXTCLASS_LOAD, "textclass-load", Noop, Layout },
966
967 /*!
968  * \var lyx::FuncCode lyx::LFUN_MARK_OFF
969  * \li Action: Disable selecting of text-region.
970  * \li Syntax: mark-off
971  * \endvar
972  */
973                 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
974 /*!
975  * \var lyx::FuncCode lyx::LFUN_MARK_ON
976  * \li Action: Enable selecting of text-region.
977  * \li Notion: After enabling you can simply move arrow keys to get selected region.
978  * \li Syntax: mark-on
979  * \endvar
980  */
981                 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
982 /*!
983  * \var lyx::FuncCode lyx::LFUN_MARK_TOGGLE
984  * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
985  * \li Syntax: mark-toggle
986  * \li Origin: poenitz, May 5 2006
987  * \endvar
988  */
989                 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
990                 
991                 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
992                 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
993                 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
994                 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
995                 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
996                 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
997                 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
998                 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
999                 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
1000                 { LFUN_MATH_SPACE, "math-space", Noop, Math },
1001                 { LFUN_MATH_IMPORT_SELECTION, "math-import-selection", Noop, Math },
1002                 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
1003                 { LFUN_MATH_MODE, "math-mode", Noop, Math },
1004 /*!
1005  * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
1006  * \li Action: Toggles numbering of the current formula line.
1007  * \li Notion: Must be in display formula mode.
1008  * \li Syntax: math-number-line-toggle
1009  * \li Origin: Alejandro 18 Jun 1996
1010  * \endvar
1011  */
1012                 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
1013 /*!
1014  * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
1015  * \li Action: Toggles numbering/labeling of the current formula.
1016  * \li Notion: Must be in display formula mode.
1017  * \li Syntax: math-number-toggle
1018  * \li Origin: Alejandro 4 Jun 1996
1019  * \endvar
1020  */
1021                 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
1022                 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
1023                 { LFUN_MATH_SIZE, "math-size", Noop, Math },
1024 /*!
1025  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
1026  * \li Action: Unfold a Math Macro.
1027  * \li Notion: Unfold the Math Macro the cursor is in, i.e.
1028                display it as \foo.
1029  * \li Syntax: math-macro-unfold
1030  * \li Origin: sts, 06 January 2008
1031  * \endvar
1032  */
1033                 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
1034 /*!
1035  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
1036  * \li Action: Fold a Math Macro.
1037  * \li Notion: Fold the Math Macro the cursor is in if it was
1038                unfolded, i.e. displayed as \foo before.
1039  * \li Syntax: math-macro-fold
1040  * \li Origin: sts, 06 January 2008
1041  * \endvar
1042  */
1043                 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
1044 /*!
1045  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
1046  * \li Action: Add a parameter.
1047  * \li Notion: Add a parameter to a Math Macro.
1048  * \li Params: <NUM>: The number of the parameter behind which the new one
1049                will be added (1 for the first, i.e. use 0 for add a
1050                parameter at the left), defaults to the last one.
1051  * \li Syntax: math-macro-add-param <NUM>
1052  * \li Origin: sts, 06 January 2008
1053  * \endvar
1054  */
1055                 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
1056 /*!
1057  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
1058  * \li Action: Remove the last parameter.
1059  * \li Notion: Remove the last parameter of a Math Macro and
1060                remove its value in all instances of the macro
1061                in the buffer.
1062  * \li Params: <NUM>: The number of the parameter to be deleted (1 for
1063                the first), defaults to the last one.
1064  * \li Syntax: math-macro-remove-param <NUM>
1065  * \li Origin: sts, 06 January 2008
1066  * \endvar
1067  */
1068                 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
1069 /*!
1070  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
1071  * \li Action: Append a greedy parameter.
1072  * \li Notion: Append a greedy parameter to a Math Macro which
1073                eats the following mathed cell in every instance of
1074                the macro in the buffer.
1075  * \li Syntax: math-macro-append-greedy-param
1076  * \li Origin: sts, 06 January 2008
1077  * \endvar
1078  */
1079                 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
1080 /*!
1081  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
1082  * \li Action: Remove a greedy parameter.
1083  * \li Notion: Remove a greedy parameter of a Math Macro and spit
1084                out the values of it in every instance of the macro
1085                in the buffer. If it is an optional parameter the [valud]
1086                format is used.
1087  * \li Syntax: math-macro-remove-greedy-param
1088  * \li Origin: sts, 06 January 2008
1089  * \endvar
1090  */
1091                 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
1092 /*!
1093  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
1094  * \li Action: Make a parameter optional.
1095  * \li Notion: Turn the first non-optional parameter of a Math Macro
1096                into an optional parameter with a default value.
1097  * \li Syntax: math-macro-make-optional
1098  * \li Origin: sts, 06 January 2008
1099  * \endvar
1100  */
1101                 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
1102 /*!
1103  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
1104  * \li Action: Make a parameter non-optional.
1105  * \li Notion: Turn the last optional parameter of a Math Macro
1106                into a non-optional parameter. The default value is
1107                remembered to be reused later if the user changes his mind.
1108  * \li Syntax: math-macro-make-nonoptional
1109  * \li Origin: sts, 06 January 2008
1110  * \endvar
1111  */
1112                 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
1113 /*!
1114  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
1115  * \li Action: Add an optional parameter.
1116  * \li Notion: Insert an optional parameter just behind the
1117                already existing optional parameters.
1118  * \li Syntax: math-macro-add-optional-param
1119  * \li Origin: sts, 06 January 2008
1120  * \endvar
1121  */
1122                 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
1123 /*!
1124  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
1125  * \li Action: Remove the last optional parameter.
1126  * \li Notion: Remove the last optional parameter of a Math Macro and
1127                remove it in all the instances of the macro in the buffer.
1128  * \li Syntax: math-macro-remove-optional-param
1129  * \li Origin: sts, 06 January 2008
1130  * \endvar
1131  */
1132                 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
1133 /*!
1134  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
1135  * \li Action: Add a greedy optional parameter.
1136  * \li Notion: Add a greedy optional parameter which eats the value
1137                from the following cells in mathed which are in the [value]
1138                format.
1139  * \li Syntax: math-macro-add-greedy-optional-param
1140  * \li Origin: sts, 06 January 2008
1141  * \endvar
1142  */
1143                 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
1144 /*!
1145  * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
1146  * \li Action: Only active in Math Macro definition.
1147  * \li Notion: Dummy function which is only active in a Math Macro definition.
1148                It's used to toggle the Math Macro toolbar if the cursor moves
1149                into a Math Macro definition.
1150  * \li Syntax: in-mathmacrotemplate
1151  * \li Origin: sts, 06 January 2008
1152  * \endvar
1153  */
1154                 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
1155
1156 /*!
1157  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
1158  * \li Action: Moves the current paragraph downwards in the document.
1159  * \li Syntax: paragraph-move-down
1160  * \li Origin: Edwin, 8 Apr 2006
1161  * \endvar
1162  */
1163                 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
1164 /*!
1165  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
1166  * \li Action: Moves the current paragraph upwards in the document.
1167  * \li Syntax: paragraph-move-up
1168  * \li Origin: Edwin, 8 Apr 2006
1169  * \endvar
1170  */
1171                 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
1172
1173 /*!
1174  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP
1175  * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1176                in upward direction.
1177  * \li Syntax: paragraph-up
1178  * \li Origin: Asger, 1 Oct 1996
1179  * \endvar
1180  */
1181                 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
1182 /*!
1183  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP_SELECT
1184  * \li Action: Move the cursor and select the text to the next paragraph (or
1185                begining of the current one) in upward direction.
1186  * \li Syntax: paragraph-up-select
1187  * \li Origin: Asger, 1 Oct 1996
1188  * \endvar
1189  */
1190                 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
1191 /*!
1192  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN
1193  * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1194                in downward direction.
1195  * \li Syntax: paragraph-down
1196  * \li Origin: Asger, 1 Oct 1996
1197  * \endvar
1198  */
1199                 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
1200 /*!
1201  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN_SELECT
1202  * \li Action: Move the cursor and select the text to the next paragraph (or
1203                begining of the current one) in downward direction.
1204  * \li Syntax: paragraph-down-select
1205  * \li Origin: Asger, 1 Oct 1996
1206  * \endvar
1207  */
1208                 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
1209 /*!
1210  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
1211  * \li Action: Jump to a paragraph given by its id number and optionally the
1212                desired position within the paragraph.
1213  * \li Notion: Note that id number of paragraph is not the sequential number of paragraph
1214                seen on the screen. Moreover the id is unique for all opened buffers (documents).
1215  * \li Syntax: paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
1216  * \li Params: <PAR_ID_NUMBER>:  paragraph id
1217                <POSITION_IN_PAR>: desired position within the paragraph
1218  * \li Origin: Dekel, 26 Aug 2000
1219  * \endvar
1220  */
1221                 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly, Edit },
1222 /*!
1223  * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1224  * \li Action: Breaks the current paragraph at the current location.
1225  * \li Syntax: break-paragraph
1226  * \endvar
1227  */
1228                 { LFUN_PARAGRAPH_SPACING, "paragraph-spacing", Noop, Edit },
1229                 { LFUN_BREAK_PARAGRAPH, "break-paragraph", Noop, Edit },
1230 /*!
1231  * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH_SKIP
1232  * \li Action: Breaks the current paragraph at the current location,
1233                unless used at the beginning of a line, where it sets
1234                the label width string to empty.
1235  * \li Syntax: break-paragraph-skip
1236  * \endvar
1237  */
1238                 { LFUN_BREAK_PARAGRAPH_SKIP, "break-paragraph-skip", Noop, Edit },
1239 /*!
1240  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
1241  * \li Action: Change paragraph settings.
1242  * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
1243                This function only modifies, and does not override, existing settings.
1244                Note that the "leftindent" indent setting is deprecated.
1245  * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
1246  * \li Params: <INDENT>:  \\noindent|\\indent|\\indent-toggle|\\leftindent LENGTH\n
1247                <SPACING>: \\paragraph_spacing default|single|onehalf|double|other\n
1248                <ALIGN>:   \\align block|left|right|center|default\n
1249                <OTHERS>:  \\labelwidthstring WIDTH|\\start_of_appendix\n
1250  * \li Origin: rgh, Aug 15 2007
1251  * \endvar
1252  */
1253                 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
1254 /*!
1255  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
1256  * \li Action: Change paragraph settings.
1257  * \li Notion: Overwrite all nonspecified settings to the default ones.
1258                Use paragraph-params lfun if you don't want to overwrite others settings.
1259  * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
1260  * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
1261  * \li Origin: leeming, 30 Mar 2004
1262  * \endvar
1263  */
1264                 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
1265                 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
1266
1267 /*!
1268  * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
1269  * \li Action: Move the current group in the upward direction in the
1270                structure of the document.
1271  * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1272                the whole substructure of the group.
1273  * \li Syntax: outline-up
1274  * \li Origin: Vermeer, 23 Mar 2006
1275  * \endvar
1276  */
1277                 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
1278 /*!
1279  * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
1280  * \li Action: Move the current group in the downward direction in the
1281                structure of the document.
1282  * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1283                the whole substructure of the group.
1284  * \li Syntax: outline-down
1285  * \li Origin: Vermeer, 23 Mar 2006
1286  * \endvar
1287  */
1288                 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
1289 /*!
1290  * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
1291  * \li Action: Moves the current group in the downward direction in the
1292                hierarchy of the document structure.
1293  * \li Notion: Part -> Chapter -> Section -> etc.
1294  * \li Syntax: outline-in
1295  * \li Origin: Vermeer, 23 Mar 2006
1296  * \endvar
1297  */
1298                 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
1299 /*!
1300  * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
1301  * \li Action: Moves the current group in the upward direction in the
1302                hierarchy of the document structure.
1303  * \li Notion: Part <- Chapter <- Section <- etc.
1304  * \li Syntax: outline-out
1305  * \li Origin: Vermeer, 23 Mar 2006
1306  * \endvar
1307  */
1308                 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
1309 /*!
1310  * \var lyx::FuncCode lyx::LFUN_INSET_EDIT
1311  * \li Action: Edit the inset at cursor with an external application,
1312  *             if one is attributed.
1313  * \li Syntax: inset-edit [<INSET_PARAMS>]
1314  * \li Params: <INSET_PARAMS>: Parameters for the inset.
1315                                Currently only the filename will be considered.
1316  * \li Origin: JSpitzm, 27 Apr 2006
1317  * \endvar
1318  */
1319                 { LFUN_INSET_EDIT, "inset-edit", Noop, Edit },
1320
1321                 { LFUN_CELL_BACKWARD, "cell-backward", Noop, Edit },
1322                 { LFUN_CELL_FORWARD, "cell-forward", Noop, Edit },
1323                 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
1324                 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
1325                 { LFUN_TABULAR_FEATURE, "tabular-feature", Noop, Edit },
1326
1327                 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
1328                 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
1329                 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
1330                 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
1331                 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
1332
1333                 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
1334                 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
1335                 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
1336                 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
1337                 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
1338                 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
1339                 { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
1340                 { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
1341
1342 /*!
1343  * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
1344  * \li Action: Apply data for an inset.
1345  * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
1346                be applied. This is either changed to #LFUN_INSET_MODIFY or
1347                #LFUN_INSET_INSERT depending on the context where it is called.
1348  * \li Syntax: inset-apply <ARGS>
1349  * \li Params: See #LFUN_INSET_INSERT .
1350  * \endvar
1351  */
1352                 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
1353 /*!
1354  * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE
1355  * \li Action: Dissolve the current inset into text.
1356  * \li Syntax: inset-dissolve [<INSET>]
1357  * \li Params: <INSET>: this can be used to make sure the right kind of inset
1358                         is dissolved. For example "dissolve" entry in the charstyles
1359                         sub-menu should only dissolve the charstyle inset, even if the
1360                         cursor is inside several nested insets of different type.\n
1361                         For values see #lyx::InsetLayout::lyxtype_ .
1362  * \li Author: JSpitz, 7 Aug 2006
1363  * \endvar
1364  */
1365                 { LFUN_INSET_DISSOLVE, "inset-dissolve", Noop, Edit },
1366 /*!
1367  * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
1368  * \li Action: Insert new inset (type given by the parameters).
1369  * \li Syntax: inset-insert <INSET> <ARGS>
1370  * \li Params: <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics|
1371                          hyperlink|include|index|label|nomencl|vspace|ref|toc>\n
1372                <ARGS>: depends on the given inset. Use "lyx -dbg action" to
1373                        explore.
1374  * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
1375                where <label name> is the name of the referenced label and
1376                <Format> is one of the following: \n
1377                ref -- <reference> \n
1378                eqref -- (<reference>) \n
1379                pageref -- <page> \n
1380                vpageref -- on <page> \n
1381                vref -- <reference> on <page> \n
1382                prettyref -- Formatted reference
1383  * \endvar
1384  */
1385                 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
1386 /*!
1387  * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
1388  * \li Action: Modify existing inset.
1389  * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1390                bibtex, ert, command, graphics, note, space, vspace, tabular,
1391                bibitem, inlude, ref insets.
1392  * \li Syntax: inset-modify <INSET> <ARGS>
1393  * \li Params: See #LFUN_INSET_INSERT for further details.
1394  * \endvar
1395  */
1396                 { LFUN_INSET_MODIFY, "", Noop, Hidden },
1397 /*!
1398  * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_MODIFY
1399  * \li Action: Modify the inset at cursor position, if there is one.
1400  * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1401                bibtex, ert, command, graphics, note, space, vspace, tabular,
1402                bibitem, inlude, ref insets.
1403  * \li Syntax: next-inset-modify <INSET> <ARGS> or next-inset-modify changetype <TYPE>
1404  * \li Params: See #LFUN_INSET_INSERT for further details.
1405  * \li Origin: JSpitzm, 23 Mar 2008
1406  * \endvar
1407  */
1408                 { LFUN_NEXT_INSET_MODIFY, "next-inset-modify", ReadOnly, Edit },
1409                 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
1410 /*!
1411  * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
1412  * \li Action: Open the inset's properties dialog.
1413  * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
1414  * \li Syntax: inset-settings <INSET>
1415  * \li Params: <INSET>: <box|branch|ert|float|listings|note|tabular|wrap>
1416  * \endvar
1417  */
1418                 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly, Edit },
1419 /*!
1420  * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_TOGGLE
1421  * \li Action: Toggles the inset at cursor position. For collapsables, this means it will
1422                be (un-)collapsed, in case of other insets, the editing widget (dialog) will
1423                be entered. Also cf. #LFUN_INSET_SETTINGS.
1424  * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1425                bibtex, ert, command, graphics, note, space, vspace, tabular,
1426                bibitem, inlude, ref insets.
1427  * \li Syntax: next-inset-toggle <ARG>
1428  * \li Params: <ARG>: these are passed as arguments to #LFUN_INSET_TOGGLE .
1429  * \li Origin: leeming, 30 Mar 2004
1430  * \endvar
1431  */
1432                 { LFUN_NEXT_INSET_TOGGLE, "next-inset-toggle", ReadOnly, Edit },
1433 /*!
1434  * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
1435  * \li Action: Toggles the collapsable inset we are currently in.
1436  * \li Syntax: inset-toggle [<ARG>]
1437  * \li Params: <ARG>: <open|close|toggle|assign>. \n
1438                open/close/toggle are for collapsable insets. close can be currently used
1439                by #LFUN_NEXT_INSET_TOGGLE. toggle is used when no argument is given.\n
1440                assign is for branch inset.
1441  * \li Origin: lasgouttes, 19 Jul 2001
1442  * \endvar
1443  */
1444                 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly, Hidden },
1445 /*!
1446  * \var lyx::FuncCode lyx::LFUN_ALL_INSETS_TOGGLE
1447  * \li Action: Toggles (open/closes) all collapsable insets (of a given type) in the document.
1448  * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
1449  * \li Syntax: all-insets-toggle <STATE> <INSET>
1450  * \li Params: <STATE>: <toggle|open|close> default: toggle \n
1451                <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all insets \n
1452  * \li Origin: leeming, 30 Mar 2004
1453  * \endvar
1454  */
1455                 { LFUN_ALL_INSETS_TOGGLE, "all-insets-toggle", ReadOnly, Edit },
1456 /*!
1457  * \var lyx::FuncCode lyx::LFUN_GRAPHICS_GROUPS_UNIFY
1458  * \li Action: Unify all graphics insets with the one given as an parameter.
1459  * \li Notion: This is internally used for synchronize certain group of graphics insets.
1460  * \li Syntax: graphics-groups-unigfy <GRAPHICS_PARAMS>
1461  * \li Params: <GRAPHICS_PARAMS>: Parameters for graphics inset
1462                                   (syntax can be seen in .lyx files).
1463  * \li Origin: sanda, 6 May 2008
1464  * \endvar
1465  */
1466                 { LFUN_GRAPHICS_GROUPS_UNIFY, "graphics-groups-unify", ReadOnly, Edit },
1467 /*!
1468  * \var lyx::FuncCode lyx::LFUN_SET_GRAPHICS_GROUP
1469  * \li Action: Set the group for the graphics inset on the cursor position.
1470  * \li Syntax: set-graphics-group [<GROUP>]
1471  * \li Params: <GROUP>: Id for an existing group. In case tthe Id is an empty string,
1472                         the graphics inset is removed from the current group.
1473  * \li Origin: sanda, 6 May 2008
1474  * \endvar
1475  */
1476                 { LFUN_SET_GRAPHICS_GROUP, "set-graphics-group", ReadOnly, Edit },
1477
1478 /*!
1479  * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
1480  * \li Action: Moves the cursor out of the current slice, going forward.
1481  * \li Notion: Cursor movement within an inset may be different than cursor
1482                movement in the surrounding text. This action should be called
1483                automatically by the cursor movement within the inset, when
1484                movement within the inset has ceased (reached the end of the
1485                last paragraph, for example), in order to move correctly
1486                back into the surrounding text.
1487  * \endvar
1488  */
1489                 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
1490 /*!
1491  * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
1492  * \li Action: Moves the cursor out of the current slice, going backwards.
1493  * \li Notion: See also #LFUN_FINISHED_FORWARD.
1494  * \endvar
1495  */
1496                 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
1497 /*!
1498  * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
1499  * \li Action: Moves the cursor out of the current slice, going right.
1500  * \li Notion: See also #LFUN_FINISHED_FORWARD
1501  * \endvar
1502  */
1503                 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
1504 /*!
1505  * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
1506  * \li Action: Moves the cursor out of the current slice, going left.
1507  * \li Notion: See also #LFUN_FINISHED_FORWARD.
1508  * \endvar
1509  */
1510                 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
1511
1512                 { LFUN_LANGUAGE, "language", Noop, Edit },
1513
1514 /*!
1515  * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
1516  * \li Action: Goto a label.
1517  * \li Syntax: label-goto [<LABEL>]
1518  * \li Params: <LABEL>: Requested label. If no label is given and refernce
1519                         is on cursor position, Bookmark 0 is saved and
1520                         cursor moves to the position of referenced label.
1521  * \li Origin: Ale, 6 Aug 1997
1522  * \endvar
1523  */
1524                 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
1525 /*!
1526  * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT
1527  * \li Action: Inserts label to text or displayed formula.
1528  * \li Syntax: label-insert [<LABEL>]
1529  * \li Params: <LABEL>: Requested label. If no label is given dialog requesting
1530                         name will be opened.
1531  * \endvar
1532  */
1533                 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
1534 /*!
1535  * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
1536  * \li Action: Go to the next label or cross-reference.
1537  * \li Syntax: reference-next
1538  * \li Origin: Dekel, 14 Jan 2001
1539  * \endvar
1540  */
1541                 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
1542
1543 /*!
1544  * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
1545  * \li Action: Goto a bookmark.
1546  * \li Notion: Moves the cursor to the numbered bookmark, opening the file
1547                if necessary. Note that bookmarsk are saved per-session, not
1548                per file.
1549  * \li Syntax: bookmark-goto <NUMBER>
1550  * \li Params: <NUMBER>: the number of the bookmark to restore.
1551  * \li Origin: Dekel, 27 January 2001
1552  * \endvar
1553  */
1554                 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
1555 /*!
1556  * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
1557  * \li Action: Save a bookmark.
1558  * \li Notion: Saves a numbered bookmark to the sessions file. The number
1559                must be between 1 and 9, inclusive. Note that bookmarks are
1560                saved per-session, not per file.
1561  * \li Syntax: bookmark-save <NUMBER>
1562  * \li Params: <NUMBER>: the number of the bookmark to save.
1563  * \li Origin: Dekel, 27 January 2001
1564  * \endvar
1565  */
1566                 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
1567 /*!
1568  * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
1569  * \li Action: Clears the list of saved bookmarks.
1570  * \li Syntax: bookmark-clear
1571  * \li Origin: bpeng, 31 October 2006
1572  * \endvar
1573  */
1574                 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
1575
1576 /*!
1577  * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
1578  * \li Action: Open the given help file according to the language setting.
1579  * \li Syntax: help-open <FILE>[.lyx]
1580  * \li Params: <FILE>: any document from (/usr/share/)doc directory.
1581  * \li Author: Jug, 27 Jun 1999
1582  * \endvar
1583  */
1584                 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
1585 /*!
1586  * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
1587  * \li Action: Terminates the current LyX instance.
1588  * \li Notion: Terminates the current LyX instance, asking whether to save
1589                modified documents, etc.
1590  * \li Syntax: lyx-quit
1591  * \endvar
1592  */
1593                 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
1594 /*!
1595  * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
1596  * \li Action: Toggles visibility of a given toolbar between on/off/auto.
1597  * \li Notion: Skiping "auto" when allowauto is false.
1598  * \li Syntax: toolbar-toggle <NAME> [allowauto]
1599  * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|
1600                        minibuffer|review|view/update|math_panels
1601  * \li Origin: Edwin, 21 May 2007
1602  * \endvar
1603  */
1604                 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
1605 /*!
1606  * \var lyx::FuncCode lyx::LFUN_MENU_OPEN
1607  * \li Action: Opens the menu given by its name.
1608  * \li Syntax: menu-open <NAME>
1609  * \li Params: <NAME>: menu name. See various .inc files in lib/ui for candidates.
1610  * \endvar
1611  */
1612                 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
1613 /*!
1614  * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
1615  * \li Action: Various UI visibility-toggling actions.
1616  * \li Syntax: ui-toggle <statusbar|menubar|frame|fullscreen>
1617  * \li Params: statusbar  : Toggle visibility of the statusbar.\n
1618                menubar    : Toggle visibility of the menubar.\n
1619                scrollbar  : Toggle visibility of the scrollbar.\n
1620                frame      : Toggle visibility of the frames around editing window.\n
1621                fullscreen : Toggle fullscreen mode. This also covers calling the
1622                             previous functions. However #LFUN_TOOLBAR_TOGGLE for the
1623                             custom tweaks of the toolbars should be used.
1624  * \li Origin: ps, 9 Feb 2007
1625  * \endvar
1626  */
1627                 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
1628
1629 /*!
1630  * \var lyx::FuncCode lyx::WINDOW_NEW
1631  * \li Action: Creates new empty LyX window.
1632  * \li Notion: Already opened documents from the previous window can be found under View menu.
1633  * \li Syntax: window-new [<GEOMETRY>]
1634  * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently 
1635                            accepted only on Windows platform.
1636  * \li Origin: Abdel, 21 Oct 2006
1637  * \endvar
1638  */
1639                 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
1640 /*!
1641  * \var lyx::FuncCode lyx::LFUN_WINDOW_CLOSE
1642  * \li Action: Closes the current LyX window.
1643  * \li Syntax: window-close
1644  * \li Origin: Abdel, 23 Oct 2006
1645  * \endvar
1646  */
1647                 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
1648
1649 /*!
1650  * \var lyx::FuncCode lyx::LFUN_SPLIT_VIEW
1651  * \li Action: Creates another split view of current buffer.
1652  * \li Notion: All split views act in the same way indpendently.
1653  * \li Syntax: split-view <vertical|horizontal>
1654  * \li Params: horizontal : The work areas are laid out side by side.\n
1655                vertical   : The work areas laid out vertically.\n
1656  * \li Origin: abdel, 20 Feb 2008
1657  * \endvar
1658  */
1659                 { LFUN_SPLIT_VIEW, "split-view", ReadOnly, Buffer },
1660
1661 /*!
1662  * \var lyx::FuncCode lyx::LFUN_CLOSE_TAB_GROUP
1663  * \li Action: Close the current tab group.
1664  * \li Notion: This only closes the work areas, not the buffer themselves.
1665                The still opened buffers can be visualized in another tab group.
1666  * \li Syntax: close-tab-group
1667  * \li Origin: abdel, 21 Feb 2008
1668  * \endvar
1669  */
1670                 { LFUN_CLOSE_TAB_GROUP, "close-tab-group", ReadOnly, Buffer },
1671                 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
1672                 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
1673                 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
1674                 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
1675                 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
1676                 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
1677
1678                 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
1679                 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
1680                 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
1681                 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
1682                 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
1683
1684                 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
1685                 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
1686                 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
1687                 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
1688
1689                 { LFUN_FLOAT_LIST, "float-list", Noop, Edit },
1690
1691                 { LFUN_SERVER_CHAR_AFTER, "server-char-after", ReadOnly, System },
1692                 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
1693                 { LFUN_SERVER_GET_NAME, "server-get-name", ReadOnly, System },
1694 /*!
1695  * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
1696  * \li Action: Sets the cursor position based on the row number of generated TeX file.
1697  * \li Syntax: server-goto-file-row <LYX_FILE_NAME> <ROW_NUMBER>
1698  * \li Origin: Edmar, 23 Dec 1998
1699  * \endvar
1700  */
1701                 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly, System },
1702                 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
1703 /*!
1704  * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
1705  * \li Action: Sets the cursor position based on the editing area coordinates
1706                (similar as clicking on that point with left mouse button).
1707  * \li Syntax: server-set-xy <X> <Y>
1708  * \endvar
1709  */
1710                 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
1711 /*!
1712  * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
1713  * \li Action: Returns the coordinates of cursor position in the editing area.
1714  * \li Syntax: server-get-xy
1715  * \endvar
1716  */
1717                 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
1718
1719 /*!
1720  * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
1721  * \li Action: Generates the code (literate programming).
1722  * \li Notion: Latex file with extension \literate_extension is generated.
1723                Then LyX invokes \build_command (with a default of``make'') to generate the code and
1724                \build_error_filter to process the compilation error messages. \n
1725                In case you want to process your literate file with a script, or some other program,
1726                just insert in your lyxrc file an entry with:\n
1727                \build_command "my_script my_arguments" \n
1728                The \build_error_filter differs from the \literate_error_filter only in that the
1729                former will identify error messages from your compiler.
1730  * \li Syntax: build-program
1731  * \endvar
1732  */
1733                 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
1734
1735 /*!
1736  * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
1737  * \li Action: Saves the current buffer to a temporary file.
1738  * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
1739                is called automatically by LyX, to "autosave" the current buffer.
1740  * \li Syntax: buffer-auto-save
1741  * \endvar
1742  */
1743                 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
1744 /*!
1745  * \var lyx::FuncCode lyx::LFUN_BUFFER_CHILD_OPEN
1746  * \li Action: Loads the given child document.
1747  * \li Notion: The current document is treated as a parent.
1748  * \li Syntax: buffer-child-open <FILE>
1749  * \li Params: <FILE>: Filename of the child. The directory of the parent is assumed by default.
1750  * \li Origin: Ale, 28 May 1997
1751  * \endvar
1752  */
1753                 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
1754 /*!
1755  * \var lyx::FuncCode lyx::LFUN_BUFFER_CHKTEX
1756  * \li Action: Runs chktex for the current document.
1757  * \li Syntax: buffer-chktex
1758  * \li Origin: Asger, 30 Oct 1997
1759  * \endvar
1760  */
1761                 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
1762 /*!
1763  * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
1764  * \li Action: Toggles compression of the current document on/off.
1765  * \li Syntax: buffer-toggle-compression
1766  * \li Origin: bpeng, 27 Apr 2006
1767  * \endvar
1768  */
1769                 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
1770 /*!
1771  * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
1772  * \li Action: Closes the current buffer.
1773  * \li Notion: Closes the current buffer, asking whether to save it, etc,
1774                if the buffer has been modified.
1775  * \li Syntax: buffer-close
1776  * \endvar
1777  */
1778                 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
1779 /*!
1780  * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
1781  * \li Action: Exports the current buffer (document) to the given format.
1782  * \li Syntax: buffer-export <FORMAT>
1783  * \li Params: <FORMAT> is either "custom" or one of the formats which you
1784                         can find in Tools->Preferences->File formats->Format.
1785                         Usual format you will enter is "pdf2" (pdflatex),
1786                         "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
1787                         In case of "custom" you will be asked for a format you
1788                         want to start from and for the command that you want to
1789                         apply to this format. Internally the control is then passed
1790                         to #LFUN_BUFFER_EXPORT_CUSTOM.
1791  * \li Origin: Lgb, 29 Jul 1997
1792  * \endvar
1793  */
1794                 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
1795 /*!
1796  * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
1797  * \li Action: Exports the current buffer (document) from the given format using
1798                the given command on it.
1799  * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
1800  * \li Params: <FORMAT> format to start from (LyX will care to produce such
1801                         intermediate file).\n
1802                <COMMAND> this command will be launched on the file. Note that you can
1803                use "$$FName" string to qualify the intermediate file.
1804  * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
1805  * \li Origin: leeming, 27 Mar 2004
1806  * \endvar
1807  */
1808                 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
1809 /*!
1810  * \var lyx::FuncCode lyx::LFUN_BUFFER_PRINT
1811  * \li Action: Prints the current document.
1812  * \li Notion: Many settings can be given via the preferences dialog.
1813  * \li Syntax: buffer-print <TARGET> <TARGET-NAME> <COMMAND>
1814  * \li Params: <TARGET> is either "printer" or "file".\n
1815                <TARGER-NAME> is either "default" or file name or printer name.\n
1816                <COMMAND> command ensuring the printing job.
1817  * \li Sample: buffer-print file "/trash/newfile1.ps" "dvips"
1818  * \li Origin: leeming, 28 Mar 2004
1819  * \endvar
1820  */
1821                 { LFUN_BUFFER_PRINT, "buffer-print", ReadOnly, Buffer },
1822 /*!
1823  * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
1824  * \li Action: Import a given file as a lyx document.
1825  * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
1826                defined convertors in preferences. Look into File->Import menu to get
1827                an idea of the currently active import formats.
1828  * \li Syntax: buffer-import <FORMAT> [<FILE>]
1829  * \li Origin: Asger, 24 Jul 1998
1830  * \endvar
1831  */
1832                 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
1833 /*!
1834  * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
1835  * \li Action: Creates a new buffer (that is, document).
1836  * \li Notion: Implicit path can be set in Preferences dialog.
1837  * \li Syntax: buffer-new [<FILE>]
1838  * \li Params: <FILE>: filename of created file with absolute path.
1839  * \endvar
1840  */
1841                 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
1842 /*!
1843  * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
1844  * \li Action: Creates a new buffer (that is, document) from a template.
1845  * \li Notion: Path for new files and templates can be set in Preferences dialog.
1846                Template will be asked for via Open-dialog.
1847  * \li Syntax: buffer-new-template [<FILE>]
1848  * \li Params: <FILE>: filename of created file with absolute path.
1849  * \endvar
1850  */
1851                 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
1852 /*!
1853  * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
1854  * \li Action: Reverts opened document.
1855  * \li Syntax: buffer-reload
1856  * \li Origin: Asger, 2 Feb 1997
1857  * \endvar
1858  */
1859                 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
1860 /*!
1861  * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
1862  * \li Action: Switch to the given buffer.
1863  * \li Notion: This is useful also in case you need simultaneously more views of the edited
1864                document in different LyX windows.
1865  * \li Syntax: buffer-new-template <BUFFER>
1866  * \li Params: <BUFFER>: already opened document which is to be shown.
1867  * \endvar
1868  */
1869                 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
1870 /*!
1871  * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
1872  * \li Action: Toggle editing mode of the current document between read/write and read-only.
1873  * \li Syntax: buffer-toggle-read-only
1874  * \li Origin: Lgb, 27 May 1997
1875  * \endvar
1876  */
1877                 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
1878 /*!
1879  * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
1880  * \li Action: Displays current buffer in chosen format.
1881  * \li Notion: Displays the contents of the current buffer in the chosen
1882                format, for example, PDF or DVI. This runs the necessary
1883                converter, calls the defined viewer, and so forth.
1884  * \li Syntax: buffer-view <FORMAT>
1885  * \li Params: <FORMAT>: The format to display, where this is one of the
1886                          formats defined (in the current GUI) in the
1887                          Tools>Preferences>File Formats dialog.
1888  * \endvar
1889  */
1890                 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
1891 /*!
1892  * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
1893  * \li Action: Exports the current document and put the result into the
1894                temporary directory.
1895  * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
1896                the output will be rewriten - updated. This is useful in case your viewer
1897                is able to detect such changes (e.g. ghostview for postscript).
1898  * \li Syntax: buffer-update <FORMAT>
1899  * \li Params: <FORMAT>: The format to display, where this is one of the
1900                          formats defined (in the current GUI) in the
1901                          Tools>Preferences>File Formats dialog.
1902  * \li Origin: Dekel, 5 Aug 2000
1903  * \endvar
1904  */
1905                 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
1906
1907 /*!
1908  * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
1909  * \li Action: Saves the current buffer.
1910  * \li Notion: Saves the current buffer to disk, using the filename that
1911                is already associated with the buffer, asking for one if
1912                none is yet assigned.
1913  * \li Syntax: buffer-write
1914  * \endvar
1915  */
1916                 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
1917 /*!
1918  * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
1919  * \li Action: Rename and save current buffer.
1920  * \li Syntax: buffer-write-as <FILENAME>
1921  * \li Params: <FILENAME>: New name of the buffer/file. A relative path
1922                is with respect to the original location of the buffer/file.
1923  * \endvar
1924  */
1925                 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
1926 /*!
1927  * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
1928  * \li Action: Save all changed documents.
1929  * \li Syntax: buffer-write-all
1930  * \li Origin: rgh, gpothier 6 Aug 2007
1931  * \endvar
1932  */
1933                 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
1934 /*!
1935  * \var lyx::FuncCode lyx::LFUN_BUFFER_NEXT
1936  * \li Action: Switch to the next opened document.
1937  * \li Notion: Note that this does not necessarily mean next in tabbar
1938                (for full list see View menu).
1939  * \li Syntax: buffer-next
1940  * \endvar
1941  */
1942                 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
1943 /*!
1944  * \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS
1945  * \li Action: Switch to the previous opened document.
1946  * \li Syntax: buffer-previous
1947  * \endvar
1948  */
1949                 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
1950 /*!
1951  * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
1952  * \li Action: When run from a child document, this updates (exports) document built
1953                 from the master buffer. If a master is not found, it updates the
1954                 current buffer.
1955  * \li Syntax: master-buffer-update
1956  * \li Author: Tommaso, 20 Sep 2007
1957  * \endvar
1958  */
1959                 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
1960 /*!
1961  * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
1962  * \li Action: When run from a child document, this command shows a preview built
1963                from the master buffer. If a master is not found, it previews the
1964                current buffer.
1965  * \li Syntax: master-buffer-view
1966  * \li Author: Tommaso, 20 Sep 2007
1967  * \endvar
1968  */
1969                 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
1970 /*!
1971  * \var lyx::FuncCode lyx::LFUN_BUFFER_LANGUAGE
1972  * \li Action: Set language of the current document.
1973  * \li Syntax: buffer-language <LANG>
1974  * \li Params: <LANG>: language name. See lib/languages for list.
1975  * \li Author: leeming, 30 Mar 2004
1976  * \endvar
1977  */
1978                 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
1979 /*!
1980  * \var lyx::FuncCode lyx::LFUN_BUFFER_SAVE_AS_DEFAULT
1981  * \li Action: Save the current document settings as default.
1982  * \li Notion: The file will will be saved into ~/.lyx/templates/defaults.lyx .
1983  * \li Syntax: buffer-save-as-default [<ARGS>]
1984  * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
1985                        you can find in document header of usual .lyx file.
1986  * \li Author: leeming, 30 Mar 2004
1987  * \endvar
1988  */
1989                 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
1990 /*!
1991  * \var lyx::FuncCode lyx::LFUN_BUFFER_PARAMS_APPLY
1992  * \li Action: Apply the given settings to the current document.
1993  * \li Syntax: buffer-params-apply [<ARGS>]
1994  * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
1995                        you can find in document header of usual .lyx file.
1996  * \li Author: leeming, 30 Mar 2004
1997  * \endvar
1998  */
1999                 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", Noop, Buffer },
2000
2001 /*!
2002  * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
2003  * \li Action: Inserts another LyX file.
2004  * \li Syntax: file-insert [<FILE>]
2005  * \li Params: <FILE>: Filename to be inserted.
2006  * \endvar
2007  */
2008                 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
2009 /*!
2010  * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
2011  * \li Action: Inserts plain text file.
2012  * \li Syntax: file-insert-plaintext [<FILE>]
2013  * \li Params: <FILE>: Filename to be inserted.
2014  * \li Origin: CFO-G, 19 Nov 1997
2015  * \endvar
2016  */
2017                 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
2018 /*!
2019  * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
2020  * \li Action: Inserts plain text file as paragraph (i.e. join lines).
2021  * \li Syntax: file-insert-plaintext-para [<FILE>]
2022  * \li Params: <FILE>: Filename to be inserted.
2023  * \li Origin: Levon, 14 Feb 2001
2024  * \endvar
2025  */
2026                 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
2027 /*!
2028  * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
2029  * \li Action: Open LyX document.
2030  * \li Syntax: file-open [<FILE>]
2031  * \li Params: <FILE>: Filename to be opened.
2032  * \endvar
2033  */
2034                 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
2035
2036 /*!
2037  * \var lyx::FuncCode lyx::LFUN_CALL
2038  * \li Action: Executes a command defined in a .def file.
2039  * \li Notion: The definitions are by default read from lib/commands/default.def.\n
2040                A .def file allows to define a command with \\define "<NAME>" "<LFUN>"
2041                where <NAME> is the name of the new command and <LFUN> is the lfun code
2042                to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
2043                \\def_file "FileName" allows to include another .def file. \n
2044                This is particularly useful in connection with toolbar buttons:
2045                Since the name of the button image for this lfun is 
2046                lib/images/commands/<NAME>.png this is the way to assign an image
2047                to a complex command-sequence.
2048  * \li Syntax: call <NAME>
2049  * \li Params: <NAME>: Name of the command that must be called.
2050  * \li Origin: broider, 2 Oct 2007
2051  * \endvar
2052  */
2053                 { LFUN_CALL, "call", NoBuffer, System },
2054 /*!
2055  * \var lyx::FuncCode lyx::LFUN_META_PREFIX
2056  * \li Action: Simulate halting Meta key (Alt key on PCs).
2057  * \li Notion: Used for buffer editation not for GUI control.
2058  * \li Syntax: meta-prefix
2059  * \endvar
2060  */
2061                 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
2062 /*!
2063  * \var lyx::FuncCode lyx::LFUN_CANCEL
2064  * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
2065  * \li Syntax: cancel
2066  * \endvar
2067  */
2068                 { LFUN_CANCEL, "cancel", NoBuffer, System },
2069
2070 /*!
2071  * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
2072  * \li Action: Opens the minibuffer toolbar so that the user can type in there.
2073  * \li Notion: Usually bound to M-x shortcut.
2074  * \li Syntax: command-execute
2075  * \endvar
2076  */
2077                 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
2078                 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
2079 /*!
2080  * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
2081  * \li Action: Run more commands (LFUN and its parameters) in a sequence.
2082  * \li Syntax: command-sequence <CMDS>
2083  * \li Params: <CMDS>: Sequence of commands separated by semicolons.
2084  * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
2085  * \li Origin: Andre', 11 Nov 1999
2086  * \endvar
2087  */
2088                 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
2089 /*!
2090  * \var lyx::FuncCode lyx::LFUN_MESSAGE
2091  * \li Action: Shows message in statusbar (for script purposes).
2092  * \li Syntax: message <STRING>
2093  * \li Origin: Lgb, 8 Apr 2001
2094  * \endvar
2095  */
2096                 { LFUN_MESSAGE, "message", NoBuffer, System },
2097 /*!
2098  * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
2099  * \li Action: Save user preferences.
2100  * \li Syntax: preferences-save
2101  * \li Origin: Lgb, 27 Nov 1999
2102  * \endvar
2103  */
2104                 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
2105 /*!
2106  * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
2107  * \li Action: Reconfigure the automatic settings.
2108  * \li Syntax: reconfigure
2109  * \li Origin: Asger, 14 Feb 1997
2110  * \endvar
2111  */
2112                 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
2113 /*!
2114  * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
2115  * \li Action: Apply the given settings to user preferences.
2116  * \li Syntax: lyxrc-apply <SETTINGS>
2117  * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
2118                            to get an idea which commands to use and their syntax.
2119                            #lyx::LyXRC::LyXRCTags has the list of possible commands.
2120  * \endvar
2121  */
2122                 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
2123 /*!
2124  * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
2125  * \li Action: Determine whether keep cursor inside the editing window regardless
2126                the scrollbar movement.
2127  * \li Syntax: toggle-cursor-follows-scrollbar
2128  * \li Origin: ARRae, 2 Dec 1997
2129  * \endvar
2130  */
2131                 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
2132 /*!
2133  * \var lyx::FuncCode lyx::LFUN_SET_COLOR
2134  * \li Action: Set the given LyX color to the color defined by the X11 name given.
2135  * \li Notion: A new color entry is created if the color is unknown.
2136                Color names can be stored as a part of user settings.
2137  * \li Syntax: set-color <LYX_NAME> <X11_NAME>
2138  * \li Origin: SLior, 11 Jun 2000
2139  * \endvar
2140  */
2141                 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
2142 /*!
2143  * \var lyx::FuncCode lyx::LFUN_STATISTICS
2144  * \li Action: Count the statistics (number of words and characters)
2145                in the document or in the given selection.
2146  * \li Notion: Note that this function gives the number of words/chars written,
2147                not the number of characters which will be typeset.
2148  * \li Syntax: statistics
2149  * \li Origin: lasgouttes, Jan 27 2004; ps, Jan 8 2008
2150  * \endvar
2151  */
2152                 { LFUN_STATISTICS, "statistics", ReadOnly, System },
2153 /*!
2154  * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
2155  * \li Action: Show the inline completion at the cursor position.
2156  * \li Syntax: completion-inline
2157  * \li Origin: sts, Feb 19 2008
2158  * \endvar
2159  */
2160                 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
2161 /*!
2162  * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
2163  * \li Action: Show the completion popup at the cursor position.
2164  * \li Syntax: completion-popup
2165  * \li Origin: sts, Feb 19 2008
2166  * \endvar
2167  */
2168                 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
2169 /*!
2170  * \var lyx::FuncCode lyx::LFUN_COMPLETION_COMPLETE
2171  * \li Action: Try to complete the word or command at the cursor position.
2172  * \li Syntax: completion-complete
2173  * \li Origin: sts, Feb 19 2008
2174  * \endvar
2175  */
2176                 { LFUN_COMPLETION_COMPLETE, "complete", SingleParUpdate, Edit },
2177
2178                 { LFUN_NOACTION, "", Noop, Hidden }
2179 #ifndef DOXYGEN_SHOULD_SKIP_THIS
2180         };
2181
2182         for (int i = 0; items[i].action != LFUN_NOACTION; ++i) {
2183                 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
2184         }
2185
2186         init = true;
2187 }
2188 #endif
2189
2190 LyXAction::LyXAction()
2191 {
2192         init();
2193 }
2194
2195
2196 // Returns an action tag from a string.
2197 FuncRequest LyXAction::lookupFunc(string const & func) const
2198 {
2199         string const func2 = trim(func);
2200
2201         if (func2.empty()) {
2202                 return FuncRequest(LFUN_NOACTION);
2203         }
2204
2205         string cmd;
2206         string const arg = split(func2, cmd, ' ');
2207
2208         func_map::const_iterator fit = lyx_func_map.find(cmd);
2209
2210         return fit != lyx_func_map.end() ? FuncRequest(fit->second, arg) : FuncRequest(LFUN_UNKNOWN_ACTION);
2211 }
2212
2213
2214 string const LyXAction::getActionName(FuncCode action) const
2215 {
2216         info_map::const_iterator const it = lyx_info_map.find(action);
2217         return it != lyx_info_map.end() ? it->second.name : string();
2218 }
2219
2220
2221 LyXAction::func_type const LyXAction::getActionType(FuncCode action) const
2222 {
2223         info_map::const_iterator const it = lyx_info_map.find(action);
2224         return it != lyx_info_map.end() ? it->second.type : Hidden;
2225 }
2226
2227
2228 bool LyXAction::funcHasFlag(FuncCode action,
2229                             LyXAction::func_attrib flag) const
2230 {
2231         info_map::const_iterator ici = lyx_info_map.find(action);
2232
2233         if (ici == lyx_info_map.end()) {
2234                 LYXERR0("action: " << action << " is not known.");
2235                 LASSERT(false, /**/);
2236         }
2237
2238         return ici->second.attrib & flag;
2239 }
2240
2241
2242 LyXAction::const_func_iterator LyXAction::func_begin() const
2243 {
2244         return lyx_func_map.begin();
2245 }
2246
2247
2248 LyXAction::const_func_iterator LyXAction::func_end() const
2249 {
2250         return lyx_func_map.end();
2251 }
2252
2253
2254 } // namespace lyx