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
11 * Full author contact details are available in file CREDITS.
16 #include "LyXAction.h"
18 #include "FuncRequest.h"
20 #include "support/debug.h"
21 #include "support/lstrings.h"
23 #include "support/lassert.h"
26 using namespace lyx::support;
31 NAMING RULES FOR USER-COMMANDS
32 Here's the set of rules to apply when a new command name is introduced:
34 1) Use the object.event order. That is, use `word-forward'
35 instead of `forward-word'.
36 2) Don't introduce an alias for an already named object. Same for events.
37 3) Forward movement or focus is called `forward' (not `right').
38 4) Backward movement or focus is called `backward' (not `left').
39 5) Upward movement of focus is called `up'.
40 6) Downward movement is called `down'.
41 7) The begin of an object is called `begin' (not `start').
42 8) The end of an object is called `end'.
44 (May 19 1996, 12:04, RvdK)
47 /* LFUN documentation (a start at least, Chr 2007-08-12)
49 * The documentation below is primarily notes about restrictions and
50 * oddities relating to the different LFUNs.
52 * Try to find an appropriate (thematical) place when adding the new LFUN.
54 * Doxygen template below. Some notes: Parameters should be set in uppercase
55 * and put in <BRACKETS>, as so.
59 * \var lyx::FuncCode lyx::LFUN_
72 void LyXAction::newFunc(FuncCode action, string const & name,
73 unsigned int attrib, LyXAction::func_type type)
75 lyx_func_map[name] = action;
78 tmpinfo.attrib = attrib;
80 lyx_info_map[action] = tmpinfo;
84 // Needed for LFUNs documentation to be accepted, since doxygen won't take
85 // \var inside functions.
86 #ifndef DOXYGEN_SHOULD_SKIP_THIS
87 void LyXAction::init()
89 // This function was changed to use the array below in initalization
90 // instead of calling newFunc numerous times because of compilation
91 // times. Since the array is not static we get back the memory it
92 // occupies after the init is completed. It compiles several
105 ev_item const items[] = {
108 * \var lyx::FuncCode lyx::LFUN_ACCENT_ACUTE
109 * \li Action: Adds an acute accent \htmlonly (á)\endhtmlonly
110 to the next character typed.
111 * \li Syntax: accent-acute
114 { LFUN_ACCENT_ACUTE, "accent-acute", Noop, Edit },
116 * \var lyx::FuncCode lyx::LFUN_ACCENT_BREVE
117 * \li Action: Adds a breve accent \htmlonly (ă)\endhtmlonly
118 to the next character typed.
119 * \li Syntax: accent-breve
122 { LFUN_ACCENT_BREVE, "accent-breve", Noop, Edit },
124 * \var lyx::FuncCode lyx::LFUN_ACCENT_CARON
125 * \li Action: Adds a caron \htmlonly (ǎ)\endhtmlonly
126 to the next character typed.
127 * \li Syntax: accent-caron
130 { LFUN_ACCENT_CARON, "accent-caron", Noop, Edit },
132 * \var lyx::FuncCode lyx::LFUN_ACCENT_CEDILLA
133 * \li Action: Adds a cedilla \htmlonly (ç)\endhtmlonly
134 to the next character typed.
135 * \li Syntax: accent-cedilla
138 { LFUN_ACCENT_CEDILLA, "accent-cedilla", Noop, Edit },
140 * \var lyx::FuncCode lyx::LFUN_ACCENT_CIRCLE
141 * \li Action: Adds a circle accent \htmlonly (å)\endhtmlonly
142 to the next character typed.
143 * \li Syntax: accent-circle
146 { LFUN_ACCENT_CIRCLE, "accent-circle", Noop, Edit },
148 * \var lyx::FuncCode lyx::LFUN_ACCENT_CIRCUMFLEX
149 * \li Action: Adds a circumflex \htmlonly (ê)\endhtmlonly
150 to the next character typed.
151 * \li Syntax: accent-circumflex
154 { LFUN_ACCENT_CIRCUMFLEX, "accent-circumflex", Noop, Edit },
156 * \var lyx::FuncCode lyx::LFUN_ACCENT_DOT
157 * \li Action: Adds a dot accent \htmlonly (ż)\endhtmlonly
158 to the next character typed.
159 * \li Syntax: accent-dot
162 { LFUN_ACCENT_DOT, "accent-dot", Noop, Edit },
164 * \var lyx::FuncCode lyx::LFUN_ACCENT_GRAVE
165 * \li Action: Adds a grave accent \htmlonly (è)\endhtmlonly
166 to the next character typed.
167 * \li Syntax: accent-grave
170 { LFUN_ACCENT_GRAVE, "accent-grave", Noop, Edit },
172 * \var lyx::FuncCode lyx::LFUN_ACCENT_HUNGARIAN_UMLAUT
173 * \li Action: Adds a Hungarian umlaut \htmlonly (ő)\endhtmlonly
174 to the next character typed.
175 * \li Syntax: accent-grave
178 { LFUN_ACCENT_HUNGARIAN_UMLAUT, "accent-hungarian-umlaut", Noop, Edit },
180 * \var lyx::FuncCode lyx::LFUN_ACCENT_MACRON
181 * \li Action: Adds a macron \htmlonly (ā)\endhtmlonly
182 to the next character typed.
183 * \li Syntax: accent-macron
186 { LFUN_ACCENT_MACRON, "accent-macron", Noop, Edit },
188 * \var lyx::FuncCode lyx::LFUN_ACCENT_OGONEK
189 * \li Action: Adds an ogonek accent \htmlonly (ą)\endhtmlonly
190 to the next character typed.
191 * \li Syntax: accent-ogonek
194 { LFUN_ACCENT_OGONEK, "accent-ogonek", Noop, Edit },
196 * \var lyx::FuncCode lyx::LFUN_ACCENT_TIE
197 * \li Action: Adds a tie \htmlonly (a͡)\endhtmlonly
198 over the next two character typed.
199 * \li Notion: the following char will finish the tie.
200 * \li Syntax: accent-tie
203 { LFUN_ACCENT_TIE, "accent-tie", Noop, Edit },
205 * \var lyx::FuncCode lyx::LFUN_ACCENT_TILDE
206 * \li Action: Adds a tilde \htmlonly (ã)\endhtmlonly
207 over the next character typed.
208 * \li Syntax: accent-tilde
211 { LFUN_ACCENT_TILDE, "accent-tilde", Noop, Edit },
213 * \var lyx::FuncCode lyx::LFUN_ACCENT_UMLAUT
214 * \li Action: Adds an umlaut \htmlonly (ä)\endhtmlonly
215 over the next character typed.
216 * \li Syntax: accent-umlaut
219 { LFUN_ACCENT_UMLAUT, "accent-umlaut", Noop, Edit },
221 * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERBAR
222 * \li Action: Adds a bar \htmlonly (a̠)\endhtmlonly
223 under the next character typed.
224 * \li Syntax: accent-underbar
227 { LFUN_ACCENT_UNDERBAR, "accent-underbar", Noop, Edit },
229 * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERDOT
230 * \li Action: Adds a dot \htmlonly (ạ)\endhtmlonly
231 under the next character typed.
232 * \li Syntax: accent-underdot
235 { LFUN_ACCENT_UNDERDOT, "accent-underdot", Noop, Edit },
238 * \var lyx::FuncCode lyx::LFUN_CAPTION_INSERT
239 * \li Action: Inserts a caption inset.
240 * \li Syntax: caption-insert
241 * \li Origin: Lgb, 18 Jul 2000
244 { LFUN_CAPTION_INSERT, "caption-insert", Noop, Edit },
246 * \var lyx::FuncCode lyx::LFUN_DATE_INSERT
247 * \li Action: Inserts the current date.
248 * \li Syntax: date-insert [<ARG>]
249 * \li Params: <ARG>: Format of date. The default value (%x) can be set
250 in Preferences->Date format. For possible formats
251 see manual page of strftime function.
252 * \li Origin: jdblair, 31 Jan 2000
255 { LFUN_DATE_INSERT, "date-insert", Noop, Edit },
257 * \var lyx::FuncCode lyx::LFUN_FOOTNOTE_INSERT
258 * \li Action: Inserts a footnote inset.
259 * \li Syntax: footnote-insert
260 * \li Origin: Jug, 7 Mar 2000
263 { LFUN_FOOTNOTE_INSERT, "footnote-insert", Noop, Edit },
265 * \var lyx::FuncCode lyx::LFUN_ERT_INSERT
266 * \li Action: Inserts an ERT inset.
267 * \li Syntax: ert-insert
268 * \li Origin: Jug, 18 Feb 2000
271 { LFUN_ERT_INSERT, "ert-insert", Noop, Edit },
273 * \var lyx::FuncCode lyx::LFUN_FLOAT_INSERT
274 * \li Action: Inserts a float inset.
275 * \li Syntax: float-insert <TYPE>
276 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
277 "algorithm", "table", "figure" parameters can be given.
278 * \li Origin: Lgb, 27 Jun 2000
281 { LFUN_FLOAT_INSERT, "float-insert", Noop, Edit },
283 * \var lyx::FuncCode lyx::LFUN_FLOAT_WIDE_INSERT
284 * \li Action: Inserts float insets as in #LFUN_FLOAT_INSERT but span multiple columns.
285 * \li Notion: Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
286 * \li Syntax: float-wide-insert <TYPE>
287 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
288 "algorithm", "table", "figure" parameters can be given.
289 * \li Origin: Lgb, 31 Oct 2001
292 { LFUN_FLOAT_WIDE_INSERT, "float-wide-insert", Noop, Edit },
294 * \var lyx::FuncCode lyx::LFUN_FLOAT_LIST_INSERT
295 * \li Action: Inserts the list of floats in the document.
296 * \li Syntax: float-list-insert <TYPE>
297 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
298 "algorithm", "table", "figure" parameters can be given.
299 * \li Origin: Lgb, 3 May 2001
302 { LFUN_FLOAT_LIST_INSERT, "float-list-insert", Noop, Edit },
304 * \var lyx::FuncCode lyx::LFUN_WRAP_INSERT
305 * \li Action: Inserts floats wrapped by the text around.
306 * \li Syntax: wrap-insert <TYPE>
307 * \li Params: <TYPE>: table|figure
308 * \li Origin: Dekel, 7 Apr 2002
311 { LFUN_WRAP_INSERT, "wrap-insert", Noop, Edit },
313 * \var lyx::FuncCode lyx::LFUN_OPTIONAL_INSERT
314 * \li Action: Inserts an optional-argument (short title) inset.
315 * \li Syntax: optional-insert
316 * \li Origin: Martin, 12 Aug 2002
319 { LFUN_OPTIONAL_INSERT, "optional-insert", Noop, Edit },
321 * \var lyx::FuncCode lyx::LFUN_LINE_INSERT
322 * \li Action: Inserts a horizontal line.
323 * \li Syntax: line-insert
324 * \li Origin: poenitz, Oct 27 2003
327 { LFUN_LINE_INSERT, "line-insert", Noop, Edit },
329 * \var lyx::FuncCode lyx::LFUN_NEWPAGE_INSERT
330 * \li Action: Inserts a new page.
331 * \li Syntax: newpage-insert<ARG>
332 * \li Params: <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
333 * \li Origin: uwestoehr, 24 Nov 2007
336 { LFUN_NEWPAGE_INSERT, "newpage-insert", Noop, Edit },
338 * \var lyx::FuncCode lyx::LFUN_MARGINALNOTE_INSERT
339 * \li Action: Inserts a marginal note.
340 * \li Syntax: marginalnote-insert
341 * \li Origin: Lgb, 26 Jun 2000
344 { LFUN_MARGINALNOTE_INSERT, "marginalnote-insert", Noop, Edit },
346 * \var lyx::FuncCode lyx::LFUN_UNICODE_INSERT
347 * \li Action: Inserts a single unicode character.
348 * \li Syntax: unicode-insert <CHAR>
349 * \li Params: <CHAR>: The character to insert, given as its code
350 point, in hexadecimal, e.g.: unicode-insert 0x0100.
351 * \li Origin: Lgb, 22 Oct 2006
354 { LFUN_UNICODE_INSERT, "unicode-insert", Noop, Edit },
356 * \var lyx::FuncCode lyx::LFUN_LISTING_INSERT
357 * \li Action: Inserts a new listings inset.
358 * \li Syntax: listing-insert
359 * \li Origin: Herbert, 10 Nov 2001; bpeng, 2 May 2007
362 { LFUN_LISTING_INSERT, "listing-insert", Noop, Edit },
364 * \var lyx::FuncCode lyx::LFUN_QUOTE_INSERT
365 * \li Action: Inserts quotes according to the type and quote-language preference.
366 * \li Action: Currently English, Swedish, German, Polish, French, Danish quotes
368 * \li Syntax: quote-insert [<TYPE>]
369 * \li Params: TYPE: 'single' for single quotes, otherwise double quotes will be used.
372 { LFUN_QUOTE_INSERT, "quote-insert", Noop, Edit },
374 * \var lyx::FuncCode lyx::LFUN_INFO_INSERT
375 * \li Action: Displays shortcuts, lyxrc, package and textclass availability and menu
376 information in a non-editable boxed InsetText.
377 * \li Notion: Apart from lfun arguments you can use the following method: \n
378 1. input the type and argument of this inset, e.g. "menu paste", in
380 2. select the text and run info-insert lfun.\n
381 * \li Syntax: info-insert <TYPE> <ARG>
382 * \li Params: <TYPE>: shortcut|lyxrc|package|textclass|menu|buffer \n
383 <ARG>: argument for a given type. Look into InsetInfo.h for detailed
385 * \li Origin: bpeng, 7 Oct 2007
388 { LFUN_INFO_INSERT, "info-insert", Noop, Edit },
390 * \var lyx::FuncCode lyx::LFUN_BRANCH_INSERT
391 * \li Action: Inserts branch inset.
392 * \li Syntax: branch-insert <BRANCH-NAME>
393 * \li Origin: vermeer, 17 Aug 2003
396 { LFUN_BRANCH_INSERT, "branch-insert", Noop, Edit },
398 * \var lyx::FuncCode lyx::LFUN_BOX_INSERT
399 * \li Action: Inserts Box inset.
400 * \li Syntax: box-insert [<TYPE>]
401 * \li Params: <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox \n
402 Framed is the default one.
403 * \li Origin: vermeer, 7 Oct 2003
406 { LFUN_BOX_INSERT, "box-insert", Noop, Edit },
408 * \var lyx::FuncCode lyx::LFUN_FLEX_INSERT
409 * \li Action: Inserts CharStyle, Custom inset or XML short element.
410 * \li Notion: Look into the Customization manual for more information about
412 For dissolving the element see #LFUN_INSET_DISSOLVE.
413 * \li Syntax: flex-insert <TYPE:Name>
414 * \li Params: TYPE: CharStyle|Custom|Element|Standard
415 Identifies whether this is a Character Style, a
416 Custom Inset or an XML Element, and which dynamical
417 sub-menu this flex inset is in on the LyX menu tree.
418 If Standard (currently unused): none of these.
419 Name: This name must be defined either in your layout file
420 or imported by some module. The definition is\n
421 InsetLayout <TYPE:Name>
422 * \li Sample: flex-insert CharStyle:Code
425 { LFUN_FLEX_INSERT, "flex-insert", Noop, Edit },
427 * \var lyx::FuncCode lyx::LFUN_SELF_INSERT
428 * \li Action: Inserts the given string (accordingly to the correct keymap).
429 * \li Notion: Automatically replace the currently selected text. Depends on lyxrc
430 settings "auto_region_delete".
431 * \li Syntax: self-insert <STRING>
434 { LFUN_SELF_INSERT, "self-insert", SingleParUpdate, Hidden },
436 * \var lyx::FuncCode lyx::LFUN_SPACE_INSERT
437 * \li Action: Inserts one of horizontal space insets.
438 * \li Syntax: space-insert <NAME> [<LEN>]
439 * \li Params: <NAME>: normal, protected, thin, quad, qquad, enspace, enskip,
440 negthinspace, hfill, hfill*, dotfill, hrulefill, hspace,
442 <LEN>: length for custom spaces (hspace, hspace* for protected)
443 * \li Origin: JSpitzm, 20 May 2003, Mar 17 2008
446 { LFUN_SPACE_INSERT, "space-insert", Noop, Edit },
448 * \var lyx::FuncCode lyx::LFUN_HYPERLINK_INSERT
449 * \li Action: Inserts hyperlinks into the document (clickable in pdf output).
450 * \li Notion: Hyperlink target can be set via selection + hyperlink-insert function.
451 * \li Syntax: href-insert [<TARGET>]
452 * \li Origin: CFO-G, 21 Nov 1997
455 { LFUN_HYPERLINK_INSERT, "href-insert", Noop, Edit },
457 * \var lyx::FuncCode lyx::LFUN_SPECIALCHAR_INSERT
458 * \li Action: Inserts various characters into the document.
459 * \li Syntax: specialchar-insert <CHAR>
460 * \li Params: <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots,
461 end-of-sentence, menu-separator.
462 * \li Origin: JSpitzm, 6 Dec 2007
465 { LFUN_SPECIALCHAR_INSERT, "specialchar-insert", Noop, Edit },
467 * \var lyx::FuncCode lyx::LFUN_TOC_INSERT
468 * \li Action: Inserts table of contents.
469 * \li Syntax: toc-insert
470 * \li Origin: Lgb, 27 May 97
473 { LFUN_TOC_INSERT, "toc-insert", Noop, Edit },
475 * \var lyx::FuncCode lyx::LFUN_APPENDIX
476 * \li Action: Start (or remove) Appendix on the given cursor position.
477 * \li Syntax: appendix
478 * \li Origin: ettrich, 5 May 1998
481 { LFUN_APPENDIX, "appendix", Noop, Edit },
483 { LFUN_INDEX_INSERT, "index-insert", Noop, Edit },
484 { LFUN_INDEX_PRINT, "index-print", Noop, Edit },
486 { LFUN_NOMENCL_INSERT, "nomencl-insert", Noop, Edit },
487 { LFUN_NOMENCL_PRINT, "nomencl-print", Noop, Edit },
489 { LFUN_NOTE_INSERT, "note-insert", Noop, Edit },
490 { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
492 * \var lyx::FuncCode lyx::LFUN_NEWLINE_INSERT
493 * \li Action: Inserts a line break or new line.
494 * \li Syntax: newline-insert <ARG>
495 * \li Params: <ARG>: <newline|linebreak> default: newline
496 * \li Origin: JSpitzm, 25 Mar 2008
499 { LFUN_NEWLINE_INSERT, "newline-insert", Noop, Edit },
503 { LFUN_LIST_INSERT, "list-insert", Noop, Edit },
507 * \var lyx::FuncCode lyx::LFUN_ESCAPE
508 * \li Action: Clears the selection. If no text is selected call #LFUN_FINISHED_FORWARD.
510 * \li Origin: Lgb, 17 May 2001
513 { LFUN_ESCAPE, "escape", ReadOnly, Edit },
514 { LFUN_DELETE_BACKWARD_SKIP, "delete-backward-skip", Noop, Edit },
515 { LFUN_DELETE_FORWARD_SKIP, "delete-forward-skip", Noop, Edit },
517 * \var lyx::FuncCode lyx::LFUN_DOWN
518 * \li Action: Moves the cursor one line in downward direction.
522 { LFUN_DOWN, "down", ReadOnly | NoUpdate, Edit },
524 * \var lyx::FuncCode lyx::LFUN_UP
525 * \li Action: Moves the cursor one line in upward direction.
529 { LFUN_UP, "up", ReadOnly | NoUpdate, Edit },
531 * \var lyx::FuncCode lyx::LFUN_DOWN_SELECT
532 * \li Action: Moves the cursor one line in downward direction adding the current
533 position to the selection.
534 * \li Syntax: down-select
537 { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, Edit },
539 * \var lyx::FuncCode lyx::LFUN_UP_SELECT
540 * \li Action: Moves the cursor one line in upward direction adding the current
541 position to the selection.
542 * \li Syntax: up-select
545 { LFUN_UP_SELECT, "up-select", ReadOnly | SingleParUpdate, Edit },
546 { LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit },
547 { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit },
548 { LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit },
549 { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit },
551 * \var lyx::FuncCode lyx::LFUN_SCROLL
552 * \li Action: Scroll the buffer view.
553 * \li Notion: Only scrolls the screen up or down; does not move the cursor.
554 * \li Syntax: scroll <TYPE> <QUANTITY>
555 * \li Params: <TYPE>: line|page\n
556 <QUANTITY>: up|down|<number>
557 * \li Origin: Abdelrazak Younes, Dec 27 2007
560 { LFUN_SCROLL, "scroll", ReadOnly, Edit },
562 * \var lyx::FuncCode lyx::LFUN_SCREEN_RECENTER
563 * \li Action: Recenters the screen on the current cursor position.
564 * \li Syntax: screen-recenter
567 { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit },
569 { LFUN_ERROR_NEXT, "error-next", ReadOnly, Edit },
571 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD
572 * \li Action: Moves the cursor one position logically backwards.
573 * \li Notion: This is not the action which should be bound to the arrow keys,
574 because backwards may be left or right, depending on the
575 language. The arrow keys should be bound to #LFUN_CHAR_LEFT or
576 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
577 * \li Syntax: char-backward
580 { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit },
582 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD_SELECT
583 * \li Action: Moves the cursor one position logically backwards, adding
584 traversed position to the selection.
585 * \li Notion: See also #LFUN_CHAR_BACKWARD.
586 * \li Syntax: char-backward-select
589 { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit },
591 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_BACKWARD
592 * \li Action: Deletes one character in the backward direction (usually the "BackSpace" key).
593 * \li Syntax: char-delete-backward
596 { LFUN_CHAR_DELETE_BACKWARD, "char-delete-backward", SingleParUpdate, Edit },
598 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_FORWARD
599 * \li Action: Deletes one character in the backward direction (usually the "Delete" key).
600 * \li Syntax: char-delete-forward
603 { LFUN_CHAR_DELETE_FORWARD, "char-delete-forward", SingleParUpdate, Edit },
605 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD
606 * \li Action: Moves the cursor one position logically forward.
607 * \li Notion: This is not the action which should be bound to the arrow keys,
608 because forward may be left or right, depending on the language.
609 The arrow keys should be bound to #LFUN_CHAR_LEFT or
610 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
611 * \li Syntax: char-forward
614 { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit },
616 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD_SELECT
617 * \li Action: Moves the cursor one position logically forward, adding
618 traversed position to the selection.
619 * \li Notion: See also #LFUN_CHAR_FORWARD.
620 * \li Syntax: char-forward-select
623 { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit },
625 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT
626 * \li Action: Moves the cursor one position "to the left".
627 * \li Notion: This is the action which should be taken when the "left" key
628 is pressed. Generally, it moves the cursor one position to the
629 left. However, in Bidi text this become slightly more
630 complicated, and there are different modes of cursor movement.
631 In "visual mode", this moves left, plain and simple. In "logical
632 mode", movement is logically forward in RTL paragraphs, and
633 logically backwards in LTR paragraphs.
634 * \li Syntax: char-left
637 { LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit },
639 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT_SELECT
640 * \li Action: Moves the cursor one position "to the left", adding
641 traversed position to the selection.
642 * \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement.
643 * \li Syntax: char-left-select
646 { LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit },
648 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT
649 * \li Action: Moves the cursor one position "to the right".
650 * \li Notion: This is the action which should be taken when the "right" key
651 is pressed. Generally, it moves the cursor one position to the
652 right. However, in Bidi text this become slightly more
653 complicated, and there are different modes of cursor movement.
654 In "visual mode", this moves right, plain and simple. In "logical
655 mode", movement is logically forward in LTR paragraphs, and
656 logically backwards in RTL paragraphs.
657 * \li Syntax: char-right
660 { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit },
662 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT_SELECT
663 * \li Action: Moves the cursor one position "to the right", adding
664 traversed position to the selection.
665 * \li Notion: See also #LFUN_CHAR_RIGHT for exact details of the movement.
666 * \li Syntax: char-right-select
669 { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit },
672 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD
673 * \li Action: Moves the cursor to the logically previous beginning of a word.
674 * \li Notion: This is not the action which should be bound to the arrow keys,
675 because backwards may be left or right, depending on the
676 language. The arrow keys should be bound to #LFUN_WORD_LEFT or
677 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
678 * \li Syntax: word-backward
681 { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit },
683 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD_SELECT
684 * \li Action: Moves the cursor to the logically previous beginning of a word,
685 adding the logically traversed text to the selection.
686 * \li Notion: See also #LFUN_WORD_BACKWARD.
687 * \li Syntax: word-backward-select
690 { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
692 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_BACKWARD
693 * \li Action: Deletes characters to the begining of the word (usually the "C+BackSpace" key).
694 * \li Syntax: word-delete-backward
697 { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
699 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_FORWARD
700 * \li Action: Deletes characters to the end of the word (usually the "C+Delete" key).
701 * \li Syntax: word-delete-forward
704 { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
706 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_FORWARD
707 * \li Action: Search for a given string in forward direction.
708 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
709 * \li Syntax: word-find-forward [<STRING>]
710 * \li Origin: Etienne, 16 Feb 1998
713 { LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit },
715 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_BACKWARD
716 * \li Action: Search for a given string in backward direction.
717 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
718 * \li Syntax: word-find-backward [<STRING>]
719 * \li Origin: Etienne, 20 Feb 1998
722 { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
724 * \var lyx::FuncCode lyx::LFUN_WORD_FIND
725 * \li Action: Search for next occurence of a string.
726 * \li Syntax: word-find [<DATA>]
727 * \li Params: <DATA>: data encoded from Find dialog (see #lyx::find2string()).
728 If no parameter is given, search with last find-dialog
729 data is used for search (i.e. find-next).
730 * \li Origin: poenitz, Jan 7 2004
733 { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
734 { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
736 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD
737 * \li Action: Moves the cursor to the logically next beginning of a word.
738 * \li Notion: This is not the action which should be bound to the arrow keys,
739 because forward may be left or right, depending on the language.
740 The arrow keys should be bound to #LFUN_WORD_LEFT or
741 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
742 * \li Syntax: word-forward
745 { LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
747 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD_SELECT
748 * \li Action: Moves the cursor to the logically next beginning of a word,
749 adding the logically traversed text to the selection.
750 * \li Notion: See also #LFUN_WORD_FORWARD.
751 * \li Syntax: word-forward-select
754 { LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
756 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT
757 * \li Action: Moves the cursor to the next beginning of a word "on the left".
758 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
759 "left" key is pressed. Generally, it moves the cursor to the
760 next beginning of a word on the left. However, in Bidi text this
761 become slightly more complicated, and there are different modes
762 of cursor movement. In "visual mode", this moves left, plain and
763 simple. In "logical mode", movement is logically forward in RTL
764 paragraphs, and logically backwards in LTR paragraphs.
765 * \li Syntax: word-left
766 * \li Origin: dov, 28 Oct 2007
769 { LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
771 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT_SELECT
772 * \li Action: Moves the cursor to the next beginning of a word "on the left",
773 adding *logically* traversed text to the selection.
774 * \li Notion: See also #LFUN_WORD_LEFT for exact details of the movement.
775 * \li Syntax: word-left-select
776 * \li Origin: dov, 28 Oct 2007
779 { LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit },
781 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT
782 * \li Action: Moves the cursor to the next beginning of a word "on the right".
783 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
784 "right" key is pressed. Generally, it moves the cursor to the
785 next beginning of a word on the right. However, in Bidi text
786 this become slightly more complicated, and there are different
787 modes of cursor movement. In "visual mode", this moves right,
788 plain and simple. In "logical mode", movement is logically
789 forward in LTR paragraphs, and logically backwards in RTL
791 * \li Syntax: word-right
792 * \li Origin: dov, 28 Oct 2007
795 { LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit },
797 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT_SELECT
798 * \li Action: Moves the cursor to the next beginning of a word "on the right",
799 adding *logically* traversed text to the selection.
800 * \li Notion: See also #LFUN_WORD_RIGHT for exact details of the movement.
801 * \li Syntax: word-right-select
802 * \li Origin: dov, 28 Oct 2007
805 { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
806 { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
808 * \var lyx::FuncCode lyx::LFUN_WORD_CAPITALIZE
809 * \li Action: Capitalizes the words in the selection (i.e. the first letters)
810 or the letter on the cursor position.
811 * \li Syntax: word-capitalize
814 { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
816 * \var lyx::FuncCode lyx::LFUN_WORD_UPCASE
817 * \li Action: Change the words in the selection or from the cursor position
818 to the end of word to the upper case.
819 * \li Syntax: word-upcase
822 { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
824 * \var lyx::FuncCode lyx::LFUN_WORD_LOWCASE
825 * \li Action: Change the words in the selection or from the cursor position
826 to the end of word to the lower case.
827 * \li Syntax: word-lowcase
830 { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
832 * \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
833 * \li Action: Look up thesaurus entries with respect to the word under the cursor.
834 * \li Syntax: thesaurus-entry
835 * \li Origin: Levon, 20 Jul 2001
838 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
839 { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
840 { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
841 { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
842 { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
844 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
845 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
846 { LFUN_LINE_DELETE, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
847 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
848 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
850 * \var lyx::FuncCode lyx::LFUN_COPY
851 * \li Action: Copies to the clipboard the last edit.
855 { LFUN_COPY, "copy", ReadOnly, Edit },
857 * \var lyx::FuncCode lyx::LFUN_CUT
858 * \li Action: Cuts to the clipboard.
862 { LFUN_CUT, "cut", Noop, Edit },
864 * \var lyx::FuncCode lyx::LFUN_PASTE
865 * \li Action: Pastes from the active clipboard.
869 { LFUN_PASTE, "paste", Noop, Edit },
870 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
872 * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
873 * \li Action: Pastes the material currently selected.
874 * \li Syntax: primary-selection-paste
877 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
879 * \var lyx::FuncCode lyx::LFUN_UNDO
880 * \li Action: Undoes the last edit.
884 { LFUN_UNDO, "undo", Noop, Edit },
886 * \var lyx::FuncCode lyx::LFUN_REDO
887 * \li Action: Redoes the last thing undone.
891 { LFUN_REDO, "redo", Noop, Edit },
893 * \var lyx::FuncCode lyx::LFUN_REPEAT
894 * \li Action: Repeat the given command.
895 * \li Syntax: repeat <COUNT> <LFUN-COMMAND>
896 * \li Author: poenitz, 27 Oct 2003
899 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
901 * \var lyx::FuncCode lyx::LFUN_CHARS_TRANSPOSE
902 * \li Action: Transposes the character at the cursor with the one before it.
903 * \li Syntax: chars-transpose
904 * \li Author: Lgb, 25 Apr 2001
907 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
909 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
910 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
911 { LFUN_ENVIRONMENT_INSERT, "environment-insert", Noop, Edit },
914 * \var lyx::FuncCode lyx::LFUN_FONT_BOLD
915 * \li Action: Toggles the bold font (selection-wise).
916 * \li Syntax: font-bold
919 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
921 * \var lyx::FuncCode lyx::LFUN_FONT_TYPEWRITER
922 * \li Action: Toggles the typewriter family font (selection-wise).
923 * \li Syntax: font-typewriter
926 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
928 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERLINE
929 * \li Action: Toggles underline in the font (selection-wise).
930 * \li Syntax: font-underline
933 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
935 * \var lyx::FuncCode lyx::LFUN_FONT_EMPH
936 * \li Action: Toggles the emphasis font style (selection-wise).
937 * \li Syntax: font-emph
940 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
942 * \var lyx::FuncCode lyx::LFUN_FONT_NOUN
943 * \li Action: Toggles Noun text style font (selection-wise).
944 * \li Syntax: font-noun
947 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
949 * \var lyx::FuncCode lyx::LFUN_FONT_ROMAN
950 * \li Action: Toggles Roman family font (selection-wise).
951 * \li Syntax: font-roman
954 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
956 * \var lyx::FuncCode lyx::LFUN_FONT_SANS
957 * \li Action: Toggles Sans Serif family font (selection-wise).
958 * \li Syntax: font-sans
961 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
963 * \var lyx::FuncCode lyx::LFUN_FONT_FRAK
964 * \li Action: Toggles Fraktur family font (math-mode, selection-wise).
965 * \li Syntax: font-frak
966 * \li Origin: vermeer, 10 Jan 2002
969 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
971 * \var lyx::FuncCode lyx::LFUN_FONT_ITAL
972 * \li Action: Toggles Italics font shape (math-mode, selection-wise).
973 * \li Syntax: font-ital
974 * \li Origin: vermeer, 10 Jan 2002
977 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
979 * \var lyx::FuncCode lyx::LFUN_FONT_DEFAULT
980 * \li Action: Reverts the settings of the font to the default values (selection-wise).
981 * \li Syntax: font-default
984 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
985 { LFUN_FONT_FREE_APPLY, "font-free-apply", Noop, Layout },
986 { LFUN_FONT_FREE_UPDATE, "font-free-update", Noop, Layout },
987 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
988 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
990 * \var lyx::FuncCode lyx::LFUN_FONT_STATE
991 * \li Action: Returns the info about the current font.
992 * \li Syntax: font-state
995 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
997 { LFUN_BIBITEM_INSERT, "bibitem-insert", Noop, Edit },
998 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
999 { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit },
1000 { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
1003 * \var lyx::FuncCode lyx::LFUN_LAYOUT
1004 * \li Action: Sets the layout (that is, environment) for the current paragraph.
1005 * \li Syntax: layout <LAYOUT>
1006 * \li Params: <LAYOUT>: the layout to use
1009 { LFUN_LAYOUT, "layout", Noop, Layout },
1011 * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH
1012 * \li Action: Launches the paragraph settings dialog.
1013 * \li Syntax: layout-paragraph
1016 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
1018 * \var lyx::FuncCode lyx::LFUN_LAYOUT_TABULAR
1019 * \li Action: Launches the tabular settings dialog.
1020 * \li Syntax: layout-tabular
1021 * \li Origin: Jug, 31 Jul 2000
1024 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
1026 * \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE
1027 * \li Action: Displays list of layout choices.
1028 * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
1029 dropbox allowing for choice of layout.
1030 * \li Syntax: drop-layouts-choice
1033 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
1035 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
1036 * \li Action: Clears the module list.
1037 * \li Notion: Clears the list of included modules for the current buffer.
1038 * \li Syntax: layout-modules-clear
1039 * \li Origin: rgh, 25 August 2007
1042 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", Noop, Layout },
1044 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULE_ADD
1045 * \li Action: Adds a module.
1046 * \li Notion: Adds a module to the list of included modules for the current buffer.
1047 * \li Syntax: layout-module-add <MODULE>
1048 * \li Params: <MODULE>: the module to be added
1049 * \li Origin: rgh, 25 August 2007
1052 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", Noop, Layout },
1054 * \var lyx::FuncCode lyx::LFUN_LAYOUT_RELOAD
1055 * \li Action: Reloads layout information.
1056 * \li Notion: Reloads all layout information for the current buffer from disk, thus
1057 recognizing any changes that have been made to layout files on the fly.
1058 This is intended to be used only by layout developers and should not be
1059 used when one is trying to do actual work.
1060 * \li Syntax: layout-reload
1061 * \li Origin: rgh, 3 September 2007
1064 { LFUN_LAYOUT_RELOAD, "layout-reload", Noop, Layout },
1066 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
1067 * \li Action: Sets the text class for the current buffer.
1068 * \li Syntax: textclass-apply <TEXTCLASS>
1069 * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
1070 the filename, minus the ".layout" extension.
1073 { LFUN_TEXTCLASS_APPLY, "textclass-apply", Noop, Layout },
1075 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
1076 * \li Action: Loads information for a textclass from disk.
1077 * \li Syntax: textclass-load <TEXTCLASS>
1078 * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
1079 the filename, minus the ".layout" extension.
1082 { LFUN_TEXTCLASS_LOAD, "textclass-load", Noop, Layout },
1085 * \var lyx::FuncCode lyx::LFUN_MARK_OFF
1086 * \li Action: Disable selecting of text-region.
1087 * \li Syntax: mark-off
1090 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
1092 * \var lyx::FuncCode lyx::LFUN_MARK_ON
1093 * \li Action: Enable selecting of text-region.
1094 * \li Notion: After enabling you can simply move arrow keys to get selected region.
1095 * \li Syntax: mark-on
1098 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
1100 * \var lyx::FuncCode lyx::LFUN_MARK_TOGGLE
1101 * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
1102 * \li Syntax: mark-toggle
1103 * \li Origin: poenitz, May 5 2006
1106 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
1108 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
1109 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
1110 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
1111 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
1112 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
1113 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
1114 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
1115 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
1116 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
1117 { LFUN_MATH_SPACE, "math-space", Noop, Math },
1118 { LFUN_MATH_IMPORT_SELECTION, "math-import-selection", Noop, Math },
1119 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
1120 { LFUN_MATH_MODE, "math-mode", Noop, Math },
1122 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
1123 * \li Action: Toggles numbering of the current formula line.
1124 * \li Notion: Must be in display formula mode.
1125 * \li Syntax: math-number-line-toggle
1126 * \li Origin: Alejandro 18 Jun 1996
1129 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
1131 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
1132 * \li Action: Toggles numbering/labeling of the current formula.
1133 * \li Notion: Must be in display formula mode.
1134 * \li Syntax: math-number-toggle
1135 * \li Origin: Alejandro 4 Jun 1996
1138 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
1139 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
1140 { LFUN_MATH_SIZE, "math-size", Noop, Math },
1142 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
1143 * \li Action: Unfold a Math Macro.
1144 * \li Notion: Unfold the Math Macro the cursor is in, i.e.
1146 * \li Syntax: math-macro-unfold
1147 * \li Origin: sts, 06 January 2008
1150 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
1152 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
1153 * \li Action: Fold a Math Macro.
1154 * \li Notion: Fold the Math Macro the cursor is in if it was
1155 unfolded, i.e. displayed as \foo before.
1156 * \li Syntax: math-macro-fold
1157 * \li Origin: sts, 06 January 2008
1160 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
1162 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
1163 * \li Action: Add a parameter.
1164 * \li Notion: Add a parameter to a Math Macro.
1165 * \li Params: <NUM>: The number of the parameter behind which the new one
1166 will be added (1 for the first, i.e. use 0 for add a
1167 parameter at the left), defaults to the last one.
1168 * \li Syntax: math-macro-add-param <NUM>
1169 * \li Origin: sts, 06 January 2008
1172 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
1174 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
1175 * \li Action: Remove the last parameter.
1176 * \li Notion: Remove the last parameter of a Math Macro and
1177 remove its value in all instances of the macro
1179 * \li Params: <NUM>: The number of the parameter to be deleted (1 for
1180 the first), defaults to the last one.
1181 * \li Syntax: math-macro-remove-param <NUM>
1182 * \li Origin: sts, 06 January 2008
1185 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
1187 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
1188 * \li Action: Append a greedy parameter.
1189 * \li Notion: Append a greedy parameter to a Math Macro which
1190 eats the following mathed cell in every instance of
1191 the macro in the buffer.
1192 * \li Syntax: math-macro-append-greedy-param
1193 * \li Origin: sts, 06 January 2008
1196 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
1198 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
1199 * \li Action: Remove a greedy parameter.
1200 * \li Notion: Remove a greedy parameter of a Math Macro and spit
1201 out the values of it in every instance of the macro
1202 in the buffer. If it is an optional parameter the [valud]
1204 * \li Syntax: math-macro-remove-greedy-param
1205 * \li Origin: sts, 06 January 2008
1208 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
1210 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
1211 * \li Action: Make a parameter optional.
1212 * \li Notion: Turn the first non-optional parameter of a Math Macro
1213 into an optional parameter with a default value.
1214 * \li Syntax: math-macro-make-optional
1215 * \li Origin: sts, 06 January 2008
1218 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
1220 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
1221 * \li Action: Make a parameter non-optional.
1222 * \li Notion: Turn the last optional parameter of a Math Macro
1223 into a non-optional parameter. The default value is
1224 remembered to be reused later if the user changes his mind.
1225 * \li Syntax: math-macro-make-nonoptional
1226 * \li Origin: sts, 06 January 2008
1229 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
1231 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
1232 * \li Action: Add an optional parameter.
1233 * \li Notion: Insert an optional parameter just behind the
1234 already existing optional parameters.
1235 * \li Syntax: math-macro-add-optional-param
1236 * \li Origin: sts, 06 January 2008
1239 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
1241 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
1242 * \li Action: Remove the last optional parameter.
1243 * \li Notion: Remove the last optional parameter of a Math Macro and
1244 remove it in all the instances of the macro in the buffer.
1245 * \li Syntax: math-macro-remove-optional-param
1246 * \li Origin: sts, 06 January 2008
1249 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
1251 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
1252 * \li Action: Add a greedy optional parameter.
1253 * \li Notion: Add a greedy optional parameter which eats the value
1254 from the following cells in mathed which are in the [value]
1256 * \li Syntax: math-macro-add-greedy-optional-param
1257 * \li Origin: sts, 06 January 2008
1260 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
1262 * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
1263 * \li Action: Only active in Math Macro definition.
1264 * \li Notion: Dummy function which is only active in a Math Macro definition.
1265 It's used to toggle the Math Macro toolbar if the cursor moves
1266 into a Math Macro definition.
1267 * \li Syntax: in-mathmacrotemplate
1268 * \li Origin: sts, 06 January 2008
1271 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
1274 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
1275 * \li Action: Moves the current paragraph downwards in the document.
1276 * \li Syntax: paragraph-move-down
1277 * \li Origin: Edwin, 8 Apr 2006
1280 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
1282 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
1283 * \li Action: Moves the current paragraph upwards in the document.
1284 * \li Syntax: paragraph-move-up
1285 * \li Origin: Edwin, 8 Apr 2006
1288 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
1291 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP
1292 * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1293 in upward direction.
1294 * \li Syntax: paragraph-up
1295 * \li Origin: Asger, 1 Oct 1996
1298 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
1300 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP_SELECT
1301 * \li Action: Move the cursor and select the text to the next paragraph (or
1302 begining of the current one) in upward direction.
1303 * \li Syntax: paragraph-up-select
1304 * \li Origin: Asger, 1 Oct 1996
1307 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
1309 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN
1310 * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1311 in downward direction.
1312 * \li Syntax: paragraph-down
1313 * \li Origin: Asger, 1 Oct 1996
1316 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
1318 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN_SELECT
1319 * \li Action: Move the cursor and select the text to the next paragraph (or
1320 begining of the current one) in downward direction.
1321 * \li Syntax: paragraph-down-select
1322 * \li Origin: Asger, 1 Oct 1996
1325 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
1327 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
1328 * \li Action: Jump to a paragraph given by its id number and optionally the
1329 desired position within the paragraph.
1330 * \li Notion: Note that id number of paragraph is not the sequential number of paragraph
1331 seen on the screen. Moreover the id is unique for all opened buffers (documents).
1332 * \li Syntax: paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
1333 * \li Params: <PAR_ID_NUMBER>: paragraph id
1334 <POSITION_IN_PAR>: desired position within the paragraph
1335 * \li Origin: Dekel, 26 Aug 2000
1338 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly, Edit },
1340 * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1341 * \li Action: Breaks the current paragraph at the current location.
1342 * \li Syntax: break-paragraph
1345 { LFUN_PARAGRAPH_SPACING, "paragraph-spacing", Noop, Edit },
1347 * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1348 * \li Action: Breaks the current paragraph at the current location.
1349 * \li Notion: Removes the selection.
1350 * \li Syntax: break-paragraph [<LAYOUT>]
1351 * \li Params: <LAYOUT>: "inverse" - decreases depth by one (or change layout
1352 to default layout) when the cursor is at the end of
1356 { LFUN_BREAK_PARAGRAPH, "break-paragraph", Noop, Edit },
1358 * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH_SKIP
1359 * \li Action: Breaks the current paragraph at the current location,
1360 unless used at the beginning of a line, where it sets
1361 the label width string to empty.
1362 * \li Syntax: break-paragraph-skip
1365 { LFUN_BREAK_PARAGRAPH_SKIP, "break-paragraph-skip", Noop, Edit },
1367 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
1368 * \li Action: Change paragraph settings.
1369 * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
1370 This function only modifies, and does not override, existing settings.
1371 Note that the "leftindent" indent setting is deprecated.
1372 * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
1373 * \li Params: <INDENT>: \\noindent|\\indent|\\indent-toggle|\\leftindent LENGTH\n
1374 <SPACING>: \\paragraph_spacing default|single|onehalf|double|other\n
1375 <ALIGN>: \\align block|left|right|center|default\n
1376 <OTHERS>: \\labelwidthstring WIDTH|\\start_of_appendix\n
1377 * \li Origin: rgh, Aug 15 2007
1380 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
1382 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
1383 * \li Action: Change paragraph settings.
1384 * \li Notion: Overwrite all nonspecified settings to the default ones.
1385 Use paragraph-params lfun if you don't want to overwrite others settings.
1386 * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
1387 * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
1388 * \li Origin: leeming, 30 Mar 2004
1391 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
1392 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
1395 * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
1396 * \li Action: Move the current group in the upward direction in the
1397 structure of the document.
1398 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1399 the whole substructure of the group.
1400 * \li Syntax: outline-up
1401 * \li Origin: Vermeer, 23 Mar 2006
1404 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
1406 * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
1407 * \li Action: Move the current group in the downward direction in the
1408 structure of the document.
1409 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1410 the whole substructure of the group.
1411 * \li Syntax: outline-down
1412 * \li Origin: Vermeer, 23 Mar 2006
1415 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
1417 * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
1418 * \li Action: Moves the current group in the downward direction in the
1419 hierarchy of the document structure.
1420 * \li Notion: Part -> Chapter -> Section -> etc.
1421 * \li Syntax: outline-in
1422 * \li Origin: Vermeer, 23 Mar 2006
1425 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
1427 * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
1428 * \li Action: Moves the current group in the upward direction in the
1429 hierarchy of the document structure.
1430 * \li Notion: Part <- Chapter <- Section <- etc.
1431 * \li Syntax: outline-out
1432 * \li Origin: Vermeer, 23 Mar 2006
1435 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
1437 * \var lyx::FuncCode lyx::LFUN_INSET_EDIT
1438 * \li Action: Edit the inset at cursor with an external application,
1439 * if one is attributed.
1440 * \li Syntax: inset-edit [<INSET_PARAMS>]
1441 * \li Params: <INSET_PARAMS>: Parameters for the inset.
1442 Currently only the filename will be considered.
1443 * \li Origin: JSpitzm, 27 Apr 2006
1446 { LFUN_INSET_EDIT, "inset-edit", Noop, Edit },
1448 { LFUN_CELL_BACKWARD, "cell-backward", Noop, Edit },
1449 { LFUN_CELL_FORWARD, "cell-forward", Noop, Edit },
1450 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
1451 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
1452 { LFUN_TABULAR_FEATURE, "tabular-feature", Noop, Edit },
1454 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
1455 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
1456 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
1457 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
1458 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
1460 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
1461 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
1462 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
1463 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
1464 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
1465 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
1466 { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
1467 { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
1470 * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
1471 * \li Action: Apply data for an inset.
1472 * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
1473 be applied. This is either changed to #LFUN_INSET_MODIFY or
1474 #LFUN_INSET_INSERT depending on the context where it is called.
1475 * \li Syntax: inset-apply <ARGS>
1476 * \li Params: See #LFUN_INSET_INSERT .
1479 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
1481 * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE
1482 * \li Action: Dissolve the current inset into text.
1483 * \li Syntax: inset-dissolve [<INSET>]
1484 * \li Params: <INSET>: this can be used to make sure the right kind of inset
1485 is dissolved. For example "dissolve" entry in the charstyles
1486 sub-menu should only dissolve the charstyle inset, even if the
1487 cursor is inside several nested insets of different type.\n
1488 For values see #lyx::InsetLayout::lyxtype_ .
1489 * \li Author: JSpitz, 7 Aug 2006
1492 { LFUN_INSET_DISSOLVE, "inset-dissolve", Noop, Edit },
1494 * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
1495 * \li Action: Insert new inset (type given by the parameters).
1496 * \li Syntax: inset-insert <INSET> <ARGS>
1497 * \li Params: <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics|
1498 hyperlink|include|index|label|nomencl|vspace|ref|toc>\n
1499 <ARGS>: depends on the given inset. Use "lyx -dbg action" to
1501 * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
1502 where <label name> is the name of the referenced label and
1503 <Format> is one of the following: \n
1504 ref -- <reference> \n
1505 eqref -- (<reference>) \n
1506 pageref -- <page> \n
1507 vpageref -- on <page> \n
1508 vref -- <reference> on <page> \n
1509 prettyref -- Formatted reference
1512 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
1514 * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
1515 * \li Action: Modify existing inset.
1516 * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1517 bibtex, ert, command, graphics, note, space, vspace, tabular,
1518 bibitem, inlude, ref insets.
1519 * \li Syntax: inset-modify <INSET> <ARGS>
1520 * \li Params: See #LFUN_INSET_INSERT for further details.
1523 { LFUN_INSET_MODIFY, "", Noop, Hidden },
1525 * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_MODIFY
1526 * \li Action: Modify the inset at cursor position, if there is one.
1527 * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1528 bibtex, ert, command, graphics, note, space, vspace, tabular,
1529 bibitem, inlude, ref insets.
1530 * \li Syntax: next-inset-modify <INSET> <ARGS> or next-inset-modify changetype <TYPE>
1531 * \li Params: See #LFUN_INSET_INSERT for further details.
1532 * \li Origin: JSpitzm, 23 Mar 2008
1535 { LFUN_NEXT_INSET_MODIFY, "next-inset-modify", ReadOnly, Edit },
1536 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
1538 * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
1539 * \li Action: Open the inset's properties dialog.
1540 * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
1541 * \li Syntax: inset-settings <INSET>
1542 * \li Params: <INSET>: <box|branch|ert|float|listings|note|tabular|wrap>
1545 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly, Edit },
1547 * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_TOGGLE
1548 * \li Action: Toggles the inset at cursor position. For collapsables, this means it will
1549 be (un-)collapsed, in case of other insets, the editing widget (dialog) will
1550 be entered. Also cf. #LFUN_INSET_SETTINGS.
1551 * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1552 bibtex, ert, command, graphics, note, space, vspace, tabular,
1553 bibitem, inlude, ref insets.
1554 * \li Syntax: next-inset-toggle <ARG>
1555 * \li Params: <ARG>: these are passed as arguments to #LFUN_INSET_TOGGLE .
1556 * \li Origin: leeming, 30 Mar 2004
1559 { LFUN_NEXT_INSET_TOGGLE, "next-inset-toggle", ReadOnly, Edit },
1561 * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
1562 * \li Action: Toggles the collapsable inset we are currently in.
1563 * \li Syntax: inset-toggle [<ARG>]
1564 * \li Params: <ARG>: <open|close|toggle|assign>. \n
1565 open/close/toggle are for collapsable insets. close can be currently used
1566 by #LFUN_NEXT_INSET_TOGGLE. toggle is used when no argument is given.\n
1567 assign is for branch inset.
1568 * \li Origin: lasgouttes, 19 Jul 2001
1571 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly, Hidden },
1573 * \var lyx::FuncCode lyx::LFUN_ALL_INSETS_TOGGLE
1574 * \li Action: Toggles (open/closes) all collapsable insets (of a given type) in the document.
1575 * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
1576 * \li Syntax: all-insets-toggle <STATE> <INSET>
1577 * \li Params: <STATE>: <toggle|open|close> default: toggle \n
1578 <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all insets \n
1579 * \li Origin: leeming, 30 Mar 2004
1582 { LFUN_ALL_INSETS_TOGGLE, "all-insets-toggle", ReadOnly, Edit },
1584 * \var lyx::FuncCode lyx::LFUN_GRAPHICS_GROUPS_UNIFY
1585 * \li Action: Unify all graphics insets with the one given as an parameter.
1586 * \li Notion: This is internally used for synchronize certain group of graphics insets.
1587 * \li Syntax: graphics-groups-unigfy <GRAPHICS_PARAMS>
1588 * \li Params: <GRAPHICS_PARAMS>: Parameters for graphics inset
1589 (syntax can be seen in .lyx files).
1590 * \li Origin: sanda, 6 May 2008
1593 { LFUN_GRAPHICS_GROUPS_UNIFY, "graphics-groups-unify", ReadOnly, Edit },
1595 * \var lyx::FuncCode lyx::LFUN_SET_GRAPHICS_GROUP
1596 * \li Action: Set the group for the graphics inset on the cursor position.
1597 * \li Syntax: set-graphics-group [<GROUP>]
1598 * \li Params: <GROUP>: Id for an existing group. In case tthe Id is an empty string,
1599 the graphics inset is removed from the current group.
1600 * \li Origin: sanda, 6 May 2008
1603 { LFUN_SET_GRAPHICS_GROUP, "set-graphics-group", ReadOnly, Edit },
1606 * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
1607 * \li Action: Moves the cursor out of the current slice, going forward.
1608 * \li Notion: Cursor movement within an inset may be different than cursor
1609 movement in the surrounding text. This action should be called
1610 automatically by the cursor movement within the inset, when
1611 movement within the inset has ceased (reached the end of the
1612 last paragraph, for example), in order to move correctly
1613 back into the surrounding text.
1616 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
1618 * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
1619 * \li Action: Moves the cursor out of the current slice, going backwards.
1620 * \li Notion: See also #LFUN_FINISHED_FORWARD.
1623 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
1625 * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
1626 * \li Action: Moves the cursor out of the current slice, going right.
1627 * \li Notion: See also #LFUN_FINISHED_FORWARD
1630 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
1632 * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
1633 * \li Action: Moves the cursor out of the current slice, going left.
1634 * \li Notion: See also #LFUN_FINISHED_FORWARD.
1637 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
1639 { LFUN_LANGUAGE, "language", Noop, Edit },
1642 * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
1643 * \li Action: Goto a label.
1644 * \li Syntax: label-goto [<LABEL>]
1645 * \li Params: <LABEL>: Requested label. If no label is given and refernce
1646 is on cursor position, Bookmark 0 is saved and
1647 cursor moves to the position of referenced label.
1648 * \li Origin: Ale, 6 Aug 1997
1651 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
1653 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT
1654 * \li Action: Inserts label to text or displayed formula.
1655 * \li Syntax: label-insert [<LABEL>]
1656 * \li Params: <LABEL>: Requested label. If no label is given dialog requesting
1657 name will be opened.
1660 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
1662 * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
1663 * \li Action: Go to the next label or cross-reference.
1664 * \li Syntax: reference-next
1665 * \li Origin: Dekel, 14 Jan 2001
1668 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
1671 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
1672 * \li Action: Goto a bookmark.
1673 * \li Notion: Moves the cursor to the numbered bookmark, opening the file
1674 if necessary. Note that bookmarsk are saved per-session, not
1676 * \li Syntax: bookmark-goto <NUMBER>
1677 * \li Params: <NUMBER>: the number of the bookmark to restore.
1678 * \li Origin: Dekel, 27 January 2001
1681 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
1683 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
1684 * \li Action: Save a bookmark.
1685 * \li Notion: Saves a numbered bookmark to the sessions file. The number
1686 must be between 1 and 9, inclusive. Note that bookmarks are
1687 saved per-session, not per file.
1688 * \li Syntax: bookmark-save <NUMBER>
1689 * \li Params: <NUMBER>: the number of the bookmark to save.
1690 * \li Origin: Dekel, 27 January 2001
1693 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
1695 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
1696 * \li Action: Clears the list of saved bookmarks.
1697 * \li Syntax: bookmark-clear
1698 * \li Origin: bpeng, 31 October 2006
1701 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
1704 * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
1705 * \li Action: Open the given help file according to the language setting.
1706 * \li Syntax: help-open <FILE>[.lyx]
1707 * \li Params: <FILE>: any document from (/usr/share/)doc directory.
1708 * \li Author: Jug, 27 Jun 1999
1711 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
1713 * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
1714 * \li Action: Terminates the current LyX instance.
1715 * \li Notion: Terminates the current LyX instance, asking whether to save
1716 modified documents, etc.
1717 * \li Syntax: lyx-quit
1720 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
1722 * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
1723 * \li Action: Toggles visibility of a given toolbar between on/off/auto.
1724 * \li Notion: Skiping "auto" when allowauto is false.
1725 * \li Syntax: toolbar-toggle <NAME> [allowauto]
1726 * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|
1727 minibuffer|review|view/update|math_panels
1728 * \li Origin: Edwin, 21 May 2007
1731 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
1733 * \var lyx::FuncCode lyx::LFUN_MENU_OPEN
1734 * \li Action: Opens the menu given by its name.
1735 * \li Syntax: menu-open <NAME>
1736 * \li Params: <NAME>: menu name. See various .inc files in lib/ui for candidates.
1739 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
1741 * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
1742 * \li Action: Various UI visibility-toggling actions.
1743 * \li Syntax: ui-toggle <statusbar|menubar|frame|fullscreen>
1744 * \li Params: statusbar : Toggle visibility of the statusbar.\n
1745 menubar : Toggle visibility of the menubar.\n
1746 scrollbar : Toggle visibility of the scrollbar.\n
1747 frame : Toggle visibility of the frames around editing window.\n
1748 fullscreen : Toggle fullscreen mode. This also covers calling the
1749 previous functions. However #LFUN_TOOLBAR_TOGGLE for the
1750 custom tweaks of the toolbars should be used.
1751 * \li Origin: ps, 9 Feb 2007
1754 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
1757 * \var lyx::FuncCode lyx::WINDOW_NEW
1758 * \li Action: Creates new empty LyX window.
1759 * \li Notion: Already opened documents from the previous window can be found under View menu.
1760 * \li Syntax: window-new [<GEOMETRY>]
1761 * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently
1762 accepted only on Windows platform.
1763 * \li Origin: Abdel, 21 Oct 2006
1766 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
1768 * \var lyx::FuncCode lyx::LFUN_WINDOW_CLOSE
1769 * \li Action: Closes the current LyX window.
1770 * \li Syntax: window-close
1771 * \li Origin: Abdel, 23 Oct 2006
1774 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
1777 * \var lyx::FuncCode lyx::LFUN_SPLIT_VIEW
1778 * \li Action: Creates another split view of current buffer.
1779 * \li Notion: All split views act in the same way indpendently.
1780 * \li Syntax: split-view <vertical|horizontal>
1781 * \li Params: horizontal : The work areas are laid out side by side.\n
1782 vertical : The work areas laid out vertically.\n
1783 * \li Origin: abdel, 20 Feb 2008
1786 { LFUN_SPLIT_VIEW, "split-view", ReadOnly, Buffer },
1789 * \var lyx::FuncCode lyx::LFUN_CLOSE_TAB_GROUP
1790 * \li Action: Close the current tab group.
1791 * \li Notion: This only closes the work areas, not the buffer themselves.
1792 The still opened buffers can be visualized in another tab group.
1793 * \li Syntax: close-tab-group
1794 * \li Origin: abdel, 21 Feb 2008
1797 { LFUN_CLOSE_TAB_GROUP, "close-tab-group", ReadOnly, Buffer },
1798 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
1799 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
1800 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
1801 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
1802 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
1803 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
1805 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
1806 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
1807 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
1808 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
1809 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
1811 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
1812 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
1813 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
1814 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
1816 { LFUN_SERVER_CHAR_AFTER, "server-char-after", ReadOnly, System },
1817 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
1818 { LFUN_SERVER_GET_NAME, "server-get-name", ReadOnly, System },
1820 * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
1821 * \li Action: Sets the cursor position based on the row number of generated TeX file.
1822 * \li Syntax: server-goto-file-row <LYX_FILE_NAME> <ROW_NUMBER>
1823 * \li Origin: Edmar, 23 Dec 1998
1826 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly, System },
1827 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
1829 * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
1830 * \li Action: Sets the cursor position based on the editing area coordinates
1831 (similar as clicking on that point with left mouse button).
1832 * \li Syntax: server-set-xy <X> <Y>
1835 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
1837 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
1838 * \li Action: Returns the coordinates of cursor position in the editing area.
1839 * \li Syntax: server-get-xy
1842 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
1845 * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
1846 * \li Action: Generates the code (literate programming).
1847 * \li Notion: Latex file with extension \literate_extension is generated.
1848 Then LyX invokes \build_command (with a default of``make'') to generate the code and
1849 \build_error_filter to process the compilation error messages. \n
1850 In case you want to process your literate file with a script, or some other program,
1851 just insert in your lyxrc file an entry with:\n
1852 \build_command "my_script my_arguments" \n
1853 The \build_error_filter differs from the \literate_error_filter only in that the
1854 former will identify error messages from your compiler.
1855 * \li Syntax: build-program
1858 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
1861 * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
1862 * \li Action: Saves the current buffer to a temporary file.
1863 * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
1864 is called automatically by LyX, to "autosave" the current buffer.
1865 * \li Syntax: buffer-auto-save
1868 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
1870 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHILD_OPEN
1871 * \li Action: Loads the given child document.
1872 * \li Notion: The current document is treated as a parent.
1873 * \li Syntax: buffer-child-open <FILE>
1874 * \li Params: <FILE>: Filename of the child. The directory of the parent is assumed by default.
1875 * \li Origin: Ale, 28 May 1997
1878 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
1880 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHKTEX
1881 * \li Action: Runs chktex for the current document.
1882 * \li Syntax: buffer-chktex
1883 * \li Origin: Asger, 30 Oct 1997
1886 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
1888 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
1889 * \li Action: Toggles compression of the current document on/off.
1890 * \li Syntax: buffer-toggle-compression
1891 * \li Origin: bpeng, 27 Apr 2006
1894 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
1896 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
1897 * \li Action: Closes the current buffer.
1898 * \li Notion: Closes the current buffer, asking whether to save it, etc,
1899 if the buffer has been modified.
1900 * \li Syntax: buffer-close
1903 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
1905 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
1906 * \li Action: Exports the current buffer (document) to the given format.
1907 * \li Syntax: buffer-export <FORMAT>
1908 * \li Params: <FORMAT> is either "custom" or one of the formats which you
1909 can find in Tools->Preferences->File formats->Format.
1910 Usual format you will enter is "pdf2" (pdflatex),
1911 "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
1912 In case of "custom" you will be asked for a format you
1913 want to start from and for the command that you want to
1914 apply to this format. Internally the control is then passed
1915 to #LFUN_BUFFER_EXPORT_CUSTOM.
1916 * \li Origin: Lgb, 29 Jul 1997
1919 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
1921 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
1922 * \li Action: Exports the current buffer (document) from the given format using
1923 the given command on it.
1924 * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
1925 * \li Params: <FORMAT> format to start from (LyX will care to produce such
1926 intermediate file).\n
1927 <COMMAND> this command will be launched on the file. Note that you can
1928 use "$$FName" string to qualify the intermediate file.
1929 * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
1930 * \li Origin: leeming, 27 Mar 2004
1933 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
1935 * \var lyx::FuncCode lyx::LFUN_BUFFER_PRINT
1936 * \li Action: Prints the current document.
1937 * \li Notion: Many settings can be given via the preferences dialog.
1938 * \li Syntax: buffer-print <TARGET> <TARGET-NAME> <COMMAND>
1939 * \li Params: <TARGET> is either "printer" or "file".\n
1940 <TARGER-NAME> is either "default" or file name or printer name.\n
1941 <COMMAND> command ensuring the printing job.
1942 * \li Sample: buffer-print file "/trash/newfile1.ps" "dvips"
1943 * \li Origin: leeming, 28 Mar 2004
1946 { LFUN_BUFFER_PRINT, "buffer-print", ReadOnly, Buffer },
1948 * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
1949 * \li Action: Import a given file as a lyx document.
1950 * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
1951 defined convertors in preferences. Look into File->Import menu to get
1952 an idea of the currently active import formats.
1953 * \li Syntax: buffer-import <FORMAT> [<FILE>]
1954 * \li Origin: Asger, 24 Jul 1998
1957 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
1959 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
1960 * \li Action: Creates a new buffer (that is, document).
1961 * \li Notion: Implicit path can be set in Preferences dialog.
1962 * \li Syntax: buffer-new [<FILE>]
1963 * \li Params: <FILE>: filename of created file with absolute path.
1966 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
1968 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
1969 * \li Action: Creates a new buffer (that is, document) from a template.
1970 * \li Notion: Path for new files and templates can be set in Preferences dialog.
1971 Template will be asked for via Open-dialog.
1972 * \li Syntax: buffer-new-template [<FILE>]
1973 * \li Params: <FILE>: filename of created file with absolute path.
1976 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
1978 * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
1979 * \li Action: Reverts opened document.
1980 * \li Syntax: buffer-reload
1981 * \li Origin: Asger, 2 Feb 1997
1984 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
1986 * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
1987 * \li Action: Switch to the given buffer.
1988 * \li Notion: This is useful also in case you need simultaneously more views of the edited
1989 document in different LyX windows.
1990 * \li Syntax: buffer-new-template <BUFFER>
1991 * \li Params: <BUFFER>: already opened document which is to be shown.
1994 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
1996 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
1997 * \li Action: Toggle editing mode of the current document between read/write and read-only.
1998 * \li Syntax: buffer-toggle-read-only
1999 * \li Origin: Lgb, 27 May 1997
2002 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
2004 * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
2005 * \li Action: Displays current buffer in chosen format.
2006 * \li Notion: Displays the contents of the current buffer in the chosen
2007 format, for example, PDF or DVI. This runs the necessary
2008 converter, calls the defined viewer, and so forth.
2009 * \li Syntax: buffer-view <FORMAT>
2010 * \li Params: <FORMAT>: The format to display, where this is one of the
2011 formats defined (in the current GUI) in the
2012 Tools>Preferences>File Formats dialog.
2015 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
2017 * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
2018 * \li Action: Exports the current document and put the result into the
2019 temporary directory.
2020 * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
2021 the output will be rewriten - updated. This is useful in case your viewer
2022 is able to detect such changes (e.g. ghostview for postscript).
2023 * \li Syntax: buffer-update <FORMAT>
2024 * \li Params: <FORMAT>: The format to display, where this is one of the
2025 formats defined (in the current GUI) in the
2026 Tools>Preferences>File Formats dialog.
2027 * \li Origin: Dekel, 5 Aug 2000
2030 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
2033 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
2034 * \li Action: Saves the current buffer.
2035 * \li Notion: Saves the current buffer to disk, using the filename that
2036 is already associated with the buffer, asking for one if
2037 none is yet assigned.
2038 * \li Syntax: buffer-write
2041 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
2043 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
2044 * \li Action: Rename and save current buffer.
2045 * \li Syntax: buffer-write-as <FILENAME>
2046 * \li Params: <FILENAME>: New name of the buffer/file. A relative path
2047 is with respect to the original location of the buffer/file.
2050 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
2052 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
2053 * \li Action: Save all changed documents.
2054 * \li Syntax: buffer-write-all
2055 * \li Origin: rgh, gpothier 6 Aug 2007
2058 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
2060 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEXT
2061 * \li Action: Switch to the next opened document.
2062 * \li Notion: Note that this does not necessarily mean next in tabbar
2063 (for full list see View menu).
2064 * \li Syntax: buffer-next
2067 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
2069 * \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS
2070 * \li Action: Switch to the previous opened document.
2071 * \li Syntax: buffer-previous
2074 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
2076 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
2077 * \li Action: When run from a child document, this updates (exports) document built
2078 from the master buffer. If a master is not found, it updates the
2080 * \li Syntax: master-buffer-update
2081 * \li Author: Tommaso, 20 Sep 2007
2084 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
2086 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
2087 * \li Action: When run from a child document, this command shows a preview built
2088 from the master buffer. If a master is not found, it previews the
2090 * \li Syntax: master-buffer-view
2091 * \li Author: Tommaso, 20 Sep 2007
2094 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
2096 * \var lyx::FuncCode lyx::LFUN_BUFFER_LANGUAGE
2097 * \li Action: Set language of the current document.
2098 * \li Syntax: buffer-language <LANG>
2099 * \li Params: <LANG>: language name. See lib/languages for list.
2100 * \li Author: leeming, 30 Mar 2004
2103 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
2105 * \var lyx::FuncCode lyx::LFUN_BUFFER_SAVE_AS_DEFAULT
2106 * \li Action: Save the current document settings as default.
2107 * \li Notion: The file will will be saved into ~/.lyx/templates/defaults.lyx .
2108 * \li Syntax: buffer-save-as-default [<ARGS>]
2109 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
2110 you can find in document header of usual .lyx file.
2111 * \li Author: leeming, 30 Mar 2004
2114 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
2116 * \var lyx::FuncCode lyx::LFUN_BUFFER_PARAMS_APPLY
2117 * \li Action: Apply the given settings to the current document.
2118 * \li Syntax: buffer-params-apply [<ARGS>]
2119 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
2120 you can find in document header of usual .lyx file.
2121 * \li Author: leeming, 30 Mar 2004
2124 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", Noop, Buffer },
2127 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
2128 * \li Action: Inserts another LyX file.
2129 * \li Syntax: file-insert [<FILE>]
2130 * \li Params: <FILE>: Filename to be inserted.
2133 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
2135 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
2136 * \li Action: Inserts plain text file.
2137 * \li Syntax: file-insert-plaintext [<FILE>]
2138 * \li Params: <FILE>: Filename to be inserted.
2139 * \li Origin: CFO-G, 19 Nov 1997
2142 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
2144 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
2145 * \li Action: Inserts plain text file as paragraph (i.e. join lines).
2146 * \li Syntax: file-insert-plaintext-para [<FILE>]
2147 * \li Params: <FILE>: Filename to be inserted.
2148 * \li Origin: Levon, 14 Feb 2001
2151 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
2153 * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
2154 * \li Action: Open LyX document.
2155 * \li Syntax: file-open [<FILE>]
2156 * \li Params: <FILE>: Filename to be opened.
2159 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
2162 * \var lyx::FuncCode lyx::LFUN_CALL
2163 * \li Action: Executes a command defined in a .def file.
2164 * \li Notion: The definitions are by default read from lib/commands/default.def.\n
2165 A .def file allows to define a command with \\define "<NAME>" "<LFUN>"
2166 where <NAME> is the name of the new command and <LFUN> is the lfun code
2167 to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
2168 \\def_file "FileName" allows to include another .def file. \n
2169 This is particularly useful in connection with toolbar buttons:
2170 Since the name of the button image for this lfun is
2171 lib/images/commands/<NAME>.png this is the way to assign an image
2172 to a complex command-sequence.
2173 * \li Syntax: call <NAME>
2174 * \li Params: <NAME>: Name of the command that must be called.
2175 * \li Origin: broider, 2 Oct 2007
2178 { LFUN_CALL, "call", NoBuffer, System },
2180 * \var lyx::FuncCode lyx::LFUN_META_PREFIX
2181 * \li Action: Simulate halting Meta key (Alt key on PCs).
2182 * \li Notion: Used for buffer editation not for GUI control.
2183 * \li Syntax: meta-prefix
2186 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
2188 * \var lyx::FuncCode lyx::LFUN_CANCEL
2189 * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
2190 * \li Syntax: cancel
2193 { LFUN_CANCEL, "cancel", NoBuffer, System },
2196 * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
2197 * \li Action: Opens the minibuffer toolbar so that the user can type in there.
2198 * \li Notion: Usually bound to M-x shortcut.
2199 * \li Syntax: command-execute
2202 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
2203 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
2205 * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
2206 * \li Action: Run more commands (LFUN and its parameters) in a sequence.
2207 * \li Syntax: command-sequence <CMDS>
2208 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
2209 * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
2210 * \li Origin: Andre', 11 Nov 1999
2213 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
2215 * \var lyx::FuncCode lyx::LFUN_MESSAGE
2216 * \li Action: Shows message in statusbar (for script purposes).
2217 * \li Syntax: message <STRING>
2218 * \li Origin: Lgb, 8 Apr 2001
2221 { LFUN_MESSAGE, "message", NoBuffer, System },
2223 * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
2224 * \li Action: Save user preferences.
2225 * \li Syntax: preferences-save
2226 * \li Origin: Lgb, 27 Nov 1999
2229 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
2231 * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
2232 * \li Action: Reconfigure the automatic settings.
2233 * \li Syntax: reconfigure
2234 * \li Origin: Asger, 14 Feb 1997
2237 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
2239 * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
2240 * \li Action: Apply the given settings to user preferences.
2241 * \li Syntax: lyxrc-apply <SETTINGS>
2242 * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
2243 to get an idea which commands to use and their syntax.
2244 #lyx::LyXRC::LyXRCTags has the list of possible commands.
2247 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
2249 * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
2250 * \li Action: Determine whether keep cursor inside the editing window regardless
2251 the scrollbar movement.
2252 * \li Syntax: toggle-cursor-follows-scrollbar
2253 * \li Origin: ARRae, 2 Dec 1997
2256 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
2258 * \var lyx::FuncCode lyx::LFUN_SET_COLOR
2259 * \li Action: Set the given LyX color to the color defined by the X11 name given.
2260 * \li Notion: A new color entry is created if the color is unknown.
2261 Color names can be stored as a part of user settings.
2262 * \li Syntax: set-color <LYX_NAME> <X11_NAME>
2263 * \li Origin: SLior, 11 Jun 2000
2266 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
2268 * \var lyx::FuncCode lyx::LFUN_STATISTICS
2269 * \li Action: Count the statistics (number of words and characters)
2270 in the document or in the given selection.
2271 * \li Notion: Note that this function gives the number of words/chars written,
2272 not the number of characters which will be typeset.
2273 * \li Syntax: statistics
2274 * \li Origin: lasgouttes, Jan 27 2004; ps, Jan 8 2008
2277 { LFUN_STATISTICS, "statistics", ReadOnly, System },
2279 * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
2280 * \li Action: Show the inline completion at the cursor position.
2281 * \li Syntax: completion-inline
2282 * \li Origin: sts, Feb 19 2008
2285 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
2287 * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
2288 * \li Action: Show the completion popup at the cursor position.
2289 * \li Syntax: completion-popup
2290 * \li Origin: sts, Feb 19 2008
2293 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
2295 * \var lyx::FuncCode lyx::LFUN_COMPLETION_COMPLETE
2296 * \li Action: Try to complete the word or command at the cursor position.
2297 * \li Syntax: completion-complete
2298 * \li Origin: sts, Feb 19 2008
2301 { LFUN_COMPLETION_COMPLETE, "complete", SingleParUpdate, Edit },
2303 * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
2304 * \li Action: Activate the branch
2305 * \li Syntax: branch-activate <BRANCH>
2306 * \li Params: <BRANCH>: The branch to activate
2307 * \li Sample: lyx -e pdf2 -x "branch-activate answers" finalexam.lyx \n
2308 could be used to export a pdf with the answers branch included
2309 without one's having to open LyX and activate the branch manually.
2310 * \li Origin: rgh, 27 May 2008
2313 { LFUN_BRANCH_ACTIVATE, "branch-activate", Argument, Buffer },
2315 * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
2316 * \li Action: De-activate the branch
2317 * \li Syntax: branch-deactivate <BRANCH>
2318 * \li Params: <BRANCH>: The branch to deactivate
2319 * \li Origin: rgh, 27 May 2008
2322 { LFUN_BRANCH_DEACTIVATE, "branch-deactivate", Argument, Buffer },
2324 { LFUN_NOACTION, "", Noop, Hidden }
2325 #ifndef DOXYGEN_SHOULD_SKIP_THIS
2328 for (int i = 0; items[i].action != LFUN_NOACTION; ++i) {
2329 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
2336 LyXAction::LyXAction()
2342 // Returns an action tag from a string.
2343 FuncRequest LyXAction::lookupFunc(string const & func) const
2345 string const func2 = trim(func);
2347 if (func2.empty()) {
2348 return FuncRequest(LFUN_NOACTION);
2352 string const arg = split(func2, cmd, ' ');
2354 func_map::const_iterator fit = lyx_func_map.find(cmd);
2356 return fit != lyx_func_map.end() ? FuncRequest(fit->second, arg) : FuncRequest(LFUN_UNKNOWN_ACTION);
2360 string const LyXAction::getActionName(FuncCode action) const
2362 info_map::const_iterator const it = lyx_info_map.find(action);
2363 return it != lyx_info_map.end() ? it->second.name : string();
2367 LyXAction::func_type const LyXAction::getActionType(FuncCode action) const
2369 info_map::const_iterator const it = lyx_info_map.find(action);
2370 return it != lyx_info_map.end() ? it->second.type : Hidden;
2374 bool LyXAction::funcHasFlag(FuncCode action,
2375 LyXAction::func_attrib flag) const
2377 info_map::const_iterator ici = lyx_info_map.find(action);
2379 if (ici == lyx_info_map.end()) {
2380 LYXERR0("action: " << action << " is not known.");
2381 LASSERT(false, /**/);
2384 return ici->second.attrib & flag;
2388 LyXAction::const_func_iterator LyXAction::func_begin() const
2390 return lyx_func_map.begin();
2394 LyXAction::const_func_iterator LyXAction::func_end() const
2396 return lyx_func_map.end();