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