]> git.lyx.org Git - lyx.git/blob - src/LyXAction.cpp
Add support for MyThes (i.e., OpenOffice thesauri).
[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>]
1489  * \li Params: <TYPE>: negative spaces: !|negmedspace|negthickspace \n
1490                        positive spaces: ,|:|;|quad|qquad \n
1491                        "," used by default.
1492  * \li Origin: Andre, 25 Jul 2001; sanda, 16 Jun 2008
1493  * \endvar
1494  */
1495                 { LFUN_MATH_SPACE, "math-space", Noop, Math },
1496 /*!
1497  * \var lyx::FuncCode lyx::LFUN_MATH_MATRIX
1498  * \li Action: Inserts a matrix.
1499  * \li Syntax: math-matrix <COLS> <ROWS> [<ALIGN>]
1500  * \li Params: <ALIGN>: Alignment is a word composed of the vertical alignment
1501                         (b, c or t) (i.e. 1 char) and the horizontal alignments 
1502                         (l, c or r) (i.e. <COL> chars).
1503  * \li Sample: math-matrix 3 3 bccc
1504  * \endvar
1505  */
1506                 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
1507 /*!
1508  * \var lyx::FuncCode lyx::LFUN_MATH_MODE
1509  * \li Action: In text mode enters math mode (i.e. puts math insets on the current
1510                cursor position), in math mode enters text mode inside math expression.
1511  * \li Notion: If there is some selected text, it puts the text inside created math box.
1512  * \li Syntax: math-mode [<ARG>]
1513  * \li Params: <ARG>: eventual argument (LaTeX code) is passed to #LFUN_MATH_INSERT .
1514  * \li Origin: Alejandro, 4 Jun 1996
1515  * \endvar
1516  */
1517                 { LFUN_MATH_MODE, "math-mode", Noop, Math },
1518 /*!
1519  * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
1520  * \li Action: Toggles numbering of the current formula line.
1521  * \li Notion: Must be in display formula mode.
1522  * \li Syntax: math-number-line-toggle
1523  * \li Origin: Alejandro, 18 Jun 1996
1524  * \endvar
1525  */
1526                 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
1527 /*!
1528  * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
1529  * \li Action: Toggles numbering/labeling of the current formula.
1530  * \li Notion: Must be in display formula mode.
1531  * \li Syntax: math-number-toggle
1532  * \li Origin: Alejandro, 4 Jun 1996
1533  * \endvar
1534  */
1535                 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
1536 /*!
1537  * \var lyx::FuncCode lyx::LFUN_MATH_EXTERN
1538  * \li Action: Calls external program and passes the current expression/equation
1539                as an argument for the calculation in the format appropriate to the
1540                given language.
1541  * \li Notion: Selection can be used to determine the input for the external program.
1542  * \li Syntax: math-extern <LANG> [<COMMAND>]
1543  * \li Params: <LANG>: octave|maxima|maple|mathematica|script \n
1544                        where "script" stands fot the external script (normalized
1545                        expression will be passed)
1546  * \li Origin: Andre, 24 Apr 2001
1547  * \li Sample: math-extern maple simplify
1548  * \endvar
1549  */
1550                 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
1551 /*!
1552  * \var lyx::FuncCode lyx::LFUN_MATH_SIZE
1553  * \li Action: Changes arbitrarily the size used by math fonts inside a context.
1554  * \li Notion: Provides an interface to the LaTeX math mode font size commands.
1555  * \li Syntax: math-size <STYLE>
1556  * \li Params: <STYLE>: \displaystyle|\textstyle|\scriptstyle|\scriptscriptstyle
1557  * \li Origin: Alejandro, 15 Aug 1996; ps, 14 Jun 2008
1558  * \endvar
1559  */
1560                 { LFUN_MATH_SIZE, "math-size", Noop, Math },
1561 /*!
1562  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
1563  * \li Action: Unfold a Math Macro.
1564  * \li Notion: Unfold the Math Macro the cursor is in, i.e.
1565                display it as \foo.
1566  * \li Syntax: math-macro-unfold
1567  * \li Origin: sts, 06 January 2008
1568  * \endvar
1569  */
1570                 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
1571 /*!
1572  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
1573  * \li Action: Fold a Math Macro.
1574  * \li Notion: Fold the Math Macro the cursor is in if it was
1575                unfolded, i.e. displayed as \foo before.
1576  * \li Syntax: math-macro-fold
1577  * \li Origin: sts, 06 January 2008
1578  * \endvar
1579  */
1580                 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
1581 /*!
1582  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
1583  * \li Action: Add a parameter.
1584  * \li Notion: Add a parameter to a Math Macro.
1585  * \li Params: <NUM>: The number of the parameter behind which the new one
1586                will be added (1 for the first, i.e. use 0 for add a
1587                parameter at the left), defaults to the last one.
1588  * \li Syntax: math-macro-add-param <NUM>
1589  * \li Origin: sts, 06 January 2008
1590  * \endvar
1591  */
1592                 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
1593 /*!
1594  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
1595  * \li Action: Remove the last parameter.
1596  * \li Notion: Remove the last parameter of a Math Macro and
1597                remove its value in all instances of the macro
1598                in the buffer.
1599  * \li Params: <NUM>: The number of the parameter to be deleted (1 for
1600                the first), defaults to the last one.
1601  * \li Syntax: math-macro-remove-param <NUM>
1602  * \li Origin: sts, 06 January 2008
1603  * \endvar
1604  */
1605                 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
1606 /*!
1607  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
1608  * \li Action: Append a greedy parameter.
1609  * \li Notion: Append a greedy parameter to a Math Macro which
1610                eats the following mathed cell in every instance of
1611                the macro in the buffer.
1612  * \li Syntax: math-macro-append-greedy-param
1613  * \li Origin: sts, 06 January 2008
1614  * \endvar
1615  */
1616                 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
1617 /*!
1618  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
1619  * \li Action: Remove a greedy parameter.
1620  * \li Notion: Remove a greedy parameter of a Math Macro and spit
1621                out the values of it in every instance of the macro
1622                in the buffer. If it is an optional parameter the [valud]
1623                format is used.
1624  * \li Syntax: math-macro-remove-greedy-param
1625  * \li Origin: sts, 06 January 2008
1626  * \endvar
1627  */
1628                 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
1629 /*!
1630  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
1631  * \li Action: Make a parameter optional.
1632  * \li Notion: Turn the first non-optional parameter of a Math Macro
1633                into an optional parameter with a default value.
1634  * \li Syntax: math-macro-make-optional
1635  * \li Origin: sts, 06 January 2008
1636  * \endvar
1637  */
1638                 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
1639 /*!
1640  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
1641  * \li Action: Make a parameter non-optional.
1642  * \li Notion: Turn the last optional parameter of a Math Macro
1643                into a non-optional parameter. The default value is
1644                remembered to be reused later if the user changes his mind.
1645  * \li Syntax: math-macro-make-nonoptional
1646  * \li Origin: sts, 06 January 2008
1647  * \endvar
1648  */
1649                 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
1650 /*!
1651  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
1652  * \li Action: Add an optional parameter.
1653  * \li Notion: Insert an optional parameter just behind the
1654                already existing optional parameters.
1655  * \li Syntax: math-macro-add-optional-param
1656  * \li Origin: sts, 06 January 2008
1657  * \endvar
1658  */
1659                 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
1660 /*!
1661  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
1662  * \li Action: Remove the last optional parameter.
1663  * \li Notion: Remove the last optional parameter of a Math Macro and
1664                remove it in all the instances of the macro in the buffer.
1665  * \li Syntax: math-macro-remove-optional-param
1666  * \li Origin: sts, 06 January 2008
1667  * \endvar
1668  */
1669                 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
1670 /*!
1671  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
1672  * \li Action: Add a greedy optional parameter.
1673  * \li Notion: Add a greedy optional parameter which eats the value
1674                from the following cells in mathed which are in the [value]
1675                format.
1676  * \li Syntax: math-macro-add-greedy-optional-param
1677  * \li Origin: sts, 06 January 2008
1678  * \endvar
1679  */
1680                 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
1681 /*!
1682  * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
1683  * \li Action: Only active in Math Macro definition.
1684  * \li Notion: Dummy function which is only active in a Math Macro definition.
1685                It's used to toggle the Math Macro toolbar if the cursor moves
1686                into a Math Macro definition.
1687  * \li Syntax: in-mathmacrotemplate
1688  * \li Origin: sts, 06 January 2008
1689  * \endvar
1690  */
1691                 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
1692
1693 /*!
1694  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
1695  * \li Action: Moves the current paragraph downwards in the document.
1696  * \li Syntax: paragraph-move-down
1697  * \li Origin: Edwin, 8 Apr 2006
1698  * \endvar
1699  */
1700                 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
1701 /*!
1702  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
1703  * \li Action: Moves the current paragraph upwards in the document.
1704  * \li Syntax: paragraph-move-up
1705  * \li Origin: Edwin, 8 Apr 2006
1706  * \endvar
1707  */
1708                 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
1709
1710 /*!
1711  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP
1712  * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1713                in upward direction.
1714  * \li Syntax: paragraph-up
1715  * \li Origin: Asger, 1 Oct 1996
1716  * \endvar
1717  */
1718                 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
1719 /*!
1720  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP_SELECT
1721  * \li Action: Move the cursor and select the text to the next paragraph (or
1722                begining of the current one) in upward direction.
1723  * \li Syntax: paragraph-up-select
1724  * \li Origin: Asger, 1 Oct 1996
1725  * \endvar
1726  */
1727                 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
1728 /*!
1729  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN
1730  * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1731                in downward direction.
1732  * \li Syntax: paragraph-down
1733  * \li Origin: Asger, 1 Oct 1996
1734  * \endvar
1735  */
1736                 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
1737 /*!
1738  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN_SELECT
1739  * \li Action: Move the cursor and select the text to the next paragraph (or
1740                begining of the current one) in downward direction.
1741  * \li Syntax: paragraph-down-select
1742  * \li Origin: Asger, 1 Oct 1996
1743  * \endvar
1744  */
1745                 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
1746 /*!
1747  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
1748  * \li Action: Jump to a paragraph given by its id number and optionally the
1749                desired position within the paragraph.
1750  * \li Notion: Note that id number of paragraph is not the sequential number of paragraph
1751                seen on the screen. Moreover the id is unique for all opened buffers (documents).
1752  * \li Syntax: paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
1753  * \li Params: <PAR_ID_NUMBER>:  paragraph id \n
1754                <POSITION_IN_PAR>: desired position within the paragraph
1755  * \li Origin: Dekel, 26 Aug 2000
1756  * \endvar
1757  */
1758                 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly, Edit },
1759 /*!
1760  * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1761  * \li Action: Breaks the current paragraph at the current location.
1762  * \li Syntax: break-paragraph
1763  * \endvar
1764  */
1765                 { LFUN_PARAGRAPH_SPACING, "paragraph-spacing", Noop, Edit },
1766 /*!
1767  * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1768  * \li Action: Breaks the current paragraph at the current location.
1769  * \li Notion: Removes the selection.
1770  * \li Syntax: break-paragraph [<LAYOUT>]
1771  * \li Params: <LAYOUT>: "inverse" - decreases depth by one (or change layout
1772                          to default layout) when the cursor is at the end of
1773                          the line.
1774  * \endvar
1775  */
1776                 { LFUN_BREAK_PARAGRAPH, "break-paragraph", Noop, Edit },
1777 /*!
1778  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
1779  * \li Action: Change paragraph settings.
1780  * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
1781                This function only modifies, and does not override, existing settings.
1782                Note that the "leftindent" indent setting is deprecated.
1783  * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
1784  * \li Params: <INDENT>:  \\noindent|\\indent|\\indent-toggle|\\leftindent LENGTH\n
1785                <SPACING>: \\paragraph_spacing default|single|onehalf|double|other\n
1786                <ALIGN>:   \\align block|left|right|center|default\n
1787                <OTHERS>:  \\labelwidthstring WIDTH|\\start_of_appendix\n
1788  * \li Origin: rgh, Aug 15 2007
1789  * \endvar
1790  */
1791                 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
1792 /*!
1793  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
1794  * \li Action: Change paragraph settings.
1795  * \li Notion: Overwrite all nonspecified settings to the default ones.
1796                Use paragraph-params lfun if you don't want to overwrite others settings.
1797  * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
1798  * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
1799  * \li Origin: leeming, 30 Mar 2004
1800  * \endvar
1801  */
1802                 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
1803 /*!
1804  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UPDATE
1805  * \li Action: Updates the values inside the paragraph dialog from the paragraph.
1806  * \li Notion: This is internal LFUN, not to be used by users. Called internally
1807                by #LFUN_DIALOG_UPDATE.
1808  * \li Origin: leeming, 13 Mar 2003
1809  * \endvar
1810  */
1811                 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
1812
1813 /*!
1814  * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
1815  * \li Action: Move the current group in the upward direction in the
1816                structure of the document.
1817  * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1818                the whole substructure of the group.
1819  * \li Syntax: outline-up
1820  * \li Origin: Vermeer, 23 Mar 2006
1821  * \endvar
1822  */
1823                 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
1824 /*!
1825  * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
1826  * \li Action: Move the current group in the downward direction in the
1827                structure of the document.
1828  * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1829                the whole substructure of the group.
1830  * \li Syntax: outline-down
1831  * \li Origin: Vermeer, 23 Mar 2006
1832  * \endvar
1833  */
1834                 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
1835 /*!
1836  * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
1837  * \li Action: Moves the current group in the downward direction in the
1838                hierarchy of the document structure.
1839  * \li Notion: Part -> Chapter -> Section -> etc.
1840  * \li Syntax: outline-in
1841  * \li Origin: Vermeer, 23 Mar 2006
1842  * \endvar
1843  */
1844                 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
1845 /*!
1846  * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
1847  * \li Action: Moves the current group in the upward direction in the
1848                hierarchy of the document structure.
1849  * \li Notion: Part <- Chapter <- Section <- etc.
1850  * \li Syntax: outline-out
1851  * \li Origin: Vermeer, 23 Mar 2006
1852  * \endvar
1853  */
1854                 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
1855 /*!
1856  * \var lyx::FuncCode lyx::LFUN_INSET_EDIT
1857  * \li Action: Edit the inset at cursor with an external application,
1858  *             if one is attributed.
1859  * \li Syntax: inset-edit [<INSET_PARAMS>]
1860  * \li Params: <INSET_PARAMS>: Parameters for the inset. \n
1861                                Currently only the filename will be considered.
1862  * \li Origin: JSpitzm, 27 Apr 2006
1863  * \endvar
1864  */
1865                 { LFUN_INSET_EDIT, "inset-edit", ReadOnly, Edit },
1866
1867 /*!
1868  * \var lyx::FuncCode lyx::LFUN_TABULAR_INSERT
1869  * \li Action: Inserts table into the document.
1870  * \li Syntax: tabular-insert [<ROWS> <COLUMNS>]
1871  * \li Params: In case no arguments are given show insert dialog.
1872  * \li Origin: Jug, 12 Apr 2000
1873  * \endvar
1874  */
1875                 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
1876 /*!
1877  * \var lyx::FuncCode lyx::LFUN_TABULAR_FEATURE
1878  * \li Action: Sets various features to the table/cell on the current cursor position.
1879  * \li Notion: Various math-environment features are handled here as well, e.g.
1880                add-vline-left/right for Grid/Cases environment
1881  * \li Syntax: tabular-feature <FEATURE> [<ARG>]
1882  * \li Params: <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|copy-column|
1883                        toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
1884                        align-left|align-right|align-center|align-block|valign-top|valign-bottom|
1885                        valign-middle|m-align-left|m-align-right|m-align-center|m-valign-top|
1886                        m-valign-bottom|m-valign-middle|multicolumn|set-all-lines|unset-all-lines|
1887                        set-longtabular|unset-longtabular|set-pwidth|set-mpwidth|
1888                        set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|
1889                        set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|
1890                        unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|
1891                        set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
1892                        set-special-column|set-special-multi|set-booktabs|unset-booktabs|
1893                        set-top-space|set-bottom-space|set-interline-space|set-border-lines \n
1894                 <ARG>: additional argument for some commands, use debug mode to explore its values.
1895  * \li Origin: Jug, 28 Jul 2000
1896  * \endvar
1897  */
1898                 { LFUN_TABULAR_FEATURE, "tabular-feature", Noop, Edit },
1899 /*!
1900  * \var lyx::FuncCode lyx::LFUN_CELL_BACKWARD
1901  * \li Action: Moves the cursor to the previous cell inside the table.
1902  * \li Syntax: cell-backward
1903  * \li Origin: Jug, 22 May 2000
1904  * \endvar
1905  */
1906                 { LFUN_CELL_BACKWARD, "cell-backward", Noop, Edit },
1907 /*!
1908  * \var lyx::FuncCode lyx::LFUN_CELL_FORWARD
1909  * \li Action: Moves the cursor to the next cell inside the table.
1910  * \li Syntax: cell-forward
1911  * \endvar
1912  */
1913                 { LFUN_CELL_FORWARD, "cell-forward", Noop, Edit },
1914 /*!
1915  * \var lyx::FuncCode lyx::LFUN_CELL_SPLIT
1916  * \li Action: Splits cell and shifts right part to the next cell (inside the math grid).
1917  * \li Syntax: cell-split
1918  * \li Origin: Ale, 15 May 1997
1919  * \endvar
1920  */
1921                 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
1922
1923 /*!
1924  * \var lyx::FuncCode lyx::LFUN_VC_REGISTER
1925  * \li Action: Register the document as an file inside version control system (RCS, CVS).
1926  * \li Notion: File is registered inside cvs, svn or rcs repository acording to the existence
1927                of cvs/svn/rcs entries in the document's directory. \n
1928                See LyX Additional Features Manual (Version Control Chapter) for additional
1929                information.
1930  * \li Syntax: vc-register
1931  * \li Origin: Lgb, 1 Jul 1997
1932  * \endvar
1933  */
1934                 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
1935 /*!
1936  * \var lyx::FuncCode lyx::LFUN_VC_CHECK_IN
1937  * \li Action: Checks-in/commits the changes of the registered file to the repository.
1938  * \li Notion: In RCS case this also unlocks the file.
1939  * \li Syntax: vc-check-in
1940  * \li Origin: Lgb, 1 Jul 1997
1941  * \endvar
1942  */
1943                 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
1944 /*!
1945  * \var lyx::FuncCode lyx::LFUN_VC_CHECK_OUT
1946  * \li Action: Checks-out the document for edit (and locks it for RCS).
1947  * \li Notion: This is implemented only for RCS and SVN, not CVS.
1948  * \li Syntax: vc-check-out
1949  * \li Origin: Lgb, 1 Jul 1997
1950  * \endvar
1951  */
1952                 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
1953 /*!
1954  * \var lyx::FuncCode lyx::LFUN_VC_REVERT
1955  * \li Action: Reverts the document to the last check-in/commit in VCS.
1956  * \li Syntax: vc-revert
1957  * \li Origin: Lgb, 1 Jul 1997
1958  * \endvar
1959  */
1960                 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
1961 /*!
1962  * \var lyx::FuncCode lyx::LFUN_VC_UNDO_LAST
1963  * \li Action: Undo last check-in.
1964  * \li Notion: This is currently implemented only for RCS.
1965  * \li Syntax: vc-check-out
1966  * \li Origin: Lgb, 1 Jul 1997
1967  * \endvar
1968  */
1969                 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
1970
1971 /*!
1972  * \var lyx::FuncCode lyx::LFUN_CHANGES_TRACK
1973  * \li Action: Toggles change tracking to on/off.
1974  * \li Syntax: changes-track
1975  * \li Origin: levon, 1 Oct 2002
1976  * \endvar
1977  */
1978                 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
1979 /*!
1980  * \var lyx::FuncCode lyx::LFUN_CHANGES_OUTPUT
1981  * \li Action: Toggles showing of change tracking in typesetted output.
1982  * \li Syntax: changes-output
1983  * \li Origin: jspitzm, 21 Jan 2005
1984  * \endvar
1985  */
1986                 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
1987 /*!
1988  * \var lyx::FuncCode lyx::LFUN_CHANGE_NEXT
1989  * \li Action: Moves the cursor to the position of the next change
1990                of the change tracking records.
1991  * \li Syntax: change-next
1992  * \li Origin: schmitt, 4 Oct 2006
1993  * \endvar
1994  */
1995                 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
1996 /*!
1997  * \var lyx::FuncCode lyx::LFUN_CHANGES_MERGE
1998  * \li Action: Open change tracking dialog for merging and moves the cursor
1999                to the position of the next change.
2000  * \li Syntax: changes-merge
2001  * \li Origin: Levon, 16 Oct 2002
2002  * \endvar
2003  */
2004                 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
2005 /*!
2006  * \var lyx::FuncCode lyx::LFUN_CHANGE_ACCEPT
2007  * \li Action: Accepts tracked change inside the selection.
2008  * \li Syntax: change-accept
2009  * \li Origin: Levon, 16 Oct 2002
2010  * \endvar
2011  */
2012                 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
2013 /*!
2014  * \var lyx::FuncCode lyx::LFUN_CHANGE_REJECT
2015  * \li Action: Rejects tracked change inside the selection.
2016  * \li Syntax: change-accept
2017  * \li Origin: Levon, 16 Oct 2002
2018  * \endvar
2019  */
2020                 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
2021 /*!
2022  * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_ACCEPT
2023  * \li Action: Accepts all tracked changes in the document.
2024  * \li Syntax: all-changes-accept
2025  * \li Origin: Levon, 16 Oct 2002
2026  * \endvar
2027  */
2028                 { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
2029 /*!
2030  * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_REJECT
2031  * \li Action: Rejects all tracked changes in the document.
2032  * \li Notion: Reject does not work recursively; the user may have to repeat the operation.
2033  * \li Syntax: all-changes-reject
2034  * \li Origin: Levon, 16 Oct 2002
2035  * \endvar
2036  */
2037                 { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
2038
2039 /*!
2040  * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
2041  * \li Action: Apply data for an inset.
2042  * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
2043                be applied. This is either changed to #LFUN_INSET_MODIFY or
2044                #LFUN_INSET_INSERT depending on the context where it is called.
2045  * \li Syntax: inset-apply <ARGS>
2046  * \li Params: See #LFUN_INSET_INSERT .
2047  * \endvar
2048  */
2049                 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
2050 /*!
2051  * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE
2052  * \li Action: Dissolve the current inset into text.
2053  * \li Syntax: inset-dissolve [<INSET>]
2054  * \li Params: <INSET>: this can be used to make sure the right kind of inset
2055                         is dissolved. For example "dissolve" entry in the charstyles
2056                         sub-menu should only dissolve the charstyle inset, even if the
2057                         cursor is inside several nested insets of different type.\n
2058                         For values see #lyx::InsetLayout::lyxtype_ .
2059  * \li Origin: JSpitz, 7 Aug 2006
2060  * \endvar
2061  */
2062                 { LFUN_INSET_DISSOLVE, "inset-dissolve", Noop, Edit },
2063 /*!
2064  * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
2065  * \li Action: Insert new inset (type given by the parameters).
2066  * \li Syntax: inset-insert <INSET> <ARGS>
2067  * \li Params: <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics|
2068                          hyperlink|include|index|label|nomencl|vspace|ref|toc>\n
2069                <ARGS>: depends on the given inset. Use "lyx -dbg action" to
2070                        explore.
2071  * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
2072                where <label name> is the name of the referenced label and
2073                <Format> is one of the following: \n
2074                ref -- <reference> \n
2075                eqref -- (<reference>) \n
2076                pageref -- <page> \n
2077                vpageref -- on <page> \n
2078                vref -- <reference> on <page> \n
2079                prettyref -- Formatted reference
2080  * \endvar
2081  */
2082                 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
2083 /*!
2084  * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
2085  * \li Action: Modify existing inset.
2086  * \li Notion: Used for label, floats, listings, box, branch, external, wrap
2087                bibtex, ert, command, graphics, note, space, vspace, tabular,
2088                bibitem, inlude, ref insets.
2089  * \li Syntax: inset-modify <INSET> <ARGS>
2090  * \li Params: See #LFUN_INSET_INSERT for further details.
2091  * \endvar
2092  */
2093                 { LFUN_INSET_MODIFY, "", Noop, Hidden },
2094 /*!
2095  * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_MODIFY
2096  * \li Action: Modify the inset at cursor position, if there is one.
2097  * \li Notion: Used for label, floats, listings, box, branch, external, wrap
2098                bibtex, ert, command, graphics, note, space, vspace, tabular,
2099                bibitem, inlude, ref insets.
2100  * \li Syntax: next-inset-modify <INSET> <ARGS>
2101  * \li Syntax: next-inset-modify changetype <TYPE>
2102  * \li Params: See #LFUN_INSET_INSERT for further details.
2103  * \li Origin: JSpitzm, 23 Mar 2008
2104  * \endvar
2105  */
2106                 { LFUN_NEXT_INSET_MODIFY, "next-inset-modify", ReadOnly, Edit },
2107 /*!
2108  * \var lyx::FuncCode lyx::LFUN_INSET_DIALOG_UPDATE
2109  * \li Action: Updates the values inside the dialog from the inset.
2110  * \li Notion: This is internal LFUN, not to be used by users. Called internally
2111                by #LFUN_DIALOG_UPDATE
2112  * \li Params: <DIALOG-NAME>
2113  * \li Origin: leeming, 25 Feb 2003
2114  * \endvar
2115  */
2116                 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
2117 /*!
2118  * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
2119  * \li Action: Open the inset's properties dialog.
2120  * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
2121  * \li Syntax: inset-settings <INSET>
2122  * \li Params: <INSET>: <box|branch|ert|float|listings|note|tabular|wrap>
2123  * \endvar
2124  */
2125                 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly, Edit },
2126 /*!
2127  * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_TOGGLE
2128  * \li Action: Toggles the inset at cursor position. For collapsables, this means it will
2129                be (un-)collapsed, in case of other insets, the editing widget (dialog) will
2130                be entered. Also cf. #LFUN_INSET_SETTINGS.
2131  * \li Notion: Used for label, floats, listings, box, branch, external, wrap
2132                bibtex, ert, command, graphics, note, space, vspace, tabular,
2133                bibitem, inlude, ref insets.
2134  * \li Syntax: next-inset-toggle <ARG>
2135  * \li Params: <ARG>: these are passed as arguments to #LFUN_INSET_TOGGLE .
2136  * \li Origin: leeming, 30 Mar 2004
2137  * \endvar
2138  */
2139                 { LFUN_NEXT_INSET_TOGGLE, "next-inset-toggle", ReadOnly, Edit },
2140 /*!
2141  * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
2142  * \li Action: Toggles the collapsable inset we are currently in.
2143  * \li Syntax: inset-toggle [<ARG>]
2144  * \li Params: <ARG>: <open|close|toggle|assign>. \n
2145                open/close/toggle are for collapsable insets. close can be currently used
2146                by #LFUN_NEXT_INSET_TOGGLE. toggle is used when no argument is given.\n
2147                assign is for branch inset.
2148  * \li Origin: lasgouttes, 19 Jul 2001
2149  * \endvar
2150  */
2151                 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly, Hidden },
2152 /*!
2153  * \var lyx::FuncCode lyx::LFUN_ALL_INSETS_TOGGLE
2154  * \li Action: Toggles (open/closes) all collapsable insets (of a given type) in the document.
2155  * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
2156  * \li Syntax: all-insets-toggle <STATE> <INSET>
2157  * \li Params: <STATE>: <toggle|open|close> default: toggle \n
2158                <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all insets
2159  * \li Origin: leeming, 30 Mar 2004
2160  * \endvar
2161  */
2162                 { LFUN_ALL_INSETS_TOGGLE, "all-insets-toggle", ReadOnly, Edit },
2163 /*!
2164  * \var lyx::FuncCode lyx::LFUN_SET_GRAPHICS_GROUP
2165  * \li Action: Set the group for the graphics inset on the cursor position.
2166  * \li Syntax: set-graphics-group [<GROUP>]
2167  * \li Params: <GROUP>: Id for an existing group. In case the Id is an empty string,
2168                         the graphics inset is removed from the current group.
2169  * \li Origin: sanda, 6 May 2008
2170  * \endvar
2171  */
2172                 { LFUN_SET_GRAPHICS_GROUP, "set-graphics-group", Noop, Edit },
2173
2174 /*!
2175  * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
2176  * \li Action: Moves the cursor out of the current slice, going forward.
2177  * \li Notion: Cursor movement within an inset may be different than cursor
2178                movement in the surrounding text. This action should be called
2179                automatically by the cursor movement within the inset, when
2180                movement within the inset has ceased (reached the end of the
2181                last paragraph, for example), in order to move correctly
2182                back into the surrounding text.
2183  * \endvar
2184  */
2185                 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
2186 /*!
2187  * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
2188  * \li Action: Moves the cursor out of the current slice, going backwards.
2189  * \li Notion: See also #LFUN_FINISHED_FORWARD.
2190  * \endvar
2191  */
2192                 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
2193 /*!
2194  * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
2195  * \li Action: Moves the cursor out of the current slice, going right.
2196  * \li Notion: See also #LFUN_FINISHED_FORWARD
2197  * \endvar
2198  */
2199                 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
2200 /*!
2201  * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
2202  * \li Action: Moves the cursor out of the current slice, going left.
2203  * \li Notion: See also #LFUN_FINISHED_FORWARD.
2204  * \endvar
2205  */
2206                 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
2207
2208 /*!
2209  * \var lyx::FuncCode lyx::LFUN_LANGUAGE
2210  * \li Action: Set language from the current cursor position.
2211  * \li Syntax: language <LANG>
2212  * \li Params: <LANG>: Requested language. Look in lib/languages for
2213                        the list.
2214  * \li Origin: Dekel, 2 Mar 2000
2215  * \endvar
2216  */
2217                 { LFUN_LANGUAGE, "language", Noop, Edit },
2218
2219 /*!
2220  * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
2221  * \li Action: Goto a label.
2222  * \li Syntax: label-goto [<LABEL>]
2223  * \li Params: <LABEL>: Requested label. If no label is given and refernce
2224                         is on cursor position, Bookmark 0 is saved and
2225                         cursor moves to the position of referenced label.
2226  * \li Origin: Ale, 6 Aug 1997
2227  * \endvar
2228  */
2229                 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
2230 /*!
2231  * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT
2232  * \li Action: Inserts label to text or displayed formula.
2233  * \li Syntax: label-insert [<LABEL>]
2234  * \li Params: <LABEL>: Requested label. If no label is given dialog requesting
2235                         name will be opened.
2236  * \endvar
2237  */
2238                 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
2239 /*!
2240  * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
2241  * \li Action: Go to the next label or cross-reference.
2242  * \li Syntax: reference-next
2243  * \li Origin: Dekel, 14 Jan 2001
2244  * \endvar
2245  */
2246                 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
2247
2248 /*!
2249  * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
2250  * \li Action: Goto a bookmark.
2251  * \li Notion: Moves the cursor to the numbered bookmark, opening the file
2252                if necessary. Note that bookmarsk are saved per-session, not
2253                per file.
2254  * \li Syntax: bookmark-goto <NUMBER>
2255  * \li Params: <NUMBER>: the number of the bookmark to restore.
2256  * \li Origin: Dekel, 27 January 2001
2257  * \endvar
2258  */
2259                 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
2260 /*!
2261  * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
2262  * \li Action: Save a bookmark.
2263  * \li Notion: Saves a numbered bookmark to the sessions file. The number
2264                must be between 1 and 9, inclusive. Note that bookmarks are
2265                saved per-session, not per file.
2266  * \li Syntax: bookmark-save <NUMBER>
2267  * \li Params: <NUMBER>: the number of the bookmark to save.
2268  * \li Origin: Dekel, 27 January 2001
2269  * \endvar
2270  */
2271                 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
2272 /*!
2273  * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
2274  * \li Action: Clears the list of saved bookmarks.
2275  * \li Syntax: bookmark-clear
2276  * \li Origin: bpeng, 31 October 2006
2277  * \endvar
2278  */
2279                 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
2280
2281 /*!
2282  * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
2283  * \li Action: Open the given help file according to the language setting.
2284  * \li Syntax: help-open <FILE>[.lyx]
2285  * \li Params: <FILE>: any document from (/usr/share/)doc directory.
2286  * \li Origin: Jug, 27 Jun 1999
2287  * \endvar
2288  */
2289                 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
2290 /*!
2291  * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
2292  * \li Action: Terminates the current LyX instance.
2293  * \li Notion: Terminates the current LyX instance, asking whether to save
2294                modified documents, etc.
2295  * \li Syntax: lyx-quit
2296  * \endvar
2297  */
2298                 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
2299 /*!
2300  * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
2301  * \li Action: Toggles visibility of a given toolbar between on/off/auto.
2302  * \li Notion: Skiping "auto" when allowauto is false.
2303  * \li Syntax: toolbar-toggle <NAME> [allowauto]
2304  * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|
2305                        minibuffer|review|view/update|math_panels|vcs
2306  * \li Origin: Edwin, 21 May 2007
2307  * \endvar
2308  */
2309                 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
2310 /*!
2311  * \var lyx::FuncCode lyx::LFUN_MENU_OPEN
2312  * \li Action: Opens the menu given by its name.
2313  * \li Syntax: menu-open <NAME>
2314  * \li Params: <NAME>: menu name. See various .inc files in lib/ui for candidates.
2315  * \endvar
2316  */
2317                 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
2318 /*!
2319  * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
2320  * \li Action: Various UI visibility-toggling actions.
2321  * \li Syntax: ui-toggle <statusbar|menubar|frame|fullscreen>
2322  * \li Params: statusbar  : Toggle visibility of the statusbar.\n
2323                menubar    : Toggle visibility of the menubar.\n
2324                scrollbar  : Toggle visibility of the scrollbar.\n
2325                frame      : Toggle visibility of the frames around editing window.\n
2326                fullscreen : Toggle fullscreen mode. This also covers calling the
2327                             previous functions. However #LFUN_TOOLBAR_TOGGLE for the
2328                             custom tweaks of the toolbars should be used.
2329  * \li Origin: sanda, 9 Feb 2007
2330  * \endvar
2331  */
2332                 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
2333
2334 /*!
2335  * \var lyx::FuncCode lyx::WINDOW_NEW
2336  * \li Action: Creates new empty LyX window.
2337  * \li Notion: Already opened documents from the previous window can be found under View menu.
2338  * \li Syntax: window-new [<GEOMETRY>]
2339  * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently 
2340                            accepted only on Windows platform.
2341  * \li Origin: Abdel, 21 Oct 2006
2342  * \endvar
2343  */
2344                 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
2345 /*!
2346  * \var lyx::FuncCode lyx::LFUN_WINDOW_CLOSE
2347  * \li Action: Closes the current LyX window.
2348  * \li Syntax: window-close
2349  * \li Origin: Abdel, 23 Oct 2006
2350  * \endvar
2351  */
2352                 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
2353
2354 /*!
2355  * \var lyx::FuncCode lyx::LFUN_SPLIT_VIEW
2356  * \li Action: Creates another split view of current buffer.
2357  * \li Notion: All split views act in the same way indpendently.
2358  * \li Syntax: split-view <vertical|horizontal>
2359  * \li Params: horizontal : The work areas are laid out side by side.\n
2360                vertical   : The work areas laid out vertically.
2361  * \li Origin: Abdel, 20 Feb 2008
2362  * \endvar
2363  */
2364                 { LFUN_SPLIT_VIEW, "split-view", ReadOnly, Buffer },
2365
2366 /*!
2367  * \var lyx::FuncCode lyx::LFUN_CLOSE_TAB_GROUP
2368  * \li Action: Close the current tab group.
2369  * \li Notion: This only closes the work areas, not the buffer themselves.
2370                The still opened buffers can be visualized in another tab group.
2371  * \li Syntax: close-tab-group
2372  * \li Origin: Abdel, 21 Feb 2008
2373  * \endvar
2374  */
2375                 { LFUN_CLOSE_TAB_GROUP, "close-tab-group", ReadOnly, Buffer },
2376 /*!
2377  * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW
2378  * \li Action: Shows hidden dialog or create new one for a given function/inset settings etc.
2379  * \li Syntax: dialog-show <NAME> [<DATA>]
2380  * \li Params: <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|\n
2381                document|errorlist|ert|external|file|findreplace|float|graphics|\n
2382                include|index|info|nomenclature|label|log|mathdelimiter|mathmatrix|\n
2383                note|paragraph|prefs|print|ref|sendto|space|spellchecker|symbols|\n
2384                tabular|tabularcreate|thesaurus|texinfo|toc|href|view-source|vspace\n
2385                wrap|listings|<SPECIAL> \n
2386                <SPECIAL>: latexlog|vclog \n
2387                <DATA>: data, usually settings for the given dialog. Use debug mode for the
2388                        details.
2389  * \li Origin: leeming, 17 Jun 2003
2390  * \endvar
2391  */
2392                 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
2393 /*!
2394  * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW_NEW_INSET
2395  * \li Action: Shows hidden dialog or create new one for a given inset settings etc.
2396  * \li Notion: Internally uses #LFUN_DIALOG_SHOW with processed data for a given inset.
2397  * \li Syntax: dialog-show-new-inset <NAME> [<DATA>]
2398  * \li Params: See #LFUN_DIALOG_SHOW .
2399  * \li Origin: leeming, 25 Feb 2003
2400  * \endvar
2401  */
2402                 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
2403 /*!
2404  * \var lyx::FuncCode lyx::LFUN_DIALOG_UPDATE
2405  * \li Action: Updates the dialog values from the inset/paragraph/document.
2406  * \li Syntax: dialog-update <NAME>
2407  * \li Params: <NAME>: paragraph|prefs|<INSET> \n
2408                <INSET>: inset name
2409  * \li Origin: leeming, 25 Feb 2003
2410  * \endvar
2411  */
2412                 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
2413 /*!
2414  * \var lyx::FuncCode lyx::LFUN_DIALOG_HIDE
2415  * \li Action: Hides showed dialog. Counterpart to #LFUN_DIALOG_SHOW .
2416  * \li Syntax: dialog-hide <NAME>
2417  * \li Params: See #LFUN_DIALOG_SHOW .
2418  * \li Origin: leeming, 25 Feb 2003
2419  * \endvar
2420  */
2421                 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
2422 /*!
2423  * \var lyx::FuncCode lyx::LFUN_DIALOG_TOGGLE
2424  * \li Action: Toggles dialog between showed/hidden state.
2425  * \li Notion: Internally uses #LFUN_DIALOG_SHOW , #LFUN_DIALOG_HIDE .
2426  * \li Syntax: dialog-toggle <NAME> [<DATA>]
2427  * \li Params: See #LFUN_DIALOG_SHOW .
2428  * \li Origin: JSpitzm, 30 Apr 2007
2429  * \endvar
2430  */
2431                 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
2432 /*!
2433  * \var lyx::FuncCode lyx::LFUN_DIALOG_DISCONNECT_INSET
2434  * \li Action: Closes opened connection to opened inset.
2435  * \li Notion: Connection is used for apply functions.
2436  * \li Syntax: dialog-disconnect-inset <INSET-NAME>
2437  * \li Origin: leeming, 25 Feb 2003
2438  * \endvar
2439  */
2440                 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
2441
2442 /*!
2443  * \var lyx::FuncCode lyx::LFUN_MOUSE_PRESS
2444  * \li Action: This function is called when mouse button is pressed (inside workarea).
2445                Action depends on the context.
2446  * \li Notion: This is internal LFUN, not to be used by users.
2447  * \li Origin: Andre, 9 Aug 2002
2448  * \endvar
2449  */
2450                 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
2451 /*!
2452  * \var lyx::FuncCode lyx::LFUN_MOUSE_DOUBLE
2453  * \li Action: This function is called when double click on mouse button is
2454                pressed (inside workarea). Action depends on the context.
2455  * \li Notion: This is internal LFUN, not to be used by users.
2456  * \li Origin: Andre, 9 Aug 2002
2457  * \endvar
2458  */
2459                 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
2460 /*!
2461  * \var lyx::FuncCode lyx::LFUN_MOUSE_TRIPLE
2462  * \li Action: This function is called when triple click on mouse button is
2463                pressed (inside workarea). Action depends on the context.
2464  * \li Notion: This is internal LFUN, not to be used by users.
2465  * \li Origin: Andre, 9 Aug 2002
2466  * \endvar
2467  */
2468                 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
2469 /*!
2470  * \var lyx::FuncCode lyx::LFUN_MOUSE_MOTION
2471  * \li Action: This function is called when mouse cursor is moving over the text.
2472                Action depends on the context.
2473  * \li Notion: This is internal LFUN, not to be used by users.
2474  * \li Origin: Andre, 9 Aug 2002
2475  * \endvar
2476  */
2477                 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
2478 /*!
2479  * \var lyx::FuncCode lyx::LFUN_MOUSE_RELEASE
2480  * \li Action: This function is called when mouse button is released (inside workarea).
2481                Action depends on the context.
2482  * \li Notion: This is internal LFUN, not to be used by users.
2483  * \li Origin: Andre, 9 Aug 2002
2484  * \endvar
2485  */
2486                 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
2487
2488 /*!
2489  * \var lyx::FuncCode lyx::LFUN_KEYMAP_OFF
2490  * \li Action: Turn off the loaded keyboard map.
2491  * \li Syntax: keymap-off
2492  * \endvar
2493  */
2494                 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
2495 /*!
2496  * \var lyx::FuncCode lyx::LFUN_KEYMAP_PRIMARY
2497  * \li Action: Turn on the primary keyboard map.
2498  * \li Notion: Maps were widely used in past, when X-windows didn't have nowadays
2499                keyboard support. They can be still used to maintain uniform keyboard
2500                layout across the various plaforms.\n
2501                The language is to be set in the Preferences dialog.
2502  * \li Syntax: keymap-primary
2503  * \endvar
2504  */
2505                 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
2506 /*!
2507  * \var lyx::FuncCode lyx::LFUN_KEYMAP_SECONDARY
2508  * \li Action: Turn on the secondary keyboard map.
2509  * \li Syntax: keymap-secondary
2510  * \endvar
2511  */
2512                 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
2513 /*!
2514  * \var lyx::FuncCode lyx::LFUN_KEYMAP_TOGGLE
2515  * \li Action: Toggles keyboard maps (first/second/off).
2516  * \li Syntax: keymap-toggle
2517  * \li Origin: leeming, 30 Mar 2004
2518  * \endvar
2519  */
2520                 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
2521
2522 /*!
2523  * \var lyx::FuncCode lyx::LFUN_SERVER_GET_LAYOUT
2524  * \li Action: Returns the current layout (that is environment) name
2525                on the cursor position.
2526  * \li Syntax: server-get-layout
2527  * \endvar
2528  */
2529                 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
2530 /*!
2531  * \var lyx::FuncCode lyx::LFUN_SERVER_GET_FILENAME
2532  * \li Action: Returns path and file name of the currently edited document.
2533  * \li Syntax: server-get-filename
2534  * \endvar
2535  */
2536                 { LFUN_SERVER_GET_FILENAME, "server-get-filename", ReadOnly, System },
2537 /*!
2538  * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
2539  * \li Action: Sets the cursor position based on the row number of generated TeX file.
2540  * \li Syntax: server-goto-file-row <LYX_FILE_NAME> <ROW_NUMBER>
2541  * \li Origin: Edmar, 23 Dec 1998
2542  * \endvar
2543  */
2544                 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly, System },
2545 /*!
2546  * \var lyx::FuncCode lyx::LFUN_SERVER_NOTIFY
2547  * \li Action: Sends notify message about the last key-sequence to client.
2548  * \li Notion: This can be used to grab last key-sequence used inside the LyX window.
2549                See also Debug extensions section in Additional features manual.
2550  * \li Syntax: server-notify
2551  * \endvar
2552  */
2553                 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
2554 /*!
2555  * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
2556  * \li Action: Sets the cursor position based on the editing area coordinates
2557                (similar as clicking on that point with left mouse button).
2558  * \li Syntax: server-set-xy <X> <Y>
2559  * \endvar
2560  */
2561                 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
2562 /*!
2563  * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
2564  * \li Action: Returns the coordinates of cursor position in the editing area.
2565  * \li Syntax: server-get-xy
2566  * \endvar
2567  */
2568                 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
2569
2570 /*!
2571  * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
2572  * \li Action: Generates the code (literate programming).
2573  * \li Notion: Latex file with extension \literate_extension is generated.
2574                Then LyX invokes \build_command (with a default of``make'') to generate the code and
2575                \build_error_filter to process the compilation error messages. \n
2576                In case you want to process your literate file with a script, or some other program,
2577                just insert in your lyxrc file an entry with:\n
2578                \build_command "my_script my_arguments" \n
2579                The \build_error_filter differs from the \literate_error_filter only in that the
2580                former will identify error messages from your compiler.
2581  * \li Syntax: build-program
2582  * \endvar
2583  */
2584                 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
2585
2586 /*!
2587  * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
2588  * \li Action: Saves the current buffer to a temporary file.
2589  * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
2590                is called automatically by LyX, to "autosave" the current buffer.
2591  * \li Syntax: buffer-auto-save
2592  * \endvar
2593  */
2594                 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
2595 /*!
2596  * \var lyx::FuncCode lyx::LFUN_BUFFER_CHILD_OPEN
2597  * \li Action: Loads the given child document.
2598  * \li Notion: The current document is treated as a parent.
2599  * \li Syntax: buffer-child-open <FILE>
2600  * \li Params: <FILE>: Filename of the child. The directory of the parent is assumed by default.
2601  * \li Origin: Ale, 28 May 1997
2602  * \endvar
2603  */
2604                 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
2605 /*!
2606  * \var lyx::FuncCode lyx::LFUN_BUFFER_CHKTEX
2607  * \li Action: Runs chktex for the current document.
2608  * \li Syntax: buffer-chktex
2609  * \li Origin: Asger, 30 Oct 1997
2610  * \endvar
2611  */
2612                 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
2613 /*!
2614  * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
2615  * \li Action: Toggles compression of the current document on/off.
2616  * \li Syntax: buffer-toggle-compression
2617  * \li Origin: bpeng, 27 Apr 2006
2618  * \endvar
2619  */
2620                 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
2621 /*!
2622  * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
2623  * \li Action: Closes the current buffer.
2624  * \li Notion: Closes the current buffer, asking whether to save it, etc,
2625                if the buffer has been modified.
2626  * \li Syntax: buffer-close
2627  * \endvar
2628  */
2629                 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
2630 /*!
2631  * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
2632  * \li Action: Exports the current buffer (document) to the given format.
2633  * \li Syntax: buffer-export <FORMAT>
2634  * \li Params: <FORMAT> is either "custom" or one of the formats which you
2635                         can find in Tools->Preferences->File formats->Format.
2636                         Usual format you will enter is "pdf2" (pdflatex),
2637                         "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
2638                         In case of "custom" you will be asked for a format you
2639                         want to start from and for the command that you want to
2640                         apply to this format. Internally the control is then passed
2641                         to #LFUN_BUFFER_EXPORT_CUSTOM.
2642  * \li Origin: Lgb, 29 Jul 1997
2643  * \endvar
2644  */
2645                 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
2646 /*!
2647  * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
2648  * \li Action: Exports the current buffer (document) from the given format using
2649                the given command on it.
2650  * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
2651  * \li Params: <FORMAT> format to start from (LyX will care to produce such
2652                         intermediate file).\n
2653                <COMMAND> this command will be launched on the file. Note that you can
2654                use "$$FName" string to qualify the intermediate file.
2655  * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
2656  * \li Origin: leeming, 27 Mar 2004
2657  * \endvar
2658  */
2659                 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
2660 /*!
2661  * \var lyx::FuncCode lyx::LFUN_BUFFER_PRINT
2662  * \li Action: Prints the current document.
2663  * \li Notion: Many settings can be given via the preferences dialog.
2664  * \li Syntax: buffer-print <TARGET> <TARGET-NAME> <COMMAND>
2665  * \li Params: <TARGET> is either "printer" or "file".\n
2666                <TARGER-NAME> is either "default" or file name or printer name.\n
2667                <COMMAND> command ensuring the printing job.
2668  * \li Sample: buffer-print file "/trash/newfile1.ps" "dvips"
2669  * \li Origin: leeming, 28 Mar 2004
2670  * \endvar
2671  */
2672                 { LFUN_BUFFER_PRINT, "buffer-print", ReadOnly, Buffer },
2673 /*!
2674  * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
2675  * \li Action: Import a given file as a lyx document.
2676  * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
2677                defined convertors in preferences. Look into File->Import menu to get
2678                an idea of the currently active import formats.
2679  * \li Syntax: buffer-import <FORMAT> [<FILE>]
2680  * \li Origin: Asger, 24 Jul 1998
2681  * \endvar
2682  */
2683                 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
2684 /*!
2685  * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
2686  * \li Action: Creates a new buffer (that is, document).
2687  * \li Notion: Implicit path can be set in Preferences dialog.
2688  * \li Syntax: buffer-new [<FILE>]
2689  * \li Params: <FILE>: filename of created file with absolute path.
2690  * \endvar
2691  */
2692                 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
2693 /*!
2694  * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
2695  * \li Action: Creates a new buffer (that is, document) from a template.
2696  * \li Notion: Path for new files and templates can be set in Preferences dialog.
2697                Template will be asked for via Open-dialog.
2698  * \li Syntax: buffer-new-template [<FILE>]
2699  * \li Params: <FILE>: filename of created file with absolute path.
2700  * \endvar
2701  */
2702                 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
2703 /*!
2704  * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
2705  * \li Action: Reverts opened document.
2706  * \li Syntax: buffer-reload
2707  * \li Origin: Asger, 2 Feb 1997
2708  * \endvar
2709  */
2710                 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
2711 /*!
2712  * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
2713  * \li Action: Switch to the given buffer.
2714  * \li Notion: This is useful also in case you need simultaneously more views of the edited
2715                document in different LyX windows.
2716  * \li Syntax: buffer-new-template <BUFFER>
2717  * \li Params: <BUFFER>: already opened document which is to be shown.
2718  * \endvar
2719  */
2720                 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
2721 /*!
2722  * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
2723  * \li Action: Toggle editing mode of the current document between read/write and read-only.
2724  * \li Notion: In the ->Readonly mode checks-in/commits the data if the file is under version control.
2725                In the Readonly-> mode checkouts the data from repository. \n
2726                If these operations fail, buffer won't be toggled.
2727  * \li Syntax: buffer-toggle-read-only
2728  * \li Origin: Lgb, 27 May 1997
2729  * \endvar
2730  */
2731                 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
2732 /*!
2733  * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
2734  * \li Action: Displays current buffer in chosen format.
2735  * \li Notion: Displays the contents of the current buffer in the chosen
2736                format, for example, PDF or DVI. This runs the necessary
2737                converter, calls the defined viewer, and so forth.
2738  * \li Syntax: buffer-view <FORMAT>
2739  * \li Params: <FORMAT>: The format to display, where this is one of the
2740                          formats defined (in the current GUI) in the
2741                          Tools>Preferences>File Formats dialog.
2742  * \endvar
2743  */
2744                 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
2745 /*!
2746  * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
2747  * \li Action: Exports the current document and put the result into the
2748                temporary directory.
2749  * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
2750                the output will be rewriten - updated. This is useful in case your viewer
2751                is able to detect such changes (e.g. ghostview for postscript).
2752  * \li Syntax: buffer-update <FORMAT>
2753  * \li Params: <FORMAT>: The format to display, where this is one of the
2754                          formats defined (in the current GUI) in the
2755                          Tools>Preferences>File Formats dialog.
2756  * \li Origin: Dekel, 5 Aug 2000
2757  * \endvar
2758  */
2759                 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
2760
2761 /*!
2762  * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
2763  * \li Action: Saves the current buffer.
2764  * \li Notion: Saves the current buffer to disk, using the filename that
2765                is already associated with the buffer, asking for one if
2766                none is yet assigned.
2767  * \li Syntax: buffer-write
2768  * \endvar
2769  */
2770                 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
2771 /*!
2772  * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
2773  * \li Action: Rename and save current buffer.
2774  * \li Syntax: buffer-write-as <FILENAME>
2775  * \li Params: <FILENAME>: New name of the buffer/file. A relative path
2776                is with respect to the original location of the buffer/file.
2777  * \endvar
2778  */
2779                 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
2780 /*!
2781  * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
2782  * \li Action: Save all changed documents.
2783  * \li Syntax: buffer-write-all
2784  * \li Origin: rgh, gpothier 6 Aug 2007
2785  * \endvar
2786  */
2787                 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
2788 /*!
2789  * \var lyx::FuncCode lyx::LFUN_BUFFER_NEXT
2790  * \li Action: Switch to the next opened document.
2791  * \li Notion: Note that this does not necessarily mean next in tabbar
2792                (for full list see View menu).
2793  * \li Syntax: buffer-next
2794  * \endvar
2795  */
2796                 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
2797 /*!
2798  * \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS
2799  * \li Action: Switch to the previous opened document.
2800  * \li Syntax: buffer-previous
2801  * \endvar
2802  */
2803                 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
2804 /*!
2805  * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
2806  * \li Action: When run from a child document, this updates (exports) document built
2807                 from the master buffer. If a master is not found, it updates the
2808                 current buffer.
2809  * \li Syntax: master-buffer-update
2810  * \li Origin: Tommaso, 20 Sep 2007
2811  * \endvar
2812  */
2813                 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
2814 /*!
2815  * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
2816  * \li Action: When run from a child document, this command shows a preview built
2817                from the master buffer. If a master is not found, it previews the
2818                current buffer.
2819  * \li Syntax: master-buffer-view
2820  * \li Origin: Tommaso, 20 Sep 2007
2821  * \endvar
2822  */
2823                 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
2824 /*!
2825  * \var lyx::FuncCode lyx::LFUN_BUFFER_LANGUAGE
2826  * \li Action: Set language of the current document.
2827  * \li Syntax: buffer-language <LANG>
2828  * \li Params: <LANG>: language name. See lib/languages for list.
2829  * \li Origin: leeming, 30 Mar 2004
2830  * \endvar
2831  */
2832                 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
2833 /*!
2834  * \var lyx::FuncCode lyx::LFUN_BUFFER_SAVE_AS_DEFAULT
2835  * \li Action: Save the current document settings as default.
2836  * \li Notion: The file will will be saved into ~/.lyx/templates/defaults.lyx .
2837  * \li Syntax: buffer-save-as-default [<ARGS>]
2838  * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
2839                        you can find in document header of usual .lyx file.
2840  * \li Origin: leeming, 30 Mar 2004
2841  * \endvar
2842  */
2843                 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
2844 /*!
2845  * \var lyx::FuncCode lyx::LFUN_BUFFER_PARAMS_APPLY
2846  * \li Action: Apply the given settings to the current document.
2847  * \li Syntax: buffer-params-apply [<ARGS>]
2848  * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
2849                        you can find in document header of usual .lyx file.
2850  * \li Origin: leeming, 30 Mar 2004
2851  * \endvar
2852  */
2853                 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", Noop, Buffer },
2854
2855 /*!
2856  * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
2857  * \li Action: Inserts another LyX file.
2858  * \li Syntax: file-insert [<FILE>]
2859  * \li Params: <FILE>: Filename to be inserted.
2860  * \endvar
2861  */
2862                 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
2863 /*!
2864  * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
2865  * \li Action: Inserts plain text file.
2866  * \li Syntax: file-insert-plaintext [<FILE>]
2867  * \li Params: <FILE>: Filename to be inserted.
2868  * \li Origin: CFO-G, 19 Nov 1997
2869  * \endvar
2870  */
2871                 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
2872 /*!
2873  * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
2874  * \li Action: Inserts plain text file as paragraph (i.e. join lines).
2875  * \li Syntax: file-insert-plaintext-para [<FILE>]
2876  * \li Params: <FILE>: Filename to be inserted.
2877  * \li Origin: Levon, 14 Feb 2001
2878  * \endvar
2879  */
2880                 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
2881 /*!
2882  * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
2883  * \li Action: Open LyX document.
2884  * \li Syntax: file-open [<FILE>]
2885  * \li Params: <FILE>: Filename to be opened.
2886  * \endvar
2887  */
2888                 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
2889
2890 /*!
2891  * \var lyx::FuncCode lyx::LFUN_CALL
2892  * \li Action: Executes a command defined in a .def file.
2893  * \li Notion: The definitions are by default read from lib/commands/default.def.\n
2894                A .def file allows to define a command with \\define "<NAME>" "<LFUN>"
2895                where <NAME> is the name of the new command and <LFUN> is the lfun code
2896                to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
2897                \\def_file "FileName" allows to include another .def file. \n
2898                This is particularly useful in connection with toolbar buttons:
2899                Since the name of the button image for this lfun is 
2900                lib/images/commands/<NAME>.png this is the way to assign an image
2901                to a complex command-sequence.
2902  * \li Syntax: call <NAME>
2903  * \li Params: <NAME>: Name of the command that must be called.
2904  * \li Origin: broider, 2 Oct 2007
2905  * \endvar
2906  */
2907                 { LFUN_CALL, "call", NoBuffer, System },
2908 /*!
2909  * \var lyx::FuncCode lyx::LFUN_META_PREFIX
2910  * \li Action: Simulate halting Meta key (Alt key on PCs).
2911  * \li Notion: Used for buffer editation not for GUI control.
2912  * \li Syntax: meta-prefix
2913  * \endvar
2914  */
2915                 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
2916 /*!
2917  * \var lyx::FuncCode lyx::LFUN_CANCEL
2918  * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
2919  * \li Syntax: cancel
2920  * \endvar
2921  */
2922                 { LFUN_CANCEL, "cancel", NoBuffer, System },
2923
2924 /*!
2925  * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
2926  * \li Action: Opens the minibuffer toolbar so that the user can type in there.
2927  * \li Notion: Usually bound to M-x shortcut.
2928  * \li Syntax: command-execute
2929  * \endvar
2930  */
2931                 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
2932 /*!
2933  * \var lyx::FuncCode lyx::LFUN_COMMAND_PREFIX
2934  * \li Action: Return the current key sequence and available options as a string.
2935  * \li Notion: No options are added if no current map exists. \n
2936                This is probably usable only with connection to lyxserver.
2937  * \li Syntax: command-prefix
2938  * \endvar
2939  */
2940                 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
2941 /*!
2942  * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
2943  * \li Action: Run more commands (LFUN and its parameters) in a sequence.
2944  * \li Syntax: command-sequence <CMDS>
2945  * \li Params: <CMDS>: Sequence of commands separated by semicolons.
2946  * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
2947  * \li Origin: Andre, 11 Nov 1999
2948  * \endvar
2949  */
2950                 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
2951 /*!
2952  * \var lyx::FuncCode lyx::LFUN_COMMAND_ALTERNATIVES
2953  * \li Action: Runs the first listed command that is enabled.
2954  * \li Notion: This can be used to bind multiple functions to a single key,
2955                and then which one is used will depend upon the context.
2956  * \li Syntax: command-alternatives <CMDS>
2957  * \li Params: <CMDS>: Sequence of commands separated by semicolons.
2958  * \li Sample: command-alternatives completion-accept;cell-forward
2959  * \li Origin: rgh, 24 September 2008
2960  * \endvar
2961  */
2962                 { LFUN_COMMAND_ALTERNATIVES, "command-alternatives", NoBuffer, System },
2963 /*!
2964  * \var lyx::FuncCode lyx::LFUN_MESSAGE
2965  * \li Action: Shows message in statusbar (for script purposes).
2966  * \li Syntax: message <STRING>
2967  * \li Origin: Lgb, 8 Apr 2001
2968  * \endvar
2969  */
2970                 { LFUN_MESSAGE, "message", NoBuffer, System },
2971 /*!
2972  * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
2973  * \li Action: Save user preferences.
2974  * \li Syntax: preferences-save
2975  * \li Origin: Lgb, 27 Nov 1999
2976  * \endvar
2977  */
2978                 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
2979 /*!
2980  * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
2981  * \li Action: Reconfigure the automatic settings.
2982  * \li Syntax: reconfigure
2983  * \li Origin: Asger, 14 Feb 1997
2984  * \endvar
2985  */
2986                 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
2987 /*!
2988  * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
2989  * \li Action: Apply the given settings to user preferences.
2990  * \li Syntax: lyxrc-apply <SETTINGS>
2991  * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
2992                            to get an idea which commands to use and their syntax.
2993                            #lyx::LyXRC::LyXRCTags has the list of possible commands.
2994  * \endvar
2995  */
2996                 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
2997 /*!
2998  * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
2999  * \li Action: Determine whether keep cursor inside the editing window regardless
3000                the scrollbar movement.
3001  * \li Syntax: toggle-cursor-follows-scrollbar
3002  * \li Origin: ARRae, 2 Dec 1997
3003  * \endvar
3004  */
3005                 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
3006 /*!
3007  * \var lyx::FuncCode lyx::LFUN_SET_COLOR
3008  * \li Action: Set the given LyX color to the color defined by the X11 name given.
3009  * \li Notion: A new color entry is created if the color is unknown.
3010                Color names can be stored as a part of user settings.
3011  * \li Syntax: set-color <LYX_NAME> <X11_NAME>
3012  * \li Origin: SLior, 11 Jun 2000
3013  * \endvar
3014  */
3015                 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
3016 /*!
3017  * \var lyx::FuncCode lyx::LFUN_STATISTICS
3018  * \li Action: Count the statistics (number of words and characters)
3019                in the document or in the given selection.
3020  * \li Notion: Note that this function gives the number of words/chars written,
3021                not the number of characters which will be typeset.
3022  * \li Syntax: statistics
3023  * \li Origin: lasgouttes, Jan 27 2004; sanda, Jan 8 2008
3024  * \endvar
3025  */
3026                 { LFUN_STATISTICS, "statistics", ReadOnly, System },
3027 /*!
3028  * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
3029  * \li Action: Show the inline completion at the cursor position.
3030  * \li Syntax: completion-inline
3031  * \li Origin: sts, Feb 19 2008
3032  * \endvar
3033  */
3034                 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
3035 /*!
3036  * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
3037  * \li Action: Show the completion popup at the cursor position.
3038  * \li Syntax: completion-popup
3039  * \li Origin: sts, Feb 19 2008
3040  * \endvar
3041  */
3042                 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
3043 /*!
3044  * \var lyx::FuncCode lyx::LFUN_COMPLETION_COMPLETE
3045  * \li Action: Try to complete the word or command at the cursor position.
3046  * \li Syntax: complete
3047  * \li Origin: sts, Feb 19 2008
3048  * \endvar
3049  */
3050                 { LFUN_COMPLETION_COMPLETE, "complete", SingleParUpdate, Edit },
3051
3052 /*!
3053  * \var lyx::FuncCode lyx::LFUN_COMPLETION_CANCEL
3054  * \li Action: Try to cancel completion, either the popup or the inline completion
3055  * \li Syntax: completion-cancel
3056  * \li Origin: sts, Sep 07 2008
3057  * \endvar
3058  */
3059                 { LFUN_COMPLETION_CANCEL, "completion-cancel", SingleParUpdate, Edit },
3060 /*!
3061  * \var lyx::FuncCode lyx::LFUN_COMPLETION_ACCEPT
3062  * \li Action: Accept suggested completion.
3063  * \li Syntax: completion-accept
3064  * \li Origin: sanda, Sep 08 2008
3065  * \endvar
3066  */
3067                 { LFUN_COMPLETION_ACCEPT, "completion-accept", SingleParUpdate, Edit },
3068
3069
3070 /*!
3071  * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
3072  * \li Action: Activate the branch
3073  * \li Syntax: branch-activate <BRANCH>
3074  * \li Params: <BRANCH>: The branch to activate
3075  * \li Sample: lyx -e pdf2 -x "branch-activate answers" finalexam.lyx \n
3076                could be used to export a pdf with the answers branch included
3077                without one's having to open LyX and activate the branch manually.
3078  * \li Origin: rgh, 27 May 2008
3079  * \endvar
3080  */
3081                 { LFUN_BRANCH_ACTIVATE, "branch-activate", Argument, Buffer },
3082 /*!
3083  * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
3084  * \li Action: De-activate the branch
3085  * \li Syntax: branch-deactivate <BRANCH>
3086  * \li Params: <BRANCH>: The branch to deactivate
3087  * \li Origin: rgh, 27 May 2008
3088  * \endvar
3089  */
3090                 { LFUN_BRANCH_DEACTIVATE, "branch-deactivate", Argument, Buffer },
3091
3092                 { LFUN_NOACTION, "", Noop, Hidden }
3093 #ifndef DOXYGEN_SHOULD_SKIP_THIS
3094         };
3095
3096         for (int i = 0; items[i].action != LFUN_NOACTION; ++i) {
3097                 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
3098         }
3099
3100         init = true;
3101 }
3102 #endif
3103
3104 LyXAction::LyXAction()
3105 {
3106         init();
3107 }
3108
3109
3110 // Returns an action tag from a string.
3111 FuncRequest LyXAction::lookupFunc(string const & func) const
3112 {
3113         string const func2 = trim(func);
3114
3115         if (func2.empty()) {
3116                 return FuncRequest(LFUN_NOACTION);
3117         }
3118
3119         string cmd;
3120         string const arg = split(func2, cmd, ' ');
3121
3122         func_map::const_iterator fit = lyx_func_map.find(cmd);
3123
3124         return fit != lyx_func_map.end() ? FuncRequest(fit->second, arg) : FuncRequest(LFUN_UNKNOWN_ACTION);
3125 }
3126
3127
3128 string const LyXAction::getActionName(FuncCode action) const
3129 {
3130         info_map::const_iterator const it = lyx_info_map.find(action);
3131         return it != lyx_info_map.end() ? it->second.name : string();
3132 }
3133
3134
3135 LyXAction::func_type LyXAction::getActionType(FuncCode action) const
3136 {
3137         info_map::const_iterator const it = lyx_info_map.find(action);
3138         return it != lyx_info_map.end() ? it->second.type : Hidden;
3139 }
3140
3141
3142 bool LyXAction::funcHasFlag(FuncCode action,
3143                             LyXAction::func_attrib flag) const
3144 {
3145         info_map::const_iterator ici = lyx_info_map.find(action);
3146
3147         if (ici == lyx_info_map.end()) {
3148                 LYXERR0("action: " << action << " is not known.");
3149                 LASSERT(false, /**/);
3150         }
3151
3152         return ici->second.attrib & flag;
3153 }
3154
3155
3156 LyXAction::const_func_iterator LyXAction::func_begin() const
3157 {
3158         return lyx_func_map.begin();
3159 }
3160
3161
3162 LyXAction::const_func_iterator LyXAction::func_end() const
3163 {
3164         return lyx_func_map.end();
3165 }
3166
3167
3168 LyXErr & operator<<(LyXErr & l, FuncCode code)
3169 {
3170         if (l.enabled())
3171                 l.stream() << lyxaction.getActionName(code);
3172         return l;
3173 }
3174
3175 } // namespace lyx