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 },
502 * \var lyx::FuncCode lyx::LFUN_ESCAPE
503 * \li Action: Clears the selection. If no text is selected call #LFUN_FINISHED_FORWARD.
505 * \li Origin: Lgb, 17 May 2001
508 { LFUN_ESCAPE, "escape", ReadOnly, Edit },
510 * \var lyx::FuncCode lyx::LFUN_DOWN
511 * \li Action: Moves the cursor one line in downward direction.
515 { LFUN_DOWN, "down", ReadOnly | NoUpdate, Edit },
517 * \var lyx::FuncCode lyx::LFUN_UP
518 * \li Action: Moves the cursor one line in upward direction.
522 { LFUN_UP, "up", ReadOnly | NoUpdate, Edit },
524 * \var lyx::FuncCode lyx::LFUN_DOWN_SELECT
525 * \li Action: Moves the cursor one line in downward direction adding the current
526 position to the selection.
527 * \li Syntax: down-select
530 { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, Edit },
532 * \var lyx::FuncCode lyx::LFUN_UP_SELECT
533 * \li Action: Moves the cursor one line in upward direction adding the current
534 position to the selection.
535 * \li Syntax: up-select
538 { LFUN_UP_SELECT, "up-select", ReadOnly | SingleParUpdate, Edit },
539 { LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit },
540 { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit },
541 { LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit },
542 { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit },
544 * \var lyx::FuncCode lyx::LFUN_SCROLL
545 * \li Action: Scroll the buffer view.
546 * \li Notion: Only scrolls the screen up or down; does not move the cursor.
547 * \li Syntax: scroll <TYPE> <QUANTITY>
548 * \li Params: <TYPE>: line|page\n
549 <QUANTITY>: up|down|<number>
550 * \li Origin: Abdelrazak Younes, Dec 27 2007
553 { LFUN_SCROLL, "scroll", ReadOnly, Edit },
555 * \var lyx::FuncCode lyx::LFUN_SCREEN_RECENTER
556 * \li Action: Recenters the screen on the current cursor position.
557 * \li Syntax: screen-recenter
560 { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit },
562 { LFUN_ERROR_NEXT, "error-next", ReadOnly, Edit },
564 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD
565 * \li Action: Moves the cursor one position logically backwards.
566 * \li Notion: This is not the action which should be bound to the arrow keys,
567 because backwards may be left or right, depending on the
568 language. The arrow keys should be bound to #LFUN_CHAR_LEFT or
569 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
570 * \li Syntax: char-backward
573 { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit },
575 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD_SELECT
576 * \li Action: Moves the cursor one position logically backwards, adding
577 traversed position to the selection.
578 * \li Notion: See also #LFUN_CHAR_BACKWARD.
579 * \li Syntax: char-backward-select
582 { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit },
584 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_BACKWARD
585 * \li Action: Deletes one character in the backward direction (usually the "BackSpace" key).
586 * \li Syntax: char-delete-backward
589 { LFUN_CHAR_DELETE_BACKWARD, "char-delete-backward", SingleParUpdate, Edit },
591 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_FORWARD
592 * \li Action: Deletes one character in the backward direction (usually the "Delete" key).
593 * \li Syntax: char-delete-forward
596 { LFUN_CHAR_DELETE_FORWARD, "char-delete-forward", SingleParUpdate, Edit },
598 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD
599 * \li Action: Moves the cursor one position logically forward.
600 * \li Notion: This is not the action which should be bound to the arrow keys,
601 because forward may be left or right, depending on the language.
602 The arrow keys should be bound to #LFUN_CHAR_LEFT or
603 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
604 * \li Syntax: char-forward
607 { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit },
609 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD_SELECT
610 * \li Action: Moves the cursor one position logically forward, adding
611 traversed position to the selection.
612 * \li Notion: See also #LFUN_CHAR_FORWARD.
613 * \li Syntax: char-forward-select
616 { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit },
618 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT
619 * \li Action: Moves the cursor one position "to the left".
620 * \li Notion: This is the action which should be taken when the "left" key
621 is pressed. Generally, it moves the cursor one position to the
622 left. However, in Bidi text this become slightly more
623 complicated, and there are different modes of cursor movement.
624 In "visual mode", this moves left, plain and simple. In "logical
625 mode", movement is logically forward in RTL paragraphs, and
626 logically backwards in LTR paragraphs.
627 * \li Syntax: char-left
630 { LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit },
632 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT_SELECT
633 * \li Action: Moves the cursor one position "to the left", adding
634 traversed position to the selection.
635 * \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement.
636 * \li Syntax: char-left-select
639 { LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit },
641 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT
642 * \li Action: Moves the cursor one position "to the right".
643 * \li Notion: This is the action which should be taken when the "right" key
644 is pressed. Generally, it moves the cursor one position to the
645 right. However, in Bidi text this become slightly more
646 complicated, and there are different modes of cursor movement.
647 In "visual mode", this moves right, plain and simple. In "logical
648 mode", movement is logically forward in LTR paragraphs, and
649 logically backwards in RTL paragraphs.
650 * \li Syntax: char-right
653 { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit },
655 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT_SELECT
656 * \li Action: Moves the cursor one position "to the right", adding
657 traversed position to the selection.
658 * \li Notion: See also #LFUN_CHAR_RIGHT for exact details of the movement.
659 * \li Syntax: char-right-select
662 { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit },
665 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD
666 * \li Action: Moves the cursor to the logically previous beginning of a word.
667 * \li Notion: This is not the action which should be bound to the arrow keys,
668 because backwards may be left or right, depending on the
669 language. The arrow keys should be bound to #LFUN_WORD_LEFT or
670 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
671 * \li Syntax: word-backward
674 { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit },
676 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD_SELECT
677 * \li Action: Moves the cursor to the logically previous beginning of a word,
678 adding the logically traversed text to the selection.
679 * \li Notion: See also #LFUN_WORD_BACKWARD.
680 * \li Syntax: word-backward-select
683 { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
685 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_BACKWARD
686 * \li Action: Deletes characters to the begining of the word (usually the "C+BackSpace" key).
687 * \li Syntax: word-delete-backward
690 { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
692 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_FORWARD
693 * \li Action: Deletes characters to the end of the word (usually the "C+Delete" key).
694 * \li Syntax: word-delete-forward
697 { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
699 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_FORWARD
700 * \li Action: Search for a given string in forward direction.
701 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
702 * \li Syntax: word-find-forward [<STRING>]
703 * \li Origin: Etienne, 16 Feb 1998
706 { LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit },
708 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_BACKWARD
709 * \li Action: Search for a given string in backward direction.
710 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
711 * \li Syntax: word-find-backward [<STRING>]
712 * \li Origin: Etienne, 20 Feb 1998
715 { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
717 * \var lyx::FuncCode lyx::LFUN_WORD_FIND
718 * \li Action: Search for next occurence of a string.
719 * \li Syntax: word-find [<DATA>]
720 * \li Params: <DATA>: data encoded from Find dialog (see #lyx::find2string()).
721 If no parameter is given, search with last find-dialog
722 data is used for search (i.e. find-next).
723 * \li Origin: poenitz, Jan 7 2004
726 { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
727 { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
729 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD
730 * \li Action: Moves the cursor to the logically next beginning of a word.
731 * \li Notion: This is not the action which should be bound to the arrow keys,
732 because forward may be left or right, depending on the language.
733 The arrow keys should be bound to #LFUN_WORD_LEFT or
734 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
735 * \li Syntax: word-forward
738 { LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
740 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD_SELECT
741 * \li Action: Moves the cursor to the logically next beginning of a word,
742 adding the logically traversed text to the selection.
743 * \li Notion: See also #LFUN_WORD_FORWARD.
744 * \li Syntax: word-forward-select
747 { LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
749 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT
750 * \li Action: Moves the cursor to the next beginning of a word "on the left".
751 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
752 "left" key is pressed. Generally, it moves the cursor to the
753 next beginning of a word on the left. However, in Bidi text this
754 become slightly more complicated, and there are different modes
755 of cursor movement. In "visual mode", this moves left, plain and
756 simple. In "logical mode", movement is logically forward in RTL
757 paragraphs, and logically backwards in LTR paragraphs.
758 * \li Syntax: word-left
759 * \li Origin: dov, 28 Oct 2007
762 { LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
764 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT_SELECT
765 * \li Action: Moves the cursor to the next beginning of a word "on the left",
766 adding *logically* traversed text to the selection.
767 * \li Notion: See also #LFUN_WORD_LEFT for exact details of the movement.
768 * \li Syntax: word-left-select
769 * \li Origin: dov, 28 Oct 2007
772 { LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit },
774 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT
775 * \li Action: Moves the cursor to the next beginning of a word "on the right".
776 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
777 "right" key is pressed. Generally, it moves the cursor to the
778 next beginning of a word on the right. However, in Bidi text
779 this become slightly more complicated, and there are different
780 modes of cursor movement. In "visual mode", this moves right,
781 plain and simple. In "logical mode", movement is logically
782 forward in LTR paragraphs, and logically backwards in RTL
784 * \li Syntax: word-right
785 * \li Origin: dov, 28 Oct 2007
788 { LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit },
790 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT_SELECT
791 * \li Action: Moves the cursor to the next beginning of a word "on the right",
792 adding *logically* traversed text to the selection.
793 * \li Notion: See also #LFUN_WORD_RIGHT for exact details of the movement.
794 * \li Syntax: word-right-select
795 * \li Origin: dov, 28 Oct 2007
798 { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
799 { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
801 * \var lyx::FuncCode lyx::LFUN_WORD_CAPITALIZE
802 * \li Action: Capitalizes the words in the selection (i.e. the first letters)
803 or the letter on the cursor position.
804 * \li Syntax: word-capitalize
807 { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
809 * \var lyx::FuncCode lyx::LFUN_WORD_UPCASE
810 * \li Action: Change the words in the selection or from the cursor position
811 to the end of word to the upper case.
812 * \li Syntax: word-upcase
815 { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
817 * \var lyx::FuncCode lyx::LFUN_WORD_LOWCASE
818 * \li Action: Change the words in the selection or from the cursor position
819 to the end of word to the lower case.
820 * \li Syntax: word-lowcase
823 { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
825 * \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
826 * \li Action: Look up thesaurus entries with respect to the word under the cursor.
827 * \li Syntax: thesaurus-entry
828 * \li Origin: Levon, 20 Jul 2001
831 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
832 { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
833 { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
834 { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
835 { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
837 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
838 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
839 { LFUN_LINE_DELETE, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
840 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
841 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
843 * \var lyx::FuncCode lyx::LFUN_COPY
844 * \li Action: Copies to the clipboard the last edit.
848 { LFUN_COPY, "copy", ReadOnly, Edit },
850 * \var lyx::FuncCode lyx::LFUN_CUT
851 * \li Action: Cuts to the clipboard.
855 { LFUN_CUT, "cut", Noop, Edit },
857 * \var lyx::FuncCode lyx::LFUN_PASTE
858 * \li Action: Pastes from the active clipboard.
862 { LFUN_PASTE, "paste", Noop, Edit },
863 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
865 * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
866 * \li Action: Pastes the material currently selected.
867 * \li Syntax: primary-selection-paste
870 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
872 * \var lyx::FuncCode lyx::LFUN_UNDO
873 * \li Action: Undoes the last edit.
877 { LFUN_UNDO, "undo", Noop, Edit },
879 * \var lyx::FuncCode lyx::LFUN_REDO
880 * \li Action: Redoes the last thing undone.
884 { LFUN_REDO, "redo", Noop, Edit },
886 * \var lyx::FuncCode lyx::LFUN_REPEAT
887 * \li Action: Repeat the given command.
888 * \li Syntax: repeat <COUNT> <LFUN-COMMAND>
889 * \li Author: poenitz, 27 Oct 2003
892 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
894 * \var lyx::FuncCode lyx::LFUN_CHARS_TRANSPOSE
895 * \li Action: Transposes the character at the cursor with the one before it.
896 * \li Syntax: chars-transpose
897 * \li Author: Lgb, 25 Apr 2001
900 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
902 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
903 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
904 { LFUN_ENVIRONMENT_INSERT, "environment-insert", Noop, Edit },
907 * \var lyx::FuncCode lyx::LFUN_FONT_BOLD
908 * \li Action: Toggles the bold font (selection-wise).
909 * \li Syntax: font-bold
912 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
914 * \var lyx::FuncCode lyx::LFUN_FONT_TYPEWRITER
915 * \li Action: Toggles the typewriter family font (selection-wise).
916 * \li Syntax: font-typewriter
919 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
921 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERLINE
922 * \li Action: Toggles underline in the font (selection-wise).
923 * \li Syntax: font-underline
926 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
928 * \var lyx::FuncCode lyx::LFUN_FONT_EMPH
929 * \li Action: Toggles the emphasis font style (selection-wise).
930 * \li Syntax: font-emph
933 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
935 * \var lyx::FuncCode lyx::LFUN_FONT_NOUN
936 * \li Action: Toggles Noun text style font (selection-wise).
937 * \li Syntax: font-noun
940 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
942 * \var lyx::FuncCode lyx::LFUN_FONT_ROMAN
943 * \li Action: Toggles Roman family font (selection-wise).
944 * \li Syntax: font-roman
947 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
949 * \var lyx::FuncCode lyx::LFUN_FONT_SANS
950 * \li Action: Toggles Sans Serif family font (selection-wise).
951 * \li Syntax: font-sans
954 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
956 * \var lyx::FuncCode lyx::LFUN_FONT_FRAK
957 * \li Action: Toggles Fraktur family font (math-mode, selection-wise).
958 * \li Syntax: font-frak
959 * \li Origin: vermeer, 10 Jan 2002
962 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
964 * \var lyx::FuncCode lyx::LFUN_FONT_ITAL
965 * \li Action: Toggles Italics font shape (math-mode, selection-wise).
966 * \li Syntax: font-ital
967 * \li Origin: vermeer, 10 Jan 2002
970 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
972 * \var lyx::FuncCode lyx::LFUN_FONT_DEFAULT
973 * \li Action: Reverts the settings of the font to the default values (selection-wise).
974 * \li Syntax: font-default
977 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
978 { LFUN_FONT_FREE_APPLY, "font-free-apply", Noop, Layout },
979 { LFUN_FONT_FREE_UPDATE, "font-free-update", Noop, Layout },
980 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
981 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
983 * \var lyx::FuncCode lyx::LFUN_FONT_STATE
984 * \li Action: Returns the info about the current font.
985 * \li Syntax: font-state
988 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
990 { LFUN_BIBITEM_INSERT, "bibitem-insert", Noop, Edit },
991 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
992 { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit },
993 { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
996 * \var lyx::FuncCode lyx::LFUN_LAYOUT
997 * \li Action: Sets the layout (that is, environment) for the current paragraph.
998 * \li Syntax: layout <LAYOUT>
999 * \li Params: <LAYOUT>: the layout to use
1002 { LFUN_LAYOUT, "layout", Noop, Layout },
1004 * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH
1005 * \li Action: Launches the paragraph settings dialog.
1006 * \li Syntax: layout-paragraph
1009 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
1011 * \var lyx::FuncCode lyx::LFUN_LAYOUT_TABULAR
1012 * \li Action: Launches the tabular settings dialog.
1013 * \li Syntax: layout-tabular
1014 * \li Origin: Jug, 31 Jul 2000
1017 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
1019 * \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE
1020 * \li Action: Displays list of layout choices.
1021 * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
1022 dropbox allowing for choice of layout.
1023 * \li Syntax: drop-layouts-choice
1026 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
1028 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
1029 * \li Action: Clears the module list.
1030 * \li Notion: Clears the list of included modules for the current buffer.
1031 * \li Syntax: layout-modules-clear
1032 * \li Origin: rgh, 25 August 2007
1035 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", Noop, Layout },
1037 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULE_ADD
1038 * \li Action: Adds a module.
1039 * \li Notion: Adds a module to the list of included modules for the current buffer.
1040 * \li Syntax: layout-module-add <MODULE>
1041 * \li Params: <MODULE>: the module to be added
1042 * \li Origin: rgh, 25 August 2007
1045 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", Noop, Layout },
1047 * \var lyx::FuncCode lyx::LFUN_LAYOUT_RELOAD
1048 * \li Action: Reloads layout information.
1049 * \li Notion: Reloads all layout information for the current buffer from disk, thus
1050 recognizing any changes that have been made to layout files on the fly.
1051 This is intended to be used only by layout developers and should not be
1052 used when one is trying to do actual work.
1053 * \li Syntax: layout-reload
1054 * \li Origin: rgh, 3 September 2007
1057 { LFUN_LAYOUT_RELOAD, "layout-reload", Noop, Layout },
1059 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
1060 * \li Action: Sets the text class for the current buffer.
1061 * \li Syntax: textclass-apply <TEXTCLASS>
1062 * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
1063 the filename, minus the ".layout" extension.
1066 { LFUN_TEXTCLASS_APPLY, "textclass-apply", Noop, Layout },
1068 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
1069 * \li Action: Loads information for a textclass from disk.
1070 * \li Syntax: textclass-load <TEXTCLASS>
1071 * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
1072 the filename, minus the ".layout" extension.
1075 { LFUN_TEXTCLASS_LOAD, "textclass-load", Noop, Layout },
1078 * \var lyx::FuncCode lyx::LFUN_MARK_OFF
1079 * \li Action: Disable selecting of text-region.
1080 * \li Syntax: mark-off
1083 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
1085 * \var lyx::FuncCode lyx::LFUN_MARK_ON
1086 * \li Action: Enable selecting of text-region.
1087 * \li Notion: After enabling you can simply move arrow keys to get selected region.
1088 * \li Syntax: mark-on
1091 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
1093 * \var lyx::FuncCode lyx::LFUN_MARK_TOGGLE
1094 * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
1095 * \li Syntax: mark-toggle
1096 * \li Origin: poenitz, May 5 2006
1099 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
1101 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
1102 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
1103 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
1104 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
1105 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
1106 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
1107 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
1108 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
1109 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
1110 { LFUN_MATH_SPACE, "math-space", Noop, Math },
1111 { LFUN_MATH_IMPORT_SELECTION, "math-import-selection", Noop, Math },
1112 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
1113 { LFUN_MATH_MODE, "math-mode", Noop, Math },
1115 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
1116 * \li Action: Toggles numbering of the current formula line.
1117 * \li Notion: Must be in display formula mode.
1118 * \li Syntax: math-number-line-toggle
1119 * \li Origin: Alejandro 18 Jun 1996
1122 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
1124 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
1125 * \li Action: Toggles numbering/labeling of the current formula.
1126 * \li Notion: Must be in display formula mode.
1127 * \li Syntax: math-number-toggle
1128 * \li Origin: Alejandro 4 Jun 1996
1131 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
1132 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
1133 { LFUN_MATH_SIZE, "math-size", Noop, Math },
1135 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
1136 * \li Action: Unfold a Math Macro.
1137 * \li Notion: Unfold the Math Macro the cursor is in, i.e.
1139 * \li Syntax: math-macro-unfold
1140 * \li Origin: sts, 06 January 2008
1143 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
1145 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
1146 * \li Action: Fold a Math Macro.
1147 * \li Notion: Fold the Math Macro the cursor is in if it was
1148 unfolded, i.e. displayed as \foo before.
1149 * \li Syntax: math-macro-fold
1150 * \li Origin: sts, 06 January 2008
1153 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
1155 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
1156 * \li Action: Add a parameter.
1157 * \li Notion: Add a parameter to a Math Macro.
1158 * \li Params: <NUM>: The number of the parameter behind which the new one
1159 will be added (1 for the first, i.e. use 0 for add a
1160 parameter at the left), defaults to the last one.
1161 * \li Syntax: math-macro-add-param <NUM>
1162 * \li Origin: sts, 06 January 2008
1165 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
1167 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
1168 * \li Action: Remove the last parameter.
1169 * \li Notion: Remove the last parameter of a Math Macro and
1170 remove its value in all instances of the macro
1172 * \li Params: <NUM>: The number of the parameter to be deleted (1 for
1173 the first), defaults to the last one.
1174 * \li Syntax: math-macro-remove-param <NUM>
1175 * \li Origin: sts, 06 January 2008
1178 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
1180 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
1181 * \li Action: Append a greedy parameter.
1182 * \li Notion: Append a greedy parameter to a Math Macro which
1183 eats the following mathed cell in every instance of
1184 the macro in the buffer.
1185 * \li Syntax: math-macro-append-greedy-param
1186 * \li Origin: sts, 06 January 2008
1189 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
1191 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
1192 * \li Action: Remove a greedy parameter.
1193 * \li Notion: Remove a greedy parameter of a Math Macro and spit
1194 out the values of it in every instance of the macro
1195 in the buffer. If it is an optional parameter the [valud]
1197 * \li Syntax: math-macro-remove-greedy-param
1198 * \li Origin: sts, 06 January 2008
1201 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
1203 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
1204 * \li Action: Make a parameter optional.
1205 * \li Notion: Turn the first non-optional parameter of a Math Macro
1206 into an optional parameter with a default value.
1207 * \li Syntax: math-macro-make-optional
1208 * \li Origin: sts, 06 January 2008
1211 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
1213 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
1214 * \li Action: Make a parameter non-optional.
1215 * \li Notion: Turn the last optional parameter of a Math Macro
1216 into a non-optional parameter. The default value is
1217 remembered to be reused later if the user changes his mind.
1218 * \li Syntax: math-macro-make-nonoptional
1219 * \li Origin: sts, 06 January 2008
1222 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
1224 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
1225 * \li Action: Add an optional parameter.
1226 * \li Notion: Insert an optional parameter just behind the
1227 already existing optional parameters.
1228 * \li Syntax: math-macro-add-optional-param
1229 * \li Origin: sts, 06 January 2008
1232 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
1234 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
1235 * \li Action: Remove the last optional parameter.
1236 * \li Notion: Remove the last optional parameter of a Math Macro and
1237 remove it in all the instances of the macro in the buffer.
1238 * \li Syntax: math-macro-remove-optional-param
1239 * \li Origin: sts, 06 January 2008
1242 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
1244 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
1245 * \li Action: Add a greedy optional parameter.
1246 * \li Notion: Add a greedy optional parameter which eats the value
1247 from the following cells in mathed which are in the [value]
1249 * \li Syntax: math-macro-add-greedy-optional-param
1250 * \li Origin: sts, 06 January 2008
1253 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
1255 * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
1256 * \li Action: Only active in Math Macro definition.
1257 * \li Notion: Dummy function which is only active in a Math Macro definition.
1258 It's used to toggle the Math Macro toolbar if the cursor moves
1259 into a Math Macro definition.
1260 * \li Syntax: in-mathmacrotemplate
1261 * \li Origin: sts, 06 January 2008
1264 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
1267 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
1268 * \li Action: Moves the current paragraph downwards in the document.
1269 * \li Syntax: paragraph-move-down
1270 * \li Origin: Edwin, 8 Apr 2006
1273 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
1275 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
1276 * \li Action: Moves the current paragraph upwards in the document.
1277 * \li Syntax: paragraph-move-up
1278 * \li Origin: Edwin, 8 Apr 2006
1281 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
1284 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP
1285 * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1286 in upward direction.
1287 * \li Syntax: paragraph-up
1288 * \li Origin: Asger, 1 Oct 1996
1291 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
1293 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP_SELECT
1294 * \li Action: Move the cursor and select the text to the next paragraph (or
1295 begining of the current one) in upward direction.
1296 * \li Syntax: paragraph-up-select
1297 * \li Origin: Asger, 1 Oct 1996
1300 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
1302 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN
1303 * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1304 in downward direction.
1305 * \li Syntax: paragraph-down
1306 * \li Origin: Asger, 1 Oct 1996
1309 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
1311 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN_SELECT
1312 * \li Action: Move the cursor and select the text to the next paragraph (or
1313 begining of the current one) in downward direction.
1314 * \li Syntax: paragraph-down-select
1315 * \li Origin: Asger, 1 Oct 1996
1318 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
1320 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
1321 * \li Action: Jump to a paragraph given by its id number and optionally the
1322 desired position within the paragraph.
1323 * \li Notion: Note that id number of paragraph is not the sequential number of paragraph
1324 seen on the screen. Moreover the id is unique for all opened buffers (documents).
1325 * \li Syntax: paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
1326 * \li Params: <PAR_ID_NUMBER>: paragraph id
1327 <POSITION_IN_PAR>: desired position within the paragraph
1328 * \li Origin: Dekel, 26 Aug 2000
1331 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly, Edit },
1333 * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1334 * \li Action: Breaks the current paragraph at the current location.
1335 * \li Syntax: break-paragraph
1338 { LFUN_PARAGRAPH_SPACING, "paragraph-spacing", Noop, Edit },
1340 * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1341 * \li Action: Breaks the current paragraph at the current location.
1342 * \li Notion: Removes the selection.
1343 * \li Syntax: break-paragraph [<LAYOUT>]
1344 * \li Params: <LAYOUT>: "inverse" - decreases depth by one (or change layout
1345 to default layout) when the cursor is at the end of
1349 { LFUN_BREAK_PARAGRAPH, "break-paragraph", Noop, Edit },
1351 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
1352 * \li Action: Change paragraph settings.
1353 * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
1354 This function only modifies, and does not override, existing settings.
1355 Note that the "leftindent" indent setting is deprecated.
1356 * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
1357 * \li Params: <INDENT>: \\noindent|\\indent|\\indent-toggle|\\leftindent LENGTH\n
1358 <SPACING>: \\paragraph_spacing default|single|onehalf|double|other\n
1359 <ALIGN>: \\align block|left|right|center|default\n
1360 <OTHERS>: \\labelwidthstring WIDTH|\\start_of_appendix\n
1361 * \li Origin: rgh, Aug 15 2007
1364 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
1366 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
1367 * \li Action: Change paragraph settings.
1368 * \li Notion: Overwrite all nonspecified settings to the default ones.
1369 Use paragraph-params lfun if you don't want to overwrite others settings.
1370 * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
1371 * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
1372 * \li Origin: leeming, 30 Mar 2004
1375 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
1376 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
1379 * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
1380 * \li Action: Move the current group in the upward direction in the
1381 structure of the document.
1382 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1383 the whole substructure of the group.
1384 * \li Syntax: outline-up
1385 * \li Origin: Vermeer, 23 Mar 2006
1388 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
1390 * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
1391 * \li Action: Move the current group in the downward direction in the
1392 structure of the document.
1393 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1394 the whole substructure of the group.
1395 * \li Syntax: outline-down
1396 * \li Origin: Vermeer, 23 Mar 2006
1399 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
1401 * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
1402 * \li Action: Moves the current group in the downward direction in the
1403 hierarchy of the document structure.
1404 * \li Notion: Part -> Chapter -> Section -> etc.
1405 * \li Syntax: outline-in
1406 * \li Origin: Vermeer, 23 Mar 2006
1409 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
1411 * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
1412 * \li Action: Moves the current group in the upward direction in the
1413 hierarchy of the document structure.
1414 * \li Notion: Part <- Chapter <- Section <- etc.
1415 * \li Syntax: outline-out
1416 * \li Origin: Vermeer, 23 Mar 2006
1419 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
1421 * \var lyx::FuncCode lyx::LFUN_INSET_EDIT
1422 * \li Action: Edit the inset at cursor with an external application,
1423 * if one is attributed.
1424 * \li Syntax: inset-edit [<INSET_PARAMS>]
1425 * \li Params: <INSET_PARAMS>: Parameters for the inset.
1426 Currently only the filename will be considered.
1427 * \li Origin: JSpitzm, 27 Apr 2006
1430 { LFUN_INSET_EDIT, "inset-edit", Noop, Edit },
1432 { LFUN_CELL_BACKWARD, "cell-backward", Noop, Edit },
1433 { LFUN_CELL_FORWARD, "cell-forward", Noop, Edit },
1434 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
1435 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
1436 { LFUN_TABULAR_FEATURE, "tabular-feature", Noop, Edit },
1438 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
1439 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
1440 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
1441 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
1442 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
1444 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
1445 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
1446 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
1447 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
1448 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
1449 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
1450 { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
1451 { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
1454 * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
1455 * \li Action: Apply data for an inset.
1456 * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
1457 be applied. This is either changed to #LFUN_INSET_MODIFY or
1458 #LFUN_INSET_INSERT depending on the context where it is called.
1459 * \li Syntax: inset-apply <ARGS>
1460 * \li Params: See #LFUN_INSET_INSERT .
1463 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
1465 * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE
1466 * \li Action: Dissolve the current inset into text.
1467 * \li Syntax: inset-dissolve [<INSET>]
1468 * \li Params: <INSET>: this can be used to make sure the right kind of inset
1469 is dissolved. For example "dissolve" entry in the charstyles
1470 sub-menu should only dissolve the charstyle inset, even if the
1471 cursor is inside several nested insets of different type.\n
1472 For values see #lyx::InsetLayout::lyxtype_ .
1473 * \li Author: JSpitz, 7 Aug 2006
1476 { LFUN_INSET_DISSOLVE, "inset-dissolve", Noop, Edit },
1478 * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
1479 * \li Action: Insert new inset (type given by the parameters).
1480 * \li Syntax: inset-insert <INSET> <ARGS>
1481 * \li Params: <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics|
1482 hyperlink|include|index|label|nomencl|vspace|ref|toc>\n
1483 <ARGS>: depends on the given inset. Use "lyx -dbg action" to
1485 * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
1486 where <label name> is the name of the referenced label and
1487 <Format> is one of the following: \n
1488 ref -- <reference> \n
1489 eqref -- (<reference>) \n
1490 pageref -- <page> \n
1491 vpageref -- on <page> \n
1492 vref -- <reference> on <page> \n
1493 prettyref -- Formatted reference
1496 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
1498 * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
1499 * \li Action: Modify existing inset.
1500 * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1501 bibtex, ert, command, graphics, note, space, vspace, tabular,
1502 bibitem, inlude, ref insets.
1503 * \li Syntax: inset-modify <INSET> <ARGS>
1504 * \li Params: See #LFUN_INSET_INSERT for further details.
1507 { LFUN_INSET_MODIFY, "", Noop, Hidden },
1509 * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_MODIFY
1510 * \li Action: Modify the inset at cursor position, if there is one.
1511 * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1512 bibtex, ert, command, graphics, note, space, vspace, tabular,
1513 bibitem, inlude, ref insets.
1514 * \li Syntax: next-inset-modify <INSET> <ARGS> or next-inset-modify changetype <TYPE>
1515 * \li Params: See #LFUN_INSET_INSERT for further details.
1516 * \li Origin: JSpitzm, 23 Mar 2008
1519 { LFUN_NEXT_INSET_MODIFY, "next-inset-modify", ReadOnly, Edit },
1520 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
1522 * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
1523 * \li Action: Open the inset's properties dialog.
1524 * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
1525 * \li Syntax: inset-settings <INSET>
1526 * \li Params: <INSET>: <box|branch|ert|float|listings|note|tabular|wrap>
1529 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly, Edit },
1531 * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_TOGGLE
1532 * \li Action: Toggles the inset at cursor position. For collapsables, this means it will
1533 be (un-)collapsed, in case of other insets, the editing widget (dialog) will
1534 be entered. Also cf. #LFUN_INSET_SETTINGS.
1535 * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1536 bibtex, ert, command, graphics, note, space, vspace, tabular,
1537 bibitem, inlude, ref insets.
1538 * \li Syntax: next-inset-toggle <ARG>
1539 * \li Params: <ARG>: these are passed as arguments to #LFUN_INSET_TOGGLE .
1540 * \li Origin: leeming, 30 Mar 2004
1543 { LFUN_NEXT_INSET_TOGGLE, "next-inset-toggle", ReadOnly, Edit },
1545 * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
1546 * \li Action: Toggles the collapsable inset we are currently in.
1547 * \li Syntax: inset-toggle [<ARG>]
1548 * \li Params: <ARG>: <open|close|toggle|assign>. \n
1549 open/close/toggle are for collapsable insets. close can be currently used
1550 by #LFUN_NEXT_INSET_TOGGLE. toggle is used when no argument is given.\n
1551 assign is for branch inset.
1552 * \li Origin: lasgouttes, 19 Jul 2001
1555 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly, Hidden },
1557 * \var lyx::FuncCode lyx::LFUN_ALL_INSETS_TOGGLE
1558 * \li Action: Toggles (open/closes) all collapsable insets (of a given type) in the document.
1559 * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
1560 * \li Syntax: all-insets-toggle <STATE> <INSET>
1561 * \li Params: <STATE>: <toggle|open|close> default: toggle \n
1562 <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all insets \n
1563 * \li Origin: leeming, 30 Mar 2004
1566 { LFUN_ALL_INSETS_TOGGLE, "all-insets-toggle", ReadOnly, Edit },
1568 * \var lyx::FuncCode lyx::LFUN_GRAPHICS_GROUPS_UNIFY
1569 * \li Action: Unify all graphics insets with the one given as an parameter.
1570 * \li Notion: This is internally used for synchronize certain group of graphics insets.
1571 * \li Syntax: graphics-groups-unigfy <GRAPHICS_PARAMS>
1572 * \li Params: <GRAPHICS_PARAMS>: Parameters for graphics inset
1573 (syntax can be seen in .lyx files).
1574 * \li Origin: sanda, 6 May 2008
1577 { LFUN_GRAPHICS_GROUPS_UNIFY, "graphics-groups-unify", ReadOnly, Edit },
1579 * \var lyx::FuncCode lyx::LFUN_SET_GRAPHICS_GROUP
1580 * \li Action: Set the group for the graphics inset on the cursor position.
1581 * \li Syntax: set-graphics-group [<GROUP>]
1582 * \li Params: <GROUP>: Id for an existing group. In case tthe Id is an empty string,
1583 the graphics inset is removed from the current group.
1584 * \li Origin: sanda, 6 May 2008
1587 { LFUN_SET_GRAPHICS_GROUP, "set-graphics-group", ReadOnly, Edit },
1590 * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
1591 * \li Action: Moves the cursor out of the current slice, going forward.
1592 * \li Notion: Cursor movement within an inset may be different than cursor
1593 movement in the surrounding text. This action should be called
1594 automatically by the cursor movement within the inset, when
1595 movement within the inset has ceased (reached the end of the
1596 last paragraph, for example), in order to move correctly
1597 back into the surrounding text.
1600 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
1602 * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
1603 * \li Action: Moves the cursor out of the current slice, going backwards.
1604 * \li Notion: See also #LFUN_FINISHED_FORWARD.
1607 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
1609 * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
1610 * \li Action: Moves the cursor out of the current slice, going right.
1611 * \li Notion: See also #LFUN_FINISHED_FORWARD
1614 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
1616 * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
1617 * \li Action: Moves the cursor out of the current slice, going left.
1618 * \li Notion: See also #LFUN_FINISHED_FORWARD.
1621 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
1623 { LFUN_LANGUAGE, "language", Noop, Edit },
1626 * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
1627 * \li Action: Goto a label.
1628 * \li Syntax: label-goto [<LABEL>]
1629 * \li Params: <LABEL>: Requested label. If no label is given and refernce
1630 is on cursor position, Bookmark 0 is saved and
1631 cursor moves to the position of referenced label.
1632 * \li Origin: Ale, 6 Aug 1997
1635 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
1637 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT
1638 * \li Action: Inserts label to text or displayed formula.
1639 * \li Syntax: label-insert [<LABEL>]
1640 * \li Params: <LABEL>: Requested label. If no label is given dialog requesting
1641 name will be opened.
1644 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
1646 * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
1647 * \li Action: Go to the next label or cross-reference.
1648 * \li Syntax: reference-next
1649 * \li Origin: Dekel, 14 Jan 2001
1652 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
1655 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
1656 * \li Action: Goto a bookmark.
1657 * \li Notion: Moves the cursor to the numbered bookmark, opening the file
1658 if necessary. Note that bookmarsk are saved per-session, not
1660 * \li Syntax: bookmark-goto <NUMBER>
1661 * \li Params: <NUMBER>: the number of the bookmark to restore.
1662 * \li Origin: Dekel, 27 January 2001
1665 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
1667 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
1668 * \li Action: Save a bookmark.
1669 * \li Notion: Saves a numbered bookmark to the sessions file. The number
1670 must be between 1 and 9, inclusive. Note that bookmarks are
1671 saved per-session, not per file.
1672 * \li Syntax: bookmark-save <NUMBER>
1673 * \li Params: <NUMBER>: the number of the bookmark to save.
1674 * \li Origin: Dekel, 27 January 2001
1677 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
1679 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
1680 * \li Action: Clears the list of saved bookmarks.
1681 * \li Syntax: bookmark-clear
1682 * \li Origin: bpeng, 31 October 2006
1685 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
1688 * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
1689 * \li Action: Open the given help file according to the language setting.
1690 * \li Syntax: help-open <FILE>[.lyx]
1691 * \li Params: <FILE>: any document from (/usr/share/)doc directory.
1692 * \li Author: Jug, 27 Jun 1999
1695 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
1697 * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
1698 * \li Action: Terminates the current LyX instance.
1699 * \li Notion: Terminates the current LyX instance, asking whether to save
1700 modified documents, etc.
1701 * \li Syntax: lyx-quit
1704 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
1706 * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
1707 * \li Action: Toggles visibility of a given toolbar between on/off/auto.
1708 * \li Notion: Skiping "auto" when allowauto is false.
1709 * \li Syntax: toolbar-toggle <NAME> [allowauto]
1710 * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|
1711 minibuffer|review|view/update|math_panels
1712 * \li Origin: Edwin, 21 May 2007
1715 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
1717 * \var lyx::FuncCode lyx::LFUN_MENU_OPEN
1718 * \li Action: Opens the menu given by its name.
1719 * \li Syntax: menu-open <NAME>
1720 * \li Params: <NAME>: menu name. See various .inc files in lib/ui for candidates.
1723 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
1725 * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
1726 * \li Action: Various UI visibility-toggling actions.
1727 * \li Syntax: ui-toggle <statusbar|menubar|frame|fullscreen>
1728 * \li Params: statusbar : Toggle visibility of the statusbar.\n
1729 menubar : Toggle visibility of the menubar.\n
1730 scrollbar : Toggle visibility of the scrollbar.\n
1731 frame : Toggle visibility of the frames around editing window.\n
1732 fullscreen : Toggle fullscreen mode. This also covers calling the
1733 previous functions. However #LFUN_TOOLBAR_TOGGLE for the
1734 custom tweaks of the toolbars should be used.
1735 * \li Origin: ps, 9 Feb 2007
1738 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
1741 * \var lyx::FuncCode lyx::WINDOW_NEW
1742 * \li Action: Creates new empty LyX window.
1743 * \li Notion: Already opened documents from the previous window can be found under View menu.
1744 * \li Syntax: window-new [<GEOMETRY>]
1745 * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently
1746 accepted only on Windows platform.
1747 * \li Origin: Abdel, 21 Oct 2006
1750 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
1752 * \var lyx::FuncCode lyx::LFUN_WINDOW_CLOSE
1753 * \li Action: Closes the current LyX window.
1754 * \li Syntax: window-close
1755 * \li Origin: Abdel, 23 Oct 2006
1758 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
1761 * \var lyx::FuncCode lyx::LFUN_SPLIT_VIEW
1762 * \li Action: Creates another split view of current buffer.
1763 * \li Notion: All split views act in the same way indpendently.
1764 * \li Syntax: split-view <vertical|horizontal>
1765 * \li Params: horizontal : The work areas are laid out side by side.\n
1766 vertical : The work areas laid out vertically.\n
1767 * \li Origin: abdel, 20 Feb 2008
1770 { LFUN_SPLIT_VIEW, "split-view", ReadOnly, Buffer },
1773 * \var lyx::FuncCode lyx::LFUN_CLOSE_TAB_GROUP
1774 * \li Action: Close the current tab group.
1775 * \li Notion: This only closes the work areas, not the buffer themselves.
1776 The still opened buffers can be visualized in another tab group.
1777 * \li Syntax: close-tab-group
1778 * \li Origin: abdel, 21 Feb 2008
1781 { LFUN_CLOSE_TAB_GROUP, "close-tab-group", ReadOnly, Buffer },
1782 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
1783 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
1784 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
1785 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
1786 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
1787 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
1789 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
1790 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
1791 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
1792 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
1793 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
1795 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
1796 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
1797 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
1798 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
1800 { LFUN_SERVER_CHAR_AFTER, "server-char-after", ReadOnly, System },
1801 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
1802 { LFUN_SERVER_GET_NAME, "server-get-name", ReadOnly, System },
1804 * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
1805 * \li Action: Sets the cursor position based on the row number of generated TeX file.
1806 * \li Syntax: server-goto-file-row <LYX_FILE_NAME> <ROW_NUMBER>
1807 * \li Origin: Edmar, 23 Dec 1998
1810 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly, System },
1811 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
1813 * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
1814 * \li Action: Sets the cursor position based on the editing area coordinates
1815 (similar as clicking on that point with left mouse button).
1816 * \li Syntax: server-set-xy <X> <Y>
1819 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
1821 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
1822 * \li Action: Returns the coordinates of cursor position in the editing area.
1823 * \li Syntax: server-get-xy
1826 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
1829 * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
1830 * \li Action: Generates the code (literate programming).
1831 * \li Notion: Latex file with extension \literate_extension is generated.
1832 Then LyX invokes \build_command (with a default of``make'') to generate the code and
1833 \build_error_filter to process the compilation error messages. \n
1834 In case you want to process your literate file with a script, or some other program,
1835 just insert in your lyxrc file an entry with:\n
1836 \build_command "my_script my_arguments" \n
1837 The \build_error_filter differs from the \literate_error_filter only in that the
1838 former will identify error messages from your compiler.
1839 * \li Syntax: build-program
1842 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
1845 * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
1846 * \li Action: Saves the current buffer to a temporary file.
1847 * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
1848 is called automatically by LyX, to "autosave" the current buffer.
1849 * \li Syntax: buffer-auto-save
1852 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
1854 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHILD_OPEN
1855 * \li Action: Loads the given child document.
1856 * \li Notion: The current document is treated as a parent.
1857 * \li Syntax: buffer-child-open <FILE>
1858 * \li Params: <FILE>: Filename of the child. The directory of the parent is assumed by default.
1859 * \li Origin: Ale, 28 May 1997
1862 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
1864 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHKTEX
1865 * \li Action: Runs chktex for the current document.
1866 * \li Syntax: buffer-chktex
1867 * \li Origin: Asger, 30 Oct 1997
1870 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
1872 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
1873 * \li Action: Toggles compression of the current document on/off.
1874 * \li Syntax: buffer-toggle-compression
1875 * \li Origin: bpeng, 27 Apr 2006
1878 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
1880 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
1881 * \li Action: Closes the current buffer.
1882 * \li Notion: Closes the current buffer, asking whether to save it, etc,
1883 if the buffer has been modified.
1884 * \li Syntax: buffer-close
1887 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
1889 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
1890 * \li Action: Exports the current buffer (document) to the given format.
1891 * \li Syntax: buffer-export <FORMAT>
1892 * \li Params: <FORMAT> is either "custom" or one of the formats which you
1893 can find in Tools->Preferences->File formats->Format.
1894 Usual format you will enter is "pdf2" (pdflatex),
1895 "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
1896 In case of "custom" you will be asked for a format you
1897 want to start from and for the command that you want to
1898 apply to this format. Internally the control is then passed
1899 to #LFUN_BUFFER_EXPORT_CUSTOM.
1900 * \li Origin: Lgb, 29 Jul 1997
1903 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
1905 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
1906 * \li Action: Exports the current buffer (document) from the given format using
1907 the given command on it.
1908 * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
1909 * \li Params: <FORMAT> format to start from (LyX will care to produce such
1910 intermediate file).\n
1911 <COMMAND> this command will be launched on the file. Note that you can
1912 use "$$FName" string to qualify the intermediate file.
1913 * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
1914 * \li Origin: leeming, 27 Mar 2004
1917 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
1919 * \var lyx::FuncCode lyx::LFUN_BUFFER_PRINT
1920 * \li Action: Prints the current document.
1921 * \li Notion: Many settings can be given via the preferences dialog.
1922 * \li Syntax: buffer-print <TARGET> <TARGET-NAME> <COMMAND>
1923 * \li Params: <TARGET> is either "printer" or "file".\n
1924 <TARGER-NAME> is either "default" or file name or printer name.\n
1925 <COMMAND> command ensuring the printing job.
1926 * \li Sample: buffer-print file "/trash/newfile1.ps" "dvips"
1927 * \li Origin: leeming, 28 Mar 2004
1930 { LFUN_BUFFER_PRINT, "buffer-print", ReadOnly, Buffer },
1932 * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
1933 * \li Action: Import a given file as a lyx document.
1934 * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
1935 defined convertors in preferences. Look into File->Import menu to get
1936 an idea of the currently active import formats.
1937 * \li Syntax: buffer-import <FORMAT> [<FILE>]
1938 * \li Origin: Asger, 24 Jul 1998
1941 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
1943 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
1944 * \li Action: Creates a new buffer (that is, document).
1945 * \li Notion: Implicit path can be set in Preferences dialog.
1946 * \li Syntax: buffer-new [<FILE>]
1947 * \li Params: <FILE>: filename of created file with absolute path.
1950 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
1952 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
1953 * \li Action: Creates a new buffer (that is, document) from a template.
1954 * \li Notion: Path for new files and templates can be set in Preferences dialog.
1955 Template will be asked for via Open-dialog.
1956 * \li Syntax: buffer-new-template [<FILE>]
1957 * \li Params: <FILE>: filename of created file with absolute path.
1960 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
1962 * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
1963 * \li Action: Reverts opened document.
1964 * \li Syntax: buffer-reload
1965 * \li Origin: Asger, 2 Feb 1997
1968 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
1970 * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
1971 * \li Action: Switch to the given buffer.
1972 * \li Notion: This is useful also in case you need simultaneously more views of the edited
1973 document in different LyX windows.
1974 * \li Syntax: buffer-new-template <BUFFER>
1975 * \li Params: <BUFFER>: already opened document which is to be shown.
1978 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
1980 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
1981 * \li Action: Toggle editing mode of the current document between read/write and read-only.
1982 * \li Syntax: buffer-toggle-read-only
1983 * \li Origin: Lgb, 27 May 1997
1986 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
1988 * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
1989 * \li Action: Displays current buffer in chosen format.
1990 * \li Notion: Displays the contents of the current buffer in the chosen
1991 format, for example, PDF or DVI. This runs the necessary
1992 converter, calls the defined viewer, and so forth.
1993 * \li Syntax: buffer-view <FORMAT>
1994 * \li Params: <FORMAT>: The format to display, where this is one of the
1995 formats defined (in the current GUI) in the
1996 Tools>Preferences>File Formats dialog.
1999 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
2001 * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
2002 * \li Action: Exports the current document and put the result into the
2003 temporary directory.
2004 * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
2005 the output will be rewriten - updated. This is useful in case your viewer
2006 is able to detect such changes (e.g. ghostview for postscript).
2007 * \li Syntax: buffer-update <FORMAT>
2008 * \li Params: <FORMAT>: The format to display, where this is one of the
2009 formats defined (in the current GUI) in the
2010 Tools>Preferences>File Formats dialog.
2011 * \li Origin: Dekel, 5 Aug 2000
2014 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
2017 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
2018 * \li Action: Saves the current buffer.
2019 * \li Notion: Saves the current buffer to disk, using the filename that
2020 is already associated with the buffer, asking for one if
2021 none is yet assigned.
2022 * \li Syntax: buffer-write
2025 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
2027 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
2028 * \li Action: Rename and save current buffer.
2029 * \li Syntax: buffer-write-as <FILENAME>
2030 * \li Params: <FILENAME>: New name of the buffer/file. A relative path
2031 is with respect to the original location of the buffer/file.
2034 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
2036 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
2037 * \li Action: Save all changed documents.
2038 * \li Syntax: buffer-write-all
2039 * \li Origin: rgh, gpothier 6 Aug 2007
2042 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
2044 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEXT
2045 * \li Action: Switch to the next opened document.
2046 * \li Notion: Note that this does not necessarily mean next in tabbar
2047 (for full list see View menu).
2048 * \li Syntax: buffer-next
2051 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
2053 * \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS
2054 * \li Action: Switch to the previous opened document.
2055 * \li Syntax: buffer-previous
2058 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
2060 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
2061 * \li Action: When run from a child document, this updates (exports) document built
2062 from the master buffer. If a master is not found, it updates the
2064 * \li Syntax: master-buffer-update
2065 * \li Author: Tommaso, 20 Sep 2007
2068 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
2070 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
2071 * \li Action: When run from a child document, this command shows a preview built
2072 from the master buffer. If a master is not found, it previews the
2074 * \li Syntax: master-buffer-view
2075 * \li Author: Tommaso, 20 Sep 2007
2078 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
2080 * \var lyx::FuncCode lyx::LFUN_BUFFER_LANGUAGE
2081 * \li Action: Set language of the current document.
2082 * \li Syntax: buffer-language <LANG>
2083 * \li Params: <LANG>: language name. See lib/languages for list.
2084 * \li Author: leeming, 30 Mar 2004
2087 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
2089 * \var lyx::FuncCode lyx::LFUN_BUFFER_SAVE_AS_DEFAULT
2090 * \li Action: Save the current document settings as default.
2091 * \li Notion: The file will will be saved into ~/.lyx/templates/defaults.lyx .
2092 * \li Syntax: buffer-save-as-default [<ARGS>]
2093 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
2094 you can find in document header of usual .lyx file.
2095 * \li Author: leeming, 30 Mar 2004
2098 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
2100 * \var lyx::FuncCode lyx::LFUN_BUFFER_PARAMS_APPLY
2101 * \li Action: Apply the given settings to the current document.
2102 * \li Syntax: buffer-params-apply [<ARGS>]
2103 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
2104 you can find in document header of usual .lyx file.
2105 * \li Author: leeming, 30 Mar 2004
2108 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", Noop, Buffer },
2111 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
2112 * \li Action: Inserts another LyX file.
2113 * \li Syntax: file-insert [<FILE>]
2114 * \li Params: <FILE>: Filename to be inserted.
2117 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
2119 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
2120 * \li Action: Inserts plain text file.
2121 * \li Syntax: file-insert-plaintext [<FILE>]
2122 * \li Params: <FILE>: Filename to be inserted.
2123 * \li Origin: CFO-G, 19 Nov 1997
2126 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
2128 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
2129 * \li Action: Inserts plain text file as paragraph (i.e. join lines).
2130 * \li Syntax: file-insert-plaintext-para [<FILE>]
2131 * \li Params: <FILE>: Filename to be inserted.
2132 * \li Origin: Levon, 14 Feb 2001
2135 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
2137 * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
2138 * \li Action: Open LyX document.
2139 * \li Syntax: file-open [<FILE>]
2140 * \li Params: <FILE>: Filename to be opened.
2143 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
2146 * \var lyx::FuncCode lyx::LFUN_CALL
2147 * \li Action: Executes a command defined in a .def file.
2148 * \li Notion: The definitions are by default read from lib/commands/default.def.\n
2149 A .def file allows to define a command with \\define "<NAME>" "<LFUN>"
2150 where <NAME> is the name of the new command and <LFUN> is the lfun code
2151 to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
2152 \\def_file "FileName" allows to include another .def file. \n
2153 This is particularly useful in connection with toolbar buttons:
2154 Since the name of the button image for this lfun is
2155 lib/images/commands/<NAME>.png this is the way to assign an image
2156 to a complex command-sequence.
2157 * \li Syntax: call <NAME>
2158 * \li Params: <NAME>: Name of the command that must be called.
2159 * \li Origin: broider, 2 Oct 2007
2162 { LFUN_CALL, "call", NoBuffer, System },
2164 * \var lyx::FuncCode lyx::LFUN_META_PREFIX
2165 * \li Action: Simulate halting Meta key (Alt key on PCs).
2166 * \li Notion: Used for buffer editation not for GUI control.
2167 * \li Syntax: meta-prefix
2170 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
2172 * \var lyx::FuncCode lyx::LFUN_CANCEL
2173 * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
2174 * \li Syntax: cancel
2177 { LFUN_CANCEL, "cancel", NoBuffer, System },
2180 * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
2181 * \li Action: Opens the minibuffer toolbar so that the user can type in there.
2182 * \li Notion: Usually bound to M-x shortcut.
2183 * \li Syntax: command-execute
2186 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
2187 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
2189 * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
2190 * \li Action: Run more commands (LFUN and its parameters) in a sequence.
2191 * \li Syntax: command-sequence <CMDS>
2192 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
2193 * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
2194 * \li Origin: Andre', 11 Nov 1999
2197 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
2199 * \var lyx::FuncCode lyx::LFUN_MESSAGE
2200 * \li Action: Shows message in statusbar (for script purposes).
2201 * \li Syntax: message <STRING>
2202 * \li Origin: Lgb, 8 Apr 2001
2205 { LFUN_MESSAGE, "message", NoBuffer, System },
2207 * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
2208 * \li Action: Save user preferences.
2209 * \li Syntax: preferences-save
2210 * \li Origin: Lgb, 27 Nov 1999
2213 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
2215 * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
2216 * \li Action: Reconfigure the automatic settings.
2217 * \li Syntax: reconfigure
2218 * \li Origin: Asger, 14 Feb 1997
2221 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
2223 * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
2224 * \li Action: Apply the given settings to user preferences.
2225 * \li Syntax: lyxrc-apply <SETTINGS>
2226 * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
2227 to get an idea which commands to use and their syntax.
2228 #lyx::LyXRC::LyXRCTags has the list of possible commands.
2231 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
2233 * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
2234 * \li Action: Determine whether keep cursor inside the editing window regardless
2235 the scrollbar movement.
2236 * \li Syntax: toggle-cursor-follows-scrollbar
2237 * \li Origin: ARRae, 2 Dec 1997
2240 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
2242 * \var lyx::FuncCode lyx::LFUN_SET_COLOR
2243 * \li Action: Set the given LyX color to the color defined by the X11 name given.
2244 * \li Notion: A new color entry is created if the color is unknown.
2245 Color names can be stored as a part of user settings.
2246 * \li Syntax: set-color <LYX_NAME> <X11_NAME>
2247 * \li Origin: SLior, 11 Jun 2000
2250 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
2252 * \var lyx::FuncCode lyx::LFUN_STATISTICS
2253 * \li Action: Count the statistics (number of words and characters)
2254 in the document or in the given selection.
2255 * \li Notion: Note that this function gives the number of words/chars written,
2256 not the number of characters which will be typeset.
2257 * \li Syntax: statistics
2258 * \li Origin: lasgouttes, Jan 27 2004; ps, Jan 8 2008
2261 { LFUN_STATISTICS, "statistics", ReadOnly, System },
2263 * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
2264 * \li Action: Show the inline completion at the cursor position.
2265 * \li Syntax: completion-inline
2266 * \li Origin: sts, Feb 19 2008
2269 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
2271 * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
2272 * \li Action: Show the completion popup at the cursor position.
2273 * \li Syntax: completion-popup
2274 * \li Origin: sts, Feb 19 2008
2277 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
2279 * \var lyx::FuncCode lyx::LFUN_COMPLETION_COMPLETE
2280 * \li Action: Try to complete the word or command at the cursor position.
2281 * \li Syntax: completion-complete
2282 * \li Origin: sts, Feb 19 2008
2285 { LFUN_COMPLETION_COMPLETE, "complete", SingleParUpdate, Edit },
2287 * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
2288 * \li Action: Activate the branch
2289 * \li Syntax: branch-activate <BRANCH>
2290 * \li Params: <BRANCH>: The branch to activate
2291 * \li Sample: lyx -e pdf2 -x "branch-activate answers" finalexam.lyx \n
2292 could be used to export a pdf with the answers branch included
2293 without one's having to open LyX and activate the branch manually.
2294 * \li Origin: rgh, 27 May 2008
2297 { LFUN_BRANCH_ACTIVATE, "branch-activate", Argument, Buffer },
2299 * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
2300 * \li Action: De-activate the branch
2301 * \li Syntax: branch-deactivate <BRANCH>
2302 * \li Params: <BRANCH>: The branch to deactivate
2303 * \li Origin: rgh, 27 May 2008
2306 { LFUN_BRANCH_DEACTIVATE, "branch-deactivate", Argument, Buffer },
2308 { LFUN_NOACTION, "", Noop, Hidden }
2309 #ifndef DOXYGEN_SHOULD_SKIP_THIS
2312 for (int i = 0; items[i].action != LFUN_NOACTION; ++i) {
2313 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
2320 LyXAction::LyXAction()
2326 // Returns an action tag from a string.
2327 FuncRequest LyXAction::lookupFunc(string const & func) const
2329 string const func2 = trim(func);
2331 if (func2.empty()) {
2332 return FuncRequest(LFUN_NOACTION);
2336 string const arg = split(func2, cmd, ' ');
2338 func_map::const_iterator fit = lyx_func_map.find(cmd);
2340 return fit != lyx_func_map.end() ? FuncRequest(fit->second, arg) : FuncRequest(LFUN_UNKNOWN_ACTION);
2344 string const LyXAction::getActionName(FuncCode action) const
2346 info_map::const_iterator const it = lyx_info_map.find(action);
2347 return it != lyx_info_map.end() ? it->second.name : string();
2351 LyXAction::func_type const LyXAction::getActionType(FuncCode action) const
2353 info_map::const_iterator const it = lyx_info_map.find(action);
2354 return it != lyx_info_map.end() ? it->second.type : Hidden;
2358 bool LyXAction::funcHasFlag(FuncCode action,
2359 LyXAction::func_attrib flag) const
2361 info_map::const_iterator ici = lyx_info_map.find(action);
2363 if (ici == lyx_info_map.end()) {
2364 LYXERR0("action: " << action << " is not known.");
2365 LASSERT(false, /**/);
2368 return ici->second.attrib & flag;
2372 LyXAction::const_func_iterator LyXAction::func_begin() const
2374 return lyx_func_map.begin();
2378 LyXAction::const_func_iterator LyXAction::func_end() const
2380 return lyx_func_map.end();