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 "figure*" in LaTeX.
286 * \li Syntax: float-wide-insert <TYPE>
287 * \li Origin: Lgb, 31 Oct 2001
290 { LFUN_FLOAT_WIDE_INSERT, "float-wide-insert", Noop, Edit },
291 { LFUN_WRAP_INSERT, "wrap-insert", Noop, Edit },
293 * \var lyx::FuncCode lyx::LFUN_OPTIONAL_INSERT
294 * \li Action: Inserts an optional-argument (short title) inset.
295 * \li Syntax: optional-insert
296 * \li Origin: Martin, 12 Aug 2002
299 { LFUN_OPTIONAL_INSERT, "optional-insert", Noop, Edit },
301 * \var lyx::FuncCode lyx::LFUN_LINE_INSERT
302 * \li Action: Inserts a horizontal line.
303 * \li Syntax: line-insert
304 * \li Origin: poenitz, Oct 27 2003
307 { LFUN_LINE_INSERT, "line-insert", Noop, Edit },
309 * \var lyx::FuncCode lyx::LFUN_NEWPAGE_INSERT
310 * \li Action: Inserts a new page.
311 * \li Syntax: newpage-insert<ARG>
312 * \li Params: <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
313 * \li Origin: uwestoehr, 24 Nov 2007
316 { LFUN_NEWPAGE_INSERT, "newpage-insert", Noop, Edit },
318 * \var lyx::FuncCode lyx::LFUN_MARGINALNOTE_INSERT
319 * \li Action: Inserts a marginal note.
320 * \li Syntax: marginalnote-insert
321 * \li Origin: Lgb, 26 Jun 2000
324 { LFUN_MARGINALNOTE_INSERT, "marginalnote-insert", Noop, Edit },
326 * \var lyx::FuncCode lyx::LFUN_UNICODE_INSERT
327 * \li Action: Inserts a single unicode character.
328 * \li Syntax: unicode-insert <CHAR>
329 * \li Params: <CHAR>: The character to insert, given as its code
330 point, in hexadecimal, e.g.: unicode-insert 0x0100.
331 * \li Origin: Lgb, 22 Oct 2006
334 { LFUN_UNICODE_INSERT, "unicode-insert", Noop, Edit },
336 * \var lyx::FuncCode lyx::LFUN_LISTING_INSERT
337 * \li Action: Inserts a new listings inset.
338 * \li Syntax: listing-insert
339 * \li Origin: Herbert, 10 Nov 2001; bpeng, 2 May 2007
342 { LFUN_LISTING_INSERT, "listing-insert", Noop, Edit },
344 * \var lyx::FuncCode lyx::LFUN_QUOTE_INSERT
345 * \li Action: Inserts quotes according to the type and quote-language preference.
346 * \li Action: Currently English, Swedish, German, Polish, French, Danish quotes
348 * \li Syntax: quote-insert [<TYPE>]
349 * \li Params: TYPE: 'single' for single quotes, otherwise double quotes will be used.
352 { LFUN_QUOTE_INSERT, "quote-insert", Noop, Edit },
354 * \var lyx::FuncCode lyx::LFUN_INFO_INSERT
355 * \li Action: Displays shortcuts, lyxrc, package and textclass availability and menu
356 information in a non-editable boxed InsetText.
357 * \li Notion: Apart from lfun arguments you can use the following method: \n
358 1. input the type and argument of this inset, e.g. "menu paste", in
360 2. select the text and run info-insert lfun.\n
361 * \li Syntax: info-insert <TYPE> <ARG>
362 * \li Params: <TYPE>: shortcut|lyxrc|package|textclass|menu|buffer \n
363 <ARG>: argument for a given type. Look into InsetInfo.h for detailed
365 * \li Origin: bpeng, 7 Oct 2007
368 { LFUN_INFO_INSERT, "info-insert", Noop, Edit },
370 * \var lyx::FuncCode lyx::LFUN_BRANCH_INSERT
371 * \li Action: Inserts branch inset.
372 * \li Syntax: branch-insert <BRANCH-NAME>
373 * \li Origin: vermeer, 17 Aug 2003
376 { LFUN_BRANCH_INSERT, "branch-insert", Noop, Edit },
378 * \var lyx::FuncCode lyx::LFUN_BOX_INSERT
379 * \li Action: Inserts Box inset.
380 * \li Syntax: box-insert [<TYPE>]
381 * \li Params: <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox \n
382 Framed is the default one.
383 * \li Origin: vermeer, 7 Oct 2003
386 { LFUN_BOX_INSERT, "box-insert", Noop, Edit },
388 * \var lyx::FuncCode lyx::LFUN_FLEX_INSERT
389 * \li Action: Inserts CharStyle, Custom inset or XML short element.
390 * \li Notion: Look into the Customization manual for more information about
392 For dissolving the element see #LFUN_INSET_DISSOLVE.
393 * \li Syntax: flex-insert <TYPE:Name>
394 * \li Params: TYPE: CharStyle|Custom|Element|Standard
395 Identifies whether this is a Character Style, a
396 Custom Inset or an XML Element, and which dynamical
397 sub-menu this flex inset is in on the LyX menu tree.
398 If Standard (currently unused): none of these.
399 Name: This name must be defined either in your layout file
400 or imported by some module. The definition is\n
401 InsetLayout <TYPE:Name>
402 * \li Sample: flex-insert CharStyle:Code
405 { LFUN_FLEX_INSERT, "flex-insert", Noop, Edit },
407 * \var lyx::FuncCode lyx::LFUN_SELF_INSERT
408 * \li Action: Inserts the given string (accordingly to the correct keymap).
409 * \li Notion: Automatically replace the currently selected text. Depends on lyxrc
410 settings "auto_region_delete".
411 * \li Syntax: self-insert <STRING>
414 { LFUN_SELF_INSERT, "self-insert", SingleParUpdate, Hidden },
416 * \var lyx::FuncCode lyx::LFUN_SPACE_INSERT
417 * \li Action: Inserts one of horizontal space insets.
418 * \li Syntax: space-insert <NAME> [<LEN>]
419 * \li Params: <NAME>: normal, protected, thin, quad, qquad, enspace, enskip,
420 negthinspace, hfill, hfill*, dotfill, hrulefill, hspace,
422 <LEN>: length for custom spaces (hspace, hspace* for protected)
423 * \li Origin: JSpitzm, 20 May 2003, Mar 17 2008
426 { LFUN_SPACE_INSERT, "space-insert", Noop, Edit },
428 * \var lyx::FuncCode lyx::LFUN_HYPERLINK_INSERT
429 * \li Action: Inserts hyperlinks into the document (clickable in pdf output).
430 * \li Notion: Hyperlink target can be set via selection + hyperlink-insert function.
431 * \li Syntax: href-insert [<TARGET>]
432 * \li Origin: CFO-G, 21 Nov 1997
435 { LFUN_HYPERLINK_INSERT, "href-insert", Noop, Edit },
437 * \var lyx::FuncCode lyx::LFUN_SPECIALCHAR_INSERT
438 * \li Action: Inserts various characters into the document.
439 * \li Syntax: specialchar-insert <CHAR>
440 * \li Params: <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots,
441 end-of-sentence, menu-separator.
442 * \li Origin: JSpitzm, 6 Dec 2007
445 { LFUN_SPECIALCHAR_INSERT, "specialchar-insert", Noop, Edit },
447 * \var lyx::FuncCode lyx::LFUN_TOC_INSERT
448 * \li Action: Inserts table of contents.
449 * \li Syntax: toc-insert
450 * \li Origin: Lgb, 27 May 97
453 { LFUN_TOC_INSERT, "toc-insert", Noop, Edit },
455 * \var lyx::FuncCode lyx::LFUN_APPENDIX
456 * \li Action: Start (or remove) Appendix on the given cursor position.
457 * \li Syntax: appendix
458 * \li Origin: ettrich, 5 May 1998
461 { LFUN_APPENDIX, "appendix", Noop, Edit },
463 { LFUN_INDEX_INSERT, "index-insert", Noop, Edit },
464 { LFUN_INDEX_PRINT, "index-print", Noop, Edit },
466 { LFUN_NOMENCL_INSERT, "nomencl-insert", Noop, Edit },
467 { LFUN_NOMENCL_PRINT, "nomencl-print", Noop, Edit },
469 { LFUN_NOTE_INSERT, "note-insert", Noop, Edit },
470 { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
472 * \var lyx::FuncCode lyx::LFUN_NEWLINE_INSERT
473 * \li Action: Inserts a line break or new line.
474 * \li Syntax: newline-insert <ARG>
475 * \li Params: <ARG>: <newline|linebreak> default: newline
476 * \li Origin: JSpitzm, 25 Mar 2008
479 { LFUN_NEWLINE_INSERT, "newline-insert", Noop, Edit },
483 { LFUN_LIST_INSERT, "list-insert", Noop, Edit },
487 * \var lyx::FuncCode lyx::LFUN_ESCAPE
488 * \li Action: Clears the selection. If no text is selected call #LFUN_FINISHED_FORWARD.
490 * \li Origin: Lgb, 17 May 2001
493 { LFUN_ESCAPE, "escape", ReadOnly, Edit },
494 { LFUN_DELETE_BACKWARD_SKIP, "delete-backward-skip", Noop, Edit },
495 { LFUN_DELETE_FORWARD_SKIP, "delete-forward-skip", Noop, Edit },
496 { LFUN_DOWN, "down", ReadOnly | NoUpdate, Edit },
497 { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, Edit },
498 { LFUN_UP, "up", ReadOnly | NoUpdate, Edit },
499 { LFUN_UP_SELECT, "up-select", ReadOnly | SingleParUpdate, Edit },
500 { LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit },
501 { LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit },
503 * \var lyx::FuncCode lyx::LFUN_SCROLL
504 * \li Action: Scroll the buffer view.
505 * \li Notion: Only scrolls the screen up or down; does not move the cursor.
506 * \li Syntax: scroll <TYPE> <QUANTITY>
507 * \li Params: <TYPE>: line|page\n
508 <QUANTITY>: up|down|<number>
509 * \li Origin: Abdelrazak Younes, Dec 27 2007
512 { LFUN_SCROLL, "scroll", ReadOnly, Edit },
514 * \var lyx::FuncCode lyx::LFUN_SCREEN_RECENTER
515 * \li Action: Recenters the screen on the current cursor position.
516 * \li Syntax: screen-recenter
519 { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit },
520 { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit },
521 { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit },
523 { LFUN_ERROR_NEXT, "error-next", ReadOnly, Edit },
525 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD
526 * \li Action: Moves the cursor one position logically backwards.
527 * \li Notion: This is not the action which should be bound to the arrow keys,
528 because backwards may be left or right, depending on the
529 language. The arrow keys should be bound to #LFUN_CHAR_LEFT or
530 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
531 * \li Syntax: char-backward
534 { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit },
536 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD_SELECT
537 * \li Action: Moves the cursor one position logically backwards, adding
538 traversed position to the selection.
539 * \li Notion: See also #LFUN_CHAR_BACKWARD.
540 * \li Syntax: char-backward-select
543 { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit },
544 { LFUN_CHAR_DELETE_BACKWARD, "delete-backward", SingleParUpdate, Edit },
545 { LFUN_CHAR_DELETE_FORWARD, "delete-forward", SingleParUpdate, Edit },
547 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD
548 * \li Action: Moves the cursor one position logically forward.
549 * \li Notion: This is not the action which should be bound to the arrow keys,
550 because forward may be left or right, depending on the language.
551 The arrow keys should be bound to #LFUN_CHAR_LEFT or
552 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
553 * \li Syntax: char-forward
556 { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit },
558 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD_SELECT
559 * \li Action: Moves the cursor one position logically forward, adding
560 traversed position to the selection.
561 * \li Notion: See also #LFUN_CHAR_FORWARD.
562 * \li Syntax: char-forward-select
565 { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit },
567 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT
568 * \li Action: Moves the cursor one position "to the left".
569 * \li Notion: This is the action which should be taken when the "left" key
570 is pressed. Generally, it moves the cursor one position to the
571 left. However, in Bidi text this become slightly more
572 complicated, and there are different modes of cursor movement.
573 In "visual mode", this moves left, plain and simple. In "logical
574 mode", movement is logically forward in RTL paragraphs, and
575 logically backwards in LTR paragraphs.
576 * \li Syntax: char-left
579 { LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit },
581 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT_SELECT
582 * \li Action: Moves the cursor one position "to the left", adding
583 traversed position to the selection.
584 * \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement.
585 * \li Syntax: char-left-select
588 { LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit },
590 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT
591 * \li Action: Moves the cursor one position "to the right".
592 * \li Notion: This is the action which should be taken when the "right" key
593 is pressed. Generally, it moves the cursor one position to the
594 right. However, in Bidi text this become slightly more
595 complicated, and there are different modes of cursor movement.
596 In "visual mode", this moves right, plain and simple. In "logical
597 mode", movement is logically forward in LTR paragraphs, and
598 logically backwards in RTL paragraphs.
599 * \li Syntax: char-right
602 { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit },
604 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT_SELECT
605 * \li Action: Moves the cursor one position "to the right", adding
606 traversed position to the selection.
607 * \li Notion: See also #LFUN_CHAR_RIGHT for exact details of the movement.
608 * \li Syntax: char-right-select
611 { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit },
614 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD
615 * \li Action: Moves the cursor to the logically previous beginning of a word.
616 * \li Notion: This is not the action which should be bound to the arrow keys,
617 because backwards may be left or right, depending on the
618 language. The arrow keys should be bound to #LFUN_WORD_LEFT or
619 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
620 * \li Syntax: word-backward
623 { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit },
625 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD_SELECT
626 * \li Action: Moves the cursor to the logically previous beginning of a word,
627 adding the logically traversed text to the selection.
628 * \li Notion: See also #LFUN_WORD_BACKWARD.
629 * \li Syntax: word-backward-select
632 { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
633 { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
634 { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
636 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_FORWARD
637 * \li Action: Search for a given string in forward direction.
638 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
639 * \li Syntax: word-find-forward [<STRING>]
640 * \li Origin: Etienne, 16 Feb 1998
643 { LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit },
645 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_BACKWARD
646 * \li Action: Search for a given string in backward direction.
647 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
648 * \li Syntax: word-find-backward [<STRING>]
649 * \li Origin: Etienne, 20 Feb 1998
652 { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
654 * \var lyx::FuncCode lyx::LFUN_WORD_FIND
655 * \li Action: Search for next occurence of a string.
656 * \li Syntax: word-find [<DATA>]
657 * \li Params: <DATA>: data encoded from Find dialog (see #lyx::find2string()).
658 If no parameter is given, search with last find-dialog
659 data is used for search (i.e. find-next).
660 * \li Origin: poenitz, Jan 7 2004
663 { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
664 { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
666 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD
667 * \li Action: Moves the cursor to the logically next beginning of a word.
668 * \li Notion: This is not the action which should be bound to the arrow keys,
669 because forward may be left or right, depending on the language.
670 The arrow keys should be bound to #LFUN_WORD_LEFT or
671 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
672 * \li Syntax: word-forward
675 { LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
677 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD_SELECT
678 * \li Action: Moves the cursor to the logically next beginning of a word,
679 adding the logically traversed text to the selection.
680 * \li Notion: See also #LFUN_WORD_FORWARD.
681 * \li Syntax: word-forward-select
684 { LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
686 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT
687 * \li Action: Moves the cursor to the next beginning of a word "on the left".
688 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
689 "left" key is pressed. Generally, it moves the cursor to the
690 next beginning of a word on the left. However, in Bidi text this
691 become slightly more complicated, and there are different modes
692 of cursor movement. In "visual mode", this moves left, plain and
693 simple. In "logical mode", movement is logically forward in RTL
694 paragraphs, and logically backwards in LTR paragraphs.
695 * \li Syntax: word-left
696 * \li Origin: dov, 28 Oct 2007
699 { LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
701 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT_SELECT
702 * \li Action: Moves the cursor to the next beginning of a word "on the left",
703 adding *logically* traversed text to the selection.
704 * \li Notion: See also #LFUN_WORD_LEFT for exact details of the movement.
705 * \li Syntax: word-left-select
706 * \li Origin: dov, 28 Oct 2007
709 { LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit },
711 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT
712 * \li Action: Moves the cursor to the next beginning of a word "on the right".
713 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
714 "right" key is pressed. Generally, it moves the cursor to the
715 next beginning of a word on the right. However, in Bidi text
716 this become slightly more complicated, and there are different
717 modes of cursor movement. In "visual mode", this moves right,
718 plain and simple. In "logical mode", movement is logically
719 forward in LTR paragraphs, and logically backwards in RTL
721 * \li Syntax: word-right
722 * \li Origin: dov, 28 Oct 2007
725 { LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit },
727 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT_SELECT
728 * \li Action: Moves the cursor to the next beginning of a word "on the right",
729 adding *logically* traversed text to the selection.
730 * \li Notion: See also #LFUN_WORD_RIGHT for exact details of the movement.
731 * \li Syntax: word-right-select
732 * \li Origin: dov, 28 Oct 2007
735 { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
736 { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
738 * \var lyx::FuncCode lyx::LFUN_WORD_CAPITALIZE
739 * \li Action: Capitalizes the words in the selection (i.e. the first letters)
740 or the letter on the cursor position.
741 * \li Syntax: word-capitalize
744 { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
746 * \var lyx::FuncCode lyx::LFUN_WORD_UPCASE
747 * \li Action: Change the words in the selection or from the cursor position
748 to the end of word to the upper case.
749 * \li Syntax: word-upcase
752 { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
754 * \var lyx::FuncCode lyx::LFUN_WORD_LOWCASE
755 * \li Action: Change the words in the selection or from the cursor position
756 to the end of word to the lower case.
757 * \li Syntax: word-lowcase
760 { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
762 * \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
763 * \li Action: Look up thesaurus entries with respect to the word under the cursor.
764 * \li Syntax: thesaurus-entry
765 * \li Origin: Levon, 20 Jul 2001
768 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
769 { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
770 { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
771 { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
772 { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
774 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
775 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
776 { LFUN_LINE_DELETE, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
777 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
778 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
780 * \var lyx::FuncCode lyx::LFUN_COPY
781 * \li Action: Copies to the clipboard the last edit.
785 { LFUN_COPY, "copy", ReadOnly, Edit },
787 * \var lyx::FuncCode lyx::LFUN_CUT
788 * \li Action: Cuts to the clipboard.
792 { LFUN_CUT, "cut", Noop, Edit },
794 * \var lyx::FuncCode lyx::LFUN_PASTE
795 * \li Action: Pastes from the active clipboard.
799 { LFUN_PASTE, "paste", Noop, Edit },
800 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
802 * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
803 * \li Action: Pastes the material currently selected.
804 * \li Syntax: primary-selection-paste
807 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
809 * \var lyx::FuncCode lyx::LFUN_UNDO
810 * \li Action: Undoes the last edit.
814 { LFUN_UNDO, "undo", Noop, Edit },
816 * \var lyx::FuncCode lyx::LFUN_REDO
817 * \li Action: Redoes the last thing undone.
821 { LFUN_REDO, "redo", Noop, Edit },
823 * \var lyx::FuncCode lyx::LFUN_REPEAT
824 * \li Action: Repeat the given command.
825 * \li Syntax: repeat <COUNT> <LFUN-COMMAND>
826 * \li Author: poenitz, 27 Oct 2003
829 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
831 * \var lyx::FuncCode lyx::LFUN_CHARS_TRANSPOSE
832 * \li Action: Transposes the character at the cursor with the one before it.
833 * \li Syntax: chars-transpose
834 * \li Author: Lgb, 25 Apr 2001
837 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
839 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
840 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
841 { LFUN_ENVIRONMENT_INSERT, "environment-insert", Noop, Edit },
844 * \var lyx::FuncCode lyx::LFUN_FONT_BOLD
845 * \li Action: Toggles the bold font (selection-wise).
846 * \li Syntax: font-bold
849 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
851 * \var lyx::FuncCode lyx::LFUN_FONT_TYPEWRITER
852 * \li Action: Toggles the typewriter family font (selection-wise).
853 * \li Syntax: font-typewriter
856 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
858 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERLINE
859 * \li Action: Toggles underline in the font (selection-wise).
860 * \li Syntax: font-underline
863 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
865 * \var lyx::FuncCode lyx::LFUN_FONT_EMPH
866 * \li Action: Toggles the emphasis font style (selection-wise).
867 * \li Syntax: font-emph
870 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
872 * \var lyx::FuncCode lyx::LFUN_FONT_NOUN
873 * \li Action: Toggles Noun text style font (selection-wise).
874 * \li Syntax: font-noun
877 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
879 * \var lyx::FuncCode lyx::LFUN_FONT_ROMAN
880 * \li Action: Toggles Roman family font (selection-wise).
881 * \li Syntax: font-roman
884 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
886 * \var lyx::FuncCode lyx::LFUN_FONT_SANS
887 * \li Action: Toggles Sans Serif family font (selection-wise).
888 * \li Syntax: font-sans
891 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
893 * \var lyx::FuncCode lyx::LFUN_FONT_FRAK
894 * \li Action: Toggles Fraktur family font (math-mode, selection-wise).
895 * \li Syntax: font-frak
896 * \li Origin: vermeer, 10 Jan 2002
899 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
901 * \var lyx::FuncCode lyx::LFUN_FONT_ITAL
902 * \li Action: Toggles Italics font shape (math-mode, selection-wise).
903 * \li Syntax: font-ital
904 * \li Origin: vermeer, 10 Jan 2002
907 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
909 * \var lyx::FuncCode lyx::LFUN_FONT_DEFAULT
910 * \li Action: Reverts the settings of the font to the default values (selection-wise).
911 * \li Syntax: font-default
914 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
915 { LFUN_FONT_FREE_APPLY, "font-free-apply", Noop, Layout },
916 { LFUN_FONT_FREE_UPDATE, "font-free-update", Noop, Layout },
917 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
918 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
920 * \var lyx::FuncCode lyx::LFUN_FONT_STATE
921 * \li Action: Returns the info about the current font.
922 * \li Syntax: font-state
925 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
927 { LFUN_BIBITEM_INSERT, "bibitem-insert", Noop, Edit },
928 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
929 { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit },
930 { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
933 * \var lyx::FuncCode lyx::LFUN_LAYOUT
934 * \li Action: Sets the layout (that is, environment) for the current paragraph.
935 * \li Syntax: layout <LAYOUT>
936 * \li Params: <LAYOUT>: the layout to use
939 { LFUN_LAYOUT, "layout", Noop, Layout },
941 * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH
942 * \li Action: Launches the paragraph settings dialog.
943 * \li Syntax: layout-paragraph
946 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
948 * \var lyx::FuncCode lyx::LFUN_LAYOUT_TABULAR
949 * \li Action: Launches the tabular settings dialog.
950 * \li Syntax: layout-tabular
951 * \li Origin: Jug, 31 Jul 2000
954 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
956 * \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE
957 * \li Action: Displays list of layout choices.
958 * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
959 dropbox allowing for choice of layout.
960 * \li Syntax: drop-layouts-choice
963 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
965 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
966 * \li Action: Clears the module list.
967 * \li Notion: Clears the list of included modules for the current buffer.
968 * \li Syntax: layout-modules-clear
969 * \li Origin: rgh, 25 August 2007
972 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", Noop, Layout },
974 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULE_ADD
975 * \li Action: Adds a module.
976 * \li Notion: Adds a module to the list of included modules for the current buffer.
977 * \li Syntax: layout-module-add <MODULE>
978 * \li Params: <MODULE>: the module to be added
979 * \li Origin: rgh, 25 August 2007
982 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", Noop, Layout },
984 * \var lyx::FuncCode lyx::LFUN_LAYOUT_RELOAD
985 * \li Action: Reloads layout information.
986 * \li Notion: Reloads all layout information for the current buffer from disk, thus
987 recognizing any changes that have been made to layout files on the fly.
988 This is intended to be used only by layout developers and should not be
989 used when one is trying to do actual work.
990 * \li Syntax: layout-reload
991 * \li Origin: rgh, 3 September 2007
994 { LFUN_LAYOUT_RELOAD, "layout-reload", Noop, Layout },
996 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
997 * \li Action: Sets the text class for the current buffer.
998 * \li Syntax: textclass-apply <TEXTCLASS>
999 * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
1000 the filename, minus the ".layout" extension.
1003 { LFUN_TEXTCLASS_APPLY, "textclass-apply", Noop, Layout },
1005 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
1006 * \li Action: Loads information for a textclass from disk.
1007 * \li Syntax: textclass-load <TEXTCLASS>
1008 * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
1009 the filename, minus the ".layout" extension.
1012 { LFUN_TEXTCLASS_LOAD, "textclass-load", Noop, Layout },
1015 * \var lyx::FuncCode lyx::LFUN_MARK_OFF
1016 * \li Action: Disable selecting of text-region.
1017 * \li Syntax: mark-off
1020 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
1022 * \var lyx::FuncCode lyx::LFUN_MARK_ON
1023 * \li Action: Enable selecting of text-region.
1024 * \li Notion: After enabling you can simply move arrow keys to get selected region.
1025 * \li Syntax: mark-on
1028 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
1030 * \var lyx::FuncCode lyx::LFUN_MARK_TOGGLE
1031 * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
1032 * \li Syntax: mark-toggle
1033 * \li Origin: poenitz, May 5 2006
1036 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
1038 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
1039 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
1040 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
1041 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
1042 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
1043 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
1044 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
1045 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
1046 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
1047 { LFUN_MATH_SPACE, "math-space", Noop, Math },
1048 { LFUN_MATH_IMPORT_SELECTION, "math-import-selection", Noop, Math },
1049 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
1050 { LFUN_MATH_MODE, "math-mode", Noop, Math },
1052 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
1053 * \li Action: Toggles numbering of the current formula line.
1054 * \li Notion: Must be in display formula mode.
1055 * \li Syntax: math-number-line-toggle
1056 * \li Origin: Alejandro 18 Jun 1996
1059 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
1061 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
1062 * \li Action: Toggles numbering/labeling of the current formula.
1063 * \li Notion: Must be in display formula mode.
1064 * \li Syntax: math-number-toggle
1065 * \li Origin: Alejandro 4 Jun 1996
1068 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
1069 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
1070 { LFUN_MATH_SIZE, "math-size", Noop, Math },
1072 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
1073 * \li Action: Unfold a Math Macro.
1074 * \li Notion: Unfold the Math Macro the cursor is in, i.e.
1076 * \li Syntax: math-macro-unfold
1077 * \li Origin: sts, 06 January 2008
1080 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
1082 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
1083 * \li Action: Fold a Math Macro.
1084 * \li Notion: Fold the Math Macro the cursor is in if it was
1085 unfolded, i.e. displayed as \foo before.
1086 * \li Syntax: math-macro-fold
1087 * \li Origin: sts, 06 January 2008
1090 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
1092 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
1093 * \li Action: Add a parameter.
1094 * \li Notion: Add a parameter to a Math Macro.
1095 * \li Params: <NUM>: The number of the parameter behind which the new one
1096 will be added (1 for the first, i.e. use 0 for add a
1097 parameter at the left), defaults to the last one.
1098 * \li Syntax: math-macro-add-param <NUM>
1099 * \li Origin: sts, 06 January 2008
1102 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
1104 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
1105 * \li Action: Remove the last parameter.
1106 * \li Notion: Remove the last parameter of a Math Macro and
1107 remove its value in all instances of the macro
1109 * \li Params: <NUM>: The number of the parameter to be deleted (1 for
1110 the first), defaults to the last one.
1111 * \li Syntax: math-macro-remove-param <NUM>
1112 * \li Origin: sts, 06 January 2008
1115 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
1117 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
1118 * \li Action: Append a greedy parameter.
1119 * \li Notion: Append a greedy parameter to a Math Macro which
1120 eats the following mathed cell in every instance of
1121 the macro in the buffer.
1122 * \li Syntax: math-macro-append-greedy-param
1123 * \li Origin: sts, 06 January 2008
1126 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
1128 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
1129 * \li Action: Remove a greedy parameter.
1130 * \li Notion: Remove a greedy parameter of a Math Macro and spit
1131 out the values of it in every instance of the macro
1132 in the buffer. If it is an optional parameter the [valud]
1134 * \li Syntax: math-macro-remove-greedy-param
1135 * \li Origin: sts, 06 January 2008
1138 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
1140 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
1141 * \li Action: Make a parameter optional.
1142 * \li Notion: Turn the first non-optional parameter of a Math Macro
1143 into an optional parameter with a default value.
1144 * \li Syntax: math-macro-make-optional
1145 * \li Origin: sts, 06 January 2008
1148 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
1150 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
1151 * \li Action: Make a parameter non-optional.
1152 * \li Notion: Turn the last optional parameter of a Math Macro
1153 into a non-optional parameter. The default value is
1154 remembered to be reused later if the user changes his mind.
1155 * \li Syntax: math-macro-make-nonoptional
1156 * \li Origin: sts, 06 January 2008
1159 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
1161 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
1162 * \li Action: Add an optional parameter.
1163 * \li Notion: Insert an optional parameter just behind the
1164 already existing optional parameters.
1165 * \li Syntax: math-macro-add-optional-param
1166 * \li Origin: sts, 06 January 2008
1169 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
1171 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
1172 * \li Action: Remove the last optional parameter.
1173 * \li Notion: Remove the last optional parameter of a Math Macro and
1174 remove it in all the instances of the macro in the buffer.
1175 * \li Syntax: math-macro-remove-optional-param
1176 * \li Origin: sts, 06 January 2008
1179 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
1181 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
1182 * \li Action: Add a greedy optional parameter.
1183 * \li Notion: Add a greedy optional parameter which eats the value
1184 from the following cells in mathed which are in the [value]
1186 * \li Syntax: math-macro-add-greedy-optional-param
1187 * \li Origin: sts, 06 January 2008
1190 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
1192 * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
1193 * \li Action: Only active in Math Macro definition.
1194 * \li Notion: Dummy function which is only active in a Math Macro definition.
1195 It's used to toggle the Math Macro toolbar if the cursor moves
1196 into a Math Macro definition.
1197 * \li Syntax: in-mathmacrotemplate
1198 * \li Origin: sts, 06 January 2008
1201 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
1204 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
1205 * \li Action: Moves the current paragraph downwards in the document.
1206 * \li Syntax: paragraph-move-down
1207 * \li Origin: Edwin, 8 Apr 2006
1210 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
1212 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
1213 * \li Action: Moves the current paragraph upwards in the document.
1214 * \li Syntax: paragraph-move-up
1215 * \li Origin: Edwin, 8 Apr 2006
1218 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
1221 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP
1222 * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1223 in upward direction.
1224 * \li Syntax: paragraph-up
1225 * \li Origin: Asger, 1 Oct 1996
1228 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
1230 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP_SELECT
1231 * \li Action: Move the cursor and select the text to the next paragraph (or
1232 begining of the current one) in upward direction.
1233 * \li Syntax: paragraph-up-select
1234 * \li Origin: Asger, 1 Oct 1996
1237 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
1239 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN
1240 * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1241 in downward direction.
1242 * \li Syntax: paragraph-down
1243 * \li Origin: Asger, 1 Oct 1996
1246 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
1248 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN_SELECT
1249 * \li Action: Move the cursor and select the text to the next paragraph (or
1250 begining of the current one) in downward direction.
1251 * \li Syntax: paragraph-down-select
1252 * \li Origin: Asger, 1 Oct 1996
1255 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
1257 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
1258 * \li Action: Jump to a paragraph given by its id number and optionally the
1259 desired position within the paragraph.
1260 * \li Notion: Note that id number of paragraph is not the sequential number of paragraph
1261 seen on the screen. Moreover the id is unique for all opened buffers (documents).
1262 * \li Syntax: paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
1263 * \li Params: <PAR_ID_NUMBER>: paragraph id
1264 <POSITION_IN_PAR>: desired position within the paragraph
1265 * \li Origin: Dekel, 26 Aug 2000
1268 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly, Edit },
1270 * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1271 * \li Action: Breaks the current paragraph at the current location.
1272 * \li Syntax: break-paragraph
1275 { LFUN_PARAGRAPH_SPACING, "paragraph-spacing", Noop, Edit },
1277 * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1278 * \li Action: Breaks the current paragraph at the current location.
1279 * \li Notion: Removes the selection.
1280 * \li Syntax: break-paragraph [<LAYOUT>]
1281 * \li Params: <LAYOUT>: "inverse" - decreases depth by one (or change layout
1282 to default layout) when the cursor is at the end of
1286 { LFUN_BREAK_PARAGRAPH, "break-paragraph", Noop, Edit },
1288 * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH_SKIP
1289 * \li Action: Breaks the current paragraph at the current location,
1290 unless used at the beginning of a line, where it sets
1291 the label width string to empty.
1292 * \li Syntax: break-paragraph-skip
1295 { LFUN_BREAK_PARAGRAPH_SKIP, "break-paragraph-skip", Noop, Edit },
1297 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
1298 * \li Action: Change paragraph settings.
1299 * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
1300 This function only modifies, and does not override, existing settings.
1301 Note that the "leftindent" indent setting is deprecated.
1302 * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
1303 * \li Params: <INDENT>: \\noindent|\\indent|\\indent-toggle|\\leftindent LENGTH\n
1304 <SPACING>: \\paragraph_spacing default|single|onehalf|double|other\n
1305 <ALIGN>: \\align block|left|right|center|default\n
1306 <OTHERS>: \\labelwidthstring WIDTH|\\start_of_appendix\n
1307 * \li Origin: rgh, Aug 15 2007
1310 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
1312 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
1313 * \li Action: Change paragraph settings.
1314 * \li Notion: Overwrite all nonspecified settings to the default ones.
1315 Use paragraph-params lfun if you don't want to overwrite others settings.
1316 * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
1317 * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
1318 * \li Origin: leeming, 30 Mar 2004
1321 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
1322 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
1325 * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
1326 * \li Action: Move the current group in the upward direction in the
1327 structure of the document.
1328 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1329 the whole substructure of the group.
1330 * \li Syntax: outline-up
1331 * \li Origin: Vermeer, 23 Mar 2006
1334 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
1336 * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
1337 * \li Action: Move the current group in the downward direction in the
1338 structure of the document.
1339 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1340 the whole substructure of the group.
1341 * \li Syntax: outline-down
1342 * \li Origin: Vermeer, 23 Mar 2006
1345 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
1347 * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
1348 * \li Action: Moves the current group in the downward direction in the
1349 hierarchy of the document structure.
1350 * \li Notion: Part -> Chapter -> Section -> etc.
1351 * \li Syntax: outline-in
1352 * \li Origin: Vermeer, 23 Mar 2006
1355 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
1357 * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
1358 * \li Action: Moves the current group in the upward direction in the
1359 hierarchy of the document structure.
1360 * \li Notion: Part <- Chapter <- Section <- etc.
1361 * \li Syntax: outline-out
1362 * \li Origin: Vermeer, 23 Mar 2006
1365 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
1367 * \var lyx::FuncCode lyx::LFUN_INSET_EDIT
1368 * \li Action: Edit the inset at cursor with an external application,
1369 * if one is attributed.
1370 * \li Syntax: inset-edit [<INSET_PARAMS>]
1371 * \li Params: <INSET_PARAMS>: Parameters for the inset.
1372 Currently only the filename will be considered.
1373 * \li Origin: JSpitzm, 27 Apr 2006
1376 { LFUN_INSET_EDIT, "inset-edit", Noop, Edit },
1378 { LFUN_CELL_BACKWARD, "cell-backward", Noop, Edit },
1379 { LFUN_CELL_FORWARD, "cell-forward", Noop, Edit },
1380 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
1381 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
1382 { LFUN_TABULAR_FEATURE, "tabular-feature", Noop, Edit },
1384 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
1385 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
1386 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
1387 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
1388 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
1390 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
1391 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
1392 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
1393 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
1394 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
1395 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
1396 { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
1397 { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
1400 * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
1401 * \li Action: Apply data for an inset.
1402 * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
1403 be applied. This is either changed to #LFUN_INSET_MODIFY or
1404 #LFUN_INSET_INSERT depending on the context where it is called.
1405 * \li Syntax: inset-apply <ARGS>
1406 * \li Params: See #LFUN_INSET_INSERT .
1409 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
1411 * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE
1412 * \li Action: Dissolve the current inset into text.
1413 * \li Syntax: inset-dissolve [<INSET>]
1414 * \li Params: <INSET>: this can be used to make sure the right kind of inset
1415 is dissolved. For example "dissolve" entry in the charstyles
1416 sub-menu should only dissolve the charstyle inset, even if the
1417 cursor is inside several nested insets of different type.\n
1418 For values see #lyx::InsetLayout::lyxtype_ .
1419 * \li Author: JSpitz, 7 Aug 2006
1422 { LFUN_INSET_DISSOLVE, "inset-dissolve", Noop, Edit },
1424 * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
1425 * \li Action: Insert new inset (type given by the parameters).
1426 * \li Syntax: inset-insert <INSET> <ARGS>
1427 * \li Params: <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics|
1428 hyperlink|include|index|label|nomencl|vspace|ref|toc>\n
1429 <ARGS>: depends on the given inset. Use "lyx -dbg action" to
1431 * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
1432 where <label name> is the name of the referenced label and
1433 <Format> is one of the following: \n
1434 ref -- <reference> \n
1435 eqref -- (<reference>) \n
1436 pageref -- <page> \n
1437 vpageref -- on <page> \n
1438 vref -- <reference> on <page> \n
1439 prettyref -- Formatted reference
1442 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
1444 * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
1445 * \li Action: Modify existing inset.
1446 * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1447 bibtex, ert, command, graphics, note, space, vspace, tabular,
1448 bibitem, inlude, ref insets.
1449 * \li Syntax: inset-modify <INSET> <ARGS>
1450 * \li Params: See #LFUN_INSET_INSERT for further details.
1453 { LFUN_INSET_MODIFY, "", Noop, Hidden },
1455 * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_MODIFY
1456 * \li Action: Modify the inset at cursor position, if there is one.
1457 * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1458 bibtex, ert, command, graphics, note, space, vspace, tabular,
1459 bibitem, inlude, ref insets.
1460 * \li Syntax: next-inset-modify <INSET> <ARGS> or next-inset-modify changetype <TYPE>
1461 * \li Params: See #LFUN_INSET_INSERT for further details.
1462 * \li Origin: JSpitzm, 23 Mar 2008
1465 { LFUN_NEXT_INSET_MODIFY, "next-inset-modify", ReadOnly, Edit },
1466 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
1468 * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
1469 * \li Action: Open the inset's properties dialog.
1470 * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
1471 * \li Syntax: inset-settings <INSET>
1472 * \li Params: <INSET>: <box|branch|ert|float|listings|note|tabular|wrap>
1475 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly, Edit },
1477 * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_TOGGLE
1478 * \li Action: Toggles the inset at cursor position. For collapsables, this means it will
1479 be (un-)collapsed, in case of other insets, the editing widget (dialog) will
1480 be entered. Also cf. #LFUN_INSET_SETTINGS.
1481 * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1482 bibtex, ert, command, graphics, note, space, vspace, tabular,
1483 bibitem, inlude, ref insets.
1484 * \li Syntax: next-inset-toggle <ARG>
1485 * \li Params: <ARG>: these are passed as arguments to #LFUN_INSET_TOGGLE .
1486 * \li Origin: leeming, 30 Mar 2004
1489 { LFUN_NEXT_INSET_TOGGLE, "next-inset-toggle", ReadOnly, Edit },
1491 * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
1492 * \li Action: Toggles the collapsable inset we are currently in.
1493 * \li Syntax: inset-toggle [<ARG>]
1494 * \li Params: <ARG>: <open|close|toggle|assign>. \n
1495 open/close/toggle are for collapsable insets. close can be currently used
1496 by #LFUN_NEXT_INSET_TOGGLE. toggle is used when no argument is given.\n
1497 assign is for branch inset.
1498 * \li Origin: lasgouttes, 19 Jul 2001
1501 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly, Hidden },
1503 * \var lyx::FuncCode lyx::LFUN_ALL_INSETS_TOGGLE
1504 * \li Action: Toggles (open/closes) all collapsable insets (of a given type) in the document.
1505 * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
1506 * \li Syntax: all-insets-toggle <STATE> <INSET>
1507 * \li Params: <STATE>: <toggle|open|close> default: toggle \n
1508 <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all insets \n
1509 * \li Origin: leeming, 30 Mar 2004
1512 { LFUN_ALL_INSETS_TOGGLE, "all-insets-toggle", ReadOnly, Edit },
1514 * \var lyx::FuncCode lyx::LFUN_GRAPHICS_GROUPS_UNIFY
1515 * \li Action: Unify all graphics insets with the one given as an parameter.
1516 * \li Notion: This is internally used for synchronize certain group of graphics insets.
1517 * \li Syntax: graphics-groups-unigfy <GRAPHICS_PARAMS>
1518 * \li Params: <GRAPHICS_PARAMS>: Parameters for graphics inset
1519 (syntax can be seen in .lyx files).
1520 * \li Origin: sanda, 6 May 2008
1523 { LFUN_GRAPHICS_GROUPS_UNIFY, "graphics-groups-unify", ReadOnly, Edit },
1525 * \var lyx::FuncCode lyx::LFUN_SET_GRAPHICS_GROUP
1526 * \li Action: Set the group for the graphics inset on the cursor position.
1527 * \li Syntax: set-graphics-group [<GROUP>]
1528 * \li Params: <GROUP>: Id for an existing group. In case tthe Id is an empty string,
1529 the graphics inset is removed from the current group.
1530 * \li Origin: sanda, 6 May 2008
1533 { LFUN_SET_GRAPHICS_GROUP, "set-graphics-group", ReadOnly, Edit },
1536 * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
1537 * \li Action: Moves the cursor out of the current slice, going forward.
1538 * \li Notion: Cursor movement within an inset may be different than cursor
1539 movement in the surrounding text. This action should be called
1540 automatically by the cursor movement within the inset, when
1541 movement within the inset has ceased (reached the end of the
1542 last paragraph, for example), in order to move correctly
1543 back into the surrounding text.
1546 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
1548 * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
1549 * \li Action: Moves the cursor out of the current slice, going backwards.
1550 * \li Notion: See also #LFUN_FINISHED_FORWARD.
1553 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
1555 * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
1556 * \li Action: Moves the cursor out of the current slice, going right.
1557 * \li Notion: See also #LFUN_FINISHED_FORWARD
1560 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
1562 * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
1563 * \li Action: Moves the cursor out of the current slice, going left.
1564 * \li Notion: See also #LFUN_FINISHED_FORWARD.
1567 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
1569 { LFUN_LANGUAGE, "language", Noop, Edit },
1572 * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
1573 * \li Action: Goto a label.
1574 * \li Syntax: label-goto [<LABEL>]
1575 * \li Params: <LABEL>: Requested label. If no label is given and refernce
1576 is on cursor position, Bookmark 0 is saved and
1577 cursor moves to the position of referenced label.
1578 * \li Origin: Ale, 6 Aug 1997
1581 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
1583 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT
1584 * \li Action: Inserts label to text or displayed formula.
1585 * \li Syntax: label-insert [<LABEL>]
1586 * \li Params: <LABEL>: Requested label. If no label is given dialog requesting
1587 name will be opened.
1590 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
1592 * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
1593 * \li Action: Go to the next label or cross-reference.
1594 * \li Syntax: reference-next
1595 * \li Origin: Dekel, 14 Jan 2001
1598 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
1601 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
1602 * \li Action: Goto a bookmark.
1603 * \li Notion: Moves the cursor to the numbered bookmark, opening the file
1604 if necessary. Note that bookmarsk are saved per-session, not
1606 * \li Syntax: bookmark-goto <NUMBER>
1607 * \li Params: <NUMBER>: the number of the bookmark to restore.
1608 * \li Origin: Dekel, 27 January 2001
1611 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
1613 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
1614 * \li Action: Save a bookmark.
1615 * \li Notion: Saves a numbered bookmark to the sessions file. The number
1616 must be between 1 and 9, inclusive. Note that bookmarks are
1617 saved per-session, not per file.
1618 * \li Syntax: bookmark-save <NUMBER>
1619 * \li Params: <NUMBER>: the number of the bookmark to save.
1620 * \li Origin: Dekel, 27 January 2001
1623 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
1625 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
1626 * \li Action: Clears the list of saved bookmarks.
1627 * \li Syntax: bookmark-clear
1628 * \li Origin: bpeng, 31 October 2006
1631 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
1634 * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
1635 * \li Action: Open the given help file according to the language setting.
1636 * \li Syntax: help-open <FILE>[.lyx]
1637 * \li Params: <FILE>: any document from (/usr/share/)doc directory.
1638 * \li Author: Jug, 27 Jun 1999
1641 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
1643 * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
1644 * \li Action: Terminates the current LyX instance.
1645 * \li Notion: Terminates the current LyX instance, asking whether to save
1646 modified documents, etc.
1647 * \li Syntax: lyx-quit
1650 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
1652 * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
1653 * \li Action: Toggles visibility of a given toolbar between on/off/auto.
1654 * \li Notion: Skiping "auto" when allowauto is false.
1655 * \li Syntax: toolbar-toggle <NAME> [allowauto]
1656 * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|
1657 minibuffer|review|view/update|math_panels
1658 * \li Origin: Edwin, 21 May 2007
1661 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
1663 * \var lyx::FuncCode lyx::LFUN_MENU_OPEN
1664 * \li Action: Opens the menu given by its name.
1665 * \li Syntax: menu-open <NAME>
1666 * \li Params: <NAME>: menu name. See various .inc files in lib/ui for candidates.
1669 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
1671 * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
1672 * \li Action: Various UI visibility-toggling actions.
1673 * \li Syntax: ui-toggle <statusbar|menubar|frame|fullscreen>
1674 * \li Params: statusbar : Toggle visibility of the statusbar.\n
1675 menubar : Toggle visibility of the menubar.\n
1676 scrollbar : Toggle visibility of the scrollbar.\n
1677 frame : Toggle visibility of the frames around editing window.\n
1678 fullscreen : Toggle fullscreen mode. This also covers calling the
1679 previous functions. However #LFUN_TOOLBAR_TOGGLE for the
1680 custom tweaks of the toolbars should be used.
1681 * \li Origin: ps, 9 Feb 2007
1684 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
1687 * \var lyx::FuncCode lyx::WINDOW_NEW
1688 * \li Action: Creates new empty LyX window.
1689 * \li Notion: Already opened documents from the previous window can be found under View menu.
1690 * \li Syntax: window-new [<GEOMETRY>]
1691 * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently
1692 accepted only on Windows platform.
1693 * \li Origin: Abdel, 21 Oct 2006
1696 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
1698 * \var lyx::FuncCode lyx::LFUN_WINDOW_CLOSE
1699 * \li Action: Closes the current LyX window.
1700 * \li Syntax: window-close
1701 * \li Origin: Abdel, 23 Oct 2006
1704 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
1707 * \var lyx::FuncCode lyx::LFUN_SPLIT_VIEW
1708 * \li Action: Creates another split view of current buffer.
1709 * \li Notion: All split views act in the same way indpendently.
1710 * \li Syntax: split-view <vertical|horizontal>
1711 * \li Params: horizontal : The work areas are laid out side by side.\n
1712 vertical : The work areas laid out vertically.\n
1713 * \li Origin: abdel, 20 Feb 2008
1716 { LFUN_SPLIT_VIEW, "split-view", ReadOnly, Buffer },
1719 * \var lyx::FuncCode lyx::LFUN_CLOSE_TAB_GROUP
1720 * \li Action: Close the current tab group.
1721 * \li Notion: This only closes the work areas, not the buffer themselves.
1722 The still opened buffers can be visualized in another tab group.
1723 * \li Syntax: close-tab-group
1724 * \li Origin: abdel, 21 Feb 2008
1727 { LFUN_CLOSE_TAB_GROUP, "close-tab-group", ReadOnly, Buffer },
1728 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
1729 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
1730 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
1731 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
1732 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
1733 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
1735 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
1736 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
1737 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
1738 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
1739 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
1741 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
1742 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
1743 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
1744 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
1746 { LFUN_FLOAT_LIST, "float-list", Noop, Edit },
1748 { LFUN_SERVER_CHAR_AFTER, "server-char-after", ReadOnly, System },
1749 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
1750 { LFUN_SERVER_GET_NAME, "server-get-name", ReadOnly, System },
1752 * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
1753 * \li Action: Sets the cursor position based on the row number of generated TeX file.
1754 * \li Syntax: server-goto-file-row <LYX_FILE_NAME> <ROW_NUMBER>
1755 * \li Origin: Edmar, 23 Dec 1998
1758 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly, System },
1759 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
1761 * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
1762 * \li Action: Sets the cursor position based on the editing area coordinates
1763 (similar as clicking on that point with left mouse button).
1764 * \li Syntax: server-set-xy <X> <Y>
1767 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
1769 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
1770 * \li Action: Returns the coordinates of cursor position in the editing area.
1771 * \li Syntax: server-get-xy
1774 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
1777 * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
1778 * \li Action: Generates the code (literate programming).
1779 * \li Notion: Latex file with extension \literate_extension is generated.
1780 Then LyX invokes \build_command (with a default of``make'') to generate the code and
1781 \build_error_filter to process the compilation error messages. \n
1782 In case you want to process your literate file with a script, or some other program,
1783 just insert in your lyxrc file an entry with:\n
1784 \build_command "my_script my_arguments" \n
1785 The \build_error_filter differs from the \literate_error_filter only in that the
1786 former will identify error messages from your compiler.
1787 * \li Syntax: build-program
1790 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
1793 * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
1794 * \li Action: Saves the current buffer to a temporary file.
1795 * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
1796 is called automatically by LyX, to "autosave" the current buffer.
1797 * \li Syntax: buffer-auto-save
1800 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
1802 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHILD_OPEN
1803 * \li Action: Loads the given child document.
1804 * \li Notion: The current document is treated as a parent.
1805 * \li Syntax: buffer-child-open <FILE>
1806 * \li Params: <FILE>: Filename of the child. The directory of the parent is assumed by default.
1807 * \li Origin: Ale, 28 May 1997
1810 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
1812 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHKTEX
1813 * \li Action: Runs chktex for the current document.
1814 * \li Syntax: buffer-chktex
1815 * \li Origin: Asger, 30 Oct 1997
1818 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
1820 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
1821 * \li Action: Toggles compression of the current document on/off.
1822 * \li Syntax: buffer-toggle-compression
1823 * \li Origin: bpeng, 27 Apr 2006
1826 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
1828 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
1829 * \li Action: Closes the current buffer.
1830 * \li Notion: Closes the current buffer, asking whether to save it, etc,
1831 if the buffer has been modified.
1832 * \li Syntax: buffer-close
1835 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
1837 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
1838 * \li Action: Exports the current buffer (document) to the given format.
1839 * \li Syntax: buffer-export <FORMAT>
1840 * \li Params: <FORMAT> is either "custom" or one of the formats which you
1841 can find in Tools->Preferences->File formats->Format.
1842 Usual format you will enter is "pdf2" (pdflatex),
1843 "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
1844 In case of "custom" you will be asked for a format you
1845 want to start from and for the command that you want to
1846 apply to this format. Internally the control is then passed
1847 to #LFUN_BUFFER_EXPORT_CUSTOM.
1848 * \li Origin: Lgb, 29 Jul 1997
1851 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
1853 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
1854 * \li Action: Exports the current buffer (document) from the given format using
1855 the given command on it.
1856 * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
1857 * \li Params: <FORMAT> format to start from (LyX will care to produce such
1858 intermediate file).\n
1859 <COMMAND> this command will be launched on the file. Note that you can
1860 use "$$FName" string to qualify the intermediate file.
1861 * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
1862 * \li Origin: leeming, 27 Mar 2004
1865 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
1867 * \var lyx::FuncCode lyx::LFUN_BUFFER_PRINT
1868 * \li Action: Prints the current document.
1869 * \li Notion: Many settings can be given via the preferences dialog.
1870 * \li Syntax: buffer-print <TARGET> <TARGET-NAME> <COMMAND>
1871 * \li Params: <TARGET> is either "printer" or "file".\n
1872 <TARGER-NAME> is either "default" or file name or printer name.\n
1873 <COMMAND> command ensuring the printing job.
1874 * \li Sample: buffer-print file "/trash/newfile1.ps" "dvips"
1875 * \li Origin: leeming, 28 Mar 2004
1878 { LFUN_BUFFER_PRINT, "buffer-print", ReadOnly, Buffer },
1880 * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
1881 * \li Action: Import a given file as a lyx document.
1882 * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
1883 defined convertors in preferences. Look into File->Import menu to get
1884 an idea of the currently active import formats.
1885 * \li Syntax: buffer-import <FORMAT> [<FILE>]
1886 * \li Origin: Asger, 24 Jul 1998
1889 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
1891 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
1892 * \li Action: Creates a new buffer (that is, document).
1893 * \li Notion: Implicit path can be set in Preferences dialog.
1894 * \li Syntax: buffer-new [<FILE>]
1895 * \li Params: <FILE>: filename of created file with absolute path.
1898 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
1900 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
1901 * \li Action: Creates a new buffer (that is, document) from a template.
1902 * \li Notion: Path for new files and templates can be set in Preferences dialog.
1903 Template will be asked for via Open-dialog.
1904 * \li Syntax: buffer-new-template [<FILE>]
1905 * \li Params: <FILE>: filename of created file with absolute path.
1908 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
1910 * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
1911 * \li Action: Reverts opened document.
1912 * \li Syntax: buffer-reload
1913 * \li Origin: Asger, 2 Feb 1997
1916 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
1918 * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
1919 * \li Action: Switch to the given buffer.
1920 * \li Notion: This is useful also in case you need simultaneously more views of the edited
1921 document in different LyX windows.
1922 * \li Syntax: buffer-new-template <BUFFER>
1923 * \li Params: <BUFFER>: already opened document which is to be shown.
1926 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
1928 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
1929 * \li Action: Toggle editing mode of the current document between read/write and read-only.
1930 * \li Syntax: buffer-toggle-read-only
1931 * \li Origin: Lgb, 27 May 1997
1934 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
1936 * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
1937 * \li Action: Displays current buffer in chosen format.
1938 * \li Notion: Displays the contents of the current buffer in the chosen
1939 format, for example, PDF or DVI. This runs the necessary
1940 converter, calls the defined viewer, and so forth.
1941 * \li Syntax: buffer-view <FORMAT>
1942 * \li Params: <FORMAT>: The format to display, where this is one of the
1943 formats defined (in the current GUI) in the
1944 Tools>Preferences>File Formats dialog.
1947 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
1949 * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
1950 * \li Action: Exports the current document and put the result into the
1951 temporary directory.
1952 * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
1953 the output will be rewriten - updated. This is useful in case your viewer
1954 is able to detect such changes (e.g. ghostview for postscript).
1955 * \li Syntax: buffer-update <FORMAT>
1956 * \li Params: <FORMAT>: The format to display, where this is one of the
1957 formats defined (in the current GUI) in the
1958 Tools>Preferences>File Formats dialog.
1959 * \li Origin: Dekel, 5 Aug 2000
1962 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
1965 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
1966 * \li Action: Saves the current buffer.
1967 * \li Notion: Saves the current buffer to disk, using the filename that
1968 is already associated with the buffer, asking for one if
1969 none is yet assigned.
1970 * \li Syntax: buffer-write
1973 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
1975 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
1976 * \li Action: Rename and save current buffer.
1977 * \li Syntax: buffer-write-as <FILENAME>
1978 * \li Params: <FILENAME>: New name of the buffer/file. A relative path
1979 is with respect to the original location of the buffer/file.
1982 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
1984 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
1985 * \li Action: Save all changed documents.
1986 * \li Syntax: buffer-write-all
1987 * \li Origin: rgh, gpothier 6 Aug 2007
1990 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
1992 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEXT
1993 * \li Action: Switch to the next opened document.
1994 * \li Notion: Note that this does not necessarily mean next in tabbar
1995 (for full list see View menu).
1996 * \li Syntax: buffer-next
1999 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
2001 * \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS
2002 * \li Action: Switch to the previous opened document.
2003 * \li Syntax: buffer-previous
2006 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
2008 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
2009 * \li Action: When run from a child document, this updates (exports) document built
2010 from the master buffer. If a master is not found, it updates the
2012 * \li Syntax: master-buffer-update
2013 * \li Author: Tommaso, 20 Sep 2007
2016 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
2018 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
2019 * \li Action: When run from a child document, this command shows a preview built
2020 from the master buffer. If a master is not found, it previews the
2022 * \li Syntax: master-buffer-view
2023 * \li Author: Tommaso, 20 Sep 2007
2026 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
2028 * \var lyx::FuncCode lyx::LFUN_BUFFER_LANGUAGE
2029 * \li Action: Set language of the current document.
2030 * \li Syntax: buffer-language <LANG>
2031 * \li Params: <LANG>: language name. See lib/languages for list.
2032 * \li Author: leeming, 30 Mar 2004
2035 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
2037 * \var lyx::FuncCode lyx::LFUN_BUFFER_SAVE_AS_DEFAULT
2038 * \li Action: Save the current document settings as default.
2039 * \li Notion: The file will will be saved into ~/.lyx/templates/defaults.lyx .
2040 * \li Syntax: buffer-save-as-default [<ARGS>]
2041 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
2042 you can find in document header of usual .lyx file.
2043 * \li Author: leeming, 30 Mar 2004
2046 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
2048 * \var lyx::FuncCode lyx::LFUN_BUFFER_PARAMS_APPLY
2049 * \li Action: Apply the given settings to the current document.
2050 * \li Syntax: buffer-params-apply [<ARGS>]
2051 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
2052 you can find in document header of usual .lyx file.
2053 * \li Author: leeming, 30 Mar 2004
2056 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", Noop, Buffer },
2059 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
2060 * \li Action: Inserts another LyX file.
2061 * \li Syntax: file-insert [<FILE>]
2062 * \li Params: <FILE>: Filename to be inserted.
2065 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
2067 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
2068 * \li Action: Inserts plain text file.
2069 * \li Syntax: file-insert-plaintext [<FILE>]
2070 * \li Params: <FILE>: Filename to be inserted.
2071 * \li Origin: CFO-G, 19 Nov 1997
2074 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
2076 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
2077 * \li Action: Inserts plain text file as paragraph (i.e. join lines).
2078 * \li Syntax: file-insert-plaintext-para [<FILE>]
2079 * \li Params: <FILE>: Filename to be inserted.
2080 * \li Origin: Levon, 14 Feb 2001
2083 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
2085 * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
2086 * \li Action: Open LyX document.
2087 * \li Syntax: file-open [<FILE>]
2088 * \li Params: <FILE>: Filename to be opened.
2091 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
2094 * \var lyx::FuncCode lyx::LFUN_CALL
2095 * \li Action: Executes a command defined in a .def file.
2096 * \li Notion: The definitions are by default read from lib/commands/default.def.\n
2097 A .def file allows to define a command with \\define "<NAME>" "<LFUN>"
2098 where <NAME> is the name of the new command and <LFUN> is the lfun code
2099 to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
2100 \\def_file "FileName" allows to include another .def file. \n
2101 This is particularly useful in connection with toolbar buttons:
2102 Since the name of the button image for this lfun is
2103 lib/images/commands/<NAME>.png this is the way to assign an image
2104 to a complex command-sequence.
2105 * \li Syntax: call <NAME>
2106 * \li Params: <NAME>: Name of the command that must be called.
2107 * \li Origin: broider, 2 Oct 2007
2110 { LFUN_CALL, "call", NoBuffer, System },
2112 * \var lyx::FuncCode lyx::LFUN_META_PREFIX
2113 * \li Action: Simulate halting Meta key (Alt key on PCs).
2114 * \li Notion: Used for buffer editation not for GUI control.
2115 * \li Syntax: meta-prefix
2118 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
2120 * \var lyx::FuncCode lyx::LFUN_CANCEL
2121 * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
2122 * \li Syntax: cancel
2125 { LFUN_CANCEL, "cancel", NoBuffer, System },
2128 * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
2129 * \li Action: Opens the minibuffer toolbar so that the user can type in there.
2130 * \li Notion: Usually bound to M-x shortcut.
2131 * \li Syntax: command-execute
2134 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
2135 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
2137 * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
2138 * \li Action: Run more commands (LFUN and its parameters) in a sequence.
2139 * \li Syntax: command-sequence <CMDS>
2140 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
2141 * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
2142 * \li Origin: Andre', 11 Nov 1999
2145 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
2147 * \var lyx::FuncCode lyx::LFUN_MESSAGE
2148 * \li Action: Shows message in statusbar (for script purposes).
2149 * \li Syntax: message <STRING>
2150 * \li Origin: Lgb, 8 Apr 2001
2153 { LFUN_MESSAGE, "message", NoBuffer, System },
2155 * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
2156 * \li Action: Save user preferences.
2157 * \li Syntax: preferences-save
2158 * \li Origin: Lgb, 27 Nov 1999
2161 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
2163 * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
2164 * \li Action: Reconfigure the automatic settings.
2165 * \li Syntax: reconfigure
2166 * \li Origin: Asger, 14 Feb 1997
2169 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
2171 * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
2172 * \li Action: Apply the given settings to user preferences.
2173 * \li Syntax: lyxrc-apply <SETTINGS>
2174 * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
2175 to get an idea which commands to use and their syntax.
2176 #lyx::LyXRC::LyXRCTags has the list of possible commands.
2179 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
2181 * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
2182 * \li Action: Determine whether keep cursor inside the editing window regardless
2183 the scrollbar movement.
2184 * \li Syntax: toggle-cursor-follows-scrollbar
2185 * \li Origin: ARRae, 2 Dec 1997
2188 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
2190 * \var lyx::FuncCode lyx::LFUN_SET_COLOR
2191 * \li Action: Set the given LyX color to the color defined by the X11 name given.
2192 * \li Notion: A new color entry is created if the color is unknown.
2193 Color names can be stored as a part of user settings.
2194 * \li Syntax: set-color <LYX_NAME> <X11_NAME>
2195 * \li Origin: SLior, 11 Jun 2000
2198 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
2200 * \var lyx::FuncCode lyx::LFUN_STATISTICS
2201 * \li Action: Count the statistics (number of words and characters)
2202 in the document or in the given selection.
2203 * \li Notion: Note that this function gives the number of words/chars written,
2204 not the number of characters which will be typeset.
2205 * \li Syntax: statistics
2206 * \li Origin: lasgouttes, Jan 27 2004; ps, Jan 8 2008
2209 { LFUN_STATISTICS, "statistics", ReadOnly, System },
2211 * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
2212 * \li Action: Show the inline completion at the cursor position.
2213 * \li Syntax: completion-inline
2214 * \li Origin: sts, Feb 19 2008
2217 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
2219 * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
2220 * \li Action: Show the completion popup at the cursor position.
2221 * \li Syntax: completion-popup
2222 * \li Origin: sts, Feb 19 2008
2225 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
2227 * \var lyx::FuncCode lyx::LFUN_COMPLETION_COMPLETE
2228 * \li Action: Try to complete the word or command at the cursor position.
2229 * \li Syntax: completion-complete
2230 * \li Origin: sts, Feb 19 2008
2233 { LFUN_COMPLETION_COMPLETE, "complete", SingleParUpdate, Edit },
2235 * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
2236 * \li Action: Activate the branch
2237 * \li Syntax: branch-activate <BRANCH>
2238 * \li Params: <BRANCH>: The branch to activate
2239 * \li Sample: lyx -e pdf2 -x "branch-activate answers" finalexam.lyx \n
2240 could be used to export a pdf with the answers branch included
2241 without one's having to open LyX and activate the branch manually.
2242 * \li Origin: rgh, 27 May 2008
2245 { LFUN_BRANCH_ACTIVATE, "branch-activate", Argument, Buffer },
2247 * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
2248 * \li Action: De-activate the branch
2249 * \li Syntax: branch-deactivate <BRANCH>
2250 * \li Params: <BRANCH>: The branch to deactivate
2251 * \li Origin: rgh, 27 May 2008
2254 { LFUN_BRANCH_DEACTIVATE, "branch-deactivate", Argument, Buffer },
2256 { LFUN_NOACTION, "", Noop, Hidden }
2257 #ifndef DOXYGEN_SHOULD_SKIP_THIS
2260 for (int i = 0; items[i].action != LFUN_NOACTION; ++i) {
2261 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
2268 LyXAction::LyXAction()
2274 // Returns an action tag from a string.
2275 FuncRequest LyXAction::lookupFunc(string const & func) const
2277 string const func2 = trim(func);
2279 if (func2.empty()) {
2280 return FuncRequest(LFUN_NOACTION);
2284 string const arg = split(func2, cmd, ' ');
2286 func_map::const_iterator fit = lyx_func_map.find(cmd);
2288 return fit != lyx_func_map.end() ? FuncRequest(fit->second, arg) : FuncRequest(LFUN_UNKNOWN_ACTION);
2292 string const LyXAction::getActionName(FuncCode action) const
2294 info_map::const_iterator const it = lyx_info_map.find(action);
2295 return it != lyx_info_map.end() ? it->second.name : string();
2299 LyXAction::func_type const LyXAction::getActionType(FuncCode action) const
2301 info_map::const_iterator const it = lyx_info_map.find(action);
2302 return it != lyx_info_map.end() ? it->second.type : Hidden;
2306 bool LyXAction::funcHasFlag(FuncCode action,
2307 LyXAction::func_attrib flag) const
2309 info_map::const_iterator ici = lyx_info_map.find(action);
2311 if (ici == lyx_info_map.end()) {
2312 LYXERR0("action: " << action << " is not known.");
2313 LASSERT(false, /**/);
2316 return ici->second.attrib & flag;
2320 LyXAction::const_func_iterator LyXAction::func_begin() const
2322 return lyx_func_map.begin();
2326 LyXAction::const_func_iterator LyXAction::func_end() const
2328 return lyx_func_map.end();