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