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