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