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 },
516 { LFUN_DOWN, "down", ReadOnly | NoUpdate, Edit },
517 { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, Edit },
518 { LFUN_UP, "up", ReadOnly | NoUpdate, Edit },
519 { LFUN_UP_SELECT, "up-select", ReadOnly | SingleParUpdate, Edit },
520 { LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit },
521 { LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit },
523 * \var lyx::FuncCode lyx::LFUN_SCROLL
524 * \li Action: Scroll the buffer view.
525 * \li Notion: Only scrolls the screen up or down; does not move the cursor.
526 * \li Syntax: scroll <TYPE> <QUANTITY>
527 * \li Params: <TYPE>: line|page\n
528 <QUANTITY>: up|down|<number>
529 * \li Origin: Abdelrazak Younes, Dec 27 2007
532 { LFUN_SCROLL, "scroll", ReadOnly, Edit },
534 * \var lyx::FuncCode lyx::LFUN_SCREEN_RECENTER
535 * \li Action: Recenters the screen on the current cursor position.
536 * \li Syntax: screen-recenter
539 { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit },
540 { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit },
541 { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit },
543 { LFUN_ERROR_NEXT, "error-next", ReadOnly, Edit },
545 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD
546 * \li Action: Moves the cursor one position logically backwards.
547 * \li Notion: This is not the action which should be bound to the arrow keys,
548 because backwards may be left or right, depending on the
549 language. The arrow keys should be bound to #LFUN_CHAR_LEFT or
550 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
551 * \li Syntax: char-backward
554 { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit },
556 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD_SELECT
557 * \li Action: Moves the cursor one position logically backwards, adding
558 traversed position to the selection.
559 * \li Notion: See also #LFUN_CHAR_BACKWARD.
560 * \li Syntax: char-backward-select
563 { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit },
564 { LFUN_CHAR_DELETE_BACKWARD, "delete-backward", SingleParUpdate, Edit },
565 { LFUN_CHAR_DELETE_FORWARD, "delete-forward", SingleParUpdate, Edit },
567 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD
568 * \li Action: Moves the cursor one position logically forward.
569 * \li Notion: This is not the action which should be bound to the arrow keys,
570 because forward may be left or right, depending on the language.
571 The arrow keys should be bound to #LFUN_CHAR_LEFT or
572 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
573 * \li Syntax: char-forward
576 { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit },
578 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD_SELECT
579 * \li Action: Moves the cursor one position logically forward, adding
580 traversed position to the selection.
581 * \li Notion: See also #LFUN_CHAR_FORWARD.
582 * \li Syntax: char-forward-select
585 { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit },
587 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT
588 * \li Action: Moves the cursor one position "to the left".
589 * \li Notion: This is the action which should be taken when the "left" key
590 is pressed. Generally, it moves the cursor one position to the
591 left. However, in Bidi text this become slightly more
592 complicated, and there are different modes of cursor movement.
593 In "visual mode", this moves left, plain and simple. In "logical
594 mode", movement is logically forward in RTL paragraphs, and
595 logically backwards in LTR paragraphs.
596 * \li Syntax: char-left
599 { LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit },
601 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT_SELECT
602 * \li Action: Moves the cursor one position "to the left", adding
603 traversed position to the selection.
604 * \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement.
605 * \li Syntax: char-left-select
608 { LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit },
610 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT
611 * \li Action: Moves the cursor one position "to the right".
612 * \li Notion: This is the action which should be taken when the "right" key
613 is pressed. Generally, it moves the cursor one position to the
614 right. However, in Bidi text this become slightly more
615 complicated, and there are different modes of cursor movement.
616 In "visual mode", this moves right, plain and simple. In "logical
617 mode", movement is logically forward in LTR paragraphs, and
618 logically backwards in RTL paragraphs.
619 * \li Syntax: char-right
622 { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit },
624 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT_SELECT
625 * \li Action: Moves the cursor one position "to the right", adding
626 traversed position to the selection.
627 * \li Notion: See also #LFUN_CHAR_RIGHT for exact details of the movement.
628 * \li Syntax: char-right-select
631 { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit },
634 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD
635 * \li Action: Moves the cursor to the logically previous beginning of a word.
636 * \li Notion: This is not the action which should be bound to the arrow keys,
637 because backwards may be left or right, depending on the
638 language. The arrow keys should be bound to #LFUN_WORD_LEFT or
639 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
640 * \li Syntax: word-backward
643 { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit },
645 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD_SELECT
646 * \li Action: Moves the cursor to the logically previous beginning of a word,
647 adding the logically traversed text to the selection.
648 * \li Notion: See also #LFUN_WORD_BACKWARD.
649 * \li Syntax: word-backward-select
652 { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
653 { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
654 { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
656 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_FORWARD
657 * \li Action: Search for a given string in forward direction.
658 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
659 * \li Syntax: word-find-forward [<STRING>]
660 * \li Origin: Etienne, 16 Feb 1998
663 { LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit },
665 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_BACKWARD
666 * \li Action: Search for a given string in backward direction.
667 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
668 * \li Syntax: word-find-backward [<STRING>]
669 * \li Origin: Etienne, 20 Feb 1998
672 { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
674 * \var lyx::FuncCode lyx::LFUN_WORD_FIND
675 * \li Action: Search for next occurence of a string.
676 * \li Syntax: word-find [<DATA>]
677 * \li Params: <DATA>: data encoded from Find dialog (see #lyx::find2string()).
678 If no parameter is given, search with last find-dialog
679 data is used for search (i.e. find-next).
680 * \li Origin: poenitz, Jan 7 2004
683 { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
684 { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
686 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD
687 * \li Action: Moves the cursor to the logically next beginning of a word.
688 * \li Notion: This is not the action which should be bound to the arrow keys,
689 because forward may be left or right, depending on the language.
690 The arrow keys should be bound to #LFUN_WORD_LEFT or
691 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
692 * \li Syntax: word-forward
695 { LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
697 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD_SELECT
698 * \li Action: Moves the cursor to the logically next beginning of a word,
699 adding the logically traversed text to the selection.
700 * \li Notion: See also #LFUN_WORD_FORWARD.
701 * \li Syntax: word-forward-select
704 { LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
706 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT
707 * \li Action: Moves the cursor to the next beginning of a word "on the left".
708 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
709 "left" key is pressed. Generally, it moves the cursor to the
710 next beginning of a word on the left. However, in Bidi text this
711 become slightly more complicated, and there are different modes
712 of cursor movement. In "visual mode", this moves left, plain and
713 simple. In "logical mode", movement is logically forward in RTL
714 paragraphs, and logically backwards in LTR paragraphs.
715 * \li Syntax: word-left
716 * \li Origin: dov, 28 Oct 2007
719 { LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
721 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT_SELECT
722 * \li Action: Moves the cursor to the next beginning of a word "on the left",
723 adding *logically* traversed text to the selection.
724 * \li Notion: See also #LFUN_WORD_LEFT for exact details of the movement.
725 * \li Syntax: word-left-select
726 * \li Origin: dov, 28 Oct 2007
729 { LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit },
731 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT
732 * \li Action: Moves the cursor to the next beginning of a word "on the right".
733 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
734 "right" key is pressed. Generally, it moves the cursor to the
735 next beginning of a word on the right. However, in Bidi text
736 this become slightly more complicated, and there are different
737 modes of cursor movement. In "visual mode", this moves right,
738 plain and simple. In "logical mode", movement is logically
739 forward in LTR paragraphs, and logically backwards in RTL
741 * \li Syntax: word-right
742 * \li Origin: dov, 28 Oct 2007
745 { LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit },
747 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT_SELECT
748 * \li Action: Moves the cursor to the next beginning of a word "on the right",
749 adding *logically* traversed text to the selection.
750 * \li Notion: See also #LFUN_WORD_RIGHT for exact details of the movement.
751 * \li Syntax: word-right-select
752 * \li Origin: dov, 28 Oct 2007
755 { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
756 { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
758 * \var lyx::FuncCode lyx::LFUN_WORD_CAPITALIZE
759 * \li Action: Capitalizes the words in the selection (i.e. the first letters)
760 or the letter on the cursor position.
761 * \li Syntax: word-capitalize
764 { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
766 * \var lyx::FuncCode lyx::LFUN_WORD_UPCASE
767 * \li Action: Change the words in the selection or from the cursor position
768 to the end of word to the upper case.
769 * \li Syntax: word-upcase
772 { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
774 * \var lyx::FuncCode lyx::LFUN_WORD_LOWCASE
775 * \li Action: Change the words in the selection or from the cursor position
776 to the end of word to the lower case.
777 * \li Syntax: word-lowcase
780 { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
782 * \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
783 * \li Action: Look up thesaurus entries with respect to the word under the cursor.
784 * \li Syntax: thesaurus-entry
785 * \li Origin: Levon, 20 Jul 2001
788 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
789 { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
790 { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
791 { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
792 { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
794 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
795 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
796 { LFUN_LINE_DELETE, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
797 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
798 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
800 * \var lyx::FuncCode lyx::LFUN_COPY
801 * \li Action: Copies to the clipboard the last edit.
805 { LFUN_COPY, "copy", ReadOnly, Edit },
807 * \var lyx::FuncCode lyx::LFUN_CUT
808 * \li Action: Cuts to the clipboard.
812 { LFUN_CUT, "cut", Noop, Edit },
814 * \var lyx::FuncCode lyx::LFUN_PASTE
815 * \li Action: Pastes from the active clipboard.
819 { LFUN_PASTE, "paste", Noop, Edit },
820 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
822 * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
823 * \li Action: Pastes the material currently selected.
824 * \li Syntax: primary-selection-paste
827 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
829 * \var lyx::FuncCode lyx::LFUN_UNDO
830 * \li Action: Undoes the last edit.
834 { LFUN_UNDO, "undo", Noop, Edit },
836 * \var lyx::FuncCode lyx::LFUN_REDO
837 * \li Action: Redoes the last thing undone.
841 { LFUN_REDO, "redo", Noop, Edit },
843 * \var lyx::FuncCode lyx::LFUN_REPEAT
844 * \li Action: Repeat the given command.
845 * \li Syntax: repeat <COUNT> <LFUN-COMMAND>
846 * \li Author: poenitz, 27 Oct 2003
849 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
851 * \var lyx::FuncCode lyx::LFUN_CHARS_TRANSPOSE
852 * \li Action: Transposes the character at the cursor with the one before it.
853 * \li Syntax: chars-transpose
854 * \li Author: Lgb, 25 Apr 2001
857 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
859 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
860 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
861 { LFUN_ENVIRONMENT_INSERT, "environment-insert", Noop, Edit },
864 * \var lyx::FuncCode lyx::LFUN_FONT_BOLD
865 * \li Action: Toggles the bold font (selection-wise).
866 * \li Syntax: font-bold
869 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
871 * \var lyx::FuncCode lyx::LFUN_FONT_TYPEWRITER
872 * \li Action: Toggles the typewriter family font (selection-wise).
873 * \li Syntax: font-typewriter
876 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
878 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERLINE
879 * \li Action: Toggles underline in the font (selection-wise).
880 * \li Syntax: font-underline
883 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
885 * \var lyx::FuncCode lyx::LFUN_FONT_EMPH
886 * \li Action: Toggles the emphasis font style (selection-wise).
887 * \li Syntax: font-emph
890 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
892 * \var lyx::FuncCode lyx::LFUN_FONT_NOUN
893 * \li Action: Toggles Noun text style font (selection-wise).
894 * \li Syntax: font-noun
897 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
899 * \var lyx::FuncCode lyx::LFUN_FONT_ROMAN
900 * \li Action: Toggles Roman family font (selection-wise).
901 * \li Syntax: font-roman
904 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
906 * \var lyx::FuncCode lyx::LFUN_FONT_SANS
907 * \li Action: Toggles Sans Serif family font (selection-wise).
908 * \li Syntax: font-sans
911 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
913 * \var lyx::FuncCode lyx::LFUN_FONT_FRAK
914 * \li Action: Toggles Fraktur family font (math-mode, selection-wise).
915 * \li Syntax: font-frak
916 * \li Origin: vermeer, 10 Jan 2002
919 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
921 * \var lyx::FuncCode lyx::LFUN_FONT_ITAL
922 * \li Action: Toggles Italics font shape (math-mode, selection-wise).
923 * \li Syntax: font-ital
924 * \li Origin: vermeer, 10 Jan 2002
927 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
929 * \var lyx::FuncCode lyx::LFUN_FONT_DEFAULT
930 * \li Action: Reverts the settings of the font to the default values (selection-wise).
931 * \li Syntax: font-default
934 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
935 { LFUN_FONT_FREE_APPLY, "font-free-apply", Noop, Layout },
936 { LFUN_FONT_FREE_UPDATE, "font-free-update", Noop, Layout },
937 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
938 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
940 * \var lyx::FuncCode lyx::LFUN_FONT_STATE
941 * \li Action: Returns the info about the current font.
942 * \li Syntax: font-state
945 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
947 { LFUN_BIBITEM_INSERT, "bibitem-insert", Noop, Edit },
948 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
949 { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit },
950 { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
953 * \var lyx::FuncCode lyx::LFUN_LAYOUT
954 * \li Action: Sets the layout (that is, environment) for the current paragraph.
955 * \li Syntax: layout <LAYOUT>
956 * \li Params: <LAYOUT>: the layout to use
959 { LFUN_LAYOUT, "layout", Noop, Layout },
961 * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH
962 * \li Action: Launches the paragraph settings dialog.
963 * \li Syntax: layout-paragraph
966 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
968 * \var lyx::FuncCode lyx::LFUN_LAYOUT_TABULAR
969 * \li Action: Launches the tabular settings dialog.
970 * \li Syntax: layout-tabular
971 * \li Origin: Jug, 31 Jul 2000
974 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
976 * \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE
977 * \li Action: Displays list of layout choices.
978 * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
979 dropbox allowing for choice of layout.
980 * \li Syntax: drop-layouts-choice
983 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
985 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
986 * \li Action: Clears the module list.
987 * \li Notion: Clears the list of included modules for the current buffer.
988 * \li Syntax: layout-modules-clear
989 * \li Origin: rgh, 25 August 2007
992 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", Noop, Layout },
994 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULE_ADD
995 * \li Action: Adds a module.
996 * \li Notion: Adds a module to the list of included modules for the current buffer.
997 * \li Syntax: layout-module-add <MODULE>
998 * \li Params: <MODULE>: the module to be added
999 * \li Origin: rgh, 25 August 2007
1002 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", Noop, Layout },
1004 * \var lyx::FuncCode lyx::LFUN_LAYOUT_RELOAD
1005 * \li Action: Reloads layout information.
1006 * \li Notion: Reloads all layout information for the current buffer from disk, thus
1007 recognizing any changes that have been made to layout files on the fly.
1008 This is intended to be used only by layout developers and should not be
1009 used when one is trying to do actual work.
1010 * \li Syntax: layout-reload
1011 * \li Origin: rgh, 3 September 2007
1014 { LFUN_LAYOUT_RELOAD, "layout-reload", Noop, Layout },
1016 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
1017 * \li Action: Sets the text class for the current buffer.
1018 * \li Syntax: textclass-apply <TEXTCLASS>
1019 * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
1020 the filename, minus the ".layout" extension.
1023 { LFUN_TEXTCLASS_APPLY, "textclass-apply", Noop, Layout },
1025 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
1026 * \li Action: Loads information for a textclass from disk.
1027 * \li Syntax: textclass-load <TEXTCLASS>
1028 * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
1029 the filename, minus the ".layout" extension.
1032 { LFUN_TEXTCLASS_LOAD, "textclass-load", Noop, Layout },
1035 * \var lyx::FuncCode lyx::LFUN_MARK_OFF
1036 * \li Action: Disable selecting of text-region.
1037 * \li Syntax: mark-off
1040 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
1042 * \var lyx::FuncCode lyx::LFUN_MARK_ON
1043 * \li Action: Enable selecting of text-region.
1044 * \li Notion: After enabling you can simply move arrow keys to get selected region.
1045 * \li Syntax: mark-on
1048 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
1050 * \var lyx::FuncCode lyx::LFUN_MARK_TOGGLE
1051 * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
1052 * \li Syntax: mark-toggle
1053 * \li Origin: poenitz, May 5 2006
1056 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
1058 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
1059 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
1060 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
1061 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
1062 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
1063 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
1064 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
1065 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
1066 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
1067 { LFUN_MATH_SPACE, "math-space", Noop, Math },
1068 { LFUN_MATH_IMPORT_SELECTION, "math-import-selection", Noop, Math },
1069 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
1070 { LFUN_MATH_MODE, "math-mode", Noop, Math },
1072 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
1073 * \li Action: Toggles numbering of the current formula line.
1074 * \li Notion: Must be in display formula mode.
1075 * \li Syntax: math-number-line-toggle
1076 * \li Origin: Alejandro 18 Jun 1996
1079 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
1081 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
1082 * \li Action: Toggles numbering/labeling of the current formula.
1083 * \li Notion: Must be in display formula mode.
1084 * \li Syntax: math-number-toggle
1085 * \li Origin: Alejandro 4 Jun 1996
1088 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
1089 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
1090 { LFUN_MATH_SIZE, "math-size", Noop, Math },
1092 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
1093 * \li Action: Unfold a Math Macro.
1094 * \li Notion: Unfold the Math Macro the cursor is in, i.e.
1096 * \li Syntax: math-macro-unfold
1097 * \li Origin: sts, 06 January 2008
1100 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
1102 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
1103 * \li Action: Fold a Math Macro.
1104 * \li Notion: Fold the Math Macro the cursor is in if it was
1105 unfolded, i.e. displayed as \foo before.
1106 * \li Syntax: math-macro-fold
1107 * \li Origin: sts, 06 January 2008
1110 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
1112 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
1113 * \li Action: Add a parameter.
1114 * \li Notion: Add a parameter to a Math Macro.
1115 * \li Params: <NUM>: The number of the parameter behind which the new one
1116 will be added (1 for the first, i.e. use 0 for add a
1117 parameter at the left), defaults to the last one.
1118 * \li Syntax: math-macro-add-param <NUM>
1119 * \li Origin: sts, 06 January 2008
1122 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
1124 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
1125 * \li Action: Remove the last parameter.
1126 * \li Notion: Remove the last parameter of a Math Macro and
1127 remove its value in all instances of the macro
1129 * \li Params: <NUM>: The number of the parameter to be deleted (1 for
1130 the first), defaults to the last one.
1131 * \li Syntax: math-macro-remove-param <NUM>
1132 * \li Origin: sts, 06 January 2008
1135 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
1137 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
1138 * \li Action: Append a greedy parameter.
1139 * \li Notion: Append a greedy parameter to a Math Macro which
1140 eats the following mathed cell in every instance of
1141 the macro in the buffer.
1142 * \li Syntax: math-macro-append-greedy-param
1143 * \li Origin: sts, 06 January 2008
1146 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
1148 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
1149 * \li Action: Remove a greedy parameter.
1150 * \li Notion: Remove a greedy parameter of a Math Macro and spit
1151 out the values of it in every instance of the macro
1152 in the buffer. If it is an optional parameter the [valud]
1154 * \li Syntax: math-macro-remove-greedy-param
1155 * \li Origin: sts, 06 January 2008
1158 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
1160 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
1161 * \li Action: Make a parameter optional.
1162 * \li Notion: Turn the first non-optional parameter of a Math Macro
1163 into an optional parameter with a default value.
1164 * \li Syntax: math-macro-make-optional
1165 * \li Origin: sts, 06 January 2008
1168 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
1170 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
1171 * \li Action: Make a parameter non-optional.
1172 * \li Notion: Turn the last optional parameter of a Math Macro
1173 into a non-optional parameter. The default value is
1174 remembered to be reused later if the user changes his mind.
1175 * \li Syntax: math-macro-make-nonoptional
1176 * \li Origin: sts, 06 January 2008
1179 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
1181 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
1182 * \li Action: Add an optional parameter.
1183 * \li Notion: Insert an optional parameter just behind the
1184 already existing optional parameters.
1185 * \li Syntax: math-macro-add-optional-param
1186 * \li Origin: sts, 06 January 2008
1189 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
1191 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
1192 * \li Action: Remove the last optional parameter.
1193 * \li Notion: Remove the last optional parameter of a Math Macro and
1194 remove it in all the instances of the macro in the buffer.
1195 * \li Syntax: math-macro-remove-optional-param
1196 * \li Origin: sts, 06 January 2008
1199 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
1201 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
1202 * \li Action: Add a greedy optional parameter.
1203 * \li Notion: Add a greedy optional parameter which eats the value
1204 from the following cells in mathed which are in the [value]
1206 * \li Syntax: math-macro-add-greedy-optional-param
1207 * \li Origin: sts, 06 January 2008
1210 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
1212 * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
1213 * \li Action: Only active in Math Macro definition.
1214 * \li Notion: Dummy function which is only active in a Math Macro definition.
1215 It's used to toggle the Math Macro toolbar if the cursor moves
1216 into a Math Macro definition.
1217 * \li Syntax: in-mathmacrotemplate
1218 * \li Origin: sts, 06 January 2008
1221 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
1224 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
1225 * \li Action: Moves the current paragraph downwards in the document.
1226 * \li Syntax: paragraph-move-down
1227 * \li Origin: Edwin, 8 Apr 2006
1230 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
1232 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
1233 * \li Action: Moves the current paragraph upwards in the document.
1234 * \li Syntax: paragraph-move-up
1235 * \li Origin: Edwin, 8 Apr 2006
1238 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
1241 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP
1242 * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1243 in upward direction.
1244 * \li Syntax: paragraph-up
1245 * \li Origin: Asger, 1 Oct 1996
1248 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
1250 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP_SELECT
1251 * \li Action: Move the cursor and select the text to the next paragraph (or
1252 begining of the current one) in upward direction.
1253 * \li Syntax: paragraph-up-select
1254 * \li Origin: Asger, 1 Oct 1996
1257 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
1259 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN
1260 * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1261 in downward direction.
1262 * \li Syntax: paragraph-down
1263 * \li Origin: Asger, 1 Oct 1996
1266 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
1268 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN_SELECT
1269 * \li Action: Move the cursor and select the text to the next paragraph (or
1270 begining of the current one) in downward direction.
1271 * \li Syntax: paragraph-down-select
1272 * \li Origin: Asger, 1 Oct 1996
1275 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
1277 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
1278 * \li Action: Jump to a paragraph given by its id number and optionally the
1279 desired position within the paragraph.
1280 * \li Notion: Note that id number of paragraph is not the sequential number of paragraph
1281 seen on the screen. Moreover the id is unique for all opened buffers (documents).
1282 * \li Syntax: paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
1283 * \li Params: <PAR_ID_NUMBER>: paragraph id
1284 <POSITION_IN_PAR>: desired position within the paragraph
1285 * \li Origin: Dekel, 26 Aug 2000
1288 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly, Edit },
1290 * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1291 * \li Action: Breaks the current paragraph at the current location.
1292 * \li Syntax: break-paragraph
1295 { LFUN_PARAGRAPH_SPACING, "paragraph-spacing", Noop, Edit },
1297 * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1298 * \li Action: Breaks the current paragraph at the current location.
1299 * \li Notion: Removes the selection.
1300 * \li Syntax: break-paragraph [<LAYOUT>]
1301 * \li Params: <LAYOUT>: "inverse" - decreases depth by one (or change layout
1302 to default layout) when the cursor is at the end of
1306 { LFUN_BREAK_PARAGRAPH, "break-paragraph", Noop, Edit },
1308 * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH_SKIP
1309 * \li Action: Breaks the current paragraph at the current location,
1310 unless used at the beginning of a line, where it sets
1311 the label width string to empty.
1312 * \li Syntax: break-paragraph-skip
1315 { LFUN_BREAK_PARAGRAPH_SKIP, "break-paragraph-skip", Noop, Edit },
1317 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
1318 * \li Action: Change paragraph settings.
1319 * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
1320 This function only modifies, and does not override, existing settings.
1321 Note that the "leftindent" indent setting is deprecated.
1322 * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
1323 * \li Params: <INDENT>: \\noindent|\\indent|\\indent-toggle|\\leftindent LENGTH\n
1324 <SPACING>: \\paragraph_spacing default|single|onehalf|double|other\n
1325 <ALIGN>: \\align block|left|right|center|default\n
1326 <OTHERS>: \\labelwidthstring WIDTH|\\start_of_appendix\n
1327 * \li Origin: rgh, Aug 15 2007
1330 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
1332 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
1333 * \li Action: Change paragraph settings.
1334 * \li Notion: Overwrite all nonspecified settings to the default ones.
1335 Use paragraph-params lfun if you don't want to overwrite others settings.
1336 * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
1337 * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
1338 * \li Origin: leeming, 30 Mar 2004
1341 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
1342 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
1345 * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
1346 * \li Action: Move the current group in the upward direction in the
1347 structure of the document.
1348 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1349 the whole substructure of the group.
1350 * \li Syntax: outline-up
1351 * \li Origin: Vermeer, 23 Mar 2006
1354 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
1356 * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
1357 * \li Action: Move the current group in the downward direction in the
1358 structure of the document.
1359 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1360 the whole substructure of the group.
1361 * \li Syntax: outline-down
1362 * \li Origin: Vermeer, 23 Mar 2006
1365 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
1367 * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
1368 * \li Action: Moves the current group in the downward direction in the
1369 hierarchy of the document structure.
1370 * \li Notion: Part -> Chapter -> Section -> etc.
1371 * \li Syntax: outline-in
1372 * \li Origin: Vermeer, 23 Mar 2006
1375 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
1377 * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
1378 * \li Action: Moves the current group in the upward direction in the
1379 hierarchy of the document structure.
1380 * \li Notion: Part <- Chapter <- Section <- etc.
1381 * \li Syntax: outline-out
1382 * \li Origin: Vermeer, 23 Mar 2006
1385 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
1387 * \var lyx::FuncCode lyx::LFUN_INSET_EDIT
1388 * \li Action: Edit the inset at cursor with an external application,
1389 * if one is attributed.
1390 * \li Syntax: inset-edit [<INSET_PARAMS>]
1391 * \li Params: <INSET_PARAMS>: Parameters for the inset.
1392 Currently only the filename will be considered.
1393 * \li Origin: JSpitzm, 27 Apr 2006
1396 { LFUN_INSET_EDIT, "inset-edit", Noop, Edit },
1398 { LFUN_CELL_BACKWARD, "cell-backward", Noop, Edit },
1399 { LFUN_CELL_FORWARD, "cell-forward", Noop, Edit },
1400 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
1401 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
1402 { LFUN_TABULAR_FEATURE, "tabular-feature", Noop, Edit },
1404 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
1405 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
1406 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
1407 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
1408 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
1410 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
1411 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
1412 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
1413 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
1414 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
1415 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
1416 { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
1417 { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
1420 * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
1421 * \li Action: Apply data for an inset.
1422 * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
1423 be applied. This is either changed to #LFUN_INSET_MODIFY or
1424 #LFUN_INSET_INSERT depending on the context where it is called.
1425 * \li Syntax: inset-apply <ARGS>
1426 * \li Params: See #LFUN_INSET_INSERT .
1429 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
1431 * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE
1432 * \li Action: Dissolve the current inset into text.
1433 * \li Syntax: inset-dissolve [<INSET>]
1434 * \li Params: <INSET>: this can be used to make sure the right kind of inset
1435 is dissolved. For example "dissolve" entry in the charstyles
1436 sub-menu should only dissolve the charstyle inset, even if the
1437 cursor is inside several nested insets of different type.\n
1438 For values see #lyx::InsetLayout::lyxtype_ .
1439 * \li Author: JSpitz, 7 Aug 2006
1442 { LFUN_INSET_DISSOLVE, "inset-dissolve", Noop, Edit },
1444 * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
1445 * \li Action: Insert new inset (type given by the parameters).
1446 * \li Syntax: inset-insert <INSET> <ARGS>
1447 * \li Params: <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics|
1448 hyperlink|include|index|label|nomencl|vspace|ref|toc>\n
1449 <ARGS>: depends on the given inset. Use "lyx -dbg action" to
1451 * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
1452 where <label name> is the name of the referenced label and
1453 <Format> is one of the following: \n
1454 ref -- <reference> \n
1455 eqref -- (<reference>) \n
1456 pageref -- <page> \n
1457 vpageref -- on <page> \n
1458 vref -- <reference> on <page> \n
1459 prettyref -- Formatted reference
1462 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
1464 * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
1465 * \li Action: Modify existing inset.
1466 * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1467 bibtex, ert, command, graphics, note, space, vspace, tabular,
1468 bibitem, inlude, ref insets.
1469 * \li Syntax: inset-modify <INSET> <ARGS>
1470 * \li Params: See #LFUN_INSET_INSERT for further details.
1473 { LFUN_INSET_MODIFY, "", Noop, Hidden },
1475 * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_MODIFY
1476 * \li Action: Modify the inset at cursor position, if there is one.
1477 * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1478 bibtex, ert, command, graphics, note, space, vspace, tabular,
1479 bibitem, inlude, ref insets.
1480 * \li Syntax: next-inset-modify <INSET> <ARGS> or next-inset-modify changetype <TYPE>
1481 * \li Params: See #LFUN_INSET_INSERT for further details.
1482 * \li Origin: JSpitzm, 23 Mar 2008
1485 { LFUN_NEXT_INSET_MODIFY, "next-inset-modify", ReadOnly, Edit },
1486 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
1488 * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
1489 * \li Action: Open the inset's properties dialog.
1490 * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
1491 * \li Syntax: inset-settings <INSET>
1492 * \li Params: <INSET>: <box|branch|ert|float|listings|note|tabular|wrap>
1495 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly, Edit },
1497 * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_TOGGLE
1498 * \li Action: Toggles the inset at cursor position. For collapsables, this means it will
1499 be (un-)collapsed, in case of other insets, the editing widget (dialog) will
1500 be entered. Also cf. #LFUN_INSET_SETTINGS.
1501 * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1502 bibtex, ert, command, graphics, note, space, vspace, tabular,
1503 bibitem, inlude, ref insets.
1504 * \li Syntax: next-inset-toggle <ARG>
1505 * \li Params: <ARG>: these are passed as arguments to #LFUN_INSET_TOGGLE .
1506 * \li Origin: leeming, 30 Mar 2004
1509 { LFUN_NEXT_INSET_TOGGLE, "next-inset-toggle", ReadOnly, Edit },
1511 * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
1512 * \li Action: Toggles the collapsable inset we are currently in.
1513 * \li Syntax: inset-toggle [<ARG>]
1514 * \li Params: <ARG>: <open|close|toggle|assign>. \n
1515 open/close/toggle are for collapsable insets. close can be currently used
1516 by #LFUN_NEXT_INSET_TOGGLE. toggle is used when no argument is given.\n
1517 assign is for branch inset.
1518 * \li Origin: lasgouttes, 19 Jul 2001
1521 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly, Hidden },
1523 * \var lyx::FuncCode lyx::LFUN_ALL_INSETS_TOGGLE
1524 * \li Action: Toggles (open/closes) all collapsable insets (of a given type) in the document.
1525 * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
1526 * \li Syntax: all-insets-toggle <STATE> <INSET>
1527 * \li Params: <STATE>: <toggle|open|close> default: toggle \n
1528 <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all insets \n
1529 * \li Origin: leeming, 30 Mar 2004
1532 { LFUN_ALL_INSETS_TOGGLE, "all-insets-toggle", ReadOnly, Edit },
1534 * \var lyx::FuncCode lyx::LFUN_GRAPHICS_GROUPS_UNIFY
1535 * \li Action: Unify all graphics insets with the one given as an parameter.
1536 * \li Notion: This is internally used for synchronize certain group of graphics insets.
1537 * \li Syntax: graphics-groups-unigfy <GRAPHICS_PARAMS>
1538 * \li Params: <GRAPHICS_PARAMS>: Parameters for graphics inset
1539 (syntax can be seen in .lyx files).
1540 * \li Origin: sanda, 6 May 2008
1543 { LFUN_GRAPHICS_GROUPS_UNIFY, "graphics-groups-unify", ReadOnly, Edit },
1545 * \var lyx::FuncCode lyx::LFUN_SET_GRAPHICS_GROUP
1546 * \li Action: Set the group for the graphics inset on the cursor position.
1547 * \li Syntax: set-graphics-group [<GROUP>]
1548 * \li Params: <GROUP>: Id for an existing group. In case tthe Id is an empty string,
1549 the graphics inset is removed from the current group.
1550 * \li Origin: sanda, 6 May 2008
1553 { LFUN_SET_GRAPHICS_GROUP, "set-graphics-group", ReadOnly, Edit },
1556 * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
1557 * \li Action: Moves the cursor out of the current slice, going forward.
1558 * \li Notion: Cursor movement within an inset may be different than cursor
1559 movement in the surrounding text. This action should be called
1560 automatically by the cursor movement within the inset, when
1561 movement within the inset has ceased (reached the end of the
1562 last paragraph, for example), in order to move correctly
1563 back into the surrounding text.
1566 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
1568 * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
1569 * \li Action: Moves the cursor out of the current slice, going backwards.
1570 * \li Notion: See also #LFUN_FINISHED_FORWARD.
1573 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
1575 * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
1576 * \li Action: Moves the cursor out of the current slice, going right.
1577 * \li Notion: See also #LFUN_FINISHED_FORWARD
1580 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
1582 * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
1583 * \li Action: Moves the cursor out of the current slice, going left.
1584 * \li Notion: See also #LFUN_FINISHED_FORWARD.
1587 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
1589 { LFUN_LANGUAGE, "language", Noop, Edit },
1592 * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
1593 * \li Action: Goto a label.
1594 * \li Syntax: label-goto [<LABEL>]
1595 * \li Params: <LABEL>: Requested label. If no label is given and refernce
1596 is on cursor position, Bookmark 0 is saved and
1597 cursor moves to the position of referenced label.
1598 * \li Origin: Ale, 6 Aug 1997
1601 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
1603 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT
1604 * \li Action: Inserts label to text or displayed formula.
1605 * \li Syntax: label-insert [<LABEL>]
1606 * \li Params: <LABEL>: Requested label. If no label is given dialog requesting
1607 name will be opened.
1610 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
1612 * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
1613 * \li Action: Go to the next label or cross-reference.
1614 * \li Syntax: reference-next
1615 * \li Origin: Dekel, 14 Jan 2001
1618 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
1621 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
1622 * \li Action: Goto a bookmark.
1623 * \li Notion: Moves the cursor to the numbered bookmark, opening the file
1624 if necessary. Note that bookmarsk are saved per-session, not
1626 * \li Syntax: bookmark-goto <NUMBER>
1627 * \li Params: <NUMBER>: the number of the bookmark to restore.
1628 * \li Origin: Dekel, 27 January 2001
1631 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
1633 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
1634 * \li Action: Save a bookmark.
1635 * \li Notion: Saves a numbered bookmark to the sessions file. The number
1636 must be between 1 and 9, inclusive. Note that bookmarks are
1637 saved per-session, not per file.
1638 * \li Syntax: bookmark-save <NUMBER>
1639 * \li Params: <NUMBER>: the number of the bookmark to save.
1640 * \li Origin: Dekel, 27 January 2001
1643 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
1645 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
1646 * \li Action: Clears the list of saved bookmarks.
1647 * \li Syntax: bookmark-clear
1648 * \li Origin: bpeng, 31 October 2006
1651 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
1654 * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
1655 * \li Action: Open the given help file according to the language setting.
1656 * \li Syntax: help-open <FILE>[.lyx]
1657 * \li Params: <FILE>: any document from (/usr/share/)doc directory.
1658 * \li Author: Jug, 27 Jun 1999
1661 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
1663 * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
1664 * \li Action: Terminates the current LyX instance.
1665 * \li Notion: Terminates the current LyX instance, asking whether to save
1666 modified documents, etc.
1667 * \li Syntax: lyx-quit
1670 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
1672 * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
1673 * \li Action: Toggles visibility of a given toolbar between on/off/auto.
1674 * \li Notion: Skiping "auto" when allowauto is false.
1675 * \li Syntax: toolbar-toggle <NAME> [allowauto]
1676 * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|
1677 minibuffer|review|view/update|math_panels
1678 * \li Origin: Edwin, 21 May 2007
1681 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
1683 * \var lyx::FuncCode lyx::LFUN_MENU_OPEN
1684 * \li Action: Opens the menu given by its name.
1685 * \li Syntax: menu-open <NAME>
1686 * \li Params: <NAME>: menu name. See various .inc files in lib/ui for candidates.
1689 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
1691 * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
1692 * \li Action: Various UI visibility-toggling actions.
1693 * \li Syntax: ui-toggle <statusbar|menubar|frame|fullscreen>
1694 * \li Params: statusbar : Toggle visibility of the statusbar.\n
1695 menubar : Toggle visibility of the menubar.\n
1696 scrollbar : Toggle visibility of the scrollbar.\n
1697 frame : Toggle visibility of the frames around editing window.\n
1698 fullscreen : Toggle fullscreen mode. This also covers calling the
1699 previous functions. However #LFUN_TOOLBAR_TOGGLE for the
1700 custom tweaks of the toolbars should be used.
1701 * \li Origin: ps, 9 Feb 2007
1704 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
1707 * \var lyx::FuncCode lyx::WINDOW_NEW
1708 * \li Action: Creates new empty LyX window.
1709 * \li Notion: Already opened documents from the previous window can be found under View menu.
1710 * \li Syntax: window-new [<GEOMETRY>]
1711 * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently
1712 accepted only on Windows platform.
1713 * \li Origin: Abdel, 21 Oct 2006
1716 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
1718 * \var lyx::FuncCode lyx::LFUN_WINDOW_CLOSE
1719 * \li Action: Closes the current LyX window.
1720 * \li Syntax: window-close
1721 * \li Origin: Abdel, 23 Oct 2006
1724 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
1727 * \var lyx::FuncCode lyx::LFUN_SPLIT_VIEW
1728 * \li Action: Creates another split view of current buffer.
1729 * \li Notion: All split views act in the same way indpendently.
1730 * \li Syntax: split-view <vertical|horizontal>
1731 * \li Params: horizontal : The work areas are laid out side by side.\n
1732 vertical : The work areas laid out vertically.\n
1733 * \li Origin: abdel, 20 Feb 2008
1736 { LFUN_SPLIT_VIEW, "split-view", ReadOnly, Buffer },
1739 * \var lyx::FuncCode lyx::LFUN_CLOSE_TAB_GROUP
1740 * \li Action: Close the current tab group.
1741 * \li Notion: This only closes the work areas, not the buffer themselves.
1742 The still opened buffers can be visualized in another tab group.
1743 * \li Syntax: close-tab-group
1744 * \li Origin: abdel, 21 Feb 2008
1747 { LFUN_CLOSE_TAB_GROUP, "close-tab-group", ReadOnly, Buffer },
1748 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
1749 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
1750 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
1751 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
1752 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
1753 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
1755 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
1756 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
1757 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
1758 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
1759 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
1761 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
1762 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
1763 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
1764 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
1766 { LFUN_SERVER_CHAR_AFTER, "server-char-after", ReadOnly, System },
1767 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
1768 { LFUN_SERVER_GET_NAME, "server-get-name", ReadOnly, System },
1770 * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
1771 * \li Action: Sets the cursor position based on the row number of generated TeX file.
1772 * \li Syntax: server-goto-file-row <LYX_FILE_NAME> <ROW_NUMBER>
1773 * \li Origin: Edmar, 23 Dec 1998
1776 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly, System },
1777 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
1779 * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
1780 * \li Action: Sets the cursor position based on the editing area coordinates
1781 (similar as clicking on that point with left mouse button).
1782 * \li Syntax: server-set-xy <X> <Y>
1785 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
1787 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
1788 * \li Action: Returns the coordinates of cursor position in the editing area.
1789 * \li Syntax: server-get-xy
1792 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
1795 * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
1796 * \li Action: Generates the code (literate programming).
1797 * \li Notion: Latex file with extension \literate_extension is generated.
1798 Then LyX invokes \build_command (with a default of``make'') to generate the code and
1799 \build_error_filter to process the compilation error messages. \n
1800 In case you want to process your literate file with a script, or some other program,
1801 just insert in your lyxrc file an entry with:\n
1802 \build_command "my_script my_arguments" \n
1803 The \build_error_filter differs from the \literate_error_filter only in that the
1804 former will identify error messages from your compiler.
1805 * \li Syntax: build-program
1808 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
1811 * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
1812 * \li Action: Saves the current buffer to a temporary file.
1813 * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
1814 is called automatically by LyX, to "autosave" the current buffer.
1815 * \li Syntax: buffer-auto-save
1818 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
1820 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHILD_OPEN
1821 * \li Action: Loads the given child document.
1822 * \li Notion: The current document is treated as a parent.
1823 * \li Syntax: buffer-child-open <FILE>
1824 * \li Params: <FILE>: Filename of the child. The directory of the parent is assumed by default.
1825 * \li Origin: Ale, 28 May 1997
1828 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
1830 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHKTEX
1831 * \li Action: Runs chktex for the current document.
1832 * \li Syntax: buffer-chktex
1833 * \li Origin: Asger, 30 Oct 1997
1836 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
1838 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
1839 * \li Action: Toggles compression of the current document on/off.
1840 * \li Syntax: buffer-toggle-compression
1841 * \li Origin: bpeng, 27 Apr 2006
1844 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
1846 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
1847 * \li Action: Closes the current buffer.
1848 * \li Notion: Closes the current buffer, asking whether to save it, etc,
1849 if the buffer has been modified.
1850 * \li Syntax: buffer-close
1853 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
1855 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
1856 * \li Action: Exports the current buffer (document) to the given format.
1857 * \li Syntax: buffer-export <FORMAT>
1858 * \li Params: <FORMAT> is either "custom" or one of the formats which you
1859 can find in Tools->Preferences->File formats->Format.
1860 Usual format you will enter is "pdf2" (pdflatex),
1861 "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
1862 In case of "custom" you will be asked for a format you
1863 want to start from and for the command that you want to
1864 apply to this format. Internally the control is then passed
1865 to #LFUN_BUFFER_EXPORT_CUSTOM.
1866 * \li Origin: Lgb, 29 Jul 1997
1869 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
1871 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
1872 * \li Action: Exports the current buffer (document) from the given format using
1873 the given command on it.
1874 * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
1875 * \li Params: <FORMAT> format to start from (LyX will care to produce such
1876 intermediate file).\n
1877 <COMMAND> this command will be launched on the file. Note that you can
1878 use "$$FName" string to qualify the intermediate file.
1879 * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
1880 * \li Origin: leeming, 27 Mar 2004
1883 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
1885 * \var lyx::FuncCode lyx::LFUN_BUFFER_PRINT
1886 * \li Action: Prints the current document.
1887 * \li Notion: Many settings can be given via the preferences dialog.
1888 * \li Syntax: buffer-print <TARGET> <TARGET-NAME> <COMMAND>
1889 * \li Params: <TARGET> is either "printer" or "file".\n
1890 <TARGER-NAME> is either "default" or file name or printer name.\n
1891 <COMMAND> command ensuring the printing job.
1892 * \li Sample: buffer-print file "/trash/newfile1.ps" "dvips"
1893 * \li Origin: leeming, 28 Mar 2004
1896 { LFUN_BUFFER_PRINT, "buffer-print", ReadOnly, Buffer },
1898 * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
1899 * \li Action: Import a given file as a lyx document.
1900 * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
1901 defined convertors in preferences. Look into File->Import menu to get
1902 an idea of the currently active import formats.
1903 * \li Syntax: buffer-import <FORMAT> [<FILE>]
1904 * \li Origin: Asger, 24 Jul 1998
1907 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
1909 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
1910 * \li Action: Creates a new buffer (that is, document).
1911 * \li Notion: Implicit path can be set in Preferences dialog.
1912 * \li Syntax: buffer-new [<FILE>]
1913 * \li Params: <FILE>: filename of created file with absolute path.
1916 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
1918 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
1919 * \li Action: Creates a new buffer (that is, document) from a template.
1920 * \li Notion: Path for new files and templates can be set in Preferences dialog.
1921 Template will be asked for via Open-dialog.
1922 * \li Syntax: buffer-new-template [<FILE>]
1923 * \li Params: <FILE>: filename of created file with absolute path.
1926 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
1928 * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
1929 * \li Action: Reverts opened document.
1930 * \li Syntax: buffer-reload
1931 * \li Origin: Asger, 2 Feb 1997
1934 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
1936 * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
1937 * \li Action: Switch to the given buffer.
1938 * \li Notion: This is useful also in case you need simultaneously more views of the edited
1939 document in different LyX windows.
1940 * \li Syntax: buffer-new-template <BUFFER>
1941 * \li Params: <BUFFER>: already opened document which is to be shown.
1944 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
1946 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
1947 * \li Action: Toggle editing mode of the current document between read/write and read-only.
1948 * \li Syntax: buffer-toggle-read-only
1949 * \li Origin: Lgb, 27 May 1997
1952 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
1954 * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
1955 * \li Action: Displays current buffer in chosen format.
1956 * \li Notion: Displays the contents of the current buffer in the chosen
1957 format, for example, PDF or DVI. This runs the necessary
1958 converter, calls the defined viewer, and so forth.
1959 * \li Syntax: buffer-view <FORMAT>
1960 * \li Params: <FORMAT>: The format to display, where this is one of the
1961 formats defined (in the current GUI) in the
1962 Tools>Preferences>File Formats dialog.
1965 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
1967 * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
1968 * \li Action: Exports the current document and put the result into the
1969 temporary directory.
1970 * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
1971 the output will be rewriten - updated. This is useful in case your viewer
1972 is able to detect such changes (e.g. ghostview for postscript).
1973 * \li Syntax: buffer-update <FORMAT>
1974 * \li Params: <FORMAT>: The format to display, where this is one of the
1975 formats defined (in the current GUI) in the
1976 Tools>Preferences>File Formats dialog.
1977 * \li Origin: Dekel, 5 Aug 2000
1980 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
1983 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
1984 * \li Action: Saves the current buffer.
1985 * \li Notion: Saves the current buffer to disk, using the filename that
1986 is already associated with the buffer, asking for one if
1987 none is yet assigned.
1988 * \li Syntax: buffer-write
1991 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
1993 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
1994 * \li Action: Rename and save current buffer.
1995 * \li Syntax: buffer-write-as <FILENAME>
1996 * \li Params: <FILENAME>: New name of the buffer/file. A relative path
1997 is with respect to the original location of the buffer/file.
2000 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
2002 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
2003 * \li Action: Save all changed documents.
2004 * \li Syntax: buffer-write-all
2005 * \li Origin: rgh, gpothier 6 Aug 2007
2008 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
2010 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEXT
2011 * \li Action: Switch to the next opened document.
2012 * \li Notion: Note that this does not necessarily mean next in tabbar
2013 (for full list see View menu).
2014 * \li Syntax: buffer-next
2017 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
2019 * \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS
2020 * \li Action: Switch to the previous opened document.
2021 * \li Syntax: buffer-previous
2024 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
2026 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
2027 * \li Action: When run from a child document, this updates (exports) document built
2028 from the master buffer. If a master is not found, it updates the
2030 * \li Syntax: master-buffer-update
2031 * \li Author: Tommaso, 20 Sep 2007
2034 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
2036 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
2037 * \li Action: When run from a child document, this command shows a preview built
2038 from the master buffer. If a master is not found, it previews the
2040 * \li Syntax: master-buffer-view
2041 * \li Author: Tommaso, 20 Sep 2007
2044 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
2046 * \var lyx::FuncCode lyx::LFUN_BUFFER_LANGUAGE
2047 * \li Action: Set language of the current document.
2048 * \li Syntax: buffer-language <LANG>
2049 * \li Params: <LANG>: language name. See lib/languages for list.
2050 * \li Author: leeming, 30 Mar 2004
2053 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
2055 * \var lyx::FuncCode lyx::LFUN_BUFFER_SAVE_AS_DEFAULT
2056 * \li Action: Save the current document settings as default.
2057 * \li Notion: The file will will be saved into ~/.lyx/templates/defaults.lyx .
2058 * \li Syntax: buffer-save-as-default [<ARGS>]
2059 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
2060 you can find in document header of usual .lyx file.
2061 * \li Author: leeming, 30 Mar 2004
2064 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
2066 * \var lyx::FuncCode lyx::LFUN_BUFFER_PARAMS_APPLY
2067 * \li Action: Apply the given settings to the current document.
2068 * \li Syntax: buffer-params-apply [<ARGS>]
2069 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
2070 you can find in document header of usual .lyx file.
2071 * \li Author: leeming, 30 Mar 2004
2074 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", Noop, Buffer },
2077 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
2078 * \li Action: Inserts another LyX file.
2079 * \li Syntax: file-insert [<FILE>]
2080 * \li Params: <FILE>: Filename to be inserted.
2083 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
2085 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
2086 * \li Action: Inserts plain text file.
2087 * \li Syntax: file-insert-plaintext [<FILE>]
2088 * \li Params: <FILE>: Filename to be inserted.
2089 * \li Origin: CFO-G, 19 Nov 1997
2092 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
2094 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
2095 * \li Action: Inserts plain text file as paragraph (i.e. join lines).
2096 * \li Syntax: file-insert-plaintext-para [<FILE>]
2097 * \li Params: <FILE>: Filename to be inserted.
2098 * \li Origin: Levon, 14 Feb 2001
2101 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
2103 * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
2104 * \li Action: Open LyX document.
2105 * \li Syntax: file-open [<FILE>]
2106 * \li Params: <FILE>: Filename to be opened.
2109 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
2112 * \var lyx::FuncCode lyx::LFUN_CALL
2113 * \li Action: Executes a command defined in a .def file.
2114 * \li Notion: The definitions are by default read from lib/commands/default.def.\n
2115 A .def file allows to define a command with \\define "<NAME>" "<LFUN>"
2116 where <NAME> is the name of the new command and <LFUN> is the lfun code
2117 to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
2118 \\def_file "FileName" allows to include another .def file. \n
2119 This is particularly useful in connection with toolbar buttons:
2120 Since the name of the button image for this lfun is
2121 lib/images/commands/<NAME>.png this is the way to assign an image
2122 to a complex command-sequence.
2123 * \li Syntax: call <NAME>
2124 * \li Params: <NAME>: Name of the command that must be called.
2125 * \li Origin: broider, 2 Oct 2007
2128 { LFUN_CALL, "call", NoBuffer, System },
2130 * \var lyx::FuncCode lyx::LFUN_META_PREFIX
2131 * \li Action: Simulate halting Meta key (Alt key on PCs).
2132 * \li Notion: Used for buffer editation not for GUI control.
2133 * \li Syntax: meta-prefix
2136 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
2138 * \var lyx::FuncCode lyx::LFUN_CANCEL
2139 * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
2140 * \li Syntax: cancel
2143 { LFUN_CANCEL, "cancel", NoBuffer, System },
2146 * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
2147 * \li Action: Opens the minibuffer toolbar so that the user can type in there.
2148 * \li Notion: Usually bound to M-x shortcut.
2149 * \li Syntax: command-execute
2152 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
2153 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
2155 * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
2156 * \li Action: Run more commands (LFUN and its parameters) in a sequence.
2157 * \li Syntax: command-sequence <CMDS>
2158 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
2159 * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
2160 * \li Origin: Andre', 11 Nov 1999
2163 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
2165 * \var lyx::FuncCode lyx::LFUN_MESSAGE
2166 * \li Action: Shows message in statusbar (for script purposes).
2167 * \li Syntax: message <STRING>
2168 * \li Origin: Lgb, 8 Apr 2001
2171 { LFUN_MESSAGE, "message", NoBuffer, System },
2173 * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
2174 * \li Action: Save user preferences.
2175 * \li Syntax: preferences-save
2176 * \li Origin: Lgb, 27 Nov 1999
2179 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
2181 * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
2182 * \li Action: Reconfigure the automatic settings.
2183 * \li Syntax: reconfigure
2184 * \li Origin: Asger, 14 Feb 1997
2187 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
2189 * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
2190 * \li Action: Apply the given settings to user preferences.
2191 * \li Syntax: lyxrc-apply <SETTINGS>
2192 * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
2193 to get an idea which commands to use and their syntax.
2194 #lyx::LyXRC::LyXRCTags has the list of possible commands.
2197 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
2199 * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
2200 * \li Action: Determine whether keep cursor inside the editing window regardless
2201 the scrollbar movement.
2202 * \li Syntax: toggle-cursor-follows-scrollbar
2203 * \li Origin: ARRae, 2 Dec 1997
2206 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
2208 * \var lyx::FuncCode lyx::LFUN_SET_COLOR
2209 * \li Action: Set the given LyX color to the color defined by the X11 name given.
2210 * \li Notion: A new color entry is created if the color is unknown.
2211 Color names can be stored as a part of user settings.
2212 * \li Syntax: set-color <LYX_NAME> <X11_NAME>
2213 * \li Origin: SLior, 11 Jun 2000
2216 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
2218 * \var lyx::FuncCode lyx::LFUN_STATISTICS
2219 * \li Action: Count the statistics (number of words and characters)
2220 in the document or in the given selection.
2221 * \li Notion: Note that this function gives the number of words/chars written,
2222 not the number of characters which will be typeset.
2223 * \li Syntax: statistics
2224 * \li Origin: lasgouttes, Jan 27 2004; ps, Jan 8 2008
2227 { LFUN_STATISTICS, "statistics", ReadOnly, System },
2229 * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
2230 * \li Action: Show the inline completion at the cursor position.
2231 * \li Syntax: completion-inline
2232 * \li Origin: sts, Feb 19 2008
2235 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
2237 * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
2238 * \li Action: Show the completion popup at the cursor position.
2239 * \li Syntax: completion-popup
2240 * \li Origin: sts, Feb 19 2008
2243 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
2245 * \var lyx::FuncCode lyx::LFUN_COMPLETION_COMPLETE
2246 * \li Action: Try to complete the word or command at the cursor position.
2247 * \li Syntax: completion-complete
2248 * \li Origin: sts, Feb 19 2008
2251 { LFUN_COMPLETION_COMPLETE, "complete", SingleParUpdate, Edit },
2253 * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
2254 * \li Action: Activate the branch
2255 * \li Syntax: branch-activate <BRANCH>
2256 * \li Params: <BRANCH>: The branch to activate
2257 * \li Sample: lyx -e pdf2 -x "branch-activate answers" finalexam.lyx \n
2258 could be used to export a pdf with the answers branch included
2259 without one's having to open LyX and activate the branch manually.
2260 * \li Origin: rgh, 27 May 2008
2263 { LFUN_BRANCH_ACTIVATE, "branch-activate", Argument, Buffer },
2265 * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
2266 * \li Action: De-activate the branch
2267 * \li Syntax: branch-deactivate <BRANCH>
2268 * \li Params: <BRANCH>: The branch to deactivate
2269 * \li Origin: rgh, 27 May 2008
2272 { LFUN_BRANCH_DEACTIVATE, "branch-deactivate", Argument, Buffer },
2274 { LFUN_NOACTION, "", Noop, Hidden }
2275 #ifndef DOXYGEN_SHOULD_SKIP_THIS
2278 for (int i = 0; items[i].action != LFUN_NOACTION; ++i) {
2279 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
2286 LyXAction::LyXAction()
2292 // Returns an action tag from a string.
2293 FuncRequest LyXAction::lookupFunc(string const & func) const
2295 string const func2 = trim(func);
2297 if (func2.empty()) {
2298 return FuncRequest(LFUN_NOACTION);
2302 string const arg = split(func2, cmd, ' ');
2304 func_map::const_iterator fit = lyx_func_map.find(cmd);
2306 return fit != lyx_func_map.end() ? FuncRequest(fit->second, arg) : FuncRequest(LFUN_UNKNOWN_ACTION);
2310 string const LyXAction::getActionName(FuncCode action) const
2312 info_map::const_iterator const it = lyx_info_map.find(action);
2313 return it != lyx_info_map.end() ? it->second.name : string();
2317 LyXAction::func_type const LyXAction::getActionType(FuncCode action) const
2319 info_map::const_iterator const it = lyx_info_map.find(action);
2320 return it != lyx_info_map.end() ? it->second.type : Hidden;
2324 bool LyXAction::funcHasFlag(FuncCode action,
2325 LyXAction::func_attrib flag) const
2327 info_map::const_iterator ici = lyx_info_map.find(action);
2329 if (ici == lyx_info_map.end()) {
2330 LYXERR0("action: " << action << " is not known.");
2331 LASSERT(false, /**/);
2334 return ici->second.attrib & flag;
2338 LyXAction::const_func_iterator LyXAction::func_begin() const
2340 return lyx_func_map.begin();
2344 LyXAction::const_func_iterator LyXAction::func_end() const
2346 return lyx_func_map.end();