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